Rename UseSelection -> UseSelectionIfPresent, clarify docs

nyalldawson · nyalldawson · commit b067bd786ac4 · 2017-04-26T12:53:35.000+10:00
diff --git a/python/core/processing/qgsprocessingcontext.sip b/python/core/processing/qgsprocessingcontext.sip
@@ -28,7 +28,7 @@ class QgsProcessingContext
 
     enum Flag
     {
-      UseSelection,
+      UseSelectionIfPresent,
     };
     typedef QFlags<QgsProcessingContext::Flag> Flags;
 
diff --git a/python/plugins/processing/tests/ToolsTest.py b/python/plugins/processing/tests/ToolsTest.py
@@ -86,7 +86,7 @@ def testValues(self):
         self.assertEqual(res[2], [2, 1, 0, 2, 1, 0, 0, 0, 0])
 
         # test with selected features
-        context.setFlags(QgsProcessingContext.UseSelection)
+        context.setFlags(QgsProcessingContext.UseSelectionIfPresent)
         test_layer.selectByIds([2, 4, 6])
         res = vector.values(test_layer, context, 1)
         self.assertEqual(set(res[1]), set([5, 7, 3]))
@@ -111,7 +111,7 @@ def testUniqueValues(self):
         self.assertEqual(set(v), set([2, 1, 0]))
 
         # test with selected features
-        context.setFlags(QgsProcessingContext.UseSelection)
+        context.setFlags(QgsProcessingContext.UseSelectionIfPresent)
         test_layer.selectByIds([2, 4, 6])
         v = vector.uniqueValues(test_layer, context, 'id')
         self.assertEqual(len(v), len(set(v)))
diff --git a/python/plugins/processing/tools/general.py b/python/plugins/processing/tools/general.py
@@ -108,7 +108,7 @@ def createContext():
 
     use_selection = ProcessingConfig.getSetting(ProcessingConfig.USE_SELECTED)
     if use_selection:
-        context.setFlags(QgsProcessingContext.UseSelection)
+        context.setFlags(QgsProcessingContext.UseSelectionIfPresent)
 
     invalid_features_method = ProcessingConfig.getSetting(ProcessingConfig.FILTER_INVALID_GEOMETRIES)
     context.setInvalidGeometryCheck(invalid_features_method)
