openttd-ottdgrfs: debug.h@fd60d4ecc921 (annotated)

2186 461a2aff3486 (svn r2701) Insert Id tags into all source files tron parents: 2125 diff changeset	1	/* $Id$ */
461a2aff3486 (svn r2701) Insert Id tags into all source files tron parents: 2125 diff changeset	2
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	3	#ifndef DEBUG_H
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	4	#define DEBUG_H
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	5
5568 75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	6	/* Debugging messages policy:
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	7	* These should be the severities used for direct DEBUG() calls
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	8	* maximum debugging level should be 10 if really deep, deep
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	9	* debugging is needed.
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	10	* (there is room for exceptions, but you have to have a good cause):
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	11	* 0 - errors or severe warnings
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	12	* 1 - other non-fatal, non-severe warnings
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	13	* 2 - crude progress indicator of functionality
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	14	* 3 - important debugging messages (function entry)
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	15	* 4 - debugging messages (crude loop status, etc.)
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	16	* 5 - detailed debugging information
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	17	* 6.. - extremely detailed spamming
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	18	*/
75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	19
5592 fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	20	/* Of course MSVC 2003 and lower has no support for variadic macros
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	21	* so we need to work around this... sigh */
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	22	#if defined(_MSC_VER) && (_MSC_VER < 1400)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	23	#define NO_VARARG_MACRO
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	24	#endif
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	25
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	26	#if defined(NO_VARARG_MACRO)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	27	enum DebugLevelType {
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	28	ai,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	29	driver,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	30	grf,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	31	map,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	32	misc,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	33	ms,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	34	net,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	35	sprite,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	36	oldloader,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	37	ntp,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	38	npf,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	39	yapf,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	40	freetype,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	41	sl,
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	42	};
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	43	#endif /* NO_VARARG_MACRO */
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	44
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	45	#ifdef NO_DEBUG_MESSAGES
5592 fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	46	#if defined(NO_VARARG_MACRO)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	47	static inline void DEBUG(int name, int level, ...) {}
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	48	#elif defined(__GNUC__) && (__GNUC__ < 3)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	49	#define DEBUG(name, level, args...)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	50	#else
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	51	#define DEBUG(name, level, ...)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	52	#endif
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	53	#else /* NO_DEBUG_MESSAGES */
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	54	#if defined(NO_VARARG_MACRO)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	55	void CDECL DEBUG(int name, int level, ...);
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	56	#elif defined(__GNUC__) && (__GNUC__ < 3)
5578 595d940beb8f (svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry. celestar parents: 5573 diff changeset	57	#define DEBUG(name, level, args...) if ((level == 0) \|\| ( _debug_ ## name ## _level >= level)) debug(#name, args)
595d940beb8f (svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry. celestar parents: 5573 diff changeset	58	#else
595d940beb8f (svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry. celestar parents: 5573 diff changeset	59	#define DEBUG(name, level, ...) if (level == 0 \|\| _debug_ ## name ## _level >= level) debug(#name, __VA_ARGS__)
595d940beb8f (svn r7579) -Fix: upon merging the bridge branch, I accidently reverted 7571. Re-revert it. Sorry. celestar parents: 5573 diff changeset	60	#endif
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	61
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	62	extern int _debug_ai_level;
2210 58a293892a66 (svn r2728) -Fix/Feature: Change the driver probing algorithm tron parents: 2186 diff changeset	63	extern int _debug_driver_level;
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	64	extern int _debug_grf_level;
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	65	extern int _debug_map_level;
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	66	extern int _debug_misc_level;
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	67	extern int _debug_ms_level;
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	68	extern int _debug_net_level;
5568 75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	69	extern int _debug_sprite_level;
1322 8697b73baa64 (svn r1826) -Feature: a brand new OldLoader so OpenTTD is TTD(Patch) compatible truelight parents: 1299 diff changeset	70	extern int _debug_oldloader_level;
2125 3098398bf7ff (svn r2635) Fix: [ntp/misc] Improve the old pathfinder. Changed it to A* instead of Dijkstra. ludde parents: 2033 diff changeset	71	extern int _debug_ntp_level;
1678 838dd6f46081 (svn r2182) - Add: [NPF] There is now a debug class for NPF. Use -d npf<level> to enable debugging printouts from npf. matthijs parents: 1322 diff changeset	72	extern int _debug_npf_level;
3900 4984308f9125 (svn r4987) Feature: Merged YAPF into trunk. Thanks to devs for continuous support and users for testing. KUDr parents: 3851 diff changeset	73	extern int _debug_yapf_level;
5108 dc67d70b5a45 (svn r7182) -Feature: Merge utf8 branch. This brings us support for Unicode/UTF-8 and the option for fonts rendered by FreeType. Language changes to come. peter1138 parents: 3900 diff changeset	74	extern int _debug_freetype_level;
5568 75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	75	extern int _debug_sl_level;
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	76
5592 fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	77	#if !defined(NO_VARARG_MACRO)
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	78	void CDECL debug(const char *dbg, ...);
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	79	#endif /* NO_VARARG_MACRO */
fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	80	#endif /* NO_DEBUG_MESSAGES */
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	81
0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	82	void SetDebugString(const char *s);
1847 47703af63895 (svn r2352) - Feature: add the possibility to print out the current debug-level Darkvater parents: 1678 diff changeset	83	const char *GetDebugString(void);
1299 0a6510cc889b (svn r1803) Move debugging stuff into files of it's own tron parents: diff changeset	84
3851 4bbb525957b0 (svn r4875) - Fix: %ll don't work with mingw (msvrct.dll problem) glx parents: 3341 diff changeset	85	/* MSVCRT of course has to have a different syntax for long long sigh */
4bbb525957b0 (svn r4875) - Fix: %ll don't work with mingw (msvrct.dll problem) glx parents: 3341 diff changeset	86	#if defined(_MSC_VER) \|\| defined(__MINGW32__)
5592 fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	87	#define OTTD_PRINTF64 "I64"
3341 b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	88	#else
5592 fd60d4ecc921 (svn r7608) [cbh] - Merge with trunk r7593:7607 because I need 7607 here celestar parents: 5578 diff changeset	89	#define OTTD_PRINTF64 "ll"
3341 b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	90	#endif
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	91
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	92	// Used for profiling
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	93	#define TIC() {\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	94	extern uint64 _rdtsc(void);\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	95	uint64 _xxx_ = _rdtsc();\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	96	static uint64 __sum__ = 0;\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	97	static uint32 __i__ = 0;
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	98
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	99	#define TOC(str, count)\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	100	__sum__ += _rdtsc() - _xxx_;\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	101	if (++__i__ == count) {\
5568 75f13d7bfaed (svn r7565) -Codechange: Rework DEBUG functionality. Look for appropiate debugging levels to Darkvater parents: 5108 diff changeset	102	DEBUG(misc, 0, "[%s] %" OTTD_PRINTF64 "u [avg: %.1f]\n", str, __sum__, __sum__/(double)__i__);\
3341 b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	103	__i__ = 0;\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	104	__sum__ = 0;\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	105	}\
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	106	}
b8febc9509d7 (svn r4125) - Feature: Add a general TIC() TOC() mechanism using rdtsc or something similar on non-i386 architectures to performance-tune (critical) code. Some systems are probably missing, but those can be added later. Darkvater parents: 2916 diff changeset	107
2436 177cb6a8339f (svn r2962) - const correctness for all Get* functions and most Draw* functions that don't change their pointer parameters Darkvater parents: 2210 diff changeset	108	#endif /* DEBUG_H */

author	celestar
	Fri, 29 Dec 2006 10:13:35 +0000
branch	custombridgeheads
changeset 5592	fd60d4ecc921
parent 5578	595d940beb8f
permissions	-rw-r--r--