The AST builder. More...

#include <Builder.h>

Inheritance diagram for AST::Builder:

Public Member Functions
const std::filesystem::path *	file () const noexcept
	Currently parsed IDL file path.

Location	location () const

bool	is_main_file () const noexcept
	Test if currently parsed file is main.

const std::string &	prefix () const

void	type_prefix (const ScopedName &name, const Variant &s, const Location &id_loc)
	Set repository id prefix for item. See the `typeprefix` IDL keyword.

void	type_id (const ScopedName &name, const Variant &id, const Location &id_loc)
	Set repository id for item. See the `typeid` IDL keyword.

void	pragma_version (const ScopedName &name, const Version &ver, const Location &loc)
	Set repository id version for item. See `#pragma version`.

const Item *	cur_parent () const

void	native (const SimpleDeclarator &name)
	Create native type.

void	module_begin (const SimpleDeclarator &name)
	Begin module.

void	module_end ()
	End module.

void	interface_decl (const SimpleDeclarator &name, InterfaceKind ik=InterfaceKind())
	Create interface forward declaration.

void	interface_begin (const SimpleDeclarator &name, InterfaceKind ik=InterfaceKind())
	Begin interface definition.

void	interface_bases (const ScopedNames &bases)
	Set current interface bases.

void	operation_begin (bool oneway, Type &&type, const SimpleDeclarator &name)
	Begin operation definition for the current interface or valuetype.

void	parameter (Parameter::Attribute att, Type &&type, const SimpleDeclarator &name)
	Add parameter to the current operation.

void	raises (const ScopedNames &names)
	Set raises for the current operation.

void	operation_context (const Variants &strings)
	Set context for the current operation.

void	operation_end ()
	End of the operation definition.

void	attribute (bool readonly, Type &&type, const SimpleDeclarators &declarators)
	Add attributes to the current interface or valuetype.

void	attribute_begin (bool readonly, Type &&type, const SimpleDeclarator &name)
	Begin attribute definition for the current interface or valuetype.

void	getraises (const ScopedNames &names)
	Set getraises for the current attribute.

void	setraises (const ScopedNames &names)
	Set setraises for the current attribute.

void	attribute_end ()
	End of the attribute definition.

void	interface_end ()
	End of the interface definition.

void	type_def (Type &&type, const Declarators &declarators)
	Create type alias.

void	struct_decl (const SimpleDeclarator &name)
	Create structure forward declaration.

void	struct_begin (const SimpleDeclarator &name)
	Begin of the structure definition.

const NamedItem *	struct_end ()
	End of the structure definition.

void	exception_begin (const SimpleDeclarator &name)
	Begin of the exception definition.

void	exception_end ()
	End of the exception definition.

void	member (Type &&type, const Declarators &names)
	Add members to the current structure or exception.

void	union_decl (const SimpleDeclarator &name)
	Create union forward declaration.

void	union_begin (const SimpleDeclarator &name, const Type &switch_type, const Location &type_loc)
	Begin of the union definition.

void	union_label (const Variant &label, const Location &loc)
	Create label for the current union.

void	union_default (const Location &loc)
	Create default label for the current union.

void	union_element (Type &&type, const Declarator &decl)
	Create union element for the current label.

const NamedItem *	union_end ()
	End of the union definition.

const NamedItem *	enum_type (const SimpleDeclarator &name, const SimpleDeclarators &items)
	Create enum type.

void	valuetype_decl (const SimpleDeclarator &name, bool is_abstract=false)
	Create valuetype forward declaration.

void	valuetype_begin (const SimpleDeclarator &name, ValueType::Modifier mod=ValueType::Modifier::NONE)
	Begin valuetype definition.

void	valuetype_bases (bool truncatable, const ScopedNames &bases)
	Set current valuetype bases.

void	valuetype_supports (const ScopedNames &interfaces)
	Set current valuetype supported interfaces.

void	state_member (bool is_public, Type &&type, const Declarators &names)
	Add members to the current valuetype.

void	valuetype_factory_begin (const SimpleDeclarator &name)
	Begin valuetype factory.

void	valuetype_factory_end ()
	End valuetype factory.

void	valuetype_end ()
	End of the valuetype definition.

void	valuetype_box (const SimpleDeclarator &name, Type &&type)
	Create value box definition.

void	constant (Type &&t, const SimpleDeclarator &name, Variant &&val, const Location &loc)
	Create constant definition.

void	constant (Type &&t, const SimpleDeclarator &name)
	Create interface constant definition (Nirvana extension).

Type	lookup_type (const ScopedName &scoped_name)
	Find type by name.

Public Member Functions inherited from BE::MessageOut
	MessageOut (std::ostream &out=std::cerr, unsigned max_err_cnt=20)

void	message (const AST::Location &l, MessageType mt, const std::string &msg)

void	message (const std::exception &ex)

unsigned	error_count () const noexcept

Additional Inherited Members
Public Types inherited from BE::MessageOut
enum class	MessageType { ERROR , WARNING , MESSAGE }
	Message types. More...

Detailed Description

The AST builder.

Definition at line 59 of file Builder.h.

