1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . B O U N D E D _ O R D E R E D _ M A P S --
9 -- Copyright (C) 2004-2011, 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 private with Ada.Containers.Red_Black_Trees;
36 with Ada.Streams; use Ada.Streams;
37 with Ada.Iterator_Interfaces;
40 type Key_Type is private;
41 type Element_Type is private;
43 with function "<" (Left, Right : Key_Type) return Boolean is <>;
44 with function "=" (Left, Right : Element_Type) return Boolean is <>;
46 package Ada.Containers.Bounded_Ordered_Maps is
50 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
52 type Map (Capacity : Count_Type) is tagged private with
53 constant_Indexing => Constant_Reference,
54 Variable_Indexing => Reference,
55 Default_Iterator => Iterate,
56 Iterator_Element => Element_Type;
58 pragma Preelaborable_Initialization (Map);
60 type Cursor is private;
61 pragma Preelaborable_Initialization (Cursor);
63 Empty_Map : constant Map;
65 No_Element : constant Cursor;
67 function Has_Element (Position : Cursor) return Boolean;
69 package Map_Iterator_Interfaces is new
70 Ada.Iterator_Interfaces (Cursor, Has_Element);
72 function "=" (Left, Right : Map) return Boolean;
74 function Length (Container : Map) return Count_Type;
76 function Is_Empty (Container : Map) return Boolean;
78 procedure Clear (Container : in out Map);
80 function Key (Position : Cursor) return Key_Type;
82 function Element (Position : Cursor) return Element_Type;
84 procedure Replace_Element
85 (Container : in out Map;
87 New_Item : Element_Type);
89 procedure Query_Element
91 Process : not null access
92 procedure (Key : Key_Type; Element : Element_Type));
94 procedure Update_Element
95 (Container : in out Map;
97 Process : not null access
98 procedure (Key : Key_Type; Element : in out Element_Type));
100 procedure Assign (Target : in out Map; Source : Map);
102 function Copy (Source : Map; Capacity : Count_Type := 0) return Map;
104 procedure Move (Target : in out Map; Source : in out Map);
107 (Container : in out Map;
109 New_Item : Element_Type;
110 Position : out Cursor;
111 Inserted : out Boolean);
114 (Container : in out Map;
116 Position : out Cursor;
117 Inserted : out Boolean);
120 (Container : in out Map;
122 New_Item : Element_Type);
125 (Container : in out Map;
127 New_Item : Element_Type);
130 (Container : in out Map;
132 New_Item : Element_Type);
134 procedure Exclude (Container : in out Map; Key : Key_Type);
136 procedure Delete (Container : in out Map; Key : Key_Type);
138 procedure Delete (Container : in out Map; Position : in out Cursor);
140 procedure Delete_First (Container : in out Map);
142 procedure Delete_Last (Container : in out Map);
144 function First (Container : Map) return Cursor;
146 function First_Element (Container : Map) return Element_Type;
148 function First_Key (Container : Map) return Key_Type;
150 function Last (Container : Map) return Cursor;
152 function Last_Element (Container : Map) return Element_Type;
154 function Last_Key (Container : Map) return Key_Type;
156 function Next (Position : Cursor) return Cursor;
158 procedure Next (Position : in out Cursor);
160 function Previous (Position : Cursor) return Cursor;
162 procedure Previous (Position : in out Cursor);
164 function Find (Container : Map; Key : Key_Type) return Cursor;
166 function Element (Container : Map; Key : Key_Type) return Element_Type;
168 function Floor (Container : Map; Key : Key_Type) return Cursor;
170 function Ceiling (Container : Map; Key : Key_Type) return Cursor;
172 function Contains (Container : Map; Key : Key_Type) return Boolean;
174 function "<" (Left, Right : Cursor) return Boolean;
176 function ">" (Left, Right : Cursor) return Boolean;
178 function "<" (Left : Cursor; Right : Key_Type) return Boolean;
180 function ">" (Left : Cursor; Right : Key_Type) return Boolean;
182 function "<" (Left : Key_Type; Right : Cursor) return Boolean;
184 function ">" (Left : Key_Type; Right : Cursor) return Boolean;
186 type Constant_Reference_Type
187 (Element : not null access constant Element_Type) is private
189 Implicit_Dereference => Element;
192 (Stream : not null access Root_Stream_Type'Class;
193 Item : out Constant_Reference_Type);
195 for Constant_Reference_Type'Read use Read;
198 (Stream : not null access Root_Stream_Type'Class;
199 Item : Constant_Reference_Type);
201 for Constant_Reference_Type'Write use Write;
203 type Reference_Type (Element : not null access Element_Type) is private
205 Implicit_Dereference => Element;
208 (Stream : not null access Root_Stream_Type'Class;
209 Item : out Reference_Type);
211 for Reference_Type'Read use Read;
214 (Stream : not null access Root_Stream_Type'Class;
215 Item : Reference_Type);
217 for Reference_Type'Write use Write;
219 function Constant_Reference
221 Key : Key_Type) -- SHOULD BE ALIASED ???
222 return Constant_Reference_Type;
224 function Reference (Container : Map; Key : Key_Type) return Reference_Type;
228 Process : not null access procedure (Position : Cursor));
231 (Container : Map) return Map_Iterator_Interfaces.Forward_Iterator'class;
236 return Map_Iterator_Interfaces.Reversible_Iterator'class;
238 procedure Reverse_Iterate
240 Process : not null access procedure (Position : Cursor));
244 pragma Inline (Next);
245 pragma Inline (Previous);
247 type Node_Type is record
251 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
253 Element : Element_Type;
256 package Tree_Types is
257 new Red_Black_Trees.Generic_Bounded_Tree_Types (Node_Type);
259 type Map (Capacity : Count_Type) is
260 new Tree_Types.Tree_Type (Capacity) with null record;
262 type Map_Access is access all Map;
263 for Map_Access'Storage_Size use 0;
268 type Cursor is record
269 Container : Map_Access;
270 Node : Count_Type := 0;
274 (Stream : not null access Root_Stream_Type'Class;
277 for Cursor'Write use Write;
280 (Stream : not null access Root_Stream_Type'Class;
283 for Cursor'Read use Read;
285 No_Element : constant Cursor := Cursor'(null, 0);
288 (Stream : not null access Root_Stream_Type'Class;
291 for Map'Write use Write;
294 (Stream : not null access Root_Stream_Type'Class;
295 Container : out Map);
297 for Map'Read use Read;
299 type Constant_Reference_Type
300 (Element : not null access constant Element_Type) is null record;
303 (Element : not null access Element_Type) is null record;
305 Empty_Map : constant Map := Map'(Tree_Type with Capacity => 0);
307 end Ada.Containers.Bounded_Ordered_Maps;