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