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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
FileReferenceList
====================================================================
-->
<module name="FileReferenceList">
<short>Contains types and classes used to implement a list of file references.</short>
<descr>
<p>
Implements the <var>TFileReference</var> and <var>TFileReferenceList</var> classes. Provides a list of file references with reference counters and a search path for files in the list.
</p>
<p>
Author: Mattias Gaertner
</p>
</descr>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Laz_AVL_Tree"/>
<element name="LazFileUtils"/>
<element name="LazFileCache"/>
<element name="LazTracer"/>
<element name="TFileReference">
<short>Represents a reference-counted file stored in TFileReferenceList.</short>
<descr>
<p>
<var>TFileReference</var> is a class used to represent a reference-counted file stored in the <var>TFileReferenceList</var> class. It provides <var>FileName</var> and <var>ReferenceCount</var> properties which are maintained by methods in TFileReferenceList.
</p>
</descr>
<seealso>
<link id="TFileReferenceList"/>
</seealso>
</element>
<!-- private -->
<element name="TFileReference.fFilename"/>
<element name="TFileReference.fReferenceCount"/>
<!-- public -->
<element name="TFileReference.Filename">
<short>Contains the name for the reference-counted file in the class instance.</short>
<descr>
<p>
<var>FileName</var> is a read-only String property with the name for the reference-counted file. The value in FileName is assigned in the <var>TFileReferenceList.AddFilename</var> method when the class instance is created.
</p>
<p>
Use <var>ReferenceCount</var> to determine the number of times the file is referenced in the AVL Tree for the <var>TFileReferenceList</var> class where the item is stored.
</p>
</descr>
<seealso>
<link id="TFileReference.ReferenceCount"/>
<link id="TFileReferenceList.AddFilename"/>
<link id="TFileReferenceList.RemoveFilename"/>
</seealso>
</element>
<element name="TFileReference.ReferenceCount">
<short>Contains the number of references for the file.</short>
<descr/>
<seealso>
<link id="TFileReference.FileName"/>
<link id="TFileReferenceList.AddFilename"/>
<link id="TFileReferenceList.RemoveFilename"/>
</seealso>
</element>
<element name="TFileReferenceFlag">
<short>Represents flag values used for file references in TFileReferenceList.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceFlag.frfSearchPathValid">
<short>
Included when the search path for a file reference list is valid.
</short>
</element>
<element name="TFileReferenceFlag.frfChanged">
<short>
Included when the Timestamp or UpdateLock is changed for a file reference list.
</short>
</element>
<element name="TFileReferenceFlags">
<short>Set type used to store flag values for TFileReferenceList.</short>
<descr/>
<seealso>
<link id="TFileReferenceList"/>
</seealso>
</element>
<element name="TFileReferenceList">
<short>Implements a list used to maintain TFileReference instances.</short>
<descr/>
<seealso/>
</element>
<!-- private -->
<element name="TFileReferenceList.FOnChanged"/>
<element name="TFileReferenceList.FTimeStamp"/>
<element name="TFileReferenceList.FTree">
<short>Tree of TFileReference instances sorted by file name.</short>
</element>
<element name="TFileReferenceList.FFlags"/>
<element name="TFileReferenceList.FSearchPath"/>
<element name="TFileReferenceList.FUpdateLock"/>
<element name="TFileReferenceList.UpdateSearchPath">
<short>
Reconstructs the delimited list of search path(s) for the files in the list.
</short>
</element>
<element name="TFileReferenceList.IncreaseTimeStamp">
<short>Increments the value in the TimeStamp property.</short>
</element>
<element name="TFileReferenceList.Invalidate">
<short>
Updates the TimeStamp and internal flags for the list, and signal OnChange when needed.
</short>
</element>
<!-- public -->
<element name="TFileReferenceList.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Sets the default value for the <var>Timestamp</var> property (<var>LUInvalidChangeStamp64</var>).
</p>
</descr>
<seealso>
<link id="TFileReferenceList.TimeStamp"/>
<link id="#lazutils.lazfilecache.LUInvalidChangeStamp64"/>
</seealso>
</element>
<element name="TFileReferenceList.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. It calls <var>Clear</var> to remove nodes in the internal AVL Tree for the class instance. Calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso/>
</element>
<element name="TFileReferenceList.Clear">
<short>Removes any tree nodes in the internal AVL tree.</short>
<descr>
Also frees the <var>TFileReference</var> instance for the AVL tree nodes.
</descr>
<seealso/>
</element>
<element name="TFileReferenceList.BeginUpdate">
<short>Increments the UpdateLock for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.EndUpdate">
<short>Decrements the UpdateLock and signals OnChange when needed.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename">
<short>Adds a reference-counted file name to the list.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.AddFilename.Filename">
<short>File name added to the list and the internal AVL tree.</short>
</element>
<element name="TFileReferenceList.RemoveFilename">
<short>Remove a reference for the specified file name.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.RemoveFilename.Filename">
<short>
File name de-referenced in the list and optionally removed from the internal AVL tree.
</short>
</element>
<element name="TFileReferenceList.GetFileReference">
<short>Gets an existing TFileReference instance for the specified file name.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.GetFileReference.Result">
<short>
TFileReference instance for the specified file name, or Nil when not found.
</short>
</element>
<element name="TFileReferenceList.GetFileReference.Filename">
<short>File name to locate in the list.</short>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles">
<short>
Gets a delimited list of search paths for the reference-counted files in the list.
</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateSearchPathFromAllFiles.Result">
<short>Delimited list of search paths for the reference-counted files.</short>
</element>
<element name="TFileReferenceList.CreateFileList">
<short>
Creates and returns a TStringList instance with the file names in the list.
</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.CreateFileList.Result">
<short>TStringList instance allocated in the method for the list of file names.</short>
</element>
<element name="TFileReferenceList.TimeStamp">
<short>Contains the timestamp value for the last change to the list.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.OnChanged">
<short>Event handler signalled when items in the list have been changed.</short>
<descr/>
<seealso/>
</element>
<element name="TFileReferenceList.UpdateLock">
<short>Contains the active update counter for the list.</short>
<descr/>
<seealso/>
</element>
</module>
<!-- FileReferenceList -->
</package>
</fpdoc-descriptions>
|
