MeVis/ThirdParty/Sources/Inventor/inventor/lib/mevis/include/Inventor/SoCatch.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2004 MeVis gGmbH  All Rights Reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: MeVis, Center for Medical Diagnostic Systems and
 *  Visualization GmbH, Universitätsallee 29, D-28359 Bremen, GERMANY, or:
 *
 *  http://www.mevis.de
 *
 */

/*
 * Copyright (C) 2004   MeVis Research GmbH
 *
 _______________________________________________________________________
 _______________  M E V I S   R E S E A R C H   G M B H  _______________
 |
 |   Description:
 |   Macro file to implement exception handlers around some code to make
 |   code safe. In the case of caught exception an error message is composed
 |   and send to SoError.
 |   The usage of the exception handler is optional and can be enabled/disabled
 |   by the static class function SoCatch::enableExceptionHandling().
 |
 |   Author(s)      : Wolf Spindler, Felix Ritter
 |
 _______________  M E V I S   R E S E A R C H   G M B H  _______________
 _______________________________________________________________________
 */

#ifndef  _SO_CATCH_
#define  _SO_CATCH_

#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/errors/SoError.h>


class INVENTOR_API SoCatch
{
   public:

      static SbBool isExceptionHandlingEnabled();

      static void enableExceptionHandling(SbBool on);

      static void initClass();

      static void postExceptionMessage(SoType      ERR_OBJ_TYPE_ID,
                                       const char *OP_DESCR_STR,
                                       SoType      ACTION_TYPE_ID,
                                       const char *END_STR);

   private:

      static SbBool _isExceptionHandlingEnabled;

};

#if !defined(DISABLE_ERRORTRACING)

#define SO_CATCH_START \
    if (!SoCatch::isExceptionHandlingEnabled()) {


#define SO_CATCH_ELSE(CODE_BEFORE_TRY) \
    }                                  \
    else {                             \
      CODE_BEFORE_TRY                  \
      try {


#define SO_CATCH_END(ERR_OBJ_TYPE_ID, OP_DESCR_STR, ACTION_TYPE_ID, END_STR)    \
      }                                                       \
      catch(...) {                                            \
        /* Bad case, we caught a crash. Compose            */ \
        /* the error string and post it to SoError.        */ \
        try {                                                 \
          /* Do extra save message posting since we must   */ \
          /* assume that passed parameters (which could    */ \
          /* be expressions) also could be corrupt.        */ \
          SoCatch::postExceptionMessage(ERR_OBJ_TYPE_ID,      \
                                        OP_DESCR_STR,         \
                                        ACTION_TYPE_ID,       \
                                        END_STR);             \
        }                                                     \
        catch(...) {                                          \
          SoError::post("<Could not create error message "    \
                        "after catching fatal error>");       \
        }                                                     \
      } /* catch(...) */                                      \
    } /* else of SO_CATCH_ELSE */

#else  // DISABLE_ERRORTRACING

#define SO_CATCH_START \
    if(1) {
#define SO_CATCH_ELSE(CODE_BEFORE_TRY) \
    }                                  \
    else {
#define SO_CATCH_END(ERR_OBJ_TYPE_ID, OP_DESCR_STR, ACTION_TYPE_ID, END_STR) \
    }

#endif  // DISABLE_ERRORTRACING

#endif  // _SO_CATCH_