The abstraction of a typedef declaration. More...

#include <abg-ir.h>

Inheritance diagram for typedef_decl:

Classes
struct	hash
	Hash functor for instances of typedef_decl. More...

Public Member Functions
	typedef_decl (const string &name, const environment &env, const location &locus, const string &mangled_name="", visibility vis=VISIBILITY_DEFAULT)
	Constructor of the typedef_decl type.

	typedef_decl (const string &name, const type_base_sptr underlying_type, const location &locus, const string &mangled_name="", visibility vis=VISIBILITY_DEFAULT)
	Constructor of the typedef_decl type.

virtual size_t	get_alignment_in_bits () const
	Return the alignment of the typedef.

virtual string	get_pretty_representation (bool internal=false, bool qualified_name=true) const
	Build a pretty representation for a typedef_decl.

virtual const interned_string &	get_qualified_name (bool internal=false) const
	Implementation of the virtual "get_qualified_name" method.

virtual void	get_qualified_name (interned_string &qualified_name, bool internal=false) const
	Implementation of the virtual "get_qualified_name" method.

virtual size_t	get_size_in_bits () const
	Return the size of the typedef.

type_base_sptr	get_underlying_type () const
	Getter of the underlying type of the typedef.

virtual hash_t	hash_value () const
	Return the hash value of the current IR node.

virtual bool	operator== (const decl_base &) const
	Equality operator.

virtual bool	operator== (const type_base &) const
	Equality operator.

void	set_underlying_type (const type_base_sptr &)
	Setter ofthe underlying type of the typedef.

virtual bool	traverse (ir_node_visitor &)
	This implements the ir_traversable_base::traverse pure virtual function.

Public Member Functions inherited from type_base
	type_base (const environment &e, size_t s, size_t a)
	The constructor of type_base.

const interned_string &	get_cached_pretty_representation (bool internal=false) const
	Get the pretty representation of the current type.

type_base_sptr	get_canonical_type () const
	Getter of the canonical type of the current instance of type_base.

type_base *	get_naked_canonical_type () const
	Getter of the canonical type pointer.

virtual bool	operator!= (const type_base &) const
	Inequality operator.

virtual void	set_alignment_in_bits (size_t)
	Setter for the alignment of the type.

virtual void	set_size_in_bits (size_t)
	Setter for the size of the type.

Public Member Functions inherited from type_or_decl_base
	type_or_decl_base (const environment &, enum type_or_decl_kind k=ABSTRACT_TYPE_OR_DECL)
	Constructor of type_or_decl_base.

virtual	~type_or_decl_base ()
	The destructor of the type_or_decl_base type.

location &	get_artificial_location () const
	Getter of the artificial location of the artifact.

corpus *	get_corpus ()
	Get the corpus this ABI artifact belongs to.

const corpus *	get_corpus () const
	Get the corpus this ABI artifact belongs to.

const environment &	get_environment () const
	Getter of the environment of the current ABI artifact.

bool	get_is_artificial () const
	Getter of the flag that says if the artefact is artificial.

translation_unit *	get_translation_unit ()
	Get the translation_unit this ABI artifact belongs to.

const translation_unit *	get_translation_unit () const
	Get the translation_unit this ABI artifact belongs to.

bool	has_artificial_location () const
	Test if the current ABI artifact carries an artificial location.

enum type_or_decl_kind	kind () const
	Getter for the "kind" property of type_or_decl_base type.

void	set_artificial_location (const location &)
	Setter of the artificial location of the artificat.

void	set_is_artificial (bool)
	Setter of the flag that says if the artefact is artificial.

void	set_translation_unit (translation_unit *)
	Set the translation_unit this ABI artifact belongs to.

Public Member Functions inherited from ir_traversable_base
Public Member Functions inherited from traversable_base
virtual	~traversable_base ()
	Destructor of the traversable_base type.

Public Member Functions inherited from decl_base
	decl_base (const environment &, const location &)
	Constructor for the decl_base type.

	decl_base (const environment &e, const interned_string &name, const location &locus, const interned_string &mangled_name=interned_string(), visibility vis=VISIBILITY_DEFAULT)
	Constructor.

	decl_base (const environment &e, const string &name, const location &locus, const string &mangled_name="", visibility vis=VISIBILITY_DEFAULT)
	Constructor for the decl_base type.

