ginac/structure.h

   1 /** @file structure.h
   2  *
   3  *  Interface to 'abstract' class structure. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 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_STRUCTURE_H__
  24 #define __GINAC_STRUCTURE_H__
  25
  26 #include "basic.h"
  27
  28 #ifndef NO_NAMESPACE_GINAC
  29 namespace GiNaC {
  30 #endif // ndef NO_NAMESPACE_GINAC
  31
  32 struct registered_structure_info {
  33         const char * name;
  34 };
  35
  36 /** The class structure is used to implement user defined classes
  37         with named members which behave similar to ordinary C structs.
  38         structure is an 'abstract' base class (it is possible but not
  39         meaningful to make instances), the user defined structures
  40         will be create by the perl script structure.pl */
  41
  42 class structure : public basic
  43 {
  44         GINAC_DECLARE_REGISTERED_CLASS(structure, basic)
  45
  46         // other constructors
  47         // none
  48
  49         // functions overriding virtual functions from bases classes
  50 public:
  51         void printraw(std::ostream & os) const;
  52         void print(std::ostream & os, unsigned upper_precedence=0) const;
  53         void printtree(std::ostream & os, unsigned indent) const;
  54         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  55 protected:
  56         bool is_equal_same_type(const basic & other) const;
  57
  58         // new virtual functions which can be overridden by derived classes
  59         // none
  60
  61         // non-virtual functions in this class
  62 protected:
  63         static std::vector<registered_structure_info> & registered_structures(void);
  64 public:
  65         static unsigned register_new(const char * nm);
  66
  67 // member variables
  68 // none
  69
  70 };
  71
  72 #ifndef NO_NAMESPACE_GINAC
  73 } // namespace GiNaC
  74 #endif // ndef NO_NAMESPACE_GINAC
  75
  76 #endif // ndef __GINAC_STRUCTURE_H__