1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the qt3to4 porting application of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef LOGGER_H

    43 #define LOGGER_H

    44 

    45 #include <QString>

    46 #include <QStringList>

    47 #include <QList>

    48 #include <QMap>

    49 

    50 QT_BEGIN_NAMESPACE

    51 /*

    52     Base class for logger entries;

    53     description() should return a text for this entry,

    54 */

    55 class LogEntry

    56 {

    57 public:

    58     LogEntry(QString type, QString location);

    59     virtual ~LogEntry(){};

    60     virtual QString description() const =0;

    61     virtual void updateLinePos(int threshold, int delta) {Q_UNUSED(threshold); Q_UNUSED(delta)};

    62 protected:

    63     QString type; // Error, Warning, Info, etc

    64     QString location;// preprocessor, c++parser, porting, etc

    65 };

    66 

    67 class PlainLogEntry: public LogEntry

    68 {

    69 public:

    70      PlainLogEntry(QString type, QString lcation, QString text);

    71      QString description() const {return text;};

    72 protected:

    73      QString text;

    74 };

    75 

    76 /*

    77     A log entry that stores a source point: file, line and column.

    78 */

    79 class SourcePointLogEntry : public LogEntry

    80 {

    81 public:

    82     SourcePointLogEntry(QString type, QString location, QString file, int line, int column, QString text);

    83     QString description() const;

    84     void updateLinePos(int threshold, int delta);

    85 protected:

    86     QString file;

    87     int line;

    88     int column;

    89     QString text;

    90 };

    91 

    92 

    93 class Logger

    94 {

    95 public:

    96     Logger(){};

    97     ~Logger();

    98     static Logger *instance();

    99     static void deleteInstance();

   100 

   101     void beginSection();

   102     void commitSection();

   103     void revertSection();

   104     void addEntry(LogEntry *entry);

   105 

   106     QStringList fullReport();

   107     int numEntries();

   108     void updateLineNumbers(int insertLine, int numLines);

   109     /*

   110         glabalState can be used for storage of application state

   111         together with the logger. This can be useful in some cases,

   112         for example the current filename is stored here when processing

   113         files.

   114     */

   115     QMap<QString, QString> globalState;

   116 private:

   117     static Logger *theInstance;

   118     QList<LogEntry*> logEntries;

   119     QList<LogEntry*> pendingLogEntries;

   120 };

   121 

   122 QT_END_NAMESPACE

   123 

   124 #endif