smt_to_smt2_string.cpp

Go to the documentation of this file.

// Author: Diffblue Ltd.
 
#include <util/range.h>
#include <util/string_utils.h>
 
#include <solvers/smt2/smt2_conv.h>
#include <solvers/smt2_incremental/ast/smt_commands.h>
#include <solvers/smt2_incremental/ast/smt_index.h>
#include <solvers/smt2_incremental/ast/smt_logics.h>
#include <solvers/smt2_incremental/ast/smt_sorts.h>
#include <solvers/smt2_incremental/ast/smt_terms.h>
#include <solvers/smt2_incremental/smt_to_smt2_string.h>
 
#include <functional>
#include <sstream> // IWYU pragma: keep
#include <stack>
#include <string>
 
static std::string escape_identifier(const irep_idt &identifier)
{
  return smt2_convt::convert_identifier(identifier);
}
 
class smt_index_output_visitort : public smt_index_const_downcast_visitort
{
protected:
  std::ostream &os;
 
public:
  explicit smt_index_output_visitort(std::ostream &os) : os(os)
  {
  }
 
  void visit(const smt_numeral_indext &numeral) override
  {
    os << numeral.value();
  }
 
  void visit(const smt_symbol_indext &symbol) override
  {
    os << escape_identifier(symbol.identifier());
  }
};
 
std::ostream &operator<<(std::ostream &os, const smt_indext &index)
{
  smt_index_output_visitort visitor{os};
  index.accept(visitor);
  return os;
}
 
std::string smt_to_smt2_string(const smt_indext &index)
{
  std::stringstream ss;
  ss << index;
  return ss.str();
}
 
class smt_sort_output_visitort : public smt_sort_const_downcast_visitort
{
protected:
  std::ostream &os;
 
public:
  explicit smt_sort_output_visitort(std::ostream &os) : os(os)
  {
  }
 
  void visit(const smt_bool_sortt &) override
  {
    os << "Bool";
  }
 
  void visit(const smt_bit_vector_sortt &bit_vec) override
  {
    os << "(_ BitVec " << bit_vec.bit_width() << ")";
  }
 
  void visit(const smt_array_sortt &array) override
  {
    os << "(Array " << array.index_sort() << " " << array.element_sort() << ")";
  }
};
 
std::ostream &operator<<(std::ostream &os, const smt_sortt &sort)
{
  sort.accept(smt_sort_output_visitort{os});
  return os;
}
 
std::string smt_to_smt2_string(const smt_sortt &sort)
{
  std::stringstream ss;
  ss << sort;
  return ss.str();
}
 
struct sorted_variablest final
{
  std::vector<std::reference_wrapper<const smt_identifier_termt>> identifiers;
};
 
class smt_term_to_string_convertert : private smt_term_const_downcast_visitort
{
private:
  using output_functiont = std::function<void(std::ostream &)>;
  std::stack<output_functiont> output_stack;
 
  static output_functiont make_output_function(const std::string &output);
  static output_functiont make_output_function(const smt_indext &output);
  static output_functiont make_output_function(const smt_sortt &output);
  output_functiont make_output_function(const smt_termt &output);
  template <typename elementt>
  output_functiont make_output_function(
    const std::vector<std::reference_wrapper<const elementt>> &output);
  output_functiont make_output_function(const sorted_variablest &output);
 
  template <typename outputt>
  void push_output(outputt &&output);
 
  void push_outputs();
 
  template <typename outputt, typename... outputst>
  void push_outputs(outputt &&output, outputst &&... outputs);
 
  smt_term_to_string_convertert() = default;
 
  void visit(const smt_bool_literal_termt &bool_literal) override;
  void visit(const smt_identifier_termt &identifier_term) override;
  void visit(const smt_bit_vector_constant_termt &bit_vector_constant) override;
  void
  visit(const smt_function_application_termt &function_application) override;
  void visit(const smt_forall_termt &forall) override;
  void visit(const smt_exists_termt &exists) override;
 
public:
  static std::ostream &convert(std::ostream &os, const smt_termt &term);
};
 
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(const std::string &output)
{
  // `output` must be captured by value to avoid dangling references.
  return [output](std::ostream &os) { os << output; };
}
 
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(const smt_indext &output)
{
  return [=](std::ostream &os) { os << output; };
}
 
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(const smt_sortt &output)
{
  return [=](std::ostream &os) { os << output; };
}
 
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(const smt_termt &output)
{
  return [=](std::ostream &os) { output.accept(*this); };
}
 
