1

/* $Id$ */

     2

     3

/** @file debug.h */

     4

     5

#ifndef DEBUG_H

     6

#define DEBUG_H

     7

     8

#include "stdafx.h" // We need this for CDECL

     9

    10

/* Debugging messages policy:

    11

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

    12

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

    13

 * debugging is needed.

    14

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

    15

 * 0   - errors or severe warnings

    16

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

    17

 * 2   - crude progress indicator of functionality

    18

 * 3   - important debugging messages (function entry)

    19

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

    20

 * 5   - detailed debugging information

    21

 * 6.. - extremely detailed spamming

    22

 */

    23

    24

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

    25

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

    26

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

    27

	#define NO_VARARG_MACRO

    28

#endif

    29

    30

#if defined(NO_VARARG_MACRO)

    31

	enum DebugLevelType {

    32

		ai,

    33

		driver,

    34

		grf,

    35

		map,

    36

		misc,

    37

		ms,

    38

		net,

    39

		sprite,

    40

		oldloader,

    41

		ntp,

    42

		npf,

    43

		yapf,

    44

		freetype,

    45

		sl,

    46

		station,

    47

		eco,

    48

	};

    49

#endif /* NO_VARARG_MACRO */

    50

    51

#ifdef NO_DEBUG_MESSAGES

    52

	#if defined(NO_VARARG_MACRO)

    53

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

    54

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

    55

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

    56

	#else

    57

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

    58

	#endif

    59

#else /* NO_DEBUG_MESSAGES */

    60

	#if defined(NO_VARARG_MACRO)

    61

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

    62

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

    63

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

    64

	#else

    65

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

    66

	#endif

    67

    68

	extern int _debug_ai_level;

    69

	extern int _debug_driver_level;

    70

	extern int _debug_grf_level;

    71

	extern int _debug_map_level;

    72

	extern int _debug_misc_level;

    73

	extern int _debug_ms_level;

    74

	extern int _debug_net_level;

    75

	extern int _debug_sprite_level;

    76

	extern int _debug_oldloader_level;

    77

	extern int _debug_ntp_level;

    78

	extern int _debug_npf_level;

    79

	extern int _debug_yapf_level;

    80

	extern int _debug_freetype_level;

    81

	extern int _debug_sl_level;

    82

	extern int _debug_station_level;

    83

	extern int _debug_eco_level;

    84

    85

	#if !defined(NO_VARARG_MACRO)

    86

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

    87

	#endif /* NO_VARARG_MACRO */

    88

#endif /* NO_DEBUG_MESSAGES */

    89

    90

void SetDebugString(const char *s);

    91

const char *GetDebugString();

    92

    93

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

    94

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

    95

	#define OTTD_PRINTF64 "I64"

    96

#else

    97

	#define OTTD_PRINTF64 "ll"

    98

#endif

    99

   100

/* Used for profiling */

   101

#define TIC() {\

   102

	extern uint64 _rdtsc();\

   103

	uint64 _xxx_ = _rdtsc();\

   104

	static uint64 __sum__ = 0;\

   105

	static uint32 __i__ = 0;

   106

   107

#define TOC(str, count)\

   108

	__sum__ += _rdtsc() - _xxx_;\

   109

	if (++__i__ == count) {\

   110

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

   111

		__i__ = 0;\

   112

		__sum__ = 0;\

   113

	}\

   114

}

   115

   116

#endif /* DEBUG_H */