Remove substitution map from QgsExpression::replaceExpressionText

nyalldawson · nyalldawson · commit a0360a6400ed · 2016-08-10T17:56:01.000+10:00
Since expression context variables should now be used instead. Also
remove all the deprecated methods which relied on this API.
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -128,6 +128,15 @@ corresponding counterparts in QgsUnitTypes should be used instead.</li>
 <li>fileMenu() has been removed, use projectMenu() instead.
 </ul>
 
+\subsection qgis_api_break_3_0_QgsActionManager QgsActionManager
+
+<ul>
+<li>doAction() no longer accepts a substitution map. Use expression context variables instead.</li>
+<li>The doAction() variant which takes a QgsFeature along has been removed. Use the expression context
+variant instead.</li>
+<li>expandAction() has been removed. Use QgsExpression::replaceExpressionText() instead.</li>
+</ul>
+
 \subsection qgis_api_break_3_0_QgsAtlasComposition QgsAtlasComposition
 
 <ul>
@@ -146,6 +155,15 @@ corresponding counterparts in QgsUnitTypes should be used instead.</li>
 <li>GenericDataSourceURI has been renamed to GenericDataSourceUri</li>
 </ul>
 
+\subsection qgis_api_break_3_0_QgsComposerLabel QgsComposerLabel
+
+<ul>
+<li>setExpressionContext() has been removed. Setup the composition using an atlas and with
+expression variables in the composer label item instead.</li>
+<li>setSubstitutions has been removed. Use expression context variables in the composer
+label item instead.</li>
+</ul>
+
 \subsection qgis_api_break_3_0_QgsComposerLegend QgsComposerLegend
 
 <ul>
@@ -313,6 +331,7 @@ version instead.</li>
 <li>QgsExpression::Function::func has been modified to use a QgsExpressionContext argument rather than a QgsFeature.</li>
 <li>The QgsExpression::Node::eval and prepare versions which take a QgsFeature has been removed, use the QgsExpressionContext versions instead.</li>
 <li>QgsExpression::Interval has been removed. Use QgsInterval instead.</li>
+<li>replaceExpressionText() no longer accepts a substitution map parameter. Use expression context variables instead.</li>
 </ul>
 
 \subsection qgis_api_break_3_0_QgsFeature QgsFeature
diff --git a/python/core/composer/qgscomposerlabel.sip b/python/core/composer/qgscomposerlabel.sip
@@ -28,16 +28,6 @@ class QgsComposerLabel : QgsComposerItem
     /** Returns the text as it appears on screen (with replaced data field) */
     QString displayText() const;
 
-    /** Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions.
-      * @deprecated use atlas features and setSubstitutions() instead
-      */
-    void setExpressionContext( QgsFeature* feature, QgsVectorLayer* layer, const QMap<QString, QVariant>& substitutions = QMap<QString, QVariant>() ) /Deprecated/;
-
-    /** Sets the list of local variable substitutions for evaluating expressions in label text.
-     * @note added in QGIS 2.12
-     */
-    void setSubstitutions( const QMap<QString, QVariant>& substitutions = QMap<QString, QVariant>() );
-
     QFont font() const;
     void setFont( const QFont& f );
     /** Accessor for the vertical alignment of the label
diff --git a/python/core/qgsactionmanager.sip b/python/core/qgsactionmanager.sip
@@ -75,24 +75,10 @@ class QgsActionManager
      * @param index action index
      * @param feature feature to run action for
      * @param context expression context to evalute expressions under
-     * @param substitutionMap deprecated - kept for compatibility with projects, will be removed for 3.0
      */
-    // TODO QGIS 3.0 remove substition map - force use of expression variables
     void doAction( int index,
                    const QgsFeature& feature,
-                   const QgsExpressionContext& context,
-                   const QMap<QString, QVariant> *substitutionMap = nullptr );
-
-
-    /** Does the action using the expression builder to expand it
-     *  and getting values from the passed feature attribute map.
-     *  substitutionMap is used to pass custom substitutions, to replace
-     *  each key in the map with the associated value
-     *  @note available in python bindings as doActionFeatureWithSubstitution
-     */
-    void doAction( int index,
-                   const QgsFeature &feat,
-                   const QMap<QString, QVariant> *substitutionMap ) /PyName=doActionFeatureWithSubstitution/;
+                   const QgsExpressionContext& context );
 
     //! Removes all actions
     void clearActions();
