gsprofilesrv_plat/controlpanel_api/inc/logger.h
author hgs
Wed, 29 Sep 2010 10:45:02 +0800
changeset 61 33e86ecbfdb4
parent 52 controlpanel/controlpanel_plat/inc/logger.h@58cebe0861a8
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0""
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
52
hgs
parents: 32
diff changeset
    14
* Description:  This class provide log functionality.
32
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef LOGGER_H
hgs
parents:
diff changeset
    19
#define LOGGER_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <QObject>
hgs
parents:
diff changeset
    22
#include <QSettings>
hgs
parents:
diff changeset
    23
#include <loggerglobal.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
class LogOutput;
hgs
parents:
diff changeset
    26
class QSettings;
hgs
parents:
diff changeset
    27
class LoggerPrivate;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/*
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
configuration format:
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
    [myapplog]
hgs
parents:
diff changeset
    34
    logDateTime = 1
hgs
parents:
diff changeset
    35
    logLoggerName = 1
52
hgs
parents: 32
diff changeset
    36
    datetimeformat = hh:mm:ss
32
hgs
parents:
diff changeset
    37
    output = debugoutput consoleoutput fileoutput
hgs
parents:
diff changeset
    38
    fileoutput/logfile = C:/data/log/myapp.log
hgs
parents:
diff changeset
    39
    fileoutput/truncate = 1
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
code examples:
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    QSettings settings("myapp.ini",QSettings::IniFormat);
hgs
parents:
diff changeset
    44
    Logger::instance("myapplog")->configure(settings);
hgs
parents:
diff changeset
    45
    Logger::instance("myapplog")->log("Hello world!");
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
*/
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
class LOGGER_EXPORT Logger : public QObject
hgs
parents:
diff changeset
    50
{
hgs
parents:
diff changeset
    51
    Q_OBJECT
hgs
parents:
diff changeset
    52
    Q_PROPERTY(bool logDateTime READ logDateTime WRITE setLogDateTime)
hgs
parents:
diff changeset
    53
    Q_PROPERTY(bool logLoggerName READ logLoggerName WRITE setLogLoggerName)
hgs
parents:
diff changeset
    54
    Q_PROPERTY(QString dateTimeFormat READ dateTimeFormat WRITE setDateTimeFormat)
hgs
parents:
diff changeset
    55
public:
hgs
parents:
diff changeset
    56
    static Logger *instance(const QString &name);	
hgs
parents:
diff changeset
    57
    static void close(const QString &name);
hgs
parents:
diff changeset
    58
    static void closeAll();
hgs
parents:
diff changeset
    59
public:
hgs
parents:
diff changeset
    60
    virtual ~Logger();
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    void log(const QString &log);
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    void configure(const QString &configFile,QSettings::Format format = QSettings::NativeFormat);
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    void configure(QSettings &settings);
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    bool addLogOutput(LogOutput *output);
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    void removeLogOutput(LogOutput *output);
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    LogOutput *logOutput(const QString &name);
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
    void clearAllLogOutput();
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    QString name() const;
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
    bool logDateTime() const;
hgs
parents:
diff changeset
    79
    void setLogDateTime(bool on);
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
    bool logLoggerName() const;
hgs
parents:
diff changeset
    82
    void setLogLoggerName(bool on);
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
    QString dateTimeFormat() const;
hgs
parents:
diff changeset
    85
    void setDateTimeFormat(const QString &format);
hgs
parents:
diff changeset
    86
private:
hgs
parents:
diff changeset
    87
    explicit Logger(const QString &name = QString(),QObject *parent = 0);
hgs
parents:
diff changeset
    88
    LoggerPrivate *d_ptr;
hgs
parents:
diff changeset
    89
};
hgs
parents:
diff changeset
    90
52
hgs
parents: 32
diff changeset
    91
class InitLoggerHelper
hgs
parents: 32
diff changeset
    92
{
hgs
parents: 32
diff changeset
    93
public:
hgs
parents: 32
diff changeset
    94
    InitLoggerHelper(const QString &loggerName,const QString &configPath)
hgs
parents: 32
diff changeset
    95
    : mLoggerName(loggerName)
hgs
parents: 32
diff changeset
    96
    {
hgs
parents: 32
diff changeset
    97
        Logger::instance(loggerName)->configure(configPath,QSettings::IniFormat);
hgs
parents: 32
diff changeset
    98
    }
hgs
parents: 32
diff changeset
    99
    ~InitLoggerHelper() {
hgs
parents: 32
diff changeset
   100
        Logger::close(mLoggerName);
hgs
parents: 32
diff changeset
   101
    }
hgs
parents: 32
diff changeset
   102
private:
hgs
parents: 32
diff changeset
   103
    QString mLoggerName;
hgs
parents: 32
diff changeset
   104
};
hgs
parents: 32
diff changeset
   105
hgs
parents: 32
diff changeset
   106
class LogFunctionEntryHelper
hgs
parents: 32
diff changeset
   107
{
hgs
parents: 32
diff changeset
   108
public:
hgs
parents: 32
diff changeset
   109
    LogFunctionEntryHelper(const QString &loggerName,const QString &func)
hgs
parents: 32
diff changeset
   110
    : mLoggerName(loggerName), mFunc(func)
hgs
parents: 32
diff changeset
   111
    {
hgs
parents: 32
diff changeset
   112
        Logger::instance(mLoggerName)->log(QLatin1String(">>>> ") + mFunc);
hgs
parents: 32
diff changeset
   113
    }
hgs
parents: 32
diff changeset
   114
    ~LogFunctionEntryHelper()
hgs
parents: 32
diff changeset
   115
    {
hgs
parents: 32
diff changeset
   116
        Logger::instance(mLoggerName)->log(QLatin1String("<<<< ") + mFunc);
hgs
parents: 32
diff changeset
   117
    }
hgs
parents: 32
diff changeset
   118
private:
hgs
parents: 32
diff changeset
   119
    QString mLoggerName;
hgs
parents: 32
diff changeset
   120
    QString mFunc;
hgs
parents: 32
diff changeset
   121
};
hgs
parents: 32
diff changeset
   122
hgs
parents: 32
diff changeset
   123
#define INIT_LOGGER(loggerName,configPath) \
hgs
parents: 32
diff changeset
   124
    InitLoggerHelper __init##loggerName(loggerName,configPath);
hgs
parents: 32
diff changeset
   125
32
hgs
parents:
diff changeset
   126
#endif //LOGGER_H