libabigail
Classes | Public Member Functions | List of all members
function_tdecl Class Reference

Abstract a function template declaration. More...

#include <abg-ir.h>

Inheritance diagram for function_tdecl:
[legend]

Classes

struct  hash
 
struct  shared_ptr_hash
 

Public Member Functions

 function_tdecl (const environment &env, const location &locus, visibility vis=VISIBILITY_DEFAULT, binding bind=BINDING_NONE)
 Constructor for a function template declaration. More...
 
 function_tdecl (function_decl_sptr pattern, const location &locus, visibility vis=VISIBILITY_DEFAULT, binding bind=BINDING_NONE)
 Constructor for a function template declaration. More...
 
binding get_binding () const
 Get the binding of the function template. More...
 
shared_ptr< function_declget_pattern () const
 Get the pattern of the function template. More...
 
virtual bool operator== (const decl_base &) const
 Comparison operator for the function_tdecl type. More...
 
virtual bool operator== (const function_tdecl &) const
 Comparison operator for the function_tdecl type. More...
 
virtual bool operator== (const template_decl &) const
 Comparison operator for the function_tdecl type. More...
 
void set_pattern (shared_ptr< function_decl > p)
 Set a new pattern to the function template. More...
 
virtual bool traverse (ir_node_visitor &v)
 This implements the ir_traversable_base::traverse pure virtual function. More...
 
- Public Member Functions inherited from template_decl
 template_decl (const environment &env, const string &name, const location &locus, visibility vis=VISIBILITY_DEFAULT)
 Constructor. More...
 
virtual ~template_decl ()
 Destructor. More...
 
void add_template_parameter (const template_parameter_sptr p)
 Add a new template parameter to the current instance of template_decl. More...
 
const std::list< template_parameter_sptr > & get_template_parameters () const
 Get the list of template parameters of the current instance of template_decl. More...
 
- Public Member Functions inherited from decl_base
 decl_base (const environment &, const location &)
 Constructor for the decl_base type. More...
 
 decl_base (const environment &e, const interned_string &name, const location &locus, const interned_string &mangled_name=interned_string(), visibility vis=VISIBILITY_DEFAULT)
 Constructor. More...
 
 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. More...
 
virtual ~decl_base ()
 Destructor of the decl_base type. More...
 
const decl_base_sptr get_definition_of_declaration () const
 If this decl_base is declaration-only, get its definition, if any. More...
 
const decl_base_sptr get_earlier_declaration () const
 If this decl_base is a definition, get its earlier declaration. More...
 
bool get_has_anonymous_parent () const
 Get the "has_anonymous_parent" flag of the current declaration. More...
 
bool get_is_anonymous () const
 Test if the current declaration is anonymous. More...
 
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. More...
 
bool get_is_in_public_symbol_table () const
 Test if the decl is defined in a ELF symbol table as a public symbol. More...
 
const interned_stringget_linkage_name () const
 Getter for the mangled name. More...
 
const locationget_location () const
 Get the location of a given declaration. More...
 
const decl_baseget_naked_definition_of_declaration () const
 If this decl_base is declaration-only, get its definition, if any. More...
 
const interned_stringget_name () const
 Getter for the name of the current decl. More...
 
typedef_decl_sptr get_naming_typedef () const
 Getter for the naming typedef of the current decl. More...
 
virtual string get_pretty_representation (bool internal=false, bool qualified_name=true) const
 Get the pretty representatin of the current declaration. More...
 
virtual const interned_stringget_qualified_name (bool internal=false) const
 Return the qualified name of the decl. More...
 
virtual void get_qualified_name (interned_string &qualified_name, bool internal=false) const
 Compute the qualified name of the decl. More...
 
const interned_stringget_qualified_parent_name () const
 Return a copy of the qualified name of the parent of the current decl. More...
 
scope_declget_scope () const
 Return the type containing the current decl, if any. More...
 
virtual const interned_stringget_scoped_name () const
 Return the scoped name of the decl. More...
 
visibility get_visibility () const
 Getter for the visibility of the decl. More...
 
virtual bool operator!= (const decl_base &) const
 Inequality operator. More...
 
void set_definition_of_declaration (const decl_base_sptr &)
 Set the definition of this declaration-only decl_base. More...
 
void set_earlier_declaration (const decl_base_sptr &)
 set the earlier declaration of this decl_base definition. More...
 
void set_is_anonymous (bool)
 Set the "is_anonymous" flag of the current declaration. More...
 
void set_is_declaration_only (bool f)
 Set a flag saying if the enum_type_decl is a declaration-only enum_type_decl. More...
 
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). More...
 
virtual void set_linkage_name (const string &m)
 Setter for the linkage name. More...
 
void set_location (const location &l)
 Set the location for a given declaration. More...
 
void set_name (const string &n)
 Setter for the name of the decl. More...
 
void set_naming_typedef (const typedef_decl_sptr &)
 Set the naming typedef of the current instance of decl_base. More...
 
