Debug.h revision 7d0276624726ddea3245bb7d88c47db59278bf14 
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// Unsurprisingly, most users of this macro use std::cerr too.
30#include <iostream>
31
32namespace llvm {
33
34// DebugFlag - This boolean is set to true if the '-debug' command line option
35// is specified.  This should probably not be referenced directly, instead, use
36// the DEBUG macro below.
37//
38extern bool DebugFlag;
39
40// isCurrentDebugType - Return true if the specified string is the debug type
41// specified on the command line, or if none was specified on the command line
42// with the -debug-only=X option.
43//
44bool isCurrentDebugType(const char *Type);
45
46// DEBUG macro - This macro should be used by passes to emit debug information.
47// In the '-debug' option is specified on the commandline, and if this is a
48// debug build, then the code specified as the option to the macro will be
49// executed.  Otherwise it will not be.  Example:
50//
51// DEBUG(cerr << "Bitset contains: " << Bitset << "\n");
52//
53
54#ifndef DEBUG_TYPE
55#define DEBUG_TYPE ""
56#endif
57
58#ifdef NDEBUG
59#define DEBUG(X)
60#else
61#define DEBUG(X) \
62  do { if (DebugFlag && isCurrentDebugType(DEBUG_TYPE)) { X; } } while (0)
63#endif
64
65} // End llvm namespace
66
67#endif
68