QGIS API Documentation 4.3.0-Master (0cef2469b72)
Loading...
Searching...
No Matches
QgsVbScript Class Reference

Parses and encapsulates an entire VBScript script. More...

#include <qgsvbscript.h>

Public Member Functions

 QgsVbScript (const QgsVbScript &other)
 QgsVbScript (const QString &scriptText=QString())
 Creates a new script from scriptText.
 ~QgsVbScript ()
void acceptVisitor (QgsVbScriptVisitor &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.
QgsVbScript & operator= (const QgsVbScript &other)
QString parserErrorString () const
 Returns parser error description.
const QgsVbScriptBlockStatement * 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 extractFieldReference (const QString &text)
 Strips enclosing square brackets from text and unescapes double right brackets.
static QString quotedFieldReference (const QString &fieldName)
 Returns a field name enclosed in square brackets with internal right brackets escaped.
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< QgsVbScriptBlockStatement > mRootBlock
QString mScript

Detailed Description

Parses and encapsulates an entire VBScript script.

Since
QGIS 4.4

Definition at line 1245 of file qgsvbscript.h.

Constructor & Destructor Documentation

◆ QgsVbScript() [1/2]

QgsVbScript::QgsVbScript ( const QString & scriptText = QString())
explicit

Creates a new script from scriptText.

Definition at line 866 of file qgsvbscript.cpp.

◆ QgsVbScript() [2/2]

QgsVbScript::QgsVbScript ( const QgsVbScript & other)

Definition at line 875 of file qgsvbscript.cpp.

◆ ~QgsVbScript()

QgsVbScript::~QgsVbScript ( )
default

Member Function Documentation

◆ acceptVisitor()

void QgsVbScript::acceptVisitor ( QgsVbScriptVisitor & visitor) const

Accepts a visitor to traverse the script abstract syntax tree.

Definition at line 936 of file qgsvbscript.cpp.

◆ dump()

QString QgsVbScript::dump ( ) const

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

Definition at line 928 of file qgsvbscript.cpp.

◆ extractFieldReference()

QString QgsVbScript::extractFieldReference ( const QString & text)
static

Strips enclosing square brackets from text and unescapes double right brackets.

Definition at line 956 of file qgsvbscript.cpp.

◆ hasParserError()

bool QgsVbScript::hasParserError ( ) const

Returns true if a parsing error occurred.

Definition at line 905 of file qgsvbscript.cpp.

◆ operator=()

QgsVbScript & QgsVbScript::operator= ( const QgsVbScript & other)

Definition at line 885 of file qgsvbscript.cpp.

◆ parserErrorString()

QString QgsVbScript::parserErrorString ( ) const

Returns parser error description.

Definition at line 910 of file qgsvbscript.cpp.

◆ quotedFieldReference()

QString QgsVbScript::quotedFieldReference ( const QString & fieldName)
static

Returns a field name enclosed in square brackets with internal right brackets escaped.

Definition at line 949 of file qgsvbscript.cpp.

◆ quotedString()

QString QgsVbScript::quotedString ( const QString & text)
static

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

Definition at line 942 of file qgsvbscript.cpp.

◆ rootBlock()

const QgsVbScriptBlockStatement * QgsVbScript::rootBlock ( ) const

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

Definition at line 915 of file qgsvbscript.cpp.

◆ script()

QString QgsVbScript::script ( ) const

Returns the original script text.

Definition at line 920 of file qgsvbscript.cpp.

Member Data Documentation

◆ mParserErrorString

QString QgsVbScript::mParserErrorString
protected

Definition at line 1306 of file qgsvbscript.h.

◆ mRootBlock

std::unique_ptr<QgsVbScriptBlockStatement> QgsVbScript::mRootBlock
protected

Definition at line 1304 of file qgsvbscript.h.

◆ mScript

QString QgsVbScript::mScript
protected

Definition at line 1305 of file qgsvbscript.h.


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