Logger.h

/***********************************************************************
        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
{

enum LoggingLevel
{
        Errors,                 
    Warnings,       
        Standard,               
        Informative,    
        Insane                  
};

class CEGUIEXPORT Logger :
    public Singleton<Logger>,
    public AllocatedObject<Logger>
{
public:
        Logger(void);

        virtual ~Logger(void);


        void    setLoggingLevel(LoggingLevel level)             {d_level = level;}


        LoggingLevel    getLoggingLevel(void) const             {return d_level;}


        virtual void logEvent(const String& message, LoggingLevel level = Standard) = 0;

    virtual void setLogFilename(const String& filename, bool append = false) = 0;

protected:
        LoggingLevel    d_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_