pass by const ref, fix docstring

ViperMiniQ · ViperMiniQ · commit f66016777dc0 · 2026-01-01T14:46:04.000+01:00
diff --git a/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in
@@ -519,15 +519,20 @@ Deletes a vertex within the geometry
 .. seealso:: :py:func:`moveVertex`
 %End
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions ) = 0;
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions ) = 0;
 %Docstring
-Deletes vertices within the geometry
+Deletes vertices within the geometry If a vertex cannot be deleted, the
+method returns ``False`` and the geometry may be left in a partially
+modified and invalid state
 
 :param positions: list of vertex ids for vertices to delete
 
-:return: ``True`` if delete was successful
+:return: ``True`` if all requested vertices were deleted, ``False`` if a
+         single vertex could not be deleted
 
 .. seealso:: :py:func:`deleteVertex`
+
+.. versionadded:: 4.0
 %End
 
     virtual double length() const;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgscircularstring.sip.in b/python/PyQt6/core/auto_generated/geometry/qgscircularstring.sip.in
@@ -175,7 +175,7 @@ circular string.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
diff --git a/python/PyQt6/core/auto_generated/geometry/qgscompoundcurve.sip.in b/python/PyQt6/core/auto_generated/geometry/qgscompoundcurve.sip.in
@@ -167,7 +167,7 @@ Converts the vertex at the given position from/to circular
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
diff --git a/python/PyQt6/core/auto_generated/geometry/qgscurvepolygon.sip.in b/python/PyQt6/core/auto_generated/geometry/qgscurvepolygon.sip.in
@@ -265,7 +265,7 @@ This convention matches the OGC Simple Features specification.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsCoordinateSequence coordinateSequence() const;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -809,7 +809,7 @@ is index 0)
          object to help make the distinction?)
 %End
 
-    bool deleteVertices( const QList<int> atVertices );
+    bool deleteVertices( const QList<int> &atVertices );
 %Docstring
 Deletes vertices at the given positions (first number is index 0)
 
diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometrycollection.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometrycollection.sip.in
@@ -223,7 +223,7 @@ ownership to the caller.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual double length() const /HoldGIL/;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in b/python/PyQt6/core/auto_generated/geometry/qgslinestring.sip.in
@@ -728,7 +728,7 @@ approximation of the curve.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsLineString *reversed() const /Factory/;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgspoint.sip.in b/python/PyQt6/core/auto_generated/geometry/qgspoint.sip.in
@@ -419,7 +419,7 @@ Example
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgspolyhedralsurface.sip.in b/python/PyQt6/core/auto_generated/geometry/qgspolyhedralsurface.sip.in
@@ -168,7 +168,7 @@ deleted.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsCoordinateSequence coordinateSequence() const;
diff --git a/python/PyQt6/core/auto_generated/geometry/qgstriangle.sip.in b/python/PyQt6/core/auto_generated/geometry/qgstriangle.sip.in
@@ -92,7 +92,7 @@ triangle.
 Inherited method not used. You cannot delete or insert a vertex
 directly. Returns always ``False``.
 %End
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
 
diff --git a/python/PyQt6/core/auto_generated/geometry/qgstriangulatedsurface.sip.in b/python/PyQt6/core/auto_generated/geometry/qgstriangulatedsurface.sip.in
@@ -68,7 +68,7 @@ only of triangle patches.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     void setTriangles( const QVector<QgsTriangle *> &triangles /Transfer/ );
diff --git a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in
@@ -519,15 +519,20 @@ Deletes a vertex within the geometry
 .. seealso:: :py:func:`moveVertex`
 %End
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions ) = 0;
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions ) = 0;
 %Docstring
-Deletes vertices within the geometry
+Deletes vertices within the geometry If a vertex cannot be deleted, the
+method returns ``False`` and the geometry may be left in a partially
+modified and invalid state
 
 :param positions: list of vertex ids for vertices to delete
 
-:return: ``True`` if delete was successful
+:return: ``True`` if all requested vertices were deleted, ``False`` if a
+         single vertex could not be deleted
 
 .. seealso:: :py:func:`deleteVertex`
