1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . B O U N D E D _ O R D E R E D _ M A P S --
9 -- Copyright (C) 2004-2010, 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 3, 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. --
22 -- As a special exception under Section 7 of GPL version 3, you are granted --
23 -- additional permissions described in the GCC Runtime Library Exception, --
24 -- version 3.1, as published by the Free Software Foundation. --
26 -- You should have received a copy of the GNU General Public License and --
27 -- a copy of the GCC Runtime Library Exception along with this program; --
28 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
29 -- <http://www.gnu.org/licenses/>. --
31 -- This unit was originally developed by Matthew J Heaney. --
32 ------------------------------------------------------------------------------
34 private with Ada
.Containers
.Red_Black_Trees
;
35 private with Ada
.Streams
;
38 type Key_Type
is private;
39 type Element_Type
is private;
41 with function "<" (Left
, Right
: Key_Type
) return Boolean is <>;
42 with function "=" (Left
, Right
: Element_Type
) return Boolean is <>;
44 package Ada
.Containers
.Bounded_Ordered_Maps
is
48 function Equivalent_Keys
(Left
, Right
: Key_Type
) return Boolean;
50 type Map
(Capacity
: Count_Type
) is tagged private;
51 pragma Preelaborable_Initialization
(Map
);
53 type Cursor
is private;
54 pragma Preelaborable_Initialization
(Cursor
);
56 Empty_Map
: constant Map
;
58 No_Element
: constant Cursor
;
60 function "=" (Left
, Right
: Map
) return Boolean;
62 function Length
(Container
: Map
) return Count_Type
;
64 function Is_Empty
(Container
: Map
) return Boolean;
66 procedure Clear
(Container
: in out Map
);
68 function Key
(Position
: Cursor
) return Key_Type
;
70 function Element
(Position
: Cursor
) return Element_Type
;
72 procedure Replace_Element
73 (Container
: in out Map
;
75 New_Item
: Element_Type
);
77 procedure Query_Element
79 Process
: not null access
80 procedure (Key
: Key_Type
; Element
: Element_Type
));
82 procedure Update_Element
83 (Container
: in out Map
;
85 Process
: not null access
86 procedure (Key
: Key_Type
; Element
: in out Element_Type
));
88 procedure Assign
(Target
: in out Map
; Source
: Map
);
90 function Copy
(Source
: Map
; Capacity
: Count_Type
:= 0) return Map
;
92 procedure Move
(Target
: in out Map
; Source
: in out Map
);
95 (Container
: in out Map
;
97 New_Item
: Element_Type
;
98 Position
: out Cursor
;
99 Inserted
: out Boolean);
102 (Container
: in out Map
;
104 Position
: out Cursor
;
105 Inserted
: out Boolean);
108 (Container
: in out Map
;
110 New_Item
: Element_Type
);
113 (Container
: in out Map
;
115 New_Item
: Element_Type
);
118 (Container
: in out Map
;
120 New_Item
: Element_Type
);
122 procedure Exclude
(Container
: in out Map
; Key
: Key_Type
);
124 procedure Delete
(Container
: in out Map
; Key
: Key_Type
);
126 procedure Delete
(Container
: in out Map
; Position
: in out Cursor
);
128 procedure Delete_First
(Container
: in out Map
);
130 procedure Delete_Last
(Container
: in out Map
);
132 function First
(Container
: Map
) return Cursor
;
134 function First_Element
(Container
: Map
) return Element_Type
;
136 function First_Key
(Container
: Map
) return Key_Type
;
138 function Last
(Container
: Map
) return Cursor
;
140 function Last_Element
(Container
: Map
) return Element_Type
;
142 function Last_Key
(Container
: Map
) return Key_Type
;
144 function Next
(Position
: Cursor
) return Cursor
;
146 procedure Next
(Position
: in out Cursor
);
148 function Previous
(Position
: Cursor
) return Cursor
;
150 procedure Previous
(Position
: in out Cursor
);
152 function Find
(Container
: Map
; Key
: Key_Type
) return Cursor
;
154 function Element
(Container
: Map
; Key
: Key_Type
) return Element_Type
;
156 function Floor
(Container
: Map
; Key
: Key_Type
) return Cursor
;
158 function Ceiling
(Container
: Map
; Key
: Key_Type
) return Cursor
;
160 function Contains
(Container
: Map
; Key
: Key_Type
) return Boolean;
162 function Has_Element
(Position
: Cursor
) return Boolean;
164 function "<" (Left
, Right
: Cursor
) return Boolean;
166 function ">" (Left
, Right
: Cursor
) return Boolean;
168 function "<" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
170 function ">" (Left
: Cursor
; Right
: Key_Type
) return Boolean;
172 function "<" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
174 function ">" (Left
: Key_Type
; Right
: Cursor
) return Boolean;
178 Process
: not null access procedure (Position
: Cursor
));
180 procedure Reverse_Iterate
182 Process
: not null access procedure (Position
: Cursor
));
186 pragma Inline
(Next
);
187 pragma Inline
(Previous
);
189 type Node_Type
is record
193 Color
: Red_Black_Trees
.Color_Type
:= Red_Black_Trees
.Red
;
195 Element
: Element_Type
;
198 package Tree_Types
is
199 new Red_Black_Trees
.Generic_Bounded_Tree_Types
(Node_Type
);
201 type Map
(Capacity
: Count_Type
) is
202 new Tree_Types
.Tree_Type
(Capacity
) with null record;
204 type Map_Access
is access all Map
;
205 for Map_Access
'Storage_Size use 0;
211 type Cursor
is record
212 Container
: Map_Access
;
217 (Stream
: not null access Root_Stream_Type
'Class;
220 for Cursor
'Write use Write
;
223 (Stream
: not null access Root_Stream_Type
'Class;
226 for Cursor
'Read use Read
;
228 No_Element
: constant Cursor
:= Cursor
'(null, 0);
231 (Stream : not null access Root_Stream_Type'Class;
234 for Map'Write use Write;
237 (Stream : not null access Root_Stream_Type'Class;
238 Container : out Map);
240 for Map'Read use Read;
242 Empty_Map : constant Map := Map'(Tree_Type
with Capacity
=> 0);
244 end Ada
.Containers
.Bounded_Ordered_Maps
;