Properly regenerate gcc/configure.
[official-gcc.git] / gcc / ada / a-cborse.ads
blob09cb6510b2c8d1c152ae2c5be08d223e9fcffbd4
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT LIBRARY COMPONENTS --
4 -- --
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 _ S E T S --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 2004-2014, Free Software Foundation, Inc. --
10 -- --
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. --
14 -- --
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. --
21 -- --
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. --
25 -- --
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/>. --
30 -- --
31 -- This unit was originally developed by Matthew J Heaney. --
32 ------------------------------------------------------------------------------
34 with Ada.Iterator_Interfaces;
36 private with Ada.Containers.Red_Black_Trees;
37 private with Ada.Streams;
38 private with Ada.Finalization;
40 generic
41 type Element_Type is private;
43 with function "<" (Left, Right : Element_Type) return Boolean is <>;
44 with function "=" (Left, Right : Element_Type) return Boolean is <>;
46 package Ada.Containers.Bounded_Ordered_Sets is
47 pragma Pure;
48 pragma Remote_Types;
50 function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
52 type Set (Capacity : Count_Type) is tagged private
53 with Constant_Indexing => Constant_Reference,
54 Default_Iterator => Iterate,
55 Iterator_Element => Element_Type;
57 pragma Preelaborable_Initialization (Set);
59 type Cursor is private;
60 pragma Preelaborable_Initialization (Cursor);
62 Empty_Set : constant Set;
64 No_Element : constant Cursor;
66 function Has_Element (Position : Cursor) return Boolean;
68 package Set_Iterator_Interfaces is new
69 Ada.Iterator_Interfaces (Cursor, Has_Element);
71 function "=" (Left, Right : Set) return Boolean;
73 function Equivalent_Sets (Left, Right : Set) return Boolean;
75 function To_Set (New_Item : Element_Type) return Set;
77 function Length (Container : Set) return Count_Type;
79 function Is_Empty (Container : Set) return Boolean;
81 procedure Clear (Container : in out Set);
83 function Element (Position : Cursor) return Element_Type;
85 procedure Replace_Element
86 (Container : in out Set;
87 Position : Cursor;
88 New_Item : Element_Type);
90 procedure Query_Element
91 (Position : Cursor;
92 Process : not null access procedure (Element : Element_Type));
94 type Constant_Reference_Type
95 (Element : not null access constant Element_Type) is
96 private
97 with
98 Implicit_Dereference => Element;
100 function Constant_Reference
101 (Container : aliased Set;
102 Position : Cursor) return Constant_Reference_Type;
104 procedure Assign (Target : in out Set; Source : Set);
106 function Copy (Source : Set; Capacity : Count_Type := 0) return Set;
108 procedure Move (Target : in out Set; Source : in out Set);
110 procedure Insert
111 (Container : in out Set;
112 New_Item : Element_Type;
113 Position : out Cursor;
114 Inserted : out Boolean);
116 procedure Insert
117 (Container : in out Set;
118 New_Item : Element_Type);
120 procedure Include
121 (Container : in out Set;
122 New_Item : Element_Type);
124 procedure Replace
125 (Container : in out Set;
126 New_Item : Element_Type);
128 procedure Exclude
129 (Container : in out Set;
130 Item : Element_Type);
132 procedure Delete
133 (Container : in out Set;
134 Item : Element_Type);
136 procedure Delete
137 (Container : in out Set;
138 Position : in out Cursor);
140 procedure Delete_First (Container : in out Set);
142 procedure Delete_Last (Container : in out Set);
144 procedure Union (Target : in out Set; Source : Set);
146 function Union (Left, Right : Set) return Set;
148 function "or" (Left, Right : Set) return Set renames Union;
150 procedure Intersection (Target : in out Set; Source : Set);
152 function Intersection (Left, Right : Set) return Set;
154 function "and" (Left, Right : Set) return Set renames Intersection;
156 procedure Difference (Target : in out Set; Source : Set);
158 function Difference (Left, Right : Set) return Set;
160 function "-" (Left, Right : Set) return Set renames Difference;
162 procedure Symmetric_Difference (Target : in out Set; Source : Set);
164 function Symmetric_Difference (Left, Right : Set) return Set;
166 function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
168 function Overlap (Left, Right : Set) return Boolean;
170 function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
172 function First (Container : Set) return Cursor;
174 function First_Element (Container : Set) return Element_Type;
176 function Last (Container : Set) return Cursor;
178 function Last_Element (Container : Set) return Element_Type;
180 function Next (Position : Cursor) return Cursor;
182 procedure Next (Position : in out Cursor);
184 function Previous (Position : Cursor) return Cursor;
186 procedure Previous (Position : in out Cursor);
188 function Find (Container : Set; Item : Element_Type) return Cursor;
190 function Floor (Container : Set; Item : Element_Type) return Cursor;
192 function Ceiling (Container : Set; Item : Element_Type) return Cursor;
194 function Contains (Container : Set; Item : Element_Type) return Boolean;
196 function "<" (Left, Right : Cursor) return Boolean;
198 function ">" (Left, Right : Cursor) return Boolean;
200 function "<" (Left : Cursor; Right : Element_Type) return Boolean;
202 function ">" (Left : Cursor; Right : Element_Type) return Boolean;
204 function "<" (Left : Element_Type; Right : Cursor) return Boolean;
206 function ">" (Left : Element_Type; Right : Cursor) return Boolean;
208 procedure Iterate
209 (Container : Set;
210 Process : not null access procedure (Position : Cursor));
212 procedure Reverse_Iterate
213 (Container : Set;
214 Process : not null access procedure (Position : Cursor));
216 function Iterate
217 (Container : Set)
218 return Set_Iterator_Interfaces.Reversible_Iterator'class;
220 function Iterate
221 (Container : Set;
222 Start : Cursor)
223 return Set_Iterator_Interfaces.Reversible_Iterator'class;
225 generic
226 type Key_Type (<>) is private;
228 with function Key (Element : Element_Type) return Key_Type;
230 with function "<" (Left, Right : Key_Type) return Boolean is <>;
232 package Generic_Keys is
234 function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
236 function Key (Position : Cursor) return Key_Type;
238 function Element (Container : Set; Key : Key_Type) return Element_Type;
240 procedure Replace
241 (Container : in out Set;
242 Key : Key_Type;
243 New_Item : Element_Type);
245 procedure Exclude (Container : in out Set; Key : Key_Type);
247 procedure Delete (Container : in out Set; Key : Key_Type);
249 function Find (Container : Set; Key : Key_Type) return Cursor;
251 function Floor (Container : Set; Key : Key_Type) return Cursor;
253 function Ceiling (Container : Set; Key : Key_Type) return Cursor;
255 function Contains (Container : Set; Key : Key_Type) return Boolean;
257 procedure Update_Element_Preserving_Key
258 (Container : in out Set;
259 Position : Cursor;
260 Process : not null access
261 procedure (Element : in out Element_Type));
263 type Reference_Type (Element : not null access Element_Type) is private
264 with
265 Implicit_Dereference => Element;
267 function Reference_Preserving_Key
268 (Container : aliased in out Set;
269 Position : Cursor) return Reference_Type;
271 function Constant_Reference
272 (Container : aliased Set;
273 Key : Key_Type) return Constant_Reference_Type;
275 function Reference_Preserving_Key
276 (Container : aliased in out Set;
277 Key : Key_Type) return Reference_Type;
279 private
280 type Set_Access is access all Set;
281 for Set_Access'Storage_Size use 0;
283 type Key_Access is access all Key_Type;
285 use Ada.Streams;
287 type Reference_Control_Type is
288 new Ada.Finalization.Controlled with
289 record
290 Container : Set_Access;
291 Pos : Cursor;
292 Old_Key : Key_Access;
293 end record;
295 overriding procedure Adjust (Control : in out Reference_Control_Type);
296 pragma Inline (Adjust);
298 overriding procedure Finalize (Control : in out Reference_Control_Type);
299 pragma Inline (Finalize);
301 type Reference_Type (Element : not null access Element_Type) is record
302 Control : Reference_Control_Type;
303 end record;
305 procedure Read
306 (Stream : not null access Root_Stream_Type'Class;
307 Item : out Reference_Type);
309 for Reference_Type'Read use Read;
311 procedure Write
312 (Stream : not null access Root_Stream_Type'Class;
313 Item : Reference_Type);
315 for Reference_Type'Write use Write;
317 end Generic_Keys;
319 private
321 pragma Inline (Next);
322 pragma Inline (Previous);
324 type Node_Type is record
325 Parent : Count_Type;
326 Left : Count_Type;
327 Right : Count_Type;
328 Color : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
329 Element : aliased Element_Type;
330 end record;
332 package Tree_Types is
333 new Red_Black_Trees.Generic_Bounded_Tree_Types (Node_Type);
335 type Set (Capacity : Count_Type) is
336 new Tree_Types.Tree_Type (Capacity) with null record;
338 use Tree_Types;
339 use Ada.Finalization;
340 use Ada.Streams;
342 procedure Write
343 (Stream : not null access Root_Stream_Type'Class;
344 Container : Set);
346 for Set'Write use Write;
348 procedure Read
349 (Stream : not null access Root_Stream_Type'Class;
350 Container : out Set);
352 for Set'Read use Read;
354 type Set_Access is access all Set;
355 for Set_Access'Storage_Size use 0;
357 -- Note: If a Cursor object has no explicit initialization expression,
358 -- it must default initialize to the same value as constant No_Element.
359 -- The Node component of type Cursor has scalar type Count_Type, so it
360 -- requires an explicit initialization expression of its own declaration,
361 -- in order for objects of record type Cursor to properly initialize.
363 type Cursor is record
364 Container : Set_Access;
365 Node : Count_Type := 0;
366 end record;
368 procedure Write
369 (Stream : not null access Root_Stream_Type'Class;
370 Item : Cursor);
372 for Cursor'Write use Write;
374 procedure Read
375 (Stream : not null access Root_Stream_Type'Class;
376 Item : out Cursor);
378 for Cursor'Read use Read;
380 type Reference_Control_Type is new Controlled with record
381 Container : Set_Access;
382 end record;
384 overriding procedure Adjust (Control : in out Reference_Control_Type);
385 pragma Inline (Adjust);
387 overriding procedure Finalize (Control : in out Reference_Control_Type);
388 pragma Inline (Finalize);
390 type Constant_Reference_Type
391 (Element : not null access constant Element_Type) is
392 record
393 Control : Reference_Control_Type;
394 end record;
396 procedure Read
397 (Stream : not null access Root_Stream_Type'Class;
398 Item : out Constant_Reference_Type);
400 for Constant_Reference_Type'Read use Read;
402 procedure Write
403 (Stream : not null access Root_Stream_Type'Class;
404 Item : Constant_Reference_Type);
406 for Constant_Reference_Type'Write use Write;
408 Empty_Set : constant Set := Set'(Tree_Type with Capacity => 0);
410 No_Element : constant Cursor := Cursor'(null, 0);
412 type Iterator is new Limited_Controlled and
413 Set_Iterator_Interfaces.Reversible_Iterator with
414 record
415 Container : Set_Access;
416 Node : Count_Type;
417 end record;
419 overriding procedure Finalize (Object : in out Iterator);
421 overriding function First (Object : Iterator) return Cursor;
422 overriding function Last (Object : Iterator) return Cursor;
424 overriding function Next
425 (Object : Iterator;
426 Position : Cursor) return Cursor;
428 overriding function Previous
429 (Object : Iterator;
430 Position : Cursor) return Cursor;
432 end Ada.Containers.Bounded_Ordered_Sets;