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 _ T A B L E S           --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2004-2011, Free Software Foundation, Inc.         --
10--                                                                          --
11-- GNAT is free software;  you can  redistribute it  and/or modify it under --
12-- terms of the  GNU General Public License as published  by the Free Soft- --
13-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
17--                                                                          --
18-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
21--                                                                          --
22-- You should have received a copy of the GNU General Public License and    --
23-- a copy of the GCC Runtime Library Exception along with this program;     --
24-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25-- <http://www.gnu.org/licenses/>.                                          --
26--                                                                          --
27-- This unit was originally developed by Matthew J Heaney.                  --
28------------------------------------------------------------------------------
29
30--  This package declares the hash-table type used to implement hashed
31--  containers.
32
33package Ada.Containers.Hash_Tables is
34   pragma Pure;
35   --  Declare Pure so this can be imported by Remote_Types packages
36
37   generic
38      type Node_Type (<>) is limited private;
39
40      type Node_Access is access Node_Type;
41
42   package Generic_Hash_Table_Types is
43      type Buckets_Type is array (Hash_Type range <>) of Node_Access;
44
45      type Buckets_Access is access all Buckets_Type;
46      for Buckets_Access'Storage_Size use 0;
47      --  Storage_Size of zero so this package can be Pure
48
49      type Hash_Table_Type is tagged record
50         Buckets : Buckets_Access;
51         Length  : Count_Type := 0;
52         Busy    : Natural    := 0;
53         Lock    : Natural    := 0;
54      end record;
55   end Generic_Hash_Table_Types;
56
57   generic
58      type Node_Type is private;
59   package Generic_Bounded_Hash_Table_Types is
60      type Nodes_Type is array (Count_Type range <>) of Node_Type;
61      type Buckets_Type is array (Hash_Type range <>) of Count_Type;
62
63      type Hash_Table_Type
64        (Capacity : Count_Type;
65         Modulus  : Hash_Type) is
66      tagged record
67         Length  : Count_Type                  := 0;
68         Busy    : Natural                     := 0;
69         Lock    : Natural                     := 0;
70         Free    : Count_Type'Base             := -1;
71         Nodes   : Nodes_Type (1 .. Capacity)  := (others => <>);
72         Buckets : Buckets_Type (1 .. Modulus) := (others => 0);
73      end record;
74   end Generic_Bounded_Hash_Table_Types;
75
76end Ada.Containers.Hash_Tables;
77