3478887507c11b20067c606650cd1cc14e25703a
[ginac.git] / ginac / structure.h
1 /** @file structure.h
2  *
3  *  Interface to 'abstract' class structure. */
4
5 /*
6  *  GiNaC Copyright (C) 1999 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 namespace GiNaC {
29
30 struct registered_structure_info {
31     char const * name;
32 };
33
34 /** The class structure is used to implement user defined classes
35     with named members which behave similar to ordinary C structs.
36     structure is an 'abstract' base class (it is possible but not
37     meaningful to make instances), the user defined structures
38     will be create by the perl script structure.pl */
39
40 class structure : public basic
41 {
42 // member functions
43
44     // default constructor, destructor, copy constructor assignment operator and helpers
45 public:
46     structure();
47     ~structure();
48     structure(structure const & other);
49     structure const & operator=(structure const & other);
50 protected:
51     void copy(structure const & other);
52     void destroy(bool call_parent);
53
54     // other constructors
55     // none
56
57     // functions overriding virtual functions from bases classes
58 public:
59     basic * duplicate() const;
60     void printraw(ostream & os) const; 
61     void print(ostream & os, unsigned upper_precedence=0) const;
62     void printtree(ostream & os, unsigned indent) const;
63     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
64 protected:
65     int compare_same_type(basic const & other) const;
66     bool is_equal_same_type(basic const & other) const;
67     
68     // new virtual functions which can be overridden by derived classes
69     // none
70     
71     // non-virtual functions in this class
72 protected:
73     static vector<registered_structure_info> & registered_structures(void);
74 public:
75     static unsigned register_new(char const * nm);
76
77 // member variables
78 // none
79
80 };
81
82 // global constants
83
84 extern const structure some_structure;
85 extern type_info const & typeid_structure;
86
87 } // namespace GiNaC
88
89 #endif // ndef __GINAC_STRUCTURE_H__