UT/UT_ErrorLog.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.
 *
 * Produced by:
 * Joe Drew
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        UT_ErrorLog.h (UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_ErrorLog__
#define __UT_ErrorLog__

#include "UT_API.h"
#include <fstream.h>
#include <time.h>
#include "UT_SymbolTable.h"
#include "UT_String.h"
#include "UT_Lock.h"

class UT_Error;

class UT_API UT_ErrorLog
{
public:
    UT_ErrorLog();
    ~UT_ErrorLog();

    // Log the error's description to the error file if its severity is greater
    // than or equal to our minimum level
    void                logError(UT_Error *);

    // We only worry about locking when we set strings; we assume integers
    // and booleans are atomic
    const UT_String    &getLogFileName() const 
                        { return myLogFileName; }
    void                setLogFileName(const UT_String &name) 
                        {
                            myLock.lockNap(); 
                            myLogFileName.harden(name);
                            myLogFileName.expandVariables();
                            myLock.unlock();
                        }

    int                 getMinLevel() const 
                        { return myMinLevel; }
    void                setMinLevel(const int level)
                        { myMinLevel = level; }

    bool                getDoLogging() const
                        { return myDoLogging; }
    void                setDoLogging(bool log)
                        { myDoLogging = log; }

    void                resetState()
                        {
                            myLock.lockNap(); 
                            myErrorLogTimes.clear();
                            myLock.unlock();
                        }

protected:

private:
    int                 myMinLevel;
    UT_String           myLogFileName;
    bool                myDoLogging;
    UT_SymbolTable      myErrorLogTimes;
    time_t              myLastErrorTime;
    UT_Lock             myLock;
};

UT_API UT_ErrorLog *UTgetErrorLog();

#endif

---