debug.h

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #ifndef DEBUG_H
00013 #define DEBUG_H
00014 
00015 /* Debugging messages policy:
00016  * These should be the severities used for direct DEBUG() calls
00017  * maximum debugging level should be 10 if really deep, deep
00018  * debugging is needed.
00019  * (there is room for exceptions, but you have to have a good cause):
00020  * 0   - errors or severe warnings
00021  * 1   - other non-fatal, non-severe warnings
00022  * 2   - crude progress indicator of functionality
00023  * 3   - important debugging messages (function entry)
00024  * 4   - debugging messages (crude loop status, etc.)
00025  * 5   - detailed debugging information
00026  * 6.. - extremely detailed spamming
00027  */
00028 
00029 #ifdef NO_DEBUG_MESSAGES
00030   #define DEBUG(name, level, ...) { }
00031 #else /* NO_DEBUG_MESSAGES */
00032 
00037   #define DEBUG(name, level, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) debug(#name, __VA_ARGS__)
00038 
00039   extern int _debug_driver_level;
00040   extern int _debug_grf_level;
00041   extern int _debug_map_level;
00042   extern int _debug_misc_level;
00043   extern int _debug_net_level;
00044   extern int _debug_sprite_level;
00045   extern int _debug_oldloader_level;
00046   extern int _debug_npf_level;
00047   extern int _debug_yapf_level;
00048   extern int _debug_freetype_level;
00049   extern int _debug_script_level;
00050   extern int _debug_sl_level;
00051   extern int _debug_gamelog_level;
00052   extern int _debug_desync_level;
00053   extern int _debug_console_level;
00054 #ifdef RANDOM_DEBUG
00055   extern int _debug_random_level;
00056 #endif
00057 
00058   void CDECL debug(const char *dbg, const char *format, ...) WARN_FORMAT(2, 3);
00059 #endif /* NO_DEBUG_MESSAGES */
00060 
00061 char *DumpDebugFacilityNames(char *buf, char *last);
00062 void SetDebugString(const char *s);
00063 const char *GetDebugString();
00064 
00065 /* Shorter form for passing filename and linenumber */
00066 #define FILE_LINE __FILE__, __LINE__
00067 
00072 uint64 ottd_rdtsc();
00073 
00074 /* Used for profiling
00075  *
00076  * Usage:
00077  * TIC();
00078  *   --Do your code--
00079  * TOC("A name", 1);
00080  *
00081  * When you run the TIC() / TOC() multiple times, you can increase the '1'
00082  *  to only display average stats every N values. Some things to know:
00083  *
00084  * for (int i = 0; i < 5; i++) {
00085  *   TIC();
00086  *     --Do yuor code--
00087  *   TOC("A name", 5);
00088  * }
00089  *
00090  * Is the correct usage for multiple TIC() / TOC() calls.
00091  *
00092  * TIC() / TOC() creates its own block, so make sure not the mangle
00093  *  it with another block.
00094  **/
00095 #define TIC() {\
00096   uint64 _xxx_ = ottd_rdtsc();\
00097   static uint64 __sum__ = 0;\
00098   static uint32 __i__ = 0;
00099 
00100 #define TOC(str, count)\
00101   __sum__ += ottd_rdtsc() - _xxx_;\
00102   if (++__i__ == count) {\
00103     DEBUG(misc, 0, "[%s] " OTTD_PRINTF64 " [avg: %.1f]", str, __sum__, __sum__/(double)__i__);\
00104     __i__ = 0;\
00105     __sum__ = 0;\
00106   }\
00107 }
00108 
00109 void ShowInfo(const char *str);
00110 void CDECL ShowInfoF(const char *str, ...) WARN_FORMAT(1, 2);
00111 
00112 const char *GetLogPrefix();
00113 
00115 extern uint32 _realtime_tick;
00116 
00117 #endif /* DEBUG_H */