template <typename elementt>
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(
  const std::vector<std::reference_wrapper<const elementt>> &outputs)
{
  return [=](std::ostream &os) {
    for(const auto &output : make_range(outputs.rbegin(), outputs.rend()))
    {
      push_outputs(" ", output.get());
    }
  };
}
 
smt_term_to_string_convertert::output_functiont
smt_term_to_string_convertert::make_output_function(
  const sorted_variablest &output)
{
  return [=](std::ostream &os) {
    const auto push_sorted_variable =
      [&](const smt_identifier_termt &identifier) {
        push_outputs("(", identifier, " ", identifier.get_sort(), ")");
      };
    for(const auto &bound_variable :
        make_range(output.identifiers.rbegin(), --output.identifiers.rend()))
    {
      push_sorted_variable(bound_variable);
      push_output(" ");
    }
    push_sorted_variable(output.identifiers.front());
  };
}
 
template <typename outputt>
void smt_term_to_string_convertert::push_output(outputt &&output)
{
  output_stack.push(make_output_function(std::forward<outputt>(output)));
}
 
void smt_term_to_string_convertert::push_outputs()
{
}
 
template <typename outputt, typename... outputst>
void smt_term_to_string_convertert::push_outputs(
  outputt &&output,
  outputst &&... outputs)
{
  push_outputs(std::forward<outputst>(outputs)...);
  push_output(std::forward<outputt>(output));
}
 
void smt_term_to_string_convertert::visit(
  const smt_bool_literal_termt &bool_literal)
{
  push_output(bool_literal.value() ? "true" : "false");
}
 
void smt_term_to_string_convertert::visit(
  const smt_identifier_termt &identifier_term)
{
  auto indices = identifier_term.indices();
  auto escaped_identifier = escape_identifier(identifier_term.identifier());
  if(indices.empty())
  {
    push_outputs(std::move(escaped_identifier));
  }
  else
  {
    push_outputs("(_ ", std::move(escaped_identifier), std::move(indices), ")");
  }
}
 
void smt_term_to_string_convertert::visit(
  const smt_bit_vector_constant_termt &bit_vector_constant)
{
  auto value = integer2string(bit_vector_constant.value());
  auto bit_width = std::to_string(bit_vector_constant.get_sort().bit_width());
  push_outputs("(_ bv", std::move(value), " ", std::move(bit_width), ")");
}
 
void smt_term_to_string_convertert::visit(
  const smt_function_application_termt &function_application)
{
  const auto &id = function_application.function_identifier();
  auto arguments = function_application.arguments();
  push_outputs("(", id, std::move(arguments), ")");
}
 
void smt_term_to_string_convertert::visit(const smt_forall_termt &forall)
{
  sorted_variablest bound_variables{forall.bound_variables()};
  auto predicate = forall.predicate();
  push_outputs("(forall (", bound_variables, ") ", std::move(predicate), ")");
}
 
void smt_term_to_string_convertert::visit(const smt_exists_termt &exists)
{
  sorted_variablest bound_variables{exists.bound_variables()};
  auto predicate = exists.predicate();
  push_outputs("(exists (", bound_variables, ") ", std::move(predicate), ")");
}
 
std::ostream &
smt_term_to_string_convertert::convert(std::ostream &os, const smt_termt &term)
{
  smt_term_to_string_convertert converter;
  term.accept(converter);
  while(!converter.output_stack.empty())
  {
    auto output_function = std::move(converter.output_stack.top());
    converter.output_stack.pop();
    output_function(os);
  }
  return os;
}
 
std::ostream &operator<<(std::ostream &os, const smt_termt &term)
{
  return smt_term_to_string_convertert::convert(os, term);
}
 
