QgsEsriArcadeScript Class Reference

Parses and encapsulates an entire Esri Arcade script. More...

#include <qgsesriarcadescript.h>

Public Member Functions
	QgsEsriArcadeScript (const QgsEsriArcadeScript &other)
	QgsEsriArcadeScript (const QString &scriptText=QString())
	Creates a new script from scriptText.
	~QgsEsriArcadeScript ()
void	acceptVisitor (QgsEsriArcadeVisitor &visitor) const
	Accepts a visitor to traverse the script abstract syntax tree.
QString	dump () const
	Dumps the abstract syntax tree back into an Arcade script string.
bool	hasParserError () const
	Returns true if a parsing error occurred.
QgsEsriArcadeScript &	operator= (const QgsEsriArcadeScript &other)
QString	parserErrorString () const
	Returns parser error description.
const QgsEsriArcadeBlockStatement *	rootBlock () const
	Returns the root block statement node, or nullptr if parsing failed.
QString	script () const
	Returns the original script text.

Static Public Member Functions
static QString	quotedString (const QString &text)
	Returns a properly quoted string literal (enclosed in double quotes with escape sequences).

Protected Attributes
QString	mParserErrorString
std::unique_ptr< QgsEsriArcadeBlockStatement >	mRootBlock
QString	mScript

Detailed Description

Parses and encapsulates an entire Esri Arcade script.

Since

QGIS 4.4

Definition at line 1434 of file qgsesriarcadescript.h.

Constructor & Destructor Documentation

QgsEsriArcadeScript() [1/2]

QgsEsriArcadeScript::QgsEsriArcadeScript ( const QString & scriptText = QString() )

explicit

Creates a new script from scriptText.

Definition at line 966 of file qgsesriarcadescript.cpp.

QgsEsriArcadeScript() [2/2]

QgsEsriArcadeScript::QgsEsriArcadeScript

(

const QgsEsriArcadeScript &

other

)

Definition at line 975 of file qgsesriarcadescript.cpp.

~QgsEsriArcadeScript()

QgsEsriArcadeScript::~QgsEsriArcadeScript ( )

default

Member Function Documentation

acceptVisitor()

void QgsEsriArcadeScript::acceptVisitor

(

QgsEsriArcadeVisitor &

visitor

)

const

Accepts a visitor to traverse the script abstract syntax tree.

Definition at line 1036 of file qgsesriarcadescript.cpp.

dump()

QString QgsEsriArcadeScript::dump

(

)

const

Dumps the abstract syntax tree back into an Arcade script string.

Definition at line 1028 of file qgsesriarcadescript.cpp.

hasParserError()

bool QgsEsriArcadeScript::hasParserError

(

)

const

Returns true if a parsing error occurred.

Definition at line 1005 of file qgsesriarcadescript.cpp.

operator=()

QgsEsriArcadeScript & QgsEsriArcadeScript::operator=

(

const QgsEsriArcadeScript &

other

)

Definition at line 985 of file qgsesriarcadescript.cpp.

parserErrorString()

QString QgsEsriArcadeScript::parserErrorString

(

)

const

Returns parser error description.

Definition at line 1010 of file qgsesriarcadescript.cpp.

quotedString()

QString QgsEsriArcadeScript::quotedString ( const QString & text )

static

Returns a properly quoted string literal (enclosed in double quotes with escape sequences).

Definition at line 1042 of file qgsesriarcadescript.cpp.

rootBlock()

const QgsEsriArcadeBlockStatement * QgsEsriArcadeScript::rootBlock

(

)

const

Returns the root block statement node, or nullptr if parsing failed.

Definition at line 1015 of file qgsesriarcadescript.cpp.

script()

QString QgsEsriArcadeScript::script

(

)

const

Returns the original script text.

Definition at line 1020 of file qgsesriarcadescript.cpp.

Member Data Documentation

mParserErrorString

QString QgsEsriArcadeScript::mParserErrorString

protected

Definition at line 1485 of file qgsesriarcadescript.h.

mRootBlock

std::unique_ptr<QgsEsriArcadeBlockStatement> QgsEsriArcadeScript::mRootBlock

protected

Definition at line 1483 of file qgsesriarcadescript.h.

mScript

QString QgsEsriArcadeScript::mScript

protected

Definition at line 1484 of file qgsesriarcadescript.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-4.3.0+git20261102+6ece89243d2+99sid/src/core/providers/arcgis/qgsesriarcadescript.h
• /build/qgis-4.3.0+git20261102+6ece89243d2+99sid/src/core/providers/arcgis/qgsesriarcadescript.cpp