The abstraction of a diff between two pointers. More...

#include <abg-comparison.h>

Inheritance diagram for pointer_diff:

Classes
struct	priv
	The internal type for the impl idiom implementation of pointer_diff. More...

Public Member Functions
virtual void	chain_into_hierarchy ()
	Populate the vector of children node of the diff base type sub-object of this instance of pointer_diff.

const pointer_type_def_sptr	first_pointer () const
	Getter for the first subject of a pointer diff.

virtual const string &	get_pretty_representation () const

virtual bool	has_changes () const
	Return true iff the current diff node carries a change.

virtual enum change_kind	has_local_changes () const

virtual void	report (ostream &, const string &indent="") const
	Report the diff in a serialized form.

const pointer_type_def_sptr	second_pointer () const
	Getter for the second subject of a pointer diff.

diff_sptr	underlying_type_diff () const
	Getter for the diff between the pointed-to types of the pointers of this diff.

void	underlying_type_diff (const diff_sptr)
	Setter for the diff between the pointed-to types of the pointers of this diff.

Public Member Functions inherited from type_diff_base
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.

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.

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.

void	append_child_node (diff_sptr)
	Add a new child node to the vector of children nodes for the current diff node.

const vector< diff * > &	children_nodes () const
	Getter for the children nodes of the current diff node.

const diff_context_sptr	context () const
	Getter of the context of the current diff.

void	context (diff_context_sptr c)
	Setter of the context of the current diff.

bool	currently_reporting () const
	Tests if we are currently in the middle of emitting a report for this diff.

void	currently_reporting (bool f) const
	Sets a flag saying if we are currently in the middle of emitting a report for this diff.

type_or_decl_base_sptr	first_subject () const
	Getter of the first subject of the diff.

diff *	get_canonical_diff () const
	Getter for the canonical diff of the current instance of diff.

diff_category	get_category () const
	Getter for the category of the current diff tree node.

diff_category	get_class_of_equiv_category () const
	Getter of the category of the class of equivalence of the current diff tree node.

diff_category	get_local_category () const
	Getter for the local category of the current diff tree node.

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.

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.

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.

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.

bool	is_filtered_out () const
	Test if this diff tree node is to be filtered out for reporting purposes.

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.

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.

bool	is_suppressed () const
	Test if the current diff node has been suppressed by a user-provided suppression specification.

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.

bool	is_traversing () const
	Tell if a given node is being traversed or not.

const diff *	parent_node () const
	Getter for the parent node of the current diff node.

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.

diff_category	remove_from_local_category (diff_category c)
	Remove the current diff tree node from the categories resulting from the local changes.

bool	reported_once () const
	Tests if a report has already been emitted for the current diff.

void	reported_once (bool f) const
	Sets a flag saying if a report has already been emitted for the current diff.

type_or_decl_base_sptr	second_subject () const
	Getter of the second subject of the diff.

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.

void	set_local_category (diff_category c)
	Set the local category of the current diff node.

bool	to_be_reported () const
	Test if this diff tree node should be reported.

virtual bool	traverse (diff_node_visitor &v)
	The generic traversing code that walks a given diff sub-tree.

Public Member Functions inherited from diff_traversable_base
Public Member Functions inherited from traversable_base
virtual	~traversable_base ()
	Destructor of the traversable_base type.

Protected Member Functions
	pointer_diff (pointer_type_def_sptr first, pointer_type_def_sptr second, diff_sptr underlying_type_diff, diff_context_sptr ctxt=diff_context_sptr())
	Constructor for a pointer_diff.

Protected Member Functions inherited from type_diff_base
	type_diff_base (type_base_sptr first_subject, type_base_sptr second_subject, diff_context_sptr ctxt)

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.

	diff (type_or_decl_base_sptr first_subject, type_or_decl_base_sptr second_subject, diff_context_sptr ctxt)
	Constructor for the diff type.

void	begin_traversing ()
	Flag a given diff node as being traversed.

bool	do_log () const
	Test if logging was requested.

void	do_log (bool)
	Request logging (or not)

void	end_traversing ()
	Flag a given diff node as not being traversed anymore.

virtual void	finish_diff_type ()
	Finish the insertion of a diff tree node into the diff graph.

void	set_canonical_diff (diff *)
	Setter for the canonical diff of the current instance of diff.

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.

