Rename set_variable to with_variable

m-kuhn · m-kuhn · commit 10dc0d5da9a3 · 2017-07-07T13:00:47.000+02:00
diff --git a/resources/function_help/json/with_variable b/resources/function_help/json/with_variable
@@ -0,0 +1,11 @@
+{
+  "name": "with_variable",
+  "type": "function",
+  "description": "This function sets a variable for any expression code that will be provided as 3rd argument. This is only useful for complicated expressions, where the same calculated value needs to be used in different places.",
+  "arguments": [
+                 {"arg":"name","description":"the name of the variable to set"},
+                 {"arg":"value","description":"the value to set"},
+                 {"arg":"node","description":"the expression for which the variable will be available"}
+               ],
+  "examples": [ { "expression":"with_variable('my_sum', 1 + 2 + 3, @my_sum * 2 + @my_sum * 5)", "returns":"42"}]
+}
diff --git a/src/core/expression/qgsexpressionfunction.cpp b/src/core/expression/qgsexpressionfunction.cpp
@@ -4230,7 +4230,7 @@ const QList<QgsExpressionFunction *> &QgsExpression::Functions()
 
     sFunctions
         << new QgsStaticExpressionFunction( QStringLiteral( "env" ), 1, fcnEnvVar, QStringLiteral( "General" ), QString() )
-        << new QgsSetVariableExpressionFunction()
+        << new QgsWithVariableExpressionFunction()
         << new QgsStaticExpressionFunction( QStringLiteral( "attribute" ), 2, fcnAttribute, QStringLiteral( "Record" ), QString(), false, QSet<QString>() << QgsFeatureRequest::ALL_ATTRIBUTES )
 
         // functions for arrays
@@ -4276,13 +4276,13 @@ const QList<QgsExpressionFunction *> &QgsExpression::Functions()
   return sFunctions;
 }
 
-QgsSetVariableExpressionFunction::QgsSetVariableExpressionFunction()
-  : QgsExpressionFunction( "set_variable", 3, QCoreApplication::tr( "General" ), "help text TODODOODO" )
+QgsWithVariableExpressionFunction::QgsWithVariableExpressionFunction()
+  : QgsExpressionFunction( QStringLiteral("with_variable"), 3, QCoreApplication::tr( "General" ) )
 {
 
 }
 
-bool QgsSetVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const
+bool QgsWithVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const
 {
   bool isStatic = false;
 
@@ -4310,7 +4310,7 @@ bool QgsSetVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction
   return false;
 }
 
