1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . --
6 -- I N D E F I N I T E _ H A S H E D _ M A P S --
10 -- Copyright (C) 2004-2007, Free Software Foundation, Inc. --
12 -- This specification is derived from the Ada Reference Manual for use with --
13 -- GNAT. The copyright notice above, and the license provisions that follow --
14 -- apply solely to the contents of the part following the private keyword. --
16 -- GNAT is free software; you can redistribute it and/or modify it under --
17 -- terms of the GNU General Public License as published by the Free Soft- --
18 -- ware Foundation; either version 2, or (at your option) any later ver- --
19 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
20 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
21 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
22 -- for more details. You should have received a copy of the GNU General --
23 -- Public License distributed with GNAT; see file COPYING. If not, write --
24 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
25 -- Boston, MA 02110-1301, USA. --
27 -- As a special exception, if other files instantiate generics from this --
28 -- unit, or you link this unit with other files to produce an executable, --
29 -- this unit does not by itself cause the resulting executable to be --
30 -- covered by the GNU General Public License. This exception does not --
31 -- however invalidate any other reasons why the executable file might be --
32 -- covered by the GNU Public License. --
34 -- This unit was originally developed by Matthew J Heaney. --
35 ------------------------------------------------------------------------------
37 with Ada
.Containers
.Hash_Tables
;
39 with Ada
.Finalization
;
42 type Key_Type
(<>) is private;
43 type Element_Type
(<>) is private;
45 with function Hash
(Key
: Key_Type
) return Hash_Type
;
46 with function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
47 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
49 package Ada
.Containers
.Indefinite_Hashed_Maps
is
53 type Map
is tagged private;
54 pragma Preelaborable_Initialization
(Map
);
56 type Cursor
is private;
57 pragma Preelaborable_Initialization
(Cursor
);
59 Empty_Map
: constant Map
;
60 No_Element
: constant Cursor
;
62 function "=" (Left
, Right
: Map
) return Boolean;
64 function Capacity
(Container
: Map
) return Count_Type
;
66 procedure Reserve_Capacity
67 (Container
: in out Map
;
68 Capacity
: Count_Type
);
70 function Length
(Container
: Map
) return Count_Type
;
72 function Is_Empty
(Container
: Map
) return Boolean;
74 procedure Clear
(Container
: in out Map
);
76 function Key
(Position
: Cursor
) return Key_Type
;
78 function Element
(Position
: Cursor
) return Element_Type
;
80 procedure Replace_Element
81 (Container
: in out Map
;
83 New_Item
: Element_Type
);
85 procedure Query_Element
87 Process
: not null access procedure (Key
: Key_Type
;
88 Element
: Element_Type
));
90 procedure Update_Element
91 (Container
: in out Map
;
93 Process
: not null access procedure (Key
: Key_Type
;
94 Element
: in out Element_Type
));
96 procedure Move
(Target
: in out Map
; Source
: in out Map
);
99 (Container
: in out Map
;
101 New_Item
: Element_Type
;
102 Position
: out Cursor
;
103 Inserted
: out Boolean);
106 (Container
: in out Map
;
108 New_Item
: Element_Type
);
111 (Container
: in out Map
;
113 New_Item
: Element_Type
);
116 (Container
: in out Map
;
118 New_Item
: Element_Type
);
120 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
122 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
124 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
126 function First
(Container
: Map
) return Cursor
;
128 function Next
(Position
: Cursor
) return Cursor
;
130 procedure Next
(Position
: in out Cursor
);
132 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
134 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
136 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
138 function Has_Element
(Position
: Cursor
) return Boolean;
140 function Equivalent_Keys
(Left
, Right
: Cursor
) return Boolean;
142 function Equivalent_Keys
(Left
: Cursor
; Right
: Key_Type
) return Boolean;
144 function Equivalent_Keys
(Left
: Key_Type
; Right
: Cursor
) return Boolean;
148 Process
: not null access procedure (Position
: Cursor
));
152 pragma Inline
(Length
);
153 pragma Inline
(Is_Empty
);
154 pragma Inline
(Clear
);
156 pragma Inline
(Element
);
157 pragma Inline
(Move
);
158 pragma Inline
(Contains
);
159 pragma Inline
(Capacity
);
160 pragma Inline
(Reserve_Capacity
);
161 pragma Inline
(Has_Element
);
162 pragma Inline
(Equivalent_Keys
);
163 pragma Inline
(Next
);
166 type Node_Access
is access Node_Type
;
168 type Key_Access
is access Key_Type
;
169 type Element_Access
is access Element_Type
;
171 type Node_Type
is limited record
173 Element
: Element_Access
;
177 package HT_Types
is new Hash_Tables
.Generic_Hash_Table_Types
181 type Map
is new Ada
.Finalization
.Controlled
with record
182 HT
: HT_Types
.Hash_Table_Type
;
186 use Ada
.Finalization
;
189 procedure Adjust
(Container
: in out Map
);
191 procedure Finalize
(Container
: in out Map
);
193 type Map_Access
is access constant Map
;
194 for Map_Access
'Storage_Size use 0;
198 Container
: Map_Access
;
203 (Stream
: not null access Root_Stream_Type
'Class;
206 for Cursor
'Write use Write
;
209 (Stream
: not null access Root_Stream_Type
'Class;
212 for Cursor
'Read use Read
;
214 No_Element
: constant Cursor
:=
219 (Stream
: not null access Root_Stream_Type
'Class;
222 for Map
'Write use Write
;
225 (Stream
: not null access Root_Stream_Type
'Class;
226 Container
: out Map
);
228 for Map
'Read use Read
;
230 Empty_Map
: constant Map
:= (Controlled
with HT
=> (null, 0, 0, 0));
232 end Ada
.Containers
.Indefinite_Hashed_Maps
;