@@ -103,26 +89,6 @@ class QgsActionManager
     //! Return the layer
     QgsVectorLayer* layer() const;
 
-    /** Expands the given action, replacing all %'s with the value as
-     *  given.
-     * @deprecated use QgsExpression::replaceExpressionText() instead
-     */
-    QString expandAction( QString action, const QMap<int, QVariant> &attributes, uint defaultValueIndex ) /Deprecated/;
-
-    /** Expands the given action using the expression builder
-     *  This function currently replaces each expression between [% and %]
-     *  placeholders in the action with the result of its evaluation on
-     *  the feature passed as argument.
-     *
-     *  Additional substitutions can be passed through the substitutionMap
-     *  parameter
-     *  @deprecated use QgsExpression::replaceExpressionText() instead
-     */
-    QString expandAction( const QString& action,
-                          QgsFeature &feat,
-                          const QMap<QString, QVariant> *substitutionMap = 0 ) /Deprecated/;
-
-
     //! Writes the actions out in XML format
     bool writeXml( QDomNode& layer_node, QDomDocument& doc ) const;
 
diff --git a/python/core/qgsexpression.sip b/python/core/qgsexpression.sip
@@ -140,13 +140,11 @@ class QgsExpression
      * Additional substitutions can be passed through the substitutionMap parameter
      * @param action
      * @param context expression context
-     * @param substitutionMap
      * @param distanceArea optional QgsDistanceArea. If specified, the QgsDistanceArea is used for distance
      * and area conversion
      * @note added in QGIS 2.12
      */
     static QString replaceExpressionText( const QString &action, const QgsExpressionContext* context,
-                                          const QMap<QString, QVariant> *substitutionMap = 0,
                                           const QgsDistanceArea* distanceArea = 0 );
 
     /** Attempts to evaluate a text string as an expression to a resultant double
diff --git a/src/app/qgsmaptoolfeatureaction.cpp b/src/app/qgsmaptoolfeatureaction.cpp
@@ -138,14 +138,6 @@ bool QgsMapToolFeatureAction::doAction( QgsVectorLayer *layer, int x, int y )
     if ( layer->actions()->defaultAction() >= 0 )
     {
       // define custom substitutions: layer id and clicked coords
-
-      // TODO QGIS 3.0 - remove these deprecated global expression variables!
-      QMap<QString, QVariant> substitutionMap;
-      substitutionMap.insert( "$layerid", layer->id() );
-      point = toLayerCoordinates( layer, point );
-      substitutionMap.insert( "$clickx", point.x() );
-      substitutionMap.insert( "$clicky", point.y() );
-
       QgsExpressionContext context;
       context << QgsExpressionContextUtils::globalScope()
       << QgsExpressionContextUtils::projectScope()
@@ -156,7 +148,7 @@ bool QgsMapToolFeatureAction::doAction( QgsVectorLayer *layer, int x, int y )
       context << actionScope;
 
       int actionIdx = layer->actions()->defaultAction();
-      layer->actions()->doAction( actionIdx, feat, context, &substitutionMap );
+      layer->actions()->doAction( actionIdx, feat, context );
     }
     else
     {
diff --git a/src/core/composer/qgscomposerhtml.cpp b/src/core/composer/qgscomposerhtml.cpp
@@ -179,7 +179,7 @@ void QgsComposerHtml::loadHtml( const bool useCache, const QgsExpressionContext
   //evaluate expressions
   if ( mEvaluateExpressions )
   {
-    loadedHtml = QgsExpression::replaceExpressionText( loadedHtml, evalContext, nullptr, mDistanceArea );
+    loadedHtml = QgsExpression::replaceExpressionText( loadedHtml, evalContext, mDistanceArea );
   }
 
   mLoaded = false;
diff --git a/src/core/composer/qgscomposerlabel.cpp b/src/core/composer/qgscomposerlabel.cpp
@@ -240,38 +240,6 @@ void QgsComposerLabel::setHtmlState( int state )
   }
 }
 
-void QgsComposerLabel::setExpressionContext( QgsFeature *feature, QgsVectorLayer* layer, const QMap<QString, QVariant>& substitutions )
-{
-  mExpressionFeature.reset( feature ? new QgsFeature( *feature ) : nullptr );
-  mExpressionLayer = layer;
-  mSubstitutions = substitutions;
-
-  //setup distance area conversion
-  if ( layer )
-  {
-    mDistanceArea->setSourceCrs( layer->crs().srsid() );
-  }
-  else if ( mComposition )
-  {
-    //set to composition's mapsettings' crs
-    mDistanceArea->setSourceCrs( mComposition->mapSettings().destinationCrs().srsid() );
-  }
-  if ( mComposition )
-  {
-    mDistanceArea->setEllipsoidalMode( mComposition->mapSettings().hasCrsTransformEnabled() );
-  }
-  mDistanceArea->setEllipsoid( QgsProject::instance()->readEntry( "Measure", "/Ellipsoid", GEO_NONE ) );
-  contentChanged();
-
-  // Force label to redraw -- fixes label printing for labels with blend modes when used with atlas
-  update();
-}
-
-void QgsComposerLabel::setSubstitutions( const QMap<QString, QVariant>& substitutions )
-{
-  mSubstitutions = substitutions;
-}
-
 void QgsComposerLabel::refreshExpressionContext()
 {
   mExpressionLayer = nullptr;
@@ -307,7 +275,6 @@ QString QgsComposerLabel::displayText() const
 {
   QString displayText = mText;
   replaceDateText( displayText );
-  QMap<QString, QVariant> subs = mSubstitutions;
 
   QScopedPointer<QgsExpressionContext> context( createExpressionContext() );
   //overwrite layer/feature if they have been set via setExpressionContext
@@ -317,7 +284,7 @@ QString QgsComposerLabel::displayText() const
   if ( mExpressionLayer )
     context->setFields( mExpressionLayer->fields() );
 
-  return QgsExpression::replaceExpressionText( displayText, context.data(), &subs, mDistanceArea );
+  return QgsExpression::replaceExpressionText( displayText, context.data(), mDistanceArea );
 }
 
 void QgsComposerLabel::replaceDateText( QString& text ) const
diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h
@@ -53,16 +53,6 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
     /** Returns the text as it appears on screen (with replaced data field) */
     QString displayText() const;
 
