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-2006, 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, 51 Franklin Street, Fifth Floor, --
24 -- Boston, MA 02110-1301, 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
;
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
50 function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
52 type Map
is tagged private;
53 pragma Preelaborable_Initialization
(Map
);
55 type Cursor
is private;
56 pragma Preelaborable_Initialization
(Cursor
);
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 Replace_Element
75 (Container
: in out Map
;
77 New_Item
: Element_Type
);
79 procedure Query_Element
81 Process
: not null access
82 procedure (Key
: Key_Type
; Element
: Element_Type
));
84 procedure Update_Element
85 (Container
: in out Map
;
87 Process
: not null access
88 procedure (Key
: Key_Type
; Element
: in out Element_Type
));
90 procedure Move
(Target
: in out Map
; Source
: in out Map
);
93 (Container
: in out Map
;
95 New_Item
: Element_Type
;
96 Position
: out Cursor
;
97 Inserted
: out Boolean);
100 (Container
: in out Map
;
102 Position
: out Cursor
;
103 Inserted
: out Boolean);
106 (Container
: in out Map
;
108 New_Item
: Element_Type
);
111 (Container
: in out Map
;
113 New_Item
: Element_Type
);
116 (Container
: in out Map
;
118 New_Item
: Element_Type
);
120 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
122 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
124 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
126 procedure Delete_First
(Container
: in out Map
);
128 procedure Delete_Last
(Container
: in out Map
);
130 function First
(Container
: Map
) return Cursor
;
132 function First_Element
(Container
: Map
) return Element_Type
;
134 function First_Key
(Container
: Map
) return Key_Type
;
136 function Last
(Container
: Map
) return Cursor
;
138 function Last_Element
(Container
: Map
) return Element_Type
;
140 function Last_Key
(Container
: Map
) return Key_Type
;
142 function Next
(Position
: Cursor
) return Cursor
;
144 procedure Next
(Position
: in out Cursor
);
146 function Previous
(Position
: Cursor
) return Cursor
;
148 procedure Previous
(Position
: in out Cursor
);
150 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
152 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
154 function Floor
(Container
: Map
; Key
: Key_Type
) return Cursor
;
156 function Ceiling
(Container
: Map
; Key
: Key_Type
) return Cursor
;
158 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
160 function Has_Element
(Position
: Cursor
) return Boolean;
162 function "<" (Left
, Right
: Cursor
) return Boolean;
164 function ">" (Left
, Right
: Cursor
) return Boolean;
166 function "<" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
168 function ">" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
170 function "<" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
172 function ">" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
176 Process
: not null access procedure (Position
: Cursor
));
178 procedure Reverse_Iterate
180 Process
: not null access procedure (Position
: Cursor
));
185 type Node_Access
is access Node_Type
;
187 type Node_Type
is limited record
188 Parent
: Node_Access
;
191 Color
: Red_Black_Trees
.Color_Type
:= Red_Black_Trees
.Red
;
193 Element
: Element_Type
;
196 package Tree_Types
is new Red_Black_Trees
.Generic_Tree_Types
200 type Map
is new Ada
.Finalization
.Controlled
with record
201 Tree
: Tree_Types
.Tree_Type
;
204 procedure Adjust
(Container
: in out Map
);
206 procedure Finalize
(Container
: in out Map
) renames Clear
;
210 use Ada
.Finalization
;
213 type Map_Access
is access all Map
;
214 for Map_Access
'Storage_Size use 0;
216 type Cursor
is record
217 Container
: Map_Access
;
222 (Stream
: not null access Root_Stream_Type
'Class;
225 for Cursor
'Write use Write
;
228 (Stream
: not null access Root_Stream_Type
'Class;
231 for Cursor
'Read use Read
;
233 No_Element
: constant Cursor
:= Cursor
'(null, null);
236 (Stream : not null access Root_Stream_Type'Class;
239 for Map'Write use Write;
242 (Stream : not null access Root_Stream_Type'Class;
243 Container : out Map);
245 for Map'Read use Read;
247 Empty_Map : constant Map :=
248 (Controlled with Tree => (First => null,
255 end Ada.Containers.Ordered_Maps;