nierr.h

/*
 * Project name:
 * Implementace interpretu imperativního jazyka IFJ13.
 *
 * Codename:
 * INI: Ni Interpreter
 *
 * Description:
 * https://wis.fit.vutbr.cz/FIT/st/course-files-st.php/course/IFJ-IT/projects/ifj2013.pdf
 *
 * Project's GitHub repository:
 * https://github.com/metthal/IFJ-Projekt
 *
 * Team:
 * Marek Milkovič   (xmilko01)
 * Lukáš Vrabec     (xvrabe07)
 * Ján Spišiak      (xspisi03)
 * Ivan Ševčík      (xsevci50)
 * Marek Bertovič   (xberto00)
 */

/**
 * @file nierr.h
 * @brief Declares error framework.
 */

#ifndef NIERR_H
#define NIERR_H

#include <stdio.h>

/*
 * Add new values to enum as needed, but remember that those are error
 * codes of interpreter thus at higher abstraction level. E.g. we don't need
 * information that file doesn't exist, just that lexical analyzer had problem
 * related to file, which can also be caused by missing <?php tag etc.
 */

/** Error types used internally to detect and handle errors. */
typedef enum
{
    ERR_None = 0,      //!< ERR_None
    ERR_Unknown,       //!< ERR_Unknown
    ERR_LexFile,       //!< ERR_LexFile
    ERR_Allocation,    //!< ERR_Allocation
    ERR_Range,         //!< ERR_Range
    ERR_Internal,      //!< ERR_Internal
    ERR_Convert,       //!< ERR_Convert
    ERR_Syntax,        //!< ERR_Syntax
    ERR_UndefFunction, //!< ERR_UndefFunction
    ERR_RedefFunction, //!< ERR_RedefFunction
    ERR_UndefVariable, //!< ERR_UndefVariable
    ERR_RedefParameter,//!< ERR_RedefParameter
    ERR_BadParamCount, //!< ERR_BadParamCount
    ERR_DefArgOrder,   //!< ERR_DefArgOrder
    ERR_BadDefArg,     //!< ERR_BadDefArg
    ERR_ISTGenerator,  //!< ERR_ISTGenerator
    ERR_CycleControl, //!< Invalid break / continue statement
    ERR_Substr,        //!< ERR_Substr
    ERR_OperandTypes,  //!< ERR_OperandTypes
    ERR_DivideByZero   //!< ERR_DivideByZero
} NiErrorType;

/** Structure that holds informations about error. */
typedef struct
{
    NiErrorType type;
    int line;
    const char *file;
    const char *fun;
} NiError;

#ifdef DEBUG
extern char errorPrinted;
void printError();
#endif

extern NiError niErr;

/** Gets last interpret error.
 * @return Last error.
 */
static inline NiErrorType getError()
{
#ifdef DEBUG
    printError();
#endif
    return niErr.type;
}

/** Sets interpret error.
 * @param err One of NiErrorType values.
 */
#define setError(err) setErrorExp(err, __LINE__, __FILE__, __func__)
static inline void setErrorExp(NiErrorType errType, int line, const char *file,
        const char *fun)
{
    niErr.type = errType;
    niErr.line = line;
    niErr.file = file;
    niErr.fun = fun;
#ifdef DEBUG
    errorPrinted = 0;
#endif
}

/** Clears interpret error to ERR_None */
static inline void clearError()
{
    niErr.type = ERR_None;
}
#endif