Updating the copyright headers and scripts.
[cvc5.git] / src / printer / printer.h
1 /********************* */
2 /*! \file printer.h
3 ** \verbatim
4 ** Top contributors (to current version):
5 ** Morgan Deters, Tim King, Andrew Reynolds
6 ** This file is part of the CVC4 project.
7 ** Copyright (c) 2009-2016 by the authors listed in the file AUTHORS
8 ** in the top-level source directory) and their institutional affiliations.
9 ** All rights reserved. See the file COPYING in the top-level source
10 ** directory for licensing 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 <map>
23 #include <string>
24
25 #include "expr/node.h"
26 #include "options/language.h"
27 #include "smt/command.h"
28 #include "smt/model.h"
29 #include "util/sexpr.h"
30
31 namespace CVC4 {
32
33 class Printer {
34 /** Printers for each OutputLanguage */
35 static Printer* d_printers[language::output::LANG_MAX];
36
37 /** Make a Printer for a given OutputLanguage */
38 static Printer* makePrinter(OutputLanguage lang) throw();
39
40 // disallow copy, assignment
41 Printer(const Printer&) CVC4_UNDEFINED;
42 Printer& operator=(const Printer&) CVC4_UNDEFINED;
43
44 protected:
45 // derived classes can construct, but no one else.
46 Printer() throw() {}
47 virtual ~Printer() {}
48
49 /** write model response to command */
50 virtual void toStream(std::ostream& out, const Model& m, const Command* c) const throw() = 0;
51
52 /** write model response to command using another language printer */
53 void toStreamUsing(OutputLanguage lang, std::ostream& out, const Model& m, const Command* c) const throw() {
54 getPrinter(lang)->toStream(out, m, c);
55 }
56
57 public:
58 /** Get the Printer for a given OutputLanguage */
59 static Printer* getPrinter(OutputLanguage lang) throw();
60
61 /** Write a Node out to a stream with this Printer. */
62 virtual void toStream(std::ostream& out, TNode n,
63 int toDepth, bool types, size_t dag) const throw() = 0;
64
65 /** Write a Command out to a stream with this Printer. */
66 virtual void toStream(std::ostream& out, const Command* c,
67 int toDepth, bool types, size_t dag) const throw() = 0;
68
69 /** Write a CommandStatus out to a stream with this Printer. */
70 virtual void toStream(std::ostream& out, const CommandStatus* s) const throw() = 0;
71
72
73
74 /** Write a Model out to a stream with this Printer. */
75 virtual void toStream(std::ostream& out, const Model& m) const throw();
76
77 /** Write an UnsatCore out to a stream with this Printer. */
78 virtual void toStream(std::ostream& out, const UnsatCore& core) const throw();
79
80 /** Write an UnsatCore out to a stream with this Printer. */
81 virtual void toStream(std::ostream& out, const UnsatCore& core, const std::map<Expr, std::string>& names) const throw();
82
83 };/* class Printer */
84
85 }/* CVC4 namespace */
86
87 #endif /* __CVC4__PRINTER__PRINTER_H */