explain.c

Go to the documentation of this file.

// Copyright (C) 2023 Ethan Uppal. All rights reserved.
 
#include "explain.h"
#include "error.h"
 
/* clang-format off */
static STR explanations[PS_NUM_OF_ECODES] = {
    [PS_ECODE_UNKNOWN_TOKEN] = "",
    [PS_ECODE_UNBALANCED_SLASH_COMMENT] = "The lexer encountered an unknown "
    "character or a known character in an invalid position.",
 
    [PS_ECODE_INVALID_NUMBER] = "The lexer encountered a number with an "
    "invalid digit representation or scientific notation.",
 
    [PS_ECODE_EMPTY_CHR_LIT] = "The lexer encountered an empty character "
    "literal in the source code. Character literals must contain at least one "
    "character.",
 
    [PS_ECODE_UNEXPECTED_TKN] = "The parser attempted to match a current token "
    "in the token stream against a set number of possibilities. None of those "
    "possibilities were encountered.",
 
    [PS_ECODE_STOP] = "The maximum number of errors has been received.",
 
    [PS_ECODE_EXPECTED_EXPR] = "The parser expected an expression in the "
    "source code but did not find one. This could be due to a syntax error.",
 
    [PS_ECODE_INVALID_OP] = "The parser encountered an invalid operator in the "
    "source code. This could be due to an operator being used in an incorrect "
    "context.",
 
    [PS_ECODE_MISMATCH] = "The parser encountered mismatched groupings in the "
    "source code. This could be due to mismatched parentheses, brackets, or "
    "braces."
};
/* clang-format on */
 
STR ps_error_explain(enum ps_error_code code) {
    if (code < 0 || code >= PS_NUM_OF_ECODES) {
        return "The provided error code is invalid. Error codes must be in "
               "range.";
    }
    STR explanation = explanations[code];
    if (!explanation) {
        return "The provided error code does not currently have an explanation "
               "entry.";
    }
    return explanation;
}