1 | /* |
---|
2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
3 | * > www.orxonox.net < |
---|
4 | * |
---|
5 | * |
---|
6 | * License notice: |
---|
7 | * |
---|
8 | * This program is free software; you can redistribute it and/or |
---|
9 | * modify it under the terms of the GNU General Public License |
---|
10 | * as published by the Free Software Foundation; either version 2 |
---|
11 | * of the License, or (at your option) any later version. |
---|
12 | * |
---|
13 | * This program is distributed in the hope that it will be useful, |
---|
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
16 | * GNU General Public License for more details. |
---|
17 | * |
---|
18 | * You should have received a copy of the GNU General Public License |
---|
19 | * along with this program; if not, write to the Free Software |
---|
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
21 | * |
---|
22 | * Author: |
---|
23 | * Fabian 'x3n' Landau |
---|
24 | * Reto Grieder |
---|
25 | * Co-authors: |
---|
26 | * ... |
---|
27 | * |
---|
28 | */ |
---|
29 | |
---|
30 | /** |
---|
31 | @file |
---|
32 | @brief |
---|
33 | Handles different output-levels of errors, warnings, infos and debug information. |
---|
34 | |
---|
35 | The COUT(level) macro acts like std::cout, but the output is only performed if the given |
---|
36 | level is <= the soft debug level. |
---|
37 | |
---|
38 | There are two used values in this file: |
---|
39 | - The hard debug level is used during compile time. It describes the highest allowed output level. |
---|
40 | - The soft debug level is used during runtime and is the maximum of the three configurable |
---|
41 | output-levels for console, log file and in game shell. |
---|
42 | |
---|
43 | The separation between the three devices is done by the OutputHandler. |
---|
44 | |
---|
45 | Possible levels are: |
---|
46 | 0: Very important output |
---|
47 | 1: Errors |
---|
48 | 2: Warnings |
---|
49 | 3: Information |
---|
50 | 4: Debug information |
---|
51 | 5: More debug information |
---|
52 | 6: Crazy debug information |
---|
53 | |
---|
54 | @example |
---|
55 | COUT(0) << "Very important output" << std::endl; |
---|
56 | COUT(1) << "Error: Something went wrong!" << std::endl; |
---|
57 | COUT(2) << "Warning: There might be a problem." << std::endl; |
---|
58 | COUT(3) << "Info: It's Monday" << std::endl; |
---|
59 | COUT(4) << "Debug: x is 1.23456" << std::endl; |
---|
60 | */ |
---|
61 | |
---|
62 | #ifndef _Util_Debug_H__ |
---|
63 | #define _Util_Debug_H__ |
---|
64 | |
---|
65 | #include "UtilPrereqs.h" |
---|
66 | #include "OutputHandler.h" |
---|
67 | |
---|
68 | namespace orxonox |
---|
69 | { |
---|
70 | // Just for convenience |
---|
71 | using std::endl; |
---|
72 | |
---|
73 | // Adjust this to discard certain output with level > hardDebugLevel at compile time already |
---|
74 | #ifdef ORXONOX_RELEASE |
---|
75 | const int hardDebugLevel = OutputLevel::Verbose; |
---|
76 | #elif defined(NDEBUG) |
---|
77 | const int hardDebugLevel = OutputLevel::Verbose; |
---|
78 | #else |
---|
79 | //! Maximum level for debug output that should be even processed at run time |
---|
80 | const int hardDebugLevel = OutputLevel::Ultra; |
---|
81 | #endif |
---|
82 | |
---|
83 | //! This function simply returns 0 and helps to suppress the "statement has no effect" compiler warning |
---|
84 | inline int debugDummyFunction() |
---|
85 | { |
---|
86 | return 0; |
---|
87 | } |
---|
88 | } |
---|
89 | |
---|
90 | /** |
---|
91 | @brief |
---|
92 | Logs text output: use exactly like std::cout, but specify an output |
---|
93 | level as argument. |
---|
94 | @details |
---|
95 | (a > b ? 0 : c << "text") is equivalent to (a > b ? 0 : (c << "text")) |
---|
96 | where (a > b ? 0 : ) stands for COUT(x). This should explain how |
---|
97 | this macro magic can possibly even work ;) |
---|
98 | @example |
---|
99 | COUT(3) << "Some info" << std::endl; |
---|
100 | @note |
---|
101 | The ? : operator requires both possible results to have the type of |
---|
102 | the first. This is achieved by the int conversion operator dummy |
---|
103 | in the OutputHandler. |
---|
104 | */ |
---|
105 | #define COUT(level) \ |
---|
106 | /*if*/ (level > orxonox::hardDebugLevel) ? \ |
---|
107 | orxonox::debugDummyFunction() \ |
---|
108 | /*else*/ : \ |
---|
109 | /*if*/ (level > orxonox::OutputHandler::getSoftDebugLevel()) ? \ |
---|
110 | orxonox::debugDummyFunction() \ |
---|
111 | /*else*/ : \ |
---|
112 | orxonox::OutputHandler::getOutStream(level) |
---|
113 | |
---|
114 | #endif /* _Util_Debug_H__ */ |
---|