1

/* $Id$ */

     2

     3

/** @file debug.h Functions related to debugging. */

     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

#ifdef NO_DEBUG_MESSAGES

    23

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

    24

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

    25

	#else

    26

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

    27

	#endif

    28

#else /* NO_DEBUG_MESSAGES */

    29

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

    30

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

    31

	#else

    32

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

    33

	#endif

    34

    35

	extern int _debug_ai_level;

    36

	extern int _debug_driver_level;

    37

	extern int _debug_grf_level;

    38

	extern int _debug_map_level;

    39

	extern int _debug_misc_level;

    40

	extern int _debug_ms_level;

    41

	extern int _debug_net_level;

    42

	extern int _debug_sprite_level;

    43

	extern int _debug_oldloader_level;

    44

	extern int _debug_ntp_level;

    45

	extern int _debug_npf_level;

    46

	extern int _debug_yapf_level;

    47

	extern int _debug_freetype_level;

    48

	extern int _debug_sl_level;

    49

	extern int _debug_station_level;

    50

	extern int _debug_gamelog_level;

    51

    52

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

    53

#endif /* NO_DEBUG_MESSAGES */

    54

    55

void SetDebugString(const char *s);

    56

const char *GetDebugString();

    57

    58

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

    59

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

    60

	#define OTTD_PRINTF64 "I64"

    61

#else

    62

	#define OTTD_PRINTF64 "ll"

    63

#endif

    64

    65

/* Used for profiling

    66

 *

    67

 * Usage:

    68

 * TIC();

    69

 *   --Do your code--

    70

 * TOC("A name", 1);

    71

 *

    72

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

    73

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

    74

 *

    75

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

    76

 *   TIC();

    77

 *     --Do yuor code--

    78

 *   TOC("A name", 5);

    79

 * }

    80

 *

    81

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

    82

 *

    83

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

    84

 *  it with an other block.

    85

 **/

    86

#define TIC() {\

    87

	extern uint64 ottd_rdtsc();\

    88

	uint64 _xxx_ = ottd_rdtsc();\

    89

	static uint64 __sum__ = 0;\

    90

	static uint32 __i__ = 0;

    91

    92

#define TOC(str, count)\

    93

	__sum__ += ottd_rdtsc() - _xxx_;\

    94

	if (++__i__ == count) {\

    95

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

    96

		__i__ = 0;\

    97

		__sum__ = 0;\

    98

	}\

    99

}

   100

   101

void ShowInfo(const char *str);

   102

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

   103

   104

#ifdef DEBUG_DUMP_COMMANDS

   105

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

   106

#else /* DEBUG_DUMP_COMMANDS */

   107

	/* when defined as an empty function with variable argument list,

   108

	 * it can't be inlined - so define it as an empty macro */

   109

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

   110

		#define DebugDumpCommands(s, args...)

   111

	#else

   112

		#define DebugDumpCommands(s, ...)

   113

	#endif

   114

#endif /* DEBUG_DUMP_COMMANDS */

   115

   116

#endif /* DEBUG_H */