#include <function.h>

Inheritance diagram for hilti::declaration::Function:

Public Member Functions
auto	function () const

auto	operator_ () const

auto	linkedDeclarationIndex () const

auto	linkedPrototypeIndex () const

void	setOperator (const Operator *op)

void	setLinkedDeclarationIndex (ast::DeclarationIndex index)

void	setLinkedPrototypeIndex (ast::DeclarationIndex index)

ID	functionID (ASTContext *ctx)

std::string_view	displayName () const final

node::Properties	properties () const final

Public Member Functions inherited from hilti::Declaration
const auto &	id () const

auto	linkage () const

const auto &	fullyQualifiedID () const

const auto &	canonicalID () const

auto	declarationIndex () const

void	setID (const ID &id)

void	setLinkage (declaration::Linkage linkage)

void	setFullyQualifiedID (ID id)

void	setCanonicalID (ID id)

	Declaration (const Declaration &other)

	Declaration (Declaration &&other)=default

Declaration &	operator= (const Declaration &other)=delete

Declaration &	operator= (Declaration &&other)=delete

Public Member Functions inherited from hilti::Node
node::Tag	nodeTag () const

bool	hasParent () const

Node *	parent (int i=1) const

template<typename T >
T *	parent () const

auto	pathLength () const

const auto &	meta () const

const auto &	location () const

void	setMeta (Meta m)

auto	scope () const

auto	getOrCreateScope ()

void	clearScope ()

Result< std::pair< Declaration *, ID > >	lookupID (const ID &id, const std::string_view &what) const

virtual bool	inheritScope () const

std::string	typename_ () const

uint64_t	identity () const

const auto &	children () const

template<typename T >
T *	child (unsigned int i) const

template<typename T >
T *	childTryAs (unsigned int i) const

Node *	child (unsigned int i) const

template<typename T >
auto	children (int begin, std::optional< int > end) const

template<typename T >
auto	children (int begin, std::optional< int > end)

template<typename T >
node::Set< T >	childrenOfType () const

bool	hasChild (const Node *n, bool recurse=false) const

Node *	sibling (Node *n) const

void	addChild (ASTContext ctx, Node n)

void	addChildren (ASTContext *ctx, const Nodes &children)

void	removeChild (Node *n)

void	removeChildren (int begin, std::optional< int > end)

void	setChild (ASTContext ctx, size_t idx, Node n)

void	replaceChildren (ASTContext *ctx, const Nodes &children)

void	replaceChild (ASTContext ctx, Node old, Node *new_)

template<typename T >
bool	isA () const

template<typename T >
bool	isA_ () const

template<typename T >
T *	as () const

template<typename T >
T *	as ()

template<typename T >
const T *	tryAs () const

template<typename T >
T *	tryAs ()

template<typename T >
T *	tryAs_ ()

void	print (std::ostream &out, bool compact, bool user_visible) const

std::string	print () const

std::string	printRaw () const

	operator std::string () const

std::string	dump () const

std::string	renderSelf (bool include_location=true) const

void	addError (std::string msg, std::vector< std::string > context={})

void	addError (std::string msg, node::ErrorPriority priority, std::vector< std::string > context={})

void	addError (std::string msg, const Location &l, std::vector< std::string > context={})

void	addError (std::string msg, Location l, node::ErrorPriority priority, std::vector< std::string > context={})

bool	hasErrors () const

const auto &	errors () const

void	clearErrors ()

void	clearChildren ()

void	retain ()

void	release ()

bool	isRetained () const

virtual void	dispatch (visitor::Dispatcher &v)=0

virtual std::string_view	branchTag () const

Node &	operator= (const Node &other)=delete

Node &	operator= (Node &&other) noexcept=delete

Public Member Functions inherited from hilti::node::WithDocString
const std::optional< DocString > &	documentation () const

void	clearDocumentation ()

void	setDocumentation (DocString doc)

Static Public Member Functions
static Function *	create (ASTContext ctx, hilti::Function function, declaration::Linkage linkage=Linkage::Private, Meta meta={})

Protected Member Functions
	Function (ASTContext *ctx, Nodes children, ID id, declaration::Linkage linkage, Meta meta)

	HILTI_NODE_1 (declaration::Function, Declaration, final)

Protected Member Functions inherited from hilti::Declaration
	Declaration (ASTContext *ctx, node::Tags node_tags, Nodes children, ID id, declaration::Linkage linkage, Meta meta={})

void	setDeclarationIndex (ast::DeclarationIndex index)

std::string	_dump () const override

	HILTI_NODE_0 (Declaration, override)

Protected Member Functions inherited from hilti::Node
	Node (ASTContext *ctx, node::Tags node_tags, Nodes children, Meta meta)

	Node (ASTContext *ctx, node::Tags node_tags, Meta meta)

	Node (Node &&other)=default

	Node (const Node &other)

virtual std::string	_typename () const

virtual Node *	_clone (ASTContext *ctx) const =0

Additional Inherited Members
Static Public Attributes inherited from hilti::Node
static constexpr uint16_t	NodeLevel = 0

static constexpr ::hilti::node::Tag	NodeTag = ::hilti::node::tag::Node

static constexpr ::hilti::node::Tags	NodeTags = {::hilti::node::tag::Node}

Detailed Description

AST node for a function declaration.

Member Function Documentation

◆ displayName()

std::string_view hilti::declaration::Function::displayName ( ) const

inlinefinalvirtual

Returns a user-friendly descriptive name for the type of object the declaration refers to (e.g., "local variable"). This can be used in messages to the user.

Implements hilti::Declaration.

◆ functionID()

ID declaration::Function::functionID ( ASTContext * ctx )

Returns the ID for the function declaration, regardless of the module which it was implemented in. Only valid once the AST has been resolved.

◆ linkedDeclarationIndex()

auto hilti::declaration::Function::linkedDeclarationIndex ( ) const

inline

Returns the declaration index of a type declaration that's semantically linked to this function declaration. That could for example be the struct type for methods or hooks. Note that this is different from the function's own declaration.

◆ linkedPrototypeIndex()

auto hilti::declaration::Function::linkedPrototypeIndex ( ) const

inline

Returns the index of a function declaration that's prototyping this function if that's separate from the function's own declaration.

◆ operator_()

auto hilti::declaration::Function::operator_ ( ) const

inline

Returns an operator corresponding to a call to the function that the declaration corresponds to.

◆ properties()

node::Properties declaration::Function::properties ( ) const

finalvirtual

Implements the node interface.

Reimplemented from hilti::Declaration.

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

/home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/toolchain/include/ast/declarations/function.h
/home/docs/checkouts/readthedocs.org/user_builds/spicy-docs/checkouts/v1.14.0/hilti/toolchain/src/ast/declarations/function.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ displayName()

◆ functionID()

◆ linkedDeclarationIndex()

◆ linkedPrototypeIndex()

◆ operator_()

◆ properties()