lg_error.h

/*
 *      LibGame - Copyright (C) Emmanuel Thomas-Maurin 2011-2026
 *      All rights reserved
 */
 
#ifndef LG_ERROR_H
#define LG_ERROR_H
 
/* GL errors checking */
#define CHECK_GL_E      lg_check_gl_errors(lg_log_time(), __FILE__, __LINE__, __func__)
 
#define CHECK_GL_E_2    {if (lg_check_gl_errors(lg_log_time(), __FILE__, __LINE__, __func__) != LG_OK) exit(-1);}
 
/* Checking for NULL pointers */
#define CHECKV_R(what, ret_value)       {if (what == NULL) {INFO_ERR("NULL pointer\n") return ret_value;}}
 
/* Checking for NULL pointers v2 */
#define __chkp__(pointer, string, ret_value) {if (pointer == NULL) {INFO_ERR("%s == NULL\n", string); return ret_value;}}
 
/* Where is this used ? */
#define STH_WRONG_HERE \
        { \
                static int i = 0; \
                if (i == 0) { \
                        INFO_OUT("VARO TÄSSÄ\n%s [%s: %d] %s(): jotain pitää korjata\n", UTF8_RW_ROUNDED_ARROW, __FILE__, __LINE__, __func__) \
                        i++; \
                } \
        }
 
/* Debugging stuff (trivial) */
#define DEBUG_ENTER_FUNC        INFO_OUT("\n\nDEBUG **** %s() ****\n\n", __func__)
#define DEBUG_ENTER_FUNC2(str)  INFO_OUT("\n\nDEBUG **** %s() -> %s ****\n\n", __func__, str)
#define DEBUG_CHK_PTR(ptr)      \
        { \
                if (ptr == NULL) { \
                        INFO_OUT("\n\nDEBUG **** [%s: %d] %s() -> POINTER IS NULL ****\n\n", __FILE__, __LINE__, __func__) \
                        exit(-1); \
                } \
        }
 
/* Adding timestamps to error logs on Linux */
/*
 * TODO: it would be actually more correct to change:
 * - TIME_FILE_LINE_FUNC_STR to TIME_FILE_LINE_FUNC
 * and
 * - TIME_FILE_LINE_FUNC_STR2 to TIME_FILE_LINE_FUNC_STR
 * but:
 * - There is already (uncorrectly) FILE_LINE_FUNC_STR in libetm.h
 * which should be also changed
 * - It's not working so far
 */
 
long long lg_log_time();
 
#ifndef ANDROID_V
  #define TIME_FILE_LINE_FUNC_STR       "%lld [%s: %d] %s(): ", lg_log_time(), __FILE__, __LINE__, __func__
  // STH WRONG HERE - #define TIME_FILE_LINE_FUNC_STR2  "[%lld %s: %d] %s(): %s", lg_log_time(), __FILE__, __LINE__, __func__
  #define INFO_ERR2(...) \
        {\
                fprintf(STD_ERR, TIME_FILE_LINE_FUNC_STR);\
                fprintf(STD_ERR, __VA_ARGS__);\
                fflush(STD_ERR);\
        }
#endif
 
#define LG_ERR_CTX_FILE_MAXLEN  63
#define LG_ERR_CTX_FUNC_MAXLEN  63
#define LG_ERR_CTX_TXT_MAXLEN   1023
#define LG_ERR_CTX_CODE_NA      (-100000)       /* Really not sure what to pick */
#define LG_ERR_CTX_STR_MAXLEN   2048            /* Must contain all of the above - for snprintf() */
#define LG_ERR_CTX_FORMAT       "[%s: %d] %s(): %s (code = %d)"
 
typedef struct {
        char            file[LG_ERR_CTX_FILE_MAXLEN + 1];       /* Not the full path */
        unsigned int    line;
        char            func[LG_ERR_CTX_FUNC_MAXLEN + 1];
        char            txt[LG_ERR_CTX_TXT_MAXLEN + 1];
        int             code;
} LG_ErrorContext;
 
/* This is actually an almost duplicate of Libetm/error.h: struct ErrSt (code/str) */
typedef struct {
        int             code;
        const char      *txt;
} error_code_txt;
 
enum {OOM_MALLOC2_TEST, OOM_MALLOC3_TEST, OOM_MALLOC3_TEST2, INVPTR_FREE2_TEST, INVPTR_FREE3_TEST, SEGFAULT_TEST, DIVBYZERO_TEST};
 
void            lg_override_warning_timeout(int);
 
void            lg_reset_warning_timeout();
 
void            lg_set_error_context(const char *, unsigned int, const char *, const char *, int);
 
int             lg_get_error_context_code();
 
const char      *lg_get_full_error_context();
 
void            lg_clear_error_context();
 
void            lg_save_error_context(LG_ErrorContext *);
 
void            lg_restore_error_context(LG_ErrorContext *);
 
#ifndef WIN32_V
void            sig_handler(int, siginfo_t *, void *);
 
void            set_sig_handler();
 
extern void     app_sig_handler(int, const char *);
#endif
 
void            lg_print_out_error_codes();
 
void            test_big_error(int);
 
#endif /* LG_ERROR_H */