Refactor enum handling

- Add enums to qgis.h instead of qgscoreenums, so that they belong to a Qgis namespace - Split up the various symbol headers into multiple files so that we can fine-tune their inclusion and forward declare more readily, speeding up recompilation - Move QgsSymbol enums to qgis
qgis · May 18, 2021 · b5dfe8f · b5dfe8f · nirvn · May 20, 2021
1 parent 239092e
commit b5dfe8f
Show file tree

Hide file tree

Showing 302 changed files with 3,873 additions and 3,111 deletions.
diff --git a/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in b/python/3d/auto_generated/symbols/qgspoint3dsymbol.sip.in
@@ -38,6 +38,8 @@ Constructor for QgsPoint3DSymbol with default QgsMarkerSymbol as the billboardSy
 Copy Constructor for QgsPoint3DSymbol
 %End
 
+    ~QgsPoint3DSymbol();
+
     static QgsAbstract3DSymbol *create() /Factory/;
 %Docstring
 Creates a new QgsPoint3DSymbol.

diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -1,3 +1,61 @@
 # The following has been generated automatically from src/core/qgis.h
+QgsMapLayer.LayerType = QgsMapLayerType
+# monkey patching scoped based enum
+QgsMapLayer.VectorLayer = QgsMapLayerType.VectorLayer
+QgsMapLayer.VectorLayer.__doc__ = ""
+QgsMapLayer.RasterLayer = QgsMapLayerType.RasterLayer
+QgsMapLayer.RasterLayer.__doc__ = ""
+QgsMapLayer.PluginLayer = QgsMapLayerType.PluginLayer
+QgsMapLayer.PluginLayer.__doc__ = ""
+QgsMapLayer.MeshLayer = QgsMapLayerType.MeshLayer
+QgsMapLayer.MeshLayer.__doc__ = "Added in 3.2"
+QgsMapLayer.VectorTileLayer = QgsMapLayerType.VectorTileLayer
+QgsMapLayer.VectorTileLayer.__doc__ = "Added in 3.14"
+QgsMapLayer.AnnotationLayer = QgsMapLayerType.AnnotationLayer
+QgsMapLayer.AnnotationLayer.__doc__ = "Contains freeform, georeferenced annotations. Added in QGIS 3.16"
+QgsMapLayer.PointCloudLayer = QgsMapLayerType.PointCloudLayer
+QgsMapLayer.PointCloudLayer.__doc__ = "Added in 3.18"
+QgsMapLayerType.__doc__ = 'Types of layers that can be added to a map\n\n.. versionadded:: 3.8\n\n' + '* ``VectorLayer``: ' + QgsMapLayerType.VectorLayer.__doc__ + '\n' + '* ``RasterLayer``: ' + QgsMapLayerType.RasterLayer.__doc__ + '\n' + '* ``PluginLayer``: ' + QgsMapLayerType.PluginLayer.__doc__ + '\n' + '* ``MeshLayer``: ' + QgsMapLayerType.MeshLayer.__doc__ + '\n' + '* ``VectorTileLayer``: ' + QgsMapLayerType.VectorTileLayer.__doc__ + '\n' + '* ``AnnotationLayer``: ' + QgsMapLayerType.AnnotationLayer.__doc__ + '\n' + '* ``PointCloudLayer``: ' + QgsMapLayerType.PointCloudLayer.__doc__
+# --
 Qgis.DataType.baseClass = Qgis
 Qgis.PythonMacroMode.baseClass = Qgis