-QVariant QgsSetVariableExpressionFunction::run( QgsExpressionNode::NodeList *args, const QgsExpressionContext *context, QgsExpression *parent )
+QVariant QgsWithVariableExpressionFunction::run( QgsExpressionNode::NodeList *args, const QgsExpressionContext *context, QgsExpression *parent )
 {
   QVariant result;
 
@@ -4332,7 +4332,7 @@ QVariant QgsSetVariableExpressionFunction::run( QgsExpressionNode::NodeList *arg
   return result;
 }
 
-QVariant QgsSetVariableExpressionFunction::func( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent )
+QVariant QgsWithVariableExpressionFunction::func( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent )
 {
   // This is a dummy function, all the real handling is in run
   Q_UNUSED( values )
@@ -4343,7 +4343,7 @@ QVariant QgsSetVariableExpressionFunction::func( const QVariantList &values, con
   return QVariant();
 }
 
-bool QgsSetVariableExpressionFunction::prepare( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const
+bool QgsWithVariableExpressionFunction::prepare( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const
 {
   QgsExpressionNode::NodeList *args = node->args();
 
diff --git a/src/core/expression/qgsexpressionfunction.h b/src/core/expression/qgsexpressionfunction.h
@@ -455,10 +455,10 @@ class QgsStaticExpressionFunction : public QgsExpressionFunction
     bool mIsStatic = false;
 };
 
-class QgsSetVariableExpressionFunction : public QgsExpressionFunction
+class QgsWithVariableExpressionFunction : public QgsExpressionFunction
 {
   public:
-    QgsSetVariableExpressionFunction();
+    QgsWithVariableExpressionFunction();
 
     bool isStatic( const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context ) const override;
 

Original file line number	Diff line number	Diff line change
`@@ -4230,7 +4230,7 @@ const QList<QgsExpressionFunction *> &QgsExpression::Functions()`
`4230`	`4230`
`4231`	`4231`	`sFunctions`
`4232`	`4232`	`<< new QgsStaticExpressionFunction( QStringLiteral( "env" ), 1, fcnEnvVar, QStringLiteral( "General" ), QString() )`
`4233`		`- << new QgsSetVariableExpressionFunction()`
	`4233`	`+ << new QgsWithVariableExpressionFunction()`
`4234`	`4234`	`<< new QgsStaticExpressionFunction( QStringLiteral( "attribute" ), 2, fcnAttribute, QStringLiteral( "Record" ), QString(), false, QSet<QString>() << QgsFeatureRequest::ALL_ATTRIBUTES )`
`4235`	`4235`
`4236`	`4236`	`// functions for arrays`
`@@ -4276,13 +4276,13 @@ const QList<QgsExpressionFunction *> &QgsExpression::Functions()`
`4276`	`4276`	`return sFunctions;`
`4277`	`4277`	`}`
`4278`	`4278`
`4279`		`-QgsSetVariableExpressionFunction::QgsSetVariableExpressionFunction()`
`4280`		`- : QgsExpressionFunction( "set_variable", 3, QCoreApplication::tr( "General" ), "help text TODODOODO" )`
	`4279`	`+QgsWithVariableExpressionFunction::QgsWithVariableExpressionFunction()`
	`4280`	`+ : QgsExpressionFunction( QStringLiteral("with_variable"), 3, QCoreApplication::tr( "General" ) )`
`4281`	`4281`	`{`
`4282`	`4282`
`4283`	`4283`	`}`
`4284`	`4284`
`4285`		`-bool QgsSetVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction node, QgsExpression parent, const QgsExpressionContext *context ) const`
	`4285`	`+bool QgsWithVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction node, QgsExpression parent, const QgsExpressionContext *context ) const`
`4286`	`4286`	`{`
`4287`	`4287`	`bool isStatic = false;`
`4288`	`4288`
`@@ -4310,7 +4310,7 @@ bool QgsSetVariableExpressionFunction::isStatic( const QgsExpressionNodeFunction`
`4310`	`4310`	`return false;`
`4311`	`4311`	`}`
`4312`	`4312`
`4313`		`-QVariant QgsSetVariableExpressionFunction::run( QgsExpressionNode::NodeList args, const QgsExpressionContext context, QgsExpression *parent )`
	`4313`	`+QVariant QgsWithVariableExpressionFunction::run( QgsExpressionNode::NodeList args, const QgsExpressionContext context, QgsExpression *parent )`
`4314`	`4314`	`{`
`4315`	`4315`	`QVariant result;`
`4316`	`4316`
`@@ -4332,7 +4332,7 @@ QVariant QgsSetVariableExpressionFunction::run( QgsExpressionNode::NodeList *arg`
`4332`	`4332`	`return result;`
`4333`	`4333`	`}`
`4334`	`4334`
`4335`		`-QVariant QgsSetVariableExpressionFunction::func( const QVariantList &values, const QgsExpressionContext context, QgsExpression parent )`
	`4335`	`+QVariant QgsWithVariableExpressionFunction::func( const QVariantList &values, const QgsExpressionContext context, QgsExpression parent )`
`4336`	`4336`	`{`
`4337`	`4337`	`// This is a dummy function, all the real handling is in run`
`4338`	`4338`	`Q_UNUSED( values )`
`@@ -4343,7 +4343,7 @@ QVariant QgsSetVariableExpressionFunction::func( const QVariantList &values, con`
`4343`	`4343`	`return QVariant();`
`4344`	`4344`	`}`
`4345`	`4345`
`4346`		`-bool QgsSetVariableExpressionFunction::prepare( const QgsExpressionNodeFunction node, QgsExpression parent, const QgsExpressionContext *context ) const`
	`4346`	`+bool QgsWithVariableExpressionFunction::prepare( const QgsExpressionNodeFunction node, QgsExpression parent, const QgsExpressionContext *context ) const`
`4347`	`4347`	`{`
`4348`	`4348`	`QgsExpressionNode::NodeList *args = node->args();`
`4349`	`4349`