/usr/include/cegui-0.8.7/CEGUI/Logger.h is in libcegui-mk2-dev 0.8.7-1.3+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | /***********************************************************************
created: 21/2/2004
author: Paul D Turner
purpose: Defines interface for the Logger class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUILogger_h_
#define _CEGUILogger_h_
#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include <fstream>
#include <sstream>
#include <vector>
#include <utility>
#include "CEGUI/Singleton.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4275)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Enumeration of logging levels
*/
enum LoggingLevel
{
Errors, //!< Only actual error conditions will be logged.
Warnings, //!< Warnings will be logged as well.
Standard, //!< Basic events will be logged (default level).
Informative, //!< Useful tracing (object creations etc) information will be logged.
Insane //!< Mostly everything gets logged (use for heavy tracing only, log WILL be big).
};
/*!
\brief
Abstract class that defines the interface of a logger object for the GUI system.
The default implementation of this interface is the DefaultLogger class; if you
want to perform special logging, derive your own class from Logger and initialize
a object of that type before you create the CEGUI::System singleton.
*/
class CEGUIEXPORT Logger :
public Singleton<Logger>,
public AllocatedObject<Logger>
{
public:
/*!
\brief
Constructor for Logger object.
*/
Logger(void);
/*!
\brief Destructor for Logger object.
*/
virtual ~Logger(void);
/*!
\brief
Set the level of logging information that will get out to the log file
\param level
One of the LoggingLevel enumerated values that specified the level of logging information required.
\return
Nothing
*/
void setLoggingLevel(LoggingLevel level) {d_level = level;}
/*!
\brief
return the current logging level setting
\return
One of the LoggingLevel enumerated values specifying the current level of logging
*/
LoggingLevel getLoggingLevel(void) const {return d_level;}
/*!
\brief
Add an event to the log.
\param message
String object containing the message to be added to the event log.
\param level
LoggingLevel for this message. If \a level is greater than the current set logging level, the message is not logged.
\return
Nothing
*/
virtual void logEvent(const String& message, LoggingLevel level = Standard) = 0;
/*!
\brief
Set the name of the log file where all subsequent log entries should be written.
The interpretation of file name may differ depending on the concrete logger
implementation.
\note
When this is called, and the log file is created, any cached log entries are
flushed to the log file.
\param filename
Name of the file to put log messages.
\param append
- true if events should be added to the end of the current file.
- false if the current contents of the file should be discarded.
*/
virtual void setLogFilename(const String& filename, bool append = false) = 0;
protected:
LoggingLevel d_level; //!< Holds current logging level
private:
/*************************************************************************
Copy constructor and assignment usage is denied.
*************************************************************************/
Logger(const Logger&) : Singleton <Logger>() {}
Logger& operator=(const Logger&) {return *this;}
};
/*************************************************************************
This macro is used for 'Insane' level logging so that those items are
excluded from non-debug builds
*************************************************************************/
#if defined(DEBUG) || defined (_DEBUG)
# define CEGUI_LOGINSANE( message ) CEGUI::Logger::getSingleton().logEvent((message), CEGUI::Insane);
#else
# define CEGUI_LOGINSANE( message ) (void)0
#endif
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUILogger_h_
|