+QgsVectorDataProvider.FeatureCountState = Qgis.FeatureCountState
+# monkey patching scoped based enum
+QgsVectorDataProvider.Uncounted = Qgis.FeatureCountState.Uncounted
+QgsVectorDataProvider.Uncounted.__doc__ = "Feature count not yet computed"
+QgsVectorDataProvider.UnknownCount = Qgis.FeatureCountState.UnknownCount
+QgsVectorDataProvider.UnknownCount.__doc__ = "Provider returned an unknown feature count"
+Qgis.FeatureCountState.__doc__ = 'Enumeration of feature count states\n\n.. versionadded:: 3.20\n\n' + '* ``Uncounted``: ' + Qgis.FeatureCountState.Uncounted.__doc__ + '\n' + '* ``UnknownCount``: ' + Qgis.FeatureCountState.UnknownCount.__doc__
+# --
+QgsSymbol.SymbolType = Qgis.SymbolType
+# monkey patching scoped based enum
+QgsSymbol.Marker = Qgis.SymbolType.Marker
+QgsSymbol.Marker.__doc__ = "Marker symbol"
+QgsSymbol.Line = Qgis.SymbolType.Line
+QgsSymbol.Line.__doc__ = "Line symbol"
+QgsSymbol.Fill = Qgis.SymbolType.Fill
+QgsSymbol.Fill.__doc__ = "Fill symbol"
+QgsSymbol.Hybrid = Qgis.SymbolType.Hybrid
+QgsSymbol.Hybrid.__doc__ = "Hybrid symbol"
+Qgis.SymbolType.__doc__ = 'Symbol types\n\n.. versionadded:: 3.20\n\n' + '* ``Marker``: ' + Qgis.SymbolType.Marker.__doc__ + '\n' + '* ``Line``: ' + Qgis.SymbolType.Line.__doc__ + '\n' + '* ``Fill``: ' + Qgis.SymbolType.Fill.__doc__ + '\n' + '* ``Hybrid``: ' + Qgis.SymbolType.Hybrid.__doc__
+# --
+QgsSymbol.ScaleMethod = Qgis.ScaleMethod
+# monkey patching scoped based enum
+QgsSymbol.ScaleArea = Qgis.ScaleMethod.ScaleArea
+QgsSymbol.ScaleArea.__doc__ = "Calculate scale by the area"
+QgsSymbol.ScaleDiameter = Qgis.ScaleMethod.ScaleDiameter
+QgsSymbol.ScaleDiameter.__doc__ = "Calculate scale by the diameter"
+Qgis.ScaleMethod.__doc__ = 'Scale methods\n\n.. versionadded:: 3.20\n\n' + '* ``ScaleArea``: ' + Qgis.ScaleMethod.ScaleArea.__doc__ + '\n' + '* ``ScaleDiameter``: ' + Qgis.ScaleMethod.ScaleDiameter.__doc__
+# --
+QgsSymbol.RenderHint = Qgis.SymbolRenderHint
+# monkey patching scoped based enum
+QgsSymbol.DynamicRotation = Qgis.SymbolRenderHint.DynamicRotation
+QgsSymbol.DynamicRotation.__doc__ = "Rotation of symbol may be changed during rendering and symbol should not be cached"
+Qgis.SymbolRenderHint.__doc__ = 'Flags controlling behavior of symbols during rendering\n\n.. versionadded:: 3.20\n\n' + '* ``DynamicRotation``: ' + Qgis.SymbolRenderHint.DynamicRotation.__doc__
+# --
+QgsSymbol.PreviewFlag = Qgis.SymbolPreviewFlag
+# monkey patching scoped based enum
+QgsSymbol.FlagIncludeCrosshairsForMarkerSymbols = Qgis.SymbolPreviewFlag.FlagIncludeCrosshairsForMarkerSymbols
+QgsSymbol.FlagIncludeCrosshairsForMarkerSymbols.__doc__ = "Include a crosshairs reference image in the background of marker symbol previews"
+Qgis.SymbolPreviewFlag.__doc__ = 'Flags for controlling how symbol preview images are generated.\n\n.. versionadded:: 3.20\n\n' + '* ``FlagIncludeCrosshairsForMarkerSymbols``: ' + Qgis.SymbolPreviewFlag.FlagIncludeCrosshairsForMarkerSymbols.__doc__
+# --
diff --git a/python/core/auto_additions/qgscoreenums.py b/python/core/auto_additions/qgscoreenums.py
diff --git a/python/core/auto_generated/annotations/qgsannotation.sip.in b/python/core/auto_generated/annotations/qgsannotation.sip.in
@@ -50,6 +50,8 @@ a :py:func:`~renderAnnotation` override.
 Constructor for QgsAnnotation.
 %End
 
+    ~QgsAnnotation();
+
     virtual QgsAnnotation *clone() const = 0 /Factory/;
 %Docstring
 Clones the annotation, returning a new copy of the annotation

