libabigail
Classes | Public Types | Public Member Functions | Friends | List of all members
enum_type_decl Class Reference

Abstracts a declaration for an enum type. More...

#include <abg-ir.h>

Inheritance diagram for enum_type_decl:
[legend]

Classes

class  enumerator
 The abstraction of an enumerator. More...
 

Public Types

typedef std::vector< enumeratorenumerators
 Convenience typedef for a list of enumerator. 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 Member Functions

 enum_type_decl (const string &name, const location &locus, type_base_sptr underlying_type, enumerators &enms, const string &mangled_name="", visibility vis=VISIBILITY_DEFAULT)
 Constructor of an enum type declaration. More...
 
virtual ~enum_type_decl ()
 Destructor for the enum type declaration. More...
 
enumeratorsget_enumerators ()
 
const enumeratorsget_enumerators () const
 
virtual string get_pretty_representation (bool internal=false, bool qualified_name=true) const
 Get the pretty representation of the current instance of enum_type_decl. More...
 
const enumeratorsget_sorted_enumerators () const
 Get the lexicographically sorted vector of enumerators. More...
 
type_base_sptr get_underlying_type () const
 Return the underlying type of the enum. More...
 
virtual bool operator== (const decl_base &) const
 Equality operator. More...
 
virtual bool operator== (const type_base &) const
 Equality operator. More...
 
virtual bool traverse (ir_node_visitor &v)
 This implements the ir_traversable_base::traverse pure virtual function. More...
 
- Public Member Functions inherited from type_base
 type_base (const environment &e, size_t s, size_t a)
 The constructor of type_base. More...
 
virtual size_t get_alignment_in_bits () const
 Getter for the alignment of the type. More...
 
const interned_stringget_cached_pretty_representation (bool internal=false) const
 Get the pretty representation of the current type. More...
 
type_base_sptr get_canonical_type () const
 Getter of the canonical type of the current instance of type_base. More...
 
type_baseget_naked_canonical_type () const
 Getter of the canonical type pointer. More...
 
virtual size_t get_size_in_bits () const
 Getter for the size of the type. More...
 
virtual bool operator!= (const type_base &) const
 Inequality operator. More...
 
virtual void set_alignment_in_bits (size_t)
 Setter for the alignment of the type. More...
 
virtual void set_size_in_bits (size_t)
 Setter for the size of the type. 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 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...
 
virtual size_t get_hash () const
 Get the hash of a decl. If the hash hasn't been computed yet, compute it ans store its value; otherwise, just return the hash. 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 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...
 

Friends

bool enum_has_non_name_change (const enum_type_decl &l, const enum_type_decl &r, change_kind *k)
 Test if two enums differ, but not by a name change. More...
 

Additional Inherited Members

- Public Attributes inherited from type_base
privpriv_
 
- 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 , 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...
 
- 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. 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 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...
 

Detailed Description

Abstracts a declaration for an enum type.

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

Member Typedef Documentation

◆ enumerators

typedef std::vector<enumerator> enumerators

Convenience typedef for a list of enumerator.

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

Constructor & Destructor Documentation

◆ enum_type_decl()

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

Constructor of an enum type declaration.

Constructor.

Parameters
namethe name of the enum
locusthe locus at which the enum appears in the source code.
underlying_typethe underlying type of the enum
enmsa list of enumerators for this enum.
mangled_namethe mangled name of the enum type.
visthe visibility of instances of this type.
namethe name of the type declaration.
locusthe source location where the type was defined.
underlying_typethe underlying type of the enum.
enumsthe enumerators of this enum type.
linkage_namethe linkage name of the enum.
visthe visibility of the enum type.

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

◆ ~enum_type_decl()

~enum_type_decl ( )
virtual

Destructor for the enum type declaration.

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

Member Function Documentation

◆ get_enumerators() [1/2]

enum_type_decl::enumerators & get_enumerators ( )
Returns
the list of enumerators of the enum.

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

◆ get_enumerators() [2/2]

const enum_type_decl::enumerators & get_enumerators ( ) const
Returns
the list of enumerators of the enum.

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

◆ get_pretty_representation()

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

Get the pretty representation of the current instance of enum_type_decl.

Parameters
internalset 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_nameif true, names emitted in the pretty representation are fully qualified.
Returns
the pretty representation of the enum type.

Reimplemented from decl_base.

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

◆ get_sorted_enumerators()

const enum_type_decl::enumerators & get_sorted_enumerators ( ) const

Get the lexicographically sorted vector of enumerators.

Returns
the lexicographically sorted vector of enumerators.

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

◆ get_underlying_type()

type_base_sptr get_underlying_type ( ) const

Return the underlying type of the enum.

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

◆ operator==() [1/2]

bool operator== ( const decl_base o) const
virtual

Equality operator.

Parameters
othe other enum to test against.
Returns
true iff o equals the current instance of enum type decl.

Reimplemented from decl_base.

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

◆ operator==() [2/2]

bool operator== ( const type_base o) const
virtual

Equality operator.

Parameters
othe other enum to test against.
Returns
true iff o is equals the current instance of enum type decl.

Reimplemented from type_base.

Definition at line 20197 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.
Returns
true if the entire IR node tree got traversed, false otherwise.

Reimplemented from decl_base.

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

Friends And Related Function Documentation

◆ enum_has_non_name_change

bool enum_has_non_name_change ( const enum_type_decl l,
const enum_type_decl r,
change_kind k 
)
friend

Test if two enums differ, but not by a name change.

Parameters
lthe first enum to consider.
rthe second enum to consider.
Returns
true iff l differs from r by anything but a name change.

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


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