F:/Code/DeltaQt/DeltaQt/deltaparselog.h

Go to the documentation of this file.

/*  Copyright 2012 Craig Robbins

    This file is part of DeltaQt

    DeltaQt is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DeltaQt 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DeltaQt.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef DELTAPARSELOG_H
#define DELTAPARSELOG_H

#include <QString>
#include <QStringList>
#include <QList>

class DeltaLogEntry
{
public:

    typedef enum
    {
        TYPE_INVALID  = 0,
        TYPE_INFO     = 1,
        TYPE_WARNING  = 2,
        TYPE_ERROR    = 4
    } Type;

    typedef enum
    {
        STANDARD      = 1,
        VERBOSE       = 2,
        SUMMARY       = 4

    } Detail;

    // Constructors
    DeltaLogEntry();
    DeltaLogEntry(Type type,
                  QString title,
                  QString msg,
                  Detail detail = STANDARD,
                  int line = -1,
                  int column = -1
                  );

    Type type(void) const;
    Detail detail (void) const;
    QString title(void) const;
    QString msg(void) const;
    int line(void) const;
    int column(void) const;
    QString toText(bool verbose = true, char delim = '\t') const;

    void set(Type type,
             QString title,
             QString msg,
             Detail detail = STANDARD,
             int line = -1,
             int column = -1

             );

    void setRefName(QString to);
    void setMsg(QString to);
    void setLine(int to);
    void setColumn(int to);

    bool isValid(void) const;
protected:
    void setType(Type to);

    Type m_type;
    Detail m_detail;
    QString m_refName;
    QString m_msg;
    int m_line;
    int m_column;
};




typedef QList <DeltaLogEntry> DeltaLogEntries;

class DeltaParseLog
{
public:
    DeltaParseLog();

    static const unsigned FILTER_ALLOWALL = ~0U;
    static const unsigned FILTER_ALLVALIDTYPES =
            ~0U ^ DeltaLogEntry::TYPE_INVALID;
    static const unsigned DETAIL_ALLOW_ALL = ~0U;
    static const unsigned DETAIL_NOTVERBOSE =
            ~0U ^ DeltaLogEntry::VERBOSE;
    static const unsigned DETAIL_VERBOSE =
            ~0U;
    static const unsigned FILTER_ONLY_ERRORS =
            DeltaLogEntry::TYPE_ERROR;
    static const unsigned FILTER_ONLY_WARNINGS =
            DeltaLogEntry::TYPE_WARNING;


    QStringList allAsText(bool verbose = true,
                          unsigned detailFilter = DETAIL_ALLOW_ALL,
                          unsigned typeFilter = FILTER_ALLOWALL,
                          char delim = '\t') const;

    QString allAsTextCombined(bool verbose = true,
                              unsigned detailFilter = DETAIL_ALLOW_ALL,
                              unsigned typeFilter = FILTER_ALLOWALL,
                              char delim = '\t',
                              char eol = '\n') const;

    void add(DeltaLogEntry::Type type,
             QString refName,
             QString msg,
             DeltaLogEntry::Detail detail = DeltaLogEntry::STANDARD,
             int line = -1,
             int column = -1
             );

    void clear(void);

protected:
    DeltaLogEntries m_logEntries;
};

#endif // DELTAPARSELOG_H