Member Function Documentation

◆ location()

Location AST::Builder::location ( ) const

Returns: Current location.

◆ is_main_file()

bool AST::Builder::is_main_file ( ) const

inlinenoexcept

Test if currently parsed file is main.

Returns: true if currently parsed file is compiled file. false if currently parsed file is included file.

Definition at line 75 of file Builder.h.

◆ prefix()

const std::string & AST::Builder::prefix ( ) const

Returns: Repository id prefix. See the typeprefix IDL keyword.

◆ type_prefix()

void AST::Builder::type_prefix	(	const ScopedName &	name,
		const Variant &	s,
		const Location &	id_loc
	)

Set repository id prefix for item. See the typeprefix IDL keyword.

Parameters

name	Item name.
s	Prefix string.
id_loc	`typeprefix` location.

◆ type_id()

void AST::Builder::type_id	(	const ScopedName &	name,
		const Variant &	id,
		const Location &	id_loc
	)

inline

Set repository id for item. See the typeid IDL keyword.

Parameters

name	Item name.
id	Repository id.
id_loc	`typeid` location.

Definition at line 95 of file Builder.h.

◆ pragma_version()

void AST::Builder::pragma_version	(	const ScopedName &	name,
		const Version &	ver,
		const Location &	loc
	)

inline

Set repository id version for item. See #pragma version.

Parameters

name	Item name.
ver	Item version.
loc	location.

Definition at line 105 of file Builder.h.

◆ cur_parent()

const Item * AST::Builder::cur_parent ( ) const

Returns: Current parent item or nullptr if parent item is invalid.

◆ native()

void AST::Builder::native ( const SimpleDeclarator & name )

Create native type.

Parameters

name	Native type name.

◆ module_begin()

void AST::Builder::module_begin ( const SimpleDeclarator & name )

Begin module.

Parameters

name	The module name.

Returns: Module definition.

◆ interface_decl()

void AST::Builder::interface_decl	(	const SimpleDeclarator &	name,
		InterfaceKind	ik = `InterfaceKind()`
	)

Create interface forward declaration.

Parameters

name	The interface name.
ik	The interface kind.

◆ interface_begin()

void AST::Builder::interface_begin	(	const SimpleDeclarator &	name,
		InterfaceKind	ik = `InterfaceKind()`
	)

Begin interface definition.

Parameters

name	The interface name.
ik	The interface kind.

◆ interface_bases()

void AST::Builder::interface_bases ( const ScopedNames & bases )

Set current interface bases.

Parameters

bases Base names.

◆ operation_begin()

void AST::Builder::operation_begin	(	bool	oneway,
		Type &&	type,
		const SimpleDeclarator &	name
	)

Begin operation definition for the current interface or valuetype.

Parameters

oneway	`true` for `oneway` operations.
type	Return type.
name	The operation name.

◆ parameter()

void AST::Builder::parameter	(	Parameter::Attribute	att,
		Type &&	type,
		const SimpleDeclarator &	name
	)

Add parameter to the current operation.

Parameters

att	The parameter attribute.
type	The parameter type.
name	The parameter name.

◆ raises()

void AST::Builder::raises ( const ScopedNames & names )

Set raises for the current operation.

Parameters

names Exception names.

◆ operation_context()

void AST::Builder::operation_context ( const Variants & strings )

Set context for the current operation.

Parameters

strings Context strings.

◆ attribute()

void AST::Builder::attribute	(	bool	readonly,
		Type &&	type,
		const SimpleDeclarators &	declarators
	)

Add attributes to the current interface or valuetype.

Parameters

readonly	`true` if attributes are read-only.
type	The attributes type.
declarators	The attribute names.

◆ attribute_begin()

void AST::Builder::attribute_begin	(	bool	readonly,
		Type &&	type,
		const SimpleDeclarator &	name
	)

Begin attribute definition for the current interface or valuetype.

Parameters

readonly	`true` if attribute is read-only.
type	The attribute type.
name	The attribute name.

◆ getraises()

void AST::Builder::getraises ( const ScopedNames & names )

Set getraises for the current attribute.

Parameters

names Exception names.

◆ setraises()

void AST::Builder::setraises ( const ScopedNames & names )

Set setraises for the current attribute.

Parameters

names Exception names.

◆ type_def()

void AST::Builder::type_def	(	Type &&	type,
		const Declarators &	declarators
	)

Create type alias.

Parameters

type	The type.
declarators	Type aliases.

◆ struct_decl()

void AST::Builder::struct_decl ( const SimpleDeclarator & name )

Create structure forward declaration.

Parameters

name	The structure name.

◆ struct_begin()

void AST::Builder::struct_begin ( const SimpleDeclarator & name )

Begin of the structure definition.

Parameters

name	The structure name.

◆ struct_end()

const NamedItem * AST::Builder::struct_end ( )

inline

End of the structure definition.

Returns: The pointer to definition.

Definition at line 235 of file Builder.h.

◆ exception_begin()

void AST::Builder::exception_begin ( const SimpleDeclarator & name )

Begin of the exception definition.

Parameters

name	The exception name.

◆ member()