virtual void set_scope (scope_decl *)
 Setter of the scope of the current decl. More...
 
void set_visibility (visibility v)
 Setter for the visibility of the decl. More...
 
- 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. More...
 
virtual ~type_or_decl_base ()
 The destructor of the type_or_decl_base type. More...
 
locationget_artificial_location () const
 Getter of the artificial location of the artifact. More...
 
corpusget_corpus ()
 Get the corpus this ABI artifact belongs to. More...
 
const corpusget_corpus () const
 Get the corpus this ABI artifact belongs to. More...
 
const environmentget_environment () const
 Getter of the environment of the current ABI artifact. More...
 
bool get_is_artificial () const
 Getter of the flag that says if the artefact is artificial. More...
 
translation_unitget_translation_unit ()
 Get the translation_unit this ABI artifact belongs to. More...
 
const translation_unitget_translation_unit () const
 Get the translation_unit this ABI artifact belongs to. More...
 
bool has_artificial_location () const
 Test if the current ABI artifact carries an artificial location. More...
 
void set_artificial_location (const location &)
 Setter of the artificial location of the artificat. More...
 
void set_is_artificial (bool)
 Setter of the flag that says if the artefact is artificial. More...
 
void set_translation_unit (translation_unit *)
 Set the translation_unit this ABI artifact belongs to. More...
 
- Public Member Functions inherited from traversable_base
virtual ~traversable_base ()
 Destructor of the traversable_base type. More...
 
- Public Member Functions inherited from scope_decl
 scope_decl (const environment &env, const string &name, const location &locus, visibility vis=VISIBILITY_DEFAULT)
 Constructor of the scope_decl type. More...
 
 scope_decl (const environment &env, location &l)
 Constructor of the scope_decl type. More...
 
void add_member_type (type_base_sptr t)
 Add a member type to the current instance of class_or_union. More...
 
type_base_sptr add_member_type (type_base_sptr t, access_specifier a)
 Add a member type to the current instance of class_or_union. More...
 
bool find_iterator_for_member (const decl_base *, declarations::iterator &)
 Find a member of the current scope and return an iterator on it. More...
 
bool find_iterator_for_member (const decl_base_sptr, declarations::iterator &)
 Find a member of the current scope and return an iterator on it. More...
 
type_base_sptr find_member_type (const string &name) const
 Find a member type of a given name, inside the current scope_decl. More...
 
canonical_type_sptr_set_typeget_canonical_types ()
 @eturn the set of canonical types of the the current scope. More...
 
const canonical_type_sptr_set_typeget_canonical_types () const
 @eturn the set of canonical types of the the current scope. More...
 
virtual size_t get_hash () const
 Return the hash value for the current instance of scope_decl. More...
 
declarationsget_member_decls ()
 Getter for the member declarations carried by the current scope_decl. More...
 
const declarationsget_member_decls () const
 Getter for the member declarations carried by the current scope_decl. More...
 
scopesget_member_scopes ()
 Getter for the scopes carried by the current scope. More...
 
const scopesget_member_scopes () const
 Getter for the scopes carried by the current scope. More...
 
const type_base_sptrs_typeget_member_types () const
 Get the member types of this scope_decl. More...
 
virtual size_t get_num_anonymous_member_classes () const
 Getter for the number of anonymous classes contained in this scope. More...
 
virtual size_t get_num_anonymous_member_enums () const
 Getter for the number of anonymous enums contained in this scope. More...
 
virtual size_t get_num_anonymous_member_unions () const
 Getter for the number of anonymous unions contained in this scope. More...
 
const type_base_sptrs_typeget_sorted_canonical_types () const
 Return a vector of sorted canonical types of the current scope. More...
 
const declarationsget_sorted_member_decls () const
 Getter for the sorted member declarations carried by the current scope_decl. More...
 
const type_base_sptrs_typeget_sorted_member_types () const
 Get the sorted member types of this scope_decl. More...
 
void insert_member_type (type_base_sptr t, declarations::iterator before)
 Insert a member type. More...
 
bool is_empty () const
 Test if the current scope is empty. More...
 
void remove_member_type (type_base_sptr t)
 Remove a member type from the current class_or_union scope. More...
 

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 scope_decl
typedef std::vector< decl_base_sptr > declarations
 Convenience typedef for a vector of decl_base_sptr. More...
 
typedef std::vector< function_type_sptrfunction_types
 Convenience typedef for a vector of function_type_sptr. More...
 
typedef std::vector< scope_decl_sptrscopes
 Convenience typedef for a vector of scope_decl_sptr. More...
 
- Public Attributes inherited from decl_base
priv * priv_
 
- Protected 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 , QUALIFIED_TYPE , POINTER_TYPE , REFERENCE_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...
 
- Protected Member Functions inherited from decl_base
 decl_base (const decl_base &)
 
