a0fe9b7dfb5e26d58087482a54958a15583717b5
[ginac.git] / ginac / structure.h
1 /** @file structure.h
2  *
3  *  Interface to 'abstract' class structure. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2000 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 <ginac/basic.h>
27
28 #ifndef NO_GINAC_NAMESPACE
29 namespace GiNaC {
30 #endif // ndef NO_GINAC_NAMESPACE
31
32 struct registered_structure_info {
33     char const * 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(structure const & other);
51     structure const & operator=(structure const & other);
52 protected:
53     void copy(structure const & 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(ostream & os) const; 
63     void print(ostream & os, unsigned upper_precedence=0) const;
64     void printtree(ostream & os, unsigned indent) const;
65     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
66 protected:
67     int compare_same_type(basic const & other) const;
68     bool is_equal_same_type(basic const & 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 vector<registered_structure_info> & registered_structures(void);
76 public:
77     static unsigned register_new(char const * nm);
78
79 // member variables
80 // none
81
82 };
83
84 // global constants
85
86 extern const structure some_structure;
87 extern type_info const & typeid_structure;
88
89 #ifndef NO_GINAC_NAMESPACE
90 } // namespace GiNaC
91 #endif // ndef NO_GINAC_NAMESPACE
92
93 #endif // ndef __GINAC_STRUCTURE_H__