1

/* $Id$ */

     2

     3

#ifndef DEBUG_H

     4

#define DEBUG_H

     5

     6

/* Debugging messages policy:

     7

 * These should be the severities used for direct DEBUG() calls

     8

 * maximum debugging level should be 10 if really deep, deep

     9

 * debugging is needed.

    10

 * (there is room for exceptions, but you have to have a good cause):

    11

 * 0   - errors or severe warnings

    12

 * 1   - other non-fatal, non-severe warnings

    13

 * 2   - crude progress indicator of functionality

    14

 * 3   - important debugging messages (function entry)

    15

 * 4   - debugging messages (crude loop status, etc.)

    16

 * 5   - detailed debugging information

    17

 * 6.. - extremely detailed spamming

    18

 */

    19

    20

/* Of course MSVC 2003 and lower has no support for variadic macros

    21

 * so we need to work around this... *sigh* */

    22

#if defined(_MSC_VER) && (_MSC_VER < 1400)

    23

	#define NO_VARARG_MACRO

    24

#endif

    25

    26

#if defined(NO_VARARG_MACRO)

    27

	enum DebugLevelType {

    28

		ai,

    29

		driver,

    30

		grf,

    31

		map,

    32

		misc,

    33

		ms,

    34

		net,

    35

		sprite,

    36

		oldloader,

    37

		ntp,

    38

		npf,

    39

		yapf,

    40

		freetype,

    41

		sl,

    42

		station,

    43

	};

    44

#endif /* NO_VARARG_MACRO */

    45

    46

#ifdef NO_DEBUG_MESSAGES

    47

	#if defined(NO_VARARG_MACRO)

    48

		static inline void DEBUG(int name, int level, ...) {}

    49

	#elif defined(__GNUC__) && (__GNUC__ < 3)

    50

		#define DEBUG(name, level, args...)

    51

	#else

    52

		#define DEBUG(name, level, ...)

    53

	#endif

    54

#else /* NO_DEBUG_MESSAGES */

    55

	#if defined(NO_VARARG_MACRO)

    56

		void CDECL DEBUG(int name, int level, ...);

    57

	#elif defined(__GNUC__) && (__GNUC__ < 3)

    58

		#define DEBUG(name, level, args...) if ((level == 0) || ( _debug_ ## name ## _level >= level)) debug(#name, args)

    59

	#else

    60

		#define DEBUG(name, level, ...) if (level == 0 || _debug_ ## name ## _level >= level) debug(#name, __VA_ARGS__)

    61

	#endif

    62

    63

	extern int _debug_ai_level;

    64

	extern int _debug_driver_level;

    65

	extern int _debug_grf_level;

    66

	extern int _debug_map_level;

    67

	extern int _debug_misc_level;

    68

	extern int _debug_ms_level;

    69

	extern int _debug_net_level;

    70

	extern int _debug_sprite_level;

    71

	extern int _debug_oldloader_level;

    72

	extern int _debug_ntp_level;

    73

	extern int _debug_npf_level;

    74

	extern int _debug_yapf_level;

    75

	extern int _debug_freetype_level;

    76

	extern int _debug_sl_level;

    77

	extern int _debug_station_level;

    78

    79

	#if !defined(NO_VARARG_MACRO)

    80

		void CDECL debug(const char *dbg, ...);

    81

	#endif /* NO_VARARG_MACRO */

    82

#endif /* NO_DEBUG_MESSAGES */

    83

    84

void SetDebugString(const char *s);

    85

const char *GetDebugString(void);

    86

    87

/* MSVCRT of course has to have a different syntax for long long *sigh* */

    88

#if defined(_MSC_VER) || defined(__MINGW32__)

    89

	#define OTTD_PRINTF64 "I64"

    90

#else

    91

	#define OTTD_PRINTF64 "ll"

    92

#endif

    93

    94

// Used for profiling

    95

#define TIC() {\

    96

	extern uint64 _rdtsc(void);\

    97

	uint64 _xxx_ = _rdtsc();\

    98

	static uint64 __sum__ = 0;\

    99

	static uint32 __i__ = 0;

   100

   101

#define TOC(str, count)\

   102

	__sum__ += _rdtsc() - _xxx_;\

   103

	if (++__i__ == count) {\

   104

		DEBUG(misc, 0, "[%s] %" OTTD_PRINTF64 "u [avg: %.1f]\n", str, __sum__, __sum__/(double)__i__);\

   105

		__i__ = 0;\

   106

		__sum__ = 0;\

   107

	}\

   108

}

   109

   110

#endif /* DEBUG_H */