Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Inkscape::Util::ExpressionEvaluator Class Reference

ExpressionEvaluator. More...

#include <expression-evaluator.h>

Public Member Functions

 ExpressionEvaluator (const char *string, Unit const *unit=nullptr)
 
EvaluatorQuantity evaluate ()
 Evaluates the given arithmetic expression, along with an optional dimension analysis, and basic unit conversions.
 

Private Member Functions

EvaluatorQuantity evaluateExpression ()
 
EvaluatorQuantity evaluateTerm ()
 
EvaluatorQuantity evaluateExpTerm ()
 
EvaluatorQuantity evaluateSignedFactor ()
 
EvaluatorQuantity evaluateFactor ()
 
bool acceptToken (TokenType token_type, EvaluatorToken *consumed_token)
 
void parseNextToken ()
 
void acceptTokenCount (int count, TokenType token_type)
 
void isExpected (TokenType token_type, EvaluatorToken *value)
 
void movePastWhiteSpace ()
 
void throwError (const char *msg)
 

Static Private Member Functions

static bool isUnitIdentifierStart (gunichar c)
 
static int getIdentifierSize (const char *s, int start)
 getIdentifierSize: @s: @start:
 
static bool resolveUnit (const char *identifier, EvaluatorQuantity *result, Unit const *unit)
 

Private Attributes

const char * string
 
Unit const * unit
 
EvaluatorToken current_token
 
const char * start_of_current_token
 

Detailed Description

ExpressionEvaluator.

Parameters
stringNULL terminated input string to evaluate
unitUnit output should be in

Definition at line 138 of file expression-evaluator.h.

Constructor & Destructor Documentation

◆ ExpressionEvaluator()

Inkscape::Util::ExpressionEvaluator::ExpressionEvaluator ( const char *  string,
Unit const *  unit = nullptr 
)

Definition at line 50 of file expression-evaluator.cpp.

References current_token, parseNextToken(), Inkscape::Util::TOKEN_END, and Inkscape::Util::EvaluatorToken::type.

Member Function Documentation

◆ acceptToken()

bool Inkscape::Util::ExpressionEvaluator::acceptToken ( TokenType  token_type,
EvaluatorToken *  consumed_token 
)
private

Definition at line 245 of file expression-evaluator.cpp.

References current_token, parseNextToken(), Inkscape::Util::TOKEN_ANY, and Inkscape::Util::EvaluatorToken::type.

Referenced by evaluate(), evaluateExpression(), evaluateExpTerm(), evaluateFactor(), evaluateSignedFactor(), evaluateTerm(), and isExpected().

◆ acceptTokenCount()

void Inkscape::Util::ExpressionEvaluator::acceptTokenCount ( int  count,
TokenType  token_type 
)
private

Definition at line 303 of file expression-evaluator.cpp.

References current_token, and Inkscape::Util::EvaluatorToken::type.

Referenced by parseNextToken().

◆ evaluate()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluate ( )

Evaluates the given arithmetic expression, along with an optional dimension analysis, and basic unit conversions.

All units conversions factors are relative to some implicit base-unit. This is also the unit of the returned value.

Returns: An EvaluatorQuantity with a value given in the base unit along with the order of the dimension (e.g. if the base unit is inches, a dimension order of two means in^2).

Returns
Result of evaluation.
Exceptions
Inkscape::Util::EvaluatorExceptionThere was a parse error.

Definition at line 74 of file expression-evaluator.cpp.

References acceptToken(), Inkscape::Util::EvaluatorQuantity::dimension, evaluateExpression(), isExpected(), resolveUnit(), result, Inkscape::Util::TOKEN_END, unit, and Inkscape::Util::EvaluatorQuantity::value.

Referenced by Inkscape::UI::Widget::InkSpinButton::commit_entry(), Inkscape::UI::Widget::MathSpinButton::on_input(), and Inkscape::UI::Widget::SpinButton::on_input().

◆ evaluateExpression()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluateExpression ( )
private

Definition at line 103 of file expression-evaluator.cpp.

References acceptToken(), Inkscape::Util::EvaluatorQuantity::dimension, evaluateTerm(), resolveUnit(), throwError(), unit, and Inkscape::Util::EvaluatorQuantity::value.

Referenced by evaluate(), and evaluateFactor().

◆ evaluateExpTerm()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluateExpTerm ( )
private

Definition at line 169 of file expression-evaluator.cpp.

References acceptToken(), Inkscape::Util::EvaluatorQuantity::dimension, evaluateSignedFactor(), throwError(), and Inkscape::Util::EvaluatorQuantity::value.

Referenced by evaluateTerm().

◆ evaluateFactor()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluateFactor ( )
private

Definition at line 206 of file expression-evaluator.cpp.

