qcsrc/lib/log.qh

   1 #pragma once
   2
   3 #include "progname.qh"
   4
   5 #define assert(expr, ...) _assert(LOG_SEVERE, expr, __VA_ARGS__)
   6 #define devassert(...) MACRO_BEGIN if (autocvar_developer) assert(__VA_ARGS__); MACRO_END
   7
   8 #define assert_once(expr, ...) \
   9         MACRO_BEGIN { \
  10                 static bool __once; \
  11                 if (!__once) \
  12                 { \
  13                         assert(expr, __VA_ARGS__); \
  14                         __once = true; \
  15                 } \
  16         } MACRO_END
  17 #define devassert_once(...) MACRO_BEGIN if (autocvar_developer) assert_once(__VA_ARGS__); MACRO_END
  18
  19 #define demand(expr, ...) _assert(LOG_FATAL, expr, __VA_ARGS__)
  20 #define devdemand(...) MACRO_BEGIN if (autocvar_developer) demand(__VA_ARGS__); MACRO_END
  21
  22 #define _assert(f, expr, then) \
  23         MACRO_BEGIN \
  24         { \
  25                 if (!(expr)) \
  26                 { \
  27                         f("assertion failed: `" #expr "`\n"); \
  28                         then; \
  29                 } \
  30         } MACRO_END
  31
  32 #define ASSERT_LESS(name, var, const) noref int name[(const - var + 1)];
  33
  34
  35 #if defined(MENUQC)
  36 string(string, string...) strcat1n = #53;
  37 #else
  38 string(string, string...) strcat1n = #115;
  39 #endif
  40
  41 // would be nice if __FUNC__ could be concatenated at compile time
  42 #if 0
  43         // less work, bigger binary
  44         #define __SOURCELOC__ (sprintf("^7%s^9" "(" "^9"__FILE__"^7"  ":"  "^9"STR(__LINE__)"^7" ")", __FUNC__))
  45 #else
  46         #define __SOURCELOC__ (sprintf("^7%s^9" "(" "^9%s^7"  ":"  "^9%s^7" ")", __FUNC__, __FILE__, STR(__LINE__)))
  47 #endif
  48
  49 #define _LOG_HEADER(level) "^9[::" "^7"PROGNAME"^9" "::" level"^9" "] ", __SOURCELOC__
  50 #define _LOG(f, level, s) \
  51         MACRO_BEGIN { \
  52                 f(strcat1n(_LOG_HEADER(level), "\n^7", s, "\n")); \
  53         } MACRO_END
  54
  55 #define  LOG_FATAL(...) _LOG_FATAL(strcat1n(__VA_ARGS__))
  56 #define  LOG_FATALF(...) _LOG_FATAL(sprintf(__VA_ARGS__))
  57 #define _LOG_FATAL(s) _LOG(error, "^1FATAL", s)
  58
  59 #define  LOG_SEVERE(...) _LOG_SEVERE(strcat1n(__VA_ARGS__))
  60 #define  LOG_SEVEREF(...) _LOG_SEVERE(sprintf(__VA_ARGS__))
  61 #define _LOG_SEVERE(s) _LOG(backtrace, "^1SEVERE", s)
  62
  63 #define  LOG_WARN(...) _LOG_WARN(strcat1n(__VA_ARGS__))
  64 #define  LOG_WARNF(...) _LOG_WARN(sprintf(__VA_ARGS__))
  65 #define _LOG_WARN(s) _LOG(print, "^3WARNING", s)
  66
  67 #define  LOG_INFO(...) _LOG_INFO(strcat1n(__VA_ARGS__))
  68 #define  LOG_INFOF(...) _LOG_INFO(sprintf(__VA_ARGS__))
  69 #define _LOG_INFO(s) \
  70         MACRO_BEGIN { \
  71                 dprint(_LOG_HEADER("^5INFO")); \
  72                 string __s = s; \
  73                 print("\n^7", __s); \
  74                 /* TODO: unconditionally add a newline when possible */ \
  75                 if (str2chr(__s, strlen(__s) - 1) != '\n') { print("\n"); } \
  76         } MACRO_END
  77
  78 #define  LOG_TRACE(...) _LOG_TRACE(strcat1n(__VA_ARGS__))
  79 #define  LOG_TRACEF(...) _LOG_TRACE(sprintf(__VA_ARGS__))
  80 #define _LOG_TRACE(s) _LOG(dprint, "^6TRACE", s)
  81
  82 #define  LOG_DEBUG(...) _LOG_DEBUG(strcat1n(__VA_ARGS__))
  83 #define  LOG_DEBUGF(...) _LOG_DEBUG(sprintf(__VA_ARGS__))
  84 #define _LOG_DEBUG(s) _LOG(dprint2, "^2DEBUG", s)
  85
  86 #define dprint2(msg) \
  87         MACRO_BEGIN { \
  88                 if (autocvar_developer > 1) dprint(msg); \
  89         } MACRO_END
  90
  91 // TODO: this sucks, lets find a better way to do backtraces?
  92 #define _backtrace() builtin_remove(NULL)
  93
  94 noref int autocvar_developer;
  95 noref bool autocvar_prvm_backtraceforwarnings;
  96
  97 #ifdef SVQC
  98 #define bt_cvar_set(cvar, value) builtin_cvar_set(cvar, value)
  99 #else
 100 #define bt_cvar_set(cvar, value) cvar_set(cvar, value)
 101 #endif
 102
 103 #define backtrace(msg) \
 104         MACRO_BEGIN \
 105         { \
 106                 int dev = autocvar_developer; \
 107                 bool war = autocvar_prvm_backtraceforwarnings; \
 108                 bt_cvar_set("developer", "1"); \
 109                 bt_cvar_set("prvm_backtraceforwarnings", "1"); \
 110                 print("\n--- CUT HERE ---\n", msg); \
 111                 _backtrace(); \
 112                 print("\n--- CUT UNTIL HERE ---\n"); \
 113                 bt_cvar_set("developer", ftos(dev)); \
 114                 bt_cvar_set("prvm_backtraceforwarnings", ftos(war)); \
 115         } MACRO_END