VisItException.h 8.51 KB
Newer Older
hrchilds's avatar
hrchilds committed
1 2 3 4 5 6 7 8
// ************************************************************************* //
//                            VisItException.h                               //
// ************************************************************************* //

#ifndef VISIT_EXCEPTION_H
#define VISIT_EXCEPTION_H

#include <exception>
hrchilds's avatar
hrchilds committed
9
#include <visitstream.h>
hrchilds's avatar
hrchilds committed
10 11 12 13 14 15 16
#include <string>
#ifdef FAKE_EXCEPTIONS
#include <setjmp.h>
#endif

#include <misc_exports.h>

hrchilds's avatar
hrchilds committed
17 18 19
#ifdef FAKE_EXCEPTIONS
#define VISIT_THROW_NOTHING
#else
hrchilds's avatar
hrchilds committed
20
#define VISIT_THROW_NOTHING throw()
hrchilds's avatar
hrchilds committed
21
#endif
hrchilds's avatar
hrchilds committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

// ****************************************************************************
//  Class: VisItException
//
//  Purpose:
//      An abstract type that all VisIt exceptions should be derived from.
//
//  Note:   This is only a conceptionally abstract type, there are no
//          pure virtual functions.
//
//  Programmer: Hank Childs
//  Creation:   May 16, 2000
//
//  Modifications:
//    Jeremy Meredith, Fri Nov 17 17:23:00 PST 2000
//    Made log non-static, removed setLogFile, and removed InitVisItExceptions.
//
//    Kathleen Bonnell, Wed Apr 25 14:28:22 PDT 2001 
//    Added a method to return the message. 
//
//    Kathleen Bonnell, Fri Apr 27 10:43:22 PDT 2001 
//    Added ability to set message via constructor. 
//    Added a method to return the Exception type.
//
//    Brad Whitlock, Tue Oct 23 16:56:08 PST 2001
//    Added methods to return the filename and the line.
//
//    Kathleen Bonnell, Thu Nov  1 11:10:39 PST 2001 
//    Removed const from GetLine to remove sgi compiler warning.
//
//    Brad Whitlock, Thu Mar 14 13:37:34 PST 2002
//    Added exports and a work-around for the windows compiler.
//
//    Brad Whitlock, Fri Oct 25 12:23:27 PDT 2002
//    I fixed a bug in the fake exceptions' TRY statement that could let
//    nested TRY's rethrow a previously caught exception.
//
hrchilds's avatar
hrchilds committed
59 60 61
//    Eric Brugger, Wed Jul 23 13:46:05 PDT 2003
//    No longer inherit from exception.
//
hrchilds's avatar
hrchilds committed
62 63 64
//    Brad Whitlock, Mon Aug 25 15:05:14 PST 2003
//    Added LogCatch.
//
hrchilds's avatar
hrchilds committed
65 66
// ****************************************************************************

hrchilds's avatar
hrchilds committed
67
class MISC_API VisItException
hrchilds's avatar
hrchilds committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
{
  public:
                       VisItException();
                       VisItException(const std::string &msg);
    virtual           ~VisItException() VISIT_THROW_NOTHING {;};

    void               Log(void);
  
    void               SetThrowLocation(int, char *);
    void               SetType(char *t) { type = t; };
    void               SetType(const std::string &t) { type = t; };
    const std::string &GetMessage() { return msg; };
    const std::string &Message() { return msg; };
    const std::string &GetExceptionType() { return type; };

    int                GetLine() const { return line; };
    const std::string &GetFilename() const  { return filename; }; 

hrchilds's avatar
hrchilds committed
86 87 88
    static void LogCatch(const char *exceptionType, const char *srcFile,
                         int srcLine);

hrchilds's avatar
hrchilds committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  protected:
    int                line;
    std::string        filename;
    std::string        msg;
    std::string        type;
    ostream           *log;
};

