D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/Base/spInputOutputLog.hpp

Go to the documentation of this file.

/*
 * Log header
 * 
 * This file is part of the "SoftPixel Engine" (Copyright (c) 2008 by Lukas Hermanns)
 * See "SoftPixelEngine.hpp" for license information.
 */

#ifndef __SP_INPUTOUTPUT_LOG_H__
#define __SP_INPUTOUTPUT_LOG_H__


#include "Base/spStandard.hpp"
#include "Base/spInputOutputString.hpp"
#include "Base/spDimension.hpp"
#include "Base/spMaterialColor.hpp"

#include <fstream>
#include <string.h>
#include <boost/function.hpp>

#if defined(SP_PLATFORM_WINDOWS)
#   include <io.h>
#elif defined(SP_PLATFORM_LINUX)
#   include <cstdio>
#elif defined(SP_PLATFORM_ANDROID)
#   include <android/log.h>
#endif


namespace sp
{
namespace io
{


enum ELogTimeFormats
{
    LOGTIME_DISABLE,    
    LOGTIME_HHMMSS,     
    LOGTIME_MILLISECS,  
};

enum ELogMessageFlags
{
    LOG_MSGBOX      = 0x01, 
    LOG_TIME        = 0x02, 
    LOG_WARNING     = 0x04, 
    LOG_ERROR       = 0x08, 
    LOG_DEBUG       = 0x10, 
    LOG_NONEWLINE   = 0x20, 
    LOG_NOTAB       = 0x40, 
};

enum ELogOutputContexts
{
    LOGCONTEXT_NONE     = 0x00, 
    LOGCONTEXT_CONSOLE  = 0x01, 
    LOGCONTEXT_FILE     = 0x02, 
};


#if defined(SP_PLATFORM_ANDROID)
static stringc DEF_DEBUGLOG_FILE = "/mnt/sdcard/spDebugLog.txt";
#else
static stringc DEF_DEBUGLOG_FILE = "spDebugLog.txt";
#endif


namespace Log
{

typedef boost::function<void (const io::stringc &Message, s32 Flags)> MessageCallback;

SP_EXPORT void setMessageCallback(const MessageCallback &Proc);

SP_EXPORT void error(const stringc &Message, s32 Flags = LOG_TIME);

SP_EXPORT void warning(const stringc &Message, s32 Flags = LOG_TIME);

SP_EXPORT void debug(const stringc &ProcName, const stringc &Message = "Invalid arguments", s32 Flags = LOG_TIME);

SP_EXPORT void message(const stringc &Message, s32 Flags = LOG_TIME);

SP_EXPORT void setTimeFormat(const ELogTimeFormats Format);
SP_EXPORT ELogTimeFormats getTimeFormat();

SP_EXPORT void setTabString(const stringc &TabStr);
SP_EXPORT stringc getTabString();

SP_EXPORT stringc getCurrentTab();

SP_EXPORT void upperTab();
SP_EXPORT void lowerTab();

SP_EXPORT void setOutputContext(const s32 Context);
SP_EXPORT s32 getOutputContext();

SP_EXPORT bool open(const stringc &Filename = DEF_DEBUGLOG_FILE);
SP_EXPORT void close();

SP_EXPORT void pause(bool isPaused);

SP_EXPORT void openConsole(const stringc &Title = "");
SP_EXPORT void closeConsole();
SP_EXPORT void clearConsole();
SP_EXPORT void pauseConsole();

SP_EXPORT stringc getFormatedTime();

class ScopedTab
{
    public:
        ScopedTab()
        {
            upperTab();
        }
        ~ScopedTab()
        {
            lowerTab();
        }
};

} // /namespace Log


} // /namespace io

} // /namespace sp


#endif



// ================================================================================