UT_UniversalLogConsoleSink.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_UniversalLogConsoleSink.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_UNIVERSALLOGCONSOLESINK_H__
#define __UT_UNIVERSALLOGCONSOLESINK_H__

#include "UT_API.h"
#include "UT_Error.h"
#include "UT_StringArray.h"
#include "UT_StringHolder.h"
#include "UT_UniversalLogFileLikeSink.h"

class UT_UniversalLogEntry;

class UT_API UT_UniversalLogConsoleSink : public UT_UniversalLogFileLikeSink
{
public:
    enum OutFlags
    {
        kNONE = 0x0,
        kFILE = 0x1,
        kLINE = 0x2,
        kFILELINE = kFILE | kLINE,
        kTHREAD = 0x4,
        kDATE = 0x8
    };

    UT_UniversalLogConsoleSink(const UT_UniversalLogConsoleSink &) = delete;
    UT_UniversalLogConsoleSink()
        : myEnableColor(false)
        , myOutputFlags(OutFlags::kNONE)
    {
        init();
    }
    UT_UniversalLogConsoleSink(
            const UT_StringArray& whitelist,
            const UT_StringArray& blacklist)
        : myEnableColor(false)
        , myOutputFlags(OutFlags::kNONE)
    {
        init();
    }
    ~UT_UniversalLogConsoleSink() override
    {
        // We may get doLog calls until we are disconnected, so we must
        // disconnect before doing any real destruction of this object.
        disconnectAll();
    }

    void setEnableColor(bool enable)
    { myEnableColor = enable; }
    bool enableColor() const
    { return myEnableColor; }

protected:
    void formatLogEntry(const UT_UniversalLogEntry &entry,
            UT_StringHolder &msg) const override;
    void writeString(UT_ErrorSeverity severity,
            const UT_StringHolder &msg) const override;

private:
    void init();
    static void printToConsole(
            int error_level,
            const char* msg,
            bool enable_color);

    int myOutputFlags;
    bool myEnableColor;
};

#endif // __UT_UNIVERSALLOGCONSOLESINK_H__