Bit vector proof superclass (#2599)

* Split BitvectorProof into a sub/superclass

The superclass contains general printing knowledge.

The subclass contains CNF or Resolution-specific knowledge.

* Renames & code moves

* Nits cleaned in prep for PR

* Moved CNF-proof from ResolutionBitVectorProof to BitVectorProof

Since DRAT BV proofs will also contain a CNF-proof, the CNF proof should
be stored in `BitVectorProof`.

* Unique pointers, comments, and code movement.

Adjusted the distribution of code between BVP and RBVP.
  Notably, put the CNF proof in BVP because it isn't
  resolution-specific.
Added comments to the headers of both files -- mostly BVP.
Changed two owned pointers into unique_ptr.
  BVP's pointer to a CNF proof
  RBVP's pointer to a resolution proof

BVP: `BitVectorProof`
RBVP: `ResolutionBitVectorProof`

* clang-format

* Undo manual copyright modification

* s/superclass/base class/

Co-Authored-By: alex-ozdemir <aozdemir@hmc.edu>

* make LFSCBitVectorProof::printOwnedSort public

* Andres's Comments

Mostly cleaning up (or trying to clean up) includes.

* Cleaned up one header cycle

However, this only allowed me to move the forward-decl, not eliminate
it, because there were actually two underlying include cycles that the
forward-decl solved.

* Added single _s to header gaurds

* Fix Class name in debug output

Credits to Andres

Co-Authored-By: alex-ozdemir <aozdemir@hmc.edu>

* Reordered methods in BitVectorProof per original  ordering

7 files changed, 77 insertions, 39 deletions

diff --git a/src/prop/bv_sat_solver_notify.h b/src/prop/bv_sat_solver_notify.h
new file mode 100644
index 000000000..686848829
--- /dev/null
+++ b/src/prop/bv_sat_solver_notify.h
@@ -0,0 +1,49 @@
+/*********************                                                        */
+/*! \file sat_solver_notify.h
+ ** \verbatim
+ ** Top contributors (to current version):
+ **   Liana Hadarean, Dejan Jovanovic, Morgan Deters
+ ** This file is part of the CVC4 project.
+ ** Copyright (c) 2009-2018 by the authors listed in the file AUTHORS
+ ** in the top-level source directory) and their institutional affiliations.
+ ** All rights reserved.  See the file COPYING in the top-level source
+ ** directory for licensing information.\endverbatim
+ **
+ ** \brief The interface for things that want to recieve notification from the
+ **        SAT solver
+ **/
+
+#include "cvc4_private.h"
+
+#ifndef __CVC4__PROP__BVSATSOLVERNOTIFY_H
+#define __CVC4__PROP__BVSATSOLVERNOTIFY_H
+
+#include "prop/sat_solver_types.h"
+
+namespace CVC4 {
+namespace prop {
+
+class BVSatSolverNotify {
+public:
+
+  virtual ~BVSatSolverNotify() {};
+
+  /**
+   * If the notify returns false, the solver will break out of whatever it's currently doing
+   * with an "unknown" answer.
+   */
+  virtual bool notify(SatLiteral lit) = 0;
+
+  /**
+   * Notify about a learnt clause.
+   */
+  virtual void notify(SatClause& clause) = 0;
+  virtual void spendResource(unsigned amount) = 0;
+  virtual void safePoint(unsigned amount) = 0;
+
+};/* class BVSatSolverInterface::Notify */
+
+}
+}
+
+#endif
diff --git a/src/prop/bvminisat/bvminisat.cpp b/src/prop/bvminisat/bvminisat.cpp
index 1eb4bce96..55710092b 100644
--- a/src/prop/bvminisat/bvminisat.cpp
+++ b/src/prop/bvminisat/bvminisat.cpp
@@ -51,7 +51,7 @@ void BVMinisatSatSolver::MinisatNotify::notify(
   d_notify->notify(satClause);
 }
 
-void BVMinisatSatSolver::setNotify(Notify* notify) {
+void BVMinisatSatSolver::setNotify(BVSatSolverNotify* notify) {
   d_minisatNotify.reset(new MinisatNotify(notify));
   d_minisat->setNotify(d_minisatNotify.get());
 }
@@ -104,7 +104,8 @@ void BVMinisatSatSolver::popAssumption() {
   d_minisat->popAssumption();
 }
 
-void BVMinisatSatSolver::setProofLog( BitVectorProof * bvp ) {
+void BVMinisatSatSolver::setProofLog(proof::ResolutionBitVectorProof* bvp)
+{
   d_minisat->setProofLog( bvp );
 }
 
diff --git a/src/prop/bvminisat/bvminisat.h b/src/prop/bvminisat/bvminisat.h
index 728d26bd4..16489b172 100644
--- a/src/prop/bvminisat/bvminisat.h
+++ b/src/prop/bvminisat/bvminisat.h
@@ -22,8 +22,10 @@
 
 #include "context/cdo.h"
 #include "proof/clause_id.h"
+#include "proof/resolution_bitvector_proof.h"
 #include "prop/bvminisat/simp/SimpSolver.h"
 #include "prop/sat_solver.h"
+#include "prop/bv_sat_solver_notify.h"
 #include "util/statistics_registry.h"
 
 namespace CVC4 {
@@ -35,10 +37,10 @@ class BVMinisatSatSolver : public BVSatSolverInterface,
  private:
   class MinisatNotify : public BVMinisat::Notify
   {
-    BVSatSolverInterface::Notify* d_notify;
+    BVSatSolverNotify* d_notify;
 
    public:
-    MinisatNotify(BVSatSolverInterface::Notify* notify) : d_notify(notify) {}
+    MinisatNotify(BVSatSolverNotify* notify) : d_notify(notify) {}
     bool notify(BVMinisat::Lit lit) override
     {
       return d_notify->notify(toSatLiteral(lit));
@@ -66,7 +68,7 @@ public:
   BVMinisatSatSolver(StatisticsRegistry* registry, context::Context* mainSatContext, const std::string& name = "");
   virtual ~BVMinisatSatSolver();
 
-  void setNotify(Notify* notify) override;
+  void setNotify(BVSatSolverNotify* notify) override;
 
   ClauseId addClause(SatClause& clause, bool removable) override;
 
@@ -117,7 +119,7 @@ public:
 
   void popAssumption() override;
 
-  void setProofLog(BitVectorProof* bvp) override;
+  void setProofLog(proof::ResolutionBitVectorProof* bvp) override;
 
  private:
   /* Disable the default constructor. */
diff --git a/src/prop/bvminisat/core/Solver.cc b/src/prop/bvminisat/core/Solver.cc
index a4b0248e0..a877f20c3 100644
--- a/src/prop/bvminisat/core/Solver.cc
+++ b/src/prop/bvminisat/core/Solver.cc
@@ -29,9 +29,9 @@ OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWA
 #include "base/output.h"
 #include "options/bv_options.h"
 #include "options/smt_options.h"
-#include "proof/bitvector_proof.h"
 #include "proof/clause_id.h"
 #include "proof/proof_manager.h"
+#include "proof/resolution_bitvector_proof.h"
 #include "proof/sat_proof.h"
 #include "proof/sat_proof_implementation.h"
 #include "prop/bvminisat/mtl/Sort.h"
@@ -1318,7 +1318,8 @@ void Solver::explain(Lit p, std::vector<Lit>& explanation) {
   }
 }
 
-void Solver::setProofLog( BitVectorProof * bvp ) {
+void Solver::setProofLog(proof::ResolutionBitVectorProof* bvp)
+{
   d_bvp = bvp;
   d_bvp->initSatProof(this);
   d_bvp->getSatProof()->registerTrueLit(mkLit(varTrue, false));
diff --git a/src/prop/bvminisat/core/Solver.h b/src/prop/bvminisat/core/Solver.h
index da4fb4c16..eef1c4e4c 100644
--- a/src/prop/bvminisat/core/Solver.h
+++ b/src/prop/bvminisat/core/Solver.h
@@ -39,7 +39,10 @@ namespace BVMinisat {
 class Solver;
 }
 
-class BitVectorProof;
+// TODO (aozdemir) replace this forward declaration with an include
+namespace proof {
+class ResolutionBitVectorProof;
+}
 
 namespace BVMinisat {
 
@@ -212,10 +215,10 @@ public:
     bool only_bcp;                      // solving mode in which only boolean constraint propagation is done
     void setOnlyBCP (bool val) { only_bcp = val;}
     void explain(Lit l, std::vector<Lit>& explanation);
-    
-    void setProofLog( CVC4::BitVectorProof * bvp );
 
-protected:
+    void setProofLog(CVC4::proof::ResolutionBitVectorProof* bvp);
+
+   protected:
 
     // has a clause been added
     bool                clause_added;
@@ -292,7 +295,7 @@ protected:
     bool                asynch_interrupt;
     
     //proof log
-    CVC4::BitVectorProof * d_bvp;
+    CVC4::proof::ResolutionBitVectorProof* d_bvp;
 
     // Main internal methods:
     //
diff --git a/src/prop/sat_solver.h b/src/prop/sat_solver.h
index 5222af200..49064c20f 100644
--- a/src/prop/sat_solver.h
+++ b/src/prop/sat_solver.h
@@ -26,13 +26,13 @@
 #include "context/cdlist.h"
 #include "context/context.h"
 #include "expr/node.h"
+#include "proof/resolution_bitvector_proof.h"
 #include "proof/clause_id.h"
 #include "prop/sat_solver_types.h"
+#include "prop/bv_sat_solver_notify.h"
 #include "util/statistics_registry.h"
 
 namespace CVC4 {
-  
-class BitVectorProof;
 
 namespace prop {
 
@@ -96,9 +96,9 @@ public:
 
   /** Check if the solver is in an inconsistent state */
   virtual bool ok() const = 0;
-  
-  virtual void setProofLog( BitVectorProof * bvp ) {}
-  
+
+  virtual void setProofLog(proof::ResolutionBitVectorProof* bvp) {}
+
 };/* class SatSolver */
 
 
@@ -107,27 +107,8 @@ public:
 
   virtual ~BVSatSolverInterface() {}
   /** Interface for notifications */
-  class Notify {
-  public:
-
-    virtual ~Notify() {};
-
-    /**
-     * If the notify returns false, the solver will break out of whatever it's currently doing
-     * with an "unknown" answer.
-     */
-    virtual bool notify(SatLiteral lit) = 0;
-
-    /**
-     * Notify about a learnt clause.
-     */
-    virtual void notify(SatClause& clause) = 0;
-    virtual void spendResource(unsigned amount) = 0;
-    virtual void safePoint(unsigned amount) = 0;
-
-  };/* class BVSatSolverInterface::Notify */
 
-  virtual void setNotify(Notify* notify) = 0;
+  virtual void setNotify(BVSatSolverNotify* notify) = 0;
 
   virtual void markUnremovable(SatLiteral lit) = 0;
 
diff --git a/src/prop/sat_solver_types.h b/src/prop/sat_solver_types.h
index f041f6898..ed1c5397d 100644
--- a/src/prop/sat_solver_types.h
+++ b/src/prop/sat_solver_types.h
@@ -24,8 +24,9 @@
 
 #include "cvc4_private.h"
 
-#include <string>
 #include <sstream>
+#include <string>
+#include <vector>
 
 namespace CVC4 {
 namespace prop {