Add symbol parsing utilities.

This returns some code that was deprecated and removed in master,
thus this commit will need work before it can be PR'd.

Author: smowton

src/util/namespace_utils.cpp

@@ -0,0 +1,127 @@
+#include "namespace_utils.h"
+#include "symbol.h"
+#include <goto-programs/remove_returns.h>
+
+
+/*******************************************************************\
+  Function: namespace_utils_baset::does_symbol_match
+
+  Purpose:
+    Checks whether an exprt is actually a symbolt matching a predicate
+
+  Inputs:
+    lvalue:
+      An exprt to be tested
+    predicate:
+      The predicate to test for
+
+  Outputs:
+    Whether the exprt was actually a symbolt matching a predicate
+
+\*******************************************************************/
+bool namespace_utils_baset::does_symbol_match(
+  const exprt &lvalue,
+  std::function<bool(symbolt)> predicate) const
+{
+  if(lvalue.id()!=ID_symbol)
+    return false;
+  const symbolt *symbol;
+  if(lookup(lvalue.get(ID_identifier), symbol))
+    return false;
+  return predicate(*symbol);
+}
+
+/*******************************************************************\
+  Function: namespace_utils_baset::is_parameter
+
+  Purpose:
+    Checks whether an exprt is actually a parameter symbol
+
+  Inputs:
+    lvalue:
+      An exprt to be tested
+
+  Outputs:
+    Whether the exprt was actually a parameter symbol
+
+\*******************************************************************/
+bool namespace_utils_baset::is_parameter(const exprt &lvalue) const
+{
+  return does_symbol_match(
+    lvalue,
+    [] (symbolt symbol) { return symbol.is_parameter; });
+}
+
+/*******************************************************************\
+  Function: namespace_utils_baset::is_static
+
+  Purpose:
+    Checks whether an exprt is actually a static symbol
+
+  Inputs:
+    lvalue:
+      An exprt to be tested
+
+  Outputs:
+    Whether the exprt was actually a static symbol
+
+\*******************************************************************/
+bool namespace_utils_baset::is_static(const exprt &lvalue) const
+{
+  // TODO: Also check for static member accesses
+  return does_symbol_match(
+    lvalue,
+    [] (symbolt symbol) { return symbol.is_static_lifetime; });
+}
+
+/*******************************************************************\
+  Function: namespace_utils_baset::is_auxiliary_variable
+
+  Purpose:
+    Checks whether an exprt is actually an auxiliary variable symbol
+
+  Inputs:
+    lvalue:
+      An exprt to be tested
+
+  Outputs:
+    Whether the exprt was actually an auxiliary variable symbol
+
+\*******************************************************************/
+bool namespace_utils_baset::is_auxiliary_variable(const exprt &lvalue) const
+{
+  return does_symbol_match(
+    lvalue,
+    [] (symbolt symbol) { return symbol.is_auxiliary; });
+}
+
+/*******************************************************************\
+  Function: namespace_utils_baset::is_return_value_auxiliary
+
+  Purpose:
+    Checks whether an exprt is actually an auxiliary return value symbol
+
+  Inputs:
+    lvalue:
+      An exprt to be tested
+
+  Outputs:
+    Whether the exprt was actually an auxiliary return value symbol
+
+\*******************************************************************/
+bool namespace_utils_baset::is_return_value_auxiliary(const exprt &lvalue) const
+{
+  return
+    does_symbol_match(
+      lvalue,
+      [] (symbolt symbol)
+      {
+        return
+          symbol.is_static_lifetime
+            && symbol.is_auxiliary
+            && symbol.is_file_local
+            && symbol.is_thread_local;
+      })
+    && as_string(lvalue.get(ID_identifier)).find(RETURN_VALUE_SUFFIX)
+      != std::string::npos;
+}

src/util/namespace_utils.h

@@ -0,0 +1,117 @@
+/*******************************************************************\
+
+Module:
+
+Author: Daniel Kroening, [email protected]
+
+\*******************************************************************/
+
+// THIS FILE IS DEPRECATED
+
+#ifndef CPROVER_NAMESPACE_UTILS_H
+#define CPROVER_NAMESPACE_UTILS_H
+
+#include <functional>
+#include "namespace.h"
+#include "base_type.h"
+#include "type_eq.h"
+#include "std_expr.h"
+
+// second: true <=> not found
+
+class namespace_utils_baset
+{
+ public:
+  virtual ~namespace_utils_baset()
+  {
+  }
+ 
+  const symbolt &lookup(const irep_idt &name) const
+  {
+    const symbolt *symbol;
+    if(lookup(name, symbol))
+      throw "identifier "+id2string(name)+" not found";
+    return *symbol;
+  }
+   
+  const symbolt &lookup(const symbol_exprt &symbol_expr) const
+  {
+    const symbolt *symbol;
+    if(lookup(symbol_expr.get_identifier(), symbol))
+      throw "identifier "+id2string(symbol_expr.get_identifier())+" not found";
+    return *symbol;
+  }
+   
+  bool lookup(const irep_idt &name, const symbolt *&symbol) const
+  {
+    return ns().lookup(name, symbol);
+  }
+
+  bool lookup_symbol(const exprt &symbol_expr, const symbolt *&symbol) const
+  {
+    return ns().lookup(symbol_expr.get(ID_identifier), symbol);
+  }
+
+  void follow_symbol(irept &irep) const
+  {
+    ns().follow_symbol(irep);
+  }
+
+  void follow_macros(exprt &expr) const
+  {
+    ns().follow_macros(expr);
+  }
+
+  /*
+  void base_type(typet &type)
+  {
+    ::base_type(type, ns());
+  }
+   
+  void base_type(exprt &expr)
+  {
+    ::base_type(expr, ns());
+  }
+  */
+
+
+private:
+  bool does_symbol_match(
+    const exprt& lvalue,
+    std::function<bool(symbolt)> predicate) const;
+
+public:
+  bool is_parameter(const exprt& lvalue) const;
+  bool is_static(const exprt& lvalue) const;
+  bool is_auxiliary_variable(const exprt& lvalue) const;
+  bool is_return_value_auxiliary(const exprt& lvalue) const;
+
+  bool type_eq(const typet &type1, const typet &type2)
+  {
+    return ::type_eq(type1, type2, ns());
+  }
+
+  bool base_type_eq(const typet &type1, const typet &type2)
+  {
+    return ::base_type_eq(type1, type2, ns());
+  }
+
+ protected:
+  virtual const namespacet &ns() const=0;
+};
+ 
+class namespace_utilst:public virtual namespace_utils_baset
+{
+ public:
+  namespace_utilst(const namespacet &_ns):__ns(_ns){}
+  
+ protected:
+  const namespacet &__ns;
+
+  virtual const namespacet &ns() const
+  {
+    return __ns;
+  }
+};
+ 
+#endif