Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoMemoryError.h
Go to the documentation of this file.
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-2014 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_MEMORY_ERROR
51#define _SO_MEMORY_ERROR
52
54
55class SbThreadMutex;
56class SoMemoryError;
57
72typedef bool SoMemoryCleanupCB(const size_t requestedByteSize, void* data);
73
94class SoMemoryError : public SoError {
95
96 public:
97
101 static void setHandlerCallback(SoErrorCB *cb, void *data);
102
108
113 static void* getHandlerData();
114
119 static void setMemoryCleanupCallback(SoMemoryCleanupCB *cb, void * data);
120
125
129 virtual SoType getTypeId() const;
130
134 static void post(const SbString& whatWasAllocated);
135
139 static void post(const char* whatWasAllocated);
140
141 private:
142 // Initializes SoMemoryError class
143 static void initClass();
144 static void exitClass();
145 static SoErrorCB* getDefaultHandlerCB() { return defaultHandlerCB; }
146 static bool getMemorySpace(const size_t size);
147
148 private:
149 // Returns handler callback (and data) to use for a given instance
150 virtual SoErrorCB * getHandler(void *&data) const;
151 virtual bool isInit() const;
152
153 private:
154 // Type id of SoMemoryError class
155 static SoType classTypeId;
156 // Handler callback for class
157 static SoErrorCB *handlerCB;
158 // User data for callback
159 static void *cbData;
160 // TRUE if handler initialized
161 static SbBool wasInitted;
162
163 static SoMemoryError* s_memoryErrorObject;
164 static SbThreadMutex* s_threadMutex;
165 static SbString* s_memoryErrorString;
166
167 // This allow to avoid infinite loop in this code
168 // when user set an error callback that need allocation itself.
169 static bool s_memoryFreeSpaceLoop;
170 static SoMemoryCleanupCB* s_memoryCleanupCB;
171 static void* s_memoryCleanupData;
172
173};
174
175#endif /* _SO_MEMORY_ERROR */
176
void SoErrorCB(const SoError *error, void *data)
Error handling callbacks are of this type.
Definition SoError.h:66
bool SoMemoryCleanupCB(const size_t requestedByteSize, void *data)
Memory cleanup handling callback.
Class for smart character strings.
Definition SbString.h:202
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Portable mutex c...
Error handling base class.
Definition SoError.h:106
Memory error handling.
virtual SoType getTypeId() const
Returns type identifier for an instance of this class.
static void setHandlerCallback(SoErrorCB *cb, void *data)
Sets handler callback for SoMemoryError class.
static SoType getClassTypeId()
Returns type identifier for SoMemoryError class.
static void setMemoryCleanupCallback(SoMemoryCleanupCB *cb, void *data)
Sets memory cleanup handler callback for SoMemoryError class.
static void * getHandlerData()
Returns handler data for SoMemoryError class.
static void post(const char *whatWasAllocated)
Posts an error.
static void post(const SbString &whatWasAllocated)
Posts an error.
static SoErrorCB * getHandlerCallback()
Returns handler callback for SoMemoryError class.
Stores runtime type information.
Definition SoType.h:98
int SbBool
Boolean type.
Definition SbBase.h:87
size_t size() const