std::string smt_to_smt2_string(const smt_termt &term)
{
  std::stringstream ss;
  ss << term;
  return ss.str();
}
 
class smt_option_to_string_convertert
  : public smt_option_const_downcast_visitort
{
protected:
  std::ostream &os;
 
public:
  explicit smt_option_to_string_convertert(std::ostream &os) : os(os)
  {
  }
 
  void visit(const smt_option_produce_modelst &produce_models) override
  {
    os << ":produce-models " << (produce_models.setting() ? "true" : "false");
  }
};
 
std::ostream &operator<<(std::ostream &os, const smt_optiont &option)
{
  option.accept(smt_option_to_string_convertert{os});
  return os;
}
 
std::string smt_to_smt2_string(const smt_optiont &option)
{
  std::stringstream ss;
  ss << option;
  return ss.str();
}
 
class smt_logic_to_string_convertert : public smt_logic_const_downcast_visitort
{
protected:
  std::ostream &os;
 
public:
  explicit smt_logic_to_string_convertert(std::ostream &os) : os(os)
  {
  }
 
#define LOGIC_ID(the_id, the_name)                                             \
  void visit(const smt_logic_##the_id##t &) override                           \
  {                                                                            \
    os << #the_name;                                                           \
  }
#include "solvers/smt2_incremental/ast/smt_logics.def"
 
#undef LOGIC_ID
};
 
std::ostream &operator<<(std::ostream &os, const smt_logict &logic)
{
  logic.accept(smt_logic_to_string_convertert{os});
  return os;
}
 
std::string smt_to_smt2_string(const smt_logict &logic)
{
  std::stringstream ss;
  ss << logic;
  return ss.str();
}
 
class smt_command_to_string_convertert
  : public smt_command_const_downcast_visitort
{
protected:
  std::ostream &os;
 
public:
  explicit smt_command_to_string_convertert(std::ostream &os) : os(os)
  {
  }
 
  void visit(const smt_assert_commandt &assert) override
  {
    os << "(assert " << assert.condition() << ")";
  }
 
  void visit(const smt_check_sat_commandt &check_sat) override
  {
    os << "(check-sat)";
  }
 
  void visit(const smt_declare_function_commandt &declare_function) override
  {
    os << "(declare-fun " << declare_function.identifier() << " (";
    const auto parameter_sorts = declare_function.parameter_sorts();
    join_strings(os, parameter_sorts.begin(), parameter_sorts.end(), ' ');
    os << ") " << declare_function.return_sort() << ")";
  }
 
  void visit(const smt_define_function_commandt &define_function) override
  {
    os << "(define-fun " << define_function.identifier() << " (";
    const auto parameters = define_function.parameters();
    join_strings(
      os,
      parameters.begin(),
      parameters.end(),
      " ",
      [](const smt_identifier_termt &identifier) {
        return "(" + smt_to_smt2_string(identifier) + " " +
               smt_to_smt2_string(identifier.get_sort()) + ")";
      });
    os << ") " << define_function.return_sort() << " "
       << define_function.definition() << ")";
  }
 
  void visit(const smt_exit_commandt &exit) override
  {
    os << "(exit)";
  }
 
  void visit(const smt_get_value_commandt &get_value) override
  {
    os << "(get-value (" << get_value.descriptor() << "))";
  }
 
  void visit(const smt_pop_commandt &pop) override
  {
    os << "(pop " << pop.levels() << ")";
  }
 
  void visit(const smt_push_commandt &push) override
  {
    os << "(push " << push.levels() << ")";
  }
 
  void visit(const smt_set_logic_commandt &set_logic) override
  {
    os << "(set-logic " << set_logic.logic() << ")";
  }
 
  void visit(const smt_set_option_commandt &set_option) override
  {
    os << "(set-option " << set_option.option() << ")";
  }
};
 
std::ostream &operator<<(std::ostream &os, const smt_commandt &command)
{
  command.accept(smt_command_to_string_convertert{os});
  return os;
}
 
std::string smt_to_smt2_string(const smt_commandt &command)
{
  std::stringstream ss;
  ss << command;
  return ss.str();
}