mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
117 lines
4.0 KiB
Plaintext
117 lines
4.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsprovidermetadata.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsProviderMetadata
|
|
{
|
|
%Docstring
|
|
Holds data provider key, description, and associated shared library file or function pointer information.
|
|
|
|
Provider metadata refers either to providers which are loaded via libraries or
|
|
which are native providers that are included in the core QGIS installation
|
|
and accessed through function pointers.
|
|
|
|
For library based providers, the metadata class is used in a lazy load
|
|
implementation in QgsProviderRegistry. To save memory, data providers
|
|
are only actually loaded via QLibrary calls if they're to be used. (Though they're all
|
|
iteratively loaded once to get their metadata information, and then
|
|
unloaded when the QgsProviderRegistry is created.) QgsProviderMetadata
|
|
supplies enough information to be able to later load the associated shared
|
|
library object.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprovidermetadata.h"
|
|
%End
|
|
public:
|
|
|
|
|
|
QgsProviderMetadata( const QString &_key, const QString &_description, const QString &_library );
|
|
|
|
QgsProviderMetadata( const QString &key, const QString &description, SIP_PYCALLABLE / AllowNone / );
|
|
%Docstring
|
|
Metadata for provider with direct provider creation function pointer, where
|
|
no library is involved.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
%MethodCode
|
|
|
|
// Make sure the callable doesn't get garbage collected, this is needed because refcount for a2 is 0
|
|
// and the creation function pointer is passed to the metadata and it needs to be kept in memory.
|
|
Py_INCREF( a2 );
|
|
|
|
Py_BEGIN_ALLOW_THREADS
|
|
|
|
sipCpp = new QgsProviderMetadata( *a0, *a1, [a2]( const QString &dataSource, const QgsDataProvider::ProviderOptions &providerOptions ) -> QgsDataProvider*
|
|
{
|
|
QgsDataProvider *provider;
|
|
provider = nullptr;
|
|
PyObject *sipResObj;
|
|
SIP_BLOCK_THREADS
|
|
|
|
sipResObj = sipCallMethod( nullptr, a2, "DD", new QString( dataSource ), sipType_QString, nullptr, new QgsDataProvider::ProviderOptions( providerOptions ), sipType_QgsDataProvider_ProviderOptions, NULL );
|
|
|
|
if ( sipResObj )
|
|
{
|
|
if ( sipCanConvertToType( sipResObj, sipType_QgsDataProvider, SIP_NOT_NONE ) )
|
|
{
|
|
int state0;
|
|
int sipIsErr = 0;
|
|
provider = reinterpret_cast<QgsDataProvider *>( sipConvertToType( sipResObj, sipType_QgsDataProvider, nullptr, SIP_NOT_NONE, &state0, &sipIsErr ) );
|
|
if ( sipIsErr != 0 )
|
|
{
|
|
sipReleaseType( provider, sipType_QgsDataProvider, state0 );
|
|
provider = nullptr;
|
|
}
|
|
}
|
|
}
|
|
SIP_UNBLOCK_THREADS
|
|
return provider;
|
|
} );
|
|
|
|
Py_END_ALLOW_THREADS
|
|
|
|
%End
|
|
|
|
QString key() const;
|
|
%Docstring
|
|
This returns the unique key associated with the provider
|
|
|
|
This key string is used for the associative container in :py:class:`QgsProviderRegistry`
|
|
%End
|
|
|
|
QString description() const;
|
|
%Docstring
|
|
This returns descriptive text for the provider
|
|
|
|
This is used to provide a descriptive list of available data providers.
|
|
%End
|
|
|
|
QString library() const;
|
|
%Docstring
|
|
This returns the library file name
|
|
|
|
This is used to QLibrary calls to load the data provider.
|
|
%End
|
|
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsprovidermetadata.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|