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