summaryrefslogtreecommitdiffstats
path: root/rbutil/rbutilqt/logger/FileAppender.h
blob: 70a70c3e43d3397c0b34faa26f66b7899a1e472f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
  Copyright (c) 2010 Boris Moiseev (cyberbobs at gmail dot com)

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License version 2.1
  as published by the Free Software Foundation and appearing in the file
  LICENSE.LGPL included in the packaging of this file.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Lesser General Public License for more details.
*/
#ifndef FILEAPPENDER_H
#define FILEAPPENDER_H

// Logger
#include "CuteLogger_global.h"
#include <AbstractStringAppender.h>

// Qt
#include <QFile>
#include <QTextStream>


//! File is the simple appender that writes the log records to the plain text file.
class CUTELOGGERSHARED_EXPORT FileAppender : public AbstractStringAppender
{
  public:
    //! Constructs the new file appender assigned to file with the given name.
    FileAppender(const QString& fileName = QString());
    ~FileAppender();

    //! Returns the name set by setFileName() or to the FileAppender constructor.
    /**
     * \sa setFileName()
     */
    QString fileName() const;

    //! Sets the name of the file. The name can have no path, a relative path, or an absolute path.
    /**
     * \sa fileName()
     */
    void setFileName(const QString&);

  protected:
    //! Write the log record to the file.
    /**
     * \sa fileName()
     * \sa AbstractStringAppender::format()
     */
    virtual void append(const QDateTime& timeStamp, Logger::LogLevel logLevel, const char* file, int line,
                        const char* function, const QString& message);
    bool openFile();
    void closeFile();

  private:
    QFile m_logFile;
    QTextStream m_logStream;
    mutable QMutex m_logFileMutex;
};

#endif // FILEAPPENDER_H