OgreLog.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2014 Torus Knot Software Ltd

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 OR COPYRIGHT HOLDERS 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 __Log_H__
#define __Log_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreHeaderPrefix.h"
#include "Threading/OgreThreadHeaders.h"

#if OGRE_PLATFORM == OGRE_PLATFORM_NACL
namespace pp
{
    class Instance;
}
#endif

namespace Ogre {

    // LogMessageLevel + LoggingLevel > OGRE_LOG_THRESHOLD = message logged
    #define OGRE_LOG_THRESHOLD 4

    enum LoggingLevel
    {
        LL_LOW = 1,
        LL_NORMAL = 2,
        LL_BOREME = 3
    };

    enum LogMessageLevel
    {
        LML_TRIVIAL = 1,
        LML_NORMAL = 2,
        LML_CRITICAL = 3
    };

    class LogListener
    {
    public:
        virtual ~LogListener() {}

        virtual void messageLogged( const String& message, LogMessageLevel lml, bool maskDebug, const String &logName, bool& skipThisMessage ) = 0;
    };


    class _OgreExport Log : public LogAlloc
    {
    protected:
        std::ofstream   mLog;
        LoggingLevel    mLogLevel;
        bool            mDebugOut;
        bool            mSuppressFile;
        bool            mTimeStamp;
        String          mLogName;

        typedef vector<LogListener*>::type mtLogListener;
        mtLogListener mListeners;
    public:

        class Stream;

        OGRE_AUTO_MUTEX; // public to allow external locking
        Log( const String& name, bool debugOutput = true, bool suppressFileOutput = false);

        ~Log();

        const String& getName() const { return mLogName; }
        bool isDebugOutputEnabled() const { return mDebugOut; }
        bool isFileOutputSuppressed() const { return mSuppressFile; }
        bool isTimeStampEnabled() const { return mTimeStamp; }

        void logMessage( const String& message, LogMessageLevel lml = LML_NORMAL, bool maskDebug = false );

        Stream stream(LogMessageLevel lml = LML_NORMAL, bool maskDebug = false);

        void setDebugOutputEnabled(bool debugOutput);
        void setLogDetail(LoggingLevel ll);
        void setTimeStampEnabled(bool timeStamp);
        LoggingLevel getLogDetail() const { return mLogLevel; }
        void addListener(LogListener* listener);

        void removeListener(LogListener* listener);

        class _OgrePrivate Stream
        {
        protected:
            Log* mTarget;
            LogMessageLevel mLevel;
            bool mMaskDebug;
            typedef StringUtil::StrStreamType BaseStream;
            BaseStream mCache;

        public:

            struct Flush {};

            Stream(Log* target, LogMessageLevel lml, bool maskDebug)
                :mTarget(target), mLevel(lml), mMaskDebug(maskDebug)
            {

            }
            // copy constructor
            Stream(const Stream& rhs) 
                : mTarget(rhs.mTarget), mLevel(rhs.mLevel), mMaskDebug(rhs.mMaskDebug)
            {
                // explicit copy of stream required, gcc doesn't like implicit
                mCache.str(rhs.mCache.str());
            } 
            ~Stream()
            {
                // flush on destroy
                if (mCache.tellp() > 0)
                {
                    mTarget->logMessage(mCache.str(), mLevel, mMaskDebug);
                }
            }

            template <typename T>
            Stream& operator<< (const T& v)
            {
                mCache << v;
                return *this;
            }

            Stream& operator<< (const Flush& v)
            {
                                (void)v;
                mTarget->logMessage(mCache.str(), mLevel, mMaskDebug);
                mCache.str(StringUtil::BLANK);
                return *this;
            }


        };
#if OGRE_PLATFORM == OGRE_PLATFORM_NACL
    protected:
        static pp::Instance* mInstance;
    public:
        static void setInstance(pp::Instance* instance) {mInstance = instance;};
#endif

    };
}

#include "OgreHeaderSuffix.h"

#endif