qgsreadwritecontext.h

Go to the documentation of this file.

/***************************************************************************
                         qgsreadwritecontext.h
                         ----------------------
    begin                : May 2017
    copyright            : (C) 2017 by Martin Dobias
    email                : wonder dot sk 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 QGSREADWRITECONTEXT_H
#define QGSREADWRITECONTEXT_H

#include "qgspathresolver.h"
#include "qgis.h"
#include "qgsprojecttranslator.h"

class QgsReadWriteContextCategoryPopper;

class CORE_EXPORT QgsReadWriteContext
{
  public:

    struct ReadWriteMessage
    {
        ReadWriteMessage( const QString &message, Qgis::MessageLevel level = Qgis::Warning, const QStringList &categories = QStringList() )
          : mMessage( message )
          , mLevel( level )
          , mCategories( categories )
        {}

        QString message() const {return mMessage;}

        Qgis::MessageLevel level() const {return mLevel;}

        QStringList categories() const {return mCategories;}

      private:
        QString mMessage;
        Qgis::MessageLevel mLevel;
        QStringList mCategories;
    };

    QgsReadWriteContext();

    ~QgsReadWriteContext();

    const QgsPathResolver &pathResolver() const;

    void setPathResolver( const QgsPathResolver &resolver );

    void pushMessage( const QString &message, Qgis::MessageLevel level = Qgis::Warning );

    MAYBE_UNUSED NODISCARD QgsReadWriteContextCategoryPopper enterCategory( const QString &category, const QString &details = QString() ) SIP_PYNAME( _enterCategory );

    QList<QgsReadWriteContext::ReadWriteMessage> takeMessages();

    const QgsProjectTranslator *projectTranslator( ) const { return mProjectTranslator; }

    void setProjectTranslator( QgsProjectTranslator *projectTranslator );

  private:

    class DefaultTranslator : public QgsProjectTranslator
    {
        // QgsProjectTranslator interface
      public:
        QString translate( const QString &context, const QString &sourceText, const char *disambiguation, int n ) const;
    };

    void leaveCategory();

    QgsPathResolver mPathResolver;
    QList<ReadWriteMessage> mMessages;
    QStringList mCategories = QStringList();
    QgsProjectTranslator *mProjectTranslator = nullptr;
    friend class QgsReadWriteContextCategoryPopper;
    DefaultTranslator mDefaultTranslator;
};


class CORE_EXPORT QgsReadWriteContextCategoryPopper
{
  public:
    QgsReadWriteContextCategoryPopper( QgsReadWriteContext &context ) : mContext( context ) {}
    ~QgsReadWriteContextCategoryPopper() {mContext.leaveCategory();}
  private:
    QgsReadWriteContext &mContext;
};

#endif // QGSREADWRITECONTEXT_H