qgsauxiliarystorage.h

Go to the documentation of this file.

/***************************************************************************
                          qgsauxiliarystorage.h  -  description
                           -------------------
    begin                : Aug 28, 2017
    copyright            : (C) 2017 by Paul Blottiere
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSAUXILIARYSTORAGE_H
#define QGSAUXILIARYSTORAGE_H
 
#include "qgis_core.h"
#include "qgscallout.h"
#include "qgsdatasourceuri.h"
#include "qgsdiagramrenderer.h"
#include "qgspallabeling.h"
#include "qgsproperty.h"
#include "qgssqliteutils.h"
#include "qgssymbollayer.h"
#include "qgsvectorlayer.h"
#include "qgsvectorlayerjoininfo.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsProject;

class CORE_EXPORT QgsAuxiliaryLayer : public QgsVectorLayer
{
    Q_OBJECT
 
  public:
    QgsAuxiliaryLayer( const QString &pkField, const QString &filename, const QString &table, QgsVectorLayer *vlayer );
 
    QgsAuxiliaryLayer( const QgsAuxiliaryLayer &rhs ) = delete;
 
    QgsAuxiliaryLayer &operator=( QgsAuxiliaryLayer const &rhs ) = delete;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsAuxiliaryLayer: '%1'>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN
      using QgsVectorLayer::clone;
#endif

    QgsAuxiliaryLayer *clone( QgsVectorLayer *layer ) const SIP_FACTORY;

    QgsVectorLayer *toSpatialLayer() const;

    bool clear();

    QgsVectorLayerJoinInfo joinInfo() const;

    bool exists( const QgsPropertyDefinition &definition ) const;

    bool addAuxiliaryField( const QgsPropertyDefinition &definition );

    QgsFields auxiliaryFields() const;

    bool save();

    bool deleteAttribute( int attr ) override;

    bool isHiddenProperty( int index ) const;

    int indexOfPropertyDefinition( const QgsPropertyDefinition &definition ) const;

    int propertyFromIndex( int index ) const;

    QgsPropertyDefinition propertyDefinitionFromIndex( int index ) const;

    static int createProperty( QgsPalLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );

    static int createProperty( QgsDiagramLayerSettings::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );

    static int createProperty( QgsCallout::Property property, QgsVectorLayer *vlayer, bool overwriteExisting = true );

    static int createProperty( QgsSymbolLayer::Property propertyKey, QgsVectorLayer *layer, QgsSymbolLayer *symbolLayer, bool overwriteExisting = true );

    static QgsField createAuxiliaryField( const QgsPropertyDefinition &definition );

    static QgsField createAuxiliaryField( const QgsField &field );

    static QString nameFromProperty( const QgsPropertyDefinition &def, bool joined = false );

    static QgsPropertyDefinition propertyDefinitionFromField( const QgsField &field );
 
  private:
    QgsVectorLayerJoinInfo mJoinInfo;
    QString mFileName;
    QString mTable;
    QgsVectorLayer *mLayer = nullptr;
};
 

class CORE_EXPORT QgsAuxiliaryStorage
{
  public:
    QgsAuxiliaryStorage( const QgsProject &project, bool copy = true );

    QgsAuxiliaryStorage( const QString &filename = QString(), bool copy = true );
 
    virtual ~QgsAuxiliaryStorage();

    bool isValid() const;

    QString fileName() const;

    QString currentFileName() const;

    QString errorString() const;

    bool saveAs( const QString &filename );

    bool saveAs( const QgsProject &project );

    bool save() const;

    QgsAuxiliaryLayer *createAuxiliaryLayer( const QgsField &field, QgsVectorLayer *layer ) const SIP_FACTORY;

    static bool deleteTable( const QgsDataSourceUri &uri );

    static bool duplicateTable( const QgsDataSourceUri &uri, const QString &newTable );

    static QString extension();

    static bool exists( const QgsProject &project );
 
  private:
    sqlite3_database_unique_ptr open( const QString &filename = QString() );
    sqlite3_database_unique_ptr open( const QgsProject &project );
 
    void initTmpFileName();
 
    static QString filenameForProject( const QgsProject &project );
    static sqlite3_database_unique_ptr createDB( const QString &filename );
    static sqlite3_database_unique_ptr openDB( const QString &filename );
    static bool tableExists( const QString &table, sqlite3 *handler );
    static bool createTable( const QString &type, const QString &table, sqlite3 *handler, QString &errorMsg );
 
    static bool exec( const QString &sql, sqlite3 *handler );
    static QString debugMsg( const QString &sql, sqlite3 *handler );
 
    static QgsDataSourceUri parseOgrUri( const QgsDataSourceUri &uri );
 
    bool mValid = false;
    QString mFileName;    // original filename
    QString mTmpFileName; // temporary filename used in copy mode
    bool mCopy = false;
    mutable QString mErrorString;
};
 
#endif