SoError.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  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: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.2 $
 |
 |   Description:
 |      This file defines the base SoError class.
 |
 |   Classes:
 |      SoError
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_ERROR
#define  _SO_ERROR
 
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>
 
class SoError;          
 
class SoBase;
class SoEngine;
class SoNode;
class SoPath;
 
typedef void INVENTOR_API SoErrorCB(const SoError *error, void *data);
 
 
 
class INVENTOR_API SoError {
 
  public:
 
    static void         setHandlerCallback(SoErrorCB *cb, void *data)
        { handlerCB = cb; cbData = data; }
    static SoErrorCB *  getHandlerCallback()    { return handlerCB; }
    static void *       getHandlerData()        { return cbData; }
 
    const SbString &    getDebugString() const { return debugString; }
 
    static SoType       getClassTypeId()        { return classTypeId; }
 
    virtual SoType      getTypeId() const;
 
    bool                isOfType(SoType type) const;
 
  SoEXTENDER public:
    static void         post(const char *formatString ...);
 
    static SbString     getString(const SoNode *node);
    static SbString     getString(const SoPath *path);
    static SbString     getString(const SoEngine *engine);
 
  SoINTERNAL public:
    static void         initClass();
 
    static void         initClasses();
 
  protected:
    static void         defaultHandlerCB(const SoError *error, void *data);
 
    virtual SoErrorCB * getHandler(void *&data) const;
 
    void                setDebugString(const char *string)
        { debugString = string; }
    void                appendToDebugString(const char *string)
        { debugString += string; }
 
    void                handleError();
 
    virtual ~SoError() {}
 
  private:
    static SoType       classTypeId;    
    static SoErrorCB    *handlerCB;     
    static void         *cbData;        
    static bool         wasInitted;     
    SbString            debugString;    
 
    static SbString     getBaseString(const SoBase *base, const char *what);
};
 
#endif /* _SO_ERROR */