src/printer/printer.h

   1 /*********************                                                        */
   2 /*! \file printer.h
   3  ** \verbatim
   4  ** Original author: Morgan Deters
   5  ** Major contributors: none
   6  ** Minor contributors (to current version): Clark Barrett, Andrew Reynolds
   7  ** This file is part of the CVC4 project.
   8  ** Copyright (c) 2009-2013  New York University and The University of Iowa
   9  ** See the file COPYING in the top-level source directory for licensing
  10  ** information.\endverbatim
  11  **
  12  ** \brief Base of the pretty-printer interface
  13  **
  14  ** Base of the pretty-printer interface.
  15  **/
  16
  17 #include "cvc4_private.h"
  18
  19 #ifndef __CVC4__PRINTER__PRINTER_H
  20 #define __CVC4__PRINTER__PRINTER_H
  21
  22 #include "util/language.h"
  23 #include "util/sexpr.h"
  24 #include "util/util_model.h"
  25 #include "expr/node.h"
  26 #include "expr/command.h"
  27
  28 namespace CVC4 {
  29
  30 class Printer {
  31   /** Printers for each OutputLanguage */
  32   static Printer* d_printers[language::output::LANG_MAX];
  33
  34   /** Make a Printer for a given OutputLanguage */
  35   static Printer* makePrinter(OutputLanguage lang) throw();
  36
  37   // disallow copy, assignment
  38   Printer(const Printer&) CVC4_UNUSED;
  39   Printer& operator=(const Printer&) CVC4_UNUSED;
  40
  41 protected:
  42   // derived classes can construct, but no one else.
  43   Printer() throw() {}
  44
  45   /** write model response to command */
  46   virtual void toStream(std::ostream& out, const Model& m, const Command* c) const throw() = 0;
  47
  48   /** write model response to command using another language printer */
  49   void toStreamUsing(OutputLanguage lang, std::ostream& out, const Model& m, const Command* c) const throw() {
  50     getPrinter(lang)->toStream(out, m, c);
  51   }
  52
  53 public:
  54   /** Get the Printer for a given OutputLanguage */
  55   static Printer* getPrinter(OutputLanguage lang) throw() {
  56     if(lang == language::output::LANG_AUTO) {
  57       lang = language::output::LANG_CVC4; // default
  58     }
  59     if(d_printers[lang] == NULL) {
  60       d_printers[lang] = makePrinter(lang);
  61     }
  62     return d_printers[lang];
  63   }
  64
  65   /** Write a Node out to a stream with this Printer. */
  66   virtual void toStream(std::ostream& out, TNode n,
  67                         int toDepth, bool types, size_t dag) const throw() = 0;
  68
  69   /** Write a Command out to a stream with this Printer. */
  70   virtual void toStream(std::ostream& out, const Command* c,
  71                         int toDepth, bool types, size_t dag) const throw() = 0;
  72
  73   /** Write a CommandStatus out to a stream with this Printer. */
  74   virtual void toStream(std::ostream& out, const CommandStatus* s) const throw() = 0;
  75
  76   /** Write an SExpr out to a stream with this Printer. */
  77   virtual void toStream(std::ostream& out, const SExpr& sexpr) const throw();
  78
  79   /**
  80    * Write a Result out to a stream with this Printer.
  81    *
  82    * The default implementation writes a reasonable string in lowercase
  83    * for sat, unsat, valid, invalid, or unknown results.  This behavior
  84    * is overridable by each Printer, since sometimes an output language
  85    * has a particular preference for how results should appear.
  86    */
  87   virtual void toStream(std::ostream& out, const Result& r) const throw();
  88
  89   /** Write a Model out to a stream with this Printer. */
  90   virtual void toStream(std::ostream& out, const Model& m) const throw();
  91
  92 };/* class Printer */
  93
  94 }/* CVC4 namespace */
  95
  96 #endif /* __CVC4__PRINTER__PRINTER_H */
  97