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-2020 BY FEI S.A.S, *** 00042 *** BORDEAUX, FRANCE *** 00043 *** ALL RIGHTS RESERVED *** 00044 **=======================================================================*/ 00045 /*======================================================================= 00046 ** Modified by : VSG (MMM YYYY) 00047 **=======================================================================*/ 00048 00049 00050 #ifndef _SO_DEBUG_ERROR 00051 #define _SO_DEBUG_ERROR 00052 00053 #include <Inventor/errors/SoError.h> 00054 #include <cstdarg> 00055 00056 #ifdef _WIN32 00057 #pragma warning(push) 00058 #pragma warning(disable:4251) 00059 #endif 00060 00062 // 00063 // Class: SoDebugError 00064 // 00065 // This class is used for all errors reported from the debugging 00066 // version of the Inventor library. These errors are typically 00067 // programmer errors, such as passing a NULL pointer or an 00068 // out-of-range index. The post() method takes the name of the 00069 // Inventor method that detected the error, to aid the programmer in 00070 // debugging. 00071 // 00073 00094 class SoDebugError : public SoError { 00095 00096 public: 00098 enum Severity { 00100 SERROR=0, // Error 00101 #if !defined(_WIN32) && !defined(__NUTC__) 00102 00107 ERROR=SERROR, 00108 #endif 00109 00112 WARNING=1, 00116 INFO=2 00117 }; 00118 00122 static void setHandlerCallback(SoErrorCB *cb, void *data); 00127 static SoErrorCB *getHandlerCallback(); 00132 static void *getHandlerData(); 00133 00137 static SoType getClassTypeId(); 00138 00142 virtual SoType getTypeId() const; 00143 00147 SoDebugError::Severity getSeverity() const { return severity; } 00148 00152 SoPRINTFPREFIX(2,3) static void post(const char *methodName, const char *formatString ...); 00153 00157 SoPRINTFPREFIX(2,3) static void postWarning(const char *methodName, const char *formatString ...); 00158 00162 SoPRINTFPREFIX(2,3) static void postInfo(const char *methodName, const char *formatString ...); 00163 00164 private: 00165 // Initializes SoDebugError class 00166 static void initClass(); 00167 static void exitClass(); 00168 00169 static SoErrorCB* getDefaultHandlerCB() { return defaultHandlerCB; } 00170 00175 SoPRINTFPREFIX(2,3) static void postOnce(const char *methodName, const char *formatString ...); 00176 00181 SoPRINTFPREFIX(2,3) static void postWarningOnce(const char *methodName, const char *formatString ...); 00182 00187 SoPRINTFPREFIX(2,3) static void postInfoOnce(const char *methodName, const char *formatString ...); 00188 00189 private: 00190 // Returns handler callback (and data) to use for a given instance 00191 virtual SoErrorCB *getHandler(void *&data) const; 00192 virtual bool isInit() const; 00193 00194 private: 00198 static SbString getFormattedString(const char *formatString, va_list argList); 00199 00203 static void postMessage(Severity messageType, const char *methodName, 00204 const char *formatString, va_list argList, bool alwaysEmit); 00205 00207 static std::set<SbString> s_emittedErrors; 00208 00209 static SoType classTypeId; // Type id of SoDebugError class 00210 static SoErrorCB *handlerCB; // Handler callback for class 00211 static void *cbData; // User data for callback 00212 static SbBool wasInitted; // TRUE if handler initialized 00213 00214 Severity severity; // Severity of error 00215 00216 }; 00217 00218 #ifdef _WIN32 00219 #pragma warning(pop) 00220 #endif 00221 00222 #endif /* _SO_DEBUG_ERROR */ 00223 00224 00225