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-2007, 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
51 function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
53 type Map
is tagged private;
54 pragma Preelaborable_Initialization
(Map
);
56 type Cursor
is private;
57 pragma Preelaborable_Initialization
(Cursor
);
59 Empty_Map
: constant Map
;
61 No_Element
: constant Cursor
;
63 function "=" (Left
, Right
: Map
) return Boolean;
65 function Length
(Container
: Map
) return Count_Type
;
67 function Is_Empty
(Container
: Map
) return Boolean;
69 procedure Clear
(Container
: in out Map
);
71 function Key
(Position
: Cursor
) return Key_Type
;
73 function Element
(Position
: Cursor
) return Element_Type
;
75 procedure Replace_Element
76 (Container
: in out Map
;
78 New_Item
: Element_Type
);
80 procedure Query_Element
82 Process
: not null access
83 procedure (Key
: Key_Type
; Element
: Element_Type
));
85 procedure Update_Element
86 (Container
: in out Map
;
88 Process
: not null access
89 procedure (Key
: Key_Type
; Element
: in out Element_Type
));
91 procedure Move
(Target
: in out Map
; Source
: in out Map
);
94 (Container
: in out Map
;
96 New_Item
: Element_Type
;
97 Position
: out Cursor
;
98 Inserted
: out Boolean);
101 (Container
: in out Map
;
103 Position
: out Cursor
;
104 Inserted
: out Boolean);
107 (Container
: in out Map
;
109 New_Item
: Element_Type
);
112 (Container
: in out Map
;
114 New_Item
: Element_Type
);
117 (Container
: in out Map
;
119 New_Item
: Element_Type
);
121 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
123 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
125 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
127 procedure Delete_First
(Container
: in out Map
);
129 procedure Delete_Last
(Container
: in out Map
);
131 function First
(Container
: Map
) return Cursor
;
133 function First_Element
(Container
: Map
) return Element_Type
;
135 function First_Key
(Container
: Map
) return Key_Type
;
137 function Last
(Container
: Map
) return Cursor
;
139 function Last_Element
(Container
: Map
) return Element_Type
;
141 function Last_Key
(Container
: Map
) return Key_Type
;
143 function Next
(Position
: Cursor
) return Cursor
;
145 procedure Next
(Position
: in out Cursor
);
147 function Previous
(Position
: Cursor
) return Cursor
;
149 procedure Previous
(Position
: in out Cursor
);
151 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
153 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
155 function Floor
(Container
: Map
; Key
: Key_Type
) return Cursor
;
157 function Ceiling
(Container
: Map
; Key
: Key_Type
) return Cursor
;
159 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
161 function Has_Element
(Position
: Cursor
) return Boolean;
163 function "<" (Left
, Right
: Cursor
) return Boolean;
165 function ">" (Left
, Right
: Cursor
) return Boolean;
167 function "<" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
169 function ">" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
171 function "<" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
173 function ">" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
177 Process
: not null access procedure (Position
: Cursor
));
179 procedure Reverse_Iterate
181 Process
: not null access procedure (Position
: Cursor
));
185 pragma Inline
(Next
);
186 pragma Inline
(Previous
);
189 type Node_Access
is access Node_Type
;
191 type Node_Type
is limited record
192 Parent
: Node_Access
;
195 Color
: Red_Black_Trees
.Color_Type
:= Red_Black_Trees
.Red
;
197 Element
: Element_Type
;
200 package Tree_Types
is new Red_Black_Trees
.Generic_Tree_Types
204 type Map
is new Ada
.Finalization
.Controlled
with record
205 Tree
: Tree_Types
.Tree_Type
;
208 procedure Adjust
(Container
: in out Map
);
210 procedure Finalize
(Container
: in out Map
) renames Clear
;
214 use Ada
.Finalization
;
217 type Map_Access
is access all Map
;
218 for Map_Access
'Storage_Size use 0;
220 type Cursor
is record
221 Container
: Map_Access
;
226 (Stream
: not null access Root_Stream_Type
'Class;
229 for Cursor
'Write use Write
;
232 (Stream
: not null access Root_Stream_Type
'Class;
235 for Cursor
'Read use Read
;
237 No_Element
: constant Cursor
:= Cursor
'(null, null);
240 (Stream : not null access Root_Stream_Type'Class;
243 for Map'Write use Write;
246 (Stream : not null access Root_Stream_Type'Class;
247 Container : out Map);
249 for Map'Read use Read;
251 Empty_Map : constant Map :=
252 (Controlled with Tree => (First => null,
259 end Ada.Containers.Ordered_Maps;