UT_UniversalLogFileLikeSink.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_UniversalLogFileLikeSink.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_UNIVERSALLOGFILELIKESINK_H__
#define __UT_UNIVERSALLOGFILELIKESINK_H__

#include "UT_API.h"
#include "UT_Error.h"
#include "UT_Function.h"
#include "UT_Lock.h"
#include "UT_StringHolder.h"
#include "UT_UniversalLogSink.h"

class UT_UniversalLogEntry;

class UT_API UT_UniversalLogFileLikeSink : public UT_UniversalLogSink
{
public:
    using LogEntryFormatCallback = UT_Function<void(
            const UT_UniversalLogEntry&,
            UT_StringHolder& message)>;

    UT_UniversalLogFileLikeSink(const UT_UniversalLogFileLikeSink &) = delete;
    UT_UniversalLogFileLikeSink()
        : myMinSeverity(UT_ERROR_NONE)
    {
    }

    void setFormatEntryCallback(const LogEntryFormatCallback &callback)
    { myLogEntryFormatCallback = callback; }

    void setMinSeverity(UT_ErrorSeverity severity)
    { myMinSeverity = severity; }
    int minSeverity() const
    { return myMinSeverity; }
    static UT_StringHolder severityToString(UT_ErrorSeverity sev);

protected:
    void doLog(const UT_UniversalLogEntry& entry) override;

    virtual void formatLogEntry(const UT_UniversalLogEntry &entry,
            UT_StringHolder &msg) const = 0;
    virtual void writeString(UT_ErrorSeverity severity,
            const UT_StringHolder &msg) const = 0;

private:
    UT_Lock myOutputLock;
    UT_ErrorSeverity myMinSeverity;
    LogEntryFormatCallback myLogEntryFormatCallback;
};

#endif // __UT_UNIVERSALLOGFILELIKESINK_H__