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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
(* Indexing.mod provides a dynamic indexing mechanism for CARDINAL.
Copyright (C) 2003-2023 Free Software Foundation, Inc.
Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
This file is part of GNU Modula-2.
GNU Modula-2 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.
GNU Modula-2 is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
Under Section 7 of GPL version 3, you are granted additional
permissions described in the GCC Runtime Library Exception, version
3.1, as published by the Free Software Foundation.
You should have received a copy of the GNU General Public License and
a copy of the GCC Runtime Library Exception along with this program;
see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
<http://www.gnu.org/licenses/>. *)
IMPLEMENTATION MODULE Indexing ;
FROM libc IMPORT memset, memmove ;
FROM Storage IMPORT ALLOCATE, REALLOCATE, DEALLOCATE ;
FROM SYSTEM IMPORT TSIZE, WORD, BYTE ;
CONST
MinSize = 128 ;
TYPE
PtrToAddress = POINTER TO ADDRESS ;
PtrToByte = POINTER TO BYTE ;
Index = POINTER TO RECORD
ArrayStart: ADDRESS ;
ArraySize : CARDINAL ;
Used,
Low,
High : CARDINAL ;
Debug : BOOLEAN ;
Map : BITSET ;
END ;
(*
InitIndex - creates and returns an Index.
*)
PROCEDURE InitIndex (low: CARDINAL) : Index ;
VAR
i: Index ;
BEGIN
NEW(i) ;
WITH i^ DO
Low := low ;
High := 0 ;
ArraySize := MinSize ;
ALLOCATE(ArrayStart, MinSize) ;
ArrayStart := memset(ArrayStart, 0, ArraySize) ;
Debug := FALSE ;
Used := 0 ;
Map := BITSET{}
END ;
RETURN( i )
END InitIndex ;
(*
KillIndex - returns Index to free storage.
*)
PROCEDURE KillIndex (i: Index) : Index ;
BEGIN
WITH i^ DO
DEALLOCATE(ArrayStart, ArraySize)
END ;
DISPOSE(i) ;
RETURN( NIL )
END KillIndex ;
(*
DebugIndex - turns on debugging within an index.
*)
PROCEDURE DebugIndex (i: Index) : Index ;
BEGIN
i^.Debug := TRUE ;
RETURN( i )
END DebugIndex ;
(*
InBounds - returns TRUE if indice, n, is within the bounds
of the dynamic array.
*)
PROCEDURE InBounds (i: Index; n: CARDINAL) : BOOLEAN ;
BEGIN
IF i=NIL
THEN
HALT
ELSE
WITH i^ DO
RETURN( (n>=Low) AND (n<=High) )
END
END
END InBounds ;
(*
HighIndice - returns the last legally accessible indice of this array.
*)
PROCEDURE HighIndice (i: Index) : CARDINAL ;
BEGIN
IF i=NIL
THEN
HALT
ELSE
RETURN( i^.High )
END
END HighIndice ;
(*
LowIndice - returns the first legally accessible indice of this array.
*)
PROCEDURE LowIndice (i: Index) : CARDINAL ;
BEGIN
IF i=NIL
THEN
HALT
ELSE
RETURN( i^.Low )
END
END LowIndice ;
(*
PutIndice - places, a, into the dynamic array at position i[n]
*)
PROCEDURE PutIndice (i: Index; n: CARDINAL; a: ADDRESS) ;
VAR
oldSize: CARDINAL ;
b : ADDRESS ;
p : POINTER TO POINTER TO WORD ;
BEGIN
WITH i^ DO
IF NOT InBounds(i, n)
THEN
IF n<Low
THEN
HALT
ELSE
oldSize := ArraySize ;
WHILE (n-Low)*TSIZE(ADDRESS)>=ArraySize DO
ArraySize := ArraySize * 2
END ;
IF oldSize#ArraySize
THEN
(*
IF Debug
THEN
printf2('increasing memory hunk from %d to %d\n',
oldSize, ArraySize)
END ;
*)
REALLOCATE(ArrayStart, ArraySize) ;
(* and initialize the remainder of the array to NIL *)
b := ArrayStart ;
INC(b, oldSize) ;
b := memset(b, 0, ArraySize-oldSize)
END ;
High := n
END
END ;
b := ArrayStart ;
INC(b, (n-Low)*TSIZE(ADDRESS)) ;
p := b;
p^ := a ;
INC(Used) ;
IF Debug
THEN
IF n<32
THEN
INCL(Map, n)
END
END
END
END PutIndice ;
(*
GetIndice - retrieves, element i[n] from the dynamic array.
*)
PROCEDURE GetIndice (i: Index; n: CARDINAL) : ADDRESS ;
VAR
b: PtrToByte ;
p: PtrToAddress ;
BEGIN
WITH i^ DO
IF NOT InBounds(i, n)
THEN
HALT
END ;
b := ArrayStart ;
INC(b, (n-Low)*TSIZE(ADDRESS)) ;
p := VAL(PtrToAddress, b) ;
IF Debug
THEN
IF (n<32) AND (NOT (n IN Map)) AND (p^#NIL)
THEN
HALT
END
END ;
RETURN( p^ )
END
END GetIndice ;
(*
IsIndiceInIndex - returns TRUE if, a, is in the index, i.
*)
PROCEDURE IsIndiceInIndex (i: Index; a: ADDRESS) : BOOLEAN ;
VAR
j: CARDINAL ;
b: PtrToByte ;
p: PtrToAddress ;
BEGIN
WITH i^ DO
j := Low ;
b := ArrayStart ;
WHILE j<=High DO
p := VAL(PtrToAddress, b) ;
IF p^=a
THEN
RETURN( TRUE )
END ;
(* we must not INC(p, ..) as p2c gets confused *)
INC(b, TSIZE(ADDRESS)) ;
INC(j)
END
END ;
RETURN( FALSE )
END IsIndiceInIndex ;
(*
RemoveIndiceFromIndex - removes, a, from Index, i.
*)
PROCEDURE RemoveIndiceFromIndex (i: Index; a: ADDRESS) ;
VAR
j: CARDINAL ;
p: PtrToAddress ;
b: PtrToByte ;
BEGIN
WITH i^ DO
j := Low ;
b := ArrayStart ;
WHILE j<=High DO
p := VAL(PtrToAddress, b) ;
INC(b, TSIZE(ADDRESS)) ;
IF p^=a
THEN
DeleteIndice(i, j)
END ;
INC(j)
END
END
END RemoveIndiceFromIndex ;
(*
DeleteIndice - delete i[j] from the array.
*)
PROCEDURE DeleteIndice (i: Index; j: CARDINAL) ;
VAR
p: PtrToAddress ;
b: PtrToByte ;
BEGIN
WITH i^ DO
IF InBounds(i, j)
THEN
b := ArrayStart ;
INC(b, TSIZE(ADDRESS)*(j-Low)) ;
p := VAL(PtrToAddress, b) ;
INC(b, TSIZE(ADDRESS)) ;
p := memmove(p, b, (High-j)*TSIZE(ADDRESS)) ;
DEC(High) ;
DEC(Used)
ELSE
HALT
END
END
END DeleteIndice ;
(*
IncludeIndiceIntoIndex - if the indice is not in the index, then
add it at the end.
*)
PROCEDURE IncludeIndiceIntoIndex (i: Index; a: ADDRESS) ;
BEGIN
IF NOT IsIndiceInIndex(i, a)
THEN
IF i^.Used=0
THEN
PutIndice(i, LowIndice(i), a)
ELSE
PutIndice(i, HighIndice(i)+1, a)
END
END
END IncludeIndiceIntoIndex ;
(*
ForeachIndiceInIndexDo - for each j indice of i, call procedure p(i[j])
*)
PROCEDURE ForeachIndiceInIndexDo (i: Index; p: IndexProcedure) ;
VAR
j: CARDINAL ;
BEGIN
j := LowIndice(i) ;
WHILE j<=HighIndice(i) DO
p(GetIndice(i, j)) ;
INC(j)
END
END ForeachIndiceInIndexDo ;
END Indexing.
|