-/*******************************************************************************
-
- Copyright (c) 2009, Charles McGarvey
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-*******************************************************************************/
+/*] Copyright (c) 2009-2010, Charles McGarvey [**************************
+**] All rights reserved.
+*
+* vi:ts=4 sw=4 tw=75
+*
+* Distributable under the terms and conditions of the 2-clause BSD license;
+* see the file COPYING for a complete text of the license.
+*
+**************************************************************************/
#ifndef _MOOF_LOG_H_
#define _MOOF_LOG_H_
/**
- * @file log.h
+ * \file Log.h
* Functions related to logging the process.
- * The logging functions are logError(), logWarning(), logInfo(), and
- * logDebug(), listed from most critical to least critical.
+ * The logging functions are logError(), logWarning(), and logInfo(),
+ * listed from most critical to least critical.
*/
#include <cstdlib> // exit
/**
- * Macro which tests an assertion and issues an logError() and exits if false.
- * @param X test to perform
+ * Macro which tests an assertion and issues a logError() and exits if the
+ * assertion is false.
+ * \param X test to perform
*/
#undef ASSERT
#if NDEBUG
#define ASSERT(X)
#else
-#define ASSERT(X) if (!(X)) Mf::logError << \
- "false assertion at " << __FILE__ << ":" << __LINE__ << ", " << #X, exit(1)
+#define ASSERT(X) if (!(X)) Mf::logError \
+ << "false assertion at " << __FILE__ << ":" << __LINE__ << ", " \
+ << #X, exit(1)
#endif
namespace Mf {
+/**
+ * A class for handling a log priority. There are two ways to log
+ * messages: by treating a log object as a function whose parameters are
+ * printed with default spacing, or by treating a log object as an output
+ * stream. Either way, any object can be printed to the log as long as
+ * there is an override for the ostream insertion operator.
+ */
class Log
{
public:
+ /**
+ * A type for the level or priority of a log message.
+ */
enum Level
{
- NONE = -1, ///< Disable all logging.
- ERRORR = 1, ///< Log only errors.
- WARNING = 2, ///< Log warnings and errors.
- SCRIPT = 3, ///< Log messages from Lua, too.
- INFO = 4, ///< Log info, warnings, errors.
- DEBUGG = 5, ///< Log all messages.
+ NONE = 0, ///< Disable all logging.
+ ERRORR = 1, ///< Log only errors.
+ WARNING = 2, ///< Log warnings and errors.
+ INFO = 3, ///< Log everything.
};
+
+ /**
+ * Set the lowest-priority log message that will be outputted to the
+ * log. Any logging with a lower priority will be ignored.
+ * \param level The log level.
+ */
static void setLevel(Level level);
- static Level getLevel();
+ /**
+ * Get the current lowest-priority log level. If unchanged, the
+ * default level is INFO.
+ * \return The log level.
+ */
+ static Level level();
- Log(Level level, const char* type) :
+
+ /**
+ * Construct a log with a certain priority and prefix string.
+ * \param level The log level.
+ * \param prefix The string printed before each log message.
+ */
+ Log(Level level, const char* prefix) :
mLevel(level),
- mType(type) /* only pass literal strings */ {}
+ mPrefix(prefix) /* only pass literal strings */ {}
- template <typename T>
- void operator () (const T& item)
+ template <class A>
+ void operator () (const A& a)
{
- *this << item << std::endl;
+ *this << a << std::endl;
}
+ template <class A, class B>
+ void operator () (const A& a, const B& b)
+ {
+ *this << a << " " << b << std::endl;
+ }
+
+ template <class A, class B, class C>
+ void operator () (const A& a, const B& b, const C& c)
+ {
+ *this << a << " " << b << " " << c << std::endl;
+ }
+
+ template <class A, class B, class C, class D>
+ void operator () (const A& a, const B& b, const C& c, const D& d)
+ {
+ *this << a << " " << b << " " << c << " " << d << std::endl;
+ }
+
+ template <class A, class B, class C, class D, class E>
+ void operator () (const A& a,
+ const B& b,
+ const C& c,
+ const D& d,
+ const E& e)
+ {
+ *this << a << " "
+ << b << " "
+ << c << " "
+ << d << " "
+ << e << std::endl;
+ }
+
+
private:
- template <typename T> friend std::ostream& operator << (Log&, const T&);
+ template <class T> friend std::ostream& operator << (Log&, const T&);
static Level gLevel;
Level mLevel;
- const char* mType;
+ const char* mPrefix;
};
extern Log logError;
extern Log logWarning;
extern Log logInfo;
-extern Log logDebug;
-template <typename T>
+template <class T>
inline std::ostream& operator << (Log& logObj, const T& item)
{
if (Log::gLevel < logObj.mLevel) return nullLog;
- return log << logObj.mType << item;
+ return log << logObj.mPrefix << item;
}
class Script;
-void importLogPrintFunction(Script& script);
+void importLogFunctions(Script& script);
} // namespace Mf