gcc/ada/a-cohase.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --           A D A . C O N T A I N E R S . H A S H E D _ S E T S            --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2004-2005 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,  51  Franklin  Street,  Fifth  Floor, --
  24 -- Boston, MA 02110-1301, 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 with Ada.Finalization;
  39
  40 generic
  41    type Element_Type is private;
  42
  43    with function Hash (Element : Element_Type) return Hash_Type;
  44
  45    with function Equivalent_Elements (Left, Right : Element_Type)
  46                                      return Boolean;
  47
  48    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  49
  50 package Ada.Containers.Hashed_Sets is
  51    pragma Preelaborate;
  52
  53    type Set is tagged private;
  54
  55    type Cursor is private;
  56
  57    Empty_Set : constant Set;
  58
  59    No_Element : constant Cursor;
  60
  61    function "=" (Left, Right : Set) return Boolean;
  62
  63    function Equivalent_Sets (Left, Right : Set) return Boolean;
  64
  65    function Capacity (Container : Set) return Count_Type;
  66
  67    procedure Reserve_Capacity
  68      (Container : in out Set;
  69       Capacity  : Count_Type);
  70
  71    function Length (Container : Set) return Count_Type;
  72
  73    function Is_Empty (Container : Set) return Boolean;
  74
  75    procedure Clear (Container : in out Set);
  76
  77    function Element (Position : Cursor) return Element_Type;
  78
  79    procedure Replace_Element
  80      (Container : in out Set;
  81       Position  : Cursor;
  82       New_Item  : Element_Type);
  83
  84    procedure Query_Element
  85      (Position : Cursor;
  86       Process  : not null access procedure (Element : Element_Type));
  87
  88    procedure Move (Target : in out Set; Source : in out Set);
  89
  90    procedure Insert
  91      (Container : in out Set;
  92       New_Item  : Element_Type;
  93       Position  : out Cursor;
  94       Inserted  : out Boolean);
  95
  96    procedure Insert  (Container : in out Set; New_Item : Element_Type);
  97
  98    procedure Include (Container : in out Set; New_Item : Element_Type);
  99
 100    procedure Replace (Container : in out Set; New_Item : Element_Type);
 101
 102    procedure Exclude (Container : in out Set; Item     : Element_Type);
 103
 104    procedure Delete  (Container : in out Set; Item     : Element_Type);
 105
 106    procedure Delete (Container : in out Set; Position  : in out Cursor);
 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
 131      renames Symmetric_Difference;
 132
 133    function Overlap (Left, Right : Set) return Boolean;
 134
 135    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 136
 137    function First (Container : Set) return Cursor;
 138
 139    function Next (Position : Cursor) return Cursor;
 140
 141    procedure Next (Position : in out Cursor);
 142
 143    function Find
 144      (Container : Set;
 145       Item      : Element_Type) return Cursor;
 146
 147    function Contains (Container : Set; Item : Element_Type) return Boolean;
 148
 149    function Has_Element (Position : Cursor) return Boolean;
 150
 151    function Equivalent_Elements (Left, Right : Cursor) return Boolean;
 152
 153    function Equivalent_Elements
 154      (Left  : Cursor;
 155       Right : Element_Type) return Boolean;
 156
 157    function Equivalent_Elements
 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 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 (Left, Right : Key_Type) return Boolean;
 173
 174    package Generic_Keys is
 175
 176       function Key (Position : Cursor) return Key_Type;
 177
 178       function Element (Container : Set; Key : Key_Type) return Element_Type;
 179
 180       procedure Replace          --  TODO: ask Randy why this wasn't removed
 181         (Container : in out Set;
 182          Key       : Key_Type;
 183          New_Item  : Element_Type);
 184
 185       procedure Exclude (Container : in out Set; Key : Key_Type);
 186
 187       procedure Delete (Container : in out Set; Key : Key_Type);
 188
 189       function Find (Container : Set; Key : Key_Type) return Cursor;
 190
 191       function Contains (Container : Set; Key : Key_Type) return Boolean;
 192
 193       procedure Update_Element_Preserving_Key
 194         (Container : in out Set;
 195          Position  : Cursor;
 196          Process   : not null access
 197                        procedure (Element : in out Element_Type));
 198
 199    end Generic_Keys;
 200
 201 private
 202    type Node_Type;
 203    type Node_Access is access Node_Type;
 204
 205    type Node_Type is
 206       limited record
 207          Element : Element_Type;
 208          Next    : Node_Access;
 209       end record;
 210
 211    package HT_Types is new Hash_Tables.Generic_Hash_Table_Types
 212      (Node_Type,
 213       Node_Access);
 214
 215    type Set is new Ada.Finalization.Controlled with record
 216       HT : HT_Types.Hash_Table_Type;
 217    end record;
 218
 219    procedure Adjust (Container : in out Set);
 220
 221    procedure Finalize (Container : in out Set);
 222
 223    use HT_Types;
 224    use Ada.Finalization;
 225
 226    type Set_Access is access all Set;
 227    for Set_Access'Storage_Size use 0;
 228
 229    type Cursor is
 230       record
 231          Container : Set_Access;
 232          Node      : Node_Access;
 233       end record;
 234
 235    No_Element : constant Cursor := (Container => null, Node => null);
 236
 237    use Ada.Streams;
 238
 239    procedure Write
 240      (Stream    : access Root_Stream_Type'Class;
 241       Container : Set);
 242
 243    for Set'Write use Write;
 244
 245    procedure Read
 246      (Stream    : access Root_Stream_Type'Class;
 247       Container : out Set);
 248
 249    for Set'Read use Read;
 250
 251    Empty_Set : constant Set := (Controlled with HT => (null, 0, 0, 0));
 252
 253 end Ada.Containers.Hashed_Sets;