The abstraction of a variable suppression specification. More...

#include <abg-suppression.h>

Inheritance diagram for variable_suppression:

Classes
struct	priv
	The type of the private data of the variable_suppression type. More...

Public Types
enum	change_kind { UNDEFINED_CHANGE_KIND , VARIABLE_SUBTYPE_CHANGE_KIND , ADDED_VARIABLE_CHANGE_KIND , DELETED_VARIABLE_CHANGE_KIND , ALL_CHANGE_KIND }
	The kind of change the current variable suppression should apply to. More...

Public Member Functions
	variable_suppression (const string &label="", const string &name="", const string &name_regex_str="", const string &symbol_name="", const string &symbol_name_regex_str="", const string &symbol_version="", const string &symbol_version_regex_str="", const string &type_name="", const string &type_name_regex_str="")
	Constructor for the variable_suppression type.

virtual	~variable_suppression ()
	Virtual destructor for the @erf variable_suppression type. variable_suppression type.

change_kind	get_change_kind () const
	Getter of the "change_king" property.

const string &	get_name () const
	Getter for the name of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

const string &	get_name_not_regex_str () const
	Getter for the "name_not_regexp" property of the specification.

const string &	get_name_regex_str () const
	Getter for the regular expression for a family of names of variables the user wants the current specification to designate. If the variable name as returned by variable_suppression::get_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

const string &	get_symbol_name () const
	Getter for the name of the symbol of the variable the user wants the current specification to designate.

const string &	get_symbol_name_not_regex_str () const
	Getter for a regular expression for a family of names of symbols of variables the user wants this specification to designate.

const string &	get_symbol_name_regex_str () const
	Getter of the regular expression for a family of symbol names of the variables this specification is about to designate.

const string &	get_symbol_version () const
	Getter for the version of the symbol of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

const string &	get_symbol_version_regex_str () const
	Getter of the regular expression for a family of versions of symbol for the variables the user wants the current specification to designate. If `symbol_version` is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

const string &	get_type_name () const
	Getter for the name of the type of the variable the user wants the current specification to designate.

const string &	get_type_name_regex_str () const
	Getter for the regular expression for a family of type names of variables the user wants the current specification to designate.

void	set_change_kind (change_kind k)
	Setter of the "change_kind" property.

void	set_name (const string &)
	Setter for the name of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

void	set_name_not_regex_str (const string &)
	Setter for the "name_not_regexp" property of the specification.

void	set_name_regex_str (const string &)
	Setter for the regular expression for a family of names of variables the user wants the current specification to designate. If the variable name as returned by variable_suppression::get_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

void	set_symbol_name (const string &)
	Setter for the name of the symbol of the variable the user wants the current specification to designate.

void	set_symbol_name_not_regex_str (const string &)
	Setter for a regular expression for a family of names of symbols of variables the user wants this specification to designate.

void	set_symbol_name_regex_str (const string &)
	Setter of the regular expression for a family of symbol names of the variables this specification is about to designate.

void	set_symbol_version (const string &)
	Setter for the version of the symbol of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

void	set_symbol_version_regex_str (const string &)
	Setter of the regular expression for a family of versions of symbol for the variables the user wants the current specification to designate. If `symbol_version` is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

void	set_type_name (const string &)
	Setter for the name of the type of the variable the user wants the current specification to designate.

void	set_type_name_regex_str (const string &)
	Setter for the regular expression for a family of type names of variables the user wants the current specification to designate.

bool	suppresses_diff (const diff *d) const
	Evaluate this suppression specification on a given diff node and say if the diff node should be suppressed or not.

bool	suppresses_variable (const var_decl *var, change_kind k, const diff_context_sptr cxt) const
	Evaluate the current variable suppression specification on a given var_decl and say if a report about a change involving this var_decl should be suppressed or not.

bool	suppresses_variable (const var_decl_sptr var, change_kind k, const diff_context_sptr cxt) const
	Evaluate the current variable suppression specification on a given var_decl and say if a report about a change involving this var_decl should be suppressed or not.

bool	suppresses_variable_symbol (const elf_symbol *sym, change_kind k, const diff_context_sptr cxt) const
	Evaluate the current variable suppression specification on a given elf_symbol and say if a report about a change involving this elf_symbol should be suppressed or not.

