1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . H A S H E D _ M A P S --
9 -- Copyright (C) 2004-2006, Free Software Foundation, Inc. --
11 -- This specification is derived from the Ada Reference Manual for use with --
12 -- GNAT. The copyright notice above, and the license provisions that follow --
13 -- apply solely to the contents of the part following the private keyword. --
15 -- GNAT is free software; you can redistribute it and/or modify it under --
16 -- terms of the GNU General Public License as published by the Free Soft- --
17 -- ware Foundation; either version 2, or (at your option) any later ver- --
18 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
19 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
20 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
21 -- for more details. You should have received a copy of the GNU General --
22 -- Public License distributed with GNAT; see file COPYING. If not, write --
23 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
24 -- Boston, MA 02110-1301, USA. --
26 -- As a special exception, if other files instantiate generics from this --
27 -- unit, or you link this unit with other files to produce an executable, --
28 -- this unit does not by itself cause the resulting executable to be --
29 -- covered by the GNU General Public License. This exception does not --
30 -- however invalidate any other reasons why the executable file might be --
31 -- covered by the GNU Public License. --
33 -- This unit was originally developed by Matthew J Heaney. --
34 ------------------------------------------------------------------------------
36 with Ada
.Containers
.Hash_Tables
;
38 with Ada
.Finalization
;
41 type Key_Type
is private;
42 type Element_Type
is private;
44 with function Hash
(Key
: Key_Type
) return Hash_Type
;
45 with function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
46 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
48 package Ada
.Containers
.Hashed_Maps
is
51 type Map
is tagged private;
52 pragma Preelaborable_Initialization
(Map
);
54 type Cursor
is private;
55 pragma Preelaborable_Initialization
(Cursor
);
57 Empty_Map
: constant Map
;
59 No_Element
: constant Cursor
;
61 function "=" (Left
, Right
: Map
) return Boolean;
63 function Capacity
(Container
: Map
) return Count_Type
;
65 procedure Reserve_Capacity
(Container
: in out Map
;
66 Capacity
: Count_Type
);
68 function Length
(Container
: Map
) return Count_Type
;
70 function Is_Empty
(Container
: Map
) return Boolean;
72 procedure Clear
(Container
: in out Map
);
74 function Key
(Position
: Cursor
) return Key_Type
;
76 function Element
(Position
: Cursor
) return Element_Type
;
78 procedure Replace_Element
79 (Container
: in out Map
;
81 New_Item
: Element_Type
);
83 procedure Query_Element
85 Process
: not null access
86 procedure (Key
: Key_Type
; Element
: Element_Type
));
88 procedure Update_Element
89 (Container
: in out Map
;
91 Process
: not null access
92 procedure (Key
: Key_Type
; Element
: in out Element_Type
));
94 procedure Move
(Target
: in out Map
; Source
: in out Map
);
97 (Container
: in out Map
;
99 New_Item
: Element_Type
;
100 Position
: out Cursor
;
101 Inserted
: out Boolean);
104 (Container
: in out Map
;
106 Position
: out Cursor
;
107 Inserted
: out Boolean);
110 (Container
: in out Map
;
112 New_Item
: Element_Type
);
115 (Container
: in out Map
;
117 New_Item
: Element_Type
);
120 (Container
: in out Map
;
122 New_Item
: Element_Type
);
124 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
126 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
128 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
130 function First
(Container
: Map
) return Cursor
;
132 function Next
(Position
: Cursor
) return Cursor
;
134 procedure Next
(Position
: in out Cursor
);
136 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
138 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
140 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
142 function Has_Element
(Position
: Cursor
) return Boolean;
144 function Equivalent_Keys
(Left
, Right
: Cursor
) return Boolean;
146 function Equivalent_Keys
(Left
: Cursor
; Right
: Key_Type
) return Boolean;
148 function Equivalent_Keys
(Left
: Key_Type
; Right
: Cursor
) return Boolean;
152 Process
: not null access procedure (Position
: Cursor
));
156 pragma Inline
(Length
);
157 pragma Inline
(Is_Empty
);
158 pragma Inline
(Clear
);
160 pragma Inline
(Element
);
161 pragma Inline
(Move
);
162 pragma Inline
(Contains
);
163 pragma Inline
(Capacity
);
164 pragma Inline
(Reserve_Capacity
);
165 pragma Inline
(Has_Element
);
166 pragma Inline
(Equivalent_Keys
);
169 type Node_Access
is access Node_Type
;
171 type Node_Type
is limited record
173 Element
: Element_Type
;
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
;
188 procedure Adjust
(Container
: in out Map
);
190 procedure Finalize
(Container
: in out Map
);
195 (Stream
: access Root_Stream_Type
'Class;
198 for Map
'Write use Write
;
201 (Stream
: access Root_Stream_Type
'Class;
202 Container
: out Map
);
204 for Map
'Read use Read
;
206 Empty_Map
: constant Map
:= (Controlled
with HT
=> (null, 0, 0, 0));
208 type Map_Access
is access constant Map
;
209 for Map_Access
'Storage_Size use 0;
213 Container
: Map_Access
;
218 (Stream
: access Root_Stream_Type
'Class;
221 for Cursor
'Read use Read
;
224 (Stream
: access Root_Stream_Type
'Class;
227 for Cursor
'Write use Write
;
229 No_Element
: constant Cursor
:= (Container
=> null, Node
=> null);
231 end Ada
.Containers
.Hashed_Maps
;