Cogs::Core::ExpressionContext Struct Reference

Provides a context for evaluation of expressions. More...

#include <Expressions.h>

Public Member Functions
	ExpressionContext (const ExpressionContext &other)=delete
ExpressionContext &	operator= (const ExpressionContext &other)=delete
void	inherit (ExpressionContext *other)
ExpressionVariable &	add (std::string_view name, double value)
float	eval (std::string_view expression, float defaultValue)
double	eval (std::string_view expression, double defaultValue)
int	eval (std::string_view expression, int defaultValue)
Expression *	compile (std::string_view expression, std::string_view variable)
void	free (Expression *expression)
double	update (const Expression *expression, double defaultValue)
float	update (const Expression *expression, float defaultValue)
int	update (const Expression *expression, int defaultValue)
size_t	update (const Expression *expression, size_t defaultValue)
std::span< const ExpressionVariable >	getValues () const
std::span< ExpressionVariable >	getValues ()
ExpressionContext *	getParent ()
void	link (ExpressionContext *source, std::string_view sourceName, std::string_view destName)
void	clear ()

Public Attributes
const size_t	kMaxVariables = 1024
	Simple bound on variables to avoid resizing storage and invalidating pointers.

Private Member Functions
void	reserve ()

Private Attributes
ExpressionContext *	parent
std::unordered_map< size_t, Expression >	expressions
std::vector< ExpressionVariable >	values
te_scope	scope
std::vector< te_variable >	variables

Detailed Description

Provides a context for evaluation of expressions.

Named variables can be added to the expression context to be available for expressions to use.

The context only evaluates a single variable or expression at a time, there is no automatic updates of dependent values.

Expression contexts may inherit variable state from other contexts, making all named variables of the parent context available during evaluation.

Definition at line 53 of file Expressions.h.

Constructor & Destructor Documentation

ExpressionContext()

Cogs::Core::ExpressionContext::ExpressionContext

(

)

Definition at line 17 of file Expressions.cpp.

Member Function Documentation

add()

Cogs::Core::ExpressionVariable & Cogs::Core::ExpressionContext::add	(	std::string_view	name,
		double	value
	)

Definition at line 104 of file Expressions.cpp.

clear()

void Cogs::Core::ExpressionContext::clear

(

)

Definition at line 202 of file Expressions.cpp.

compile()

Cogs::Core::Expression * Cogs::Core::ExpressionContext::compile	(	std::string_view	expression,
		std::string_view	variable
	)

Definition at line 66 of file Expressions.cpp.

eval() [1/3]

double Cogs::Core::ExpressionContext::eval	(	std::string_view	expression,
		double	defaultValue
	)

Definition at line 46 of file Expressions.cpp.

eval() [2/3]

float Cogs::Core::ExpressionContext::eval	(	std::string_view	expression,
		float	defaultValue
	)

Definition at line 41 of file Expressions.cpp.

eval() [3/3]

int Cogs::Core::ExpressionContext::eval	(	std::string_view	expression,
		int	defaultValue
	)

Definition at line 61 of file Expressions.cpp.

free()

void Cogs::Core::ExpressionContext::free

(

Expression *

expression

)

Definition at line 99 of file Expressions.cpp.

getParent()

ExpressionContext * Cogs::Core::ExpressionContext::getParent ( )

inline

Definition at line 81 of file Expressions.h.

getValues() [1/2]

std::span< Cogs::Core::ExpressionVariable > Cogs::Core::ExpressionContext::getValues

(

)

Definition at line 220 of file Expressions.cpp.

getValues() [2/2]

std::span< const Cogs::Core::ExpressionVariable > Cogs::Core::ExpressionContext::getValues

(

)

const

Definition at line 215 of file Expressions.cpp.

inherit()

void Cogs::Core::ExpressionContext::inherit

(

ExpressionContext *

other

)

Definition at line 29 of file Expressions.cpp.

link()

void Cogs::Core::ExpressionContext::link	(	ExpressionContext *	source,
		std::string_view	sourceName,
		std::string_view	destName
	)

Definition at line 167 of file Expressions.cpp.

reserve()

void Cogs::Core::ExpressionContext::reserve ( )

private

Definition at line 23 of file Expressions.cpp.

update() [1/4]

double Cogs::Core::ExpressionContext::update	(	const Expression *	expression,
		double	defaultValue
	)

Definition at line 133 of file Expressions.cpp.

update() [2/4]

float Cogs::Core::ExpressionContext::update	(	const Expression *	expression,
		float	defaultValue
	)

Definition at line 146 of file Expressions.cpp.

update() [3/4]

int Cogs::Core::ExpressionContext::update	(	const Expression *	expression,
		int	defaultValue
	)

Definition at line 151 of file Expressions.cpp.

update() [4/4]

size_t Cogs::Core::ExpressionContext::update	(	const Expression *	expression,
		size_t	defaultValue
	)

Definition at line 156 of file Expressions.cpp.

Member Data Documentation

expressions

std::unordered_map<size_t, Expression> Cogs::Core::ExpressionContext::expressions

private

Definition at line 92 of file Expressions.h.

kMaxVariables

const size_t Cogs::Core::ExpressionContext::kMaxVariables = 1024

Simple bound on variables to avoid resizing storage and invalidating pointers.

Definition at line 56 of file Expressions.h.

parent

ExpressionContext* Cogs::Core::ExpressionContext::parent

private

Definition at line 90 of file Expressions.h.

scope

te_scope Cogs::Core::ExpressionContext::scope

private

Definition at line 95 of file Expressions.h.

values

std::vector<ExpressionVariable> Cogs::Core::ExpressionContext::values

private

Definition at line 93 of file Expressions.h.

variables

std::vector<te_variable> Cogs::Core::ExpressionContext::variables

private

Definition at line 96 of file Expressions.h.

---

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

• Source/Utilities/Expressions.h
• Source/Utilities/Expressions.cpp