An abstraction of a diff between two translation units. More...
#include <abg-comparison.h>
Inheritance diagram for translation_unit_diff:
Classes | |
| struct | priv |
Public Member Functions | |
| const translation_unit_sptr | first_translation_unit () const |
| Getter for the first translation unit of this diff. More... | |
| virtual bool | has_changes () const |
| Return true iff the current diff node carries a change. More... | |
| virtual enum change_kind | has_local_changes () const |
| virtual void | report (ostream &out, const string &indent="") const |
| Report the diff in a serialized form. More... | |
| const translation_unit_sptr | second_translation_unit () const |
| Getter for the second translation unit of this diff. More... | |
 Public Member Functions inherited from scope_diff | |
| const string_decl_base_sptr_map & | added_decls () const |
| const string_decl_base_sptr_map & | added_types () const |
| virtual void | chain_into_hierarchy () |
| Populate the vector of children node of the diff base type sub-object of this instance of scope_diff. More... | |
| const diff_sptrs_type & | changed_decls () const |
| const diff_sptrs_type & | changed_types () const |
| const decl_base_sptr | deleted_member_at (unsigned index) const |
| Accessor that eases the manipulation of the edit script associated to this instance. It returns the scope member that is reported (in the edit script) as deleted at a given index. More... | |
| const decl_base_sptr | deleted_member_at (vector< deletion >::const_iterator) const |
| Accessor that eases the manipulation of the edit script associated to this instance. It returns the scope member (of the first scope of this diff instance) that is reported (in the edit script) as deleted at a given iterator. More... | |
| const scope_decl_sptr | first_scope () const |
| Getter for the first scope of the diff. More... | |
| virtual const string & | get_pretty_representation () const |
| virtual bool | has_changes () const |
| Return true iff the current diff node carries a change. More... | |
| virtual enum change_kind | has_local_changes () const |
| const decl_base_sptr | inserted_member_at (unsigned i) |
| Accessor that eases the manipulation of the edit script associated to this instance. It returns the scope member (of the second scope of this diff instance) that is reported as being inserted from a given index. More... | |
| const decl_base_sptr | inserted_member_at (vector< unsigned >::const_iterator i) |
| Accessor that eases the manipulation of the edit script associated to this instance. It returns the scope member (of the second scope of this diff instance) that is reported as being inserted from a given iterator. More... | |
| edit_script & | member_changes () |
| Accessor of the edit script of the members of a scope. More... | |
| const edit_script & | member_changes () const |
| Accessor of the edit script of the members of a scope. More... | |
| const string_decl_base_sptr_map & | removed_decls () const |
| const string_decl_base_sptr_map & | removed_types () const |
| virtual void | report (ostream &out, const string &indent="") const |
| Report the changes of one scope against another. More... | |
| const scope_decl_sptr | second_scope () const |
| Getter for the second scope of the diff. More... | |
| Public Member Functions inherited from diff | |
| diff_category | add_to_category (diff_category c) |
| Adds the current diff tree node to an additional set of categories. Note that the categories include thoses inherited from the children nodes of this diff node. More... | |
| void | add_to_local_and_inherited_categories (diff_category c) |
| Adds the current diff tree node to the categories resulting from the local and inherited changes of the current diff node. More... | |
| diff_category | add_to_local_category (diff_category c) |
| Adds the current diff tree node to the categories resulting from the local changes of the current diff node. More... | |
| void | append_child_node (diff_sptr) |
| Add a new child node to the vector of children nodes for the current diff node. More... | |
| virtual void | chain_into_hierarchy () |
| This constructs the relation between this diff node and its detail diff nodes, in the generic view of the diff node. More... | |
| const vector< diff * > & | children_nodes () const |
| Getter for the children nodes of the current diff node. More... | |
| const diff_context_sptr | context () const |
| Getter of the context of the current diff. More... | |
| void | context (diff_context_sptr c) |
| Setter of the context of the current diff. More... | |
| bool | currently_reporting () const |
| Tests if we are currently in the middle of emitting a report for this diff. More... | |
| void | currently_reporting (bool f) const |
| Sets a flag saying if we are currently in the middle of emitting a report for this diff. More... | |
| type_or_decl_base_sptr | first_subject () const |
| Getter of the first subject of the diff. More... | |
| diff * | get_canonical_diff () const |
| Getter for the canonical diff of the current instance of diff. More... | |
| diff_category | get_category () const |
| Getter for the category of the current diff tree node. More... | |
| diff_category | get_class_of_equiv_category () const |
| Getter of the category of the class of equivalence of the current diff tree node. More... | |
| diff_category | get_local_category () const |
| Getter for the local category of the current diff tree node. More... | |
| virtual const string & | get_pretty_representation () const |
| Get a pretty representation of the current diff node. More... | |
| virtual bool | has_changes () const =0 |
| Pure interface to get the length of the changes encapsulated by this diff. A length of zero means that the current instance of diff doesn't carry any change. More... | |
| bool | has_descendant_allowed_by_specific_negated_suppression () const |
| Test if the current diff node has a descendant node which is specifically allowed by a negated suppression specification. More... | |
| virtual enum change_kind | has_local_changes () const =0 |
| Pure interface to know if the current instance of @diff carries a local change. A local change is a change that is on the diff object itself, as opposed to a change that is carried by some of its children nodes. More... | |
| bool | has_local_changes_to_be_reported () const |
| Test if this diff tree node should be reported when considering the categories that were *NOT* inherited from its children nodes. More... | |
| bool | has_parent_allowed_by_specific_negated_suppression () const |
| Test if the current diff node has a parent node which is specifically allowed by a negated suppression specification. More... | |
| bool | is_allowed_by_specific_negated_suppression () const |
| Test if this diff node is allowed (prevented from being suppressed) by at least one negated suppression specification. More... | |
| bool | is_categorized_as_suppressed () const |
| Test if the current diff node has been suppressed by a suppression specification or it has been categorized as suppressed due to category propagation. More... | |
| bool | is_filtered_out () const |
| Test if this diff tree node is to be filtered out for reporting purposes. More... | |
| bool | is_filtered_out_without_looking_at_allowed_changes () const |
| Test if this diff tree node is to be filtered out for reporting purposes, but without considering the categories that can /force/ the node to be unfiltered. More... | |
| bool | is_filtered_out_wrt_non_inherited_categories () const |
| Test if this diff tree node is to be filtered out for reporting purposes, but by considering only the categories that were *NOT* inherited from its children nodes. More... | |
| bool | is_suppressed () const |
| Test if the current diff node has been suppressed by a user-provided suppression specification. More... | |
| bool | is_suppressed (bool &is_private_type) const |
| Test if the current diff node has been suppressed by a user-provided suppression specification or by an auto-generated "private type" suppression specification. More... | |
| bool | is_traversing () const |
| Tell if a given node is being traversed or not. More... | |
| const diff * | parent_node () const |
| Getter for the parent node of the current diff node. More... | |
| diff_category | remove_from_category (diff_category c) |
| Remove the current diff tree node from an a existing sef of categories. The categories include those inherited from the children nodes of the current diff node. More... | |
| diff_category | remove_from_local_category (diff_category c) |
| Remove the current diff tree node from the categories resulting from the local changes. More... | |
| virtual void | report (ostream &out, const string &indent="") const =0 |
| Pure interface to report the diff in a serialized form that is legible for the user. More... | |
| bool | reported_once () const |
| Tests if a report has already been emitted for the current diff. More... | |
| void | reported_once (bool f) const |
| Sets a flag saying if a report has already been emitted for the current diff. More... | |
| type_or_decl_base_sptr | second_subject () const |
| Getter of the second subject of the diff. More... | |
| void | set_category (diff_category c) |
| Set the category of the current diff node. This category includes the categories inherited from the children nodes of the current diff node. More... | |
| void | set_local_category (diff_category c) |
| Set the local category of the current diff node. More... | |
| bool | to_be_reported () const |
| Test if this diff tree node should be reported. More... | |
| virtual bool | traverse (diff_node_visitor &v) |
| The generic traversing code that walks a given diff sub-tree. More... | |
| virtual bool | traverse (diff_node_visitor &v) |
| The default traverse function. More... | |
| Public Member Functions inherited from traversable_base | |
| virtual | ~traversable_base () |
| Destructor of the traversable_base type. More... | |
Protected Member Functions | |
| translation_unit_diff (translation_unit_sptr first, translation_unit_sptr second, diff_context_sptr ctxt=diff_context_sptr()) | |
| Constructor for translation_unit_diff. More... | |
| Protected Member Functions inherited from scope_diff | |
| scope_diff (scope_decl_sptr first_scope, scope_decl_sptr second_scope, diff_context_sptr ctxt=diff_context_sptr()) | |
| Constructor for scope_diff. More... | |
| Protected Member Functions inherited from diff | |
| diff (type_or_decl_base_sptr first_subject, type_or_decl_base_sptr second_subject) | |
| Constructor for the diff type. More... | |
| diff (type_or_decl_base_sptr first_subject, type_or_decl_base_sptr second_subject, diff_context_sptr ctxt) | |
| Constructor for the diff type. More... | |
| void | begin_traversing () |
| Flag a given diff node as being traversed. More... | |
| bool | do_log () const |
| Test if logging was requested. More... | |
| void | do_log (bool) |
| Request logging (or not) More... | |
| void | end_traversing () |
| Flag a given diff node as not being traversed anymore. More... | |
| virtual void | finish_diff_type () |
| Finish the insertion of a diff tree node into the diff graph. More... | |
| void | set_canonical_diff (diff *) |
| Setter for the canonical diff of the current instance of diff. 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... | |
Friends | |
| translation_unit_diff_sptr | compute_diff (const translation_unit_sptr first, const translation_unit_sptr second, diff_context_sptr ctxt) |
| Compute the diff between two translation_units. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from diff | |
| std::unique_ptr< priv > | priv_ |
Detailed Description
An abstraction of a diff between two translation units.
Definition at line 2446 of file abg-comparison.h.
Constructor & Destructor Documentation
◆ translation_unit_diff()
|
protected |
Constructor for translation_unit_diff.
- Parameters
-
first the first translation unit to consider for this diff. second the second translation unit to consider for this diff. ctxt the context of the diff. Note that this context object must stay alive at least during the life time of the current instance of translation_unit_diff. Otherwise memory corruption issues occur.
Definition at line 8423 of file abg-comparison.cc.
Member Function Documentation
◆ first_translation_unit()
| const translation_unit_sptr first_translation_unit | ( | ) | const |
Getter for the first translation unit of this diff.
- Returns
- the first translation unit of this diff.
Definition at line 8435 of file abg-comparison.cc.
◆ has_changes()
|
virtual |
Return true iff the current diff node carries a change.
- Returns
- true iff the current diff node carries a change.
Reimplemented from scope_diff.
Definition at line 8449 of file abg-comparison.cc.
◆ has_local_changes()
|
virtual |
- Returns
- the kind of local change carried by the current diff node. The value returned is zero if the current node carries no local change.
Reimplemented from scope_diff.
Definition at line 8456 of file abg-comparison.cc.
◆ report()
|
virtual |
Report the diff in a serialized form.
- Parameters
-
out the output stream to serialize the report to. indent the prefix to use as indentation for the report.
Reimplemented from scope_diff.
Definition at line 8465 of file abg-comparison.cc.
◆ second_translation_unit()
| const translation_unit_sptr second_translation_unit | ( | ) | const |
Getter for the second translation unit of this diff.
- Returns
- the second translation unit of this diff.
Definition at line 8442 of file abg-comparison.cc.
Friends And Related Function Documentation
◆ compute_diff
|
friend |
Compute the diff between two translation_units.
Note that the two translation units must have been created in the same environment, otherwise, this function aborts.
- Parameters
-
first the first translation_unit to consider. second the second translation_unit to consider. ctxt the diff context to use. If null, this function will create a new context and set to the diff object returned.
- Returns
- the newly created diff object.
Definition at line 8482 of file abg-comparison.cc.
The documentation for this class was generated from the following files:
- /home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/include/abg-comparison.h
- /home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/src/abg-comparison.cc
