qgsproviderregistry.h

Go to the documentation of this file.

/***************************************************************************
                    qgsproviderregistry.h  -  Singleton class for
                    registering data providers.
                             -------------------
    begin                : Sat Jan 10 2004
    copyright            : (C) 2004 by Gary E.Sherman
    email                : sherman at mrcc.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 QGSPROVIDERREGISTRY_H
#define QGSPROVIDERREGISTRY_H

#include <map>

#include <QDir>
#include <QLibrary>
#include <QString>

#include "qgsvectorlayerexporter.h"
#include "qgsdataprovider.h"
#include "qgis_core.h"
#include "qgis_sip.h"

class QgsProviderMetadata;
class QgsVectorLayer;
class QgsCoordinateReferenceSystem;
class QgsDataItemProvider;
class QgsDataItem;
class QgsRasterDataProvider;

class CORE_EXPORT QgsProviderRegistry
{

  public:

    // TODO QGIS 4 - either move to QgsAbstractDataSourceWidget or remove altogether
    enum WidgetMode
    {

      None,

      Embedded,

      Manager,
    };

    static QgsProviderRegistry *instance( const QString &pluginPath = QString() );

    virtual ~QgsProviderRegistry();

    Q_DECL_DEPRECATED QString library( const QString &providerKey ) const SIP_DEPRECATED;

    QString pluginList( bool asHtml = false ) const;

    QDir libraryDirectory() const;

    void setLibraryDirectory( const QDir &path );

    QgsDataProvider *createProvider( const QString &providerKey,
                                     const QString &dataSource,
                                     const QgsDataProvider::ProviderOptions &options = QgsDataProvider::ProviderOptions() ) SIP_FACTORY;

    Q_DECL_DEPRECATED int providerCapabilities( const QString &providerKey ) const SIP_DEPRECATED;

    SIP_SKIP QgsVectorLayerExporter::ExportError createEmptyLayer( const QString &providerKey, const QString &uri, const QgsFields &fields, QgsWkbTypes::Type wkbType, const QgsCoordinateReferenceSystem &srs, bool overwrite, QMap<int, int> &oldToNewAttrIdxMap, QString &errorMessage, const QMap<QString, QVariant> *options );

    virtual QgsRasterDataProvider *createRasterDataProvider(
      const QString &providerKey,
      const QString &uri,
      const QString &format,
      int nBands,
      Qgis::DataType type,
      int width, int height,
      double *geoTransform,
      const QgsCoordinateReferenceSystem &crs,
      const QStringList &createOptions = QStringList() ) SIP_FACTORY;

    QList<QPair<QString, QString> > pyramidResamplingMethods( const QString &providerKey );

    QVariantMap decodeUri( const QString &providerKey, const QString &uri );

    QString encodeUri( const QString &providerKey, const QVariantMap &parts );

    Q_DECL_DEPRECATED QWidget *createSelectionWidget( const QString &providerKey, QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::WindowFlags(), QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None ) SIP_DEPRECATED;

    QList< QgsDataItemProvider * > dataItemProviders( const QString &providerKey ) const SIP_FACTORY;

    int listStyles( const QString &providerKey,
                    const QString &uri,
                    QStringList &ids,
                    QStringList &names,
                    QStringList &descriptions,
                    QString &errCause );

    QString getStyleById( const QString &providerKey,  const QString &uri, QString styleId, QString &errCause );

    bool deleteStyleById( const QString &providerKey,  const QString &uri, QString styleId, QString &errCause );

    bool saveStyle( const QString &providerKey,  const QString &uri, const QString &qmlStyle, const QString &sldStyle,
                    const QString &styleName, const QString &styleDescription,
                    const QString &uiFileContent, bool useAsDefault, QString &errCause );

    QString loadStyle( const QString &providerKey,  const QString &uri, QString &errCause );

    bool createDb( const QString &providerKey, const QString &dbPath, QString &errCause );

    QgsTransaction *createTransaction( const QString &providerKey, const QString &connString ) SIP_FACTORY;

    Q_DECL_DEPRECATED QFunctionPointer function( const QString &providerKey, const QString &functionName ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED QLibrary *createProviderLibrary( const QString &providerKey ) const SIP_FACTORY SIP_DEPRECATED;

    QStringList providerList() const;

    QgsProviderMetadata *providerMetadata( const QString &providerKey ) const;

    virtual QString fileVectorFilters() const;

    virtual QString fileRasterFilters() const;

    virtual QString fileMeshFilters() const;

    virtual QString fileMeshDatasetFilters() const;

    virtual QString databaseDrivers() const;
    virtual QString directoryDrivers() const;
    virtual QString protocolDrivers() const;

    Q_DECL_DEPRECATED void registerGuis( QWidget *widget ) SIP_DEPRECATED;

    bool registerProvider( QgsProviderMetadata *providerMetadata SIP_TRANSFER );

    SIP_SKIP typedef std::map<QString, QgsProviderMetadata *> Providers;

  private:
    QgsProviderRegistry( const QString &pluginPath );

#ifdef SIP_RUN
    QgsProviderRegistry( const QString &pluginPath );
#endif

    void init();
    void clean();

    Providers mProviders;

    QDir mLibraryDirectory;

    QString mVectorFileFilters;

    QString mRasterFileFilters;

    QString mMeshFileFilters;

    QString mMeshDatasetFileFilters;

    QString mDatabaseDrivers;

    QString mDirectoryDrivers;

    QString mProtocolDrivers;

    static bool exists();

    friend class QgsApplication;

}; // class QgsProviderRegistry

#endif //QGSPROVIDERREGISTRY_H