]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/lib/log.qh
Disable cl_useenginerefdef by default so that the QC implementation is used
[xonotic/xonotic-data.pk3dir.git] / qcsrc / lib / log.qh
index 8a52073396bdedbedd9d15e06cd72ac07f8f9cbf..16875c8bc3e233224cc484b49a8efa63ed5f4932 100644 (file)
@@ -1,74 +1,97 @@
-#ifndef LOG_H
-#define LOG_H
-
-#define _printferr(...) error(sprintf(__VA_ARGS__))
-#define _printfbt(...) backtrace(sprintf(__VA_ARGS__))
-#define printf(...) print(sprintf(__VA_ARGS__))
-#define dprintf(...) dprint(sprintf(__VA_ARGS__))
-#define _dprintf2(...) \
+#pragma once
+
+#include "progname.qh"
+
+void print_assertfailed_severe(string expr);
+void print_assertfailed_fatal(string expr);
+
+#define assert(expr, ...) _assert(print_assertfailed_severe, expr, __VA_ARGS__)
+#define devassert(...) MACRO_BEGIN if (autocvar_developer > 0) assert(__VA_ARGS__); MACRO_END
+
+#define assert_once(expr, ...) \
        MACRO_BEGIN \
-       { \
-               if (autocvar_developer > 1) dprintf(__VA_ARGS__); \
-       } MACRO_END
+               static bool __once; \
+               if (!__once) \
+               { \
+                       assert(expr, __VA_ARGS__); \
+                       __once = true; \
+               } \
+       MACRO_END
+#define devassert_once(...) MACRO_BEGIN if (autocvar_developer > 0) assert_once(__VA_ARGS__); MACRO_END
+
+#define demand(expr, ...) _assert(print_assertfailed_fatal, expr, __VA_ARGS__)
+#define devdemand(...) MACRO_BEGIN if (autocvar_developer > 0) demand(__VA_ARGS__); MACRO_END
 
-#define assert(expr, ...) _assert(LOG_SEVERE, expr, __VA_ARGS__)
-#define ASSERT(expr, ...) _assert(LOG_FATAL, expr, __VA_ARGS__)
 #define _assert(f, expr, then) \
        MACRO_BEGIN \
