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 "qgsdataprovider.h"
#include "qgis_core.h"
#include "qgis_sip.h"


class QgsProviderMetadata;
class QgsVectorLayer;
class QgsCoordinateReferenceSystem;


class CORE_EXPORT QgsProviderRegistry
{

  public:

    enum WidgetMode
    {
      None,
      Embedded,
      Manager,
    };

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

    virtual ~QgsProviderRegistry();

    QString library( const QString &providerKey ) const;

    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;

    int providerCapabilities( const QString &providerKey ) const;

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

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

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

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

    QStringList providerList() const;

    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;

    void registerGuis( QWidget *widget );

    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