ObjectExpression

INCLUDE FILE

#include "Expression/ObjectExpression.h"

class ObjectExpression

Represents an expression referring to an object.

Since Objects are not deleted before the end of the program and an ObjectExpression can be contained in the Object it refers to, we use raw pointers to avoid circular ownership.

DEFINITION

            class ObjectExpression;
        

constructor ObjectExpression

DEFINITION

ObjectExpression	(	const Location & location,
		Object * object	);

PARAMETER	DESCRIPTION
`location`
`object`

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

DEFINITION

static Expression create	(	const Location & location,
		Object * object	);

PARAMETER	DESCRIPTION
`location`
`object`

RETURNS	DESCRIPTION
`Expression`

method evaluatevirtual

Evaluate the expression in the given context.

The default implementation calls evaluate() on all sub-expressions using traverse(), and then calls evaluate_process().

Errors during evaluation should either be reported via DiagnosticOutput and result in the expression being marked as invalid, or an exception should be thrown.

DEFINITION

virtual std::optional< Expression > evaluate

(

const EvaluationContext & context

);

PARAMETER	DESCRIPTION
`context`	The evaluation context.

RETURNS	DESCRIPTION
`std::optional< Expression >`	The Expression to replace this expression with, {} if no replacement is needed.

method has_valueconst virtual

Check if the value of the expression is known.

The default implementation returns true if value() returns a value, false otherwise. If the value is expensive to compute, subclasses may override this method to provide a more efficient implementation.

DEFINITION

virtual bool has_value

(

) const;

RETURNS	DESCRIPTION
`bool`	`true` if the value is known, `false` otherwise.

method maximum_valueconst virtual protected

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 protected

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 objectconst

DEFINITION

Object * object

(

) const;

RETURNS	DESCRIPTION
`Object *`

method serialize_subconst virtual

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,
		Object * object,
		bool always_create	);

PARAMETER	DESCRIPTION
`location`
`object`
`always_create`

RETURNS	DESCRIPTION
`std::optional< 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.

method valueconst virtual

Get the value of the expression if it is known.

Subclasses should override this method. The default implementation returns {}.

DEFINITION

virtual std::optional< Value > value

(

) const;

RETURNS	DESCRIPTION
`std::optional< Value >`	The value of the expression, if it is known.

member object_private

DEFINITION

Object * object_;