Skip to content

Commit f831a3c

Browse files
nyalldawsonnyalldawson
committedApr 2, 2017
Remove processing sip bindings from sip blacklist
·
ltr-3_40final-3_0_0
1 parent bed74fc commit f831a3c

File tree

6 files changed

+235
-157
lines changed

6 files changed

+235
-157
lines changed
 

‎python/auto_sip.blacklist

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,9 +243,6 @@ core/layertree/qgslayertreemodellegendnode.sip
243243
core/layertree/qgslayertreenode.sip
244244
core/layertree/qgslayertreeregistrybridge.sip
245245
core/layertree/qgslayertreeutils.sip
246-
core/processing/qgsprocessingfeedback.sip
247-
core/processing/qgsprocessingprovider.sip
248-
core/processing/qgsprocessingregistry.sip
249246
core/raster/qgsbilinearrasterresampler.sip
250247
core/raster/qgsbrightnesscontrastfilter.sip
251248
core/raster/qgscliptominmaxenhancement.sip

‎python/core/processing/qgsprocessingfeedback.sip

Lines changed: 86 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,94 @@
1-
/**
2-
* \class QgsProcessingFeedback
3-
* \ingroup core
4-
* Base class for providing feedback from a processing algorithm.
5-
*
6-
* This base class implementation silently ignores all feedback reported by algorithms.
7-
* Subclasses of QgsProcessingFeedback can be used to log this feedback or report
8-
* it to users via the GUI.
9-
* \note added in QGIS 3.0
10-
*/
11-
class QgsProcessingFeedback : public QgsFeedback
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/core/processing/qgsprocessingfeedback.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
12+
class QgsProcessingFeedback : QgsFeedback
1213
{
14+
%Docstring
15+
\class QgsProcessingFeedback
16+
\ingroup core
17+
Base class for providing feedback from a processing algorithm.
18+
19+
This base class implementation silently ignores all feedback reported by algorithms.
20+
Subclasses of QgsProcessingFeedback can be used to log this feedback or report
21+
it to users via the GUI.
22+
\note added in QGIS 3.0
23+
%End
24+
1325
%TypeHeaderCode
14-
#include <qgsprocessingfeedback.h>
26+
#include "qgsprocessingfeedback.h"
1527
%End
1628

1729
public:
1830

19-
/**
20-
* Sets a progress report text string. This can be used in conjunction with
21-
* setProgress() to provide detailed progress reports, such as "Transformed
22-
* 4 of 5 layers".
23-
* @see setProgress()
24-
*/
25-
virtual void setProgressText( const QString& text );
26-
27-
/**
28-
* Reports that the algorithm encountered an error which prevented it
29-
* from successfully executing.
30-
*/
31-
virtual void reportError( const QString& error );
32-
33-
/**
34-
* Pushes a general informational message from the algorithm. This can
35-
* be used to report feedback which is neither a status report or an
36-
* error, such as "Found 47 matching features".
37-
* @see pushCommandInfo()
38-
* @see pushDebugInfo()
39-
* @see pushConsoleInfo()
40-
*/
41-
virtual void pushInfo( const QString& info );
42-
43-
/**
44-
* Pushes an informational message containing a command from the algorithm.
45-
* This is usually used to report commands which are executed in an external
46-
* application or as subprocesses.
47-
* @see pushInfo()
48-
* @see pushDebugInfo()
49-
* @see pushConsoleInfo()
50-
*/
51-
virtual void pushCommandInfo( const QString& info );
52-
53-
/**
54-
* Pushes an informational message containing debugging helpers from
55-
* the algorithm.
56-
* @see pushInfo()
57-
* @see pushCommandInfo()
58-
* @see pushConsoleInfo()
59-
*/
60-
virtual void pushDebugInfo( const QString& info );
61-
62-
63-
/**
64-
* Pushes a console feedback message from the algorithm. This is used to
65-
* report the output from executing an external command or subprocess.
66-
* @see pushInfo()
67-
* @see pushDebugInfo()
68-
* @see pushCommandInfo()
69-
*/
70-
virtual void pushConsoleInfo( const QString& info );
31+
virtual void setProgressText( const QString &text );
32+
%Docstring
33+
Sets a progress report text string. This can be used in conjunction with
34+
setProgress() to provide detailed progress reports, such as "Transformed
35+
4 of 5 layers".
36+
@see setProgress()
37+
%End
38+
39+
virtual void reportError( const QString &error );
40+
%Docstring
41+
Reports that the algorithm encountered an error which prevented it
42+
from successfully executing.
43+
%End
44+
45+
virtual void pushInfo( const QString &info );
46+
%Docstring
47+
Pushes a general informational message from the algorithm. This can
48+
be used to report feedback which is neither a status report or an
49+
error, such as "Found 47 matching features".
50+
@see pushCommandInfo()
51+
@see pushDebugInfo()
52+
@see pushConsoleInfo()
53+
%End
54+
55+
virtual void pushCommandInfo( const QString &info );
56+
%Docstring
57+
Pushes an informational message containing a command from the algorithm.
58+
This is usually used to report commands which are executed in an external
59+
application or as subprocesses.
60+
@see pushInfo()
61+
@see pushDebugInfo()
62+
@see pushConsoleInfo()
63+
%End
64+
65+
virtual void pushDebugInfo( const QString &info );
66+
%Docstring
67+
Pushes an informational message containing debugging helpers from
68+
the algorithm.
69+
@see pushInfo()
70+
@see pushCommandInfo()
71+
@see pushConsoleInfo()
72+
%End
73+
74+
virtual void pushConsoleInfo( const QString &info );
75+
%Docstring
76+
Pushes a console feedback message from the algorithm. This is used to
77+
report the output from executing an external command or subprocess.
78+
@see pushInfo()
79+
@see pushDebugInfo()
80+
@see pushCommandInfo()
81+
%End
7182

7283
};
84+
85+
86+
87+
88+
/************************************************************************
89+
* This file has been generated automatically from *
90+
* *
91+
* src/core/processing/qgsprocessingfeedback.h *
92+
* *
93+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
94+
************************************************************************/