+
+.. versionadded:: 4.0
 %End
 
     virtual double length() const;
diff --git a/python/core/auto_generated/geometry/qgscircularstring.sip.in b/python/core/auto_generated/geometry/qgscircularstring.sip.in
@@ -175,7 +175,7 @@ circular string.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
diff --git a/python/core/auto_generated/geometry/qgscompoundcurve.sip.in b/python/core/auto_generated/geometry/qgscompoundcurve.sip.in
@@ -167,7 +167,7 @@ Converts the vertex at the given position from/to circular
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
 
diff --git a/python/core/auto_generated/geometry/qgscurvepolygon.sip.in b/python/core/auto_generated/geometry/qgscurvepolygon.sip.in
@@ -265,7 +265,7 @@ This convention matches the OGC Simple Features specification.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsCoordinateSequence coordinateSequence() const;
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -809,7 +809,7 @@ is index 0)
          object to help make the distinction?)
 %End
 
-    bool deleteVertices( const QList<int> atVertices );
+    bool deleteVertices( const QList<int> &atVertices );
 %Docstring
 Deletes vertices at the given positions (first number is index 0)
 
diff --git a/python/core/auto_generated/geometry/qgsgeometrycollection.sip.in b/python/core/auto_generated/geometry/qgsgeometrycollection.sip.in
@@ -223,7 +223,7 @@ ownership to the caller.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual double length() const /HoldGIL/;
diff --git a/python/core/auto_generated/geometry/qgslinestring.sip.in b/python/core/auto_generated/geometry/qgslinestring.sip.in
@@ -728,7 +728,7 @@ approximation of the curve.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsLineString *reversed() const /Factory/;
diff --git a/python/core/auto_generated/geometry/qgspoint.sip.in b/python/core/auto_generated/geometry/qgspoint.sip.in
@@ -419,7 +419,7 @@ Example
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt /Out/, QgsVertexId &vertexAfter /Out/, int *leftOf /Out/ = 0, double epsilon = 4 * DBL_EPSILON ) const;
diff --git a/python/core/auto_generated/geometry/qgspolyhedralsurface.sip.in b/python/core/auto_generated/geometry/qgspolyhedralsurface.sip.in
@@ -168,7 +168,7 @@ deleted.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     virtual QgsCoordinateSequence coordinateSequence() const;
diff --git a/python/core/auto_generated/geometry/qgstriangle.sip.in b/python/core/auto_generated/geometry/qgstriangle.sip.in
@@ -92,7 +92,7 @@ triangle.
 Inherited method not used. You cannot delete or insert a vertex
 directly. Returns always ``False``.
 %End
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
     virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex );
 
diff --git a/python/core/auto_generated/geometry/qgstriangulatedsurface.sip.in b/python/core/auto_generated/geometry/qgstriangulatedsurface.sip.in
@@ -68,7 +68,7 @@ only of triangle patches.
 
     virtual bool deleteVertex( QgsVertexId position );
 
-    virtual bool deleteVertices( QList<QgsVertexId> positions );
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions );
 
 
     void setTriangles( const QVector<QgsTriangle *> &triangles /Transfer/ );
diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h
@@ -530,11 +530,13 @@ class CORE_EXPORT QgsAbstractGeometry
 
     /**
      * Deletes vertices within the geometry
+     * If a vertex cannot be deleted, the method returns FALSE and the geometry may be left in a partially modified and invalid state
      * \param positions list of vertex ids for vertices to delete
-     * \returns TRUE if delete was successful
+     * \returns TRUE if all requested vertices were deleted, FALSE if a single vertex could not be deleted
      * \see deleteVertex
+     * \since QGIS 4.0
      */
