7edc7b1bd842f972c1a2d3b3f739bec6c22cc010
[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 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 <ginac/basic.h>
28
29 namespace GiNaC {
30
31 class fail : public basic
32 {
33 // member functions
34
35     // default constructor, destructor, copy constructor assignment operator and helpers
36 public:
37     fail();
38     ~fail();
39     fail(fail const & other);
40     fail const & operator=(fail const & other);
41 protected:
42     void copy(fail const & other);
43     void destroy(bool call_parent);
44
45     // other constructors
46     // none
47
48     // functions overriding virtual functions from bases classes
49 public:
50     basic * duplicate() const;
51     void printraw(ostream & os) const;
52     void print(ostream & os, unsigned upper_precedence=0) const;
53 protected:
54     int compare_same_type(basic const & other) const;
55     unsigned return_type(void) const { return return_types::noncommutative_composite; };
56     
57     // new virtual functions which can be overridden by derived classes
58     // none
59
60     // non-virtual functions in this class
61     // none
62
63 // member variables
64 // none
65 };
66
67 // global constants
68
69 extern const fail some_fail;
70 extern type_info const & typeid_fail;
71
72 } // namespace GiNaC
73
74 #endif // ndef __GINAC_FAIL_H__