1 /* ****************************************************************** 2 debug 3 Part of FSE library 4 Copyright (C) 2013-present, Yann Collet. 5 6 BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) 7 8 Redistribution and use in source and binary forms, with or without 9 modification, are permitted provided that the following conditions are 10 met: 11 12 * Redistributions of source code must retain the above copyright 13 notice, this list of conditions and the following disclaimer. 14 * Redistributions in binary form must reproduce the above 15 copyright notice, this list of conditions and the following disclaimer 16 in the documentation and/or other materials provided with the 17 distribution. 18 19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 You can contact the author at : 32 - Source repository : https://github.com/Cyan4973/FiniteStateEntropy 33 ****************************************************************** */ 34 35 36 /* 37 * The purpose of this header is to enable debug functions. 38 * They regroup assert(), DEBUGLOG() and RAWLOG(). 39 * 40 * By default, DEBUGLEVEL==0, which means debug is disabled. 41 * 42 * Level 1 enables assert() only. 43 * Starting level 2, traces can be generated and pushed to stderr. 44 * The higher the level, the more verbose the traces. 45 * 46 * It's possible to dynamically adjust level using variable g_debug_level, 47 * which is only declared if DEBUGLEVEL>=2, 48 * and is a global variable, not multi-thread protected (use with care) 49 */ 50 51 #ifndef DEBUG_H_12987983217 52 #define DEBUG_H_12987983217 53 54 #if defined (__cplusplus) 55 extern "C" { 56 #endif 57 58 59 /* static assert is triggered at compile time, leaving no runtime artefact, 60 * but can only work with compile-time constants */ 61 #define DEBUG_STATIC_ASSERT(c) { enum { DEBUG_static_assert = 1/(int)(!!(c)) }; } 62 63 64 /* DEBUGLEVEL is expected to be defined externally, 65 * typically through compiler command line. 66 * Value must be a number. */ 67 #ifndef DEBUGLEVEL 68 # define DEBUGLEVEL 0 69 #endif 70 71 /* recommended values for DEBUGLEVEL : 72 * 0 : no debug, all functions disabled (except DEBUG_STATIC_ASSERT) 73 * 1 : no display, enables assert() only 74 * 2 : reserved, for currently active debug path 75 * 3 : events once per object lifetime (CCtx, CDict, etc.) 76 * 4 : events once per frame 77 * 5 : events once per block 78 * 6 : events once per sequence (verbose) 79 * 7+: events at every position (*very* verbose) 80 * 81 * It's generally inconvenient to output traces > 5. 82 * In which case, it's possible to selectively enable higher verbosity levels 83 * by modifying g_debug_level. 84 */ 85 86 #if (DEBUGLEVEL>=1) 87 # include <assert.h> 88 #else 89 # ifndef assert /* assert may be already defined, due to prior #include <assert.h> */ 90 # define assert(condition) ((void)0) /* disable assert (default) */ 91 # endif 92 #endif 93 94 #if (DEBUGLEVEL>=2) 95 # include <stdio.h> 96 extern int g_debuglevel; /* here, this variable is only declared, 97 it actually lives in debug.c, 98 and is shared by the whole process. 99 It's typically used to enable very verbose levels 100 on selective conditions (such as position in src) */ 101 102 # define RAWLOG(l, ...) { \ 103 if (l<=g_debuglevel) { \ 104 fprintf(stderr, __VA_ARGS__); \ 105 } } 106 # define DEBUGLOG(l, ...) { \ 107 if (l<=g_debuglevel) { \ 108 fprintf(stderr, __FILE__ ": " __VA_ARGS__); \ 109 fprintf(stderr, " \n"); \ 110 } } 111 #else 112 # define RAWLOG(l, ...) {} /* disabled */ 113 # define DEBUGLOG(l, ...) {} /* disabled */ 114 #endif 115 116 117 #if defined (__cplusplus) 118 } 119 #endif 120 121 #endif /* DEBUG_H_12987983217 */ 122