src/log4qt/fileappender.h

Go to the documentation of this file.

/******************************************************************************
 *
 * package:     Log4Qt
 * file:        fileappender.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 * 
 * Copyright 2007 Martin Heinrich
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/

#ifndef LOG4QT_FILEAPPENDER_H
#define LOG4QT_FILEAPPENDER_H


/******************************************************************************
 * Dependencies
 ******************************************************************************/

#include "log4qt/writerappender.h"


/******************************************************************************
 * Declarations
 ******************************************************************************/

class QFile;
class QTextStream;

namespace Log4Qt
{
    
    class FileAppender : public WriterAppender
    {
        Q_OBJECT
        
        Q_PROPERTY(bool appendFile READ appendFile WRITE setAppendFile)
        
        
        Q_PROPERTY(bool bufferedIo READ bufferedIo WRITE setBufferedIo)
        
        Q_PROPERTY(QString file READ file WRITE setFile)
    
    public:
        FileAppender(QObject *pParent = 0);
        FileAppender(Layout *pLayout,
                     const QString &rFileName,
                     QObject *pParent = 0);
        FileAppender(Layout *pLayout,
                     const QString &rFileName,
                     bool append,
                     QObject *pParent = 0);
        FileAppender(Layout *pLayout,
                     const QString &rFileName,
                     bool append,
                     bool buffered,
                     QObject *pParent = 0);
        virtual ~FileAppender();
    private:
        FileAppender(const FileAppender &rOther); // Not implemented
        FileAppender &operator=(const FileAppender &rOther); // Not implemented
            
    public:
        bool appendFile() const;
        QString file() const;
        bool bufferedIo() const;
        // JAVA: int bufferSize() const;
        void setAppendFile(bool append);
        void setBufferedIo(bool buffered);
        // JAVA: void setBufferSize(int bufferSize);
        void setFile(const QString &rFileName);
    
        virtual void activateOptions();
        virtual void close();
        
    protected:
        virtual bool checkEntryConditions() const;
        
        void closeFile();
        
#ifndef QT_NO_DEBUG_STREAM

        virtual QDebug debug(QDebug &rDebug) const;
#endif // QT_NO_DEBUG_STREAM
    
        virtual bool handleIoErrors() const;

        void openFile();
        
        bool removeFile(QFile &rFile) const;

        bool renameFile(QFile &rFile,
                        const QString &rFileName) const;

        // JAVA: void setQWForFiles(Writer writer); 
        
    private:
        volatile bool mAppendFile;
        volatile bool mBufferedIo;
        QString mFileName;
        QFile *mpFile;
        QTextStream *mpTextStream;
    };
    
    
    /**************************************************************************
     * Operators, Helper
     **************************************************************************/
    
    
    /**************************************************************************
     * Inline
     **************************************************************************/
    
    inline bool FileAppender::appendFile() const
    {   // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
        return mAppendFile;   }
    
    inline QString FileAppender::file() const
    {   QMutexLocker locker(&mObjectGuard);
        return mFileName;   }
    
    inline bool FileAppender::bufferedIo() const
    {   // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
        return mBufferedIo;   }
    
    inline void FileAppender::setAppendFile(bool append)
    {   // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
        mAppendFile = append;   }
    
    inline void FileAppender::setBufferedIo(bool buffered)
    {   // QMutexLocker locker(&mObjectGuard); // Read/Write of int is safe
        mBufferedIo = buffered;   }
    
    inline void FileAppender::setFile(const QString &rFileName)
    {   QMutexLocker locker(&mObjectGuard);
        mFileName = rFileName;   }
    
    
} // namespace Log4Qt


// Q_DECLARE_TYPEINFO(Log4Qt::FileAppender, Q_COMPLEX_TYPE); // Use default


#endif // LOG4QT_FILEAPPENDER_H

---