Flecs: include/flecs/addons/log.h Source File
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.0 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
log.h
Go to the documentation of this file.
1
28#ifndef FLECS_LOG_H
29#define FLECS_LOG_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35#ifdef FLECS_LOG
36
48
50FLECS_API
51 void ecs_deprecated_(
52 const char *file,
53 int32_t line,
54 const char *msg);
55
62FLECS_API
63 void ecs_log_push_(int32_t level);
64
71FLECS_API
72 void ecs_log_pop_(int32_t level);
73
81FLECS_API
82 bool ecs_should_log(int32_t level);
83
87
89FLECS_API
90 const char* ecs_strerror(
91 int32_t error_code);
92
93#else // FLECS_LOG
94
98
99#define ecs_deprecated_(file, line, msg)\
100 (void)file;\
101 (void)line;\
102 (void)msg
103
104#define ecs_log_push_(level)
105#define ecs_log_pop_(level)
106#define ecs_should_log(level) false
107
108#define ecs_strerror(error_code)\
109 (void)error_code
110
111#endif // FLECS_LOG
112
113
117
118FLECS_API
119void ecs_print_(
120 int32_t level,
121 const char *file,
122 int32_t line,
123 const char *fmt,
124 ...);
125
126FLECS_API
127void ecs_printv_(
128 int level,
129 const char *file,
130 int32_t line,
131 const char *fmt,
132 va_list args);
133
134FLECS_API
135void ecs_log_(
136 int32_t level,
137 const char *file,
138 int32_t line,
139 const char *fmt,
140 ...);
141
142FLECS_API
143void ecs_logv_(
144 int level,
145 const char *file,
146 int32_t line,
147 const char *fmt,
148 va_list args);
149
150FLECS_API
151void ecs_abort_(
152 int32_t error_code,
153 const char *file,
154 int32_t line,
155 const char *fmt,
156 ...);
157
158FLECS_API
159void ecs_assert_log_(
160 int32_t error_code,
161 const char *condition_str,
162 const char *file,
163 int32_t line,
164 const char *fmt,
165 ...);
166
167FLECS_API
168void ecs_parser_error_(
169 const char *name,
170 const char *expr,
171 int64_t column,
172 const char *fmt,
173 ...);
174
175FLECS_API
176void ecs_parser_errorv_(
177 const char *name,
178 const char *expr,
179 int64_t column,
180 const char *fmt,
181 va_list args);
182
183
187
188#ifndef FLECS_LEGACY /* C89 doesn't support variadic macros */
189
190/* Base logging function. Accepts a custom level */
191#define ecs_print(level, ...)\
192 ecs_print_(level, __FILE__, __LINE__, __VA_ARGS__)
193
194#define ecs_printv(level, fmt, args)\
195 ecs_printv_(level, __FILE__, __LINE__, fmt, args)
196
197#define ecs_log(level, ...)\
198 ecs_log_(level, __FILE__, __LINE__, __VA_ARGS__)
199
200#define ecs_logv(level, fmt, args)\
201 ecs_logv_(level, __FILE__, __LINE__, fmt, args)
202
203/* Tracing. Used for logging of infrequent events */
204#define ecs_trace_(file, line, ...) ecs_log_(0, file, line, __VA_ARGS__)
205#define ecs_trace(...) ecs_trace_(__FILE__, __LINE__, __VA_ARGS__)
206
207/* Warning. Used when an issue occurs, but operation is successful */
208#define ecs_warn_(file, line, ...) ecs_log_(-2, file, line, __VA_ARGS__)
209#define ecs_warn(...) ecs_warn_(__FILE__, __LINE__, __VA_ARGS__)
210
211/* Error. Used when an issue occurs, and operation failed. */
212#define ecs_err_(file, line, ...) ecs_log_(-3, file, line, __VA_ARGS__)
213#define ecs_err(...) ecs_err_(__FILE__, __LINE__, __VA_ARGS__)
214
215/* Fatal. Used when an issue occurs, and the application cannot continue. */
216#define ecs_fatal_(file, line, ...) ecs_log_(-4, file, line, __VA_ARGS__)
217#define ecs_fatal(...) ecs_fatal_(__FILE__, __LINE__, __VA_ARGS__)
218
219/* Optionally include warnings about using deprecated features */
220#ifndef FLECS_NO_DEPRECATED_WARNINGS
221#define ecs_deprecated(...)\
222 ecs_deprecated_(__FILE__, __LINE__, __VA_ARGS__)
223#else
224#define ecs_deprecated(...)
225#endif // FLECS_NO_DEPRECATED_WARNINGS
226
227/* If no tracing verbosity is defined, pick default based on build config */
228#if !(defined(FLECS_LOG_0) || defined(FLECS_LOG_1) || defined(FLECS_LOG_2) || defined(FLECS_LOG_3))
229#if !defined(FLECS_NDEBUG)
230#define FLECS_LOG_3 /* Enable all tracing in debug mode. May slow things down */
231#else
232#define FLECS_LOG_0 /* Only enable infrequent tracing in release mode */
233#endif // !defined(FLECS_NDEBUG)
234#endif // !(defined(FLECS_LOG_0) || defined(FLECS_LOG_1) || defined(FLECS_LOG_2) || defined(FLECS_LOG_3))
235
236
237/* Define/undefine macros based on compiled-in tracing level. This can optimize
238 * out tracing statements from a build, which improves performance. */
239
240#if defined(FLECS_LOG_3) /* All debug tracing enabled */
241#define ecs_dbg_1(...) ecs_log(1, __VA_ARGS__);
242#define ecs_dbg_2(...) ecs_log(2, __VA_ARGS__);
243#define ecs_dbg_3(...) ecs_log(3, __VA_ARGS__);
244
245#define ecs_log_push_1() ecs_log_push_(1);
246#define ecs_log_push_2() ecs_log_push_(2);
247#define ecs_log_push_3() ecs_log_push_(3);
248
249#define ecs_log_pop_1() ecs_log_pop_(1);
250#define ecs_log_pop_2() ecs_log_pop_(2);
251#define ecs_log_pop_3() ecs_log_pop_(3);
252
253#define ecs_should_log_1() ecs_should_log(1)
254#define ecs_should_log_2() ecs_should_log(2)
255#define ecs_should_log_3() ecs_should_log(3)
256
257#define FLECS_LOG_2
258#define FLECS_LOG_1
259#define FLECS_LOG_0
260
261#elif defined(FLECS_LOG_2) /* Level 2 and below debug tracing enabled */
262#define ecs_dbg_1(...) ecs_log(1, __VA_ARGS__);
263#define ecs_dbg_2(...) ecs_log(2, __VA_ARGS__);
264#define ecs_dbg_3(...)
265
266#define ecs_log_push_1() ecs_log_push_(1);
267#define ecs_log_push_2() ecs_log_push_(2);
268#define ecs_log_push_3()
269
270#define ecs_log_pop_1() ecs_log_pop_(1);
271#define ecs_log_pop_2() ecs_log_pop_(2);
272#define ecs_log_pop_3()
273
274#define ecs_should_log_1() ecs_should_log(1)
275#define ecs_should_log_2() ecs_should_log(2)
276#define ecs_should_log_3() false
277
278#define FLECS_LOG_1
279#define FLECS_LOG_0
280
281#elif defined(FLECS_LOG_1) /* Level 1 debug tracing enabled */
282#define ecs_dbg_1(...) ecs_log(1, __VA_ARGS__);
283#define ecs_dbg_2(...)
284#define ecs_dbg_3(...)
285
286#define ecs_log_push_1() ecs_log_push_(1);
287#define ecs_log_push_2()
288#define ecs_log_push_3()
289
290#define ecs_log_pop_1() ecs_log_pop_(1);
291#define ecs_log_pop_2()
292#define ecs_log_pop_3()
293
294#define ecs_should_log_1() ecs_should_log(1)
295#define ecs_should_log_2() false
296#define ecs_should_log_3() false
297
298#define FLECS_LOG_0
299
300#elif defined(FLECS_LOG_0) /* No debug tracing enabled */
301#define ecs_dbg_1(...)
302#define ecs_dbg_2(...)
303#define ecs_dbg_3(...)
304
305#define ecs_log_push_1()
306#define ecs_log_push_2()
307#define ecs_log_push_3()
308
309#define ecs_log_pop_1()
310#define ecs_log_pop_2()
311#define ecs_log_pop_3()
312
313#define ecs_should_log_1() false
314#define ecs_should_log_2() false
315#define ecs_should_log_3() false
316
317#else /* No tracing enabled */
318#undef ecs_trace
319#define ecs_trace(...)
320#define ecs_dbg_1(...)
321#define ecs_dbg_2(...)
322#define ecs_dbg_3(...)
323
324#define ecs_log_push_1()
325#define ecs_log_push_2()
326#define ecs_log_push_3()
327
328#define ecs_log_pop_1()
329#define ecs_log_pop_2()
330#define ecs_log_pop_3()
331
332#endif // defined(FLECS_LOG_3)
333
334/* Default debug tracing is at level 1 */
335#define ecs_dbg ecs_dbg_1
336
337/* Default level for push/pop is 0 */
338#define ecs_log_push() ecs_log_push_(0)
339#define ecs_log_pop() ecs_log_pop_(0)
340
343#define ecs_abort(error_code, ...)\
344 ecs_abort_(error_code, __FILE__, __LINE__, __VA_ARGS__);\
345 ecs_os_abort(); abort(); /* satisfy compiler/static analyzers */
346
349#if defined(FLECS_NDEBUG) && !defined(FLECS_KEEP_ASSERT)
350#define ecs_assert(condition, error_code, ...)
351#else
352#define ecs_assert(condition, error_code, ...)\
353 if (!(condition)) {\
354 ecs_assert_log_(error_code, #condition, __FILE__, __LINE__, __VA_ARGS__);\
355 ecs_os_abort();\
356 }\
357 assert(condition) /* satisfy compiler/static analyzers */
358#endif // FLECS_NDEBUG
359
360#define ecs_assert_var(var, error_code, ...)\
361 ecs_assert(var, error_code, __VA_ARGS__);\
362 (void)var
363
366#ifndef FLECS_NDEBUG
367#define ecs_dbg_assert(condition, error_code, ...) ecs_assert(condition, error_code, __VA_ARGS__)
368#else
369#define ecs_dbg_assert(condition, error_code, ...)
370#endif
371
374#ifdef FLECS_SANITIZE
375#define ecs_san_assert(condition, error_code, ...) ecs_assert(condition, error_code, __VA_ARGS__)
376#else
377#define ecs_san_assert(condition, error_code, ...)
378#endif
379
380
381/* Silence dead code/unused label warnings when compiling without checks. */
382#define ecs_dummy_check\
383 if ((false)) {\
384 goto error;\
385 }
386
389#if defined(FLECS_NDEBUG) && !defined(FLECS_KEEP_ASSERT)
390#define ecs_check(condition, error_code, ...) ecs_dummy_check
391#else
392#ifdef FLECS_SOFT_ASSERT
393#define ecs_check(condition, error_code, ...)\
394 if (!(condition)) {\
395 ecs_assert_log_(error_code, #condition, __FILE__, __LINE__, __VA_ARGS__);\
396 goto error;\
397 }
398#else // FLECS_SOFT_ASSERT
399#define ecs_check(condition, error_code, ...)\
400 ecs_assert(condition, error_code, __VA_ARGS__);\
401 ecs_dummy_check
402#endif
403#endif // FLECS_NDEBUG
404
407#if defined(FLECS_NDEBUG) && !defined(FLECS_KEEP_ASSERT)
408#define ecs_throw(error_code, ...) ecs_dummy_check
409#else
410#ifdef FLECS_SOFT_ASSERT
411#define ecs_throw(error_code, ...)\
412 ecs_abort_(error_code, __FILE__, __LINE__, __VA_ARGS__);\
413 goto error;
414#else
415#define ecs_throw(error_code, ...)\
416 ecs_abort(error_code, __VA_ARGS__);\
417 ecs_dummy_check
418#endif
419#endif // FLECS_NDEBUG
420
422#define ecs_parser_error(name, expr, column, ...)\
423 ecs_parser_error_(name, expr, column, __VA_ARGS__)
424
425#define ecs_parser_errorv(name, expr, column, fmt, args)\
426 ecs_parser_errorv_(name, expr, column, fmt, args)
427
428#endif // FLECS_LEGACY
429
430
434
453FLECS_API
454 int ecs_log_set_level(
455 int level);
456
461FLECS_API
462 int ecs_log_get_level(void);
463
470FLECS_API
471 bool ecs_log_enable_colors(
472 bool enabled);
473
481FLECS_API
482 bool ecs_log_enable_timestamp(
483 bool enabled);
484
498FLECS_API
499 bool ecs_log_enable_timedelta(
500 bool enabled);
501
507FLECS_API
508 int ecs_log_last_error(void);
509
510
514
515#define ECS_INVALID_OPERATION (1)
516#define ECS_INVALID_PARAMETER (2)
517#define ECS_CONSTRAINT_VIOLATED (3)
518#define ECS_OUT_OF_MEMORY (4)
519#define ECS_OUT_OF_RANGE (5)
520#define ECS_UNSUPPORTED (6)
521#define ECS_INTERNAL_ERROR (7)
522#define ECS_ALREADY_DEFINED (8)
523#define ECS_MISSING_OS_API (9)
524#define ECS_OPERATION_FAILED (10)
525#define ECS_INVALID_CONVERSION (11)
526#define ECS_ID_IN_USE (12)
527#define ECS_CYCLE_DETECTED (13)
528#define ECS_LEAK_DETECTED (14)
529#define ECS_DOUBLE_FREE (15)
530
531#define ECS_INCONSISTENT_NAME (20)
532#define ECS_NAME_IN_USE (21)
533#define ECS_NOT_A_COMPONENT (22)
534#define ECS_INVALID_COMPONENT_SIZE (23)
535#define ECS_INVALID_COMPONENT_ALIGNMENT (24)
536#define ECS_COMPONENT_NOT_REGISTERED (25)
537#define ECS_INCONSISTENT_COMPONENT_ID (26)
538#define ECS_INCONSISTENT_COMPONENT_ACTION (27)
539#define ECS_MODULE_UNDEFINED (28)
540#define ECS_MISSING_SYMBOL (29)
541#define ECS_ALREADY_IN_USE (30)
542
543#define ECS_ACCESS_VIOLATION (40)
544#define ECS_COLUMN_INDEX_OUT_OF_RANGE (41)
545#define ECS_COLUMN_IS_NOT_SHARED (42)
546#define ECS_COLUMN_IS_SHARED (43)
547#define ECS_COLUMN_TYPE_MISMATCH (45)
548
549#define ECS_INVALID_WHILE_READONLY (70)
550#define ECS_LOCKED_STORAGE (71)
551#define ECS_INVALID_FROM_WORKER (72)
552
553
557
558#define ECS_BLACK "\033[1;30m"
559#define ECS_RED "\033[0;31m"
560#define ECS_GREEN "\033[0;32m"
561#define ECS_YELLOW "\033[0;33m"
562#define ECS_BLUE "\033[0;34m"
563#define ECS_MAGENTA "\033[0;35m"
564#define ECS_CYAN "\033[0;36m"
565#define ECS_WHITE "\033[1;37m"
566#define ECS_GREY "\033[0;37m"
567#define ECS_NORMAL "\033[0;49m"
568#define ECS_BOLD "\033[1;49m"
569
570#ifdef __cplusplus
571}
572#endif
573
576#endif // FLECS_LOG_H
ecs_log_last_error
FLECS_API int ecs_log_last_error(void)
Get last logged error code.
ecs_log_pop_
FLECS_API void ecs_log_pop_(int32_t level)
Decrease log stack.
ecs_should_log
FLECS_API bool ecs_should_log(int32_t level)
Should current level be logged.
ecs_strerror
FLECS_API const char * ecs_strerror(int32_t error_code)
Get description for error code.
ecs_deprecated_
FLECS_API void ecs_deprecated_(const char *file, int32_t line, const char *msg)
Log message indicating an operation is deprecated.
ecs_log_push_
FLECS_API void ecs_log_push_(int32_t level)
Increase log stack.
ecs_log_enable_colors
FLECS_API bool ecs_log_enable_colors(bool enabled)
Enable/disable tracing with colors.
ecs_log_get_level
FLECS_API int ecs_log_get_level(void)
Get current log level.
ecs_log_set_level
FLECS_API int ecs_log_set_level(int level)
Enable or disable log.
ecs_log_enable_timestamp
FLECS_API bool ecs_log_enable_timestamp(bool enabled)
Enable/disable logging timestamp.
ecs_log_enable_timedelta
FLECS_API bool ecs_log_enable_timedelta(bool enabled)
Enable/disable logging time since last log.