1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.INDEFINITE_ORDERED_MAPS --
9 -- Copyright (C) 2004 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 2, 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. See the GNU General Public License --
21 -- for more details. You should have received a copy of the GNU General --
22 -- Public License distributed with GNAT; see file COPYING. If not, write --
23 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
24 -- MA 02111-1307, USA. --
26 -- As a special exception, if other files instantiate generics from this --
27 -- unit, or you link this unit with other files to produce an executable, --
28 -- this unit does not by itself cause the resulting executable to be --
29 -- covered by the GNU General Public License. This exception does not --
30 -- however invalidate any other reasons why the executable file might be --
31 -- covered by the GNU Public License. --
33 -- This unit was originally developed by Matthew J Heaney. --
34 ------------------------------------------------------------------------------
36 with Ada.Containers.Red_Black_Trees;
37 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
51 pragma Preelaborate (Indefinite_Ordered_Maps);
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;
118 (Container : in out Map;
119 Position : in out Cursor);
121 procedure Delete_First (Container : in out Map);
123 procedure Delete_Last (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 function Previous (Position : Cursor) return Cursor;
161 procedure Next (Position : in out 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 package Tree_Types is
193 new Red_Black_Trees.Generic_Tree_Types (Node_Access);
196 use Ada.Finalization;
198 type Map is new Controlled with record
199 Tree : Tree_Type := (Length => 0, others => null);
202 procedure Adjust (Container : in out Map);
204 procedure Finalize (Container : in out Map) renames Clear;
206 type Map_Access is access constant Map;
207 for Map_Access'Storage_Size use 0;
209 type Cursor is record
210 Container : Map_Access;
214 No_Element : constant Cursor := Cursor'(null, null);
219 (Stream : access Root_Stream_Type'Class;
222 for Map'Write use Write;
225 (Stream : access Root_Stream_Type'Class;
226 Container : out Map);
228 for Map'Read use Read;
230 Empty_Map : constant Map :=
231 (Controlled with Tree => (Length => 0, others => null));
233 end Ada.Containers.Indefinite_Ordered_Maps;