diff --git a/python/core/auto_generated/effects/qgsblureffect.sip.in b/python/core/auto_generated/effects/qgsblureffect.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsBlurEffect : QgsPaintEffect /NoDefaultCtors/
 {
 %Docstring(signature="appended")

diff --git a/python/core/auto_generated/effects/qgsshadoweffect.sip.in b/python/core/auto_generated/effects/qgsshadoweffect.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsShadowEffect : QgsPaintEffect /NoDefaultCtors/
 {
 %Docstring(signature="appended")

diff --git a/python/core/auto_generated/layertree/qgscolorramplegendnode.sip.in b/python/core/auto_generated/layertree/qgscolorramplegendnode.sip.in
@@ -8,6 +8,7 @@
 
 
 
+
 class QgsColorRampLegendNode : QgsLayerTreeModelLegendNode
 {
 %Docstring(signature="appended")

diff --git a/python/core/auto_generated/layertree/qgslegendpatchshape.sip.in b/python/core/auto_generated/layertree/qgslegendpatchshape.sip.in
@@ -29,7 +29,7 @@ A null QgsLegendPatchShape indicates that the default legend patch shape
 should be used instead.
 %End
 
-    QgsLegendPatchShape( QgsSymbol::SymbolType type,
+    QgsLegendPatchShape( Qgis::SymbolType type,
                          const QgsGeometry &geometry,
                          bool preserveAspectRatio = true );
 %Docstring
@@ -50,14 +50,14 @@ Returns ``True`` if the patch shape is a null QgsLegendPatchShape,
 which indicates that the default legend patch shape should be used instead.
 %End
 
-    QgsSymbol::SymbolType symbolType() const;
+    Qgis::SymbolType symbolType() const;
 %Docstring
 Returns the symbol type associated with this patch.
 
 .. seealso:: :py:func:`setSymbolType`
 %End
 
-    void setSymbolType( QgsSymbol::SymbolType type );
+    void setSymbolType( Qgis::SymbolType type );
 %Docstring
 Sets the symbol ``type`` associated with this patch.
 
@@ -111,7 +111,7 @@ The default behavior is to respect the :py:func:`~QgsLegendPatchShape.geometry`'
 .. seealso:: :py:func:`setPreserveAspectRatio`
 %End
 
-    QList< QList< QPolygonF > > toQPolygonF( QgsSymbol::SymbolType type, QSizeF size ) const;
+    QList< QList< QPolygonF > > toQPolygonF( Qgis::SymbolType type, QSizeF size ) const;
 %Docstring
 Converts the patch shape to a set of QPolygonF objects representing
 how the patch should be drawn for a symbol of the given ``type`` at the specified ``size`` (as

diff --git a/python/core/auto_generated/layout/qgslayoutitemmapgrid.sip.in b/python/core/auto_generated/layout/qgslayoutitemmapgrid.sip.in
@@ -240,6 +240,7 @@ Constructor for QgsLayoutItemMapGrid.
 :param name: friendly display name for grid
 :param map: :py:class:`QgsLayoutItemMap` the grid is attached to
 %End
+    ~QgsLayoutItemMapGrid();
 
     virtual void draw( QPainter *painter );
 

diff --git a/python/core/auto_generated/layout/qgslayoutitempolygon.sip.in b/python/core/auto_generated/layout/qgslayoutitempolygon.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsLayoutItemPolygon: QgsLayoutNodesItem
 {
 %Docstring(signature="appended")
@@ -33,6 +34,8 @@ Constructor for QgsLayoutItemPolygon for the specified ``polygon``
 and ``layout``.
 %End
 
+    ~QgsLayoutItemPolygon();
+
     static QgsLayoutItemPolygon *create( QgsLayout *layout ) /Factory/;
 %Docstring
 Returns a new polygon item for the specified ``layout``.

diff --git a/python/core/auto_generated/layout/qgslayoutitempolyline.sip.in b/python/core/auto_generated/layout/qgslayoutitempolyline.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsLayoutItemPolyline: QgsLayoutNodesItem
 {
 %Docstring(signature="appended")
@@ -33,6 +34,7 @@ Layout item for node based polyline shapes.
 %Docstring
 Constructor for QgsLayoutItemPolyline for the specified ``layout``.
 %End
+    ~QgsLayoutItemPolyline();
 
     QgsLayoutItemPolyline( const QPolygonF &polyline, QgsLayout *layout );
 %Docstring

diff --git a/python/core/auto_generated/layout/qgslayoutitemshape.sip.in b/python/core/auto_generated/layout/qgslayoutitemshape.sip.in
@@ -34,6 +34,8 @@ Layout item for basic filled shapes (e.g. rectangles, ellipses).
 Constructor for QgsLayoutItemShape, with the specified parent ``layout``.
 %End
 
+    ~QgsLayoutItemShape();
+
     static QgsLayoutItemShape *create( QgsLayout *layout ) /Factory/;
 %Docstring
 Returns a new shape item for the specified ``layout``.

diff --git a/python/core/auto_generated/pointcloud/qgspointcloudextentrenderer.sip.in b/python/core/auto_generated/pointcloud/qgspointcloudextentrenderer.sip.in
@@ -30,6 +30,7 @@ Constructor for QgsPointCloudExtentRenderer.
 Optionally the ``symbol`` to use for showing the extent can be specified. If specified, ownership is
 transferred to the renderer. If no ``symbol`` is specified a default one will be created instead.
 %End
+    ~QgsPointCloudExtentRenderer();
 
     virtual QString type() const;
 

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -18,6 +18,17 @@
 int QgisEvent = QEvent::User + 1;
 %End
 
+enum class QgsMapLayerType
+  {
+  VectorLayer,
+  RasterLayer,
+  PluginLayer,
+  MeshLayer,
+  VectorTileLayer,
+  AnnotationLayer,
+  PointCloudLayer,
+};
+
 
 class Qgis
 {
@@ -100,6 +111,40 @@ The development version
       NotForThisSession,
     };
 
+    enum class FeatureCountState
+      {
+      Uncounted,
+      UnknownCount,
+    };
+
+    enum class SymbolType
+      {
+      Marker,
+      Line,
+      Fill,
+      Hybrid
+    };
+
+    enum class ScaleMethod
+      {
+      ScaleArea,
+      ScaleDiameter
+    };
+
+    enum class SymbolRenderHint
+      {
+      DynamicRotation,
+    };
+    typedef QFlags<Qgis::SymbolRenderHint> SymbolRenderHints;
+
+
+    enum class SymbolPreviewFlag
+      {
+      FlagIncludeCrosshairsForMarkerSymbols,
+    };
+    typedef QFlags<Qgis::SymbolPreviewFlag> SymbolPreviewFlags;
+
+
     static const double DEFAULT_SEARCH_RADIUS_MM;
 
     static const float DEFAULT_MAPTOPIXEL_THRESHOLD;
@@ -165,6 +210,12 @@ GEOS string version linked
 %End
 };
 
+QFlags<Qgis::SymbolRenderHint> operator|(Qgis::SymbolRenderHint f1, QFlags<Qgis::SymbolRenderHint> f2);
+
+QFlags<Qgis::SymbolPreviewFlag> operator|(Qgis::SymbolPreviewFlag f1, QFlags<Qgis::SymbolPreviewFlag> f2);
+
+
+
 
 
 

diff --git a/python/core/auto_generated/qgsconditionalstyle.sip.in b/python/core/auto_generated/qgsconditionalstyle.sip.in
@@ -8,7 +8,6 @@
 
 
 
-
 typedef QList<QgsConditionalStyle> QgsConditionalStyles;
 
 
@@ -98,6 +97,7 @@ Conditional styling for a rule.
     QgsConditionalStyle();
     QgsConditionalStyle( const QgsConditionalStyle &other );
     QgsConditionalStyle( const QString &rule );
+    ~QgsConditionalStyle();
 
 
     bool matches( const QVariant &value, QgsExpressionContext &context ) const;

diff --git a/python/core/auto_generated/qgscoreenums.sip.in b/python/core/auto_generated/qgscoreenums.sip.in
diff --git a/python/core/auto_generated/symbology/qgsarrowsymbollayer.sip.in b/python/core/auto_generated/symbology/qgsarrowsymbollayer.sip.in
@@ -10,6 +10,7 @@
 
 
 
+
 class QgsArrowSymbolLayer : QgsLineSymbolLayer
 {
 %Docstring(signature="appended")
@@ -39,6 +40,7 @@ Create a new QgsArrowSymbolLayer
     virtual QgsArrowSymbolLayer *clone() const /Factory/;
 
     virtual QgsSymbol *subSymbol();
+
     virtual bool setSubSymbol( QgsSymbol *symbol /Transfer/ );
 
     virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;

diff --git a/python/core/auto_generated/symbology/qgscategorizedsymbolrenderer.sip.in b/python/core/auto_generated/symbology/qgscategorizedsymbolrenderer.sip.in
@@ -42,6 +42,7 @@ The ``render`` argument indicates whether the category should initially be rende
 %Docstring
 Copy constructor.
 %End
+    ~QgsRendererCategory();
 
     QVariant value() const;
 %Docstring
@@ -422,7 +423,7 @@ Will return ``None`` if the functionality is disabled.
 .. versionadded:: 3.0
 %End
 
-    int matchToSymbols( QgsStyle *style, QgsSymbol::SymbolType type,
+    int matchToSymbols( QgsStyle *style, Qgis::SymbolType type,
                         QVariantList &unmatchedCategories /Out/, QStringList &unmatchedSymbols /Out/, bool caseSensitive = true, bool useTolerantMatch = false );
 %Docstring
 Replaces category symbols with the symbols from a ``style`` that have a matching