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
;
43 type Key_Type
(<>) is private;
45 type Element_Type
(<>) is private;
47 with function "<" (Left
, Right
: Key_Type
) return Boolean is <>;
49 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
51 package Ada
.Containers
.Indefinite_Ordered_Maps
is
52 pragma Preelaborate
(Indefinite_Ordered_Maps
);
54 type Map
is tagged private;
56 type Cursor
is private;
58 Empty_Map
: constant Map
;
60 No_Element
: constant Cursor
;
62 function "=" (Left
, Right
: Map
) return Boolean;
64 function Length
(Container
: Map
) return Count_Type
;
66 function Is_Empty
(Container
: Map
) return Boolean;
68 procedure Clear
(Container
: in out Map
);
70 function Key
(Position
: Cursor
) return Key_Type
;
72 function Element
(Position
: Cursor
) return Element_Type
;
74 procedure Query_Element
76 Process
: not null access procedure (Key
: Key_Type
;
77 Element
: Element_Type
));
79 procedure Update_Element
81 Process
: not null access procedure (Key
: Key_Type
;
82 Element
: in out Element_Type
));
84 procedure Replace_Element
(Position
: Cursor
; By
: Element_Type
);
86 procedure Move
(Target
: in out Map
; Source
: in out Map
);
89 (Container
: in out Map
;
91 New_Item
: Element_Type
;
92 Position
: out Cursor
;
93 Inserted
: out Boolean);
96 (Container
: in out Map
;
98 New_Item
: Element_Type
);
101 (Container
: in out Map
;
103 New_Item
: Element_Type
);
106 (Container
: in out Map
;
108 New_Item
: Element_Type
);
111 (Container
: in out Map
;
115 (Container
: in out Map
;
116 Position
: in out Cursor
);
118 procedure Delete_First
(Container
: in out Map
);
120 procedure Delete_Last
(Container
: in out Map
);
123 (Container
: in out Map
;
128 Key
: Key_Type
) return Boolean;
132 Key
: Key_Type
) return Cursor
;
136 Key
: Key_Type
) return Element_Type
;
140 Key
: Key_Type
) return Cursor
;
144 Key
: Key_Type
) return Cursor
;
146 function First
(Container
: Map
) return Cursor
;
148 function First_Key
(Container
: Map
) return Key_Type
;
150 function First_Element
(Container
: Map
) return Element_Type
;
152 function Last
(Container
: Map
) return Cursor
;
154 function Last_Key
(Container
: Map
) return Key_Type
;
156 function Last_Element
(Container
: Map
) return Element_Type
;
158 function Next
(Position
: Cursor
) return Cursor
;
160 procedure Next
(Position
: in out Cursor
);
162 function Previous
(Position
: Cursor
) return Cursor
;
164 procedure Previous
(Position
: in out Cursor
);
166 function Has_Element
(Position
: Cursor
) return Boolean;
168 function "<" (Left
, Right
: Cursor
) return Boolean;
170 function ">" (Left
, Right
: Cursor
) return Boolean;
172 function "<" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
174 function ">" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
176 function "<" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
178 function ">" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
182 Process
: not null access procedure (Position
: Cursor
));
184 procedure Reverse_Iterate
186 Process
: not null access procedure (Position
: Cursor
));
191 type Node_Access
is access Node_Type
;
193 type Key_Access
is access Key_Type
;
194 type Element_Access
is access Element_Type
;
196 type Node_Type
is limited record
197 Parent
: Node_Access
;
200 Color
: Red_Black_Trees
.Color_Type
:= Red_Black_Trees
.Red
;
202 Element
: Element_Access
;
205 package Tree_Types
is new Red_Black_Trees
.Generic_Tree_Types
209 type Map
is new Ada
.Finalization
.Controlled
with record
210 Tree
: Tree_Types
.Tree_Type
;
213 procedure Adjust
(Container
: in out Map
);
215 procedure Finalize
(Container
: in out Map
) renames Clear
;
219 use Ada
.Finalization
;
221 type Map_Access
is access Map
;
222 for Map_Access
'Storage_Size use 0;
224 type Cursor
is record
225 Container
: Map_Access
;
229 No_Element
: constant Cursor
:= Cursor
'(null, null);
234 (Stream : access Root_Stream_Type'Class;
237 for Map'Write use Write;
240 (Stream : access Root_Stream_Type'Class;
241 Container : out Map);
243 for Map'Read use Read;
245 Empty_Map : constant Map :=
246 (Controlled with Tree => (First => null,
253 end Ada.Containers.Indefinite_Ordered_Maps;