-    virtual bool deleteVertices( QList<QgsVertexId> positions ) = 0;
+    virtual bool deleteVertices( const QList<QgsVertexId> &positions ) = 0;
 
     /**
      * Returns the planar, 2-dimensional length of the geometry.
diff --git a/src/core/geometry/qgscircularstring.cpp b/src/core/geometry/qgscircularstring.cpp
@@ -1314,7 +1314,7 @@ void QgsCircularString::deleteVertex( int i )
   clearCache();
 }
 
-bool QgsCircularString::deleteVertices( QList<QgsVertexId> positions )
+bool QgsCircularString::deleteVertices( const QList<QgsVertexId> &positions )
 {
   if ( positions.empty() )
   {
@@ -1323,27 +1323,29 @@ bool QgsCircularString::deleteVertices( QList<QgsVertexId> positions )
 
   int nVertices = this->numPoints();
 
-  std::sort( positions.begin(), positions.end(), []( const QgsVertexId & a, const QgsVertexId & b )
+  QList<QgsVertexId> vertices = positions;
+
+  std::sort( vertices.begin(), vertices.end(), []( const QgsVertexId & a, const QgsVertexId & b )
   {
     return a.vertex < b.vertex;
   }
            );
 
   // remove adjacent vertices as deleting one will also delete the other
-  for ( size_t i = positions.size() - 1; i >= 1; i-- )
+  for ( size_t i = vertices.size() - 1; i >= 1; i-- )
   {
-    int vertexNr = positions[i].vertex;
-    int prevVertexNr = positions[i - 1].vertex;
+    int vertexNr = vertices[i].vertex;
+    int prevVertexNr = vertices[i - 1].vertex;
 
     if ( vertexNr - 1 == prevVertexNr )
     {
       if ( vertexNr < nVertices - 2 )
       {
-        positions.removeAt( i );
+        vertices.removeAt( i );
       }
       else
       {
-        positions.removeAt( i - 1 );
+        vertices.removeAt( i - 1 );
       }
 
       nVertices -= 2;
@@ -1356,7 +1358,7 @@ bool QgsCircularString::deleteVertices( QList<QgsVertexId> positions )
 
   nVertices = this->numPoints();
 
-  QListIterator<QgsVertexId> positionsIt( positions );
+  QListIterator<QgsVertexId> positionsIt( vertices );
   positionsIt.toBack();
   while ( positionsIt.hasPrevious() )
   {
diff --git a/src/core/geometry/qgscircularstring.h b/src/core/geometry/qgscircularstring.h
@@ -270,7 +270,7 @@ class CORE_EXPORT QgsCircularString: public QgsCurve
     bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
     bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
     bool deleteVertex( QgsVertexId position ) override;
-    bool deleteVertices( QList<QgsVertexId> positions ) override;
+    bool deleteVertices( const QList<QgsVertexId> &positions ) override;
     double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const override;
     bool pointAt( int node, QgsPoint &point, Qgis::VertexType &type ) const override;
     void sumUpArea( double &sum SIP_OUT ) const override;
diff --git a/src/core/geometry/qgscompoundcurve.cpp b/src/core/geometry/qgscompoundcurve.cpp
@@ -922,7 +922,7 @@ bool QgsCompoundCurve::deleteVertex( QgsVertexId position )
   return success;
 }
 
-bool QgsCompoundCurve::deleteVertices( QList<QgsVertexId> positions )
+bool QgsCompoundCurve::deleteVertices( const QList<QgsVertexId> &positions )
 {
   // we create a list of vertices to delete for each curve
   QMap<int, QList<QgsVertexId >> curveVertices;
diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h
@@ -188,7 +188,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
     bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
     bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
     bool deleteVertex( QgsVertexId position ) override;
-    bool deleteVertices( QList<QgsVertexId> positions ) override;
+    bool deleteVertices( const QList<QgsVertexId> &positions ) override;
     double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, int *leftOf SIP_OUT = nullptr, double epsilon = 4 * std::numeric_limits<double>::epsilon() ) const override;
     bool pointAt( int node, QgsPoint &point, Qgis::VertexType &type ) const override;
     void sumUpArea( double &sum SIP_OUT ) const override;
diff --git a/src/core/geometry/qgscurvepolygon.cpp b/src/core/geometry/qgscurvepolygon.cpp
@@ -1264,7 +1264,7 @@ bool QgsCurvePolygon::deleteVertex( QgsVertexId vId )
   return success;
 }
 
-bool QgsCurvePolygon::deleteVertices( QList<QgsVertexId> positions )
+bool QgsCurvePolygon::deleteVertices( const QList<QgsVertexId> &positions )
 {
   QMap<int, QList<QgsVertexId >> ringVertices;
   for ( const QgsVertexId &pos : positions )
diff --git a/src/core/geometry/qgscurvepolygon.h b/src/core/geometry/qgscurvepolygon.h
@@ -365,7 +365,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
     bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) override;
     bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) override;
     bool deleteVertex( QgsVertexId position ) override;
-    bool deleteVertices( QList<QgsVertexId> positions ) override;
+    bool deleteVertices( const QList<QgsVertexId> &positions ) override;
 
     QgsCoordinateSequence coordinateSequence() const override;
     int nCoordinates() const override;
diff --git a/src/core/geometry/qgsgeometry.cpp b/src/core/geometry/qgsgeometry.cpp
@@ -677,16 +677,19 @@ bool QgsGeometry::deleteVertex( int atVertex )
   return d->geometry->deleteVertex( id );
 }
 
-bool QgsGeometry::deleteVertices( const QList<int> atVertices )
+bool QgsGeometry::deleteVertices( const QList<int> &atVertices )
 {
   if ( !d->geometry )
   {
     return false;
   }
 
-  //if it is a point, set the geometry to nullptr
+  // if it is a point, set the geometry to nullptr
   if ( QgsWkbTypes::flatType( d->geometry->wkbType() ) == Qgis::WkbType::Point )
   {
+    if ( atVertices.size() != 1 && !atVertices.contains( 0 ) )
+      return false;
+
     reset( nullptr );
     return true;
   }
@@ -695,13 +698,10 @@ bool QgsGeometry::deleteVertices( const QList<int> atVertices )
   for ( int vertex : atVertices )
   {
     QgsVertexId id;
-    if ( vertexIdFromVertexNr( vertex, id ) )
-    {
-      vertexIds.append( id );
-      continue;
-    }
+    if ( !vertexIdFromVertexNr( vertex, id ) )
+      return false;
 
-    return false;
+    vertexIds.append( id );
   }
 
   // create a copy of the original geometry to restore it in case of failure
diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -874,7 +874,7 @@ class CORE_EXPORT QgsGeometry
      * \see deleteVertex()
      * \since QGIS 4.0
      */
