InRangeExpression

INCLUDE FILE

#include "Expression/InRangeExpression.h"

class InRangeExpression

Expression representing a check if a value is in a certain range.

DEFINITION

            class InRangeExpression;
        

constructor InRangeExpression

Create an in-range expression.

DEFINITION

InRangeExpression	(	const Location & location,
		const Expression & lower_bound,
		const Expression & upper_bound,
		const Expression & argument	);

PARAMETER	DESCRIPTION
`location`	The location of the expression in the source code.
`lower_bound`	The lower bound of the range.
`upper_bound`	The upper bound of the range.
`argument`	The value to check.

method cloneconst virtual

Create a deep copy of the expression.

A subclass must override this method if it can occur in a macro or function definition, .repeat body, or instruction encoding.

DEFINITION

virtual Expression clone

(

const CloneContext & context

) const;

PARAMETER	DESCRIPTION
`context`

RETURNS	DESCRIPTION
`Expression`	A shared pointer to the cloned expression.

method createstatic

Create an in-range expression from a list of arguments.

DEFINITION

static Expression create	(	const Location & location,
		const std::vector< Expression > & arguments	);

PARAMETER	DESCRIPTION
`location`	The location of the expression in the source code.
`arguments`	The list of arguments.

RETURNS	DESCRIPTION
`Expression`	The created expression.

method createstatic

Create an in-range expression from its components.

DEFINITION

static Expression create	(	const Location & location,
		const Expression & lower_bound,
		const Expression & upper_bound,
		const Expression & argument	);

PARAMETER	DESCRIPTION
`location`	The location of the expression in the source code.
`lower_bound`	The lower bound of the range.
`upper_bound`	The upper bound of the range.
`argument`	The value to check.

RETURNS	DESCRIPTION
`Expression`	The created expression.

method evaluate_processvirtual protected

Process the evaluation of the expression.

This method is called by the default implementation of evaluate() after calling evaluate() on all sub-expressions.

DEFINITION

virtual std::optional< Expression > evaluate_process

(

const EvaluationContext & context

);

PARAMETER	DESCRIPTION
`context`	The evaluation context.

RETURNS	DESCRIPTION
`std::optional< Expression >`	If the expression changed, returns the new expression, otherwise {}.

method maximum_valueconst virtual

Get the minimum possible value of the expression.

The default implementation returns the value of the expression if it is known, or {} otherwise. Subclasses should override this method if they can determine a minimum value without knowing the exact value of the expression.

DEFINITION

virtual std::optional< Value > maximum_value

(

) const;

RETURNS	DESCRIPTION
`std::optional< Value >`	The minimum possible value of the expression. if it can be determined, {} otherwise.

method minimum_valueconst virtual

Get the maximum possible value of the expression.

The default implementation returns the value of the expression if it is known, or {} otherwise. Subclasses should override this method if they can determine a maximum value without knowing the exact value of the expression.

DEFINITION

virtual std::optional< Value > minimum_value

(

) const;

RETURNS	DESCRIPTION
`std::optional< Value >`	The maximum possible value of the expression if it can be determined, {} otherwise.

method serialize_subconst virtual protected

Serialize the expression to a stream.

This method must be implemented by derived classes.

DEFINITION

virtual void serialize_sub

(

std::ostream & stream

) const;

PARAMETER	DESCRIPTION
`stream`	The stream to serialize to.

method simplifystatic private

DEFINITION

static std::optional< Expression > simplify	(	const Location & location,
		const Expression & lower_bound,
		const Expression & upper_bound,
		const Expression & argument,
		bool always_create	);

PARAMETER	DESCRIPTION
`location`
`lower_bound`
`upper_bound`
`argument`
`always_create`

RETURNS	DESCRIPTION
`std::optional< Expression >`

method traversevirtual protected

Call a method on all sub-expressions of this expression.

It is used by the default implementations of resolve() and expand_calls(). Unless a subclass has no sub-expressions or overrides both of these methods, it should override traverse().

DEFINITION

virtual void traverse

(

std::function< void(Expression &)> callable

);

PARAMETER	DESCRIPTION
`callable`	A callable to apply to each sub-expression.

method typeconst virtual

Get the type of the expression's value.

The default implementation returns the type of the value of the expression if it is known, or {} otherwise. Subclasses should override this method if they can determine the type of the expression without knowing the exact value of the expression.

DEFINITION

virtual std::optional< Value::Type > type

(

) const;

RETURNS	DESCRIPTION
`std::optional< Value::Type >`	The type of the expression's value if it can be determined, {} otherwise.

member argumentprivate

The value to check.

DEFINITION

Expression argument;

member lower_boundprivate

The lower bound of the range.

DEFINITION

Expression lower_bound;

member upper_boundprivate

The upper bound of the range.

DEFINITION

Expression upper_bound;