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