gcc/ada/a-cohama.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT LIBRARY COMPONENTS                          --
   4 --                                                                          --
   5 --                        ADA.CONTAINERS.HASHED_MAPS                        --
   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 Key_Type is private;
  41
  42    type Element_Type is private;
  43
  44    with function Hash (Key : Key_Type) return Hash_Type;
  45
  46    with function Equivalent_Keys (Left, Right : Key_Type) return Boolean;
  47
  48    with function "=" (Left, Right : Element_Type) return Boolean is <>;
  49
  50 package Ada.Containers.Hashed_Maps is
  51 pragma Preelaborate (Hashed_Maps);
  52
  53    type Map is tagged private;
  54
  55    type Cursor is private;
  56
  57    Empty_Map : constant Map;
  58
  59    No_Element : constant Cursor;
  60
  61    function "=" (Left, Right : Map) return Boolean;
  62
  63    function Length (Container : Map) return Count_Type;
  64
  65    function Is_Empty (Container : Map) return Boolean;
  66
  67    procedure Clear (Container : in out Map);
  68
  69    function Element (Position : Cursor)
  70       return Element_Type;
  71
  72    procedure Query_Element
  73      (Position : Cursor;
  74       Process  : not null access
  75                    procedure (Key : Key_Type; Element : Element_Type));
  76
  77    procedure Update_Element
  78      (Position : Cursor;
  79       Process  : not null access
  80                    procedure (Key : Key_Type; Element : in out Element_Type));
  81
  82    procedure Replace_Element (Position : Cursor; By : Element_Type);
  83
  84    procedure Move (Target : in out Map; Source : in out Map);
  85
  86    procedure Insert
  87      (Container : in out Map;
  88       Key       : Key_Type;
  89       New_Item  : Element_Type;
  90       Position  : out Cursor;
  91       Inserted  : out Boolean);
  92
  93    procedure Insert
  94      (Container : in out Map;
  95       Key       : Key_Type;
  96       New_Item  : Element_Type);
  97
  98    procedure Include
  99      (Container : in out Map;
 100       Key       : Key_Type;
 101       New_Item  : Element_Type);
 102
 103    procedure Replace
 104      (Container : in out Map;
 105       Key       : Key_Type;
 106       New_Item  : Element_Type);
 107
 108    procedure Insert
 109      (Container : in out Map;
 110       Key       : Key_Type;
 111       Position  : out Cursor;
 112       Inserted  : out Boolean);
 113
 114    procedure Delete (Container : in out Map; Key : Key_Type);
 115
 116    procedure Exclude (Container : in out Map; Key : Key_Type);
 117
 118    procedure Delete (Container : in out Map; Position : in out Cursor);
 119
 120    function Contains (Container : Map; Key : Key_Type) return Boolean;
 121
 122    function Find (Container : Map; Key : Key_Type) return Cursor;
 123
 124    function Element (Container : Map; Key : Key_Type) return Element_Type;
 125
 126    function Capacity (Container : Map) return Count_Type;
 127
 128    procedure Reserve_Capacity (Container : in out Map;
 129                                Capacity  : Count_Type);
 130
 131    function First (Container : Map) return Cursor;
 132
 133    function Next (Position : Cursor) return Cursor;
 134
 135    procedure Next (Position : in out Cursor);
 136
 137    function Has_Element (Position : Cursor) return Boolean;
 138
 139    function Key (Position : Cursor) return Key_Type;
 140
 141    function Equivalent_Keys (Left, Right : Cursor) return Boolean;
 142
 143    function Equivalent_Keys (Left : Cursor; Right : Key_Type) return Boolean;
 144
 145    function Equivalent_Keys (Left : Key_Type; Right : Cursor) return Boolean;
 146
 147    procedure Iterate
 148      (Container : Map;
 149       Process   : not null access procedure (Position : Cursor));
 150
 151 private
 152
 153    type Node_Type;
 154    type Node_Access is access Node_Type;
 155
 156    package HT_Types is new Hash_Tables.Generic_Hash_Table_Types (Node_Access);
 157
 158    use HT_Types;
 159
 160    type Map is new Hash_Table_Type with null record;
 161
 162    procedure Adjust (Container : in out Map);
 163
 164    procedure Finalize (Container : in out Map);
 165
 166    use Ada.Streams;
 167
 168    procedure Write
 169      (Stream    : access Root_Stream_Type'Class;
 170       Container : Map);
 171
 172    for Map'Write use Write;
 173
 174    procedure Read
 175      (Stream    : access Root_Stream_Type'Class;
 176       Container : out Map);
 177
 178    for Map'Read use Read;
 179
 180    Empty_Map : constant Map := (Hash_Table_Type with null record);
 181
 182    type Map_Access is access constant Map;
 183    for Map_Access'Storage_Size use 0;
 184
 185    type Cursor is
 186       record
 187          Container : Map_Access;
 188          Node      : Node_Access;
 189       end record;
 190
 191    No_Element : constant Cursor := (Container => null, Node => null);
 192
 193 end Ada.Containers.Hashed_Maps;