1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT LIBRARY COMPONENTS                          --
4--                                                                          --
5--       A D A . C O N T A I N E R S . R E D _ B L A C K _ T R E 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 tree type used to implement ordered containers
31
32package Ada.Containers.Red_Black_Trees is
33   pragma Pure;
34
35   type Color_Type is (Red, Black);
36
37   generic
38      type Node_Type (<>) is limited private;
39      type Node_Access is access Node_Type;
40   package Generic_Tree_Types is
41      type Tree_Type is tagged record
42         First  : Node_Access;
43         Last   : Node_Access;
44         Root   : Node_Access;
45         Length : Count_Type := 0;
46         Busy   : Natural := 0;
47         Lock   : Natural := 0;
48      end record;
49   end Generic_Tree_Types;
50
51   generic
52      type Node_Type is private;
53   package Generic_Bounded_Tree_Types is
54      type Nodes_Type is array (Count_Type range <>) of Node_Type;
55
56      --  Note that objects of type Tree_Type are logically initialized (in the
57      --  sense that representation invariants of type are satisfied by dint of
58      --  default initialization), even without the Nodes component also having
59      --  its own initialization expression. We only initializae the Nodes
60      --  component here in order to prevent spurious compiler warnings about
61      --  the container object not being fully initialized.
62
63      type Tree_Type (Capacity : Count_Type) is tagged record
64         First  : Count_Type := 0;
65         Last   : Count_Type := 0;
66         Root   : Count_Type := 0;
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      end record;
73   end Generic_Bounded_Tree_Types;
74
75end Ada.Containers.Red_Black_Trees;
76