gcc/ada/a-cohase.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --                        ADA.CONTAINERS.HASHED_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.Hash_Tables;
  37 with Ada.Streams;
  38
  39 generic
  40    type Element_Type is private;
  41
  42    with function Hash (Element : Element_Type) return Hash_Type;
  43
  44    --  TODO: get a ruling from ARG in Atlanta re the name and
  45    --  order of these declarations. ???
  46    --
  47    with function Equivalent_Keys (Left, Right : Element_Type) return Boolean;
  48
  49    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  50
  51 package Ada.Containers.Hashed_Sets is
  52 pragma Preelaborate (Hashed_Sets);
  53
  54    type Set is tagged private;
  55
  56    type Cursor is private;
  57
  58    Empty_Set : constant Set;
  59
  60    No_Element : constant Cursor;
  61
  62    function "=" (Left, Right : Set) return Boolean;
  63
  64    function Length (Container : Set) return Count_Type;
  65
  66    function Is_Empty (Container : Set) return Boolean;
  67
  68    procedure Clear (Container : in out Set);
  69
  70    function Element (Position : Cursor) return Element_Type;
  71
  72    procedure Query_Element
  73      (Position : Cursor;
  74       Process  : not null access procedure (Element : Element_Type));
  75
  76    --  TODO: resolve in atlanta
  77    --   procedure Replace_Element
  78    --     (Container : in out Set;
  79    --      Position  : Cursor;
  80    --      By        : Element_Type);
  81
  82    procedure Move (Target : in out Set; Source : in out Set);
  83
  84    procedure Insert
  85      (Container : in out Set;
  86       New_Item  : Element_Type;
  87       Position  : out Cursor;
  88       Inserted  : out Boolean);
  89
  90    procedure Insert  (Container : in out Set; New_Item : Element_Type);
  91
  92    procedure Include (Container : in out Set; New_Item : Element_Type);
  93
  94    procedure Replace (Container : in out Set; New_Item : Element_Type);
  95
  96    procedure Delete  (Container : in out Set; Item     : Element_Type);
  97
  98    procedure Exclude (Container : in out Set; Item     : Element_Type);
  99
 100    procedure Delete (Container : in out Set; Position  : in out Cursor);
 101
 102    procedure Union (Target : in out Set; Source : Set);
 103
 104    function Union (Left, Right : Set) return Set;
 105
 106    function "or" (Left, Right : Set) return Set renames Union;
 107
 108    procedure Intersection (Target : in out Set; Source : Set);
 109
 110    function Intersection (Left, Right : Set) return Set;
 111
 112    function "and" (Left, Right : Set) return Set renames Intersection;
 113
 114    procedure Difference (Target : in out Set; Source : Set);
 115
 116    function Difference (Left, Right : Set) return Set;
 117
 118    function "-" (Left, Right : Set) return Set renames Difference;
 119
 120    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 121
 122    function Symmetric_Difference (Left, Right : Set) return Set;
 123
 124    function "xor" (Left, Right : Set) return Set
 125      renames Symmetric_Difference;
 126
 127    function Overlap (Left, Right : Set) return Boolean;
 128
 129    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 130
 131    function Contains (Container : Set; Item : Element_Type) return Boolean;
 132
 133    function Find
 134      (Container : Set;
 135       Item      : Element_Type) return Cursor;
 136
 137    function Capacity (Container : Set) return Count_Type;
 138
 139    procedure Reserve_Capacity
 140      (Container : in out Set;
 141       Capacity  : Count_Type);
 142
 143    function First (Container : Set) return Cursor;
 144
 145    function Next (Position : Cursor) return Cursor;
 146
 147    procedure Next (Position : in out Cursor);
 148
 149    function Has_Element (Position : Cursor) return Boolean;
 150
 151    function Equivalent_Keys (Left, Right : Cursor) return Boolean;
 152
 153    function Equivalent_Keys
 154      (Left  : Cursor;
 155       Right : Element_Type) return Boolean;
 156
 157    function Equivalent_Keys
 158      (Left  : Element_Type;
 159       Right : Cursor) return Boolean;
 160
 161    procedure Iterate
 162      (Container : Set;
 163       Process   : not null access procedure (Position : Cursor));
 164
 165    generic
 166       type Key_Type (<>) is limited private;
 167
 168       with function Key (Element : Element_Type) return Key_Type;
 169
 170       with function Hash (Key : Key_Type) return Hash_Type;
 171
 172       with function Equivalent_Keys
 173         (Key     : Key_Type;
 174          Element : Element_Type) return Boolean;
 175
 176    package Generic_Keys is
 177
 178       function Contains (Container : Set; Key : Key_Type) return Boolean;
 179
 180       function Find (Container : Set; Key : Key_Type) return Cursor;
 181
 182       function Key (Position : Cursor) return Key_Type;
 183
 184       function Element (Container : Set; Key : Key_Type) return Element_Type;
 185
 186       --  TODO: resolve in atlanta
 187       --      procedure Replace
 188       --        (Container : in out Set;
 189       --         Key       : Key_Type;
 190       --         New_Item  : Element_Type);
 191
 192       procedure Delete (Container : in out Set; Key : Key_Type);
 193
 194       procedure Exclude (Container : in out Set; Key : Key_Type);
 195
 196       --  TODO: resolve name in atlanta: ???
 197       procedure Checked_Update_Element
 198         (Container : in out Set;
 199          Position  : Cursor;
 200          Process   : not null access
 201                        procedure (Element : in out Element_Type));
 202
 203       function Equivalent_Keys
 204         (Left  : Cursor;
 205          Right : Key_Type) return Boolean;
 206
 207       function Equivalent_Keys
 208         (Left  : Key_Type;
 209          Right : Cursor) return Boolean;
 210
 211    end Generic_Keys;
 212
 213 private
 214
 215    type Node_Type;
 216    type Node_Access is access Node_Type;
 217
 218    package HT_Types is
 219      new Hash_Tables.Generic_Hash_Table_Types (Node_Access);
 220
 221    use HT_Types;
 222
 223    type Set is new Hash_Table_Type with null record;
 224
 225    procedure Adjust (Container : in out Set);
 226
 227    procedure Finalize (Container : in out Set);
 228
 229    type Set_Access is access constant Set;
 230    for Set_Access'Storage_Size use 0;
 231
 232    type Cursor is record
 233       Container : Set_Access;
 234       Node      : Node_Access;
 235    end record;
 236
 237    No_Element : constant Cursor := (Container => null, Node => null);
 238
 239    use Ada.Streams;
 240
 241    procedure Write
 242      (Stream    : access Root_Stream_Type'Class;
 243       Container : Set);
 244
 245    for Set'Write use Write;
 246
 247    procedure Read
 248      (Stream    : access Root_Stream_Type'Class;
 249       Container : out Set);
 250
 251    for Set'Read use Read;
 252
 253    Empty_Set : constant Set := (Hash_Table_Type with null record);
 254
 255 end Ada.Containers.Hashed_Sets;