OSDN Git Service

PR 33870
[pf3gnuchains/gcc-fork.git] / gcc / ada / a-ciorse.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT LIBRARY COMPONENTS                          --
4 --                                                                          --
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 _ S E T S               --
7 --                                                                          --
8 --                                 S p e c                                  --
9 --                                                                          --
10 --          Copyright (C) 2004-2007, Free Software Foundation, Inc.         --
11 --                                                                          --
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. --
15 --                                                                          --
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.                                              --
26 --                                                                          --
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.                                      --
33 --                                                                          --
34 -- This unit was originally developed by Matthew J Heaney.                  --
35 ------------------------------------------------------------------------------
36
37 with Ada.Containers.Red_Black_Trees;
38 with Ada.Finalization;
39 with Ada.Streams;
40
41 generic
42    type Element_Type (<>) is private;
43
44    with function "<" (Left, Right : Element_Type) return Boolean is <>;
45    with function "=" (Left, Right : Element_Type) return Boolean is <>;
46
47 package Ada.Containers.Indefinite_Ordered_Sets is
48    pragma Preelaborate;
49    pragma Remote_Types;
50
51    function Equivalent_Elements (Left, Right : Element_Type) return Boolean;
52
53    type Set is tagged private;
54    pragma Preelaborable_Initialization (Set);
55
56    type Cursor is private;
57    pragma Preelaborable_Initialization (Cursor);
58
59    Empty_Set : constant Set;
60
61    No_Element : constant Cursor;
62
63    function "=" (Left, Right : Set) return Boolean;
64
65    function Equivalent_Sets (Left, Right : Set) return Boolean;
66
67    function To_Set (New_Item : Element_Type) return Set;
68
69    function Length (Container : Set) return Count_Type;
70
71    function Is_Empty (Container : Set) return Boolean;
72
73    procedure Clear (Container : in out Set);
74
75    function Element (Position : Cursor) return Element_Type;
76
77    procedure Replace_Element
78      (Container : in out Set;
79       Position  : Cursor;
80       New_Item  : Element_Type);
81
82    procedure Query_Element
83      (Position : Cursor;
84       Process  : not null access procedure (Element : Element_Type));
85
86    procedure Move (Target : in out Set; Source : in out Set);
87
88    procedure Insert
89      (Container : in out Set;
90       New_Item  : Element_Type;
91       Position  : out Cursor;
92       Inserted  : out Boolean);
93
94    procedure Insert
95      (Container : in out Set;
96       New_Item  : Element_Type);
97
98    procedure Include
99      (Container : in out Set;
100       New_Item  : Element_Type);
101
102    procedure Replace
103      (Container : in out Set;
104       New_Item  : Element_Type);
105
106    procedure Exclude
107      (Container : in out Set;
108       Item      : Element_Type);
109
110    procedure Delete
111      (Container : in out Set;
112       Item      : Element_Type);
113
114    procedure Delete
115      (Container : in out Set;
116       Position  : in out Cursor);
117
118    procedure Delete_First (Container : in out Set);
119
120    procedure Delete_Last (Container : in out Set);
121
122    procedure Union (Target : in out Set; Source : Set);
123
124    function Union (Left, Right : Set) return Set;
125
126    function "or" (Left, Right : Set) return Set renames Union;
127
128    procedure Intersection (Target : in out Set; Source : Set);
129
130    function Intersection (Left, Right : Set) return Set;
131
132    function "and" (Left, Right : Set) return Set renames Intersection;
133
134    procedure Difference (Target : in out Set; Source : Set);
135
136    function Difference (Left, Right : Set) return Set;
137
138    function "-" (Left, Right : Set) return Set renames Difference;
139
140    procedure Symmetric_Difference (Target : in out Set; Source : Set);
141
142    function Symmetric_Difference (Left, Right : Set) return Set;
143
144    function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
145
146    function Overlap (Left, Right : Set) return Boolean;
147
148    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
149
150    function First (Container : Set) return Cursor;
151
152    function First_Element (Container : Set) return Element_Type;
153
154    function Last (Container : Set) return Cursor;
155
156    function Last_Element (Container : Set) return Element_Type;
157
158    function Next (Position : Cursor) return Cursor;
159
160    procedure Next (Position : in out Cursor);
161
162    function Previous (Position : Cursor) return Cursor;
163
164    procedure Previous (Position : in out Cursor);
165
166    function Find (Container : Set; Item : Element_Type) return Cursor;
167
168    function Floor (Container : Set; Item : Element_Type) return Cursor;
169
170    function Ceiling (Container : Set; Item : Element_Type) return Cursor;
171
172    function Contains (Container : Set; Item : Element_Type) return Boolean;
173
174    function Has_Element (Position : Cursor) return Boolean;
175
176    function "<" (Left, Right : Cursor) return Boolean;
177
178    function ">" (Left, Right : Cursor) return Boolean;
179
180    function "<" (Left : Cursor; Right : Element_Type) return Boolean;
181
182    function ">" (Left : Cursor; Right : Element_Type) return Boolean;
183
184    function "<" (Left : Element_Type; Right : Cursor) return Boolean;
185
186    function ">" (Left : Element_Type; Right : Cursor) return Boolean;
187
188    procedure Iterate
189      (Container : Set;
190       Process   : not null access procedure (Position : Cursor));
191
192    procedure Reverse_Iterate
193      (Container : Set;
194       Process   : not null access procedure (Position : Cursor));
195
196    generic
197       type Key_Type (<>) is private;
198
199       with function Key (Element : Element_Type) return Key_Type;
200
201       with function "<" (Left, Right : Key_Type) return Boolean is <>;
202
203    package Generic_Keys is
204
205       function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
206
207       function Key (Position : Cursor) return Key_Type;
208
209       function Element (Container : Set; Key : Key_Type) return Element_Type;
210
211       procedure Replace
212         (Container : in out Set;
213          Key       : Key_Type;
214          New_Item  : Element_Type);
215
216       procedure Exclude (Container : in out Set; Key : Key_Type);
217
218       procedure Delete (Container : in out Set; Key : Key_Type);
219
220       function Find
221         (Container : Set;
222          Key       : Key_Type) return Cursor;
223
224       function Floor
225         (Container : Set;
226          Key       : Key_Type) return Cursor;
227
228       function Ceiling
229         (Container : Set;
230          Key       : Key_Type) return Cursor;
231
232       function Contains
233         (Container : Set;
234          Key       : Key_Type) return Boolean;
235
236       procedure Update_Element_Preserving_Key
237         (Container : in out Set;
238          Position  : Cursor;
239          Process   : not null access
240                        procedure (Element : in out Element_Type));
241
242    end Generic_Keys;
243
244 private
245
246    pragma Inline (Next);
247    pragma Inline (Previous);
248
249    type Node_Type;
250    type Node_Access is access Node_Type;
251
252    type Element_Access is access Element_Type;
253
254    type Node_Type is limited record
255       Parent  : Node_Access;
256       Left    : Node_Access;
257       Right   : Node_Access;
258       Color   : Red_Black_Trees.Color_Type := Red_Black_Trees.Red;
259       Element : Element_Access;
260    end record;
261
262    package Tree_Types is new Red_Black_Trees.Generic_Tree_Types
263      (Node_Type,
264       Node_Access);
265
266    type Set is new Ada.Finalization.Controlled with record
267       Tree : Tree_Types.Tree_Type;
268    end record;
269
270    procedure Adjust (Container : in out Set);
271
272    procedure Finalize (Container : in out Set) renames Clear;
273
274    use Red_Black_Trees;
275    use Tree_Types;
276    use Ada.Finalization;
277    use Ada.Streams;
278
279    type Set_Access is access all Set;
280    for Set_Access'Storage_Size use 0;
281
282    type Cursor is record
283       Container : Set_Access;
284       Node      : Node_Access;
285    end record;
286
287    procedure Write
288      (Stream : not null access Root_Stream_Type'Class;
289       Item   : Cursor);
290
291    for Cursor'Write use Write;
292
293    procedure Read
294      (Stream : not null access Root_Stream_Type'Class;
295       Item   : out Cursor);
296
297    for Cursor'Read use Read;
298
299    No_Element : constant Cursor := Cursor'(null, null);
300
301    procedure Write
302      (Stream    : not null access Root_Stream_Type'Class;
303       Container : Set);
304
305    for Set'Write use Write;
306
307    procedure Read
308      (Stream    : not null access Root_Stream_Type'Class;
309       Container : out Set);
310
311    for Set'Read use Read;
312
313    Empty_Set : constant Set :=
314                  (Controlled with Tree => (First  => null,
315                                            Last   => null,
316                                            Root   => null,
317                                            Length => 0,
318                                            Busy   => 0,
319                                            Lock   => 0));
320
321 end Ada.Containers.Indefinite_Ordered_Sets;