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 To_Set (New_Item : Element_Type) return Set;
  66
  67    function Capacity (Container : Set) return Count_Type;
  68
  69    procedure Reserve_Capacity
  70      (Container : in out Set;
  71       Capacity  : Count_Type);
  72
  73    function Length (Container : Set) return Count_Type;
  74
  75    function Is_Empty (Container : Set) return Boolean;
  76
  77    procedure Clear (Container : in out Set);
  78
  79    function Element (Position : Cursor) return Element_Type;
  80
  81    procedure Replace_Element
  82      (Container : in out Set;
  83       Position  : Cursor;
  84       New_Item  : Element_Type);
  85
  86    procedure Query_Element
  87      (Position : Cursor;
  88       Process  : not null access procedure (Element : Element_Type));
  89
  90    procedure Move (Target : in out Set; Source : in out Set);
  91
  92    procedure Insert
  93      (Container : in out Set;
  94       New_Item  : Element_Type;
  95       Position  : out Cursor;
  96       Inserted  : out Boolean);
  97
  98    procedure Insert  (Container : in out Set; New_Item : Element_Type);
  99
 100    procedure Include (Container : in out Set; New_Item : Element_Type);
 101
 102    procedure Replace (Container : in out Set; New_Item : Element_Type);
 103
 104    procedure Exclude (Container : in out Set; Item     : Element_Type);
 105
 106    procedure Delete  (Container : in out Set; Item     : Element_Type);
 107
 108    procedure Delete (Container : in out Set; Position  : in out Cursor);
 109
 110    procedure Union (Target : in out Set; Source : Set);
 111
 112    function Union (Left, Right : Set) return Set;
 113
 114    function "or" (Left, Right : Set) return Set renames Union;
 115
 116    procedure Intersection (Target : in out Set; Source : Set);
 117
 118    function Intersection (Left, Right : Set) return Set;
 119
 120    function "and" (Left, Right : Set) return Set renames Intersection;
 121
 122    procedure Difference (Target : in out Set; Source : Set);
 123
 124    function Difference (Left, Right : Set) return Set;
 125
 126    function "-" (Left, Right : Set) return Set renames Difference;
 127
 128    procedure Symmetric_Difference (Target : in out Set; Source : Set);
 129
 130    function Symmetric_Difference (Left, Right : Set) return Set;
 131
 132    function "xor" (Left, Right : Set) return Set
 133      renames Symmetric_Difference;
 134
 135    function Overlap (Left, Right : Set) return Boolean;
 136
 137    function Is_Subset (Subset : Set; Of_Set : Set) return Boolean;
 138
 139    function First (Container : Set) return Cursor;
 140
 141    function Next (Position : Cursor) return Cursor;
 142
 143    procedure Next (Position : in out Cursor);
 144
 145    function Find
 146      (Container : Set;
 147       Item      : Element_Type) return Cursor;
 148
 149    function Contains (Container : Set; Item : Element_Type) return Boolean;
 150
 151    function Has_Element (Position : Cursor) return Boolean;
 152
 153    function Equivalent_Elements (Left, Right : Cursor) return Boolean;
 154
 155    function Equivalent_Elements
 156      (Left  : Cursor;
 157       Right : Element_Type) return Boolean;
 158
 159    function Equivalent_Elements
 160      (Left  : Element_Type;
 161       Right : Cursor) return Boolean;
 162
 163    procedure Iterate
 164      (Container : Set;
 165       Process   : not null access procedure (Position : Cursor));
 166
 167    generic
 168       type Key_Type (<>) is private;
 169
 170       with function Key (Element : Element_Type) return Key_Type;
 171
 172       with function Hash (Key : Key_Type) return Hash_Type;
 173
 174       with function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
 175
 176    package Generic_Keys is
 177
 178       function Key (Position : Cursor) return Key_Type;
 179
 180       function Element (Container : Set; Key : Key_Type) return Element_Type;
 181
 182       procedure Replace          --  TODO: ask Randy why this wasn't removed
 183         (Container : in out Set;
 184          Key       : Key_Type;
 185          New_Item  : Element_Type);
 186
 187       procedure Exclude (Container : in out Set; Key : Key_Type);
 188
 189       procedure Delete (Container : in out Set; Key : Key_Type);
 190
 191       function Find (Container : Set; Key : Key_Type) return Cursor;
 192
 193       function Contains (Container : Set; Key : Key_Type) return Boolean;
 194
 195       procedure Update_Element_Preserving_Key
 196         (Container : in out Set;
 197          Position  : Cursor;
 198          Process   : not null access
 199                        procedure (Element : in out Element_Type));
 200
 201    end Generic_Keys;
 202
 203 private
 204    type Node_Type;
 205    type Node_Access is access Node_Type;
 206
 207    type Node_Type is
 208       limited record
 209          Element : Element_Type;
 210          Next    : Node_Access;
 211       end record;
 212
 213    package HT_Types is new Hash_Tables.Generic_Hash_Table_Types
 214      (Node_Type,
 215       Node_Access);
 216
 217    type Set is new Ada.Finalization.Controlled with record
 218       HT : HT_Types.Hash_Table_Type;
 219    end record;
 220
 221    procedure Adjust (Container : in out Set);
 222
 223    procedure Finalize (Container : in out Set);
 224
 225    use HT_Types;
 226    use Ada.Finalization;
 227    use Ada.Streams;
 228
 229    type Set_Access is access all Set;
 230    for Set_Access'Storage_Size use 0;
 231
 232    type Cursor is
 233       record
 234          Container : Set_Access;
 235          Node      : Node_Access;
 236       end record;
 237
 238    procedure Write
 239      (Stream : access Root_Stream_Type'Class;
 240       Item   : Cursor);
 241
 242    for Cursor'Write use Write;
 243
 244    procedure Read
 245      (Stream : access Root_Stream_Type'Class;
 246       Item   : out Cursor);
 247
 248    for Cursor'Read use Read;
 249
 250    No_Element : constant Cursor := (Container => null, Node => null);
 251
 252    procedure Write
 253      (Stream    : access Root_Stream_Type'Class;
 254       Container : Set);
 255
 256    for Set'Write use Write;
 257
 258    procedure Read
 259      (Stream    : access Root_Stream_Type'Class;
 260       Container : out Set);
 261
 262    for Set'Read use Read;
 263
 264    Empty_Set : constant Set := (Controlled with HT => (null, 0, 0, 0));
 265
 266 end Ada.Containers.Hashed_Sets;