#ifndef FAKE_EXCEPTIONS
//
// This is the case where we can count on C++ to do exceptions for us.
//
#define EXCEPTION0(e) \
{\
      e _visit_exception;\
      _visit_exception.SetType(#e);\
      _visit_exception.SetThrowLocation(__LINE__, __FILE__);\
      _visit_exception.Log();\
      throw _visit_exception;\
}

#define EXCEPTION1(e, a1) \
{\
      e _visit_exception(a1);\
      _visit_exception.SetType(#e);\
      _visit_exception.SetThrowLocation(__LINE__, __FILE__);\
      _visit_exception.Log();\
      throw _visit_exception;\
}

#define EXCEPTION2(e, a1, a2) \
{\
      e _visit_exception(a1, a2);\
      _visit_exception.SetType(#e);\
      _visit_exception.SetThrowLocation(__LINE__, __FILE__);\
      _visit_exception.Log();\
      throw _visit_exception;\
}

#define EXCEPTION3(e, a1, a2, a3) \
{\
      e _visit_exception(a1, a2, a3);\
      _visit_exception.SetType(#e);\
      _visit_exception.SetThrowLocation(__LINE__, __FILE__);\
      _visit_exception.Log();\
      throw _visit_exception;\
}

#define RECONSTITUTE_EXCEPTION(E, M) \
{ \
      VisItException _visit_exception(M); \
      _visit_exception.SetType(E);\
      _visit_exception.SetThrowLocation(__LINE__, __FILE__);\
      _visit_exception.Log();\
      throw _visit_exception;\
}

hrchilds's avatar
hrchilds committed
146 147 148 149 150
#define TRY                 try {
#define CATCH(T)            } catch(T)   { VisItException::LogCatch(#T, __FILE__,  __LINE__);
#define CATCH2(T, A)        } catch(T A) { VisItException::LogCatch(#T, __FILE__,  __LINE__);
#define CATCHALL(T)         } catch(...) { VisItException::LogCatch(#T, __FILE__,  __LINE__);
#define ENDTRY              }
hrchilds's avatar
hrchilds committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
#define RETHROW             throw
#define CATCH_RETURN(n)     return
#define CATCH_RETURN2(n, v) return (v)

#else
//
// We're simulating C++ exceptions.
//

// Macro to turn exception debugging on/off. When you want exception
// debugging output, add an A to the end of the line below.
#define EXPRINT(A)

extern int             jump_stack_top;
extern jmp_buf         jump_stack[100];
extern int             jump_retval;
extern bool            exception_caught;
extern VisItException *exception_object;

// Some prototypes that are used in the fake exception calls.
int  exception_lookup(const char *name);
bool exception_compatible(const char *name);
void exception_throw(int backup);
void exception_delete(bool condition);
int  exception_default_id();

// Use fake exceptions!
#define EXCEPTION0(e) \
{ \
    exception_object = new e; \
    exception_object->SetType(#e);\
    exception_object->SetThrowLocation(__LINE__, __FILE__);\
    exception_object->Log();\
    jump_retval = exception_lookup(#e); \
    exception_throw(0); \
}

#define EXCEPTION1(e, a1) \
{ \
    exception_object = new e(a1); \
    exception_object->SetType(#e);\
    exception_object->SetThrowLocation(__LINE__, __FILE__);\
    exception_object->Log();\
    jump_retval = exception_lookup(#e); \
    exception_throw(0); \
}

#define EXCEPTION2(e, a1, a2) \
{ \
    exception_object = new e(a1, a2); \
    exception_object->SetType(#e);\
    exception_object->SetThrowLocation(__LINE__, __FILE__);\
    exception_object->Log();\
    jump_retval = exception_lookup(#e); \
    exception_throw(0); \
}

#define EXCEPTION3(e, a1, a2, a3) \
{ \
    exception_object = new e(a1, a2, a3); \
    exception_object->SetType(#e);\
    exception_object->SetThrowLocation(__LINE__, __FILE__);\
    exception_object->Log();\
    jump_retval = exception_lookup(#e); \
    exception_throw(0); \
}

#define RECONSTITUTE_EXCEPTION(E, M) \
{ \
    exception_object = new VisItException(M); \
    exception_object->SetType(E);\
    exception_object->SetThrowLocation(__LINE__, __FILE__);\
    exception_object->Log();\
    jump_retval = exception_default_id(); \
    exception_throw(0); \
}

#define TRY \
    exception_delete(true); \
    ++jump_stack_top; \
    jump_retval = setjmp(jump_stack[jump_stack_top]); \
    exception_caught = false; \
    EXPRINT(debug1 << "TRY("<<jump_stack_top<<"): "<<__FILE__<<":"<<__LINE__<<" jump_retval = " << jump_retval << endl;) \
    if(jump_retval == 0) \
    {


#define CATCH(e) \
        exception_delete(exception_caught && (jump_retval != 0)); \
    } \
    else if(exception_compatible(#e)) \
    { \
hrchilds's avatar
hrchilds committed
243
        VisItException::LogCatch(#e, __FILE__,  __LINE__); \
hrchilds's avatar
hrchilds committed
244 245 246 247 248 249 250 251
        exception_caught = true;


#define CATCH2(e, N) \
        exception_delete(exception_caught && (jump_retval != 0)); \
    } \
    else if(exception_compatible(#e)) \
    { \
hrchilds's avatar
hrchilds committed
252
        VisItException::LogCatch(#e, __FILE__,  __LINE__); \
hrchilds's avatar
hrchilds committed
253 254 255 256 257 258 259 260 261
        e & N = *((e *)exception_object); \
        exception_caught = true;


#define CATCHALL(e) \
        exception_delete(jump_retval != 0); \
    } \
    else \
    { \
hrchilds's avatar
hrchilds committed
262
        VisItException::LogCatch(#e, __FILE__,  __LINE__); \
hrchilds's avatar
hrchilds committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
        exception_caught = true; \


#define ENDTRY  \
        exception_delete(exception_caught); \
    } \
    if(exception_object != 0) \
    { \
        EXPRINT(debug1 << "Uncaught " << exception_object->GetExceptionType() \
                       <<" exception at (" << __FILE__ << ":" \
                       << __LINE__ << ") top="<<jump_stack_top << endl;) \
        exception_throw(1); \
    } \
    --jump_stack_top; \
    EXPRINT(debug1 << "ENDTRY: jump_stack_top = " << jump_stack_top << endl;) \

#define RETHROW \
    if(exception_object != 0) \
        exception_throw(1);

#define CATCH_RETURN(n) \
{ \
    exception_delete(exception_caught); \
    jump_stack_top -= (n); \
    return; \
}

#define CATCH_RETURN2(n, v) \
{ \
    exception_delete(exception_caught); \
    jump_stack_top -= (n); \
    return (v); \
}
    
#endif

#endif