8 #ifndef __ABG_CORPUS_H__
9 #define __ABG_CORPUS_H__
46 ARTIFICIAL_ORIGIN = 0,
47 NATIVE_XML_ORIGIN = 1,
49 DWARF_ORIGIN = 1 << 2,
52 LINUX_KERNEL_BINARY_ORIGIN = 1 << 5
59 void init_format_version();
63 std::unique_ptr<priv> priv_;
111 const vector<type_base_wptr>&
144 const vector<string>&
171 const symtab_reader::symtab_sptr&
218 virtual const functions&
221 const std::unordered_set<function_decl*>*
227 virtual const variables&
242 const vector<string>&
248 const vector<string>&
254 const vector<string>&
260 const vector<string>&
266 const vector<string>&
272 const vector<string>&
278 exported_decls_builder_sptr
310 std::unique_ptr<priv> priv_;
330 std::unordered_set<function_decl*>*
355 std::unique_ptr<priv> priv_;
361 typedef vector<corpus_sptr> corpora_type;
407 unordered_set<interned_string, hash_interned_string>*
419 #endif //__ABG_CORPUS_H__
bool operator==(const std::string &l, const interned_string &r)
Equality operator.
const vector< type_base_wptr > & get_types_not_reachable_from_public_interfaces() const
Getter of a sorted vector of the types that are *NOT* reachable from public interfaces.
virtual bool recording_types_reachable_from_public_interface_supported()
Test if the recording of reachable types (and thus, indirectly, the recording of non-reachable types)...
virtual const string_elf_symbols_map_type & get_var_symbol_map() const
Getter for the variable symbols map.
void sort_functions()
Sort the set of functions exported by this corpus.
vector< string > & get_regex_patterns_of_fns_to_keep()
Accessor for the regex patterns describing the functions to keep into the public decl table...
virtual const elf_symbols & get_sorted_var_symbols() const
Getter for the sorted vector of variable symbols for this corpus.
void set_path(const string &)
Set the file path associated to the corpus file.
const elf_symbols & get_sorted_undefined_fun_symbols() const
Getter for a sorted vector of the function symbols undefined in this corpus.
string & get_format_minor_version_number() const
Getter of the minor version number of the abixml serialization format.
void set_needed(const vector< string > &)
Setter of the needed property of the corpus.
bool operator==(const corpus &) const
Compare the current corpus against another one.
An abstraction helper for type declarations.
virtual const elf_symbols & get_unreferenced_variable_symbols() const
Get the set of variable symbols not referenced by any debug info, from all the corpora of the current...
virtual const elf_symbols & get_sorted_fun_symbols() const
Get a sorted vector of the symbols of the functions exported by the corpora of the current group...
void set_architecture_name(const string &)
Setter for the architecture name of the corpus.
type_maps & get_types()
Get the maps that associate a name to a certain kind of type.
This is the abstraction of a set of translation units (themselves seen as bundles of unitary abi arte...
const translation_units & get_translation_units() const
Return the list of translation units of the current corpus.
virtual const variables & get_variables() const
Return the public decl table of the global variables of the current corpus.
void set_format_minor_version_number(const string &)
Setter of the minor version number of the abixml serialization format.
virtual const functions & get_functions() const
Return the functions public decl table of the current corpus.
const functions & exported_functions() const
Getter for the reference to the vector of exported functions. This vector is shared with with the cor...
std::set< translation_unit_sptr, shared_translation_unit_comp > translation_units
Convenience typedef for an ordered set of translation_unit_sptr.
vector< string > & get_regex_patterns_of_vars_to_keep()
Accessor for the regex patterns describing the variables to keep into the public decl table...
virtual const corpus::functions & get_functions() const
Get the functions exported by the corpora of the current corpus group.
void maybe_add_var_to_exported_vars(const var_decl *)
Consider at all the tunables that control wether a variable should be added to the set of exported va...
void sort_variables()
Sort the set of variables exported by this corpus.
virtual const corpus::variables & get_variables() const
Get the global variables exported by the corpora of the current corpus group.
const translation_unit_sptr find_translation_unit(const string &path) const
Find the translation unit that has a given path.
shared_ptr< translation_unit > translation_unit_sptr
Convenience typedef for a shared pointer on a translation_unit type.
vector< string > & get_sym_ids_of_vars_to_keep()
Getter for the vector of variable symbol IDs to keep.
void set_soname(const string &)
Setter for the soname property of the corpus.
string & get_format_major_version_number() const
Getter of the major version number of the abixml serialization format.
const corpora_type & get_corpora() const
Getter of the vector of corpora held by the current corpus_group.
void maybe_add_fn_to_exported_fns(function_decl *)
Consider at all the tunables that control wether a function should be added to the set of exported fu...
Abstracts a variable declaration.
std::vector< elf_symbol_sptr > elf_symbols
Convenience typedef for a vector of elf_symbol.
const vector< string > & get_needed() const
Getter of the needed property of the corpus.
virtual const elf_symbols & get_sorted_fun_symbols() const
Return a sorted vector of function symbols for this corpus.
const elf_symbol_sptr lookup_variable_symbol(const string &n) const
Look in the variable symbols map for a symbol with a given name.
corpus::origin operator&=(corpus::origin &l, corpus::origin r)
Bitwise &= operator for the corpus::origin type.
type_maps & get_type_per_loc_map()
Get the maps that associate a location string to a certain kind of type.
virtual const elf_symbols & get_unreferenced_variable_symbols() const
Getter of the set of variable symbols that are not referenced by any variable exported by the current...
void maybe_drop_some_exported_decls()
After the set of exported functions and variables have been built, consider all the tunables that con...
Toplevel namespace for libabigail.
virtual const string_elf_symbols_map_type & get_var_symbol_map() const
Get the symbols of the global variables exported by the corpora of the current corpus_group.
std::unordered_map< string, elf_symbols > string_elf_symbols_map_type
Convenience typedef for a map which key is a string and which value is a vector of elf_symbol...
origin
This abstracts where the corpus comes from. That is, either it has been read from the native xml form...
unordered_set< interned_string, hash_interned_string > * get_public_types_pretty_representations()
Getter of a pointer to the set of types reachable from public interfaces of a given corpus group...
Abstraction for a function declaration.
virtual bool is_empty() const
Tests if the corpus is empty from an ABI surface perspective. I.e. if all of these criteria are true:...
void add_corpus(const corpus_sptr &)
Add a new corpus to the current instance of corpus_group.
Types of the main internal representation of libabigail.
const std::unordered_set< function_decl * > * lookup_functions(const string &id) const
Lookup the function which has a given function ID.
vector< string > strings_type
A convenience typedef for std::vector.
void add(const translation_unit_sptr &)
Add a translation unit to the current ABI Corpus.
The type of the private data of corpus::exported_decls_builder type.
This is a type that aggregates maps of all the kinds of types that are supported by libabigail...
const string_elf_symbols_map_type & get_undefined_var_symbol_map() const
Getter for the map of variable symbols that are undefined in this corpus.
Abstraction of an elf symbol.
This is an abstraction of the set of resources necessary to manage several aspects of the internal re...
virtual const string_elf_symbols_map_type & get_fun_symbol_map() const
Get the symbols of the global functions exported by the corpora of the current corpus_group.
const elf_symbol_sptr lookup_function_symbol(const string &n) const
Look in the function symbols map for a symbol with a given name.
virtual bool is_empty() const
Test if the current corpus group is empty.
void drop_translation_units()
Erase the translation units contained in this in-memory object.
shared_ptr< elf_symbol > elf_symbol_sptr
A convenience typedef for a shared pointer to elf_symbol.
exported_decls_builder_sptr get_exported_decls_builder() const
Getter for the object that is responsible for determining what decls ought to be in the set of export...
void record_type_as_reachable_from_public_interfaces(const type_base &)
Record a type as being reachable from public interfaces (global functions and variables).
vector< var_decl * > variables
Convenience typedef for std::vector
Abstracts the building of the set of exported variables and functions.
const symtab_reader::symtab_sptr & get_symtab() const
Getter for the symtab object.
string & get_path() const
Get the file path associated to the corpus file.
const corpus_sptr get_main_corpus() const
Getter of the first corpus added to this Group.
corpus::origin operator|(corpus::origin l, corpus::origin r)
Bitwise | operator for the corpus::origin type.
vector< string > & get_sym_ids_of_fns_to_keep()
Getter for the vector of function symbol IDs to keep.
const environment & get_environment() const
Getter of the enviroment of the corpus.
corpus::origin operator|=(corpus::origin &l, corpus::origin r)
Bitwise |= operator for the corpus::origin type.
vector< string > & get_regex_patterns_of_fns_to_suppress()
Accessor for the regex patterns describing the functions to drop from the public decl table...
std::unordered_set< function_decl * > * fn_id_maps_to_several_fns(function_decl *)
Test if a given function ID maps to several functions in the same corpus.
void set_origin(origin)
Setter for the origin of the corpus.
virtual const elf_symbols & get_sorted_var_symbols() const
Get a sorted vector of the symbols of the variables exported by the corpora of the current group...
vector< string > & get_regex_patterns_of_vars_to_suppress()
Accessor for the regex patterns describing the variables to drop from the public decl table...
void set_format_major_version_number(const string &)
Setter of the major version number of the abixml serialization format.
vector< function_decl * > functions
Convenience typedef for std::vector
bool type_is_reachable_from_public_interfaces(const type_base &) const
Test if a type is reachable from public interfaces (global functions and variables).
The abstraction of the version of an ELF symbol.
const corpus_group * get_group() const
Getter of the group this corpus is a member of.
Abstraction of a group of corpora.
const elf_symbols & get_sorted_undefined_var_symbols() const
Getter for a sorted vector of the variable symbols undefined in this corpus.
origin get_origin() const
Getter for the origin of the corpus.
const variables & exported_variables() const
Getter for the reference to the vector of exported variables. This vector is shared with with the cor...
virtual const elf_symbols & get_unreferenced_function_symbols() const
Getter of the set of function symbols that are not referenced by any function exported by the current...
const string & get_soname()
Getter for the soname property of the corpus.
corpus::origin operator&(corpus::origin l, corpus::origin r)
Bitwise & operator for the corpus::origin type.
void set_symtab(symtab_reader::symtab_sptr)
Setter for the symtab object.
virtual ~corpus_group()
Desctructor of the corpus_group type.
const string & get_architecture_name() const
Getter for the architecture name of the corpus.
virtual const string_elf_symbols_map_type & get_fun_symbol_map() const
Getter for the function symbols map.
bool has_corpus(const string &)
Test if a corpus of a given path has been added to the group.
virtual const elf_symbols & get_unreferenced_function_symbols() const
Get the set of function symbols not referenced by any debug info, from all the corpora of the current...
bool do_log() const
Test if logging was requested.
const string_elf_symbols_map_type & get_undefined_fun_symbol_map() const
Getter for the map of function symbols that are undefined in this corpus.
shared_ptr< exported_decls_builder > exported_decls_builder_sptr
Convenience typedef for shared_ptr.
virtual bool recording_types_reachable_from_public_interface_supported()
Test if the recording of reachable types (and thus, indirectly, the recording of non-reachable types)...