Friends
pointer_diff_sptr	compute_diff (pointer_type_def_sptr first, pointer_type_def_sptr second, diff_context_sptr ctxt)
	Compute the diff between between two pointers.

Additional Inherited Members
Protected Attributes inherited from diff
std::unique_ptr< priv >	priv_

Detailed Description

The abstraction of a diff between two pointers.

Definition at line 1318 of file abg-comparison.h.

Constructor & Destructor Documentation

◆ pointer_diff()

pointer_diff	(	pointer_type_def_sptr	first,
		pointer_type_def_sptr	second,
		diff_sptr	underlying,
		diff_context_sptr	ctxt = diff_context_sptr() )

protected

Constructor for a pointer_diff.

Parameters

first	the first pointer to consider for the diff.
second	the secon pointer to consider for the diff.
ctxt	the diff context to use.

Definition at line 3696 of file abg-comparison.cc.

Member Function Documentation

◆ chain_into_hierarchy()

void chain_into_hierarchy ( )

virtual

Populate the vector of children node of the diff base type sub-object of this instance of pointer_diff.

The children node can then later be retrieved using diff::children_node().

Reimplemented from diff.

Definition at line 3686 of file abg-comparison.cc.

◆ first_pointer()

const pointer_type_def_sptr first_pointer ( ) const

Getter for the first subject of a pointer diff.

Returns: the first pointer considered in this pointer diff.

Definition at line 3708 of file abg-comparison.cc.

◆ get_pretty_representation()

const string & get_pretty_representation ( ) const

virtual

Returns: the pretty represenation for the current instance of pointer_diff.

Reimplemented from diff.

Definition at line 3721 of file abg-comparison.cc.

◆ has_changes()

bool has_changes ( ) const

virtual

Return true iff the current diff node carries a change.

Returns: true iff the current diff node carries a change.

Implements diff.

Definition at line 3740 of file abg-comparison.cc.

◆ has_local_changes()

enum change_kind has_local_changes ( ) const

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.

Implements type_diff_base.

Definition at line 3747 of file abg-comparison.cc.

◆ report()

void report	(	ostream &	out,
		const string &	indent = "" ) const

virtual

Report the diff in a serialized form.

Parameters

out	the stream to serialize the diff to.
indent	the prefix to use for the indentation of this serialization.

Implements diff.

Definition at line 3779 of file abg-comparison.cc.

◆ second_pointer()

const pointer_type_def_sptr second_pointer ( ) const

Getter for the second subject of a pointer diff.

Returns: the second pointer considered in this pointer diff.

Definition at line 3715 of file abg-comparison.cc.

◆ underlying_type_diff() [1/2]

diff_sptr underlying_type_diff ( ) const

Getter for the diff between the pointed-to types of the pointers of this diff.

Returns: the diff between the pointed-to types.

Definition at line 3760 of file abg-comparison.cc.

◆ underlying_type_diff() [2/2]

void underlying_type_diff ( const diff_sptr d )

Setter for the diff between the pointed-to types of the pointers of this diff.

Parameters

d	the new diff between the pointed-to types of the pointers of this diff.

Definition at line 3769 of file abg-comparison.cc.

Friends And Related Symbol Documentation

◆ compute_diff

pointer_diff_sptr compute_diff	(	pointer_type_def_sptr	first,
		pointer_type_def_sptr	second,
		diff_context_sptr	ctxt )

friend

Compute the diff between between two pointers.

Note that the two types must have been created in the same environment, otherwise, this function aborts.

Parameters

first	the pointer to consider for the diff.
second	the pointer to consider for the diff.

Returns: the resulting diff between the two pointers.

Parameters

ctxt	the diff context to use.

Definition at line 3797 of file abg-comparison.cc.

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

/home/dodji/git/libabigail/master/include/abg-comparison.h
/home/dodji/git/libabigail/master/src/abg-comparison.cc

Classes

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pointer_diff()

Member Function Documentation

◆ chain_into_hierarchy()

◆ first_pointer()

◆ get_pretty_representation()

◆ has_changes()

◆ has_local_changes()

◆ report()

◆ second_pointer()

◆ underlying_type_diff() [1/2]

◆ underlying_type_diff() [2/2]

Friends And Related Symbol Documentation

◆ compute_diff