virtual	~decl_base ()
	Destructor of the decl_base type.

const interned_string &	get_cached_pretty_representation (bool internal=false) const
	Get the pretty representation of the current decl.

context_rel *	get_context_rel ()
	Getter for the context relationship.

const context_rel *	get_context_rel () const
	Getter for the context relationship.

const decl_base_sptr	get_definition_of_declaration () const
	If this decl_base is declaration-only, get its definition, if any.

const decl_base_sptr	get_earlier_declaration () const
	If this decl_base is a definition, get its earlier declaration.

bool	get_has_anonymous_parent () const
	Get the "has_anonymous_parent" flag of the current declaration.

bool	get_is_anonymous () const
	Test if the current declaration is anonymous.

bool	get_is_anonymous_or_has_anonymous_parent () const

bool	get_is_declaration_only () const
	Test if a decl_base is a declaration-only decl.

bool	get_is_in_public_symbol_table () const
	Test if the decl is defined in a ELF symbol table as a public symbol.

const interned_string &	get_linkage_name () const
	Getter for the mangled name.

const location &	get_location () const
	Get the location of a given declaration.

const decl_base *	get_naked_definition_of_declaration () const
	If this decl_base is declaration-only, get its definition, if any.

virtual const interned_string &	get_name () const
	Getter for the name of the current decl.

typedef_decl_sptr	get_naming_typedef () const
	Getter for the naming typedef of the current decl.

const interned_string &	get_qualified_parent_name () const
	Return a copy of the qualified name of the parent of the current decl.

scope_decl *	get_scope () const
	Return the type containing the current decl, if any.

virtual const interned_string &	get_scoped_name () const
	Return the scoped name of the decl.

visibility	get_visibility () const
	Getter for the visibility of the decl.

virtual bool	operator!= (const decl_base &) const
	Inequality operator.

void	set_definition_of_declaration (const decl_base_sptr &)
	Set the definition of this declaration-only decl_base.

void	set_earlier_declaration (const decl_base_sptr &)
	set the earlier declaration of this decl_base definition.

void	set_is_anonymous (bool)
	Set the "is_anonymous" flag of the current declaration.

void	set_is_declaration_only (bool f)
	Set a flag saying if the enum_type_decl is a declaration-only enum_type_decl.

void	set_is_in_public_symbol_table (bool)
	Set the flag saying if this decl is from a symbol that is in a public symbols table, defined as public (global or weak).

virtual void	set_linkage_name (const string &m)
	Setter for the linkage name.

void	set_location (const location &l)
	Set the location for a given declaration.

virtual void	set_name (const string &n)
	Setter for the name of the decl.

void	set_naming_typedef (const typedef_decl_sptr &)
	Set the naming typedef of the current instance of decl_base.

virtual void	set_scope (scope_decl *)
	Setter of the scope of the current decl.

void	set_visibility (visibility v)
	Setter for the visibility of the decl.

Additional Inherited Members
Public Types inherited from type_or_decl_base
enum	type_or_decl_kind { ABSTRACT_TYPE_OR_DECL , ABSTRACT_DECL_BASE , ABSTRACT_SCOPE_DECL , GLOBAL_SCOPE_DECL , NAMESPACE_DECL , VAR_DECL , FUNCTION_DECL , FUNCTION_PARAMETER_DECL , METHOD_DECL , TEMPLATE_DECL , ABSTRACT_TYPE_BASE , ABSTRACT_SCOPE_TYPE_DECL , BASIC_TYPE , SUBRANGE_TYPE , QUALIFIED_TYPE , POINTER_TYPE , REFERENCE_TYPE , POINTER_TO_MEMBER_TYPE , ARRAY_TYPE , ENUM_TYPE , TYPEDEF_TYPE , CLASS_TYPE , UNION_TYPE , FUNCTION_TYPE , METHOD_TYPE }
	This is a bitmap type which instance is meant to contain the runtime type of a given ABI artifact. Bits of the identifiers of the type of a given artifact as well as the types it inherits from are to be set to 1. More...