void clear_qualified_name ()
 Clear the qualified name of this decl. More...
 
context_relget_context_rel ()
 Getter for the context relationship. More...
 
const context_relget_context_rel () const
 Getter for the context relationship. More...
 
const interned_stringpeek_qualified_name () const
 Getter for the qualified name. More...
 
const interned_stringpeek_temporary_qualified_name () const
 Getter of the temporary qualified name of the current declaration. More...
 
void set_context_rel (context_rel *c)
 
void set_qualified_name (const interned_string &) const
 Setter for the qualified name. More...
 
void set_temporary_qualified_name (const interned_string &) const
 Setter for the temporary qualified name of the current declaration. More...
 
- Protected Member Functions inherited from type_or_decl_base
bool hashing_started () const
 Getter for the 'hashing_started' property. More...
 
void hashing_started (bool) const
 Setter for the 'hashing_started' property. More...
 
enum type_or_decl_kind kind () const
 Getter for the "kind" property of type_or_decl_base type. More...
 
void kind (enum type_or_decl_kind)
 Setter for the "kind" property of type_or_decl_base type. More...
 
type_or_decl_baseoperator= (const type_or_decl_base &)
 
void * runtime_type_instance ()
 Getter of the pointer to the runtime type sub-object of the current instance. More...
 
const void * runtime_type_instance () const
 Getter of the pointer to the runtime type sub-object of the current instance. More...
 
void runtime_type_instance (void *)
 Setter of the pointer to the runtime type sub-object of the current instance. More...
 
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. More...
 
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. More...
 
- Protected Member Functions inherited from traversable_base
 traversable_base ()
 Default constructor of the traversable_base type. More...
 
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. More...
 
void visiting (bool f)
 The traversing code should be responsible of calling this, not the user code. More...
 
- Protected Member Functions inherited from scope_decl
virtual decl_base_sptr add_member_decl (const decl_base_sptr &member)
 Add a member decl to this scope. Note that user code should not use this, but rather use add_decl_to_scope. More...
 
decl_base_sptr insert_member_decl (decl_base_sptr member, declarations::iterator before)
 Insert a member decl to this scope, right before an element pointed to by a given iterator. Note that user code should not use this, but rather use insert_decl_into_scope. More...
 
virtual void remove_member_decl (decl_base_sptr member)
 Remove a declaration from the current scope. More...
 

Detailed Description

Abstract a function template declaration.

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

Constructor & Destructor Documentation

◆ function_tdecl() [1/2]

function_tdecl ( const environment env,
const location locus,
visibility  vis = VISIBILITY_DEFAULT,
binding  bind = BINDING_NONE 
)

Constructor for a function template declaration.

Parameters
envthe environment we are operating from.
locusthe location of the declaration.
visthe visibility of the declaration. This is the visibility the functions instantiated from this template are going to have.
bindthe binding of the declaration. This is the binding the functions instantiated from this template are going to have.

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

◆ function_tdecl() [2/2]

function_tdecl ( function_decl_sptr  pattern,
const location locus,
visibility  vis = VISIBILITY_DEFAULT,
binding  bind = BINDING_NONE 
)

Constructor for a function template declaration.

Parameters
patternthe pattern of the template.
locusthe location of the declaration.
visthe visibility of the declaration. This is the visibility the functions instantiated from this template are going to have.
bindthe binding of the declaration. This is the binding the functions instantiated from this template are going to have.

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

Member Function Documentation

◆ get_binding()

decl_base::binding get_binding ( ) const

Get the binding of the function template.

Returns
the binding

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

◆ get_pattern()

function_decl_sptr get_pattern ( ) const

Get the pattern of the function template.

Returns
the pattern.

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

◆ operator==() [1/3]

bool operator== ( const decl_base other) const
virtual

Comparison operator for the function_tdecl type.

Parameters
otherthe other instance of function_tdecl to compare against.
Returns
true iff the two instance are equal.

Reimplemented from scope_decl.

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

◆ operator==() [2/3]

bool operator== ( const function_tdecl o) const
virtual

Comparison operator for the function_tdecl type.

Parameters
othe other instance of function_tdecl to compare against.
Returns
true iff the two instance are equal.

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

◆ operator==() [3/3]

bool operator== ( const template_decl other) const
virtual

Comparison operator for the function_tdecl type.

Parameters
otherthe other instance of function_tdecl to compare against.
Returns
true iff the two instance are equal.

Reimplemented from template_decl.

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

◆ set_pattern()

void set_pattern ( shared_ptr< function_decl p)

Set a new pattern to the function template.

Parameters
pthe new pattern.

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

◆ traverse()

bool traverse ( ir_node_visitor v)
virtual

This implements the ir_traversable_base::traverse pure virtual function.

Parameters
vthe visitor used on the current instance and on the function pattern of the template.
Returns
true if the entire IR node tree got traversed, false otherwise.

Reimplemented from scope_decl.

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


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