-    /** Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions.
-      * @deprecated use atlas features and setSubstitutions() instead
-      */
-    Q_DECL_DEPRECATED void setExpressionContext( QgsFeature* feature, QgsVectorLayer* layer, const QMap<QString, QVariant>& substitutions = ( QMap<QString, QVariant>() ) );
-
-    /** Sets the list of local variable substitutions for evaluating expressions in label text.
-     * @note added in QGIS 2.12
-     */
-    void setSubstitutions( const QMap<QString, QVariant>& substitutions = ( QMap<QString, QVariant>() ) );
-
     QFont font() const;
     void setFont( const QFont& f );
     /** Accessor for the vertical alignment of the label
@@ -213,7 +203,6 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
 
     QScopedPointer<QgsFeature> mExpressionFeature;
     QgsVectorLayer* mExpressionLayer;
-    QMap<QString, QVariant> mSubstitutions;
     QgsDistanceArea* mDistanceArea;
 
     QgsWebPage* mWebPage;
diff --git a/src/core/qgsactionmanager.cpp b/src/core/qgsactionmanager.cpp
diff --git a/src/core/qgsactionmanager.h b/src/core/qgsactionmanager.h
diff --git a/src/core/qgsexpression.cpp b/src/core/qgsexpression.cpp
diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ void QgsComposerHtml::loadHtml( const bool useCache, const QgsExpressionContext`
`179`	`179`	`//evaluate expressions`
`180`	`180`	`if ( mEvaluateExpressions )`
`181`	`181`	`{`
`182`		`- loadedHtml = QgsExpression::replaceExpressionText( loadedHtml, evalContext, nullptr, mDistanceArea );`
	`182`	`+ loadedHtml = QgsExpression::replaceExpressionText( loadedHtml, evalContext, mDistanceArea );`
`183`	`183`	`}`
`184`	`184`
`185`	`185`	`mLoaded = false;`