UT_UniversalLogFileSink.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_UniversalLogFileSink.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_UNIVERSALLOGFILESINK_H__
#define __UT_UNIVERSALLOGFILESINK_H__

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

class UT_UniversalLogEntry;

class UT_API UT_UniversalLogFileSink : public UT_UniversalLogFileLikeSink
{
public:
    UT_UniversalLogFileSink(const UT_UniversalLogFileSink &) = delete;
    UT_UniversalLogFileSink(const UT_StringHolder& filepath)
        : myFilePath(filepath)
    {
    }
    ~UT_UniversalLogFileSink() override
    {
        // We may get doLog calls until we are disconnected, so we must
        // disconnect before doing any real destruction of this object.
        disconnectAll();
    }

    const UT_StringHolder &filePath() const
    { return myFilePath; }

    void setMaxFileSize(exint max_size) { myMaxFileSize = max_size; }
    exint maxFileSize() const { return myMaxFileSize; }

    void setAppendDate(bool adate) { myAppendDate = adate; }
    bool appendDate() const { return myAppendDate; }

    void setPermissions(unsigned int perms) { myPermissions = perms; }
    unsigned int permissions() const { return myPermissions; }

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

private:
    UT_StringHolder myFilePath;
    exint myMaxFileSize = -1;
    bool myAppendDate = false;
    unsigned int myPermissions = 0;

    mutable bool myHasAdjustedPermissions = false;
};

#endif // __UT_UNIVERSALLOGFILESINK_H__