Abstraction of a function parameter. More...

#include <abg-ir.h>

Inheritance diagram for function_decl::parameter:

Public Member Functions
	parameter (const type_base_sptr type, const string &name, const location &loc, bool variadic_marker=false, bool is_artificial=false)

	parameter (const type_base_sptr type, unsigned index, const string &name, const location &loc, bool variadic_marker, bool is_artificial)

	parameter (const type_base_sptr type, unsigned index, const string &name, const location &loc, bool variadic_marker=false)

	parameter (const type_base_sptr type, unsigned index=0, bool variadic_marker=false)

unsigned	get_index () const

interned_string	get_name_id () const
	Get a name uniquely identifying the parameter in the function.

virtual string	get_pretty_representation (bool internal=false, bool qualified_name=true) const
	Compute and return a copy of the pretty representation of the current function parameter.

virtual void	get_qualified_name (interned_string &qualified_name, bool internal=false) const
	Compute the qualified name of the parameter.

const type_base_sptr	get_type () const

interned_string	get_type_name () const

const string	get_type_pretty_representation () const

bool	get_variadic_marker () const

virtual bool	operator== (const decl_base &) const
	Return true iff the two decls have the same name.

bool	operator== (const parameter &o) const

void	set_index (unsigned i)

virtual bool	traverse (ir_node_visitor &v)
	Traverse the diff sub-tree under the current instance function_decl.

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.

virtual const interned_string &	get_qualified_name (bool internal=false) const
	Return the qualified name of the 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.

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.

Additional Inherited Members
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 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 Attributes inherited from decl_base
priv *	priv_

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

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.

Protected Member Functions inherited from type_or_decl_base
virtual hash_t	hash_value () const
	Return the hash value of the current IR node.

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.

Detailed Description

Abstraction of a function parameter.

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

Constructor & Destructor Documentation

◆ parameter() [1/4]

parameter	(	const type_base_sptr	type,
		unsigned	index,
		const string &	name,
		const location &	loc,
		bool	variadic_marker = false )

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

◆ parameter() [2/4]

parameter	(	const type_base_sptr	type,
		unsigned	index,
		const string &	name,
		const location &	loc,
		bool	variadic_marker,
		bool	is_artificial )

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

◆ parameter() [3/4]

parameter	(	const type_base_sptr	type,
		const string &	name,
		const location &	loc,
		bool	variadic_marker = false,
		bool	is_artificial = false )

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

◆ parameter() [4/4]

parameter	(	const type_base_sptr	type,
		unsigned	index = 0,
		bool	variadic_marker = false )

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

Member Function Documentation

◆ get_index()

unsigned get_index ( ) const

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

◆ get_name_id()

interned_string get_name_id ( ) const

Get a name uniquely identifying the parameter in the function.

Returns: the unique parm name id.

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

◆ get_pretty_representation()

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

virtual

Compute and return a copy of the pretty representation of the current function parameter.

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.

Returns: a copy of the textual representation of the current function parameter.

Reimplemented from decl_base.

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

◆ get_qualified_name()

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

virtual

Compute the qualified name of the parameter.

Parameters

internal	set to true if the call is intended for an 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.
qn	the resulting qualified name.

Reimplemented from decl_base.

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

◆ get_type()

const type_base_sptr get_type ( ) const

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

◆ get_type_name()

interned_string get_type_name ( ) const

Returns: a copy of the type name of the parameter.

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

◆ get_type_pretty_representation()

const string get_type_pretty_representation ( ) const

Returns: a copy of the pretty representation of the type of the parameter.

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

◆ get_variadic_marker()

bool get_variadic_marker ( ) const

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

◆ operator==() [1/2]

bool operator== ( const decl_base & other ) const

virtual

Return true iff the two decls have the same name.

This function doesn't test if the scopes of the the two decls are equal.

Note that this virtual function is to be implemented by classes that extend the decl_base class.

Reimplemented from decl_base.

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

◆ operator==() [2/2]

bool operator== ( const parameter & o ) const

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

◆ set_index()

void set_index ( unsigned i )

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

◆ traverse()

bool traverse ( ir_node_visitor & v )

virtual

Traverse the diff sub-tree under the current instance function_decl.

Parameters

v	the visitor to invoke on each diff node of the sub-tree.

Returns: true if the traversing has to keep going on, false otherwise.

Reimplemented from decl_base.

Definition at line 23200 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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ parameter() [1/4]

◆ parameter() [2/4]

◆ parameter() [3/4]

◆ parameter() [4/4]

Member Function Documentation

◆ get_index()

◆ get_name_id()

◆ get_pretty_representation()

◆ get_qualified_name()

◆ get_type()

◆ get_type_name()

◆ get_type_pretty_representation()

◆ get_variadic_marker()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ set_index()

◆ traverse()