1

/* $Id$ */

     2

     3

/** @file debug.h */

     4

     5

#ifndef DEBUG_H

     6

#define DEBUG_H

     7

     8

/* Debugging messages policy:

     9

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

    10

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

    11

 * debugging is needed.

    12

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

    13

 * 0   - errors or severe warnings

    14

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

    15

 * 2   - crude progress indicator of functionality

    16

 * 3   - important debugging messages (function entry)

    17

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

    18

 * 5   - detailed debugging information

    19

 * 6.. - extremely detailed spamming

    20

 */

    21

    22

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

    23

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

    24

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

    25

	#define NO_VARARG_MACRO

    26

#endif

    27

    28

#if defined(NO_VARARG_MACRO)

    29

	enum DebugLevelType {

    30

		ai,

    31

		driver,

    32

		grf,

    33

		map,

    34

		misc,

    35

		ms,

    36

		net,

    37

		sprite,

    38

		oldloader,

    39

		ntp,

    40

		npf,

    41

		yapf,

    42

		freetype,

    43

		sl,

    44

		station,

    45

	};

    46

#endif /* NO_VARARG_MACRO */

    47

    48

#ifdef NO_DEBUG_MESSAGES

    49

	#if defined(NO_VARARG_MACRO)

    50

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

    51

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

    52

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

    53

	#else

    54

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

    55

	#endif

    56

#else /* NO_DEBUG_MESSAGES */

    57

	#if defined(NO_VARARG_MACRO)

    58

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

    59

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

    60

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

    61

	#else

    62

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

    63

	#endif

    64

    65

	extern int _debug_ai_level;

    66

	extern int _debug_driver_level;

    67

	extern int _debug_grf_level;

    68

	extern int _debug_map_level;

    69

	extern int _debug_misc_level;

    70

	extern int _debug_ms_level;

    71

	extern int _debug_net_level;

    72

	extern int _debug_sprite_level;

    73

	extern int _debug_oldloader_level;

    74

	extern int _debug_ntp_level;

    75

	extern int _debug_npf_level;

    76

	extern int _debug_yapf_level;

    77

	extern int _debug_freetype_level;

    78

	extern int _debug_sl_level;

    79

	extern int _debug_station_level;

    80

    81

	#if !defined(NO_VARARG_MACRO)

    82

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

    83

	#endif /* NO_VARARG_MACRO */

    84

#endif /* NO_DEBUG_MESSAGES */

    85

    86

void SetDebugString(const char *s);

    87

const char *GetDebugString();

    88

    89

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

    90

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

    91

	#define OTTD_PRINTF64 "I64"

    92

#else

    93

	#define OTTD_PRINTF64 "ll"

    94

#endif

    95

    96

/* Used for profiling

    97

 *

    98

 * Usage:

    99

 * TIC();

   100

 *   --Do your code--

   101

 * TOC("A name", 1);

   102

 *

   103

 * When you run the TIC() / TOC() multiple times, you can increase the '1'

   104

 *  to only display average stats every N values. Some things to know:

   105

 *

   106

 * for (int i = 0; i < 5; i++) {

   107

 *   TIC();

   108

 *     --Do yuor code--

   109

 *   TOC("A name", 5);

   110

 * }

   111

 *

   112

 * Is the correct usage for multiple TIC() / TOC() calls.

   113

 *

   114

 * TIC() / TOC() creates it's own block, so make sure not the mangle

   115

 *  it with an other block.

   116

 **/

   117

#define TIC() {\

   118

	extern uint64 _rdtsc();\

   119

	uint64 _xxx_ = _rdtsc();\

   120

	static uint64 __sum__ = 0;\

   121

	static uint32 __i__ = 0;

   122

   123

#define TOC(str, count)\

   124

	__sum__ += _rdtsc() - _xxx_;\

   125

	if (++__i__ == count) {\

   126

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

   127

		__i__ = 0;\

   128

		__sum__ = 0;\

   129

	}\

   130

}

   131

   132

void ShowInfo(const char *str);

   133

void CDECL ShowInfoF(const char *str, ...);

   134

   135

#ifdef DEBUG_DUMP_COMMANDS

   136

	void CDECL DebugDumpCommands(const char *s, ...);

   137

#else /* DEBUG_DUMP_COMMANDS */

   138

	static inline void DebugDumpCommands(const char *s, ...) {}

   139

#endif /* DEBUG_DUMP_COMMANDS */

   140

   141

#endif /* DEBUG_H */