gsprofilesrv_plat/controlpanel_api/inc/logger.h
changeset 59 4868a89ec1e3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gsprofilesrv_plat/controlpanel_api/inc/logger.h	Fri Sep 17 08:31:27 2010 +0300
@@ -0,0 +1,126 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0""
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  This class provide log functionality.
+*
+*/
+
+#ifndef LOGGER_H
+#define LOGGER_H
+
+#include <QObject>
+#include <QSettings>
+#include <loggerglobal.h>
+
+class LogOutput;
+class QSettings;
+class LoggerPrivate;
+
+/*
+
+configuration format:
+
+    [myapplog]
+    logDateTime = 1
+    logLoggerName = 1
+    datetimeformat = hh:mm:ss
+    output = debugoutput consoleoutput fileoutput
+    fileoutput/logfile = C:/data/log/myapp.log
+    fileoutput/truncate = 1
+
+code examples:
+
+    QSettings settings("myapp.ini",QSettings::IniFormat);
+    Logger::instance("myapplog")->configure(settings);
+    Logger::instance("myapplog")->log("Hello world!");
+
+*/
+
+class LOGGER_EXPORT Logger : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(bool logDateTime READ logDateTime WRITE setLogDateTime)
+    Q_PROPERTY(bool logLoggerName READ logLoggerName WRITE setLogLoggerName)
+    Q_PROPERTY(QString dateTimeFormat READ dateTimeFormat WRITE setDateTimeFormat)
+public:
+    static Logger *instance(const QString &name);	
+    static void close(const QString &name);
+    static void closeAll();
+public:
+    virtual ~Logger();
+
+    void log(const QString &log);
+
+    void configure(const QString &configFile,QSettings::Format format = QSettings::NativeFormat);
+
+    void configure(QSettings &settings);
+
+    bool addLogOutput(LogOutput *output);
+
+    void removeLogOutput(LogOutput *output);
+
+    LogOutput *logOutput(const QString &name);
+
+    void clearAllLogOutput();
+
+    QString name() const;
+
+    bool logDateTime() const;
+    void setLogDateTime(bool on);
+
+    bool logLoggerName() const;
+    void setLogLoggerName(bool on);
+
+    QString dateTimeFormat() const;
+    void setDateTimeFormat(const QString &format);
+private:
+    explicit Logger(const QString &name = QString(),QObject *parent = 0);
+    LoggerPrivate *d_ptr;
+};
+
+class InitLoggerHelper
+{
+public:
+    InitLoggerHelper(const QString &loggerName,const QString &configPath)
+    : mLoggerName(loggerName)
+    {
+        Logger::instance(loggerName)->configure(configPath,QSettings::IniFormat);
+    }
+    ~InitLoggerHelper() {
+        Logger::close(mLoggerName);
+    }
+private:
+    QString mLoggerName;
+};
+
+class LogFunctionEntryHelper
+{
+public:
+    LogFunctionEntryHelper(const QString &loggerName,const QString &func)
+    : mLoggerName(loggerName), mFunc(func)
+    {
+        Logger::instance(mLoggerName)->log(QLatin1String(">>>> ") + mFunc);
+    }
+    ~LogFunctionEntryHelper()
+    {
+        Logger::instance(mLoggerName)->log(QLatin1String("<<<< ") + mFunc);
+    }
+private:
+    QString mLoggerName;
+    QString mFunc;
+};
+
+#define INIT_LOGGER(loggerName,configPath) \
+    InitLoggerHelper __init##loggerName(loggerName,configPath);
+
+#endif //LOGGER_H