gcc/ada/a-cihama.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --                      A D A . C O N T A I N E R S .                       --
   6 --               I N D E F I N I T E _ H A S H E D _ M A P S                --
   7 --                                                                          --
   8 --                                 S p e c                                  --
   9 --                                                                          --
  10 --          Copyright (C) 2004-2006, Free Software Foundation, Inc.         --
  11 --                                                                          --
  12 -- This specification is derived from the Ada Reference Manual for use with --
  13 -- GNAT. The copyright notice above, and the license provisions that follow --
  14 -- apply solely to the  contents of the part following the private keyword. --
  15 --                                                                          --
  16 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  17 -- terms of the  GNU General Public License as published  by the Free Soft- --
  18 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  19 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  20 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  21 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  22 -- for  more details.  You should have  received  a copy of the GNU General --
  23 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  24 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  25 -- Boston, MA 02110-1301, USA.                                              --
  26 --                                                                          --
  27 -- As a special exception,  if other files  instantiate  generics from this --
  28 -- unit, or you link  this unit with other files  to produce an executable, --
  29 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  30 -- covered  by the  GNU  General  Public  License.  This exception does not --
  31 -- however invalidate  any other reasons why  the executable file  might be --
  32 -- covered by the  GNU Public License.                                      --
  33 --                                                                          --
  34 -- This unit was originally developed by Matthew J Heaney.                  --
  35 ------------------------------------------------------------------------------
  36
  37 with Ada.Containers.Hash_Tables;
  38 with Ada.Streams;
  39 with Ada.Finalization;
  40
  41 generic
  42    type Key_Type (<>) is private;
  43    type Element_Type (<>) is private;
  44
  45    with function Hash (Key : Key_Type) return Hash_Type;
  46    with function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
  47    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  48
  49 package Ada.Containers.Indefinite_Hashed_Maps is
  50    pragma Preelaborate;
  51
  52    type Map is tagged private;
  53    pragma Preelaborable_Initialization (Map);
  54
  55    type Cursor is private;
  56    pragma Preelaborable_Initialization (Cursor);
  57
  58    Empty_Map  : constant Map;
  59    No_Element : constant Cursor;
  60
  61    function "=" (Left, Right : Map) return Boolean;
  62
  63    function Capacity (Container : Map) return Count_Type;
  64
  65    procedure Reserve_Capacity
  66      (Container : in out Map;
  67       Capacity  : Count_Type);
  68
  69    function Length (Container : Map) return Count_Type;
  70
  71    function Is_Empty (Container : Map) return Boolean;
  72
  73    procedure Clear (Container : in out Map);
  74
  75    function Key (Position : Cursor) return Key_Type;
  76
  77    function Element (Position : Cursor) return Element_Type;
  78
  79    procedure Replace_Element
  80      (Container : in out Map;
  81       Position  : Cursor;
  82       New_Item  : Element_Type);
  83
  84    procedure Query_Element
  85      (Position : Cursor;
  86       Process  : not null access procedure (Key     : Key_Type;
  87                                             Element : Element_Type));
  88
  89    procedure Update_Element
  90      (Container : in out Map;
  91       Position  : Cursor;
  92       Process   : not null access procedure (Key     : Key_Type;
  93                                             Element : in out Element_Type));
  94
  95    procedure Move (Target : in out Map; Source : in out Map);
  96
  97    procedure Insert
  98      (Container : in out Map;
  99       Key       : Key_Type;
 100       New_Item  : Element_Type;
 101       Position  : out Cursor;
 102       Inserted  : out Boolean);
 103
 104    procedure Insert
 105      (Container : in out Map;
 106       Key       : Key_Type;
 107       New_Item  : Element_Type);
 108
 109    procedure Include
 110      (Container : in out Map;
 111       Key       : Key_Type;
 112       New_Item  : Element_Type);
 113
 114    procedure Replace
 115      (Container : in out Map;
 116       Key       : Key_Type;
 117       New_Item  : Element_Type);
 118
 119    procedure Exclude (Container : in out Map; Key : Key_Type);
 120
 121    procedure Delete (Container : in out Map; Key : Key_Type);
 122
 123    procedure Delete (Container : in out Map; Position : in out Cursor);
 124
 125    function First (Container : Map) return Cursor;
 126
 127    function Next (Position : Cursor) return Cursor;
 128
 129    procedure Next (Position : in out Cursor);
 130
 131    function Find (Container : Map; Key : Key_Type) return Cursor;
 132
 133    function Contains (Container : Map; Key : Key_Type) return Boolean;
 134
 135    function Element (Container : Map; Key : Key_Type) return Element_Type;
 136
 137    function Has_Element (Position : Cursor) return Boolean;
 138
 139    function Equivalent_Keys (Left, Right : Cursor) return Boolean;
 140
 141    function Equivalent_Keys (Left : Cursor; Right : Key_Type) return Boolean;
 142
 143    function Equivalent_Keys (Left : Key_Type; Right : Cursor) return Boolean;
 144
 145    procedure Iterate
 146      (Container : Map;
 147       Process   : not null access procedure (Position : Cursor));
 148
 149 private
 150    pragma Inline ("=");
 151    pragma Inline (Length);
 152    pragma Inline (Is_Empty);
 153    pragma Inline (Clear);
 154    pragma Inline (Key);
 155    pragma Inline (Element);
 156    pragma Inline (Move);
 157    pragma Inline (Contains);
 158    pragma Inline (Capacity);
 159    pragma Inline (Reserve_Capacity);
 160    pragma Inline (Has_Element);
 161    pragma Inline (Equivalent_Keys);
 162
 163    type Node_Type;
 164    type Node_Access is access Node_Type;
 165
 166    type Key_Access is access Key_Type;
 167    type Element_Access is access Element_Type;
 168
 169    type Node_Type is limited record
 170       Key     : Key_Access;
 171       Element : Element_Access;
 172       Next    : Node_Access;
 173    end record;
 174
 175    package HT_Types is new Hash_Tables.Generic_Hash_Table_Types
 176      (Node_Type,
 177       Node_Access);
 178
 179    type Map is new Ada.Finalization.Controlled with record
 180       HT : HT_Types.Hash_Table_Type;
 181    end record;
 182
 183    use HT_Types;
 184    use Ada.Finalization;
 185    use Ada.Streams;
 186
 187    procedure Adjust (Container : in out Map);
 188
 189    procedure Finalize (Container : in out Map);
 190
 191    type Map_Access is access constant Map;
 192    for Map_Access'Storage_Size use 0;
 193
 194    type Cursor is
 195       record
 196          Container : Map_Access;
 197          Node      : Node_Access;
 198       end record;
 199
 200    procedure Write
 201      (Stream : access Root_Stream_Type'Class;
 202       Item   : Cursor);
 203
 204    for Cursor'Write use Write;
 205
 206    procedure Read
 207      (Stream : access Root_Stream_Type'Class;
 208       Item   : out Cursor);
 209
 210    for Cursor'Read use Read;
 211
 212    No_Element : constant Cursor :=
 213      (Container => null,
 214       Node      => null);
 215
 216    procedure Write
 217      (Stream    : access Root_Stream_Type'Class;
 218       Container : Map);
 219
 220    for Map'Write use Write;
 221
 222    procedure Read
 223      (Stream    : access Root_Stream_Type'Class;
 224       Container : out Map);
 225
 226    for Map'Read use Read;
 227
 228    Empty_Map : constant Map := (Controlled with HT => (null, 0, 0, 0));
 229
 230 end Ada.Containers.Indefinite_Hashed_Maps;