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
|
(* Indexing.def provides a dynamic indexing mechanism.
Copyright (C) 2015-2025 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.
You should have received a copy of the GNU General Public License
along with GNU Modula-2; see the file COPYING3. If not see
<http://www.gnu.org/licenses/>. *)
DEFINITION MODULE Indexing ;
FROM SYSTEM IMPORT ADDRESS ;
EXPORT QUALIFIED Index, InitIndex, KillIndex, GetIndice, PutIndice,
HighIndice, LowIndice, InBounds, IsIndiceInIndex,
RemoveIndiceFromIndex, IncludeIndiceIntoIndex,
ForeachIndiceInIndexDo, DeleteIndice, DebugIndex ;
TYPE
Index ;
IndexProcedure = PROCEDURE (ADDRESS) ;
(*
InitIndex - creates and returns an Index.
*)
PROCEDURE InitIndex (low: CARDINAL) : Index ;
(*
KillIndex - returns Index to free storage.
*)
PROCEDURE KillIndex (i: Index) : Index ;
(*
DebugIndex - turns on debugging within an index.
*)
PROCEDURE DebugIndex (i: Index) : Index ;
(*
InBounds - returns TRUE if indice, n, is within the bounds
of the dynamic array.
*)
PROCEDURE InBounds (i: Index; n: CARDINAL) : BOOLEAN ;
(*
HighIndice - returns the last legally accessible indice of this array.
*)
PROCEDURE HighIndice (i: Index) : CARDINAL ;
(*
LowIndice - returns the first legally accessible indice of this array.
*)
PROCEDURE LowIndice (i: Index) : CARDINAL ;
(*
PutIndice - places, a, into the dynamic array at position i[n]
*)
PROCEDURE PutIndice (i: Index; n: CARDINAL; a: ADDRESS) ;
(*
GetIndice - retrieves, element i[n] from the dynamic array.
*)
PROCEDURE GetIndice (i: Index; n: CARDINAL) : ADDRESS ;
(*
IsIndiceInIndex - returns TRUE if, a, is in the index, i.
*)
PROCEDURE IsIndiceInIndex (i: Index; a: ADDRESS) : BOOLEAN ;
(*
RemoveIndiceFromIndex - removes, a, from Index, i.
*)
PROCEDURE RemoveIndiceFromIndex (i: Index; a: ADDRESS) ;
(*
DeleteIndice - delete i[j] from the array.
*)
PROCEDURE DeleteIndice (i: Index; j: CARDINAL) ;
(*
IncludeIndiceIntoIndex - if the indice is not in the index, then
add it at the end.
*)
PROCEDURE IncludeIndiceIntoIndex (i: Index; a: ADDRESS) ;
(*
ForeachIndiceInIndexDo - for each j indice of i, call procedure p(i[j])
*)
PROCEDURE ForeachIndiceInIndexDo (i: Index; p: IndexProcedure) ;
END Indexing.
|
