Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoDebugError.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25**=======================================================================*/
26/*=======================================================================
27 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
28 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
29 *** ***
30 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
31 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
32 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
33 *** ***
34 *** RESTRICTED RIGHTS LEGEND ***
35 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
36 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
37 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
38 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
39 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
40 *** ***
41 *** COPYRIGHT (C) 1996-2017 BY FEI S.A.S, ***
42 *** BORDEAUX, FRANCE ***
43 *** ALL RIGHTS RESERVED ***
44**=======================================================================*/
45/*=======================================================================
46** Modified by : VSG (MMM YYYY)
47**=======================================================================*/
48
49
50#ifndef _SO_DEBUG_ERROR
51#define _SO_DEBUG_ERROR
52
53#include <Inventor/errors/SoError.h>
54#include <cstdarg>
55
56#ifdef _WIN32
57#pragma warning(push)
58#pragma warning(disable:4251)
59#endif
60
62//
63// Class: SoDebugError
64//
65// This class is used for all errors reported from the debugging
66// version of the Inventor library. These errors are typically
67// programmer errors, such as passing a NULL pointer or an
68// out-of-range index. The post() method takes the name of the
69// Inventor method that detected the error, to aid the programmer in
70// debugging.
71//
73
93class SoDebugError : public SoError {
94
95 public:
97 enum Severity {
99 SERROR=0, // Error
100#if !defined(_WIN32)
107#endif
115 INFO=2
116 };
117
121 static void setHandlerCallback(SoErrorCB *cb, void *data);
131 static void *getHandlerData();
132
137
141 virtual SoType getTypeId() const;
142
146 SoDebugError::Severity getSeverity() const { return severity; }
147
151 SoPRINTFPREFIX(2,3) static void post(const char *methodName, const char *formatString ...);
152
156 SoPRINTFPREFIX(2,3) static void postWarning(const char *methodName, const char *formatString ...);
157
161 SoPRINTFPREFIX(2,3) static void postInfo(const char *methodName, const char *formatString ...);
162
163 private:
164 // Initializes SoDebugError class
165 static void initClass();
166 static void exitClass();
167
168 static SoErrorCB* getDefaultHandlerCB() { return defaultHandlerCB; }
169
174 SoPRINTFPREFIX(2,3) static void postOnce(const char *methodName, const char *formatString ...);
175
180 SoPRINTFPREFIX(2,3) static void postWarningOnce(const char *methodName, const char *formatString ...);
181
186 SoPRINTFPREFIX(2,3) static void postInfoOnce(const char *methodName, const char *formatString ...);
187
188 private:
189 // Returns handler callback (and data) to use for a given instance
190 virtual SoErrorCB *getHandler(void *&data) const;
191 virtual bool isInit() const;
192
193 private:
197 static SbString getFormattedString(const char *formatString, va_list argList);
198
202 static void postMessage(Severity messageType, const char *methodName,
203 const char *formatString, va_list argList, bool alwaysEmit);
204
206 static std::set<SbString> s_emittedErrors;
207
208 static SoType classTypeId; // Type id of SoDebugError class
209 static SoErrorCB *handlerCB; // Handler callback for class
210 static void *cbData; // User data for callback
211 static SbBool wasInitted; // TRUE if handler initialized
212
213 Severity severity; // Severity of error
214
215};
216
217#ifdef _WIN32
218#pragma warning(pop)
219#endif
220
221#endif /* _SO_DEBUG_ERROR */
222
223
Class for smart character strings.
Definition SbString.h:202
Debug error handling.
static SoErrorCB * getHandlerCallback()
Returns handler callback for SoDebugError class.
static void * getHandlerData()
Returns handler data for SoDebugError class.
virtual SoType getTypeId() const
Returns type identifier for error instance.
static void postWarning(const char *methodName, const char *formatString ...)
Posts a warning.
static SoType getClassTypeId()
Returns type identifier for SoDebugError class.
Severity
Error severity.
@ INFO
No error, just information.
@ WARNING
Just a warning.
@ SERROR
Error.
static void setHandlerCallback(SoErrorCB *cb, void *data)
Sets handler callback for SoDebugError class.
SoDebugError::Severity getSeverity() const
Returns severity of error (for use by handlers).
static void post(const char *methodName, const char *formatString ...)
Posts an error.
static void postInfo(const char *methodName, const char *formatString ...)
Posts an informational (non-error) message.
Error handling base class.
Definition SoError.h:109
void SoErrorCB(const SoError *error, void *data)
Error handling callbacks are of this type.
Definition SoError.h:69
Stores runtime type information.
Definition SoType.h:98
int SbBool
Boolean type.
Definition SbBase.h:87