-    bool deleteVertices( const QList<int> atVertices );
+    bool deleteVertices( const QList<int> &atVertices );
 
     /**
      * Converts the vertex at the given position from/to circular
diff --git a/src/core/geometry/qgsgeometrycollection.cpp b/src/core/geometry/qgsgeometrycollection.cpp
@@ -679,7 +679,7 @@ bool QgsGeometryCollection::deleteVertex( QgsVertexId position )
   return success;
 }
 
-bool QgsGeometryCollection::deleteVertices( QList<QgsVertexId> positions )
+bool QgsGeometryCollection::deleteVertices( const QList<QgsVertexId> &positions )
 {
   QMap<int, QList<QgsVertexId >> partVertices;
   for ( QgsVertexId pos : positions )
diff --git a/src/core/geometry/qgsgeometrycollection.h b/src/core/geometry/qgsgeometrycollection.h
diff --git a/src/core/geometry/qgslinestring.cpp b/src/core/geometry/qgslinestring.cpp
diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h
diff --git a/src/core/geometry/qgspoint.cpp b/src/core/geometry/qgspoint.cpp
diff --git a/src/core/geometry/qgspoint.h b/src/core/geometry/qgspoint.h
diff --git a/src/core/geometry/qgspolyhedralsurface.cpp b/src/core/geometry/qgspolyhedralsurface.cpp
diff --git a/src/core/geometry/qgspolyhedralsurface.h b/src/core/geometry/qgspolyhedralsurface.h
diff --git a/src/core/geometry/qgstriangle.cpp b/src/core/geometry/qgstriangle.cpp
diff --git a/src/core/geometry/qgstriangle.h b/src/core/geometry/qgstriangle.h
diff --git a/src/core/geometry/qgstriangulatedsurface.cpp b/src/core/geometry/qgstriangulatedsurface.cpp
diff --git a/src/core/geometry/qgstriangulatedsurface.h b/src/core/geometry/qgstriangulatedsurface.h
