]>
Commit | Line | Data |
---|---|---|
1 | % | |
2 | % automatically generated by HelpGen $Revision$ from | |
3 | % garbagec.h at 21/Jan/02 21:14:19 | |
4 | % | |
5 | ||
6 | ||
7 | \section{\class{GarbageCollector}}\label{garbagecollector} | |
8 | ||
9 | ||
10 | This class implements an extremely slow but simple garbage collection algorithm. | |
11 | ||
12 | \wxheading{Derived from} | |
13 | ||
14 | No base class | |
15 | ||
16 | \wxheading{Include files} | |
17 | ||
18 | <garbagec.h> | |
19 | ||
20 | \wxheading{Data structures} | |
21 | ||
22 | \latexignore{\rtfignore{\wxheading{Members}}} | |
23 | ||
24 | ||
25 | \membersection{GarbageCollector::GarbageCollector}\label{garbagecollectorgarbagecollector} | |
26 | ||
27 | \func{}{GarbageCollector}{\void} | |
28 | ||
29 | Default constructor. | |
30 | ||
31 | ||
32 | \membersection{GarbageCollector::\destruct{GarbageCollector}}\label{garbagecollectordtor} | |
33 | ||
34 | \func{}{\destruct{GarbageCollector}}{\void} | |
35 | ||
36 | Destructor. | |
37 | ||
38 | ||
39 | \membersection{GarbageCollector::AddDependency}\label{garbagecollectoradddependency} | |
40 | ||
41 | \func{void}{AddDependency}{\param{void* }{pObj}, \param{void* }{pDependsOnObj}} | |
42 | ||
43 | Prepare data for garbage collection. | |
44 | ||
45 | ||
46 | \membersection{GarbageCollector::AddObject}\label{garbagecollectoraddobject} | |
47 | ||
48 | \func{void}{AddObject}{\param{void* }{pObj}, \param{int }{refCnt = 1}} | |
49 | ||
50 | Prepare data for garbage collection. | |
51 | ||
52 | ||
53 | \membersection{GarbageCollector::ArrangeCollection}\label{garbagecollectorarrangecollection} | |
54 | ||
55 | \func{void}{ArrangeCollection}{\void} | |
56 | ||
57 | Executes garbage collection algorithm. | |
58 | ||
59 | ||
60 | \membersection{GarbageCollector::DestroyItemList}\label{garbagecollectordestroyitemlist} | |
61 | ||
62 | \func{void}{DestroyItemList}{\param{wxList\& }{lst}} | |
63 | ||
64 | Destroys a list of items. | |
65 | ||
66 | ||
67 | \membersection{GarbageCollector::FindItemNode}\label{garbagecollectorfinditemnode} | |
68 | ||
69 | \func{wxNode*}{FindItemNode}{\param{void* }{pForObj}} | |
70 | ||
71 | Internal method for finding a node. | |
72 | ||
73 | ||
74 | \membersection{GarbageCollector::FindReferenceFreeItemNode}\label{garbagecollectorfindreferencefreeitemnode} | |
75 | ||
76 | \func{wxNode*}{FindReferenceFreeItemNode}{\void} | |
77 | ||
78 | Internal method for findind and freeing a node. | |
79 | ||
80 | ||
81 | \membersection{GarbageCollector::GetCycledObjects}\label{garbagecollectorgetcycledobjects} | |
82 | ||
83 | \func{wxList\&}{GetCycledObjects}{\void} | |
84 | ||
85 | Get cycled objects. | |
86 | ||
87 | ||
88 | \membersection{GarbageCollector::GetRegularObjects}\label{garbagecollectorgetregularobjects} | |
89 | ||
90 | \func{wxList\&}{GetRegularObjects}{\void} | |
91 | ||
92 | Accesses the results of the algorithm. | |
93 | ||
94 | ||
95 | \membersection{GarbageCollector::RemoveReferencesToNode}\label{garbagecollectorremovereferencestonode} | |
96 | ||
97 | \func{void}{RemoveReferencesToNode}{\param{wxNode* }{pItemNode}} | |
98 | ||
99 | Remove references to this node. | |
100 | ||
101 | ||
102 | \membersection{GarbageCollector::Reset}\label{garbagecollectorreset} | |
103 | ||
104 | \func{void}{Reset}{\void} | |
105 | ||
106 | Removes all data from the garbage collector. | |
107 | ||
108 | ||
109 | \membersection{GarbageCollector::ResolveReferences}\label{garbagecollectorresolvereferences} | |
110 | ||
111 | \func{void}{ResolveReferences}{\void} | |
112 | ||
113 | Internal method for resolving references. | |
114 |