GUITrace.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/

#ifndef GUITRACE__H_
#define GUITRACE__H_

#include "GUIObserver.h"
#include "GUISubject.h"
#include "eC_Semaphore.h"
#include "GUIConfig.h"

#include "GUIComponentManager.h"

class CGUICompositeObject;
class eC_File;
class eC_PlatformFile;

#define GUILOG(Level, Message) GUILOG_##Level(Message)

// The concatenate defines will be replaced with the correct Log methods
// or with no operation to minimize the code, if only error level is set,
// or if trace is switched off.
//------------------------------------------------------------------------------------
#if (GUI_TRACE_LEVEL == GUI_TRACE_DEBUG)
#define GUILOG_GUI_TRACE_DEBUG(Message) CGUIComponentManager::GetInstance().GetTrace().Log("DEBUG: ", Message)
#define GUILOG_GUI_TRACE_WARNING(Message) CGUIComponentManager::GetInstance().GetTrace().Log("WARNING: ", Message)
#define GUILOG_GUI_TRACE_ERROR(Message) CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", Message,eC_String(__FILE__), eC_String(__LINE__))
#ifdef GUILIANI_USE_EXCEPTIONS
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) { CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", ErrorMessage,eC_String(__FILE__), eC_String(__LINE__)); throw Exception; }
#else
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) {}
#endif
#elif (GUI_TRACE_LEVEL == GUI_TRACE_WARNING)
#define GUILOG_GUI_TRACE_DEBUG(Message) {}
#define GUILOG_GUI_TRACE_WARNING(Message) CGUIComponentManager::GetInstance().GetTrace().Log("WARNING: ", Message)
#define GUILOG_GUI_TRACE_ERROR(Message) CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", Message)
#ifdef GUILIANI_USE_EXCEPTIONS
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) { CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", ErrorMessage); throw Exception; }
#else
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) {}
#endif

#elif (GUI_TRACE_LEVEL == GUI_TRACE_ERROR)
#define GUILOG_GUI_TRACE_DEBUG(Message) {}
#define GUILOG_GUI_TRACE_WARNING(Message) {}
#define GUILOG_GUI_TRACE_ERROR(Message) CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", Message)
#ifdef GUILIANI_USE_EXCEPTIONS
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) { CGUIComponentManager::GetInstance().GetTrace().Log("ERROR: ", ErrorMessage); throw Exception; }
#else
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) {}
#endif

#else // Trace is switched off
#define GUILOG_GUI_TRACE_DEBUG(Message) {}
#define GUILOG_GUI_TRACE_WARNING(Message) {}
#define GUILOG_GUI_TRACE_ERROR(Message) {}
#ifdef GUILIANI_USE_EXCEPTIONS
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) {throw Exception;}
#else
#define GUILOG_THROW_EXCEPTION(Exception, ErrorMessage) {}
#endif
//------------------------------------------------------------------------------------
#endif

// If GUI trace is set off, the GUI_REG_... defines are not needed, so they will be
// replaced with no operation and the whole class definition is not needed.
//------------------------------------------------------------------------------------
#if (GUI_TRACE_LEVEL == GUI_TRACE_OFF)
#define GUI_REG_STDOUT_TRACE() {}
#define GUI_REG_FILE_TRACE(FILE) {}
#define GUI_REG_DEBUGGER_TRACE() {}
#else
#define GUI_REG_STDOUT_TRACE() CGUIComponentManager::GetInstance().GetTrace().CreateStdOutTrace();
#define GUI_REG_FILE_TRACE(FILE) CGUIComponentManager::GetInstance().GetTrace().CreateFileTrace(FILE);
#define GUI_REG_DEBUGGER_TRACE() CGUIComponentManager::GetInstance().GetTrace().CreateDebuggerTrace();
#endif

#define GUILOGMETHODENTRY CGUIComponentManager::GetInstance().GetTrace().Log("GUILOGMETHODENTRY: ", "Method "+eC_String(__FUNCTION__)+" called. Timestamp: "+GETTIMER.GetTime()+"ms \n", eC_String(__FILE__), eC_String(__LINE__));

#define GUILOGMESSAGE(Message) CGUIComponentManager::GetInstance().GetTrace().Log("INFO: ", Message)

class CGUITrace : public CGUISubject
{
    friend class CGUIComponentManager; 

public:
    static void CreateInstance();

    static void DeleteInstance();

    void Log(
        const eC_String& rkLogStr,
        const eC_String& rkOutputStr,
        const eC_String& rkFileName = "",
        const eC_String& rkLineNumber = "");

    void CreateStdOutTrace();

    void CreateFileTrace(const eC_String &TraceFileName);

    void CreateDebuggerTrace();

    static void PrintObjectTree(CGUIObject* pObj);

    enum GUITraceActivation_t
    {
        GUITRACE_NOT_ACTIVE = 0, 
        GUITRACE_ACTIVE = 1 
    };

    void SetTraceActive(GUITraceActivation_t eTraceActive);

    GUITraceActivation_t GetTraceActive();

private:
    class CFileTrace : public CGUIObserver
    {
    public:
        CFileTrace(const eC_String& rkTraceFileName);

        virtual void OnNotification(const eC_String& rkTraceString);

        ~CFileTrace();

    private:
        CFileTrace();

        CFileTrace(const CFileTrace& kSource);

        CFileTrace& operator=(const CFileTrace& kSource);

        eC_File* m_pkTraceFile;
    };

    class CStdOutTrace : public CGUIObserver
    {
    public:
        CStdOutTrace() :
            CGUIObserver()
        {}

        virtual void OnNotification(const eC_String& rkTraceString);

        ~CStdOutTrace()
        {}
    };

    class CDebuggerTrace : public CGUIObserver
    {
    public:
        CDebuggerTrace() :CGUIObserver() {}
        virtual void OnNotification(const eC_String& rkTraceString);
        ~CDebuggerTrace() {}

    private:
        CDebuggerTrace(const CDebuggerTrace& kSource);

        CDebuggerTrace& operator=(const CDebuggerTrace& kSource);
    };

private:
    CGUITrace();

    virtual ~CGUITrace();

    CGUITrace(const CGUITrace& kSource);

    CGUITrace& operator=(const CGUITrace& kSource);

    static void PrintCompositeDebugTree(const CGUICompositeObject* pObj, eC_Int ilvl);

private:
    static CGUITrace* ms_pkInstance;
    CStdOutTrace* m_pkStdOutTrace;       
    CFileTrace* m_pkFileTrace;         
    CDebuggerTrace* m_pkDebuggerTrace;     
    eC_Semaphore m_kSem;

    GUITraceActivation_t m_eTraceActive;
};

#endif