‎python/core/processing/qgsprocessingprovider.sip

Lines changed: 59 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,82 @@
1-
/**
2-
* \class QgsProcessingProvider
3-
* \ingroup core
4-
* Abstract base class for processing providers. An algorithm provider is a set of
5-
* related algorithms, typically from the same external application or related
6-
* to a common area of analysis.
7-
* \note added in QGIS 3.0
8-
*/
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/core/processing/qgsprocessingprovider.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
912
class QgsProcessingProvider
1013
{
14+
%Docstring
15+
\class QgsProcessingProvider
16+
\ingroup core
17+
Abstract base class for processing providers. An algorithm provider is a set of
18+
related algorithms, typically from the same external application or related
19+
to a common area of analysis.
20+
\note added in QGIS 3.0
21+
%End
22+
1123
%TypeHeaderCode
12-
#include <qgsprocessingprovider.h>
24+
#include "qgsprocessingprovider.h"
1325
%End
1426

1527
public:
1628

1729
QgsProcessingProvider();
30+
%Docstring
31+
Constructor for QgsProcessingProvider.
32+
%End
1833

1934
virtual ~QgsProcessingProvider();
2035

21-
/**
22-
* Returns an icon for the provider.
23-
* @see svgIcon()
24-
*/
36+
2537
virtual QIcon icon() const;
38+
%Docstring
39+
Returns an icon for the provider.
40+
@see svgIconPath()
41+
%End
2642

27-
/**
28-
* Returns a path to an SVG version of the provider's icon.
29-
* @see icon()
30-
*/
3143
virtual QString svgIconPath() const;
44+
%Docstring
45+
Returns a path to an SVG version of the provider's icon.
46+
@see icon()
47+
%End
3248

33-
/**
34-
* Returns the unique provider id, used for identifying the provider. This string
35-
* should be a unique, short, character only string, eg "qgis" or "gdal". This
36-
* string should not be localised.
37-
* @see name()
38-
*/
3949
virtual QString id() const = 0;
50+
%Docstring
51+
Returns the unique provider id, used for identifying the provider. This string
52+
should be a unique, short, character only string, eg "qgis" or "gdal". This
53+
string should not be localised.
54+
@see name()
55+
%End
4056

41-
/**
42-
* Returns the full provider name, which is used to describe the provider within the GUI.
43-
* This string should be localised.
44-
* @see id()
45-
*/
4657
virtual QString name() const = 0;
58+
%Docstring
59+
Returns the full provider name, which is used to describe the provider within the GUI.
60+
This string should be localised.
61+
@see id()
62+
%End
4763

4864
virtual bool canBeActivated() const;
65+
%Docstring
66+
Returns true if the provider can be activated, or false if it cannot be activated (e.g. due to
67+
missing external dependencies).
68+
%End
4969

5070
private:
51-
52-
//! Providers cannot be copied
53-
QgsProcessingProvider( const QgsProcessingProvider& other );
54-
//! Providers cannot be copied
55-
//QgsProcessingProvider& operator=( const QgsProcessingProvider& other );
71+
QgsProcessingProvider( const QgsProcessingProvider &other );
5672
};
73+
74+
75+
76+
/************************************************************************
77+
* This file has been generated automatically from *
78+
* *
79+
* src/core/processing/qgsprocessingprovider.h *
80+
* *
81+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
82+
************************************************************************/

