gcc/ada/a-coormu.ads

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