Coin: SoDebugError.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoDebugError.h
1#ifndef COIN_SODEBUGERROR_H
2#define COIN_SODEBUGERROR_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/errors/SoError.h>
37#include <Inventor/C/errors/debugerror.h>
38
39// Avoid problem with Microsoft Win32 API headers (yes, they actually
40// #define ERROR -- in wingdi.h).
41#if defined(ERROR)
42#define SODEBUGERROR_STORE_ERROR_DEF ERROR
43#undef ERROR
44#endif /* ERROR */
45
46
47 class COIN_DLL_API SoDebugError : public SoError {
48 typedef SoError inherited;
49
50public:
51 enum Severity { ERROR, WARNING, INFO };
52
53 static void setHandlerCallback(SoErrorCB * const function,
54 void * const data);
55 static SoErrorCB * getHandlerCallback(void);
56 static void * getHandlerData(void);
57
58 static SoType getClassTypeId(void);
59 virtual SoType getTypeId(void) const;
60
61 SoDebugError::Severity getSeverity(void) const;
62
63 static void post(const char * const source, const char * const format, ...);
64 static void postWarning(const char * const source, const char * const format, ...);
65 static void postInfo(const char * const source, const char * const format, ...);
66
67 static void initClass(void);
68
69protected:
70 virtual SoErrorCBPtr getHandler(void * & data) const;
71
72private:
73 static void callbackForwarder(const struct cc_debugerror * error, void * data);
74 static void commonPostHandling(Severity severity, const char * type,
75 const char * source, const SbString & s);
76
77 static SoType classTypeId;
78 static SoErrorCB * callback;
79 static void * callbackData;
80 Severity severity;
81};
82
83// Avoid problem with Microsoft Win32 API headers (see above).
84#if defined(SODEBUGERROR_STORE_ERROR_DEF)
85#define ERROR SODEBUGERROR_STORE_ERROR_DEF
86#undef SODEBUGERROR_STORE_ERROR_DEF
87#endif /* SODEBUGERROR_STORE_ERROR_DEF */
88
89#endif // !COIN_SODEBUGERROR_H
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoDebugError
The SoDebugError class is the internal debugging message passing mechanism.
Definition SoDebugError.h:47
SoDebugError::Severity
Severity
Definition SoDebugError.h:51
SoDebugError::ERROR
@ ERROR
Definition SoDebugError.h:51
SoError
The SoError class is the base class for all the error handling classes.
Definition SoError.h:50
SoError::initClass
static void initClass(void)
Definition SoError.cpp:115
SoError::getHandlerCallback
static SoErrorCB * getHandlerCallback(void)
Definition SoError.cpp:203
SoError::setHandlerCallback
static void setHandlerCallback(SoErrorCB *const func, void *const data)
Definition SoError.cpp:181
SoError::getHandler
virtual SoErrorCBPtr getHandler(void *&data) const
Definition SoError.cpp:297
SoError::getTypeId
virtual SoType getTypeId(void) const
Definition SoError.cpp:154
SoError::post
static void post(const char *const format,...)
Definition SoError.cpp:236
SoError::getHandlerData
static void * getHandlerData(void)
Definition SoError.cpp:213
SoError::getClassTypeId
static SoType getClassTypeId(void)
Definition SoError.cpp:141
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
cc_debugerror
Definition debugerror.h:53