Flag class: specifies what kind of traversal an ast_iterator will carry out. More...

Public Member Functions
csint64	as_integer () const
	Get an integer representation of `this`. More...

std::string	as_repr () const
	Get a representation of a ast_traverse_flags object that includes information useful for debugging. More...

std::string	as_string () const
	Get a simple string representation of a ast_traverse_flags object. More...

int	cmp (const ast_traverse_flags &other) const
	Comparison function for ast_traverse_flags, with respect to a stable overall ordering. More...

cs_hash_t	hash () const
	Hash function for ast_traverse_flags. More...

std::string	name () const
	Get the name of a ast_traverse_flags object. More...

ast_traverse_flags &	operator &= (const ast_traverse_flags &other)
	AND-assign operator. More...

ast_traverse_flags &	operator\|= (const ast_traverse_flags &other)
	OR-assign operator. More...

ast_traverse_flags	operator~ () const
	Complementation operator. More...

Static Public Member Functions
static ast_traverse_flags	from_integer (csint64 _inner)
	Construct an instance from an integer representation. More...

Static Public Attributes
static const ast_traverse_flags	NONE
	No flags set. More...

static const ast_traverse_flags	POSTORDER
	Postorder traversal. More...

static const ast_traverse_flags	RIGHT_TO_LEFT
	Right-to-left traversal. More...

Friends
ast_traverse_flags	operator & (const ast_traverse_flags &a, const ast_traverse_flags &b)

ast_traverse_flags	operator\| (const ast_traverse_flags &a, const ast_traverse_flags &b)

Related Functions
(Note that these are not member functions.)
bool	operator!= (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Inequality operator for ast_traverse_flags. More...

ast_traverse_flags	operator& (const ast_traverse_flags &a, const ast_traverse_flags &b)
	AND operator for ast_traverse_flags. More...

bool	operator< (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Less-than operator for ast_traverse_flags. More...

std::ostream &	operator<< (std::ostream &out, const ast_traverse_flags &a)
	Print a representation of a ast_traverse_flags object to the specified stream. More...

bool	operator<= (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Less-than-or-equal operator for ast_traverse_flags. More...

bool	operator== (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Equality operator for ast_traverse_flags. More...

bool	operator> (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Greater-than operator for ast_traverse_flags. More...

bool	operator>= (const ast_traverse_flags &a, const ast_traverse_flags &b)
	Greater-than-or-equal operator for ast_traverse_flags. More...

ast_traverse_flags	operator\| (const ast_traverse_flags &a, const ast_traverse_flags &b)
	OR operator for ast_traverse_flags. More...

Detailed Description

Flag class: specifies what kind of traversal an ast_iterator will carry out.

Unless otherwise specified with ast_traverse_flags settings, traversal is preorder and left-to-right.

Member Function Documentation

◆ as_integer()

csint64 cs::ast_traverse_flags::as_integer ( ) const

inline

Get an integer representation of this.

Returns: An integer suitable for use with from_integer(). Invariant: For ast_traverse_flags x, ast_traverse_flags.from_integer(x.as_integer()) == x

◆ as_repr()

std::string cs::ast_traverse_flags::as_repr ( ) const

inline

Get a representation of a ast_traverse_flags object that includes information useful for debugging.

Returns: The string representation.

◆ as_string()

std::string cs::ast_traverse_flags::as_string ( ) const

inline

Get a simple string representation of a ast_traverse_flags object.

Returns: The string representation.

◆ cmp()

int cs::ast_traverse_flags::cmp ( const ast_traverse_flags & other ) const

inline

Comparison function for ast_traverse_flags, with respect to a stable overall ordering.

Parameters

other The ast_traverse_flags object to compare against.

Returns

An integer N such that:

N==0 if the two objects compare equal
N<0 if this < other
N>0 if this > other

◆ from_integer()

static ast_traverse_flags cs::ast_traverse_flags::from_integer ( csint64 _inner )

inlinestatic

Construct an instance from an integer representation.

Parameters

[in] _inner The integer representation, as returned by as_integer(). Invariant: For ast_traverse_flags x, ast_traverse_flags.from_integer(x.as_integer()) == x

Exceptions

cs::result::ERROR_INVALID_ARGUMENT if _inner is not a valid integer representation for a ast_traverse_flags instance.

◆ hash()

cs_hash_t cs::ast_traverse_flags::hash ( ) const

inline

Hash function for ast_traverse_flags.

◆ name()

std::string cs::ast_traverse_flags::name ( ) const

inline

Get the name of a ast_traverse_flags object.

◆ operator &=()

ast_traverse_flags& cs::ast_traverse_flags::operator&= ( const ast_traverse_flags & other )

inline

AND-assign operator.

Returns: A ast_traverse_flags object containing the flags that are contained in both this and other.

◆ operator|=()

ast_traverse_flags& cs::ast_traverse_flags::operator|= ( const ast_traverse_flags & other )

inline

OR-assign operator.

Returns: A ast_traverse_flags object containing the flags that are contained in this, other, or both.

◆ operator~()

ast_traverse_flags cs::ast_traverse_flags::operator~ ( ) const

inline

Complementation operator.

Returns: A ast_traverse_flags object containing the flags that are NOT contained in this.

Friends And Related Function Documentation

◆ operator!=()

bool operator!=	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: false if a and b are equal according to ast_traverse_flags::cmp(), true otherwise.

◆ operator&()

ast_traverse_flags operator &	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	AND operand.
[in]	b	AND operand.

Returns: A ast_traverse_flags object containing all flags that are in both a and b.

◆ operator<()

bool operator<	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: true if a < b according to ast_traverse_flags::cmp() , false otherwise.

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	out,
		const ast_traverse_flags &	a
	)

Parameters

[in]	out	The stream to print to.
[in]	a	The ast_traverse_flags object to print.

Returns: void

◆ operator<=()

bool operator<=	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: true if a <= b according to ast_traverse_flags::cmp() , false otherwise.

◆ operator==()

bool operator==	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: true if a and b are equal according to ast_traverse_flags::cmp(), false otherwise.

◆ operator>()

bool operator>	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: true if a > b according to ast_traverse_flags::cmp() , false otherwise.

◆ operator>=()

bool operator>=	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	The ast_traverse_flags object to compare.
[in]	b	The ast_traverse_flags object to compare against.

Returns: true if a >= b according to ast_traverse_flags::cmp() , false otherwise.

◆ operator|()

ast_traverse_flags operator\|	(	const ast_traverse_flags &	a,
		const ast_traverse_flags &	b
	)

Parameters

[in]	a	OR operand.
[in]	b	OR operand.

Returns: A ast_traverse_flags object containing all flags that are in at least one of a, b.

Member Data Documentation

◆ NONE

const ast_traverse_flags cs::ast_traverse_flags::NONE

static

No flags set.

◆ POSTORDER

const ast_traverse_flags cs::ast_traverse_flags::POSTORDER

static

Postorder traversal.

◆ RIGHT_TO_LEFT

const ast_traverse_flags cs::ast_traverse_flags::RIGHT_TO_LEFT

static

Right-to-left traversal.

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

cs_ast_decl.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Related Functions

Detailed Description

Member Function Documentation

◆ as_integer()

◆ as_repr()

◆ as_string()

◆ cmp()

◆ from_integer()

◆ hash()

◆ name()

◆ operator &=()

◆ operator|=()

◆ operator~()

Friends And Related Function Documentation

◆ operator!=()

◆ operator&()

◆ operator<()

◆ operator<<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator|()

Member Data Documentation

◆ NONE

◆ POSTORDER

◆ RIGHT_TO_LEFT