1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkDebugLeaks.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkDebugLeaks - identify memory leaks at program termination
// .SECTION Description
// vtkDebugLeaks is used to report memory leaks at the exit of the program.
// It uses the vtkObjectFactory to intercept the construction of all VTK
// objects. It uses the UnRegister method of vtkObject to intercept the
// destruction of all objects. A table of object name to number of instances
// is kept. At the exit of the program if there are still VTK objects around
// it will print them out. To enable this class add the flag
// -DVTK_DEBUG_LEAKS to the compile line, and rebuild vtkObject and
// vtkObjectFactory.
#ifndef vtkDebugLeaks_h
#define vtkDebugLeaks_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkToolkits.h" // Needed for VTK_DEBUG_LEAKS macro setting.
#include "vtkDebugLeaksManager.h" // Needed for proper singleton initialization
class vtkDebugLeaksHashTable;
class vtkSimpleCriticalSection;
class vtkDebugLeaksObserver;
class VTKCOMMONCORE_EXPORT vtkDebugLeaks : public vtkObject
{
public:
static vtkDebugLeaks *New();
vtkTypeMacro(vtkDebugLeaks,vtkObject);
// Description:
// Call this when creating a class of a given name.
static void ConstructClass(const char* classname);
// Description:
// Call this when deleting a class of a given name.
static void DestructClass(const char* classname);
// Description:
// Print all the values in the table. Returns non-zero if there
// were leaks.
static int PrintCurrentLeaks();
// Description:
// Get/Set flag for exiting with an error when leaks are present.
// Default is on when VTK_DEBUG_LEAKS is on and off otherwise.
static int GetExitError();
static void SetExitError(int);
static void SetDebugLeaksObserver(vtkDebugLeaksObserver* observer);
static vtkDebugLeaksObserver* GetDebugLeaksObserver();
protected:
vtkDebugLeaks(){}
virtual ~vtkDebugLeaks(){}
static int DisplayMessageBox(const char*);
static void ClassInitialize();
static void ClassFinalize();
static void ConstructingObject(vtkObjectBase* object);
static void DestructingObject(vtkObjectBase* object);
friend class vtkDebugLeaksManager;
friend class vtkObjectBase;
private:
static vtkDebugLeaksHashTable* MemoryTable;
static vtkSimpleCriticalSection* CriticalSection;
static vtkDebugLeaksObserver* Observer;
static int ExitError;
vtkDebugLeaks(const vtkDebugLeaks&); // Not implemented.
void operator=(const vtkDebugLeaks&); // Not implemented.
};
// This class defines callbacks for debugging tools. The callbacks are not for general use.
// The objects passed as arguments to the callbacks are in partially constructed or destructed
// state and accessing them may cause undefined behavior.
class VTKCOMMONCORE_EXPORT vtkDebugLeaksObserver {
public:
virtual ~vtkDebugLeaksObserver() {}
virtual void ConstructingObject(vtkObjectBase*) = 0;
virtual void DestructingObject(vtkObjectBase*) = 0;
};
#endif // vtkDebugLeaks_h
// VTK-HeaderTest-Exclude: vtkDebugLeaks.h
|
