diff mbox series

[6/7] Default construct suppression types.

Message ID 20200817093819.172380-7-gprocida@google.com
State New
Headers show
Series Suppression parsing - preparatory work | expand

Commit Message

Giuliano Procida Aug. 17, 2020, 9:38 a.m. UTC
The current constructors for the various suppression types are not a
good match for their current uses. Given that every member is
effectively optional, default constructing these to a default
unpopulated state makes the code simpler.

There are no behavioural changes.

	* include/abg-suppression.h (suppression_base): Remove both
	non-default constructors, make default constructor public.
	(type_suppression): Ditto.  (function_suppression): Remove
	non-default constructor.  (variable_suppression): Remove
	non-default constructor, add default constructor.
	(file_suppression): Remove non-default constructor, make
	default constructor public.
	* src/abg-suppression-priv.h (variable_suppression::priv):
	Replace constructor with default constructor.
	(type_suppression::priv): Make default constructor public and
	define it.
	* src/abg-suppression.cc (suppression_base): Drop non-default
	constructors, define default constructor.
	(type_suppression): Drop non-default constructor, define
	default constructor. (function_suppression): Drop non-default
	constructor.  (variable_suppression): Drop non-default
	constructor, define default constructor.  (file_suppression):
	Drop non-default constructor, define default constructor.
	(read_type_suppression): Default construct result and populate
	initial fields using setters.  (read_function_suppression):
	Ditto.	(read_function_suppression): Ditto.
	(read_file_suppression): Ditto.
	* src/abg-tools-utils.cc (handle_file_entry): Default
	construct type_suppression suppr and use set_label to set
	initial field.

Reviewed-by: Matthias Maennich <maennich@google.com>
Signed-off-by: Giuliano Procida <gprocida@google.com>
---
 include/abg-suppression.h  |  44 +-----
 src/abg-suppression-priv.h |  28 ++--
 src/abg-suppression.cc     | 270 ++++++-------------------------------
 src/abg-tools-utils.cc     |   6 +-
 4 files changed, 59 insertions(+), 289 deletions(-)
diff mbox series

Patch

diff --git a/include/abg-suppression.h b/include/abg-suppression.h
index dbb52de35..d1246a405 100644
--- a/include/abg-suppression.h
+++ b/include/abg-suppression.h
@@ -55,17 +55,10 @@  class suppression_base
   class priv;
   typedef shared_ptr<priv> priv_sptr;
 
-  // Forbid default constructor
-  suppression_base();
-
 public:
   priv_sptr priv_;
 
-  suppression_base(const string& label);
-
-  suppression_base(const string& label,
-		   const string& file_name_regex_str,
-		   const string& file_name_not_regex_str);
+  suppression_base();
 
   bool
   get_drops_artifact_from_ir() const;
@@ -155,9 +148,6 @@  class type_suppression : public suppression_base
   class priv;
   typedef shared_ptr<priv> priv_sptr;
 
-  // Forbid this;
-  type_suppression();
-
 public:
 
   priv_sptr priv_;
@@ -203,9 +193,7 @@  public:
   /// A convenience typedef for a vector of @ref insertion_range_sptr.
   typedef vector<insertion_range_sptr> insertion_ranges;
 
-  type_suppression(const string& label,
-		   const string& type_name_regexp,
-		   const string& type_name);
+  type_suppression();
 
   virtual ~type_suppression();
 
@@ -460,17 +448,6 @@  public:
 
   function_suppression();
 
-  function_suppression(const string&		label,
-		       const string&		name,
-		       const string&		name_regex,
-		       const string&		return_type_name,
-		       const string&		return_type_regex,
-		       parameter_specs_type&	parm_specs,
-		       const string&		symbol_name,
-		       const string&		symbol_name_regex,
-		       const string&		symbol_version,
-		       const string&		symbol_version_regex_str);
-
   virtual ~function_suppression();
 
   static change_kind
@@ -677,15 +654,7 @@  public:
 
   priv_sptr priv_;
 
-  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 = "");
+  variable_suppression();
 
   virtual ~variable_suppression();
 
@@ -810,14 +779,9 @@  class file_suppression: public suppression_base
 
   priv_sptr priv_;
 
-  // Forbid this
-  file_suppression();
-
 public:
 
-  file_suppression(const string& label,
-		   const string& file_name_regex,
-		   const string& file_name_not_regex);
+  file_suppression();
 
   virtual bool
   suppresses_diff(const diff* diff) const;
