ginac/print.h

   1 /** @file print.h
   2  *
   3  *  Definition of helper classes for expression output. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_PRINT_H__
  24 #define __GINAC_PRINT_H__
  25
  26 #include <iosfwd>
  27 #include <string>
  28
  29 namespace GiNaC {
  30
  31 /** Context for default (ginsh-parsable) output. */
  32 class print_context
  33 {
  34 public:
  35         print_context();
  36         print_context(std::ostream &);
  37
  38         std::ostream & s; /**< stream to output to */
  39 private:
  40         // dummy virtual function to make the class polymorphic
  41         virtual void dummy(void) {}
  42 };
  43
  44 /** Context for latex-parsable output. */
  45 class print_latex : public print_context
  46 {
  47 public:
  48         print_latex();
  49         print_latex(std::ostream &);
  50 };
  51
  52 /** Context for python pretty-print output. */
  53 class print_python : public print_context
  54 {
  55 public:
  56         print_python();
  57         print_python(std::ostream &);
  58 };
  59
  60 /** Context for python-parsable output. */
  61 class print_python_repr : public print_context
  62 {
  63 public:
  64         print_python_repr();
  65         print_python_repr(std::ostream &);
  66 };
  67
  68 /** Context for tree-like output for debugging. */
  69 class print_tree : public print_context
  70 {
  71 public:
  72         print_tree(unsigned d = 4);
  73         print_tree(std::ostream &, unsigned d = 4);
  74         const unsigned delta_indent; /**< size of indentation step */
  75 };
  76
  77 /** Base context for C source output. */
  78 class print_csrc : public print_context
  79 {
  80 public:
  81         print_csrc();
  82         print_csrc(std::ostream &);
  83 };
  84
  85 /** Context for C source output using float numbers. */
  86 class print_csrc_float : public print_csrc
  87 {
  88 public:
  89         print_csrc_float();
  90         print_csrc_float(std::ostream &);
  91 };
  92
  93 /** Context for C source output using double numbers. */
  94 class print_csrc_double : public print_csrc
  95 {
  96 public:
  97         print_csrc_double();
  98         print_csrc_double(std::ostream &);
  99 };
 100
 101 /** Context for C source output using CLN numbers. */
 102 class print_csrc_cl_N : public print_csrc
 103 {
 104 public:
 105         print_csrc_cl_N();
 106         print_csrc_cl_N(std::ostream &);
 107 };
 108
 109 /** Check if obj is a T, including base classes. */
 110 template <class T>
 111 inline bool is_a(const print_context & obj)
 112 { return dynamic_cast<const T *>(&obj)!=0; }
 113
 114 } // namespace GiNaC
 115
 116 #endif // ndef __GINAC_BASIC_H__