[expression] Show expected arg count if wrong args passed

NathanW2 · NathanW2 · commit 27714fc5a109 · 2018-05-01T08:20:11.000+10:00
diff --git a/src/core/qgsexpressionparser.yy b/src/core/qgsexpressionparser.yy
@@ -224,13 +224,26 @@ expression:
             delete $3;
             YYERROR;
           }
-          if ( QgsExpression::Functions()[fnIndex]->params() != -1
-               && !( QgsExpression::Functions()[fnIndex]->params() >= $3->count()
-               && QgsExpression::Functions()[fnIndex]->minParams() <= $3->count() ) )
+          QgsExpressionFunction* func = QgsExpression::Functions()[fnIndex];
+          if ( func->params() != -1
+               && !( func->params() >= $3->count()
+               && func->minParams() <= $3->count() ) )
           {
             QgsExpression::ParserError::ParserErrorType errorType = QgsExpression::ParserError::FunctionWrongArgs;
             parser_ctx->currentErrorType = errorType;
-            exp_error(&yyloc, parser_ctx, QString( "%1 function is called with wrong number of arguments" ).arg( QgsExpression::Functions()[fnIndex]->name() ).toLocal8Bit().constData() );
+            QString expectedMessage;
+            if (func->params() == func->minParams())
+            {
+               expectedMessage = QString("Expected %2" ).arg( func->params());
+            }
+            else
+            {
+               expectedMessage = QString("Expected between %2 and %4 max but got %3" ).arg( func->minParams(), func->params() );
+            }
+            exp_error(&yyloc, parser_ctx, QString( "%1 function is called with wrong number of arguments."
+                                                   "%2 but got %3" ).arg( QgsExpression::Functions()[fnIndex]->name() )
+                                                                             .arg( expectedMessage )
+                                                                             .arg( $3->count() ).toLocal8Bit().constData() );
             delete $3;
             YYERROR;
           }

-Original file line number
+Diff line change
             delete $3;
             YYERROR;
+          }
 -          if ( QgsExpression::Functions()[fnIndex]->params() != -1
 -               && !( QgsExpression::Functions()[fnIndex]->params() >= $3->count()
 -               && QgsExpression::Functions()[fnIndex]->minParams() <= $3->count() ) )
 +          QgsExpressionFunction* func = QgsExpression::Functions()[fnIndex];
 +          if ( func->params() != -1
 +               && !( func->params() >= $3->count()
 +               && func->minParams() <= $3->count() ) )
+          {
             QgsExpression::ParserError::ParserErrorType errorType = QgsExpression::ParserError::FunctionWrongArgs;
             parser_ctx->currentErrorType = errorType;
 -            exp_error(&yyloc, parser_ctx, QString( "%1 function is called with wrong number of arguments" ).arg( QgsExpression::Functions()[fnIndex]->name() ).toLocal8Bit().constData() );
 +            QString expectedMessage;
 +            if (func->params() == func->minParams())
 +            {
 +               expectedMessage = QString("Expected %2" ).arg( func->params());
 +            }
 +            else
 +            {
 +               expectedMessage = QString("Expected between %2 and %4 max but got %3" ).arg( func->minParams(), func->params() );Collapse commentComment on line R241
nyalldawson commented on Apr 30, 2018 
nyalldawson
on Apr 30, 2018
Collaborator
Should these messages be translated?
NathanW2 replied on Apr 30, 2018 
NathanW2
on Apr 30, 2018
MemberAuthor
Yeah I will be doing that in a different PR later.
…
On Tue, May 1, 2018 at 8:53 AM, Nyall Dawson ***@***.***> wrote:
 Should these messages be translated?

 —
 You are receiving this because you authored the thread.
 Reply to this email directly, view it on GitHub
 <27714fc#commitcomment-28799817>,
 or mute the thread
 <https://github.com/notifications/unsubscribe-auth/AAXS3EtUDbsK63VUIWLq4NrHSAu8SzZ6ks5tt5XlgaJpZM4TtVrD>
 .


Code has comments. Press enter to view.
 +            }
 +            exp_error(&yyloc, parser_ctx, QString( "%1 function is called with wrong number of arguments."
 +                                                   "%2 but got %3" ).arg( QgsExpression::Functions()[fnIndex]->name() )
 +                                                                             .arg( expectedMessage )
 +                                                                             .arg( $3->count() ).toLocal8Bit().constData() );
             delete $3;
             YYERROR;
+          }