sleep forever bug fixed
[chaz/yoink] / src / Moof / Log.hh
1
2 /*******************************************************************************
3
4 Copyright (c) 2009, Charles McGarvey
5 All rights reserved.
6
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9
10 * Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 *******************************************************************************/
28
29 #ifndef _MOOF_LOG_H_
30 #define _MOOF_LOG_H_
31
32 /**
33 * @file log.h
34 * Functions related to logging the process.
35 * The logging functions are logError(), logWarning(), logInfo(), and
36 * logDebug(), listed from most critical to least critical.
37 */
38
39 #include <cstdlib> // exit
40
41
42 /**
43 * Macro which tests an assertion and issues an logError() and exits if false.
44 * @param X test to perform
45 */
46
47 #undef ASSERT
48
49 #if NDEBUG
50 #define ASSERT(X)
51 #else
52 #define ASSERT(X) if (!(X)) Mf::logError("false assertion at %s:%d, " #X, \
53 __FILE__, __LINE__), exit(1)
54 #endif
55
56
57 namespace Mf {
58
59
60 /**
61 * Possible values used for setting the log level using LogLevel(). Log
62 * messages of lesser importance than the level specified are ignored.
63 * @see LogLevel()
64 */
65
66 enum LogLevel
67 {
68 LOG_NONE = -1, ///< Disable all logging.
69 LOG_ERROR = 1, ///< Log only errors.
70 LOG_WARNING = 2, ///< Log warnings and errors.
71 LOG_SCRIPT = 3, ///< Log messages from Lua, too.
72 LOG_INFO = 4, ///< Log info, warnings, errors.
73 LOG_DEBUG = 5, ///< Log all messages.
74 };
75
76
77 /**
78 * Set and/or get the level of logs which will be logged. If not called,
79 * defaults to WARNING
80 * @param level LOG_LEVEL_* constant or 0 for no change.
81 * @return The currently set log level.
82 */
83
84 LogLevel setLogLevel(LogLevel level);
85
86
87 /**
88 * Log an error.
89 * @param fmt Log format string.
90 * @param ... Extra format arguments.
91 */
92
93 void logError(const char* fmt, ...);
94
95 /**
96 * Log a warning.
97 * @param fmt Log format string.
98 * @param ... Extra format arguments.
99 */
100
101 void logWarning(const char* fmt, ...);
102
103 /**
104 * Log a message.
105 * @param fmt Log format string.
106 * @param ... Extra format arguments.
107 */
108
109 void logInfo(const char* fmt, ...);
110
111 /**
112 * Log a debug message.
113 * @param fmt Log format string.
114 * @param ... Extra format arguments.
115 */
116
117 void logDebug(const char* fmt, ...);
118
119 void logScript(const char* fmt, ...);
120 class Script;
121 int logScript(Script& script);
122 void importLogScript(Script& script);
123
124
125 } // namespace Mf
126
127 #endif // _MOOF_LOG_H_
128
This page took 0.037531 seconds and 4 git commands to generate.