References acceptToken(), Inkscape::Util::EvaluatorToken::c, current_token, Inkscape::Util::EvaluatorQuantity::dimension, evaluateExpression(), Inkscape::Util::EvaluatorToken::fl, isExpected(), resolveUnit(), result, Inkscape::Util::EvaluatorToken::size, throwError(), Inkscape::Util::TOKEN_ANY, Inkscape::Util::TOKEN_END, Inkscape::Util::TOKEN_IDENTIFIER, Inkscape::Util::TOKEN_NUM, Inkscape::Util::EvaluatorToken::type, unit, Inkscape::Util::EvaluatorQuantity::value, and Inkscape::Util::EvaluatorToken::value.

Referenced by evaluateSignedFactor().

◆ evaluateSignedFactor()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluateSignedFactor ( )
private

Definition at line 188 of file expression-evaluator.cpp.

References acceptToken(), evaluateFactor(), and result.

Referenced by evaluateExpTerm().

◆ evaluateTerm()

EvaluatorQuantity Inkscape::Util::ExpressionEvaluator::evaluateTerm ( )
private

Definition at line 144 of file expression-evaluator.cpp.

References acceptToken(), Inkscape::Util::EvaluatorQuantity::dimension, evaluateExpTerm(), and Inkscape::Util::EvaluatorQuantity::value.

Referenced by evaluateExpression().

◆ getIdentifierSize()

int Inkscape::Util::ExpressionEvaluator::getIdentifierSize ( const char *  string,
int  start_offset 
)
staticprivate

getIdentifierSize: @s: @start:

Returns: Size of identifier in bytes (not including NULL terminator).

Definition at line 343 of file expression-evaluator.cpp.

References c, isUnitIdentifierStart(), and start.

Referenced by parseNextToken().

◆ isExpected()

void Inkscape::Util::ExpressionEvaluator::isExpected ( TokenType  token_type,
EvaluatorToken *  value 
)
private

Definition at line 309 of file expression-evaluator.cpp.

References acceptToken(), and throwError().

Referenced by evaluate(), and evaluateFactor().

◆ isUnitIdentifierStart()

bool Inkscape::Util::ExpressionEvaluator::isUnitIdentifierStart ( gunichar  c)
staticprivate

Definition at line 328 of file expression-evaluator.cpp.

References c.

Referenced by getIdentifierSize(), and parseNextToken().

◆ movePastWhiteSpace()

void Inkscape::Util::ExpressionEvaluator::movePastWhiteSpace ( )
private

Definition at line 317 of file expression-evaluator.cpp.

Referenced by parseNextToken().

◆ parseNextToken()

void Inkscape::Util::ExpressionEvaluator::parseNextToken ( )
private

Definition at line 264 of file expression-evaluator.cpp.

References acceptTokenCount(), Inkscape::Util::EvaluatorToken::c, current_token, Inkscape::Util::EvaluatorToken::fl, getIdentifierSize(), isUnitIdentifierStart(), movePastWhiteSpace(), Inkscape::Util::EvaluatorToken::size, start_of_current_token, string, Inkscape::Util::TOKEN_END, Inkscape::Util::TOKEN_IDENTIFIER, Inkscape::Util::TOKEN_NUM, Inkscape::Util::EvaluatorToken::type, and Inkscape::Util::EvaluatorToken::value.

Referenced by acceptToken(), and ExpressionEvaluator().

◆ resolveUnit()

bool Inkscape::Util::ExpressionEvaluator::resolveUnit ( const char *  identifier,
EvaluatorQuantity *  result,
Unit const *  unit 
)
staticprivate

Definition at line 365 of file expression-evaluator.cpp.

References Inkscape::Util::Quantity::convert(), Inkscape::Util::UnitTable::get(), Inkscape::Util::Unit::isAbsolute(), result, and unit.

Referenced by evaluate(), evaluateExpression(), and evaluateFactor().

◆ throwError()

void Inkscape::Util::ExpressionEvaluator::throwError ( const char *  msg)
private

Definition at line 388 of file expression-evaluator.cpp.

References msg, and start_of_current_token.

Referenced by evaluateExpression(), evaluateExpTerm(), evaluateFactor(), and isExpected().

Member Data Documentation

◆ current_token

EvaluatorToken Inkscape::Util::ExpressionEvaluator::current_token
private

Definition at line 149 of file expression-evaluator.h.

Referenced by acceptToken(), acceptTokenCount(), evaluateFactor(), ExpressionEvaluator(), and parseNextToken().

◆ start_of_current_token

const char* Inkscape::Util::ExpressionEvaluator::start_of_current_token
private

Definition at line 150 of file expression-evaluator.h.

Referenced by parseNextToken(), and throwError().

◆ string

const char* Inkscape::Util::ExpressionEvaluator::string
private

Definition at line 146 of file expression-evaluator.h.

Referenced by parseNextToken().

◆ unit

Unit const* Inkscape::Util::ExpressionEvaluator::unit
private

Definition at line 147 of file expression-evaluator.h.

Referenced by evaluate(), evaluateExpression(), evaluateFactor(), and resolveUnit().

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