bool	suppresses_variable_symbol (const elf_symbol_sptr fn, change_kind k, const diff_context_sptr cxt) const
	Evaluate the current variable suppression specification on a given elf_symbol and say if a report about a change involving this elf_symbol should be suppressed or not.

Public Member Functions inherited from suppression_base
	suppression_base (const string &label)
	Constructor for suppression_base.

	suppression_base (const string &label, const string &file_name_regex_str, const string &file_name_not_regex_str)
	Constructor for suppression_base.

bool	get_drops_artifact_from_ir () const
	Tests if the current suppression specification is to avoid adding the matched ABI artifact to the internal representation or not.

const string &	get_file_name_not_regex_str () const
	Getter for the "file_name_not_regex" property of the current instance of suppression_base.

const string &	get_file_name_regex_str () const
	Getter for the "file_name_regex" property of the current instance of suppression_base.

bool	get_is_artificial () const
	Test is the suppression specification is artificial.

const string	get_label () const
	Getter for the label associated to this suppression specification.

const string &	get_soname_not_regex_str () const
	Getter of the "soname_not_regex_str property of the current instance of suppression_base.

const string &	get_soname_regex_str () const
	Getter of the "soname_regex_str property of the current instance of suppression_base.

bool	has_file_name_related_property () const
	Test if the current suppression has a property related to file name.

bool	has_soname_related_property () const
	Test if the current suppression has a property related to SONAMEs.

void	set_drops_artifact_from_ir (bool)
	Set the flag that says whether the current suppression specification is to avoid adding the matched ABI artifact to the internal representation or not.

void	set_file_name_not_regex_str (const string &regexp)
	Setter for the "file_name_not_regex" property of the current instance of suppression_base.

void	set_file_name_regex_str (const string &regexp)
	Setter for the "file_name_regex" property of the current instance of suppression_base.

void	set_is_artificial (bool)
	Set a flag saying if the suppression specification is artificial or not.

void	set_label (const string &)
	Setter for the label associated to this suppression specification.

void	set_soname_not_regex_str (const string &regexp)
	Setter of the "soname_not_regex_str property of the current instance of suppression_base.

void	set_soname_regex_str (const string &regexp)
	Setter of the "soname_regex_str property of the current instance of suppression_base.

Static Public Member Functions
static change_kind	parse_change_kind (const string &)
	Parses a string containing the content of the "change-kind" property and returns the an instance of variable_suppression::change_kind as a result.

Public Attributes
std::unique_ptr< priv >	priv_

Public Attributes inherited from suppression_base
std::unique_ptr< priv >	priv_

Detailed Description

The abstraction of a variable suppression specification.

It specifies under which condition reports about a var_diff diff node should be dropped on the floor for the purpose of reporting.

Definition at line 757 of file abg-suppression.h.

Member Enumeration Documentation

◆ change_kind

enum change_kind

The kind of change the current variable suppression should apply to.

Enumerator
VARIABLE_SUBTYPE_CHANGE_KIND	A change in a sub-type of the variable.
ADDED_VARIABLE_CHANGE_KIND	The variable was added to the second second subject of the diff.
DELETED_VARIABLE_CHANGE_KIND	The variable was deleted from the second subject of the diff.
ALL_CHANGE_KIND	This represents all the changes possibly described by this enum. It's a logical 'OR' of all the change enumerators above.

Definition at line 763 of file abg-suppression.h.

Constructor & Destructor Documentation

◆ variable_suppression()

variable_suppression	(	const string &	label = `""`,
		const string &	name = `""`,
		const string &	name_regex_str = `""`,
		const string &	symbol_name = `""`,
		const string &	symbol_name_regex_str = `""`,
		const string &	symbol_version = `""`,
		const string &	symbol_version_regex = `""`,
		const string &	type_name = `""`,
		const string &	type_name_regex_str = `""`
	)

Constructor for the variable_suppression type.

Parameters

