Add QgsDataProvider::ProviderOptions struct to constructors

for data providers

Allows a way to pass generic settings to providers, e.g.
passing a datum transform context for use in provider's
constructors.

Author: nyalldawson

python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in

@@ -266,7 +266,7 @@ Responsible for reading native mesh data
 #include "qgsmeshdataprovider.h"
 %End
   public:
-    QgsMeshDataProvider( const QString &uri = QString() );
+    QgsMeshDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options );
 %Docstring
 Ctor
 %End

python/core/auto_generated/mesh/qgsmeshlayer.sip.in

@@ -77,7 +77,13 @@ is the MDAL connection string. QGIS must be built with MDAL support to allow thi
 %End
   public:
 
-    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = "mesh_memory" );
+    struct LayerOptions
+    {
+
+    };
+
+    explicit QgsMeshLayer( const QString &path = QString(), const QString &baseName = QString(), const QString &providerLib = "mesh_memory",
+                           const QgsMeshLayer::LayerOptions &options = QgsMeshLayer::LayerOptions() );
 %Docstring
 Constructor - creates a mesh layer
 

python/core/auto_generated/qgsdataprovider.sip.in

@@ -64,9 +64,17 @@ to generic QgsVectorDataProvider's) depends on it.
       CustomData
     };
 
-    QgsDataProvider( const QString &uri = QString() );
+
+    struct ProviderOptions
+    {
+
+    };
+
+    QgsDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options );
 %Docstring
 Create a new dataprovider with the specified in the ``uri``.
+
+Additional creation options are specified within the ``options`` value.
 %End
 
     virtual QgsCoordinateReferenceSystem crs() const = 0;

python/core/auto_generated/qgsprovidermetadata.sip.in

@@ -10,7 +10,6 @@
 
 
 
-
 class QgsProviderMetadata
 {
 %Docstring

python/core/auto_generated/qgsproviderregistry.sip.in

@@ -73,12 +73,14 @@ Set library directory where to search for plugins
 %End
 
     QgsDataProvider *createProvider( const QString &providerKey,
-                                     const QString &dataSource ) /Factory/;
+                                     const QString &dataSource,
+                                     const QgsDataProvider::ProviderOptions &options ) /Factory/;
 %Docstring
 Creates a new instance of a provider.
 
 :param providerKey: identificator of the provider
 :param dataSource:  string containing data source for the provider
+:param options: provider options
 
 :return: new instance of provider or NULL on error
 %End

python/core/auto_generated/qgsvectordataprovider.sip.in

@@ -67,11 +67,13 @@ of feature and attribute information from a spatial datasource.
       UnknownCount,
     };
 
-    QgsVectorDataProvider( const QString &uri = QString() );
+    QgsVectorDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options );
 %Docstring
-Constructor of the vector provider
+Constructor for a vector data provider.
 
-:param uri:  uniform resource locator (URI) for a dataset
+The ``uri`` argument specifies the uniform resource locator (URI) for the associated dataset.
+
+Additional creation options are specified within the ``options`` value.
 %End
 
     virtual QgsAbstractFeatureSource *featureSource() const = 0 /Factory/;

python/core/auto_generated/qgsvectorlayer.sip.in

@@ -925,7 +925,7 @@ calculated by countSymbolFeatures()
 :return: number of features rendered by symbol or -1 if failed or counts are not available
 %End
 
-    void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag = false );
+ void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag = false ) /Deprecated/;
 %Docstring
 Update the data source of the layer. The layer's renderer and legend will be preserved only
 if the geometry type of the new data source matches the current geometry type of the layer.
@@ -937,6 +937,23 @@ if the geometry type of the new data source matches the current geometry type of
 data source
 
 .. versionadded:: 2.10
+
+.. deprecated:: Use version with ProviderOptions argument instead
+%End
+
+    void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag = false );
+%Docstring
+Updates the data source of the layer. The layer's renderer and legend will be preserved only
+if the geometry type of the new data source matches the current geometry type of the layer.
+
+:param dataSource: new layer data source
+:param baseName: base name of the layer
+:param provider: provider string
+:param options: provider options
+:param loadDefaultStyleFlag: set to true to reset the layer's style to the default for the
+data source
+
+.. versionadded:: 3.2
 %End
 
     virtual QString loadDefaultStyle( bool &resultFlag /Out/ );

python/core/auto_generated/raster/qgsrasterdataprovider.sip.in

@@ -82,7 +82,15 @@ Base class for raster data providers.
 
     QgsRasterDataProvider();
 
-    QgsRasterDataProvider( const QString &uri );
+    QgsRasterDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options );
+%Docstring
+Constructor for QgsRasterDataProvider.
+
+The ``uri`` argument gives a provider-specific uri indicating the underlying data
+source and it's parameters.
+
+The ``options`` argument specifies generic provider options.
+%End
 
     virtual QgsRasterInterface *clone() const = 0;
 

python/core/auto_generated/raster/qgsrasterlayer.sip.in

@@ -180,9 +180,21 @@ returned in ``retError``.
 Return time stamp for given file name
 %End
 
-    void setDataProvider( const QString &provider );
+ void setDataProvider( const QString &provider ) /Deprecated/;
 %Docstring
-[ data provider interface ] Set the data provider
+Set the data provider.
+
+.. deprecated:: Use the version with ProviderOptions instead.
+%End
+
+    void setDataProvider( const QString &provider, const QgsDataProvider::ProviderOptions &options );
+%Docstring
+Set the data provider.
+
+:param provider: provider key string, must match a valid QgsRasterDataProvider key. E.g. "gdal", "wms", etc.
+:param options: provider options
+
+.. versionadded:: 3.2
 %End
 
     LayerType rasterType();

src/core/mesh/qgsmeshdataprovider.cpp

@@ -18,8 +18,8 @@
 #include "qgsmeshdataprovider.h"
 #include "qgis.h"
 
-QgsMeshDataProvider::QgsMeshDataProvider( const QString &uri )
-  : QgsDataProvider( uri )
+QgsMeshDataProvider::QgsMeshDataProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options )
+  : QgsDataProvider( uri, options )
 {
 }