diff --git a/python/plugins/processing/tools/vector.py b/python/plugins/processing/tools/vector.py
@@ -94,7 +94,7 @@ def uniqueValues(layer, context, attribute):
     """
 
     fieldIndex = resolveFieldIndex(layer, attribute)
-    if context.flags() & QgsProcessingContext.UseSelection \
+    if context.flags() & QgsProcessingContext.UseSelectionIfPresent \
             and layer.selectedFeatureCount() > 0:
 
         # iterate through selected features
diff --git a/src/core/processing/qgsprocessingcontext.h b/src/core/processing/qgsprocessingcontext.h
@@ -41,7 +41,7 @@ class CORE_EXPORT QgsProcessingContext
     //! Flags that affect how processing algorithms are run
     enum Flag
     {
-      UseSelection = 1 << 0,  //!< Filter to selected features when running algorithms
+      UseSelectionIfPresent = 1 << 0,  //!< Filter to selected features when running algorithms (if a selection exists)
     };
     Q_DECLARE_FLAGS( Flags, Flag )
 
diff --git a/src/core/processing/qgsprocessingutils.cpp b/src/core/processing/qgsprocessingutils.cpp
@@ -175,7 +175,7 @@ QString QgsProcessingUtils::normalizeLayerSource( const QString &source )
 
 QgsFeatureIterator QgsProcessingUtils::getFeatures( QgsVectorLayer *layer, const QgsProcessingContext &context, const QgsFeatureRequest &request )
 {
-  bool useSelection = context.flags() & QgsProcessingContext::UseSelection && layer->selectedFeatureCount() > 0;
+  bool useSelection = context.flags() & QgsProcessingContext::UseSelectionIfPresent && layer->selectedFeatureCount() > 0;
 
   QgsFeatureRequest req( request );
   req.setInvalidGeometryCheck( context.invalidGeometryCheck() );
@@ -192,7 +192,7 @@ QgsFeatureIterator QgsProcessingUtils::getFeatures( QgsVectorLayer *layer, const
 
 long QgsProcessingUtils::featureCount( QgsVectorLayer *layer, const QgsProcessingContext &context )
 {
-  bool useSelection = context.flags() & QgsProcessingContext::UseSelection && layer->selectedFeatureCount() > 0;
+  bool useSelection = context.flags() & QgsProcessingContext::UseSelectionIfPresent && layer->selectedFeatureCount() > 0;
   if ( useSelection )
     return layer->selectedFeatureCount();
   else
diff --git a/tests/src/core/testqgsprocessing.cpp b/tests/src/core/testqgsprocessing.cpp
@@ -465,7 +465,7 @@ void TestQgsProcessing::features()
   QCOMPARE( QgsProcessingUtils::featureCount( layer, context ), 5L );
 
   // test with selected features
-  context.setFlags( QgsProcessingContext::UseSelection );
+  context.setFlags( QgsProcessingContext::UseSelectionIfPresent );
   layer->selectByIds( QgsFeatureIds() << 2 << 4 );
   ids = getIds( QgsProcessingUtils::getFeatures( layer, context ) );
   QCOMPARE( ids, QgsFeatureIds() << 2 << 4 );
@@ -479,7 +479,7 @@ void TestQgsProcessing::features()
   QCOMPARE( QgsProcessingUtils::featureCount( layer, context ), 5L );
 
   // using selected features, but no selection
-  context.setFlags( QgsProcessingContext::UseSelection );
+  context.setFlags( QgsProcessingContext::UseSelectionIfPresent );
   layer->removeSelection();
   ids = getIds( QgsProcessingUtils::getFeatures( layer, context ) );
   QCOMPARE( ids, QgsFeatureIds() << 1 << 2 << 3 << 4 << 5 );
@@ -496,7 +496,7 @@ void TestQgsProcessing::features()
 
 
   //test that feature request is honored when using selections
-  context.setFlags( QgsProcessingContext::UseSelection );
+  context.setFlags( QgsProcessingContext::UseSelectionIfPresent );
   layer->selectByIds( QgsFeatureIds() << 2 << 4 );
   ids = getIds( QgsProcessingUtils::getFeatures( layer, context, QgsFeatureRequest().setFlags( QgsFeatureRequest::NoGeometry ) ) );
   QCOMPARE( ids, QgsFeatureIds() << 2 << 4 );

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class QgsProcessingContext`
`28`	`28`
`29`	`29`	`enum Flag`
`30`	`30`	`{`
`31`		`- UseSelection,`
	`31`	`+ UseSelectionIfPresent,`
`32`	`32`	`};`
`33`	`33`	`typedef QFlags<QgsProcessingContext::Flag> Flags;`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ class CORE_EXPORT QgsProcessingContext`
`41`	`41`	`//! Flags that affect how processing algorithms are run`
`42`	`42`	`enum Flag`
`43`	`43`	`{`
`44`		`- UseSelection = 1 << 0, //!< Filter to selected features when running algorithms`
	`44`	`+ UseSelectionIfPresent = 1 << 0, //!< Filter to selected features when running algorithms (if a selection exists)`
`45`	`45`	`};`
`46`	`46`	`Q_DECLARE_FLAGS( Flags, Flag )`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ QString QgsProcessingUtils::normalizeLayerSource( const QString &source )`
`175`	`175`
`176`	`176`	`QgsFeatureIterator QgsProcessingUtils::getFeatures( QgsVectorLayer *layer, const QgsProcessingContext &context, const QgsFeatureRequest &request )`
`177`	`177`	`{`
`178`		`- bool useSelection = context.flags() & QgsProcessingContext::UseSelection && layer->selectedFeatureCount() > 0;`
	`178`	`+ bool useSelection = context.flags() & QgsProcessingContext::UseSelectionIfPresent && layer->selectedFeatureCount() > 0;`
`179`	`179`
`180`	`180`	`QgsFeatureRequest req( request );`
`181`	`181`	`req.setInvalidGeometryCheck( context.invalidGeometryCheck() );`
`@@ -192,7 +192,7 @@ QgsFeatureIterator QgsProcessingUtils::getFeatures( QgsVectorLayer *layer, const`
`192`	`192`
`193`	`193`	`long QgsProcessingUtils::featureCount( QgsVectorLayer *layer, const QgsProcessingContext &context )`
`194`	`194`	`{`
`195`		`- bool useSelection = context.flags() & QgsProcessingContext::UseSelection && layer->selectedFeatureCount() > 0;`
	`195`	`+ bool useSelection = context.flags() & QgsProcessingContext::UseSelectionIfPresent && layer->selectedFeatureCount() > 0;`
`196`	`196`	`if ( useSelection )`
`197`	`197`	`return layer->selectedFeatureCount();`
`198`	`198`	`else`