label	an informative text string that the evalution code might use to designate this variable suppression specification in error messages. This parameter might be empty, in which case it's ignored at evaluation time.
name	the name of the variable the user wants the current specification to designate. This parameter might be empty, in which case it's ignored at evaluation time.
name_regex_str	if `name` is empty, this parameter is a regular expression for a family of names of variables the user wants the current specification to designate. If `name` is not empty, then this parameter is ignored at evaluation time. This parameter might be empty, in which case it's ignored at evaluation time.
symbol_name	the name of the symbol of the variable the user wants the current specification to designate. This parameter might be empty, in which case it's ignored at evaluation time.
symbol_name_str	if `symbol_name` is empty, this parameter is a regular expression for a family of names of symbols of variables the user wants the current specification to designate. If `symbol_name` is not empty, then this parameter is ignored at evaluation time. This parameter might be empty, in which case it's ignored at evaluation time.
symbol_version	the version of the symbol of the variable the user wants the current specification to designate. This parameter might be empty, in which case it's ignored at evaluation time.
symbol_version_regex	if `symbol_version` is empty, then this parameter is a regular expression for a family of versions of symbol for the variables the user wants the current specification to designate. If `symbol_version` is not empty, then this parameter is ignored at evaluation time. This parameter might be empty, in which case it's ignored at evaluation time.
type_name	the name of the type of the variable the user wants the current specification to designate. This parameter might be empty, in which case it's ignored at evaluation time.
type_name_regex_str	if `type_name` is empty, then this parameter is a regular expression for a family of type names of variables the user wants the current specification to designate. If `type_name` is not empty, then this parameter is ignored at evluation time. This parameter might be empty, in which case it's ignored at evaluation time.

Definition at line 3851 of file abg-suppression.cc.

◆ ~variable_suppression()

~variable_suppression ( )

virtual

Virtual destructor for the @erf variable_suppression type. variable_suppression type.

Definition at line 3869 of file abg-suppression.cc.

Member Function Documentation

◆ get_change_kind()

variable_suppression::change_kind get_change_kind ( ) const

Getter of the "change_king" property.

Returns: the value of the "change_kind" property.

Definition at line 3898 of file abg-suppression.cc.

◆ get_name()

const string & get_name ( ) const

Getter for the name of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

Returns: the name of the variable.

Definition at line 3914 of file abg-suppression.cc.

◆ get_name_not_regex_str()

const string & get_name_not_regex_str ( ) const

Getter for the "name_not_regexp" property of the specification.

Returns: the value of the "name_not_regexp" property.

Definition at line 3954 of file abg-suppression.cc.

◆ get_name_regex_str()

const string & get_name_regex_str ( ) const

Getter for the regular expression for a family of names of variables the user wants the current specification to designate. If the variable name as returned by variable_suppression::get_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Returns: the regular expression for the variable name.

Definition at line 3935 of file abg-suppression.cc.

◆ get_symbol_name()

const string & get_symbol_name ( ) const

Getter for the name of the symbol of the variable the user wants the current specification to designate.

This property might be empty, in which case it is ignored at evaluation time.

Returns: the name of the symbol of the variable.

Definition at line 3972 of file abg-suppression.cc.

◆ get_symbol_name_not_regex_str()

const string & get_symbol_name_not_regex_str ( ) const

Getter for a regular expression for a family of names of symbols of variables the user wants this specification to designate.

If a symbol name is matched by this regular expression, then the suppression specification will *NOT* suppress the symbol.

If the symbol name as returned by variable_suppression::get_symbol_name() is not empty, then this property is ignored at specification evaluation time.

This property might be empty, in which case it's ignored at evaluation time.

Returns: the regular expression string for a family of names of symbols that is to be *NOT* suppressed by this suppression specification.

Definition at line 4028 of file abg-suppression.cc.

◆ get_symbol_name_regex_str()

const string & get_symbol_name_regex_str ( ) const

Getter of the regular expression for a family of symbol names of the variables this specification is about to designate.

This property might be empty, in which case it's ignored at evaluation time. Otherwise, it is taken in account iff the property returned by variable_suppression::get_symbol_name() is empty.

Returns: the regular expression for a symbol name of the variable.

Definition at line 3996 of file abg-suppression.cc.

◆ get_symbol_version()

const string & get_symbol_version ( ) const

Getter for the version of the symbol of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

Returns: the symbol version of the variable.

Definition at line 4057 of file abg-suppression.cc.

◆ get_symbol_version_regex_str()

const string & get_symbol_version_regex_str ( ) const

Getter of the regular expression for a family of versions of symbol for the variables the user wants the current specification to designate. If symbol_version is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Returns: the regular expression of the symbol version of the variable.

Definition at line 4078 of file abg-suppression.cc.

◆ get_type_name()