‎python/core/processing/qgsprocessingregistry.sip

Lines changed: 78 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,95 @@
1-
/**
2-
* \class QgsProcessingRegistry
3-
* \ingroup core
4-
* Registry for various processing components, including providers, algorithms
5-
* and various parameters and outputs.
6-
*
7-
* QgsProcessingRegistry is not usually directly created, but rather accessed through
8-
* QgsApplication::processingRegistry().
9-
* \note added in QGIS 3.0
10-
*/
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/core/processing/qgsprocessingregistry.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
1112
class QgsProcessingRegistry : QObject
1213
{
14+
%Docstring
15+
\class QgsProcessingRegistry
16+
\ingroup core
17+
Registry for various processing components, including providers, algorithms
18+
and various parameters and outputs.
19+
20+
QgsProcessingRegistry is not usually directly created, but rather accessed through
21+
QgsApplication::processingRegistry().
22+
\note added in QGIS 3.0
23+
%End
24+
1325
%TypeHeaderCode
14-
#include <qgsprocessingregistry.h>
26+
#include "qgsprocessingregistry.h"
1527
%End
1628

1729
public:
1830

19-
/**
20-
* Constructor for QgsProcessingRegistry.
21-
*/
22-
QgsProcessingRegistry( QObject* parent /TransferThis/ = nullptr );
31+
QgsProcessingRegistry( QObject *parent /TransferThis/ = 0 );
32+
%Docstring
33+
Constructor for QgsProcessingRegistry.
34+
%End
2335

2436
~QgsProcessingRegistry();
2537

26-
/**
27-
* Get list of available providers.
28-
*/
29-
QList<QgsProcessingProvider*> providers() const;
30-
31-
/**
32-
* Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
33-
* Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
34-
* in the registry).
35-
* @see removeProvider()
36-
*/
37-
bool addProvider( QgsProcessingProvider* provider /Transfer/ );
38-
39-
/**
40-
* Removes a provider implementation from the registry (the provider object is deleted).
41-
* Returns false if the provider could not be removed (eg provider does not exist in the registry).
42-
* @see addProvider()
43-
*/
44-
bool removeProvider( QgsProcessingProvider* provider );
45-
46-
/**
47-
* Removes a provider implementation from the registry (the provider object is deleted).
48-
* Returns false if the provider could not be removed (eg provider does not exist in the registry).
49-
* @see addProvider()
50-
*/
51-
bool removeProvider( const QString& providerId );
52-
53-
/**
54-
* Returns a matching provider by provider ID.
55-
*/
56-
QgsProcessingProvider* providerById( const QString& id );
38+
39+
QList<QgsProcessingProvider *> providers() const;
40+
%Docstring
41+
Get list of available providers.
42+
%End
43+
44+
bool addProvider( QgsProcessingProvider *provider /Transfer/ );
45+
%Docstring
46+
Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
47+
Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
48+
in the registry).
49+
@see removeProvider()
50+
%End
51+
52+
bool removeProvider( QgsProcessingProvider *provider );
53+
%Docstring
54+
Removes a provider implementation from the registry (the provider object is deleted).
55+
Returns false if the provider could not be removed (eg provider does not exist in the registry).
56+
@see addProvider()
57+
%End
58+
59+
bool removeProvider( const QString &providerId );
60+
%Docstring
61+
Removes a provider implementation from the registry (the provider object is deleted).
62+
Returns false if the provider could not be removed (eg provider does not exist in the registry).
63+
@see addProvider()
64+
%End
65+
66+
QgsProcessingProvider *providerById( const QString &id );
67+
%Docstring
68+
Returns a matching provider by provider ID.
69+
%End
5770

