qgserror.h

Go to the documentation of this file.

/***************************************************************************
                         qgserror.h  -  Error container
                             -------------------
    begin                : October 2012
    copyright            : (C) 2012 Radim Blazek
    email                : radim dot blazek at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSERROR_H
#define QGSERROR_H
 
#include "qgis_core.h"
 
#include <QList>
#include <QString>
 
using namespace Qt::StringLiterals;
 
// Macro to create Error message including info about where it was created.
#define QGS_ERROR_MESSAGE( message, tag ) QgsErrorMessage( QString( message ), QString( tag ), QString( __FILE__ ), QString( __FUNCTION__ ), __LINE__ )

class CORE_EXPORT QgsErrorMessage
{
  public:
    enum Format
    {
      Text, // Plain text
      Html
    };
 
    QgsErrorMessage() = default;

    QgsErrorMessage( const QString &message, const QString &tag = QString(), const QString &file = QString(), const QString &function = QString(), int line = 0 );
 
    QString message() const { return mMessage; }
    QString tag() const { return mTag; }
    QString file() const { return mFile; }
    QString function() const { return mFunction; }
    int line() const { return mLine; }
 
  private:
    QString mMessage;

    QString mTag;

    QString mFile;
    QString mFunction;
    int mLine = 0;
};

class CORE_EXPORT QgsError
{
  public:
    QgsError() = default;

    QgsError( const QString &message, const QString &tag );

    void append( const QString &message, const QString &tag );

    void append( const QgsErrorMessage &message );

    bool isEmpty() const { return mMessageList.isEmpty(); }

    QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;

    QString summary() const;

    void clear() { mMessageList.clear(); }

    QList<QgsErrorMessage> messageList() const { return mMessageList; }
 
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsError: %1>"_s.arg( sipCpp->message( QgsErrorMessage::Text ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    private:
    // clang-format on
    QList<QgsErrorMessage>
      mMessageList;
};
 
#endif