const string & get_type_name ( ) const

Getter for the name of the type of the variable the user wants the current specification to designate.

This property might be empty, in which case it's ignored at evaluation time.

Returns: the name of the variable type.

Definition at line 4101 of file abg-suppression.cc.

◆ get_type_name_regex_str()

const string & get_type_name_regex_str ( ) const

Getter for the regular expression for a family of type names of variables the user wants the current specification to designate.

If the type name as returned by variable_suppression::get_type_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Returns: the regular expression of the variable type name.

Definition at line 4125 of file abg-suppression.cc.

◆ parse_change_kind()

variable_suppression::change_kind parse_change_kind ( const string & s )

static

Parses a string containing the content of the "change-kind" property and returns the an instance of variable_suppression::change_kind as a result.

Parameters

s	the string to parse.

Returns: the resulting variable_suppression::change_kind.

Definition at line 3880 of file abg-suppression.cc.

◆ set_change_kind()

void set_change_kind ( change_kind k )

Setter of the "change_kind" property.

Parameters

k	the new value of of the change_kind.

Definition at line 3905 of file abg-suppression.cc.

◆ set_name()

void set_name ( const string & n )

Setter for the name of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

Parameters

n	the new name of the variable to set.

Definition at line 3923 of file abg-suppression.cc.

◆ set_name_not_regex_str()

void set_name_not_regex_str ( const string & r )

Setter for the "name_not_regexp" property of the specification.

Parameters

r	the new value of the "name_not_regexp" property.

Definition at line 3961 of file abg-suppression.cc.

◆ set_name_regex_str()

void set_name_regex_str ( const string & r )

Setter for the regular expression for a family of names of variables the user wants the current specification to designate. If the variable name as returned by variable_suppression::get_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Parameters

r	the new regular expression for the variable name.

Definition at line 3947 of file abg-suppression.cc.

◆ set_symbol_name()

void set_symbol_name ( const string & n )

Setter for the name of the symbol of the variable the user wants the current specification to designate.

This property might be empty, in which case it is ignored at evaluation time.

Parameters

n	the new name of the symbol of the variable.

Definition at line 3983 of file abg-suppression.cc.

◆ set_symbol_name_not_regex_str()

void set_symbol_name_not_regex_str ( const string & r )

Setter for a regular expression for a family of names of symbols of variables the user wants this specification to designate.

If a symbol name is matched by this regular expression, then the suppression specification will *NOT* suppress the symbol.

If the symbol name as returned by variable_suppression::get_symbol_name() is not empty, then this property is ignored at specification evaluation time.

This property might be empty, in which case it's ignored at evaluation time.

Parameters

the	new regular expression string for a family of names of symbols that is to be NOT suppressed by this suppression specification.

Definition at line 4048 of file abg-suppression.cc.

◆ set_symbol_name_regex_str()

void set_symbol_name_regex_str ( const string & r )

Setter of the regular expression for a family of symbol names of the variables this specification is about to designate.

This property might be empty, in which case it's ignored at evaluation time. Otherwise, it is taken in account iff the property returned by variable_suppression::get_symbol_name() is empty.

Parameters

r	the regular expression for a symbol name of the variable.

Definition at line 4009 of file abg-suppression.cc.

◆ set_symbol_version()

void set_symbol_version ( const string & v )

Setter for the version of the symbol of the variable the user wants the current specification to designate. This property might be empty, in which case it's ignored at evaluation time.

Returns: the new symbol version of the variable.

Definition at line 4066 of file abg-suppression.cc.

◆ set_symbol_version_regex_str()

void set_symbol_version_regex_str ( const string & r )

Setter of the regular expression for a family of versions of symbol for the variables the user wants the current specification to designate. If symbol_version is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Parameters

v	the new regular expression of the symbol version of the variable.

Definition at line 4090 of file abg-suppression.cc.

◆ set_type_name()

void set_type_name ( const string & n )

Setter for the name of the type of the variable the user wants the current specification to designate.

This property might be empty, in which case it's ignored at evaluation time.

Parameters

n	the new name of the variable type.

Definition at line 4112 of file abg-suppression.cc.

◆ set_type_name_regex_str()

void set_type_name_regex_str ( const string & r )

Setter for the regular expression for a family of type names of variables the user wants the current specification to designate.