-       { \
                if (!(expr)) \
                { \
-                       f("assertion failed: `" #expr "`\n"); \
+                       f(#expr); \
                        then; \
                } \
-       MACRO_END
+       MACRO_END
 
 #define ASSERT_LESS(name, var, const) noref int name[(const - var + 1)];
 
-#define _LOG(f, level, s) f("[::"level "] ["__FILE__ ":%s:%.0f] %s", __FUNC__, __LINE__, s)
 
-#define  LOG_FATAL(...) _LOG_FATAL(strcat("", __VA_ARGS__))
+#if defined(MENUQC)
+string(string, string...) strcat1n = #53;
+#else
+string(string, string...) strcat1n = #115;
+#endif
+
+// would be nice if __FUNC__ could be concatenated at compile time
+#if 0
+       // less work, bigger binary
+       #define __SOURCELOC__ (sprintf("^7%s^9(^9"__FILE__"^7:^9"STR(__LINE__)"^7)", __FUNC__))
+#else
+       #define __SOURCELOC__ (sprintf("^7%s^9(^9%s^7:^9%s^7)", __FUNC__, __FILE__, STR(__LINE__)))
+#endif
+
+#define _LOG_HEADER(level) "^9[::^7"PROGNAME"^9::"level"^9] ", __SOURCELOC__
+#define _LOG(f, level, s) \
+       MACRO_BEGIN \
+               f(strcat1n(_LOG_HEADER(level), "\n^7", s, "\n")); \
+       MACRO_END
+
+#define  LOG_FATAL(...) _LOG_FATAL(strcat1n(__VA_ARGS__))
 #define  LOG_FATALF(...) _LOG_FATAL(sprintf(__VA_ARGS__))
-#define _LOG_FATAL(s) _LOG(_printferr, "FATAL", s)
+#define _LOG_FATAL(s) _LOG(error, "^1FATAL", s)
 
-#define  LOG_SEVERE(...) _LOG_SEVERE(strcat("", __VA_ARGS__))
+#define  LOG_SEVERE(...) _LOG_SEVERE(strcat1n(__VA_ARGS__))
 #define  LOG_SEVEREF(...) _LOG_SEVERE(sprintf(__VA_ARGS__))
-#define _LOG_SEVERE(s) _LOG(_printfbt, "SEVERE", s)
+#define _LOG_SEVERE(s) _LOG(backtrace, "^1SEVERE", s)
 
-#define  LOG_WARNING(...) _LOG_WARNING(strcat("", __VA_ARGS__))
-#define  LOG_WARNINGF(...) _LOG_WARNING(sprintf(__VA_ARGS__))
-#define _LOG_WARNING(s) _LOG(printf, "WARNING", s)
+#define  LOG_WARN(...) _LOG_WARN(strcat1n(__VA_ARGS__))
+#define  LOG_WARNF(...) _LOG_WARN(sprintf(__VA_ARGS__))
+#define _LOG_WARN(s) _LOG(print, "^3WARNING", s)
 
-#define  LOG_INFO(...) \
+#define  LOG_INFO(...) _LOG_INFO(strcat1n(__VA_ARGS__))
+#define  LOG_INFOF(...) _LOG_INFO(sprintf(__VA_ARGS__))
+#define _LOG_INFO(s) \
        MACRO_BEGIN \
-       { \
-               if (autocvar_developer) _LOG_INFO(strcat("", __VA_ARGS__)); \
-               else print(__VA_ARGS__); \
-       } MACRO_END
-#define  LOG_INFOF(...) \
-       MACRO_BEGIN \
-       { \
-               if (autocvar_developer) _LOG_INFO(sprintf(__VA_ARGS__)); \
-               else printf(__VA_ARGS__); \
-       } MACRO_END
-#define _LOG_INFO(s) _LOG(printf, "INFO", s)
+               dprint(_LOG_HEADER("^5INFO")); \
+               string __s = s; \
+               print("\n^7", __s); \
+               /* TODO: unconditionally add a newline when possible */ \
+               if (str2chr(__s, strlen(__s) - 1) != '\n') { print("\n"); } \
+       MACRO_END
 
-#define  LOG_TRACE(...) _LOG_TRACE(strcat("", __VA_ARGS__))
+#define  LOG_TRACE(...) _LOG_TRACE(strcat1n(__VA_ARGS__))
 #define  LOG_TRACEF(...) _LOG_TRACE(sprintf(__VA_ARGS__))
-#define _LOG_TRACE(s) _LOG(dprintf, "TRACE", s)
+#define _LOG_TRACE(s) _LOG(dprint, "^6TRACE", s)
 
-#define  LOG_DEBUG(...) _LOG_DEBUG(strcat("", __VA_ARGS__))
+#define  LOG_DEBUG(...) _LOG_DEBUG(strcat1n(__VA_ARGS__))
 #define  LOG_DEBUGF(...) _LOG_DEBUG(sprintf(__VA_ARGS__))
-#define _LOG_DEBUG(s) _LOG(_dprintf2, "DEBUG", s)
+#define _LOG_DEBUG(s) _LOG(dprint2, "^2DEBUG", s)
+
+#define dprint2(msg) \
+       MACRO_BEGIN \
+               if (autocvar_developer > 1) dprint(msg); \
+       MACRO_END
 
 // TODO: this sucks, lets find a better way to do backtraces?
-#ifdef SVQC
-       void builtin_remove(entity);
-       #define _backtrace() builtin_remove(NULL)
-#else
-       void remove(entity);
-       #define _backtrace() remove(NULL)
-#endif
+#define _backtrace() builtin_remove(NULL)
 
 noref int autocvar_developer;
 noref bool autocvar_prvm_backtraceforwarnings;
@@ -81,16 +104,25 @@ noref bool autocvar_prvm_backtraceforwarnings;
 
 #define backtrace(msg) \
        MACRO_BEGIN \
-       { \
                int dev = autocvar_developer; \
                bool war = autocvar_prvm_backtraceforwarnings; \
                bt_cvar_set("developer", "1"); \
                bt_cvar_set("prvm_backtraceforwarnings", "1"); \
-               print("\n--- CUT HERE ---\n", msg, "\n"); \
+               print("\n--- CUT HERE ---\n", msg); \
                _backtrace(); \
                print("\n--- CUT UNTIL HERE ---\n"); \
                bt_cvar_set("developer", ftos(dev)); \
                bt_cvar_set("prvm_backtraceforwarnings", ftos(war)); \
-       MACRO_END
+       MACRO_END
 
-#endif
+void print_assertfailed_severe(string expr)
+{
+       // this is inside a function to avoid expanding it on compilation everytime
+       LOG_SEVERE("assertion failed: `", expr, "`\n");
+}
+
+void print_assertfailed_fatal(string expr)
+{
+       // this is inside a function to avoid expanding it on compilation everytime
+       LOG_FATAL("assertion failed: `", expr, "`\n");
+}