1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . O R D E R E D _ M A P S --
9 -- Copyright (C) 2004-2012, 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 3, 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. --
22 -- As a special exception under Section 7 of GPL version 3, you are granted --
23 -- additional permissions described in the GCC Runtime Library Exception, --
24 -- version 3.1, as published by the Free Software Foundation. --
26 -- You should have received a copy of the GNU General Public License and --
27 -- a copy of the GCC Runtime Library Exception along with this program; --
28 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
29 -- <http://www.gnu.org/licenses/>. --
31 -- This unit was originally developed by Matthew J Heaney. --
32 ------------------------------------------------------------------------------
34 with Ada.Iterator_Interfaces;
36 private with Ada.Containers.Red_Black_Trees;
37 private with Ada.Finalization;
38 private with Ada.Streams;
41 type Key_Type is private;
42 type Element_Type is private;
44 with function "<" (Left, Right : Key_Type) return Boolean is <>;
45 with function "=" (Left, Right : Element_Type) return Boolean is <>;
47 package Ada.Containers.Ordered_Maps is
51 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
53 type Map is tagged private with
54 Constant_Indexing => Constant_Reference,
55 Variable_Indexing => Reference,
56 Default_Iterator => Iterate,
57 Iterator_Element => Element_Type;
59 type Cursor is private;
60 pragma Preelaborable_Initialization (Cursor);
62 Empty_Map : constant Map;
64 No_Element : constant Cursor;
66 function Has_Element (Position : Cursor) return Boolean;
68 package Map_Iterator_Interfaces is new
69 Ada.Iterator_Interfaces (Cursor, Has_Element);
71 function "=" (Left, Right : Map) return Boolean;
73 function Length (Container : Map) return Count_Type;
75 function Is_Empty (Container : Map) return Boolean;
77 procedure Clear (Container : in out Map);
79 function Key (Position : Cursor) return Key_Type;
81 function Element (Position : Cursor) return Element_Type;
83 procedure Replace_Element
84 (Container : in out Map;
86 New_Item : Element_Type);
88 procedure Query_Element
90 Process : not null access
91 procedure (Key : Key_Type; Element : Element_Type));
93 procedure Update_Element
94 (Container : in out Map;
96 Process : not null access
97 procedure (Key : Key_Type; Element : in out Element_Type));
99 type Constant_Reference_Type
100 (Element : not null access constant Element_Type) is private
102 Implicit_Dereference => Element;
104 type Reference_Type (Element : not null access Element_Type) is private
106 Implicit_Dereference => Element;
108 function Constant_Reference
109 (Container : aliased Map;
110 Position : Cursor) return Constant_Reference_Type;
113 (Container : aliased in out Map;
114 Position : Cursor) return Reference_Type;
116 function Constant_Reference
117 (Container : aliased Map;
118 Key : Key_Type) return Constant_Reference_Type;
121 (Container : aliased in out Map;
122 Key : Key_Type) return Reference_Type;
124 procedure Assign (Target : in out Map; Source : Map);
126 function Copy (Source : Map) return Map;
128 procedure Move (Target : in out Map; Source : in out Map);
131 (Container : in out Map;
133 New_Item : Element_Type;
134 Position : out Cursor;
135 Inserted : out Boolean);
138 (Container : in out Map;
140 Position : out Cursor;
141 Inserted : out Boolean);
144 (Container : in out Map;
146 New_Item : Element_Type);
149 (Container : in out Map;
151 New_Item : Element_Type);
154 (Container : in out Map;
156 New_Item : Element_Type);
158 procedure Exclude (Container : in out Map; Key : Key_Type);
160 procedure Delete (Container : in out Map; Key : Key_Type);
162 procedure Delete (Container : in out Map; Position : in out Cursor);
164 procedure Delete_First (Container : in out Map);
166 procedure Delete_Last (Container : in out Map);
168 function First (Container : Map) return Cursor;
170 function First_Element (Container : Map) return Element_Type;
172 function First_Key (Container : Map) return Key_Type;
174 function Last (Container : Map) return Cursor;
176 function Last_Element (Container : Map) return Element_Type;
178 function Last_Key (Container : Map) return Key_Type;
180 function Next (Position : Cursor) return Cursor;
182 procedure Next (Position : in out Cursor);
184 function Previous (Position : Cursor) return Cursor;
186 procedure Previous (Position : in out Cursor);
188 function Find (Container : Map; Key : Key_Type) return Cursor;
190 function Element (Container : Map; Key : Key_Type) return Element_Type;
192 function Floor (Container : Map; Key : Key_Type) return Cursor;
194 function Ceiling (Container : Map; Key : Key_Type) return Cursor;
196 function Contains (Container : Map; Key : Key_Type) return Boolean;
198 function "<" (Left, Right : Cursor) return Boolean;
200 function ">" (Left, Right : Cursor) return Boolean;
202 function "<" (Left : Cursor; Right : Key_Type) return Boolean;
204 function ">" (Left : Cursor; Right : Key_Type) return Boolean;
206 function "<" (Left : Key_Type; Right : Cursor) return Boolean;
208 function ">" (Left : Key_Type; Right : Cursor) return Boolean;
212 Process : not null access procedure (Position : Cursor));
214 procedure Reverse_Iterate
216 Process : not null access procedure (Position : Cursor));
218 -- The map container supports iteration in both the forward and reverse
219 -- directions, hence these constructor functions return an object that
220 -- supports the Reversible_Iterator interface.
224 return Map_Iterator_Interfaces.Reversible_Iterator'class;
229 return Map_Iterator_Interfaces.Reversible_Iterator'class;
233 pragma Inline (Next);
234 pragma Inline (Previous);
237 type Node_Access is access Node_Type;
239 type Node_Type is limited record
240 Parent : Node_Access;
243 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
245 Element : aliased Element_Type;
248 package Tree_Types is
249 new Red_Black_Trees.Generic_Tree_Types (Node_Type, Node_Access);
251 type Map is new Ada.Finalization.Controlled with record
252 Tree : Tree_Types.Tree_Type;
255 overriding procedure Adjust (Container : in out Map);
257 overriding procedure Finalize (Container : in out Map) renames Clear;
261 use Ada.Finalization;
265 (Stream : not null access Root_Stream_Type'Class;
268 for Map'Write use Write;
271 (Stream : not null access Root_Stream_Type'Class;
272 Container : out Map);
274 for Map'Read use Read;
276 type Map_Access is access all Map;
277 for Map_Access'Storage_Size use 0;
279 type Cursor is record
280 Container : Map_Access;
285 (Stream : not null access Root_Stream_Type'Class;
288 for Cursor'Write use Write;
291 (Stream : not null access Root_Stream_Type'Class;
294 for Cursor'Read use Read;
296 type Constant_Reference_Type
297 (Element : not null access constant Element_Type) is null record;
300 (Stream : not null access Root_Stream_Type'Class;
301 Item : out Constant_Reference_Type);
303 for Constant_Reference_Type'Read use Read;
306 (Stream : not null access Root_Stream_Type'Class;
307 Item : Constant_Reference_Type);
309 for Constant_Reference_Type'Write use Write;
312 (Element : not null access Element_Type) is null record;
315 (Stream : not null access Root_Stream_Type'Class;
316 Item : out Reference_Type);
318 for Reference_Type'Read use Read;
321 (Stream : not null access Root_Stream_Type'Class;
322 Item : Reference_Type);
324 for Reference_Type'Write use Write;
326 Empty_Map : constant Map :=
327 (Controlled with Tree => (First => null,
334 No_Element : constant Cursor := Cursor'(null, null);
336 end Ada.Containers.Ordered_Maps;