If the type name as returned by variable_suppression::get_type_name() is not empty, then this property is ignored at evaluation time. This property might be empty, in which case it's ignored at evaluation time.

Parameters

r	the regular expression of the variable type name.

Definition at line 4138 of file abg-suppression.cc.

◆ suppresses_diff()

bool suppresses_diff ( const diff * diff ) const

virtual

Evaluate this suppression specification on a given diff node and say if the diff node should be suppressed or not.

Parameters

diff	the diff node to evaluate this suppression specification against.

Returns: true if diff should be suppressed.

Implements suppression_base.

Definition at line 4149 of file abg-suppression.cc.

◆ suppresses_variable() [1/2]

bool suppresses_variable	(	const var_decl *	var,
		change_kind	k,
		const diff_context_sptr	ctxt
	)		const

Evaluate the current variable suppression specification on a given var_decl and say if a report about a change involving this var_decl should be suppressed or not.

Parameters

var	the var_decl to evaluate this suppression specification against.
k	the kind of variable change `var` is supposed to have.
ctxt	the context of the current diff.

Returns: true iff a report about a change involving the variable var should be suppressed.

Definition at line 4182 of file abg-suppression.cc.

◆ suppresses_variable() [2/2]

bool suppresses_variable	(	const var_decl_sptr	var,
		change_kind	k,
		const diff_context_sptr	ctxt
	)		const

Evaluate the current variable suppression specification on a given var_decl and say if a report about a change involving this var_decl should be suppressed or not.

Parameters

var	the var_decl to evaluate this suppression specification against.
k	the kind of variable change `var` is supposed to have.
ctxt	the context of the current diff.

Returns: true iff a report about a change involving the variable var should be suppressed.

Definition at line 4302 of file abg-suppression.cc.

◆ suppresses_variable_symbol() [1/2]

bool suppresses_variable_symbol	(	const elf_symbol *	sym,
		change_kind	k,
		const diff_context_sptr	ctxt
	)		const

Evaluate the current variable suppression specification on a given elf_symbol and say if a report about a change involving this elf_symbol should be suppressed or not.

Parameters

sym	the elf_symbol to evaluate this suppression specification against.
k	the kind of variable change `sym` is supposed to have.
ctxt	the context of the current diff.

Returns: true iff a report about a change involving the symbol sym should be suppressed.

Definition at line 4321 of file abg-suppression.cc.

◆ suppresses_variable_symbol() [2/2]

bool suppresses_variable_symbol	(	const elf_symbol_sptr	sym,
		change_kind	k,
		const diff_context_sptr	ctxt
	)		const

Evaluate the current variable suppression specification on a given elf_symbol and say if a report about a change involving this elf_symbol should be suppressed or not.

Parameters

sym	the elf_symbol to evaluate this suppression specification against.
k	the kind of variable change `sym` is supposed to have.
ctxt	the context of the current diff.

Returns: true iff a report about a change involving the symbol sym should be suppressed.

Definition at line 4414 of file abg-suppression.cc.

Member Data Documentation

◆ priv_

std::unique_ptr<priv> priv_

Definition at line 785 of file abg-suppression.h.

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

/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/include/abg-suppression.h
/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/src/abg-suppression.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ change_kind

Constructor & Destructor Documentation

◆ variable_suppression()

◆ ~variable_suppression()

Member Function Documentation

◆ get_change_kind()

◆ get_name()

◆ get_name_not_regex_str()

◆ get_name_regex_str()

◆ get_symbol_name()

◆ get_symbol_name_not_regex_str()

◆ get_symbol_name_regex_str()

◆ get_symbol_version()

◆ get_symbol_version_regex_str()

◆ get_type_name()

◆ get_type_name_regex_str()

◆ parse_change_kind()

◆ set_change_kind()

◆ set_name()

◆ set_name_not_regex_str()

◆ set_name_regex_str()

◆ set_symbol_name()

◆ set_symbol_name_not_regex_str()

◆ set_symbol_name_regex_str()

◆ set_symbol_version()

◆ set_symbol_version_regex_str()

◆ set_type_name()

◆ set_type_name_regex_str()

◆ suppresses_diff()

◆ suppresses_variable() [1/2]

◆ suppresses_variable() [2/2]

◆ suppresses_variable_symbol() [1/2]

◆ suppresses_variable_symbol() [2/2]

Member Data Documentation

◆ priv_