Casting

Node and its subclasses support custom casting machinery that allows for type checking, safer static casting, and safe dynamic casting without needing the overhead of a vtable or RTTI. More...

Files
file	Casting.hpp
	The various casting and type checking operations that apply to gtirb::Node subclasses.

Detailed Description

Node and its subclasses support custom casting machinery that allows for type checking, safer static casting, and safe dynamic casting without needing the overhead of a vtable or RTTI.

File Casting.hpp defines the various operations that apply to Node subclasses.

• isa<Ty> Performs a type check.
• cast<Ty> Returns the given argument cast to the specified type; the argument cannot be null.
• cast_or_null<Ty> Returns the given argument cast to the specified type; the argument can be null.
• dyn_cast<Ty> Returns the given argument cast to the specified type, or null if the casting operation fails because the types do not match; the argument cannot be null.
• dyn_cast_or_null<Ty> Returns the given argument cast to the specified type, or null if the casting operation fails because the types do not match; the argument can be null.

Casting Operations

isa<Ty>

Perform a type check.

Parameters

Val	The object to check. Cannot be null.

Returns

true if Val is an instance of the template parameter type, false otherwise.

• isa<Ty>(const Y& Val)

Example usage:

void f(Node *N) { if (isa<Block>(N) { ... } }

cast<Ty>

Cast to the specified type; the argument cannot be null.

Parameters

Val	the value to cast. Cannot be null; consider using cast_or_null<Ty> in that case.

Returns

The result of casting Val to the specified type. This function asserts that the types match and will not return null on failure.

• cast<Ty>(Y* Val)
• cast<Ty>(Y& Val)
• cast<Ty>(const Y& Val)

Example usage:

void f(Node * N) { auto *B = cast<Block>(N); }

cast_or_null<Ty>

Cast to the specified type; the argument can be null.

Parameters

Val	the value to cast. Can be null.

Returns

The result of casting Val to the specified type. This function asserts that the types match and will not return null on failure. If Val is null, returns a null pointer cast to the given type.

• cast_or_null<Ty>(Y* Val)
• cast_or_null<Ty>(Y& Val)
• cast_or_null<Ty>(const Y& Val)

Example usage:

void f(Node *N) { auto *B = cast_or_null<Block>(N); }

dyn_cast<Ty>

Dynamic cast to the specified type; the argument cannot be null.

Parameters

Val	the value to cast. Cannot be null; consider using dyn_cast_or_null<Ty> in that case.

Returns

The result of casting Val to the specified type, or null if the casting operation fails because the types do not match.

• dyn_cast<Ty>(Y* Val)
• dyn_cast<Ty>(Y& Val)
• dyn_cast<Ty>(const Y& Val)

Example usage:

void f(Node * N) { auto *B = dyn_cast<Block>(N); }

dyn_cast_or_null<Ty>

Cast to the specified type; the argument can be null.

Parameters

Val	the value to cast. Can be null.

Returns

The result of casting Val to the specified type, or null if the casting operation fails because the types do not match. If Val is null, returns a null pointer cast to the given type.

• dyn_cast_or_null<Ty>(Y* Val)
• dyn_cast_or_null<Ty>(Y& Val)
• dyn_cast_or_null<Ty>(const Y& Val)

Example usage:

void f(Node *N) { auto *B = dyn_cast_or_null<Block>(N); }