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-2005 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;
44 type Element_Type (<>) is private;
46 with function "<" (Left, Right : Key_Type) return Boolean is <>;
48 with function "=" (Left, Right : Element_Type) return Boolean is <>;
50 package Ada.Containers.Indefinite_Ordered_Maps is
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 Key (Position : Cursor) return Key_Type;
71 function Element (Position : Cursor) return Element_Type;
73 procedure Query_Element
75 Process : not null access procedure (Key : Key_Type;
76 Element : Element_Type));
78 procedure Update_Element
80 Process : not null access procedure (Key : Key_Type;
81 Element : in out Element_Type));
83 procedure Replace_Element (Position : Cursor; By : Element_Type);
85 procedure Move (Target : in out Map; Source : in out Map);
88 (Container : in out Map;
90 New_Item : Element_Type;
91 Position : out Cursor;
92 Inserted : out Boolean);
95 (Container : in out Map;
97 New_Item : Element_Type);
100 (Container : in out Map;
102 New_Item : Element_Type);
105 (Container : in out Map;
107 New_Item : Element_Type);
110 (Container : in out Map;
114 (Container : in out Map;
115 Position : in out Cursor);
117 procedure Delete_First (Container : in out Map);
119 procedure Delete_Last (Container : in out Map);
122 (Container : in out Map;
127 Key : Key_Type) return Boolean;
131 Key : Key_Type) return Cursor;
135 Key : Key_Type) return Element_Type;
139 Key : Key_Type) return Cursor;
143 Key : Key_Type) return Cursor;
145 function First (Container : Map) return Cursor;
147 function First_Key (Container : Map) return Key_Type;
149 function First_Element (Container : Map) return Element_Type;
151 function Last (Container : Map) return Cursor;
153 function Last_Key (Container : Map) return Key_Type;
155 function Last_Element (Container : Map) return Element_Type;
157 function Next (Position : Cursor) return Cursor;
159 procedure Next (Position : in out Cursor);
161 function Previous (Position : Cursor) return Cursor;
163 procedure Previous (Position : in out Cursor);
165 function Has_Element (Position : Cursor) return Boolean;
167 function "<" (Left, Right : Cursor) return Boolean;
169 function ">" (Left, Right : Cursor) return Boolean;
171 function "<" (Left : Cursor; Right : Key_Type) return Boolean;
173 function ">" (Left : Cursor; Right : Key_Type) return Boolean;
175 function "<" (Left : Key_Type; Right : Cursor) return Boolean;
177 function ">" (Left : Key_Type; Right : Cursor) return Boolean;
181 Process : not null access procedure (Position : Cursor));
183 procedure Reverse_Iterate
185 Process : not null access procedure (Position : Cursor));
190 type Node_Access is access Node_Type;
192 type Key_Access is access Key_Type;
193 type Element_Access is access Element_Type;
195 type Node_Type is limited record
196 Parent : Node_Access;
199 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
201 Element : Element_Access;
204 package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
208 type Map is new Ada.Finalization.Controlled with record
209 Tree : Tree_Types.Tree_Type;
212 procedure Adjust (Container : in out Map);
214 procedure Finalize (Container : in out Map) renames Clear;
218 use Ada.Finalization;
220 type Map_Access is access Map;
221 for Map_Access'Storage_Size use 0;
223 type Cursor is record
224 Container : Map_Access;
228 No_Element : constant Cursor := Cursor'(null, null);
233 (Stream : access Root_Stream_Type'Class;
236 for Map'Write use Write;
239 (Stream : access Root_Stream_Type'Class;
240 Container : out Map);
242 for Map'Read use Read;
244 Empty_Map : constant Map :=
245 (Controlled with Tree => (First => null,
252 end Ada.Containers.Indefinite_Ordered_Maps;