SoError.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (Feb 2010)
**=======================================================================*/
 
#ifndef  _SO_ERROR
#define  _SO_ERROR
 
#include <Inventor/SbBase.h>
#include <Inventor/SbString.h>
#include <Inventor/SoTypedObject.h>
 
class SoError;
class SoBase;
class SoEngine;
class SoNode;
class SoPath;

typedef void    SoErrorCB(const SoError *error, void *data);

class  SoError: public SoTypedObject {
 
 public:
  static void setHandlerCallback(SoErrorCB *cb, void *data);
  static SoErrorCB* getHandlerCallback();
  static void* getHandlerData();

  const SbString& getDebugString() const { return debugString; }

  static SoType getClassTypeId();

  virtual SoType getTypeId() const;

  virtual ~SoError() {}

  SoPRINTF static void post(const char *formatString ...);
 
 private:
  // Initializes SoError class
  static void         initClass();
  static void         exitClass();
 
  static SoErrorCB* getDefaultHandlerCB() { return defaultHandlerCB; }
 
 private:
  // The default error handler callback - it just prints to stderr
  static void defaultHandlerCB(const SoError *error, void *data);
 
  // Returns handler callback (and data) to use for a given instance
  virtual SoErrorCB * getHandler(void *&data) const;
  virtual bool isInit() const;
 
  // Sets/appends to the debug string
  void setDebugString(const SbString& string)
    { debugString = string; }
  void appendToDebugString(const SbString& string)
    { debugString += string; }
 
  // Calls appropriate handler for an error instance. Application
  // writers can set breakpoints at this when debugging.
  void handleError();
 
  virtual void setDebugStringCapacity( int capacity );
 
 private:
  // Type id of SoError class
  static SoType classTypeId;
  // Handler callback for SoError class
  static SoErrorCB *handlerCB;
  // User data for callback
  static void *cbData;
  // TRUE if handler initialized
  static SbBool wasInitted;
  // Detailed error message string
  SbString debugString;
  // The getString() methods use this one
  static SbString getBaseString(const SoBase *base, const char *what);
  // allow to disable user error handler and keep everything in stderr.
  // see SoPreferences env var OIV_FORCE_DEFAULT_ERROR_HANDLER
  static SbBool s_forceDefaultHandler;
};
 
#endif /* _SO_ERROR */