5871
signals:
5972

60-
//! Emitted when a provider has been added to the registry.
61-
void providerAdded( const QString& id );
73+
void providerAdded( const QString &id );
74+
%Docstring
75+
Emitted when a provider has been added to the registry.
76+
%End
6277

63-
//! Emitted when a provider is removed from the registry
64-
void providerRemoved( const QString& id );
78+
void providerRemoved( const QString &id );
79+
%Docstring
80+
Emitted when a provider is removed from the registry
81+
%End
6582

6683
private:
67-
68-
//! Registry cannot be copied
69-
QgsProcessingRegistry( const QgsProcessingRegistry& other );
70-
//! Registry cannot be copied
71-
//QgsProcessingRegistry& operator=( const QgsProcessingRegistry& other );
84+
QgsProcessingRegistry( const QgsProcessingRegistry &other );
7285
};
86+
87+
88+
89+
/************************************************************************
90+
* This file has been generated automatically from *
91+
* *
92+
* src/core/processing/qgsprocessingregistry.h *
93+
* *
94+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
95+
************************************************************************/

‎src/core/processing/qgsprocessingprovider.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ class CORE_EXPORT QgsProcessingProvider
7979
*/
8080
virtual bool canBeActivated() const { return true; }
8181

82+
private:
83+
84+
#ifdef SIP_RUN
85+
QgsProcessingProvider( const QgsProcessingProvider &other );
86+
#endif
8287
};
8388

8489
#endif // QGSPROCESSINGPROVIDER_H

‎src/core/processing/qgsprocessingregistry.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
#define QGSPROCESSINGREGISTRY_H
2020

2121
#include "qgis_core.h"
22+
#include "qgis.h"
2223
#include "qgsprocessingprovider.h"
2324
#include <QMap>
2425

@@ -41,7 +42,7 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
4142
/**
4243
* Constructor for QgsProcessingRegistry.
4344
*/
44-
QgsProcessingRegistry( QObject *parent = nullptr );
45+
QgsProcessingRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
4546

4647
~QgsProcessingRegistry();
4748

@@ -61,7 +62,7 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
6162
* in the registry).
6263
* @see removeProvider()
6364
*/
64-
bool addProvider( QgsProcessingProvider *provider );
65+
bool addProvider( QgsProcessingProvider *provider SIP_TRANSFER );
6566

6667
/**
6768
* Removes a provider implementation from the registry (the provider object is deleted).
@@ -94,6 +95,10 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
9495

9596
//! Map of available providers by id. This class owns the pointers
9697
QMap<QString, QgsProcessingProvider *> mProviders;
98+
99+
#ifdef SIP_RUN
100+
QgsProcessingRegistry( const QgsProcessingRegistry &other );
101+
#endif
97102
};
98103

99104
#endif // QGSPROCESSINGREGISTRY_H

0 commit comments

Comments
 (0)
Please sign in to comment.