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