00001 /*======================================================================= 00002 * Copyright 1991-1996, Silicon Graphics, Inc. 00003 * ALL RIGHTS RESERVED 00004 * 00005 * UNPUBLISHED -- Rights reserved under the copyright laws of the United 00006 * States. Use of a copyright notice is precautionary only and does not 00007 * imply publication or disclosure. 00008 * 00009 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND: 00010 * Use, duplication or disclosure by the Government is subject to restrictions 00011 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights 00012 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or 00013 * in similar or successor clauses in the FAR, or the DOD or NASA FAR 00014 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc., 00015 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311. 00016 * 00017 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY 00018 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION, 00019 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY 00020 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON 00021 * GRAPHICS, INC. 00022 **=======================================================================*/ 00023 /*======================================================================= 00024 ** Author : Paul S. Strauss (MMM yyyy) 00025 **=======================================================================*/ 00026 /*======================================================================= 00027 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), *** 00028 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. *** 00029 *** *** 00030 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS *** 00031 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR *** 00032 *** WRITTEN AUTHORIZATION OF FEI S.A.S. *** 00033 *** *** 00034 *** RESTRICTED RIGHTS LEGEND *** 00035 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS *** 00036 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN *** 00037 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT *** 00038 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN *** 00039 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. *** 00040 *** *** 00041 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, *** 00042 *** BORDEAUX, FRANCE *** 00043 *** ALL RIGHTS RESERVED *** 00044 **=======================================================================*/ 00045 /*======================================================================= 00046 ** Modified by : VSG (Feb 2010) 00047 **=======================================================================*/ 00048 00049 #ifndef _SO_ERROR 00050 #define _SO_ERROR 00051 00052 #include <Inventor/SbBase.h> 00053 #include <Inventor/SbString.h> 00054 #include <Inventor/SoTypedObject.h> 00055 00056 class SoError; 00057 class SoBase; 00058 class SoEngine; 00059 class SoNode; 00060 class SoPath; 00061 00066 typedef void SoErrorCB(const SoError *error, void *data); 00067 00106 class SoError: public SoTypedObject { 00107 00108 public: 00112 static void setHandlerCallback(SoErrorCB *cb, void *data); 00117 static SoErrorCB* getHandlerCallback(); 00122 static void* getHandlerData(); 00123 00127 const SbString& getDebugString() const { return debugString; } 00128 00132 static SoType getClassTypeId(); 00133 00137 virtual SoType getTypeId() const; 00138 00142 virtual ~SoError() {} 00143 00148 SoPRINTF static void post(const char *formatString ...); 00149 00150 private: 00151 // Initializes SoError class 00152 static void initClass(); 00153 static void exitClass(); 00154 00155 static SoErrorCB* getDefaultHandlerCB() { return defaultHandlerCB; } 00156 00157 private: 00158 // The default error handler callback - it just prints to stderr 00159 static void defaultHandlerCB(const SoError *error, void *data); 00160 00161 // Returns handler callback (and data) to use for a given instance 00162 virtual SoErrorCB * getHandler(void *&data) const; 00163 virtual bool isInit() const; 00164 00165 // Sets/appends to the debug string 00166 void setDebugString(const SbString& string) 00167 { debugString = string; } 00168 void appendToDebugString(const SbString& string) 00169 { debugString += string; } 00170 00171 // Calls appropriate handler for an error instance. Application 00172 // writers can set breakpoints at this when debugging. 00173 void handleError(); 00174 00179 virtual void setDebugStringCapacity( int capacity ); 00180 00181 private: 00182 // Type id of SoError class 00183 static SoType classTypeId; 00184 // Handler callback for SoError class 00185 static SoErrorCB *handlerCB; 00186 // User data for callback 00187 static void *cbData; 00188 // TRUE if handler initialized 00189 static SbBool wasInitted; 00190 // Detailed error message string 00191 SbString debugString; 00192 // The getString() methods use this one 00193 static SbString getBaseString(const SoBase *base, const char *what); 00194 // allow to disable user error handler and keep everything in stderr. 00195 // see SoPreferences env var OIV_FORCE_DEFAULT_ERROR_HANDLER 00196 static SbBool s_forceDefaultHandler; 00197 }; 00198 00199 #endif /* _SO_ERROR */ 00200 00201 00202