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-2018, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
27 -- This unit was originally developed by Matthew J Heaney. --
28 ------------------------------------------------------------------------------
30 with Ada
.Unchecked_Deallocation
;
32 with Ada
.Containers
.Hash_Tables
.Generic_Operations
;
33 pragma Elaborate_All
(Ada
.Containers
.Hash_Tables
.Generic_Operations
);
35 with Ada
.Containers
.Hash_Tables
.Generic_Keys
;
36 pragma Elaborate_All
(Ada
.Containers
.Hash_Tables
.Generic_Keys
);
38 with Ada
.Containers
.Helpers
; use Ada
.Containers
.Helpers
;
40 with System
; use type System
.Address
;
42 package body Ada
.Containers
.Hashed_Maps
is
44 pragma Warnings
(Off
, "variable ""Busy*"" is not referenced");
45 pragma Warnings
(Off
, "variable ""Lock*"" is not referenced");
46 -- See comment in Ada.Containers.Helpers
48 -----------------------
49 -- Local Subprograms --
50 -----------------------
53 (Source
: Node_Access
) return Node_Access
;
54 pragma Inline
(Copy_Node
);
56 function Equivalent_Key_Node
58 Node
: Node_Access
) return Boolean;
59 pragma Inline
(Equivalent_Key_Node
);
61 procedure Free
(X
: in out Node_Access
);
63 function Find_Equal_Key
64 (R_HT
: Hash_Table_Type
;
65 L_Node
: Node_Access
) return Boolean;
67 function Hash_Node
(Node
: Node_Access
) return Hash_Type
;
68 pragma Inline
(Hash_Node
);
70 function Next
(Node
: Node_Access
) return Node_Access
;
74 (Stream
: not null access Root_Stream_Type
'Class) return Node_Access
;
75 pragma Inline
(Read_Node
);
77 procedure Set_Next
(Node
: Node_Access
; Next
: Node_Access
);
78 pragma Inline
(Set_Next
);
80 function Vet
(Position
: Cursor
) return Boolean;
83 (Stream
: not null access Root_Stream_Type
'Class;
85 pragma Inline
(Write_Node
);
87 --------------------------
88 -- Local Instantiations --
89 --------------------------
91 package HT_Ops
is new Hash_Tables
.Generic_Operations
92 (HT_Types
=> HT_Types
,
93 Hash_Node
=> Hash_Node
,
96 Copy_Node
=> Copy_Node
,
99 package Key_Ops
is new Hash_Tables
.Generic_Keys
100 (HT_Types
=> HT_Types
,
102 Set_Next
=> Set_Next
,
103 Key_Type
=> Key_Type
,
105 Equivalent_Keys
=> Equivalent_Key_Node
);
107 function Is_Equal
is new HT_Ops
.Generic_Equal
(Find_Equal_Key
);
109 procedure Read_Nodes
is new HT_Ops
.Generic_Read
(Read_Node
);
110 procedure Write_Nodes
is new HT_Ops
.Generic_Write
(Write_Node
);
116 function "=" (Left
, Right
: Map
) return Boolean is
118 return Is_Equal
(Left
.HT
, Right
.HT
);
125 procedure Adjust
(Container
: in out Map
) is
127 HT_Ops
.Adjust
(Container
.HT
);
134 procedure Assign
(Target
: in out Map
; Source
: Map
) is
135 procedure Insert_Item
(Node
: Node_Access
);
136 pragma Inline
(Insert_Item
);
138 procedure Insert_Items
is new HT_Ops
.Generic_Iteration
(Insert_Item
);
144 procedure Insert_Item
(Node
: Node_Access
) is
146 Target
.Insert
(Key
=> Node
.Key
, New_Item
=> Node
.Element
);
149 -- Start of processing for Assign
152 if Target
'Address = Source
'Address then
158 if Target
.Capacity
< Source
.Length
then
159 Target
.Reserve_Capacity
(Source
.Length
);
162 Insert_Items
(Source
.HT
);
169 function Capacity
(Container
: Map
) return Count_Type
is
171 return HT_Ops
.Capacity
(Container
.HT
);
178 procedure Clear
(Container
: in out Map
) is
180 HT_Ops
.Clear
(Container
.HT
);
183 ------------------------
184 -- Constant_Reference --
185 ------------------------
187 function Constant_Reference
188 (Container
: aliased Map
;
189 Position
: Cursor
) return Constant_Reference_Type
192 if Checks
and then Position
.Container
= null then
193 raise Constraint_Error
with
194 "Position cursor has no element";
197 if Checks
and then Position
.Container
/= Container
'Unrestricted_Access
199 raise Program_Error
with
200 "Position cursor designates wrong map";
205 "Position cursor in Constant_Reference is bad");
208 HT
: Hash_Table_Type
renames Container
'Unrestricted_Access.all.HT
;
209 TC
: constant Tamper_Counts_Access
:=
210 HT
.TC
'Unrestricted_Access;
212 return R
: constant Constant_Reference_Type
:=
213 (Element
=> Position
.Node
.Element
'Access,
214 Control
=> (Controlled
with TC
))
219 end Constant_Reference
;
221 function Constant_Reference
222 (Container
: aliased Map
;
223 Key
: Key_Type
) return Constant_Reference_Type
225 HT
: Hash_Table_Type
renames Container
'Unrestricted_Access.HT
;
226 Node
: constant Node_Access
:= Key_Ops
.Find
(HT
, Key
);
229 if Checks
and then Node
= null then
230 raise Constraint_Error
with "key not in map";
234 TC
: constant Tamper_Counts_Access
:=
235 HT
.TC
'Unrestricted_Access;
237 return R
: constant Constant_Reference_Type
:=
238 (Element
=> Node
.Element
'Access,
239 Control
=> (Controlled
with TC
))
244 end Constant_Reference
;
250 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean is
252 return Find
(Container
, Key
) /= No_Element
;
261 Capacity
: Count_Type
:= 0) return Map
266 if Capacity
< Source
.Length
then
267 if Checks
and then Capacity
/= 0 then
269 with "Requested capacity is less than Source length";
277 return Target
: Map
do
278 Target
.Reserve_Capacity
(C
);
279 Target
.Assign
(Source
);
288 (Source
: Node_Access
) return Node_Access
290 Target
: constant Node_Access
:=
291 new Node_Type
'(Key => Source.Key,
292 Element => Source.Element,
302 procedure Delete (Container : in out Map; Key : Key_Type) is
306 Key_Ops.Delete_Key_Sans_Free (Container.HT, Key, X);
308 if Checks and then X = null then
309 raise Constraint_Error with "attempt to delete key not in map";
315 procedure Delete (Container : in out Map; Position : in out Cursor) is
317 if Checks and then Position.Node = null then
318 raise Constraint_Error with
319 "Position cursor of Delete equals No_Element";
322 if Checks and then Position.Container /= Container'Unrestricted_Access
324 raise Program_Error with
325 "Position cursor of Delete designates wrong map";
328 TC_Check (Container.HT.TC);
330 pragma Assert (Vet (Position), "bad cursor in Delete");
332 HT_Ops.Delete_Node_Sans_Free (Container.HT, Position.Node);
334 Free (Position.Node);
335 Position.Container := null;
342 function Element (Container : Map; Key : Key_Type) return Element_Type is
343 HT : Hash_Table_Type renames Container'Unrestricted_Access.HT;
344 Node : constant Node_Access := Key_Ops.Find (HT, Key);
347 if Checks and then Node = null then
348 raise Constraint_Error with
349 "no element available because key not in map";
355 function Element (Position : Cursor) return Element_Type is
357 if Checks and then Position.Node = null then
358 raise Constraint_Error with
359 "Position cursor of function Element equals No_Element";
362 pragma Assert (Vet (Position), "bad cursor in function Element");
364 return Position.Node.Element;
367 -------------------------
368 -- Equivalent_Key_Node --
369 -------------------------
371 function Equivalent_Key_Node
373 Node : Node_Access) return Boolean is
375 return Equivalent_Keys (Key, Node.Key);
376 end Equivalent_Key_Node;
378 ---------------------
379 -- Equivalent_Keys --
380 ---------------------
382 function Equivalent_Keys (Left, Right : Cursor)
385 if Checks and then Left.Node = null then
386 raise Constraint_Error with
387 "Left cursor of Equivalent_Keys equals No_Element";
390 if Checks and then Right.Node = null then
391 raise Constraint_Error with
392 "Right cursor of Equivalent_Keys equals No_Element";
395 pragma Assert (Vet (Left), "Left cursor of Equivalent_Keys is bad");
396 pragma Assert (Vet (Right), "Right cursor of Equivalent_Keys is bad");
398 return Equivalent_Keys (Left.Node.Key, Right.Node.Key);
401 function Equivalent_Keys (Left : Cursor; Right : Key_Type) return Boolean is
403 if Checks and then Left.Node = null then
404 raise Constraint_Error with
405 "Left cursor of Equivalent_Keys equals No_Element";
408 pragma Assert (Vet (Left), "Left cursor in Equivalent_Keys is bad");
410 return Equivalent_Keys (Left.Node.Key, Right);
413 function Equivalent_Keys (Left : Key_Type; Right : Cursor) return Boolean is
415 if Checks and then Right.Node = null then
416 raise Constraint_Error with
417 "Right cursor of Equivalent_Keys equals No_Element";
420 pragma Assert (Vet (Right), "Right cursor of Equivalent_Keys is bad");
422 return Equivalent_Keys (Left, Right.Node.Key);
429 procedure Exclude (Container : in out Map; Key : Key_Type) is
432 Key_Ops.Delete_Key_Sans_Free (Container.HT, Key, X);
440 procedure Finalize (Container : in out Map) is
442 HT_Ops.Finalize (Container.HT);
445 procedure Finalize (Object : in out Iterator) is
447 if Object.Container /= null then
448 Unbusy (Object.Container.HT.TC);
456 function Find (Container : Map; Key : Key_Type) return Cursor is
457 HT : Hash_Table_Type renames Container'Unrestricted_Access.HT;
458 Node : constant Node_Access := Key_Ops.Find (HT, Key);
465 return Cursor'(Container
'Unrestricted_Access, Node
, Hash_Type
'Last);
472 function Find_Equal_Key
473 (R_HT
: Hash_Table_Type
;
474 L_Node
: Node_Access
) return Boolean
476 R_Index
: constant Hash_Type
:= Key_Ops
.Index
(R_HT
, L_Node
.Key
);
477 R_Node
: Node_Access
:= R_HT
.Buckets
(R_Index
);
480 while R_Node
/= null loop
481 if Equivalent_Keys
(L_Node
.Key
, R_Node
.Key
) then
482 return L_Node
.Element
= R_Node
.Element
;
485 R_Node
:= R_Node
.Next
;
495 function First
(Container
: Map
) return Cursor
is
497 Node
: constant Node_Access
:= HT_Ops
.First
(Container
.HT
, Pos
);
503 return Cursor
'(Container'Unrestricted_Access, Node, Pos);
506 function First (Object : Iterator) return Cursor is
508 return Object.Container.First;
515 procedure Free (X : in out Node_Access) is
516 procedure Deallocate is
517 new Ada.Unchecked_Deallocation (Node_Type, Node_Access);
520 X.Next := X; -- detect mischief (in Vet)
525 ------------------------
526 -- Get_Element_Access --
527 ------------------------
529 function Get_Element_Access
530 (Position : Cursor) return not null Element_Access is
532 return Position.Node.Element'Access;
533 end Get_Element_Access;
539 function Has_Element (Position : Cursor) return Boolean is
541 pragma Assert (Vet (Position), "bad cursor in Has_Element");
542 return Position.Node /= null;
549 function Hash_Node (Node : Node_Access) return Hash_Type is
551 return Hash (Node.Key);
559 (Container : in out Map;
561 New_Item : Element_Type)
567 Insert (Container, Key, New_Item, Position, Inserted);
570 TE_Check (Container.HT.TC);
572 Position.Node.Key := Key;
573 Position.Node.Element := New_Item;
582 (Container : in out Map;
584 Position : out Cursor;
585 Inserted : out Boolean)
587 function New_Node (Next : Node_Access) return Node_Access;
588 pragma Inline (New_Node);
590 procedure Local_Insert is
591 new Key_Ops.Generic_Conditional_Insert (New_Node);
597 function New_Node (Next : Node_Access) return Node_Access is
599 return new Node_Type'(Key
=> Key
,
604 HT
: Hash_Table_Type
renames Container
.HT
;
606 -- Start of processing for Insert
609 if HT_Ops
.Capacity
(HT
) = 0 then
610 HT_Ops
.Reserve_Capacity
(HT
, 1);
613 Local_Insert
(HT
, Key
, Position
.Node
, Inserted
);
616 and then HT
.Length
> HT_Ops
.Capacity
(HT
)
618 HT_Ops
.Reserve_Capacity
(HT
, HT
.Length
);
621 Position
.Container
:= Container
'Unrestricted_Access;
625 (Container
: in out Map
;
627 New_Item
: Element_Type
;
628 Position
: out Cursor
;
629 Inserted
: out Boolean)
631 function New_Node
(Next
: Node_Access
) return Node_Access
;
632 pragma Inline
(New_Node
);
634 procedure Local_Insert
is
635 new Key_Ops
.Generic_Conditional_Insert
(New_Node
);
641 function New_Node
(Next
: Node_Access
) return Node_Access
is
643 return new Node_Type
'(Key, New_Item, Next);
646 HT : Hash_Table_Type renames Container.HT;
648 -- Start of processing for Insert
651 if HT_Ops.Capacity (HT) = 0 then
652 HT_Ops.Reserve_Capacity (HT, 1);
655 Local_Insert (HT, Key, Position.Node, Inserted);
658 and then HT.Length > HT_Ops.Capacity (HT)
660 HT_Ops.Reserve_Capacity (HT, HT.Length);
663 Position.Container := Container'Unrestricted_Access;
667 (Container : in out Map;
669 New_Item : Element_Type)
672 pragma Unreferenced (Position);
677 Insert (Container, Key, New_Item, Position, Inserted);
679 if Checks and then not Inserted then
680 raise Constraint_Error with
681 "attempt to insert key already in map";
689 function Is_Empty (Container : Map) return Boolean is
691 return Container.HT.Length = 0;
700 Process : not null access procedure (Position : Cursor))
702 procedure Process_Node (Node : Node_Access; Position : Hash_Type);
703 pragma Inline (Process_Node);
705 procedure Local_Iterate is
706 new HT_Ops.Generic_Iteration_With_Position (Process_Node);
712 procedure Process_Node (Node : Node_Access; Position : Hash_Type) is
714 Process (Cursor'(Container
'Unrestricted_Access, Node
, Position
));
717 Busy
: With_Busy
(Container
.HT
.TC
'Unrestricted_Access);
719 -- Start of processing for Iterate
722 Local_Iterate
(Container
.HT
);
726 (Container
: Map
) return Map_Iterator_Interfaces
.Forward_Iterator
'Class
729 return It
: constant Iterator
:=
730 (Limited_Controlled
with Container
=> Container
'Unrestricted_Access)
732 Busy
(Container
.HT
.TC
'Unrestricted_Access.all);
740 function Key
(Position
: Cursor
) return Key_Type
is
742 if Checks
and then Position
.Node
= null then
743 raise Constraint_Error
with
744 "Position cursor of function Key equals No_Element";
747 pragma Assert
(Vet
(Position
), "bad cursor in function Key");
749 return Position
.Node
.Key
;
756 function Length
(Container
: Map
) return Count_Type
is
758 return Container
.HT
.Length
;
766 (Target
: in out Map
;
770 HT_Ops
.Move
(Target
=> Target
.HT
, Source
=> Source
.HT
);
777 function Next
(Node
: Node_Access
) return Node_Access
is
782 function Next
(Position
: Cursor
) return Cursor
is
783 Node
: Node_Access
:= null;
786 -- Position of cursor's element in the map buckets.
788 if Position
.Node
= null then
792 pragma Assert
(Vet
(Position
), "bad cursor in function Next");
794 -- Initialize to current position, so that HT_Ops.Next can use it
795 Pos
:= Position
.Position
;
797 Node
:= HT_Ops
.Next
(Position
.Container
.HT
, Position
.Node
, Pos
);
802 return Cursor
'(Position.Container, Node, Pos);
806 procedure Next (Position : in out Cursor) is
808 Position := Next (Position);
813 Position : Cursor) return Cursor
816 if Position.Container = null then
820 if Checks and then Position.Container /= Object.Container then
821 raise Program_Error with
822 "Position cursor of Next designates wrong map";
825 return Next (Position);
828 ----------------------
829 -- Pseudo_Reference --
830 ----------------------
832 function Pseudo_Reference
833 (Container : aliased Map'Class) return Reference_Control_Type
835 TC : constant Tamper_Counts_Access :=
836 Container.HT.TC'Unrestricted_Access;
838 return R : constant Reference_Control_Type := (Controlled with TC) do
841 end Pseudo_Reference;
847 procedure Query_Element
849 Process : not null access
850 procedure (Key : Key_Type; Element : Element_Type))
853 if Checks and then Position.Node = null then
854 raise Constraint_Error with
855 "Position cursor of Query_Element equals No_Element";
858 pragma Assert (Vet (Position), "bad cursor in Query_Element");
861 M : Map renames Position.Container.all;
862 HT : Hash_Table_Type renames M.HT'Unrestricted_Access.all;
863 Lock : With_Lock (HT.TC'Unrestricted_Access);
864 K : Key_Type renames Position.Node.Key;
865 E : Element_Type renames Position.Node.Element;
876 (Stream : not null access Root_Stream_Type'Class;
880 Read_Nodes (Stream, Container.HT);
884 (Stream : not null access Root_Stream_Type'Class;
888 raise Program_Error with "attempt to stream map cursor";
892 (Stream : not null access Root_Stream_Type'Class;
893 Item : out Reference_Type)
896 raise Program_Error with "attempt to stream reference";
900 (Stream : not null access Root_Stream_Type'Class;
901 Item : out Constant_Reference_Type)
904 raise Program_Error with "attempt to stream reference";
912 (Container : aliased in out Map;
913 Position : Cursor) return Reference_Type
916 if Checks and then Position.Container = null then
917 raise Constraint_Error with
918 "Position cursor has no element";
921 if Checks and then Position.Container /= Container'Unrestricted_Access
923 raise Program_Error with
924 "Position cursor designates wrong map";
929 "Position cursor in function Reference is bad");
932 HT : Hash_Table_Type renames Container'Unrestricted_Access.all.HT;
933 TC : constant Tamper_Counts_Access :=
934 HT.TC'Unrestricted_Access;
936 return R : constant Reference_Type :=
937 (Element => Position.Node.Element'Access,
938 Control => (Controlled with TC))
946 (Container : aliased in out Map;
947 Key : Key_Type) return Reference_Type
949 HT : Hash_Table_Type renames Container.HT;
950 Node : constant Node_Access := Key_Ops.Find (HT, Key);
953 if Checks and then Node = null then
954 raise Constraint_Error with "key not in map";
958 TC : constant Tamper_Counts_Access :=
959 HT.TC'Unrestricted_Access;
961 return R : constant Reference_Type :=
962 (Element => Node.Element'Access,
963 Control => (Controlled with TC))
975 (Stream : not null access Root_Stream_Type'Class) return Node_Access
977 Node : Node_Access := new Node_Type;
980 Key_Type'Read (Stream, Node.Key);
981 Element_Type'Read (Stream, Node.Element);
995 (Container : in out Map;
997 New_Item : Element_Type)
999 Node : constant Node_Access := Key_Ops.Find (Container.HT, Key);
1002 if Checks and then Node = null then
1003 raise Constraint_Error with
1004 "attempt to replace key not in map";
1007 TE_Check (Container.HT.TC);
1010 Node.Element := New_Item;
1013 ---------------------
1014 -- Replace_Element --
1015 ---------------------
1017 procedure Replace_Element
1018 (Container : in out Map;
1020 New_Item : Element_Type)
1023 if Checks and then Position.Node = null then
1024 raise Constraint_Error with
1025 "Position cursor of Replace_Element equals No_Element";
1028 if Checks and then Position.Container /= Container'Unrestricted_Access
1030 raise Program_Error with
1031 "Position cursor of Replace_Element designates wrong map";
1034 TE_Check (Position.Container.HT.TC);
1036 pragma Assert (Vet (Position), "bad cursor in Replace_Element");
1038 Position.Node.Element := New_Item;
1039 end Replace_Element;
1041 ----------------------
1042 -- Reserve_Capacity --
1043 ----------------------
1045 procedure Reserve_Capacity
1046 (Container : in out Map;
1047 Capacity : Count_Type)
1050 HT_Ops.Reserve_Capacity (Container.HT, Capacity);
1051 end Reserve_Capacity;
1057 procedure Set_Next (Node : Node_Access; Next : Node_Access) is
1062 --------------------
1063 -- Update_Element --
1064 --------------------
1066 procedure Update_Element
1067 (Container : in out Map;
1069 Process : not null access procedure (Key : Key_Type;
1070 Element : in out Element_Type))
1073 if Checks and then Position.Node = null then
1074 raise Constraint_Error with
1075 "Position cursor of Update_Element equals No_Element";
1078 if Checks and then Position.Container /= Container'Unrestricted_Access
1080 raise Program_Error with
1081 "Position cursor of Update_Element designates wrong map";
1084 pragma Assert (Vet (Position), "bad cursor in Update_Element");
1087 HT : Hash_Table_Type renames Container.HT;
1088 Lock : With_Lock (HT.TC'Unrestricted_Access);
1089 K : Key_Type renames Position.Node.Key;
1090 E : Element_Type renames Position.Node.Element;
1100 function Vet (Position : Cursor) return Boolean is
1102 if Position.Node = null then
1103 return Position.Container = null;
1106 if Position.Container = null then
1110 if Position.Node.Next = Position.Node then
1115 HT : Hash_Table_Type renames Position.Container.HT;
1119 if HT.Length = 0 then
1123 if HT.Buckets = null
1124 or else HT.Buckets'Length = 0
1129 X := HT.Buckets (Key_Ops.Checked_Index (HT, Position.Node.Key));
1131 for J in 1 .. HT.Length loop
1132 if X = Position.Node then
1140 if X = X.Next then -- to prevent unnecessary looping
1156 (Stream : not null access Root_Stream_Type'Class;
1160 Write_Nodes (Stream, Container.HT);
1164 (Stream : not null access Root_Stream_Type'Class;
1168 raise Program_Error with "attempt to stream map cursor";
1172 (Stream : not null access Root_Stream_Type'Class;
1173 Item : Reference_Type)
1176 raise Program_Error with "attempt to stream reference";
1180 (Stream : not null access Root_Stream_Type'Class;
1181 Item : Constant_Reference_Type)
1184 raise Program_Error with "attempt to stream reference";
1191 procedure Write_Node
1192 (Stream : not null access Root_Stream_Type'Class;
1196 Key_Type'Write (Stream, Node.Key);
1197 Element_Type'Write (Stream, Node.Element);
1200 end Ada.Containers.Hashed_Maps;