cbe44758c0e6910b0334b90c7c79dbacd8479d59
[ginac.git] / ginac / structure.h
1 /** @file structure.h
2  *
3  *  Interface to 'abstract' class structure.
4  *
5  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, write to the Free Software
19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #ifndef __GINAC_STRUCTURE_H__
23 #define __GINAC_STRUCTURE_H__
24
25 #include <ginac/basic.h>
26
27 struct registered_structure_info {
28     char const * name;
29 };
30
31 /** The class structure is used to implement user defined classes
32     with named members which behave similar to ordinary C structs.
33     structure is an 'abstract' base class (it is possible but not
34     meaningful to make instances), the user defined structures
35     will be create by the perl script structure.pl */
36
37 class structure : public basic
38 {
39 // member functions
40
41     // default constructor, destructor, copy constructor assignment operator and helpers
42 public:
43     structure();
44     ~structure();
45     structure(structure const & other);
46     structure const & operator=(structure const & other);
47 protected:
48     void copy(structure const & other);
49     void destroy(bool call_parent);
50
51     // other constructors
52     // none
53
54     // functions overriding virtual functions from bases classes
55 public:
56     basic * duplicate() const;
57     void printraw(ostream & os) const; 
58     void print(ostream & os, unsigned upper_precedence=0) const;
59     void printtree(ostream & os, unsigned indent) const;
60     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
61 protected:
62     int compare_same_type(basic const & other) const;
63     bool is_equal_same_type(basic const & other) const;
64     
65     // new virtual functions which can be overridden by derived classes
66     // none
67     
68     // non-virtual functions in this class
69 protected:
70     static vector<registered_structure_info> & registered_structures(void);
71 public:
72     static unsigned register_new(char const * nm);
73
74 // member variables
75 // none
76
77 };
78
79 // global constants
80
81 extern const structure some_structure;
82 extern type_info const & typeid_structure;
83
84 #endif // ndef __GINAC_STRUCTURE_H__
85