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 "qgis.h"
#include "qgscoordinatetransformcontext.h"
#include "qgspathresolver.h"
#include "qgsprojecttranslator.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsReadWriteContextCategoryPopper;

class CORE_EXPORT QgsReadWriteContext
{
  public:
    struct ReadWriteMessage
    {
        ReadWriteMessage( const QString &message = QString(), Qgis::MessageLevel level = Qgis::MessageLevel::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; }
 
        // TODO c++20 - replace with = default
 
        bool operator==( const QgsReadWriteContext::ReadWriteMessage &other ) const { return mMessage == other.mMessage && mLevel == other.mLevel && mCategories == other.mCategories; }
 
        bool operator!=( const QgsReadWriteContext::ReadWriteMessage &other ) const { return !( *this == other ); }
 
#ifdef SIP_RUN
        // clang-format off
        SIP_PYOBJECT __repr__();
        % MethodCode
        QString str = u"<QgsReadWriteContext.ReadWriteMessage: %1>"_s.arg( sipCpp->message() );
        sipRes = PyUnicode_FromString( str.toUtf8().constData() );
        % End
// clang-format on
#endif
 
        // clang-format off
        private:
        // clang-format on
        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::MessageLevel::Warning ) const;

    [[maybe_unused]] [[nodiscard]] QgsReadWriteContextCategoryPopper enterCategory( const QString &category, const QString &details = QString() ) const SIP_PYNAME( _enterCategory );
 

    QList<QgsReadWriteContext::ReadWriteMessage> takeMessages();

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

    void setProjectTranslator( QgsProjectTranslator *projectTranslator );

    QgsCoordinateTransformContext transformContext() const;

    void setTransformContext( const QgsCoordinateTransformContext &transformContext );

    const QString currentLayerId() const { return mCurrentLayerId; }

    void setCurrentLayerId( const QString &layerId ) { mCurrentLayerId = layerId; }
 
  private:
    void leaveCategory() const;
 
    QgsPathResolver mPathResolver;
    mutable QList<ReadWriteMessage> mMessages;
    mutable QStringList mCategories = QStringList();
    QgsProjectTranslator *mProjectTranslator = nullptr;
    friend class QgsReadWriteContextCategoryPopper;
    QgsCoordinateTransformContext mCoordinateTransformContext = QgsCoordinateTransformContext();
    QString mCurrentLayerId;
};
 

class CORE_EXPORT QgsReadWriteContextCategoryPopper
{
  public:
    QgsReadWriteContextCategoryPopper( const QgsReadWriteContext &context )
      : mContext( context )
    {}
    ~QgsReadWriteContextCategoryPopper() { mContext.leaveCategory(); }
 
  private:
#ifdef SIP_RUN
    QgsReadWriteContextCategoryPopper &operator=( const QgsReadWriteContextCategoryPopper & );
#endif
 
    const QgsReadWriteContext &mContext;
};
 
#endif // QGSREADWRITECONTEXT_H