30#include <QRegularExpression>
41 return *sFunctionHelpTexts();
56 d->mEvalErrorString = QString();
58 d->mIsPrepared =
false;
63 if ( !d->mExp.isNull() )
71 return QStringLiteral(
"\"%1\"" ).arg( name.replace(
'\"', QLatin1String(
"\"\"" ) ) );
76 text.replace(
'\'', QLatin1String(
"''" ) );
77 text.replace(
'\\', QLatin1String(
"\\\\" ) );
78 text.replace(
'\n', QLatin1String(
"\\n" ) );
79 text.replace(
'\t', QLatin1String(
"\\t" ) );
80 return QStringLiteral(
"'%1'" ).arg( text );
91 return QStringLiteral(
"NULL" );
96 case QVariant::LongLong:
97 case QVariant::Double:
98 return value.toString();
101 return value.toBool() ? QStringLiteral(
"TRUE" ) : QStringLiteral(
"FALSE" );
104 case QVariant::StringList:
106 QStringList quotedValues;
107 const QVariantList values = value.toList();
108 quotedValues.reserve( values.count() );
109 for (
const QVariant &v : values )
113 return QStringLiteral(
"array( %1 )" ).arg( quotedValues.join( QLatin1String(
", " ) ) );
117 case QVariant::String:
131 for (
int i = 0; i < count; i++ )
136 for (
const QString &alias : aliases )
138 if ( QString::compare( name, alias, Qt::CaseInsensitive ) == 0 )
152 : d( new QgsExpressionPrivate )
154 d->mRootNode =
::parseExpression( expr, d->mParserErrorString, d->mParserErrors );
156 Q_ASSERT( !d->mParserErrorString.isNull() || d->mRootNode );
167 if (
this != &other )
169 if ( !d->ref.deref() )
180QgsExpression::operator QString()
const
186 : d( new QgsExpressionPrivate )
193 if ( !d->ref.deref() )
199 return ( d == other.d || d->mExp == other.d->mExp );
209 return d->mParserErrors.count() > 0;
214 return d->mParserErrorString;
219 return d->mParserErrors;
225 return QSet<QString>();
227 return d->mRootNode->referencedColumns();
233 return QSet<QString>();
235 return d->mRootNode->referencedVariables();
241 return QSet<QString>();
243 return d->mRootNode->referencedFunctions();
251 const QSet<QString> referencedFields = d->mRootNode->referencedColumns();
252 QSet<int> referencedIndexes;
254 for (
const QString &fieldName : referencedFields )
259 referencedIndexes = QSet<int>( attributesList.begin(), attributesList.end() );
265 referencedIndexes << idx;
269 return referencedIndexes;
276 return d->mRootNode->needsGeometry();
282 if ( context && ! d->mCalc )
286 d->mDaEllipsoid = context->
variable( QStringLiteral(
"project_ellipsoid" ) ).toString();
287 d->mDaCrs = std::make_unique<QgsCoordinateReferenceSystem>( context->
variable( QStringLiteral(
"_layer_crs" ) ).value<QgsCoordinateReferenceSystem>() );
288 d->mDaTransformContext = std::make_unique<QgsCoordinateTransformContext>( context->
variable( QStringLiteral(
"_project_transform_context" ) ).value<QgsCoordinateTransformContext>() );
294 QString distanceUnitsStr = context->
variable( QStringLiteral(
"project_distance_units" ) ).toString();
295 if ( ! distanceUnitsStr.isEmpty() )
302 QString areaUnitsStr = context->
variable( QStringLiteral(
"project_area_units" ) ).toString();
303 if ( ! areaUnitsStr.isEmpty() )
308void QgsExpression::detach()
314 ( void )d->ref.deref();
316 d =
new QgsExpressionPrivate( *d );
324 d->mCalc = std::shared_ptr<QgsDistanceArea>(
new QgsDistanceArea( *calc ) );
332 d->mEvalErrorString = QString();
338 d->mRootNode =
::parseExpression( d->mExp, d->mParserErrorString, d->mParserErrors );
343 d->mEvalErrorString = tr(
"No root node! Parsing failed?" );
347 initGeomCalculator( context );
348 d->mIsPrepared =
true;
349 return d->mRootNode->prepare(
this, context );
354 d->mEvalErrorString = QString();
357 d->mEvalErrorString = tr(
"No root node! Parsing failed?" );
366 d->mEvalErrorString = QString();
369 d->mEvalErrorString = tr(
"No root node! Parsing failed?" );
373 if ( ! d->mIsPrepared )
377 return d->mRootNode->eval(
this, context );
382 return !d->mEvalErrorString.isNull();
387 return d->mEvalErrorString;
392 d->mEvalErrorString =
str;
400 return d->mRootNode->dump();
405 if ( !d->mCalc && d->mDaCrs && d->mDaCrs->isValid() && d->mDaTransformContext )
409 d->mCalc->setEllipsoid( d->mDaEllipsoid.isEmpty() ?
geoNone() : d->mDaEllipsoid );
410 d->mCalc->setSourceCrs( *d->mDaCrs.get(), *d->mDaTransformContext.get() );
413 return d->mCalc.get();
418 return d->mDistanceUnit;
423 d->mDistanceUnit = unit;
441 while ( index < action.size() )
443 static const QRegularExpression sRegEx{ QStringLiteral(
"\\[%(.*?)%\\]" ), QRegularExpression::MultilineOption | QRegularExpression::DotMatchesEverythingOption };
445 const QRegularExpressionMatch match = sRegEx.match( action, index );
446 if ( !match.hasMatch() )
449 const int pos = action.indexOf( sRegEx, index );
450 const int start = index;
451 index = pos + match.capturedLength( 0 );
452 const QString toReplace = match.captured( 1 ).trimmed();
459#if QT_VERSION < QT_VERSION_CHECK(5, 15, 2)
460 expr_action += action.midRef( start, index - start );
462 expr_action += QStringView {action} .mid( start, index - start );
473 QVariant result = exp.
evaluate( context );
478#if QT_VERSION < QT_VERSION_CHECK(5, 15, 2)
479 expr_action += action.midRef( start, index - start );
481 expr_action += QStringView {action} .mid( start, index - start );
487 expr_action += action.mid( start, pos - start ) + result.toString();
490#if QT_VERSION < QT_VERSION_CHECK(5, 15, 2)
491 expr_action += action.midRef( index );
493 expr_action += QStringView {action} .mid( index ).toString();
501 QSet<QString> variables;
503 while ( index < text.size() )
505 const thread_local QRegularExpression rx(
"\\[%([^\\]]+)%\\]" );
506 const QRegularExpressionMatch match = rx.match( text );
507 if ( !match.hasMatch() )
510 index = match.capturedStart() + match.capturedLength();
511 QString to_replace = match.captured( 1 ).trimmed();
526 double convertedValue = QLocale().toDouble( text, &ok );
529 return convertedValue;
539 QVariant result = expr.
evaluate( &context );
540 convertedValue = result.toDouble( &ok );
543 return fallbackValue;
545 return convertedValue;
550 QgsExpression::initFunctionHelp();
552 if ( !sFunctionHelpTexts()->contains( name ) )
553 return tr(
"function help for %1 missing" ).arg( name );
555 const Help &f = ( *sFunctionHelpTexts() )[ name ];
558 if ( f.mType == tr(
"group" ) )
560 name =
group( name );
561 name = name.toLower();
564 name = name.toHtmlEscaped();
566 QString helpContents( QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\"><p>%2</p></div>" )
567 .arg( tr(
"%1 %2" ).arg( f.mType, name ),
570 for (
const HelpVariant &v : std::as_const( f.mVariants ) )
572 if ( f.mVariants.size() > 1 )
574 helpContents += QStringLiteral(
"<h3>%1</h3>\n<div class=\"description\">%2</p></div>" ).arg( v.mName, v.mDescription );
577 if ( f.mType != tr(
"group" ) && f.mType != tr(
"expression" ) )
578 helpContents += QStringLiteral(
"<h4>%1</h4>\n<div class=\"syntax\">\n" ).arg( tr(
"Syntax" ) );
580 if ( f.mType == tr(
"operator" ) )
582 if ( v.mArguments.size() == 1 )
584 helpContents += QStringLiteral(
"<code><span class=\"functionname\">%1</span> <span class=\"argument\">%2</span></code>" )
585 .arg( name, v.mArguments[0].mArg );
587 else if ( v.mArguments.size() == 2 )
589 helpContents += QStringLiteral(
"<code><span class=\"argument\">%1</span> <span class=\"functionname\">%2</span> <span class=\"argument\">%3</span></code>" )
590 .arg( v.mArguments[0].mArg, name, v.mArguments[1].mArg );
593 else if ( f.mType != tr(
"group" ) && f.mType != tr(
"expression" ) )
595 helpContents += QStringLiteral(
"<code><span class=\"functionname\">%1</span>" ).arg( name );
597 bool hasOptionalArgs =
false;
599 if ( f.mType == tr(
"function" ) && ( f.mName[0] !=
'$' || !v.mArguments.isEmpty() || v.mVariableLenArguments ) )
604 for (
const HelpArg &a : std::as_const( v.mArguments ) )
610 hasOptionalArgs =
true;
611 helpContents += QLatin1Char(
'[' );
614 helpContents += delim;
615 helpContents += QStringLiteral(
"<span class=\"argument\">%2%3</span>" ).arg(
617 a.mDefaultVal.isEmpty() ? QString() :
'=' + a.mDefaultVal
621 helpContents += QLatin1Char(
']' );
623 delim = QStringLiteral(
"," );
626 if ( v.mVariableLenArguments )
628 helpContents += QChar( 0x2026 );
634 helpContents += QLatin1String(
"</code>" );
636 if ( hasOptionalArgs )
638 helpContents += QLatin1String(
"<br/><br/>" ) + tr(
"[ ] marks optional components" );
642 if ( !v.mArguments.isEmpty() )
644 helpContents += QStringLiteral(
"<h4>%1</h4>\n<div class=\"arguments\">\n<table>" ).arg( tr(
"Arguments" ) );
646 for (
const HelpArg &a : std::as_const( v.mArguments ) )
651 helpContents += QStringLiteral(
"<tr><td class=\"argument\">%1</td><td>%2</td></tr>" ).arg( a.mArg, a.mDescription );
654 helpContents += QLatin1String(
"</table>\n</div>\n" );
657 if ( !v.mExamples.isEmpty() )
659 helpContents += QStringLiteral(
"<h4>%1</h4>\n<div class=\"examples\">\n<ul>\n" ).arg( tr(
"Examples" ) );
661 for (
const HelpExample &e : std::as_const( v.mExamples ) )
663 helpContents +=
"<li><code>" + e.mExpression +
"</code> → <code>" + e.mReturns +
"</code>";
665 if ( !e.mNote.isEmpty() )
666 helpContents += QStringLiteral(
" (%1)" ).arg( e.mNote );
668 helpContents += QLatin1String(
"</li>\n" );
671 helpContents += QLatin1String(
"</ul>\n</div>\n" );
674 if ( !v.mNotes.isEmpty() )
676 helpContents += QStringLiteral(
"<h4>%1</h4>\n<div class=\"notes\"><p>%2</p></div>\n" ).arg( tr(
"Notes" ), v.mNotes );
685 QStringList
tags = QStringList();
687 QgsExpression::initFunctionHelp();
689 if ( sFunctionHelpTexts()->contains( name ) )
691 const Help &f = ( *sFunctionHelpTexts() )[ name ];
693 for (
const HelpVariant &v : std::as_const( f.mVariants ) )
702void QgsExpression::initVariableHelp()
704 if ( !sVariableHelpTexts()->isEmpty() )
708 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_version" ), QCoreApplication::translate(
"variable_help",
"Current QGIS version string." ) );
709 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_version_no" ), QCoreApplication::translate(
"variable_help",
"Current QGIS version number." ) );
710 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_release_name" ), QCoreApplication::translate(
"variable_help",
"Current QGIS release name." ) );
711 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_short_version" ), QCoreApplication::translate(
"variable_help",
"Short QGIS version string." ) );
712 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_os_name" ), QCoreApplication::translate(
"variable_help",
"Operating system name, e.g., 'windows', 'linux' or 'osx'." ) );
713 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_platform" ), QCoreApplication::translate(
"variable_help",
"QGIS platform, e.g., 'desktop' or 'server'." ) );
714 sVariableHelpTexts()->insert( QStringLiteral(
"qgis_locale" ), QCoreApplication::translate(
"variable_help",
"Two letter identifier for current QGIS locale." ) );
715 sVariableHelpTexts()->insert( QStringLiteral(
"user_account_name" ), QCoreApplication::translate(
"variable_help",
"Current user's operating system account name." ) );
716 sVariableHelpTexts()->insert( QStringLiteral(
"user_full_name" ), QCoreApplication::translate(
"variable_help",
"Current user's operating system user name (if available)." ) );
719 sVariableHelpTexts()->insert( QStringLiteral(
"project_title" ), QCoreApplication::translate(
"variable_help",
"Title of current project." ) );
720 sVariableHelpTexts()->insert( QStringLiteral(
"project_path" ), QCoreApplication::translate(
"variable_help",
"Full path (including file name) of current project." ) );
721 sVariableHelpTexts()->insert( QStringLiteral(
"project_folder" ), QCoreApplication::translate(
"variable_help",
"Folder for current project." ) );
722 sVariableHelpTexts()->insert( QStringLiteral(
"project_filename" ), QCoreApplication::translate(
"variable_help",
"Filename of current project." ) );
723 sVariableHelpTexts()->insert( QStringLiteral(
"project_basename" ), QCoreApplication::translate(
"variable_help",
"Base name of current project's filename (without path and extension)." ) );
724 sVariableHelpTexts()->insert( QStringLiteral(
"project_home" ), QCoreApplication::translate(
"variable_help",
"Home path of current project." ) );
725 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs" ), QCoreApplication::translate(
"variable_help",
"Coordinate reference system of project (e.g., 'EPSG:4326')." ) );
726 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_definition" ), QCoreApplication::translate(
"variable_help",
"Coordinate reference system of project (full definition)." ) );
727 sVariableHelpTexts()->insert( QStringLiteral(
"project_units" ), QCoreApplication::translate(
"variable_help",
"Unit of the project's CRS." ) );
728 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_description" ), QCoreApplication::translate(
"variable_help",
"Name of the coordinate reference system of the project." ) );
729 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_acronym" ), QCoreApplication::translate(
"variable_help",
"Acronym of the coordinate reference system of the project." ) );
730 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_ellipsoid" ), QCoreApplication::translate(
"variable_help",
"Acronym of the ellipsoid of the coordinate reference system of the project." ) );
731 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_proj4" ), QCoreApplication::translate(
"variable_help",
"Proj4 definition of the coordinate reference system of the project." ) );
732 sVariableHelpTexts()->insert( QStringLiteral(
"project_crs_wkt" ), QCoreApplication::translate(
"variable_help",
"WKT definition of the coordinate reference system of the project." ) );
733 sVariableHelpTexts()->insert( QStringLiteral(
"project_author" ), QCoreApplication::translate(
"variable_help",
"Project author, taken from project metadata." ) );
734 sVariableHelpTexts()->insert( QStringLiteral(
"project_abstract" ), QCoreApplication::translate(
"variable_help",
"Project abstract, taken from project metadata." ) );
735 sVariableHelpTexts()->insert( QStringLiteral(
"project_creation_date" ), QCoreApplication::translate(
"variable_help",
"Project creation date, taken from project metadata." ) );
736 sVariableHelpTexts()->insert( QStringLiteral(
"project_identifier" ), QCoreApplication::translate(
"variable_help",
"Project identifier, taken from project metadata." ) );
737 sVariableHelpTexts()->insert( QStringLiteral(
"project_last_saved" ), QCoreApplication::translate(
"variable_help",
"Date/time when project was last saved." ) );
738 sVariableHelpTexts()->insert( QStringLiteral(
"project_keywords" ), QCoreApplication::translate(
"variable_help",
"Project keywords, taken from project metadata." ) );
739 sVariableHelpTexts()->insert( QStringLiteral(
"project_area_units" ), QCoreApplication::translate(
"variable_help",
"Area unit for current project, used when calculating areas of geometries." ) );
740 sVariableHelpTexts()->insert( QStringLiteral(
"project_distance_units" ), QCoreApplication::translate(
"variable_help",
"Distance unit for current project, used when calculating lengths of geometries." ) );
741 sVariableHelpTexts()->insert( QStringLiteral(
"project_ellipsoid" ), QCoreApplication::translate(
"variable_help",
"Name of ellipsoid of current project, used when calculating geodetic areas and lengths of geometries." ) );
742 sVariableHelpTexts()->insert( QStringLiteral(
"layer_ids" ), QCoreApplication::translate(
"variable_help",
"List of all map layer IDs from the current project." ) );
743 sVariableHelpTexts()->insert( QStringLiteral(
"layers" ), QCoreApplication::translate(
"variable_help",
"List of all map layers from the current project." ) );
746 sVariableHelpTexts()->insert( QStringLiteral(
"layer_name" ), QCoreApplication::translate(
"variable_help",
"Name of current layer." ) );
747 sVariableHelpTexts()->insert( QStringLiteral(
"layer_id" ), QCoreApplication::translate(
"variable_help",
"ID of current layer." ) );
748 sVariableHelpTexts()->insert( QStringLiteral(
"layer_crs" ), QCoreApplication::translate(
"variable_help",
"CRS Authority ID of current layer." ) );
749 sVariableHelpTexts()->insert( QStringLiteral(
"layer" ), QCoreApplication::translate(
"variable_help",
"The current layer." ) );
752 sVariableHelpTexts()->insert( QStringLiteral(
"feature" ), QCoreApplication::translate(
"variable_help",
"The current feature being evaluated. This can be used with the 'attribute' function to evaluate attribute values from the current feature." ) );
753 sVariableHelpTexts()->insert( QStringLiteral(
"id" ), QCoreApplication::translate(
"variable_help",
"The ID of the current feature being evaluated." ) );
754 sVariableHelpTexts()->insert( QStringLiteral(
"geometry" ), QCoreApplication::translate(
"variable_help",
"The geometry of the current feature being evaluated." ) );
757 sVariableHelpTexts()->insert( QStringLiteral(
"layout_name" ), QCoreApplication::translate(
"variable_help",
"Name of composition." ) );
758 sVariableHelpTexts()->insert( QStringLiteral(
"layout_numpages" ), QCoreApplication::translate(
"variable_help",
"Number of pages in composition." ) );
759 sVariableHelpTexts()->insert( QStringLiteral(
"layout_page" ), QCoreApplication::translate(
"variable_help",
"Current page number in composition." ) );
760 sVariableHelpTexts()->insert( QStringLiteral(
"layout_pageheight" ), QCoreApplication::translate(
"variable_help",
"Composition page height in mm (or specified custom units)." ) );
761 sVariableHelpTexts()->insert( QStringLiteral(
"layout_pagewidth" ), QCoreApplication::translate(
"variable_help",
"Composition page width in mm (or specified custom units)." ) );
762 sVariableHelpTexts()->insert( QStringLiteral(
"layout_pageoffsets" ), QCoreApplication::translate(
"variable_help",
"Array of Y coordinate of the top of each page." ) );
763 sVariableHelpTexts()->insert( QStringLiteral(
"layout_dpi" ), QCoreApplication::translate(
"variable_help",
"Composition resolution (DPI)." ) );
766 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_layerid" ), QCoreApplication::translate(
"variable_help",
"Current atlas coverage layer ID." ) );
767 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_layername" ), QCoreApplication::translate(
"variable_help",
"Current atlas coverage layer name." ) );
768 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_totalfeatures" ), QCoreApplication::translate(
"variable_help",
"Total number of features in atlas." ) );
769 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_featurenumber" ), QCoreApplication::translate(
"variable_help",
"Current atlas feature number." ) );
770 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_filename" ), QCoreApplication::translate(
"variable_help",
"Current atlas file name." ) );
771 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_pagename" ), QCoreApplication::translate(
"variable_help",
"Current atlas page name." ) );
772 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_feature" ), QCoreApplication::translate(
"variable_help",
"Current atlas feature (as feature object)." ) );
773 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_featureid" ), QCoreApplication::translate(
"variable_help",
"Current atlas feature ID." ) );
774 sVariableHelpTexts()->insert( QStringLiteral(
"atlas_geometry" ), QCoreApplication::translate(
"variable_help",
"Current atlas feature geometry." ) );
777 sVariableHelpTexts()->insert( QStringLiteral(
"item_id" ), QCoreApplication::translate(
"variable_help",
"Layout item user-assigned ID (not necessarily unique)." ) );
778 sVariableHelpTexts()->insert( QStringLiteral(
"item_uuid" ), QCoreApplication::translate(
"variable_help",
"layout item unique ID." ) );
779 sVariableHelpTexts()->insert( QStringLiteral(
"item_left" ), QCoreApplication::translate(
"variable_help",
"Left position of layout item (in mm)." ) );
780 sVariableHelpTexts()->insert( QStringLiteral(
"item_top" ), QCoreApplication::translate(
"variable_help",
"Top position of layout item (in mm)." ) );
781 sVariableHelpTexts()->insert( QStringLiteral(
"item_width" ), QCoreApplication::translate(
"variable_help",
"Width of layout item (in mm)." ) );
782 sVariableHelpTexts()->insert( QStringLiteral(
"item_height" ), QCoreApplication::translate(
"variable_help",
"Height of layout item (in mm)." ) );
785 sVariableHelpTexts()->insert( QStringLiteral(
"map_id" ), QCoreApplication::translate(
"variable_help",
"ID of current map destination. This will be 'canvas' for canvas renders, and the item ID for layout map renders." ) );
786 sVariableHelpTexts()->insert( QStringLiteral(
"map_rotation" ), QCoreApplication::translate(
"variable_help",
"Current rotation of map." ) );
787 sVariableHelpTexts()->insert( QStringLiteral(
"map_scale" ), QCoreApplication::translate(
"variable_help",
"Current scale of map." ) );
788 sVariableHelpTexts()->insert( QStringLiteral(
"map_extent" ), QCoreApplication::translate(
"variable_help",
"Geometry representing the current extent of the map." ) );
789 sVariableHelpTexts()->insert( QStringLiteral(
"map_extent_center" ), QCoreApplication::translate(
"variable_help",
"Center of map." ) );
790 sVariableHelpTexts()->insert( QStringLiteral(
"map_extent_width" ), QCoreApplication::translate(
"variable_help",
"Width of map." ) );
791 sVariableHelpTexts()->insert( QStringLiteral(
"map_extent_height" ), QCoreApplication::translate(
"variable_help",
"Height of map." ) );
792 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs" ), QCoreApplication::translate(
"variable_help",
"Coordinate reference system of map (e.g., 'EPSG:4326')." ) );
793 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_description" ), QCoreApplication::translate(
"variable_help",
"Name of the coordinate reference system of the map." ) );
794 sVariableHelpTexts()->insert( QStringLiteral(
"map_units" ), QCoreApplication::translate(
"variable_help",
"Units for map measurements." ) );
795 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_definition" ), QCoreApplication::translate(
"variable_help",
"Coordinate reference system of the map (full definition)." ) );
796 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_acronym" ), QCoreApplication::translate(
"variable_help",
"Acronym of the coordinate reference system of the map." ) );
797 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_projection" ), QCoreApplication::translate(
"variable_help",
"Projection method used by the coordinate reference system of the map." ) );
798 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_ellipsoid" ), QCoreApplication::translate(
"variable_help",
"Acronym of the ellipsoid of the coordinate reference system of the map." ) );
799 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_proj4" ), QCoreApplication::translate(
"variable_help",
"Proj4 definition of the coordinate reference system of the map." ) );
800 sVariableHelpTexts()->insert( QStringLiteral(
"map_crs_wkt" ), QCoreApplication::translate(
"variable_help",
"WKT definition of the coordinate reference system of the map." ) );
801 sVariableHelpTexts()->insert( QStringLiteral(
"map_layer_ids" ), QCoreApplication::translate(
"variable_help",
"List of map layer IDs visible in the map." ) );
802 sVariableHelpTexts()->insert( QStringLiteral(
"map_layers" ), QCoreApplication::translate(
"variable_help",
"List of map layers visible in the map." ) );
804 sVariableHelpTexts()->insert( QStringLiteral(
"map_start_time" ), QCoreApplication::translate(
"variable_help",
"Start of the map's temporal time range (as a datetime value)" ) );
805 sVariableHelpTexts()->insert( QStringLiteral(
"map_end_time" ), QCoreApplication::translate(
"variable_help",
"End of the map's temporal time range (as a datetime value)" ) );
806 sVariableHelpTexts()->insert( QStringLiteral(
"map_interval" ), QCoreApplication::translate(
"variable_help",
"Duration of the map's temporal time range (as an interval value)" ) );
808 sVariableHelpTexts()->insert( QStringLiteral(
"frame_rate" ), QCoreApplication::translate(
"variable_help",
"Number of frames per second during animation playback" ) );
809 sVariableHelpTexts()->insert( QStringLiteral(
"frame_number" ), QCoreApplication::translate(
"variable_help",
"Current frame number during animation playback" ) );
810 sVariableHelpTexts()->insert( QStringLiteral(
"frame_duration" ), QCoreApplication::translate(
"variable_help",
"Temporal duration of each animation frame (as an interval value)" ) );
811 sVariableHelpTexts()->insert( QStringLiteral(
"frame_timestep" ), QCoreApplication::translate(
"variable_help",
"Frame time step during animation playback" ) );
812 sVariableHelpTexts()->insert( QStringLiteral(
"frame_timestep_unit" ), QCoreApplication::translate(
"variable_help",
"Unit value of the frame time step during animation playback" ) );
813 sVariableHelpTexts()->insert( QStringLiteral(
"frame_timestep_units" ), QCoreApplication::translate(
"variable_help",
"String representation of the frame time step unit during animation playback" ) );
814 sVariableHelpTexts()->insert( QStringLiteral(
"animation_start_time" ), QCoreApplication::translate(
"variable_help",
"Start of the animation's overall temporal time range (as a datetime value)" ) );
815 sVariableHelpTexts()->insert( QStringLiteral(
"animation_end_time" ), QCoreApplication::translate(
"variable_help",
"End of the animation's overall temporal time range (as a datetime value)" ) );
816 sVariableHelpTexts()->insert( QStringLiteral(
"animation_interval" ), QCoreApplication::translate(
"variable_help",
"Duration of the animation's overall temporal time range (as an interval value)" ) );
819 sVariableHelpTexts()->insert( QStringLiteral(
"zoom_level" ), QCoreApplication::translate(
"variable_help",
"Vector tile zoom level of the map that is being rendered (derived from the current map scale). Normally in interval [0, 20]." ) );
820 sVariableHelpTexts()->insert( QStringLiteral(
"vector_tile_zoom" ), QCoreApplication::translate(
"variable_help",
"Exact vector tile zoom level of the map that is being rendered (derived from the current map scale). Normally in interval [0, 20]. Unlike @zoom_level, this variable is a floating point value which can be used to interpolate values between two integer zoom levels." ) );
822 sVariableHelpTexts()->insert( QStringLiteral(
"row_number" ), QCoreApplication::translate(
"variable_help",
"Stores the number of the current row." ) );
823 sVariableHelpTexts()->insert( QStringLiteral(
"grid_number" ), QCoreApplication::translate(
"variable_help",
"Current grid annotation value." ) );
824 sVariableHelpTexts()->insert( QStringLiteral(
"grid_axis" ), QCoreApplication::translate(
"variable_help",
"Current grid annotation axis (e.g., 'x' for longitude, 'y' for latitude)." ) );
825 sVariableHelpTexts()->insert( QStringLiteral(
"column_number" ), QCoreApplication::translate(
"variable_help",
"Stores the number of the current column." ) );
828 sVariableHelpTexts()->insert( QStringLiteral(
"canvas_cursor_point" ), QCoreApplication::translate(
"variable_help",
"Last cursor position on the canvas in the project's geographical coordinates." ) );
831 sVariableHelpTexts()->insert( QStringLiteral(
"legend_title" ), QCoreApplication::translate(
"variable_help",
"Title of the legend." ) );
832 sVariableHelpTexts()->insert( QStringLiteral(
"legend_column_count" ), QCoreApplication::translate(
"variable_help",
"Number of column in the legend." ) );
833 sVariableHelpTexts()->insert( QStringLiteral(
"legend_split_layers" ), QCoreApplication::translate(
"variable_help",
"Boolean indicating if layers can be split in the legend." ) );
834 sVariableHelpTexts()->insert( QStringLiteral(
"legend_wrap_string" ), QCoreApplication::translate(
"variable_help",
"Characters used to wrap the legend text." ) );
835 sVariableHelpTexts()->insert( QStringLiteral(
"legend_filter_by_map" ), QCoreApplication::translate(
"variable_help",
"Boolean indicating if the content of the legend is filtered by the map." ) );
836 sVariableHelpTexts()->insert( QStringLiteral(
"legend_filter_out_atlas" ), QCoreApplication::translate(
"variable_help",
"Boolean indicating if the Atlas is filtered out of the legend." ) );
839 sVariableHelpTexts()->insert( QStringLiteral(
"scale_value" ), QCoreApplication::translate(
"variable_help",
"Current scale bar distance value." ) );
842 sVariableHelpTexts()->insert( QStringLiteral(
"snapping_results" ), QCoreApplication::translate(
"variable_help",
843 "<p>An array with an item for each snapped point.</p>"
844 "<p>Each item is a map with the following keys:</p>"
846 "<dt>valid</dt><dd>Boolean that indicates if the snapping result is valid</dd>"
847 "<dt>layer</dt><dd>The layer on which the snapped feature is</dd>"
848 "<dt>feature_id</dt><dd>The feature id of the snapped feature</dd>"
849 "<dt>vertex_index</dt><dd>The index of the snapped vertex</dd>"
850 "<dt>distance</dt><dd>The distance between the mouse cursor and the snapped point at the time of snapping</dd>"
855 sVariableHelpTexts()->insert( QStringLiteral(
"geometry_part_count" ), QCoreApplication::translate(
"variable_help",
"Number of parts in rendered feature's geometry." ) );
856 sVariableHelpTexts()->insert( QStringLiteral(
"geometry_part_num" ), QCoreApplication::translate(
"variable_help",
"Current geometry part number for feature being rendered." ) );
857 sVariableHelpTexts()->insert( QStringLiteral(
"geometry_ring_num" ), QCoreApplication::translate(
"variable_help",
"Current geometry ring number for feature being rendered (for polygon features only). The exterior ring has a value of 0." ) );
858 sVariableHelpTexts()->insert( QStringLiteral(
"geometry_point_count" ), QCoreApplication::translate(
"variable_help",
"Number of points in the rendered geometry's part. It is only meaningful for line geometries and for symbol layers that set this variable." ) );
859 sVariableHelpTexts()->insert( QStringLiteral(
"geometry_point_num" ), QCoreApplication::translate(
"variable_help",
"Current point number in the rendered geometry's part. It is only meaningful for line geometries and for symbol layers that set this variable." ) );
861 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_color" ), QCoreApplication::translate(
"symbol_color",
"Color of symbol used to render the feature." ) );
862 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_angle" ), QCoreApplication::translate(
"symbol_angle",
"Angle of symbol used to render the feature (valid for marker symbols only)." ) );
863 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_layer_count" ), QCoreApplication::translate(
"symbol_layer_count",
"Total number of symbol layers in the symbol." ) );
864 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_layer_index" ), QCoreApplication::translate(
"symbol_layer_index",
"Current symbol layer index." ) );
865 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_marker_row" ), QCoreApplication::translate(
"symbol_marker_row",
"Row number for marker (valid for point pattern fills only)." ) );
866 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_marker_column" ), QCoreApplication::translate(
"symbol_marker_column",
"Column number for marker (valid for point pattern fills only)." ) );
867 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_frame" ), QCoreApplication::translate(
"symbol_frame",
"Frame number (for animated symbols only)." ) );
869 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_label" ), QCoreApplication::translate(
"symbol_label",
"Label for the symbol (either a user defined label or the default autogenerated label)." ) );
870 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_id" ), QCoreApplication::translate(
"symbol_id",
"Internal ID of the symbol." ) );
871 sVariableHelpTexts()->insert( QStringLiteral(
"symbol_count" ), QCoreApplication::translate(
"symbol_count",
"Total number of features represented by the symbol." ) );
874 sVariableHelpTexts()->insert( QStringLiteral(
"cluster_color" ), QCoreApplication::translate(
"cluster_color",
"Color of symbols within a cluster, or NULL if symbols have mixed colors." ) );
875 sVariableHelpTexts()->insert( QStringLiteral(
"cluster_size" ), QCoreApplication::translate(
"cluster_size",
"Number of symbols contained within a cluster." ) );
878 sVariableHelpTexts()->insert( QStringLiteral(
"algorithm_id" ), QCoreApplication::translate(
"algorithm_id",
"Unique ID for algorithm." ) );
879 sVariableHelpTexts()->insert( QStringLiteral(
"model_path" ), QCoreApplication::translate(
"variable_help",
"Full path (including file name) of current model (or project path if model is embedded in a project)." ) );
880 sVariableHelpTexts()->insert( QStringLiteral(
"model_folder" ), QCoreApplication::translate(
"variable_help",
"Folder containing current model (or project folder if model is embedded in a project)." ) );
881 sVariableHelpTexts()->insert( QStringLiteral(
"model_name" ), QCoreApplication::translate(
"variable_help",
"Name of current model." ) );
882 sVariableHelpTexts()->insert( QStringLiteral(
"model_group" ), QCoreApplication::translate(
"variable_help",
"Group for current model." ) );
883 sVariableHelpTexts()->insert( QStringLiteral(
"fullextent_minx" ), QCoreApplication::translate(
"fullextent_minx",
"Minimum x-value from full canvas extent (including all layers)." ) );
884 sVariableHelpTexts()->insert( QStringLiteral(
"fullextent_miny" ), QCoreApplication::translate(
"fullextent_miny",
"Minimum y-value from full canvas extent (including all layers)." ) );
885 sVariableHelpTexts()->insert( QStringLiteral(
"fullextent_maxx" ), QCoreApplication::translate(
"fullextent_maxx",
"Maximum x-value from full canvas extent (including all layers)." ) );
886 sVariableHelpTexts()->insert( QStringLiteral(
"fullextent_maxy" ), QCoreApplication::translate(
"fullextent_maxy",
"Maximum y-value from full canvas extent (including all layers)." ) );
889 sVariableHelpTexts()->insert( QStringLiteral(
"notification_message" ), QCoreApplication::translate(
"notification_message",
"Content of the notification message sent by the provider (available only for actions triggered by provider notifications)." ) );
892 sVariableHelpTexts()->insert( QStringLiteral(
"current_geometry" ), QCoreApplication::translate(
"current_geometry",
"Represents the geometry of the feature currently being edited in the form or the table row. Can be used in a form/row context to filter the related features." ) );
893 sVariableHelpTexts()->insert( QStringLiteral(
"current_feature" ), QCoreApplication::translate(
"current_feature",
"Represents the feature currently being edited in the form or the table row. Can be used in a form/row context to filter the related features." ) );
896 sVariableHelpTexts()->insert( QStringLiteral(
"current_parent_geometry" ), QCoreApplication::translate(
"current_parent_geometry",
897 "Only usable in an embedded form context, "
898 "represents the geometry of the feature currently being edited in the parent form.\n"
899 "Can be used in a form/row context to filter the related features using a value "
900 "from the feature currently edited in the parent form, to make sure that the filter "
901 "still works with standalone forms it is recommended to wrap this variable in a "
903 sVariableHelpTexts()->insert( QStringLiteral(
"current_parent_feature" ), QCoreApplication::translate(
"current_parent_feature",
904 "Only usable in an embedded form context, "
905 "represents the feature currently being edited in the parent form.\n"
906 "Can be used in a form/row context to filter the related features using a value "
907 "from the feature currently edited in the parent form, to make sure that the filter "
908 "still works with standalone forms it is recommended to wrap this variable in a "
912 sVariableHelpTexts()->insert( QStringLiteral(
"form_mode" ), QCoreApplication::translate(
"form_mode",
"What the form is used for, like AddFeatureMode, SingleEditMode, MultiEditMode, SearchMode, AggregateSearchMode or IdentifyMode as string." ) );
915 sVariableHelpTexts()->insert( QStringLiteral(
"plot_axis" ), QCoreApplication::translate(
"plot_axis",
"The associated plot axis, e.g. 'x' or 'y'." ) );
916 sVariableHelpTexts()->insert( QStringLiteral(
"plot_axis_value" ), QCoreApplication::translate(
"plot_axis_value",
"The current value for the plot axis." ) );
922 if ( sVariableHelpTexts()->contains( name ) )
926 sVariableHelpTexts()->insert( name, description );
932 QgsExpression::initVariableHelp();
933 return sVariableHelpTexts()->value( variableName, QString() );
938 QString text = !description.isEmpty() ? QStringLiteral(
"<p>%1</p>" ).arg( description ) : QString();
942 if ( !value.isValid() )
944 valueString = QCoreApplication::translate(
"variable_help",
"not set" );
950 text.append( QCoreApplication::translate(
"variable_help",
"<p>Current value: %1</p>" ).arg( valueString ) );
957 if ( sGroups()->isEmpty() )
959 sGroups()->insert( QStringLiteral(
"Aggregates" ), tr(
"Aggregates" ) );
960 sGroups()->insert( QStringLiteral(
"Arrays" ), tr(
"Arrays" ) );
961 sGroups()->insert( QStringLiteral(
"Color" ), tr(
"Color" ) );
962 sGroups()->insert( QStringLiteral(
"Conditionals" ), tr(
"Conditionals" ) );
963 sGroups()->insert( QStringLiteral(
"Conversions" ), tr(
"Conversions" ) );
964 sGroups()->insert( QStringLiteral(
"Date and Time" ), tr(
"Date and Time" ) );
965 sGroups()->insert( QStringLiteral(
"Fields and Values" ), tr(
"Fields and Values" ) );
966 sGroups()->insert( QStringLiteral(
"Files and Paths" ), tr(
"Files and Paths" ) );
967 sGroups()->insert( QStringLiteral(
"Fuzzy Matching" ), tr(
"Fuzzy Matching" ) );
968 sGroups()->insert( QStringLiteral(
"General" ), tr(
"General" ) );
969 sGroups()->insert( QStringLiteral(
"GeometryGroup" ), tr(
"Geometry" ) );
970 sGroups()->insert( QStringLiteral(
"Map Layers" ), tr(
"Map Layers" ) );
971 sGroups()->insert( QStringLiteral(
"Maps" ), tr(
"Maps" ) );
972 sGroups()->insert( QStringLiteral(
"Math" ), tr(
"Math" ) );
973 sGroups()->insert( QStringLiteral(
"Operators" ), tr(
"Operators" ) );
974 sGroups()->insert( QStringLiteral(
"Rasters" ), tr(
"Rasters" ) );
975 sGroups()->insert( QStringLiteral(
"Record and Attributes" ), tr(
"Record and Attributes" ) );
976 sGroups()->insert( QStringLiteral(
"String" ), tr(
"String" ) );
977 sGroups()->insert( QStringLiteral(
"Variables" ), tr(
"Variables" ) );
978 sGroups()->insert( QStringLiteral(
"Recent (%1)" ), tr(
"Recent (%1)" ) );
979 sGroups()->insert( QStringLiteral(
"UserGroup" ), tr(
"User expressions" ) );
985 return sGroups()->value( name, name );
990 const QString startToken = htmlOutput ? QStringLiteral(
"<i><" ) : QStringLiteral(
"<" );
991 const QString endToken = htmlOutput ? QStringLiteral(
"></i>" ) : QStringLiteral(
">" );
993 if ( value.userType() == QMetaType::type(
"QgsGeometry" ) )
998 return startToken + tr(
"empty geometry" ) + endToken;
1005 return startToken + tr(
"map layer" ) + endToken;
1007 else if ( !value.isValid() )
1009 return htmlOutput ? tr(
"<i>NULL</i>" ) : QString();
1011 else if ( value.userType() == QMetaType::type(
"QgsFeature" ) )
1015 return startToken + tr(
"feature: %1" ).arg( feat.
id() ) + endToken;
1017 else if ( value.userType() == QMetaType::type(
"QgsInterval" ) )
1020 if ( interval.
days() > 1 )
1022 return startToken + tr(
"interval: %1 days" ).arg( interval.
days() ) + endToken;
1024 else if ( interval.
hours() > 1 )
1026 return startToken + tr(
"interval: %1 hours" ).arg( interval.
hours() ) + endToken;
1028 else if ( interval.
minutes() > 1 )
1030 return startToken + tr(
"interval: %1 minutes" ).arg( interval.
minutes() ) + endToken;
1034 return startToken + tr(
"interval: %1 seconds" ).arg( interval.
seconds() ) + endToken;
1037 else if ( value.userType() == QMetaType::type(
"QgsGradientColorRamp" ) )
1039 return startToken + tr(
"gradient ramp" ) + endToken;
1041 else if ( value.type() == QVariant::Date )
1043 const QDate dt = value.toDate();
1044 return startToken + tr(
"date: %1" ).arg( dt.toString( QStringLiteral(
"yyyy-MM-dd" ) ) ) + endToken;
1046 else if ( value.type() == QVariant::Time )
1048 const QTime tm = value.toTime();
1049 return startToken + tr(
"time: %1" ).arg( tm.toString( QStringLiteral(
"hh:mm:ss" ) ) ) + endToken;
1051 else if ( value.type() == QVariant::DateTime )
1053 const QDateTime dt = value.toDateTime();
1054 return startToken + tr(
"datetime: %1 (%2)" ).arg( dt.toString( QStringLiteral(
"yyyy-MM-dd hh:mm:ss" ) ), dt.timeZoneAbbreviation() ) + endToken;
1056 else if ( value.type() == QVariant::String )
1058 const QString previewString = value.toString();
1059 if ( previewString.length() > maximumPreviewLength + 3 )
1061 return tr(
"'%1…'" ).arg( previewString.left( maximumPreviewLength ) );
1065 return '\'' + previewString +
'\'';
1068 else if ( value.type() == QVariant::Map )
1070 QString mapStr = QStringLiteral(
"{" );
1071 const QVariantMap map = value.toMap();
1073 for ( QVariantMap::const_iterator it = map.constBegin(); it != map.constEnd(); ++it )
1075 mapStr.append( separator );
1076 if ( separator.isEmpty() )
1077 separator = QStringLiteral(
"," );
1079 mapStr.append( QStringLiteral(
" '%1': %2" ).arg( it.key(),
formatPreviewString( it.value(), htmlOutput ) ) );
1080 if ( mapStr.length() > maximumPreviewLength - 3 )
1082 mapStr = tr(
"%1…" ).arg( mapStr.left( maximumPreviewLength - 2 ) );
1087 mapStr += QLatin1Char(
' ' );
1088 mapStr += QLatin1Char(
'}' );
1091 else if ( value.type() == QVariant::List || value.type() == QVariant::StringList )
1093 QString listStr = QStringLiteral(
"[" );
1094 const QVariantList list = value.toList();
1096 for (
const QVariant &arrayValue : list )
1098 listStr.append( separator );
1099 if ( separator.isEmpty() )
1100 separator = QStringLiteral(
"," );
1102 listStr.append(
" " );
1104 if ( listStr.length() > maximumPreviewLength - 3 )
1106 listStr = QString( tr(
"%1…" ) ).arg( listStr.left( maximumPreviewLength - 2 ) );
1110 if ( !list.empty() )
1111 listStr += QLatin1Char(
' ' );
1112 listStr += QLatin1Char(
']' );
1115 else if ( value.type() == QVariant::Int ||
1116 value.type() == QVariant::UInt ||
1117 value.type() == QVariant::LongLong ||
1118 value.type() == QVariant::ULongLong ||
1119 value.type() == QVariant::Double ||
1121 value.type() ==
static_cast<QVariant::Type
>( QMetaType::Float ) )
1123 return QgsExpressionUtils::toLocalizedString( value );
1127 QString
str { value.toString() };
1128 if (
str.length() > maximumPreviewLength - 3 )
1130 str = tr(
"%1…" ).arg(
str.left( maximumPreviewLength - 2 ) );
1141 expr = QStringLiteral(
"%1 IS NULL" ).arg(
quotedColumnRef( fieldName ) );
1142 else if ( fieldType == QVariant::Type::Invalid )
1163 if ( columnRef && literal )
1166 value = literal->
value();
1176 if ( expressions.empty() )
1182 for (
const QString &
expression : expressions )
1193 else if (
field != inField )
1209 if ( inOp->isNotIn() )
1218 inField = columnRef->
name();
1221 else if ( columnRef->
name() != inField )
1228 const QList<QgsExpressionNode *>
nodes = nodeList->list();
1246 QStringList orParts;
1249 if ( leftOrOp->op( ) == QgsExpressionNodeBinaryOperator::BinaryOperator::boOr )
1251 orParts.append( collectOrs( leftOrOp->opLeft(), leftOrOp->opRight() ) );
1255 orParts.append( leftOrOp->dump() );
1260 orParts.append( leftInOp->dump() );
1269 if ( rightOrOp->op( ) == QgsExpressionNodeBinaryOperator::BinaryOperator::boOr )
1271 orParts.append( collectOrs( rightOrOp->opLeft(), rightOrOp->opRight() ) );
1275 orParts.append( rightOrOp->dump() );
1280 orParts.append( rightInOp->dump() );
1290 if ( orOp->op( ) == QgsExpressionNodeBinaryOperator::BinaryOperator::boOr )
1293 const QStringList orParts = collectOrs( orOp->opLeft(), orOp->opRight() );
1294 if ( orParts.isEmpty() )
1300 QString orPartsResult;
1305 if ( ! inExp.rootNode() )
1312 if ( inOpInner->node()->nodeType() != QgsExpressionNode::NodeType::ntColumnRef || inOpInner->node()->referencedColumns().size() < 1 )
1317 const QString innerInfield { inOpInner->node()->
referencedColumns().values().first() };
1321 inField = innerInfield;
1325 if ( innerInfield != inField )
1331 const auto constInnerValuesList { inOpInner->list()->list() };
1332 for (
const auto &innerInValueNode : std::as_const( constInnerValuesList ) )
1334 values.append( innerInValueNode->dump() );
1361 result = QStringLiteral(
"%1 IN (%2)" ).arg(
quotedColumnRef( inField ), values.join(
',' ) );
1367 return d->mRootNode;
1382 if ( attrIndex >= 0 )
1389 const QString fieldName = qgis::down_cast<const QgsExpressionNodeColumnRef *>( candidate.
rootNode() )->name();
1401 if ( !
expression.contains(
'\"' ) && fieldIndex != -1 )
1414 if ( !d->mRootNode )
1415 return QList<const QgsExpressionNode *>();
1417 return d->mRootNode->nodes();
QgsWkbTypes::Type wkbType() const SIP_HOLDGIL
Returns the WKB type of the geometry.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QVariant variable(const QString &name) const
Fetches a matching variable from the context.
A binary expression operator, which operates on two values.
An expression node which takes it value from a feature's field.
QString name() const
The name of the column.
An expression node for value IN or NOT IN clauses.
An expression node for literal values.
QVariant value() const
The value of the literal.
A list of expression nodes.
QList< QgsExpressionNode * > list()
Gets a list of all the nodes.
Abstract base class for all nodes that can appear in an expression.
Class for parsing and evaluation of expressions (formerly called "search strings").
bool prepare(const QgsExpressionContext *context)
Gets the expression ready for evaluation - find out column indexes.
static const QList< QgsExpressionFunction * > & Functions()
QgsExpression & operator=(const QgsExpression &other)
Create a copy of this expression.
QString expression() const
Returns the original, unmodified expression string.
static QString quotedValue(const QVariant &value)
Returns a string representation of a literal value, including appropriate quotations where required.
void setExpression(const QString &expression)
Set the expression string, will reset the whole internal structure.
static int functionIndex(const QString &name)
Returns index of the function in Functions array.
static double evaluateToDouble(const QString &text, double fallbackValue)
Attempts to evaluate a text string as an expression to a resultant double value.
static QString quoteFieldExpression(const QString &expression, const QgsVectorLayer *layer)
Validate if the expression is a field in the layer and ensure it is quoted.
static int functionCount()
Returns the number of functions defined in the parser.
QList< const QgsExpressionNode * > nodes() const
Returns a list of all nodes which are used in this expression.
static QString quotedString(QString text)
Returns a quoted version of a string (in single quotes)
QSet< QString > referencedVariables() const
Returns a list of all variables which are used in this expression.
static bool isFunctionName(const QString &name)
tells whether the identifier is a name of existing function
bool hasParserError() const
Returns true if an error occurred when parsing the input expression.
static QString variableHelpText(const QString &variableName)
Returns the help text for a specified variable.
QList< QgsExpression::ParserError > parserErrors() const
Returns parser error details including location of error.
QString evalErrorString() const
Returns evaluation error.
static QString createFieldEqualityExpression(const QString &fieldName, const QVariant &value, QVariant::Type fieldType=QVariant::Type::Invalid)
Create an expression allowing to evaluate if a field is equal to a value.
bool operator==(const QgsExpression &other) const
Compares two expressions.
QString parserErrorString() const
Returns parser error.
static QString formatPreviewString(const QVariant &value, bool htmlOutput=true, int maximumPreviewLength=60)
Formats an expression result for friendly display to the user.
static QString replaceExpressionText(const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea=nullptr)
This function replaces each expression between [% and %] in the string with the result of its evaluat...
void setDistanceUnits(QgsUnitTypes::DistanceUnit unit)
Sets the desired distance units for calculations involving geomCalculator(), e.g.,...
static QStringList tags(const QString &name)
Returns a string list of search tags for a specified function.
bool isField() const
Checks whether an expression consists only of a single field reference.
QSet< QString > referencedColumns() const
Gets list of columns referenced by the expression.
QgsUnitTypes::AreaUnit areaUnits() const
Returns the desired areal units for calculations involving geomCalculator(), e.g.,...
QgsExpression()
Create an empty expression.
QString dump() const
Returns an expression string, constructed from the internal abstract syntax tree.
static QString helpText(QString name)
Returns the help text for a specified function.
static bool isFieldEqualityExpression(const QString &expression, QString &field, QVariant &value)
Returns true if the given expression is a simple "field=value" type expression.
QSet< QString > referencedFunctions() const
Returns a list of the names of all functions which are used in this expression.
static QString group(const QString &group)
Returns the translated name for a function group.
QgsUnitTypes::DistanceUnit distanceUnits() const
Returns the desired distance units for calculations involving geomCalculator(), e....
void setEvalErrorString(const QString &str)
Sets evaluation error (used internally by evaluation functions)
static QString quotedColumnRef(QString name)
Returns a quoted column reference (in double quotes)
void setAreaUnits(QgsUnitTypes::AreaUnit unit)
Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area".
void setGeomCalculator(const QgsDistanceArea *calc)
Sets the geometry calculator used for distance and area calculations in expressions.
const QgsExpressionNode * rootNode() const
Returns the root node of the expression.
bool hasEvalError() const
Returns true if an error occurred when evaluating last input.
static QString formatVariableHelp(const QString &description, bool showValue=true, const QVariant &value=QVariant())
Returns formatted help text for a variable.
static int expressionToLayerFieldIndex(const QString &expression, const QgsVectorLayer *layer)
Attempts to resolve an expression to a field index from the given layer.
bool needsGeometry() const
Returns true if the expression uses feature geometry for some computation.
QVariant evaluate()
Evaluate the feature and return the result.
static bool attemptReduceToInClause(const QStringList &expressions, QString &result)
Attempts to reduce a list of expressions to a single "field IN (val1, val2, ... )" type expression.
bool isValid() const
Checks if this expression is valid.
static bool addVariableHelpText(const QString name, const QString &description)
Adds a help string for a custom variable.
QgsDistanceArea * geomCalculator()
Returns calculator used for distance and area calculations (used by $length, $area and $perimeter fun...
QSet< int > referencedAttributeIndexes(const QgsFields &fields) const
Returns a list of field name indexes obtained from the provided fields.
static bool checkExpression(const QString &text, const QgsExpressionContext *context, QString &errorMessage)
Tests whether a string is a valid expression.
static const QString ALL_ATTRIBUTES
A special attribute that if set matches all attributes.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Container of fields for a vector layer.
QgsAttributeList allAttributesList() const
Utility function to get list of attribute indexes.
QgsField at(int i) const
Returns the field at particular index (must be in range 0..N-1).
int lookupField(const QString &fieldName) const
Looks up field's index from the field name.
A geometry is the spatial representation of a feature.
const QgsAbstractGeometry * constGet() const SIP_HOLDGIL
Returns a non-modifiable (const) reference to the underlying abstract geometry primitive.
A representation of the interval between two datetime values.
double days() const
Returns the interval duration in days.
double seconds() const
Returns the interval duration in seconds.
double hours() const
Returns the interval duration in hours.
double minutes() const
Returns the interval duration in minutes.
static QgsProject * instance()
Returns the QgsProject singleton instance.
DistanceUnit
Units of distance.
@ DistanceUnknownUnit
Unknown distance unit.
static Q_INVOKABLE QgsUnitTypes::DistanceUnit stringToDistanceUnit(const QString &string, bool *ok=nullptr)
Converts a translated string to a distance unit.
static Q_INVOKABLE QgsUnitTypes::AreaUnit stringToAreaUnit(const QString &string, bool *ok=nullptr)
Converts a translated string to an areal unit.
@ AreaUnknownUnit
Unknown areal unit.
static bool isNull(const QVariant &variant)
Returns true if the specified variant should be considered a NULL value.
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
static QString displayString(Type type) SIP_HOLDGIL
Returns a non-translated display string type for a WKB type, e.g., the geometry name used in WKT geom...
CONSTLATIN1STRING geoNone()
Constant that holds the string representation for "No ellips/No CRS".
QMap< QString, QString > QgsStringMap
Q_GLOBAL_STATIC(QReadWriteLock, sDefinitionCacheLock)
QgsExpressionNode * parseExpression(const QString &str, QString &parserErrorMsg, QList< QgsExpression::ParserError > &parserErrors)
HelpTextHash & functionHelpTexts()
QList< int > QgsAttributeList
#define QgsDebugMsgLevel(str, level)
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.