fsIDebug.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        20/2/2014   11:40
*
*       File:           fsIDebug.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Interface for debug output
*
*********************************************************************/
 
#ifndef fsIDebughdr
#define fsIDebughdr
 
#include <vector>
 
#include <fsCore/fsBaseTypes.h>
#include <fsAppCore/fsIMessageListener.h>
#include <fsCore/src/fsTSingletonBackend.h>
 
#include "../../fsStr.h"
#include "../fsCResourceName.h"
 
class fsIDebug : public fsIMessageListener, public fsTSingletonBackend<fsIDebug>
{
        friend class fsTSingletonBackend<fsIDebug>;
 
public:
 
        fsS32 logCountGet() const { return mLogStrings.size(); }
        const std::vector<fsStr>& logsGet();
 
        virtual fsStr formattedFsStrGet(const fsChar* pFmtStr, ...) = 0;
        void logFileWrite();
 
        void errorStringInsert(fsStr pLogStr);
        void logStringInsert(fsStr pLogStr);
 
        // Lets an unattended runner (e.g. the auto-test manager) suppress the warning-box
        void dialogsSuppressSet(fsBool pSuppress) { mDialogsSuppressed = pSuppress; }
        fsBool dialogsSuppressedGet() const { return mDialogsSuppressed; }
 
        void listenersRegisterDo();
        void listenersDeregisterDo();
        fsBool messageProcessDo(const fsCUniqueId& pMessageType, const fsIMessageDispatcher::sMessageParameters& pParam);
 
        virtual ~fsIDebug();
 
protected:
 
        static fsIDebug* backendInstanceCreate();
 
        fsIDebug();
 
        std::vector<fsStr> mLogStrings;
        std::vector<fsStr> mErrorStrings;
 
        // Tracks the last inserted line across flushes, so repeats still dedupe even
        // when the buffer was just cleared out from under it (e.g. a flushed error).
        fsStr mLastLogStr;
 
        fsBool mDialogsSuppressed = false;
 
        // Bytes in the live log, tracked as we append so the size cap costs no file stat.
        fsStr::sizeT mLogFileBytes = 0;
 
 
private:
 
        const fsCResourceName mLogFileResource;
};
 
#endif