Debug.h revision b2109ce97881269a610fa4afbcbca350e975174d 
1//===- Debug.h - An easy way to add debug output to your code ---*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file implements a handle way of adding debugging information to your
11// code, without it being enabled all of the time, and without having to add
12// command line options to enable it.
13//
14// In particular, just wrap your code with the DEBUG() macro, and it will be
15// enabled automatically if you specify '-debug' on the command-line.
16// Alternatively, you can also use the SET_DEBUG_TYPE("foo") macro to specify
17// that your debug code belongs to class "foo".  Then, on the command line, you
18// can specify '-debug-only=foo' to enable JUST the debug information for the
19// foo class.
20//
21// When compiling in release mode, the -debug-* options and all code in DEBUG()
22// statements disappears, so it does not effect the runtime of the code.
23//
24//===----------------------------------------------------------------------===//
25
26#ifndef SUPPORT_DEBUG_H
27#define SUPPORT_DEBUG_H
28
29// DebugFlag - This boolean is set to true if the '-debug' command line option
30// is specified.  This should probably not be referenced directly, instead, use
31// the DEBUG macro below.
32//
33extern bool DebugFlag;
34
35// isCurrentDebugType - Return true if the specified string is the debug type
36// specified on the command line, or if none was specified on the command line
37// with the -debug-only=X option.
38//
39bool isCurrentDebugType(const char *Type);
40
41// DEBUG macro - This macro should be used by passes to emit debug information.
42// In the '-debug' option is specified on the commandline, and if this is a
43// debug build, then the code specified as the option to the macro will be
44// executed.  Otherwise it will not be.  Example:
45//
46// DEBUG(cerr << "Bitset contains: " << Bitset << "\n");
47//
48
49#ifndef DEBUG_TYPE
50#define DEBUG_TYPE ""
51#endif
52
53#ifdef NDEBUG
54#define DEBUG(X)
55#else
56#define DEBUG(X) \
57  do { if (DebugFlag && isCurrentDebugType(DEBUG_TYPE)) { X; } } while (0)
58#endif
59
60#endif
61