/
qgsexpression.h
1056 lines (882 loc) · 38.1 KB
/
qgsexpression.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
qgsexpression.h
-------------------
begin : August 2011
copyright : (C) 2011 Martin Dobias
email : wonder.sk at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSEXPRESSION_H
#define QGSEXPRESSION_H
#include <QMetaType>
#include <QStringList>
#include <QVariant>
#include <QList>
#include <QDomDocument>
#include <QCoreApplication>
#include "qgis.h"
class QgsFeature;
class QgsGeometry;
class QgsOgcUtils;
class QgsVectorLayer;
class QgsVectorDataProvider;
class QgsField;
class QgsFields;
class QgsDistanceArea;
class QDomElement;
class QgsExpressionContext;
/**
Class for parsing and evaluation of expressions (formerly called "search strings").
The expressions try to follow both syntax and semantics of SQL expressions.
Usage:
\code{.cpp}
QgsExpression exp("gid*2 > 10 and type not in ('D','F'));
if (exp.hasParserError())
{
// show error message with parserErrorString() and exit
}
QVariant result = exp.evaluate(feature, fields);
if (exp.hasEvalError())
{
// show error message with evalErrorString()
}
else
{
// examine the result
}
\endcode
Possible QVariant value types:
- invalid (null)
- int
- double
- string
- geometry
Similarly to SQL, this class supports three-value logic: true/false/unknown.
Unknown value may be a result of operations with missing data (NULL). Please note
that NULL is different value than zero or an empty string. For example
3 > NULL returns unknown.
There is no special (three-value) 'boolean' type: true/false is represented as
1/0 integer, unknown value is represented the same way as NULL values: invalid QVariant.
For better performance with many evaluations you may first call prepare(fields) function
to find out indices of columns and then repeatedly call evaluate(feature).
Type conversion: operators and functions that expect arguments to be of particular
type automatically convert the arguments to that type, e.g. sin('2.1') will convert
the argument to a double, length(123) will first convert the number to a string.
Explicit conversion can be achieved with toint, toreal, tostring functions.
If implicit or explicit conversion is invalid, the evaluation returns an error.
Comparison operators do numeric comparison in case both operators are numeric (int/double)
or they can be converted to numeric types.
Arithmetic operators do integer arithmetics if both operands are integer. That is
2+2 yields integer 4, but 2.0+2 returns real number 4.0. There are also two versions of
division and modulo operators: 1.0/2 returns 0.5 while 1/2 returns 0. */
Q_NOWARN_DEPRECATED_PUSH
class CORE_EXPORT QgsExpression
{
Q_DECLARE_TR_FUNCTIONS( QgsExpression )
public:
QgsExpression( const QString& expr );
~QgsExpression();
//! Returns true if an error occurred when parsing the input expression
bool hasParserError() const { return !mParserErrorString.isNull(); }
//! Returns parser error
QString parserErrorString() const { return mParserErrorString; }
class Node;
//! Returns root node of the expression. Root node is null is parsing has failed
const Node* rootNode() const { return mRootNode; }
//! Get the expression ready for evaluation - find out column indexes.
Q_DECL_DEPRECATED bool prepare( const QgsFields &fields );
/** Get the expression ready for evaluation - find out column indexes.
* @param context context for preparing expression
* @note added in QGIS 2.12
*/
bool prepare( const QgsExpressionContext *context );
/**
* Get list of columns referenced by the expression.
* @note if the returned list contains the QgsFeatureRequest::AllAttributes constant then
* all attributes from the layer are required for evaluation of the expression.
* QgsFeatureRequest::setSubsetOfAttributes automatically handles this case.
*
* TODO QGIS3: Return QSet<QString>
*/
QStringList referencedColumns() const;
//! Returns true if the expression uses feature geometry for some computation
bool needsGeometry() const;
// evaluation
//! Evaluate the feature and return the result
//! @note prepare() should be called before calling this method
Q_DECL_DEPRECATED QVariant evaluate( const QgsFeature* f );
//! Evaluate the feature and return the result
//! @note prepare() should be called before calling this method
//! @note available in python bindings as evaluatePrepared
Q_DECL_DEPRECATED QVariant evaluate( const QgsFeature& f );
//! Evaluate the feature and return the result
//! @note this method does not expect that prepare() has been called on this instance
Q_DECL_DEPRECATED QVariant evaluate( const QgsFeature* f, const QgsFields& fields );
//! Evaluate the feature and return the result
//! @note this method does not expect that prepare() has been called on this instance
//! @note not available in python bindings
Q_DECL_DEPRECATED QVariant evaluate( const QgsFeature& f, const QgsFields& fields );
/** Evaluate the feature and return the result.
* @note this method does not expect that prepare() has been called on this instance
* @note added in QGIS 2.12
*/
QVariant evaluate();
/** Evaluate the expression against the specified context and return the result.
* @param context context for evaluating expression
* @note prepare() should be called before calling this method.
* @note added in QGIS 2.12
*/
QVariant evaluate( const QgsExpressionContext* context );
//! Returns true if an error occurred when evaluating last input
bool hasEvalError() const { return !mEvalErrorString.isNull(); }
//! Returns evaluation error
QString evalErrorString() const { return mEvalErrorString; }
//! Set evaluation error (used internally by evaluation functions)
void setEvalErrorString( const QString& str ) { mEvalErrorString = str; }
//! Set the number for $rownum special column
Q_DECL_DEPRECATED void setCurrentRowNumber( int rowNumber ) { mRowNumber = rowNumber; }
//! Return the number used for $rownum special column
Q_DECL_DEPRECATED int currentRowNumber() { return mRowNumber; }
//TODO QGIS 3.0: make the following methods private. They are still required for replaceExpressionText
//but should not be publicly used
/** Assign a special column
* @deprecated use global or project QgsExpressionContext variables instead
*/
Q_DECL_DEPRECATED static void setSpecialColumn( const QString& name, const QVariant& value );
/** Unset a special column
* @deprecated use global or project QgsExpressionContext variables instead
*/
Q_DECL_DEPRECATED static void unsetSpecialColumn( const QString& name );
/** Return the value of the given special column or a null QVariant if undefined
* @deprecated use global or project QgsExpressionContext variables instead
*/
Q_DECL_DEPRECATED static QVariant specialColumn( const QString& name );
/** Check whether a special column exists
* @note added in 2.2
*/
static bool hasSpecialColumn( const QString& name );
/** Checks whether an expression consists only of a single field reference
* @note added in 2.9
*/
bool isField() const { return rootNode() && dynamic_cast<const NodeColumnRef*>( rootNode() ) ;}
Q_DECL_DEPRECATED static bool isValid( const QString& text, const QgsFields& fields, QString &errorMessage );
/** Tests whether a string is a valid expression.
* @param text string to test
* @param context optional expression context
* @param errorMessage will be filled with any error message from the validation
* @returns true if string is a valid expression
* @note added in QGIS 2.12
*/
static bool isValid( const QString& text, const QgsExpressionContext* context, QString &errorMessage );
void setScale( double scale ) { mScale = scale; }
double scale() { return mScale; }
//! Alias for dump()
const QString expression() const
{
if ( !mExp.isNull() )
return mExp;
else
return dump();
}
//! Return the expression string that represents this QgsExpression.
QString dump() const;
//! Return calculator used for distance and area calculations
//! (used by internal functions)
QgsDistanceArea *geomCalculator() { initGeomCalculator(); return mCalc; }
//! Sets the geometry calculator used in evaluation of expressions,
// instead of the default.
void setGeomCalculator( const QgsDistanceArea &calc );
/** This function currently replaces each expression between [% and %]
in the string with the result of its evaluation on the feature
passed as argument.
Additional substitutions can be passed through the substitutionMap
parameter
@param action
@param feat
@param layer
@param substitutionMap
@param distanceArea optional QgsDistanceArea. If specified, the QgsDistanceArea is used for distance
and area conversion
*/
Q_DECL_DEPRECATED static QString replaceExpressionText( const QString &action, const QgsFeature *feat,
QgsVectorLayer *layer,
const QMap<QString, QVariant> *substitutionMap = 0,
const QgsDistanceArea* distanceArea = 0
);
/** This function replaces each expression between [% and %]
in the string with the result of its evaluation with the specified context
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
* value.
* @param text text to evaluate as expression
* @param fallbackValue value to return if text can not be evaluated as a double
* @returns evaluated double value, or fallback value
* @note added in QGIS 2.7
* @note this method is inefficient for bulk evaluation of expressions, it is intended
* for one-off evaluations only.
*/
static double evaluateToDouble( const QString& text, const double fallbackValue );
/**
* @brief list of unary operators
* @note if any change is made here, the definition of QgsExpression::UnaryOperatorText[] must be adapted.
*/
enum UnaryOperator
{
uoNot,
uoMinus,
};
/**
* @brief list of binary operators
* @note if any change is made here, the definition of QgsExpression::BinaryOperatorText[] must be adapted.
*/
enum BinaryOperator
{
// logical
boOr,
boAnd,
// comparison
boEQ, // =
boNE, // <>
boLE, // <=
boGE, // >=
boLT, // <
boGT, // >
boRegexp,
boLike,
boNotLike,
boILike,
boNotILike,
boIs,
boIsNot,
// math
boPlus,
boMinus,
boMul,
boDiv,
boIntDiv,
boMod,
boPow,
// strings
boConcat,
};
enum SpatialOperator
{
soBbox,
soIntersects,
soContains,
soCrosses,
soEquals,
soDisjoint,
soOverlaps,
soTouches,
soWithin,
};
static const char* BinaryOperatorText[];
static const char* UnaryOperatorText[];
typedef QVariant( *FcnEval )( const QVariantList& values, const QgsFeature* f, QgsExpression* parent );
/** Function definition for evaluation against an expression context
*/
typedef QVariant( *FcnEvalContext )( const QVariantList& values, const QgsExpressionContext* context, QgsExpression* parent );
/**
* A abstract base class for defining QgsExpression functions.
*/
class CORE_EXPORT Function
{
public:
Function( const QString& fnname,
int params,
const QString& group,
const QString& helpText = QString(),
bool usesGeometry = false,
const QStringList& referencedColumns = QStringList(),
bool lazyEval = false,
bool handlesNull = false,
bool isContextual = false )
: mName( fnname )
, mParams( params )
, mUsesGeometry( usesGeometry )
, mGroup( group )
, mHelpText( helpText )
, mReferencedColumns( referencedColumns )
, mLazyEval( lazyEval )
, mHandlesNull( handlesNull )
, mIsContextual( isContextual )
{}
virtual ~Function() {}
/** The name of the function. */
QString name() { return mName; }
/** The number of parameters this function takes. */
int params() { return mParams; }
/** Does this function use a geometry object. */
bool usesgeometry() { return mUsesGeometry; }
/** Returns a list of possible aliases for the function. These include
* other permissible names for the function, eg deprecated names.
* @return list of known aliases
* @note added in QGIS 2.9
*/
virtual QStringList aliases() const { return QStringList(); }
/** True if this function should use lazy evaluation. Lazy evaluation functions take QgsExpression::Node objects
* rather than the node results when called. You can use node->eval(parent, feature) to evaluate the node and return the result
* Functions are non lazy default and will be given the node return value when called **/
bool lazyEval() { return mLazyEval; }
virtual QStringList referencedColumns() const { return mReferencedColumns; }
/** Returns whether the function is only available if provided by a QgsExpressionContext object.
* @note added in QGIS 2.12
*/
bool isContextual() const { return mIsContextual; }
/** The group the function belongs to. */
QString group() { return mGroup; }
/** The help text for the function. */
const QString helptext() { return mHelpText.isEmpty() ? QgsExpression::helptext( mName ) : mHelpText; }
Q_DECL_DEPRECATED virtual QVariant func( const QVariantList&, const QgsFeature*, QgsExpression* );
/** Returns result of evaluating the function.
* @param values list of values passed to the function
* @param context context expression is being evaluated against
* @param parent parent expression
* @returns result of function
* @note named funcV2 in Python bindings. Will be renamed to func to replace deprecated method in QGIS 3.0.
*/
//TODO QGIS 3.0 - rename python method
virtual QVariant func( const QVariantList& values, const QgsExpressionContext* context, QgsExpression* parent );
bool operator==( const Function& other ) const
{
if ( QString::compare( mName, other.mName, Qt::CaseInsensitive ) == 0 )
return true;
return false;
}
virtual bool handlesNull() const { return mHandlesNull; }
private:
QString mName;
int mParams;
bool mUsesGeometry;
QString mGroup;
QString mHelpText;
QStringList mReferencedColumns;
bool mLazyEval;
bool mHandlesNull;
bool mIsContextual; //if true function is only available through an expression context
};
class StaticFunction : public Function
{
public:
Q_DECL_DEPRECATED StaticFunction( const QString& fnname,
int params,
FcnEval fcn,
const QString& group,
const QString& helpText = QString(),
bool usesGeometry = false,
const QStringList& referencedColumns = QStringList(),
bool lazyEval = false,
const QStringList& aliases = QStringList(),
bool handlesNull = false )
: Function( fnname, params, group, helpText, usesGeometry, referencedColumns, lazyEval, handlesNull )
, mFnc( fcn )
, mContextFnc( 0 )
, mAliases( aliases )
{}
virtual ~StaticFunction() {}
/** Static function for evaluation against a QgsExpressionContext
*/
StaticFunction( const QString& fnname,
int params,
FcnEvalContext fcn,
const QString& group,
const QString& helpText = QString(),
bool usesGeometry = false,
const QStringList& referencedColumns = QStringList(),
bool lazyEval = false,
const QStringList& aliases = QStringList(),
bool handlesNull = false )
: Function( fnname, params, group, helpText, usesGeometry, referencedColumns, lazyEval, handlesNull )
, mFnc( 0 )
, mContextFnc( fcn )
, mAliases( aliases )
{}
Q_DECL_DEPRECATED virtual QVariant func( const QVariantList& values, const QgsFeature* f, QgsExpression* parent ) override;
/** Returns result of evaluating the function.
* @param values list of values passed to the function
* @param context context expression is being evaluated against
* @param parent parent expression
* @returns result of function
*/
virtual QVariant func( const QVariantList& values, const QgsExpressionContext* context, QgsExpression* parent ) override
{
return mContextFnc ? mContextFnc( values, context, parent ) : QVariant();
}
virtual QStringList aliases() const override { return mAliases; }
private:
FcnEval mFnc;
FcnEvalContext mContextFnc;
QStringList mAliases;
};
static QList<Function*> gmFunctions;
static const QList<Function*>& Functions();
static QStringList gmBuiltinFunctions;
static const QStringList& BuiltinFunctions();
/** Registers a function to the expression engine. This is required to allow expressions to utilise the function.
* @param function function to register
* @param transferOwnership set to true to transfer ownership of function to expression engine
* @returns true on successful registration
* @see unregisterFunction
*/
static bool registerFunction( Function* function, bool transferOwnership = false );
/** Unregisters a function from the expression engine. The function will no longer be usable in expressions.
* @param name function name
* @see registerFunction
*/
static bool unregisterFunction( const QString& name );
//! List of functions owned by the expression engine
static QList<Function*> gmOwnedFunctions;
/** Deletes all registered functions whose ownership have been transferred to the expression engine.
* @note added in QGIS 2.12
*/
static void cleanRegisteredFunctions();
// tells whether the identifier is a name of existing function
static bool isFunctionName( const QString& name );
// return index of the function in Functions array
static int functionIndex( const QString& name );
/** Returns the number of functions defined in the parser
* @return The number of function defined in the parser.
*/
static int functionCount();
/**
* Returns a list of special Column definitions
*/
static QList<Function*> specialColumns();
/** Returns a quoted column reference (in double quotes)
* @see quotedString()
* @see quotedValue()
*/
static QString quotedColumnRef( QString name );
/** Returns a quoted version of a string (in single quotes)
* @see quotedValue()
* @see quotedColumnRef()
*/
static QString quotedString( QString text );
/** Returns a string representation of a literal value, including appropriate
* quotations where required.
* @param value value to convert to a string representation
* @note added in QGIS 2.14
* @see quotedString()
* @see quotedColumnRef()
*/
static QString quotedValue( const QVariant& value );
/** Returns a string representation of a literal value, including appropriate
* quotations where required.
* @param value value to convert to a string representation
* @param type value type
* @note added in QGIS 2.14
* @see quotedString()
* @see quotedColumnRef()
*/
static QString quotedValue( const QVariant& value, QVariant::Type type );
//////
class Visitor; // visitor interface is defined below
enum NodeType
{
ntUnaryOperator,
ntBinaryOperator,
ntInOperator,
ntFunction,
ntLiteral,
ntColumnRef,
ntCondition
};
class CORE_EXPORT Node
{
public:
virtual ~Node() {}
/**
* Abstract virtual that returns the type of this node.
*
* @return The type of this node
*/
virtual NodeType nodeType() const = 0;
/**
* Abstract virtual eval method
* Errors are reported to the parent
*/
Q_DECL_DEPRECATED virtual QVariant eval( QgsExpression* parent, const QgsFeature* f );
/**
* Abstract virtual eval method
* Errors are reported to the parent
* @note added in QGIS 2.12
*/
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context );
/**
* Abstract virtual preparation method
* Errors are reported to the parent
*/
Q_DECL_DEPRECATED virtual bool prepare( QgsExpression* parent, const QgsFields &fields );
/**
* Abstract virtual preparation method
* Errors are reported to the parent
* @note added in QGIS 2.12
*/
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context );
/**
* Abstract virtual dump method
*
* @return An expression which represents this node as string
*/
virtual QString dump() const = 0;
/**
* Abstract virtual method which returns a list of columns required to
* evaluate this node.
*
* When reimplementing this, you need to return any column that is required to
* evaluate this node and in addition recursively collect all the columns required
* to evaluate child nodes.
*
* @return A list of columns required to evaluate this expression
*/
virtual QStringList referencedColumns() const = 0;
/**
* Abstract virtual method which returns if the geometry is required to evaluate
* this expression.
*
* This needs to call `needsGeometry()` recursively on any child nodes.
*
* @return true if a geometry is required to evaluate this expression
*/
virtual bool needsGeometry() const = 0;
/**
* Support the visitor pattern.
*
* For any implementation this should look like
*
* C++:
*
* v.visit( *this );
*
* Python:
*
* v.visit( self)
*
* @param v A visitor that visits this node.
*/
virtual void accept( Visitor& v ) const = 0;
};
class CORE_EXPORT NodeList
{
public:
NodeList() {}
virtual ~NodeList() { qDeleteAll( mList ); }
/** Takes ownership of the provided node */
void append( Node* node ) { mList.append( node ); }
int count() { return mList.count(); }
QList<Node*> list() { return mList; }
virtual QString dump() const;
protected:
QList<Node*> mList;
};
class CORE_EXPORT Interval
{
// YEAR const value taken from postgres query
// SELECT EXTRACT(EPOCH FROM interval '1 year')
static const int YEARS = 31557600;
static const int MONTHS = 60 * 60 * 24 * 30;
static const int WEEKS = 60 * 60 * 24 * 7;
static const int DAY = 60 * 60 * 24;
static const int HOUR = 60 * 60;
static const int MINUTE = 60;
public:
Interval( double seconds = 0 ) : mSeconds( seconds ), mValid( true ) { }
~Interval();
double years() { return mSeconds / YEARS;}
double months() { return mSeconds / MONTHS; }
double weeks() { return mSeconds / WEEKS;}
double days() { return mSeconds / DAY;}
double hours() { return mSeconds / HOUR;}
double minutes() { return mSeconds / MINUTE;}
double seconds() { return mSeconds; }
bool isValid() { return mValid; }
void setValid( bool valid ) { mValid = valid; }
bool operator==( const QgsExpression::Interval& other ) const;
static QgsExpression::Interval invalidInterVal();
static QgsExpression::Interval fromString( const QString& string );
private:
double mSeconds;
bool mValid;
};
class CORE_EXPORT NodeUnaryOperator : public Node
{
public:
NodeUnaryOperator( UnaryOperator op, Node* operand ) : mOp( op ), mOperand( operand ) {}
~NodeUnaryOperator() { delete mOperand; }
UnaryOperator op() const { return mOp; }
Node* operand() const { return mOperand; }
virtual NodeType nodeType() const override { return ntUnaryOperator; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override { return mOperand->referencedColumns(); }
virtual bool needsGeometry() const override { return mOperand->needsGeometry(); }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
UnaryOperator mOp;
Node* mOperand;
};
class CORE_EXPORT NodeBinaryOperator : public Node
{
public:
NodeBinaryOperator( BinaryOperator op, Node* opLeft, Node* opRight ) : mOp( op ), mOpLeft( opLeft ), mOpRight( opRight ) {}
~NodeBinaryOperator() { delete mOpLeft; delete mOpRight; }
BinaryOperator op() const { return mOp; }
Node* opLeft() const { return mOpLeft; }
Node* opRight() const { return mOpRight; }
virtual NodeType nodeType() const override { return ntBinaryOperator; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override { return mOpLeft->referencedColumns() + mOpRight->referencedColumns(); }
virtual bool needsGeometry() const override { return mOpLeft->needsGeometry() || mOpRight->needsGeometry(); }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
int precedence() const;
bool leftAssociative() const;
protected:
bool compare( double diff );
int computeInt( int x, int y );
double computeDouble( double x, double y );
QDateTime computeDateTimeFromInterval( const QDateTime& d, QgsExpression::Interval *i );
BinaryOperator mOp;
Node* mOpLeft;
Node* mOpRight;
};
class CORE_EXPORT NodeInOperator : public Node
{
public:
NodeInOperator( Node* node, NodeList* list, bool notin = false ) : mNode( node ), mList( list ), mNotIn( notin ) {}
virtual ~NodeInOperator() { delete mNode; delete mList; }
Node* node() const { return mNode; }
bool isNotIn() const { return mNotIn; }
NodeList* list() const { return mList; }
virtual NodeType nodeType() const override { return ntInOperator; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override { QStringList lst( mNode->referencedColumns() ); Q_FOREACH ( Node* n, mList->list() ) lst.append( n->referencedColumns() ); return lst; }
virtual bool needsGeometry() const override { bool needs = false; Q_FOREACH ( Node* n, mList->list() ) needs |= n->needsGeometry(); return needs; }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
Node* mNode;
NodeList* mList;
bool mNotIn;
};
class CORE_EXPORT NodeFunction : public Node
{
public:
NodeFunction( int fnIndex, NodeList* args ) : mFnIndex( fnIndex ), mArgs( args ) {}
//NodeFunction( QString name, NodeList* args ) : mName(name), mArgs(args) {}
virtual ~NodeFunction() { delete mArgs; }
int fnIndex() const { return mFnIndex; }
NodeList* args() const { return mArgs; }
virtual NodeType nodeType() const override { return ntFunction; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override;
virtual bool needsGeometry() const override { bool needs = Functions()[mFnIndex]->usesgeometry(); if ( mArgs ) { Q_FOREACH ( Node* n, mArgs->list() ) needs |= n->needsGeometry(); } return needs; }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
//QString mName;
int mFnIndex;
NodeList* mArgs;
private:
QgsExpression::Function* getFunc() const;
};
class CORE_EXPORT NodeLiteral : public Node
{
public:
NodeLiteral( const QVariant& value ) : mValue( value ) {}
inline QVariant value() const { return mValue; }
virtual NodeType nodeType() const override { return ntLiteral; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override { return QStringList(); }
virtual bool needsGeometry() const override { return false; }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
QVariant mValue;
};
class CORE_EXPORT NodeColumnRef : public Node
{
public:
NodeColumnRef( const QString& name ) : mName( name ), mIndex( -1 ) {}
QString name() const { return mName; }
virtual NodeType nodeType() const override { return ntColumnRef; }
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override { return QStringList( mName ); }
virtual bool needsGeometry() const override { return false; }
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
QString mName;
int mIndex;
};
class CORE_EXPORT WhenThen
{
public:
WhenThen( Node* whenExp, Node* thenExp ) : mWhenExp( whenExp ), mThenExp( thenExp ) {}
~WhenThen() { delete mWhenExp; delete mThenExp; }
//protected:
Node* mWhenExp;
Node* mThenExp;
};
typedef QList<WhenThen*> WhenThenList;
class CORE_EXPORT NodeCondition : public Node
{
public:
NodeCondition( WhenThenList* conditions, Node* elseExp = NULL ) : mConditions( *conditions ), mElseExp( elseExp ) { delete conditions; }
~NodeCondition() { delete mElseExp; qDeleteAll( mConditions ); }
virtual NodeType nodeType() const override { return ntCondition; }
virtual QVariant eval( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual bool prepare( QgsExpression* parent, const QgsExpressionContext* context ) override;
virtual QString dump() const override;
virtual QStringList referencedColumns() const override;
virtual bool needsGeometry() const override;
virtual void accept( Visitor& v ) const override { v.visit( *this ); }
protected:
WhenThenList mConditions;
Node* mElseExp;
};
//////
/** Support for visitor pattern - algorithms dealing with the expressions
may be implemented without modifying the Node classes */
class CORE_EXPORT Visitor
{
public:
virtual ~Visitor() {}
virtual void visit( const NodeUnaryOperator& n ) = 0;
virtual void visit( const NodeBinaryOperator& n ) = 0;
virtual void visit( const NodeInOperator& n ) = 0;
virtual void visit( const NodeFunction& n ) = 0;
virtual void visit( const NodeLiteral& n ) = 0;
virtual void visit( const NodeColumnRef& n ) = 0;
virtual void visit( const NodeCondition& n ) = 0;
};
/** Entry function for the visitor pattern */
void acceptVisitor( Visitor& v ) const;
/** Returns the help text for a specified function.
* @param name function name
* @see variableHelpText()
*/
static QString helptext( QString name );
/** Returns the help text for a specified variable.
* @param variableName name of variable
* @param showValue set to true to include current value of variable in help text
* @param value current value of variable to show in help text
* @see helptext()
* @note added in QGIS 2.12
*/
static QString variableHelpText( const QString& variableName, bool showValue = true, const QVariant& value = QVariant() );
/** Returns the translated name for a function group.
* @param group untranslated group name
*/
static QString group( const QString& group );
protected:
/**
* Used by QgsOgcUtils to create an empty
*/
QgsExpression() : mRootNode( 0 ), mRowNumber( 0 ), mScale( 0.0 ), mCalc( 0 ) {}
void initGeomCalculator();
Node* mRootNode;
QString mParserErrorString;
QString mEvalErrorString;
int mRowNumber;
double mScale;
QString mExp;
QgsDistanceArea *mCalc;
static QMap<QString, QVariant> gmSpecialColumns;
static QMap<QString, QString> gmSpecialColumnGroups;
struct HelpArg
{
HelpArg( const QString& arg, const QString& desc, bool descOnly = false, bool syntaxOnly = false )
: mArg( arg )
, mDescription( desc )
, mDescOnly( descOnly )
, mSyntaxOnly( syntaxOnly )
{}
QString mArg;
QString mDescription;
bool mDescOnly;
bool mSyntaxOnly;
};
struct HelpExample
{
HelpExample( const QString& expression, const QString& returns, const QString& note = QString::null )
: mExpression( expression )
, mReturns( returns )
, mNote( note )
{}
QString mExpression;
QString mReturns;
QString mNote;
};
struct HelpVariant
{