Public Types inherited from decl_base
enum	binding { BINDING_NONE , BINDING_LOCAL , BINDING_GLOBAL , BINDING_WEAK }
	ELF binding. More...

enum	visibility { VISIBILITY_NONE , VISIBILITY_DEFAULT , VISIBILITY_PROTECTED , VISIBILITY_HIDDEN , VISIBILITY_INTERNAL }
	ELF visibility. More...

Public Attributes inherited from type_base
priv *	priv_

Public Attributes inherited from type_or_decl_base
std::unique_ptr< priv >	priv_

Public Attributes inherited from decl_base
priv *	priv_

Protected Member Functions inherited from type_base
virtual void	on_canonical_type_set ()
	This method is invoked automatically right after the current instance of class_decl has been canonicalized.

Protected Member Functions inherited from type_or_decl_base
void	kind (enum type_or_decl_kind)
	Setter for the "kind" property of type_or_decl_base type.

type_or_decl_base &	operator= (const type_or_decl_base &)

void *	runtime_type_instance ()
	Getter of the pointer to the runtime type sub-object of the current instance.

const void *	runtime_type_instance () const
	Getter of the pointer to the runtime type sub-object of the current instance.

void	runtime_type_instance (void *)
	Setter of the pointer to the runtime type sub-object of the current instance.

void	set_hash_value (hash_t) const

void *	type_or_decl_base_pointer ()
	Getter of the pointer to either the type_base sub-object of the current instance if it's a type, or to the decl_base sub-object of the current instance if it's a decl.

const void *	type_or_decl_base_pointer () const
	Getter of the pointer to either the type_base sub-object of the current instance if it's a type, or to the decl_base sub-object of the current instance if it's a decl.

Protected Member Functions inherited from traversable_base
	traversable_base ()
	Default constructor of the traversable_base type.

bool	visiting () const
	This should returns false before and after the node has been visiting. During the visiting of the node (and of its children) this should return true.

void	visiting (bool f)
	The traversing code should be responsible of calling this, not the user code.

Protected Member Functions inherited from decl_base
	decl_base (const decl_base &)

void	clear_qualified_name ()
	Clear the qualified name of this decl.

const interned_string &	peek_qualified_name () const
	Getter for the qualified name.

const interned_string &	peek_temporary_qualified_name () const
	Getter of the temporary qualified name of the current declaration.

void	set_context_rel (context_rel *c)

void	set_qualified_name (const interned_string &) const
	Setter for the qualified name.

void	set_temporary_qualified_name (const interned_string &) const
	Setter for the temporary qualified name of the current declaration.

Detailed Description

The abstraction of a typedef declaration.

Definition at line 2897 of file abg-ir.h.

Constructor & Destructor Documentation

◆ typedef_decl() [1/2]

typedef_decl	(	const string &	name,
		const type_base_sptr	underlying_type,
		const location &	locus,
		const string &	linkage_name = "",
		visibility	vis = VISIBILITY_DEFAULT )

Constructor of the typedef_decl type.

Parameters

name	the name of the typedef.
underlying_type	the underlying type of the typedef.
locus	the source location of the typedef declaration.
linkage_name	the mangled name of the typedef.
vis	the visibility of the typedef type.

Definition at line 20574 of file abg-ir.cc.

◆ typedef_decl() [2/2]

typedef_decl	(	const string &	name,
		const environment &	env,
		const location &	locus,
		const string &	mangled_name = "",
		visibility	vis = VISIBILITY_DEFAULT )

Constructor of the typedef_decl type.

Parameters

name	the name of the typedef.
env	the environment of the current typedef.
locus	the source location of the typedef declaration.
mangled_name	the mangled name of the typedef.
vis	the visibility of the typedef type.

Definition at line 20604 of file abg-ir.cc.

◆ ~typedef_decl()

~typedef_decl ( )

virtual

Definition at line 20855 of file abg-ir.cc.

Member Function Documentation

◆ get_alignment_in_bits()

size_t get_alignment_in_bits ( ) const

virtual

Return the alignment of the typedef.

This function looks at the alignment of the underlying type and ensures that it's the same as the alignment of the typedef.

Returns: the size of the typedef.

Reimplemented from type_base.

