gcc/ada/a-ciormu.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --               ADA.CONTAINERS.INDEFINITE_ORDERED_MULTISETS                --
   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_Multisets is
  47 pragma Preelaborate (Indefinite_Ordered_Multisets);
  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    procedure Move (Target : in out Set; Source : in out Set);
  72
  73    procedure Insert
  74      (Container : in out Set;
  75       New_Item  : Element_Type;
  76       Position  : out Cursor);
  77
  78    procedure Insert (Container : in out Set; New_Item : Element_Type);
  79
  80    procedure Delete (Container : in out Set; Item : Element_Type);
  81
  82    procedure Exclude (Container : in out Set; Item : Element_Type);
  83
  84    procedure Delete (Container : in out Set; Position : in out Cursor);
  85
  86    procedure Delete_First (Container : in out Set);
  87
  88    procedure Delete_Last (Container : in out Set);
  89
  90
  91    --  NOTE: The following operation is named Replace in the Madison API.
  92    --  However, it should be named Replace_Element ???
  93    --
  94    --   procedure Replace
  95    --     (Container : in out Set;
  96    --      Position  : Cursor;
  97    --      By        : Element_Type);
  98
  99    procedure Union (Target : in out Set;
 100                     Source : Set);
 101
 102    function Union (Left, Right : Set) return Set;
 103
 104    function "or" (Left, Right : Set) return Set renames Union;
 105
 106    procedure Intersection (Target : in out Set; Source : Set);
 107
 108    function Intersection (Left, Right : Set) return Set;
 109
 110    function "and" (Left, Right : Set) return Set renames Intersection;
 111
 112    procedure Difference (Target : in out Set; Source : Set);
 113
 114    function Difference (Left, Right : Set) return Set;
 115
 116    function "-" (Left, Right : Set) return Set renames Difference;
 117
 118    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 119
 120    function Symmetric_Difference (Left, Right : Set) return Set;
 121
 122    function "xor" (Left, Right : Set) return Set renames Symmetric_Difference;
 123
 124    function Overlap (Left, Right : Set) return Boolean;
 125
 126    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 127
 128    function Contains (Container : Set; Item : Element_Type) return Boolean;
 129
 130    function Find (Container : Set; Item : Element_Type) return Cursor;
 131
 132    function Floor (Container : Set; Item : Element_Type) return Cursor;
 133
 134    function Ceiling (Container : Set; Item : Element_Type) return Cursor;
 135
 136    function First (Container : Set) return Cursor;
 137
 138    function First_Element (Container : Set) return Element_Type;
 139
 140    function Last (Container : Set) return Cursor;
 141
 142    function Last_Element (Container : Set) return Element_Type;
 143
 144    function Next (Position : Cursor) return Cursor;
 145
 146    function Previous (Position : Cursor) return Cursor;
 147
 148    procedure Next (Position : in out Cursor);
 149
 150    procedure Previous (Position : in out Cursor);
 151
 152    function Has_Element (Position : Cursor) return Boolean;
 153
 154    function "<" (Left, Right : Cursor) return Boolean;
 155
 156    function ">" (Left, Right : Cursor) return Boolean;
 157
 158    function "<" (Left : Cursor; Right : Element_Type) return Boolean;
 159
 160    function ">" (Left : Cursor; Right : Element_Type) return Boolean;
 161
 162    function "<" (Left : Element_Type; Right : Cursor) return Boolean;
 163
 164    function ">" (Left : Element_Type; Right : Cursor) return Boolean;
 165
 166    procedure Iterate
 167      (Container : Set;
 168       Process   : not null access procedure (Position : Cursor));
 169
 170    procedure Reverse_Iterate
 171      (Container : Set;
 172       Process   : not null access procedure (Position : Cursor));
 173
 174    procedure Iterate
 175      (Container : Set;
 176       Item      : Element_Type;
 177       Process   : not null access procedure (Position : Cursor));
 178
 179    procedure Reverse_Iterate
 180      (Container : Set;
 181       Item      : Element_Type;
 182       Process   : not null access procedure (Position : Cursor));
 183
 184    generic
 185
 186       type Key_Type (<>) is limited private;
 187
 188       with function Key (Element : Element_Type) return Key_Type;
 189
 190       with function "<" (Left : Key_Type; Right : Element_Type)
 191           return Boolean is <>;
 192
 193       with function ">" (Left : Key_Type; Right : Element_Type)
 194           return Boolean is <>;
 195
 196    package Generic_Keys is
 197
 198       function Contains (Container : Set; Key : Key_Type) return Boolean;
 199
 200       function Find (Container : Set; Key : Key_Type) return Cursor;
 201
 202       function Floor (Container : Set; Key : Key_Type) return Cursor;
 203
 204       function Ceiling (Container : Set; Key : Key_Type) return Cursor;
 205
 206       function Key (Position : Cursor) return Key_Type;
 207
 208       function Element (Container : Set; Key : Key_Type) return Element_Type;
 209
 210       --  NOTE: in post-madison api ???
 211       --      procedure Replace
 212       --        (Container : in out Set;
 213       --         Key       : Key_Type;
 214       --         New_Item  : Element_Type);
 215
 216       procedure Delete (Container : in out Set; Key : Key_Type);
 217
 218       procedure Exclude (Container : in out Set; Key : Key_Type);
 219
 220       function "<" (Left : Cursor; Right : Key_Type) return Boolean;
 221
 222       function ">" (Left : Cursor; Right : Key_Type) return Boolean;
 223
 224       function "<" (Left : Key_Type; Right : Cursor) return Boolean;
 225
 226       function ">" (Left : Key_Type; Right : Cursor) return Boolean;
 227
 228       procedure Checked_Update_Element
 229         (Container : in out Set;
 230          Position  : Cursor;
 231          Process   : not null access
 232                        procedure (Element : in out Element_Type));
 233
 234       procedure Iterate
 235         (Container : Set;
 236          Key       : Key_Type;
 237          Process   : not null access procedure (Position : Cursor));
 238
 239       procedure Reverse_Iterate
 240         (Container : Set;
 241          Key       : Key_Type;
 242          Process   : not null access procedure (Position : Cursor));
 243
 244    end Generic_Keys;
 245
 246 private
 247
 248    type Node_Type;
 249    type Node_Access is access Node_Type;
 250
 251    package Tree_Types is
 252       new Red_Black_Trees.Generic_Tree_Types (Node_Access);
 253
 254    use Tree_Types;
 255    use Ada.Finalization;
 256
 257    type Set is new Controlled with record
 258       Tree : Tree_Type := (Length => 0, others => null);
 259    end record;
 260
 261    procedure Adjust (Container : in out Set);
 262
 263    procedure Finalize (Container : in out Set) renames Clear;
 264
 265    type Set_Access is access constant Set;
 266    for Set_Access'Storage_Size use 0;
 267
 268    type Cursor is record
 269       Container : Set_Access;
 270       Node      : Node_Access;
 271    end record;
 272
 273    No_Element : constant Cursor := Cursor'(null, null);
 274
 275    use Ada.Streams;
 276
 277    procedure Write (Stream : access Root_Stream_Type'Class; Container : Set);
 278
 279    for Set'Write use Write;
 280
 281    procedure Read
 282      (Stream    : access Root_Stream_Type'Class;
 283       Container : out Set);
 284
 285    for Set'Read use Read;
 286
 287    Empty_Set : constant Set :=
 288                  (Controlled with Tree => (Length => 0, others => null));
 289
 290 end Ada.Containers.Indefinite_Ordered_Multisets;