1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.HASHED_MAPS --
9 -- Copyright (C) 2004 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, 59 Temple Place - Suite 330, Boston, --
24 -- MA 02111-1307, 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
;
40 type Key_Type
is private;
42 type Element_Type
is private;
44 with function Hash
(Key
: Key_Type
) return Hash_Type
;
46 with function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
48 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
50 package Ada
.Containers
.Hashed_Maps
is
51 pragma Preelaborate
(Hashed_Maps
);
53 type Map
is tagged private;
55 type Cursor
is private;
57 Empty_Map
: constant Map
;
59 No_Element
: constant Cursor
;
61 function "=" (Left
, Right
: Map
) return Boolean;
63 function Length
(Container
: Map
) return Count_Type
;
65 function Is_Empty
(Container
: Map
) return Boolean;
67 procedure Clear
(Container
: in out Map
);
69 function Element
(Position
: Cursor
)
72 procedure Query_Element
74 Process
: not null access
75 procedure (Key
: Key_Type
; Element
: Element_Type
));
77 procedure Update_Element
79 Process
: not null access
80 procedure (Key
: Key_Type
; Element
: in out Element_Type
));
82 procedure Replace_Element
(Position
: Cursor
; By
: Element_Type
);
84 procedure Move
(Target
: in out Map
; Source
: in out Map
);
87 (Container
: in out Map
;
89 New_Item
: Element_Type
;
90 Position
: out Cursor
;
91 Inserted
: out Boolean);
94 (Container
: in out Map
;
96 New_Item
: Element_Type
);
99 (Container
: in out Map
;
101 New_Item
: Element_Type
);
104 (Container
: in out Map
;
106 New_Item
: Element_Type
);
109 (Container
: in out Map
;
111 Position
: out Cursor
;
112 Inserted
: out Boolean);
114 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
116 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
118 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
120 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
122 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
124 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
126 function Capacity
(Container
: Map
) return Count_Type
;
128 procedure Reserve_Capacity
(Container
: in out Map
;
129 Capacity
: Count_Type
);
131 function First
(Container
: Map
) return Cursor
;
133 function Next
(Position
: Cursor
) return Cursor
;
135 procedure Next
(Position
: in out Cursor
);
137 function Has_Element
(Position
: Cursor
) return Boolean;
139 function Key
(Position
: Cursor
) return Key_Type
;
141 function Equivalent_Keys
(Left
, Right
: Cursor
) return Boolean;
143 function Equivalent_Keys
(Left
: Cursor
; Right
: Key_Type
) return Boolean;
145 function Equivalent_Keys
(Left
: Key_Type
; Right
: Cursor
) return Boolean;
149 Process
: not null access procedure (Position
: Cursor
));
154 type Node_Access
is access Node_Type
;
156 package HT_Types
is new Hash_Tables
.Generic_Hash_Table_Types
(Node_Access
);
160 type Map
is new Hash_Table_Type
with null record;
162 procedure Adjust
(Container
: in out Map
);
164 procedure Finalize
(Container
: in out Map
);
169 (Stream
: access Root_Stream_Type
'Class;
172 for Map
'Write use Write
;
175 (Stream
: access Root_Stream_Type
'Class;
176 Container
: out Map
);
178 for Map
'Read use Read
;
180 Empty_Map
: constant Map
:= (Hash_Table_Type
with null record);
182 type Map_Access
is access constant Map
;
183 for Map_Access
'Storage_Size use 0;
187 Container
: Map_Access
;
191 No_Element
: constant Cursor
:= (Container
=> null, Node
=> null);
193 end Ada
.Containers
.Hashed_Maps
;