gcc/ada/a-ciorse.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --                  ADA.CONTAINERS.INDEFINITE_ORDERED_SETS                  --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --             Copyright (C) 2004 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 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,  59 Temple Place - Suite 330,  Boston, --
  24 -- MA 02111-1307, USA.                                                      --
  25 --                                                                          --
  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.                                      --
  32 --                                                                          --
  33 -- This unit was originally developed by Matthew J Heaney.                  --
  34 ------------------------------------------------------------------------------
  35
  36 with Ada.Containers.Red_Black_Trees;
  37 with Ada.Finalization;
  38 with Ada.Streams;
  39
  40 generic
  41    type Element_Type (<>) is private;
  42
  43    with function "<" (Left, Right : Element_Type) return Boolean is <>;
  44    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  45
  46 package Ada.Containers.Indefinite_Ordered_Sets is
  47 pragma Preelaborate (Indefinite_Ordered_Sets);
  48
  49    type Set is tagged private;
  50
  51    type Cursor is private;
  52
  53    Empty_Set : constant Set;
  54
  55    No_Element : constant Cursor;
  56
  57    function "=" (Left, Right : Set) return Boolean;
  58
  59    function Length (Container : Set) return Count_Type;
  60
  61    function Is_Empty (Container : Set) return Boolean;
  62
  63    procedure Clear (Container : in out Set);
  64
  65    function Element (Position : Cursor) return Element_Type;
  66
  67    procedure Query_Element
  68      (Position : Cursor;
  69       Process  : not null access procedure (Element : Element_Type));
  70
  71    --  TODO: resolve in Atlanta???
  72    --   procedure Replace_Element
  73    --     (Container : in out Set;
  74    --      Position  : Cursor;
  75    --      By        : Element_Type);
  76
  77    procedure Move (Target : in out Set; Source : in out Set);
  78
  79    procedure Insert
  80      (Container : in out Set;
  81       New_Item  : Element_Type;
  82       Position  : out Cursor;
  83       Inserted  : out Boolean);
  84
  85    procedure Insert
  86      (Container : in out Set;
  87       New_Item  : Element_Type);
  88
  89    procedure Include
  90      (Container : in out Set;
  91       New_Item  : Element_Type);
  92
  93    procedure Replace
  94      (Container : in out Set;
  95       New_Item  : Element_Type);
  96
  97    procedure Delete
  98      (Container : in out Set;
  99       Item      : Element_Type);
 100
 101    procedure Exclude
 102      (Container : in out Set;
 103       Item      : Element_Type);
 104
 105    procedure Delete
 106      (Container : in out Set;
 107       Position  : in out Cursor);
 108
 109    procedure Delete_First (Container : in out Set);
 110
 111    procedure Delete_Last (Container : in out Set);
 112
 113    procedure Union (Target : in out Set; Source : Set);
 114
 115    function Union (Left, Right : Set) return Set;
 116
 117    function "or" (Left, Right : Set) return Set renames Union;
 118
 119    procedure Intersection (Target : in out Set; Source : Set);
 120
 121    function Intersection (Left, Right : Set) return Set;
 122
 123    function "and" (Left, Right : Set) return Set renames Intersection;
 124
 125    procedure Difference (Target : in out Set;
 126                          Source : Set);
 127
 128    function Difference (Left, Right : Set) return Set;
 129
 130    function "-" (Left, Right : Set) return Set renames Difference;
 131
 132    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 133
 134    function Symmetric_Difference (Left, Right : Set) return Set;
 135
 136    function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
 137
 138    function Overlap (Left, Right : Set) return Boolean;
 139
 140    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 141
 142    function Contains (Container : Set; Item : Element_Type) return Boolean;
 143
 144    function Find (Container : Set; Item : Element_Type) return Cursor;
 145
 146    function Floor (Container : Set; Item : Element_Type) return Cursor;
 147
 148    function Ceiling (Container : Set; Item : Element_Type) return Cursor;
 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    function Previous (Position : Cursor) return Cursor;
 161
 162    procedure Next (Position : in out Cursor);
 163
 164    procedure Previous (Position : in out Cursor);
 165
 166    function Has_Element (Position : Cursor) return Boolean;
 167
 168    function "<" (Left, Right : Cursor) return Boolean;
 169
 170    function ">" (Left, Right : Cursor) return Boolean;
 171
 172    function "<" (Left : Cursor; Right : Element_Type) return Boolean;
 173
 174    function ">" (Left : Cursor; Right : Element_Type) return Boolean;
 175
 176    function "<" (Left : Element_Type; Right : Cursor) return Boolean;
 177
 178    function ">" (Left : Element_Type; Right : Cursor) return Boolean;
 179
 180    procedure Iterate
 181      (Container : Set;
 182       Process   : not null access procedure (Position : Cursor));
 183
 184    procedure Reverse_Iterate
 185      (Container : Set;
 186       Process   : not null access procedure (Position : Cursor));
 187
 188    generic
 189       type Key_Type (<>) is limited private;
 190
 191       with function Key (Element : Element_Type) return Key_Type;
 192
 193       with function "<" (Left : Key_Type; Right : Element_Type)
 194           return Boolean is <>;
 195
 196       with function ">" (Left : Key_Type; Right : Element_Type)
 197           return Boolean is <>;
 198
 199    package Generic_Keys is
 200
 201       function Contains
 202         (Container : Set;
 203          Key       : Key_Type) return Boolean;
 204
 205       function Find
 206         (Container : Set;
 207          Key       : Key_Type) return Cursor;
 208
 209       function Floor
 210         (Container : Set;
 211          Key       : Key_Type) return Cursor;
 212
 213       function Ceiling
 214         (Container : Set;
 215          Key       : Key_Type) return Cursor;
 216
 217       function Key (Position : Cursor) return Key_Type;
 218
 219       function Element
 220         (Container : Set;
 221          Key       : Key_Type) return Element_Type;
 222
 223       --  TODO: resolve in Atlanta???
 224       --      procedure Replace
 225       --        (Container : in out Set;
 226       --         Key       : Key_Type;
 227       --         New_Item  : Element_Type);
 228
 229       procedure Delete (Container : in out Set; Key : Key_Type);
 230
 231       procedure Exclude (Container : in out Set; Key : Key_Type);
 232
 233       function "<" (Left : Cursor; Right : Key_Type) return Boolean;
 234
 235       function ">" (Left : Cursor; Right : Key_Type) return Boolean;
 236
 237       function "<" (Left : Key_Type; Right : Cursor) return Boolean;
 238
 239       function ">" (Left : Key_Type; Right : Cursor) return Boolean;
 240
 241       --  TODO: resolve name in Atlanta???
 242       procedure Checked_Update_Element
 243         (Container : in out Set;
 244          Position  : Cursor;
 245          Process   : not null access
 246                        procedure (Element : in out Element_Type));
 247
 248    end Generic_Keys;
 249
 250 private
 251
 252    type Node_Type;
 253    type Node_Access is access Node_Type;
 254
 255    package Tree_Types is
 256      new Red_Black_Trees.Generic_Tree_Types (Node_Access);
 257
 258    use Tree_Types;
 259    use Ada.Finalization;
 260
 261    type Set is new Controlled with record
 262       Tree : Tree_Type := (Length => 0, others => null);
 263    end record;
 264
 265    procedure Adjust (Container : in out Set);
 266
 267    procedure Finalize (Container : in out Set) renames Clear;
 268
 269    type Set_Access is access constant Set;
 270    for Set_Access'Storage_Size use 0;
 271
 272    type Cursor is record
 273       Container : Set_Access;
 274       Node      : Node_Access;
 275    end record;
 276
 277    No_Element : constant Cursor := Cursor'(null, null);
 278
 279    use Ada.Streams;
 280
 281    procedure Write
 282      (Stream    : access Root_Stream_Type'Class;
 283       Container : Set);
 284
 285    for Set'Write use Write;
 286
 287    procedure Read
 288      (Stream    : access Root_Stream_Type'Class;
 289       Container : out Set);
 290
 291    for Set'Read use Read;
 292
 293    Empty_Set : constant Set :=
 294                  (Controlled with Tree => (Length => 0, others => null));
 295
 296 end Ada.Containers.Indefinite_Ordered_Sets;