diff --git a/src/abg-suppression-priv.h b/src/abg-suppression-priv.h
index deb08269c..658aeb143 100644
--- a/src/abg-suppression-priv.h
+++ b/src/abg-suppression-priv.h
@@ -497,23 +497,8 @@  struct variable_suppression::priv
   string				type_name_regex_str_;
   mutable regex::regex_t_sptr		type_name_regex_;
 
-  priv(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)
-    : change_kind_(ALL_CHANGE_KIND),
-      name_(name),
-      name_regex_str_(name_regex_str),
-      symbol_name_(symbol_name),
-      symbol_name_regex_str_(symbol_name_regex_str),
-      symbol_version_(symbol_version),
-      symbol_version_regex_str_(symbol_version_regex_str),
-      type_name_(type_name),
-      type_name_regex_str_(type_name_regex_str)
+  priv()
+    : change_kind_(ALL_CHANGE_KIND)
   {}
 
   /// Getter for a pointer to a regular expression object built from
@@ -666,9 +651,14 @@  class type_suppression::priv
   mutable regex::regex_t_sptr		source_location_to_keep_regex_;
   mutable vector<string>		changed_enumerator_names_;
 
-  priv();
-
 public:
+  priv()
+    : consider_type_kind_(false),
+      type_kind_(CLASS_TYPE_KIND),
+      consider_reach_kind_(false),
+      reach_kind_(DIRECT_REACH_KIND)
+  {}
+
   priv(const string&			type_name_regexp,
        const string&			type_name,
        bool				consider_type_kind,
diff --git a/src/abg-suppression.cc b/src/abg-suppression.cc
index fb97a124b..c9b2390e0 100644
--- a/src/abg-suppression.cc
+++ b/src/abg-suppression.cc
@@ -78,33 +78,11 @@  check_sufficient_props(const char *const * names, size_t count,
 
 // <suppression_base stuff>
 
-/// Constructor for @ref suppression_base
-///
-/// @param a label for the suppression.  This represents just a
-/// comment.
-suppression_base::suppression_base(const string& label)
-  : priv_(new priv(label))
+/// Default constructor for @ref suppression_base
+suppression_base::suppression_base()
+  : priv_(new priv())
 {}
 
-/// Constructor for @ref suppression_base
-///
-/// @param a label for the suppression.  This represents just a
-/// comment.
-///
-/// @param file_name_regex_str the regular expression that denotes the
-/// file name to match.
-///
-/// @param file_name_not_regex_str the regular expression that denotes
-/// the file name to *NOT* match.
-suppression_base::suppression_base(const string& label,
-				   const string& file_name_regex_str,
-				   const string& file_name_not_regex_str)
-  : priv_(new priv(label,
-		   file_name_regex_str,
-		   file_name_not_regex_str))
-{
-}
-
 /// Tests if the current suppression specification is to avoid adding
 /// the matched ABI artifact to the internal representation or not.
 ///
@@ -457,32 +435,9 @@  read_suppressions(const string& file_path,
 
 // <type_suppression stuff>
 
-/// Constructor for @ref type_suppression.
-///
-/// @param label the label of the suppression.  This is just a free
-/// form comment explaining what the suppression is about.
-///
-/// @param type_name_regexp the regular expression describing the
-/// types about which diff reports should be suppressed.  If it's an
-/// empty string, the parameter is ignored.
-///
-/// @param type_name the name of the type about which diff reports
-/// should be suppressed.  If it's an empty string, the parameter is
-/// ignored.
-///
-/// Note that parameter @p type_name_regexp and @p type_name_regexp
-/// should not necessarily be populated.  It usually is either one or
-/// the other that the user wants.
-type_suppression::type_suppression(const string& label,
-				   const string& type_name_regexp,
-				   const string& type_name)
-  : suppression_base(label),
-    priv_(new priv(type_name_regexp,
-		   type_name,
-		   /*consider_type_kind=*/false,
-		   /*type_kind=*/CLASS_TYPE_KIND,
-		   /*consider_reach_kind=*/false,
-		   /*reach_kind=*/DIRECT_REACH_KIND))
+/// Default constructor for @ref type_suppression.
+type_suppression::type_suppression()
+  : suppression_base(), priv_(new priv)
 {}
 
 type_suppression::~type_suppression()
@@ -1910,7 +1865,10 @@  read_type_suppression(const ini::config::section& section,
 	changed_enumerator_names.push_back(p->get_value()->as_string());
     }
 
-  type_suppression result(label_str, name_regex_str, name_str);
+  type_suppression result;
+  result.set_label(label_str);
+  result.set_type_name_regex_str(name_regex_str);
+  result.set_type_name(name_str);
 
   if (consider_type_kind)
     {
@@ -2048,77 +2006,7 @@  function_suppression::parameter_spec::set_parameter_type_name_regex_str
 /// specified by using the various accessors of the @ref
 /// function_suppression type.
 function_suppression::function_suppression()
-  :  suppression_base(/*label=*/""), priv_(new priv)
-{}
-
-/// Constructor for the @ref function_suppression type.
-///
-/// @param label an informative text string that the evalution code
-/// might use to designate this function suppression specification in
-/// error messages.  This parameter might be empty, in which case it's
-/// ignored at evaluation time.
-///
-/// @param the name of the function the user wants the current
-/// specification to designate.  This parameter might be empty, in
-/// which case it's ignored at evaluation time.
-///
-/// @param nr if @p name is empty this parameter is a regular
-/// expression for a family of names of functions the user wants the
-/// current specification to designate.  If @p name is not empty, this
-/// parameter is ignored at specification evaluation time.  This
-/// parameter might be empty, in which case it's ignored at evaluation
-/// time.
-///
-/// @param ret_tn the name of the return type of the function the user
-/// wants this specification to designate.  This parameter might be
-/// empty, in which case it's ignored at evaluation time.
-///
-/// @param ret_tr if @p ret_tn is empty, then this is a regular
-/// expression for a family of return type names for functions the
-/// user wants the current specification to designate.  If @p ret_tn
-/// is not empty, then this parameter is ignored at specification
-/// evaluation time.  This parameter might be empty, in which case
-/// it's ignored at evaluation time.
-///
-/// @param ps a vector of parameter specifications to specify
-/// properties of the parameters of the functions the user wants this
-/// specification to designate.  This parameter might be empty, in
-/// which case it's ignored at evaluation time.
-///
-/// @param sym_n the name of symbol of the function the user wants
-/// this specification to designate.  This parameter might be empty,
-/// in which case it's ignored at evaluation time.
-///
-/// @param sym_nr if the parameter @p sym_n is empty, then this
-/// parameter is a regular expression for a family of names of symbols
-/// of functions the user wants this specification to designate.  If
-/// the parameter @p sym_n is not empty, then this parameter is
-/// ignored at specification evaluation time.  This parameter might be
-/// empty, in which case it's ignored at evaluation time.
-///
-/// @param sym_v the name of the version of the symbol of the function
-/// the user wants this specification to designate.  This parameter
-/// might be empty, in which case it's ignored at evaluation time.
-///
-/// @param sym_vr if the parameter @p sym_v is empty, then this
-/// parameter is a regular expression for a family of versions of
-/// symbols of functions the user wants the current specification to
-/// designate.  If the parameter @p sym_v is non empty, then this
-/// parameter is ignored.  This parameter might be empty, in which
-/// case it's ignored at evaluation time.
-function_suppression::function_suppression(const string&		label,
-					   const string&		name,
-					   const string&		nr,
-					   const string&		ret_tn,
-					   const string&		ret_tr,
-					   parameter_specs_type&	ps,
-					   const string&		sym_n,
-					   const string&		sym_nr,
-					   const string&		sym_v,
-					   const string&		sym_vr)
-  : suppression_base(label),
-    priv_(new priv(name, nr, ret_tn, ret_tr, ps,
-		   sym_n, sym_nr, sym_v, sym_vr))
+  : suppression_base(), priv_(new priv)
 {}
 
 function_suppression::~function_suppression()
@@ -3342,16 +3230,17 @@  read_function_suppression(const ini::config::section& section,
 	  parms.push_back(parm);
       }
 
-  function_suppression result(label_str,
-			      name,
-			      name_regex_str,
-			      return_type_name,
-			      return_type_regex_str,
-			      parms,
-			      sym_name,
-			      sym_name_regex_str,
-			      sym_version,
-			      sym_ver_regex_str);
+  function_suppression result;
+  result.set_label(label_str);
+  result.set_name(name);
+  result.set_name_regex_str(name_regex_str);
+  result.set_return_type_name(return_type_name);
+  result.set_return_type_regex_str(return_type_regex_str);
+  result.set_parameter_specs(parms);
+  result.set_symbol_name(sym_name);
+  result.set_symbol_name_regex_str(sym_name_regex_str);
+  result.set_symbol_version(sym_version);
+  result.set_symbol_version_regex_str(sym_ver_regex_str);
 
   if ((drop_artifact_str == "yes" || drop_artifact_str == "true")
       && (!name.empty()
@@ -3396,71 +3285,13 @@  read_function_suppression(const ini::config::section& section,
 
 // <variable_suppression stuff>
 
-/// Constructor for the @ref variable_suppression type.
-///
-/// @param 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.
-///
-/// @param 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.
-///
-/// @param name_regex_str if @p 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 @p 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.
-///
-/// @param 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.
-///
-/// @param symbol_name_str if @p 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 @p 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.
-///
-/// @param 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.
-///
-/// @param symbol_version_regex if @p 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 @p 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.
-///
-/// @param 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.
+/// Default constructor for the @ref variable_suppression type.
 ///
-/// @param type_name_regex_str if @p 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 @p 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.
-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)
-  : suppression_base(label),
-    priv_(new priv(name, name_regex_str,
-		   symbol_name, symbol_name_regex_str,
-		   symbol_version, symbol_version_regex,
-		   type_name, type_name_regex_str))
+/// It defines no suppression for now.  Suppressions have to be
+/// specified by using the various accessors of the @ref
+/// variable_suppression type.
+variable_suppression::variable_suppression()
+  : suppression_base(), priv_(new priv)
 {}
 
 /// Virtual destructor for the @erf variable_suppression type.
@@ -4199,15 +4030,16 @@  read_variable_suppression(const ini::config::section& section,
     ? type_name_regex_prop->get_value()->as_string()
      : "";
 
-  variable_suppression result(label_str,
-			      name_str,
-			      name_regex_str,
-			      symbol_name,
-			      symbol_name_regex_str,
-			      symbol_version,
-			      symbol_version_regex_str,
-			      type_name_str,
-			      type_name_regex_str);
+  variable_suppression result;
+  result.set_label(label_str);
+  result.set_name(name_str);
+  result.set_name_regex_str(name_regex_str);
+  result.set_symbol_name(symbol_name);
+  result.set_symbol_name_regex_str(symbol_name_regex_str);
+  result.set_symbol_version(symbol_version);
+  result.set_symbol_version_regex_str(symbol_version_regex_str);
+  result.set_type_name(type_name_str);
+  result.set_type_name_regex_str(type_name_regex_str);
 
   if ((drop_artifact_str == "yes" || drop_artifact_str == "true")
       && (!name_str.empty()
@@ -4248,25 +4080,8 @@  read_variable_suppression(const ini::config::section& section,
 
 // <file_suppression stuff>
 
-/// Constructor for the the @ref file_suppression type.
-///
-/// @param label the label of the suppression directive.
-///
-/// @param fname_regex_str the regular expression string that
-/// designates the file name that instances of @ref file_suppression
-/// should match.
-///
-/// @param fname_not_regex_str the regular expression string that
-/// designates the file name that instances of @ref file_suppression
-/// shoult *NOT* match.  In other words, this file_suppression should
-/// be activated if its file name does not match the regular
-/// expression @p fname_not_regex_str.
-file_suppression::file_suppression(const string& label,
-				   const string& fname_regex_str,
-				   const string& fname_not_regex_str)
-  : suppression_base(label,
-		     fname_regex_str,
-		     fname_not_regex_str)
+/// Default constructor for the the @ref file_suppression type.
+file_suppression::file_suppression()
 {}
 
 /// Test if instances of this @ref file_suppression suppresses a
@@ -4376,7 +4191,10 @@  read_file_suppression(const ini::config::section& section,
     ? soname_not_regex_prop->get_value()->as_string()
     : "";
 
-  file_suppression result(label_str, file_name_regex_str, file_name_not_regex_str);
+  file_suppression result;
+  result.set_label(label_str);
+  result.set_file_name_regex_str(file_name_regex_str);
+  result.set_file_name_not_regex_str(file_name_not_regex_str);
 
   if (!soname_regex_str.empty())
     {
diff --git a/src/abg-tools-utils.cc b/src/abg-tools-utils.cc
index 38e2f1755..2e12206d6 100644
--- a/src/abg-tools-utils.cc
+++ b/src/abg-tools-utils.cc
@@ -1794,10 +1794,8 @@  handle_file_entry(const string& file_path,
 {
   if (!suppr)
     {
-      suppr.reset(new type_suppression(get_private_types_suppr_spec_label(),
-				       /*type_name_regexp=*/"",
-				       /*type_name=*/""));
-
+      suppr.reset(new type_suppression());
+      suppr->set_label(get_private_types_suppr_spec_label());
       // Types that are defined in system headers are usually
       // OK to be considered as public types.
       suppr->set_source_location_to_keep_regex_str("^/usr/include/");