Definition at line 20659 of file abg-ir.cc.

◆ get_pretty_representation()

string get_pretty_representation	(	bool	internal = false,
		bool	qualified_name = true ) const

virtual

Build a pretty representation for a typedef_decl.

Parameters

internal set to true if the call is intended to get a representation of the decl (or type) for the purpose of canonical type comparison. This is mainly used in the function type_base::get_canonical_type_for().

In other words if the argument for this parameter is true then the call is meant for internal use (for technical use inside the library itself), false otherwise. If you don't know what this is for, then set it to false.

Parameters

qualified_name if true, names emitted in the pretty representation are fully qualified.

Returns: a copy of the pretty representation of the current instance of typedef_decl.

Implements type_or_decl_base.

Definition at line 20763 of file abg-ir.cc.

◆ get_qualified_name() [1/2]

const interned_string & get_qualified_name ( bool internal = false ) const

virtual

Implementation of the virtual "get_qualified_name" method.

Parameters

internal if true, then it means the qualified name is for "internal" purposes, meaning mainly for type canonicalization purposes.

Returns: the qualified name.

Reimplemented from decl_base.

Definition at line 20814 of file abg-ir.cc.

◆ get_qualified_name() [2/2]

void get_qualified_name	(	interned_string &	qualified_name,
		bool	internal = false ) const

virtual

Implementation of the virtual "get_qualified_name" method.

Parameters

qualified_name	the resuling qualified name of the typedef type.
internal	if true, then it means the qualified name is for "internal" purposes, meaning mainly for type canonicalization purposes.

Reimplemented from decl_base.

Definition at line 20802 of file abg-ir.cc.

◆ get_size_in_bits()

size_t get_size_in_bits ( ) const

virtual

Return the size of the typedef.

This function looks at the size of the underlying type and ensures that it's the same as the size of the typedef.

Returns: the size of the typedef.

Reimplemented from type_base.

Definition at line 20642 of file abg-ir.cc.

◆ get_underlying_type()

type_base_sptr get_underlying_type ( ) const

Getter of the underlying type of the typedef.

Returns: the underlying_type.

Definition at line 20780 of file abg-ir.cc.

◆ hash_value()

hash_t hash_value ( ) const

virtual

Return the hash value of the current IR node.

Note that upon the first invocation, this member functions computes the hash value and returns it. Subsequent invocations just return the hash value that was previously calculated.

Returns: the hash value of the current IR node.

Reimplemented from type_base.

Definition at line 20629 of file abg-ir.cc.

◆ operator==() [1/2]

bool operator== ( const decl_base & o ) const

virtual

Equality operator.

Parameters

o	the other typedef_decl to test against.

Reimplemented from decl_base.

Definition at line 20722 of file abg-ir.cc.

◆ operator==() [2/2]

bool operator== ( const type_base & o ) const

virtual

Equality operator.

Parameters

o	the other typedef_decl to test against.

Returns: true if the current instance of typedef_decl equals o.

Reimplemented from type_base.

Definition at line 20737 of file abg-ir.cc.

◆ set_underlying_type()

void set_underlying_type ( const type_base_sptr & t )

Setter ofthe underlying type of the typedef.

Parameters

t	the new underlying type of the typedef.

Definition at line 20787 of file abg-ir.cc.

◆ traverse()

bool traverse ( ir_node_visitor & v )

virtual

This implements the ir_traversable_base::traverse pure virtual function.

Parameters

v	the visitor used on the current instance.

Returns: true if the entire IR node tree got traversed, false otherwise.

Reimplemented from type_base.

Definition at line 20834 of file abg-ir.cc.

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

/home/dodji/git/libabigail/master/include/abg-ir.h
/home/dodji/git/libabigail/master/src/abg-ir.cc

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ typedef_decl() [1/2]

◆ typedef_decl() [2/2]

◆ ~typedef_decl()

Member Function Documentation

◆ get_alignment_in_bits()

◆ get_pretty_representation()

◆ get_qualified_name() [1/2]

◆ get_qualified_name() [2/2]

◆ get_size_in_bits()

◆ get_underlying_type()

◆ hash_value()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ set_underlying_type()

◆ traverse()