hilti::NodeRef Class Reference

#include <node-ref.h>

Public Member Functions
	NodeRef (const Node &n)
	NodeRef (const NodeRef &other)=default
	NodeRef (NodeRef &&other)=default
NodeRef &	operator= (const NodeRef &other)=default
NodeRef &	operator= (NodeRef &&other)=default
uint64_t	rid () const
std::string	renderedRid () const
const Node *	operator-> () const
const Node &	operator* () const
	operator const Node & () const
	operator bool () const

Detailed Description

A reference to an AST Node. A reference acts similarly to a pointer to a node, except that it tracks its life-time and catches (through exceptions) if the reference becomes invalid. Assigning to a node doesn't affect any references to it; they will now point to the new value.

Member Function Documentation

operator bool()

hilti::NodeRef::operator bool ( ) const

inlineexplicit

Returns true if the instance references a valid node.

operator*()

const Node& hilti::NodeRef::operator* ( ) const

inline

Returns a direct C++ reference to the the referenced node. The node may be modified, and assigned to, through this reference.

Exceptions

Invalid

if the node does not exist anymore

operator->()

const Node* hilti::NodeRef::operator-> ( ) const

inline

Returns a pointer to the the referenced node.

Exceptions

Invalid

if the node does not exist anymore

renderedRid()

std::string hilti::NodeRef::renderedRid ( ) const

inline

Returns a string version of the referenced node's unique control ID, or ??? if the instance isn't referencing anything.

Note

This is primarily for internal usage.

rid()

uint64_t hilti::NodeRef::rid ( ) const

inline

Returns the referenced node's unique control ID, or 0 if the instance isn't referencing anything.

Note

This is primarily for internal usage.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.3.0/hilti/toolchain/include/ast/node-ref.h
• /home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.3.0/hilti/toolchain/src/ast/node_ref.cc