- indentation is now done with tabs
[ginac.git] / ginac / fail.h
1 /** @file fail.h
2  *
3  *  Interface to class signaling failure of operation. Considered obsolete all
4  *  this stuff ought to be replaced by exceptions. */
5
6 /*
7  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software
21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23
24 #ifndef __GINAC_FAIL_H__
25 #define __GINAC_FAIL_H__
26
27 #include "basic.h"
28
29 #ifndef NO_NAMESPACE_GINAC
30 namespace GiNaC {
31 #endif // ndef NO_NAMESPACE_GINAC
32
33 class fail : public basic
34 {
35         GINAC_DECLARE_REGISTERED_CLASS(fail, basic)
36
37         // default constructor, destructor, copy constructor assignment operator and helpers
38 public:
39         fail();
40         ~fail();
41         fail(const fail & other);
42         const fail & operator=(const fail & other);
43 protected:
44         void copy(const fail & other);
45         void destroy(bool call_parent);
46
47         // other constructors
48         // none
49
50         // functions overriding virtual functions from bases classes
51 public:
52         basic * duplicate() const;
53         void print(std::ostream & os, unsigned upper_precedence=0) const;
54         void printraw(std::ostream & os) const;
55 protected:
56         int compare_same_type(const basic & other) const;
57         unsigned return_type(void) const { return return_types::noncommutative_composite; };
58         
59         // new virtual functions which can be overridden by derived classes
60         // none
61
62         // non-virtual functions in this class
63         // none
64
65 // member variables
66 // none
67 };
68
69 // global constants
70
71 extern const fail some_fail;
72 extern const type_info & typeid_fail;
73
74 #ifndef NO_NAMESPACE_GINAC
75 } // namespace GiNaC
76 #endif // ndef NO_NAMESPACE_GINAC
77
78 #endif // ndef __GINAC_FAIL_H__