VisionPlus_V3.0/Ref/TestLog4Qt/log4qt/fileappender.h

/******************************************************************************
 *
 * 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
{
	
	/*!
	 * \brief The class FileAppender appends log events to a file.
	 * 
	 * \note All the functions declared in this class are thread-safe.
	 * 
	 * \note The ownership and lifetime of objects of this class are managed. See
	 *       \ref Ownership "Object ownership" for more details.
	 */
	class FileAppender : public WriterAppender
	{
	    Q_OBJECT
	    
	    /*!
	     * The property holds, if the output is appended to the file.
	     *
	     * The default is false for not appending.
	     *
	     * \sa appendFile(), setAppendFile()
	     */
	    Q_PROPERTY(bool appendFile READ appendFile WRITE setAppendFile)
	    
	    /*!
	     * The property holds, if the output is buffered.
	     *
	     * The default is true for buffering.
	     *
	     * \sa bufferedIo(), setBufferedIo()
	     */
	    Q_PROPERTY(bool bufferedIo READ bufferedIo WRITE setBufferedIo)
	    
	    /*!
	     * The property holds the name of the file.
	     *
	     * \sa file(), setFile()
	     */
	    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:
	    /*!
	     * Tests if all entry conditions for using append() in this class are met.
	     * 
	     * If a conditions is not met, an error is logged and the function returns
	     * false. Otherwise the result of WriterAppender::checkEntryConditions() 
	     * is returned.
	     * 
	     * The checked conditions are:
	     * - That a file is set and open (APPENDER_NO_OPEN_FILE_ERROR)
	     * 
	     * The function is called as part of the checkEntryConditions() chain 
	     * started by AppenderSkeleton::doAppend().
	     * 
	     * \sa AppenderSkeleton::doAppend(), AppenderSkeleton::checkEntryConditions()
	     */
	    virtual bool checkEntryConditions() const;
	    
	    void closeFile();
	    
#ifndef QT_NO_DEBUG_STREAM
	    /*!
	     * Writes all object member variables to the given debug stream \a rDebug 
	     * and returns the stream.
	     *
	     * <tt>
	     * %FileAppender(name:"FA" appendfile:false bufferedio:true encoding:"" 
	     *               file:"/log.txt" filter: 0x0 immediateflush:true isactive:false 
	     *               isclosed:false layout:"TTCC" referencecount:2 
	     *               threshold:"NULL" writer:0x0)  
	     * </tt>
	     * \sa QDebug, operator<<(QDebug debug, const LogObject &rLogObject)
	     */
	    virtual QDebug debug(QDebug &rDebug) const;
#endif // QT_NO_DEBUG_STREAM
	
	    /*!
	     * Checks for file I/O errrors. If an error is found it is logged and the 
	     * function returns true. Otherwise false is returned.
	     */
	    virtual bool handleIoErrors() const;

	    /*!
	     * Opens the file for the appender based on the specified file name and
	     * mode. A text stream is created and passed on to the super class 
	     * WriterAppender. 
	     * 
	     * If the parent directory of the specified file does not exists, 
	     * it is created.
	     */
	    void openFile();
	    
	    /*!
	     * Removes the file \a rFile. If the operation is successful, true is 
	     * returned. Otherwise an APPENDER_REMOVE_FILE_ERROR error is logged
	     * and false is returned.
	     */
	    bool removeFile(QFile &rFile) const;

	    /*!
	     * Renames the file \a rFile to \a rFileName. If the operation is 
	     * successful, true is returned. Otherwise an 
	     * APPENDER_RENAMING_FILE_ERROR error is logged and false is returned.
	     */
	    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