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