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 // member functions
  45
  46         // default constructor, destructor, copy constructor assignment operator and helpers
  47 public:
  48         structure();
  49         ~structure();
  50         structure(const structure & other);
  51         const structure & operator=(const structure & other);
  52 protected:
  53         void copy(const structure & other);
  54         void destroy(bool call_parent);
  55
  56         // other constructors
  57         // none
  58
  59         // functions overriding virtual functions from bases classes
  60 public:
  61         basic * duplicate() const;
  62         void printraw(std::ostream & os) const;
  63         void print(std::ostream & os, unsigned upper_precedence=0) const;
  64         void printtree(std::ostream & os, unsigned indent) const;
  65         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  66 protected:
  67         int compare_same_type(const basic & other) const;
  68         bool is_equal_same_type(const basic & other) const;
  69
  70         // new virtual functions which can be overridden by derived classes
  71         // none
  72
  73         // non-virtual functions in this class
  74 protected:
  75         static std::vector<registered_structure_info> & registered_structures(void);
  76 public:
  77         static unsigned register_new(const char * nm);
  78
  79 // member variables
  80 // none
  81
  82 };
  83
  84 #ifndef NO_NAMESPACE_GINAC
  85 } // namespace GiNaC
  86 #endif // ndef NO_NAMESPACE_GINAC
  87
  88 #endif // ndef __GINAC_STRUCTURE_H__