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 _ O R D E R 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.Red_Black_Trees;
38 with Ada.Finalization;
42 type Key_Type (<>) is private;
43 type Element_Type (<>) is private;
45 with function "<" (Left, Right : Key_Type) return Boolean is <>;
46 with function "=" (Left, Right : Element_Type) return Boolean is <>;
48 package Ada.Containers.Indefinite_Ordered_Maps is
52 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
54 type Map is tagged private;
55 pragma Preelaborable_Initialization (Map);
57 type Cursor is private;
58 pragma Preelaborable_Initialization (Cursor);
60 Empty_Map : constant Map;
62 No_Element : constant Cursor;
64 function "=" (Left, Right : Map) return Boolean;
66 function Length (Container : Map) return Count_Type;
68 function Is_Empty (Container : Map) return Boolean;
70 procedure Clear (Container : in out Map);
72 function Key (Position : Cursor) return Key_Type;
74 function Element (Position : Cursor) return Element_Type;
76 procedure Replace_Element
77 (Container : in out Map;
79 New_Item : Element_Type);
81 procedure Query_Element
83 Process : not null access procedure (Key : Key_Type;
84 Element : Element_Type));
86 procedure Update_Element
87 (Container : in out Map;
89 Process : not null access procedure (Key : Key_Type;
90 Element : in out Element_Type));
92 procedure Move (Target : in out Map; Source : in out Map);
95 (Container : in out Map;
97 New_Item : Element_Type;
98 Position : out Cursor;
99 Inserted : out Boolean);
102 (Container : in out Map;
104 New_Item : Element_Type);
107 (Container : in out Map;
109 New_Item : Element_Type);
112 (Container : in out Map;
114 New_Item : Element_Type);
116 procedure Exclude (Container : in out Map; Key : Key_Type);
118 procedure Delete (Container : in out Map; Key : Key_Type);
120 procedure Delete (Container : in out Map; Position : in out Cursor);
122 procedure Delete_First (Container : in out Map);
124 procedure Delete_Last (Container : in out Map);
126 function First (Container : Map) return Cursor;
128 function First_Element (Container : Map) return Element_Type;
130 function First_Key (Container : Map) return Key_Type;
132 function Last (Container : Map) return Cursor;
134 function Last_Element (Container : Map) return Element_Type;
136 function Last_Key (Container : Map) return Key_Type;
138 function Next (Position : Cursor) return Cursor;
140 procedure Next (Position : in out Cursor);
142 function Previous (Position : Cursor) return Cursor;
144 procedure Previous (Position : in out Cursor);
146 function Find (Container : Map; Key : Key_Type) return Cursor;
148 function Element (Container : Map; Key : Key_Type) return Element_Type;
150 function Floor (Container : Map; Key : Key_Type) return Cursor;
152 function Ceiling (Container : Map; Key : Key_Type) return Cursor;
154 function Contains (Container : Map; Key : Key_Type) return Boolean;
156 function Has_Element (Position : Cursor) return Boolean;
158 function "<" (Left, Right : Cursor) return Boolean;
160 function ">" (Left, Right : Cursor) return Boolean;
162 function "<" (Left : Cursor; Right : Key_Type) return Boolean;
164 function ">" (Left : Cursor; Right : Key_Type) return Boolean;
166 function "<" (Left : Key_Type; Right : Cursor) return Boolean;
168 function ">" (Left : Key_Type; Right : Cursor) return Boolean;
172 Process : not null access procedure (Position : Cursor));
174 procedure Reverse_Iterate
176 Process : not null access procedure (Position : Cursor));
180 pragma Inline (Next);
181 pragma Inline (Previous);
184 type Node_Access is access Node_Type;
186 type Key_Access is access Key_Type;
187 type Element_Access is access Element_Type;
189 type Node_Type is limited record
190 Parent : Node_Access;
193 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
195 Element : Element_Access;
198 package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
202 type Map is new Ada.Finalization.Controlled with record
203 Tree : Tree_Types.Tree_Type;
206 procedure Adjust (Container : in out Map);
208 procedure Finalize (Container : in out Map) renames Clear;
212 use Ada.Finalization;
215 type Map_Access is access all Map;
216 for Map_Access'Storage_Size use 0;
218 type Cursor is record
219 Container : Map_Access;
224 (Stream : not null access Root_Stream_Type'Class;
227 for Cursor'Write use Write;
230 (Stream : not null access Root_Stream_Type'Class;
233 for Cursor'Read use Read;
235 No_Element : constant Cursor := Cursor'(null, null);
238 (Stream : not null access Root_Stream_Type'Class;
241 for Map'Write use Write;
244 (Stream : not null access Root_Stream_Type'Class;
245 Container : out Map);
247 for Map'Read use Read;
249 Empty_Map : constant Map :=
250 (Controlled with Tree => (First => null,
257 end Ada.Containers.Indefinite_Ordered_Maps;