Updated documentation and removed unused exception

Author: fbbotero-aws

src/cbmc/cbmc_parse_options.cpp

@@ -1116,7 +1116,7 @@ void cbmc_parse_optionst::help()
     " --yices                      use Yices\n"
     " --z3                         use Z3\n"
     " --refine                     use refinement procedure (experimental)\n"
-    " --sat-solver-invocation cmd  command to invoke SAT solver process (experimental)\n"
+    " --sat-solver-invocation cmd  command to invoke SAT solver process\n"
     HELP_STRING_REFINEMENT_CBMC
     " --outfile filename           output formula to given file\n"
     " --arrays-uf-never            never turn arrays into uninterpreted functions\n" // NOLINT(*)

src/solvers/sat/external_sat.cpp

@@ -1,8 +1,7 @@
-/*******************************************************************\
-
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
-\*******************************************************************/
+/// \file
+/// Allows call an external SAT solver to allow faster integration of 
+/// newer SAT solvers
+/// \author Francis Botero <[email protected]>
 
 #include "external_sat.h"
 
@@ -13,8 +12,6 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #include <util/string_utils.h>
 #include <util/tempfile.h>
 
-#include <json/json_parser.h>
-
 #include <chrono>
 #include <cstdlib>
 #include <fstream>
@@ -24,7 +21,7 @@ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #include <thread>
 
 external_satt::external_satt(message_handlert &message_handler, std::string cmd)
-  : cnf_clause_list_assignmentt(message_handler), _cmd(std::move(cmd))
+  : cnf_clause_list_assignmentt(message_handler), solver_cmd(std::move(cmd))
 {
 }
 
@@ -43,7 +40,7 @@ void external_satt::set_assignment(literalt, bool)
   UNIMPLEMENTED;
 }
 
-inline void external_satt::write_cnf_file(std::string cnf_file)
+void external_satt::write_cnf_file(std::string cnf_file)
 {
   log.status() << "Writing temporary CNF" << messaget::eom;
   std::ofstream out(cnf_file);
@@ -57,18 +54,17 @@ inline void external_satt::write_cnf_file(std::string cnf_file)
   out.close();
 }
 
-inline std::string external_satt::execute_solver(std::string cnf_file)
+std::string external_satt::execute_solver(std::string cnf_file)
 {
   log.status() << "Invoking SAT solver" << messaget::eom;
   std::ostringstream response_ostream;
-  auto cmd_result = run(_cmd, {"", cnf_file}, "", response_ostream, "");
+  auto cmd_result = run(solver_cmd, {"", cnf_file}, "", response_ostream, "");
 
   log.status() << "Solver returned code: " << cmd_result << messaget::eom;
   return response_ostream.str();
 }
 
-inline external_satt::resultt
-external_satt::parse_result(std::string solver_output)
+external_satt::resultt external_satt::parse_result(std::string solver_output)
 {
   std::istringstream response_istream(solver_output);
   std::string line;

src/solvers/sat/external_sat.h

@@ -1,14 +1,13 @@
-/*******************************************************************\
+/// \file
+/// Allows call an external SAT solver to allow faster integration of 
+/// newer SAT solvers
+/// \author Francis Botero <[email protected]>
 
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
-\*******************************************************************/
-
-#ifndef CPROVER_SOLVERS_EXTERNAL_SAT_SAT_H
-#define CPROVER_SOLVERS_EXTERNAL_SAT_SAT_H
+#ifndef CPROVER_SOLVERS_SAT_EXTERNAL_SAT_H
+#define CPROVER_SOLVERS_SAT_EXTERNAL_SAT_H
 
 #include "cnf_clause_list.h"
-/// \brief Allows call an external SAT solver to allow faster integration of newer SAT solvers
 class external_satt : public cnf_clause_list_assignmentt
 {
 public:
@@ -31,12 +30,12 @@ class external_satt : public cnf_clause_list_assignmentt
 
 protected:
   resultt do_prop_solve() override;
-  std::string _cmd;
+  std::string solver_cmd;
 
 private:
   inline void write_cnf_file(std::string);
   inline std::string execute_solver(std::string);
   inline resultt parse_result(std::string);
 };
 
-#endif // CPROVER_SOLVERS_EXTERNAL_SAT_SAT_H
+#endif // CPROVER_SOLVERS_SAT_EXTERNAL_SAT_H