void AST::Builder::member	(	Type &&	type,
		const Declarators &	names
	)

Add members to the current structure or exception.

Parameters

type	The members type.
names	The member names.

◆ union_decl()

void AST::Builder::union_decl ( const SimpleDeclarator & name )

Create union forward declaration.

Parameters

name	The union name.

◆ union_begin()

void AST::Builder::union_begin	(	const SimpleDeclarator &	name,
		const Type &	switch_type,
		const Location &	type_loc
	)

Begin of the union definition.

Parameters

name	The union name.
switch_type	The union discriminator type.
type_loc	Discriminator type location.

◆ union_label()

void AST::Builder::union_label	(	const Variant &	label,
		const Location &	loc
	)

Create label for the current union.

Parameters

label	The constant.
loc	The label location.

◆ union_default()

void AST::Builder::union_default ( const Location & loc )

Create default label for the current union.

Parameters

loc	The label location.

◆ union_element()

void AST::Builder::union_element	(	Type &&	type,
		const Declarator &	decl
	)

Create union element for the current label.

Parameters

type	The element type.
decl	The element name.

◆ union_end()

const NamedItem * AST::Builder::union_end ( )

End of the union definition.

Returns: The pointer to definition.

◆ enum_type()

const NamedItem * AST::Builder::enum_type	(	const SimpleDeclarator &	name,
		const SimpleDeclarators &	items
	)

Create enum type.

Parameters

name	The enum type name.
items	The enum items.

Returns: The pointer to definition.

◆ valuetype_decl()

void AST::Builder::valuetype_decl	(	const SimpleDeclarator &	name,
		bool	is_abstract = `false`
	)

Create valuetype forward declaration.

Parameters

name	The valuetype name.
is_abstract	`true` for abstract valuetype.

◆ valuetype_begin()

void AST::Builder::valuetype_begin	(	const SimpleDeclarator &	name,
		ValueType::Modifier	mod = `ValueType::Modifier::NONE`
	)

Begin valuetype definition.

Parameters

name	The valuetype name.
mod	The valuetype modifier.

◆ valuetype_bases()

void AST::Builder::valuetype_bases	(	bool	truncatable,
		const ScopedNames &	bases
	)

Set current valuetype bases.

Parameters

truncatable	`true` if valuetype is truncatable.
bases	Base names.

◆ valuetype_supports()

void AST::Builder::valuetype_supports ( const ScopedNames & interfaces )

Set current valuetype supported interfaces.

Parameters

interfaces Supported interface names.

◆ state_member()

void AST::Builder::state_member	(	bool	is_public,
		Type &&	type,
		const Declarators &	names
	)

Add members to the current valuetype.

Parameters

is_public	`true` for public members.
type	The members type.
names	The member names.

◆ valuetype_factory_begin()

void AST::Builder::valuetype_factory_begin ( const SimpleDeclarator & name )

Begin valuetype factory.

Parameters

name	The valuetype factory name.

◆ valuetype_factory_end()

void AST::Builder::valuetype_factory_end ( )

inline

End valuetype factory.

Parameters

name	The valuetype factory name.

Definition at line 335 of file Builder.h.

◆ valuetype_box()

void AST::Builder::valuetype_box	(	const SimpleDeclarator &	name,
		Type &&	type
	)

Create value box definition.

Parameters

name	The value box name.
type	Boxed type.

◆ constant() [1/2]

void AST::Builder::constant	(	Type &&	t,
		const SimpleDeclarator &	name,
		Variant &&	val,
		const Location &	loc
	)

Create constant definition.

Parameters

t	The constant type.
name	The constant name.
val	The constant value.
loc	The constant value location.

◆ constant() [2/2]

void AST::Builder::constant	(	Type &&	t,
		const SimpleDeclarator &	name
	)

Create interface constant definition (Nirvana extension).

Parameters

t	The constant type.
name	The constant name.

◆ lookup_type()

Type AST::Builder::lookup_type ( const ScopedName & scoped_name )

Find type by name.

Parameters

scoped_name The scoped name.

Returns: Type.

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

src/include/AST/Builder.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ location()

◆ is_main_file()

◆ prefix()

◆ type_prefix()

◆ type_id()

◆ pragma_version()

◆ cur_parent()

◆ native()

◆ module_begin()

◆ interface_decl()

◆ interface_begin()

◆ interface_bases()

◆ operation_begin()

◆ parameter()

◆ raises()

◆ operation_context()

◆ attribute()

◆ attribute_begin()

◆ getraises()

◆ setraises()

◆ type_def()

◆ struct_decl()

◆ struct_begin()

◆ struct_end()

◆ exception_begin()

◆ member()

◆ union_decl()

◆ union_begin()

◆ union_label()

◆ union_default()

◆ union_element()

◆ union_end()

◆ enum_type()

◆ valuetype_decl()

◆ valuetype_begin()

◆ valuetype_bases()

◆ valuetype_supports()

◆ state_member()

◆ valuetype_factory_begin()

◆ valuetype_factory_end()

◆ valuetype_box()

◆ constant() [1/2]

◆ constant() [2/2]

◆ lookup_type()