1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT LIBRARY COMPONENTS                          --
4--                                                                          --
5--                ADA.CONTAINERS.BOUNDED_SYNCHRONIZED_QUEUES                --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 2011-2013, 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 3,  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.                                     --
21--                                                                          --
22-- As a special exception under Section 7 of GPL version 3, you are granted --
23-- additional permissions described in the GCC Runtime Library Exception,   --
24-- version 3.1, as published by the Free Software Foundation.               --
25--                                                                          --
26-- You should have received a copy of the GNU General Public License and    --
27-- a copy of the GCC Runtime Library Exception along with this program;     --
28-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
29-- <http://www.gnu.org/licenses/>.                                          --
30--                                                                          --
31-- This unit was originally developed by Matthew J Heaney.                  --
32------------------------------------------------------------------------------
33
34with System;
35with Ada.Containers.Synchronized_Queue_Interfaces;
36
37generic
38   with package Queue_Interfaces is
39     new Ada.Containers.Synchronized_Queue_Interfaces (<>);
40
41   Default_Capacity : Count_Type;
42   Default_Ceiling  : System.Any_Priority := System.Priority'Last;
43
44package Ada.Containers.Bounded_Synchronized_Queues is
45   pragma Preelaborate;
46
47   package Implementation is
48
49      --  All identifiers in this unit are implementation defined
50
51      pragma Implementation_Defined;
52
53      type List_Type (Capacity : Count_Type) is tagged limited private;
54
55      procedure Enqueue
56        (List     : in out List_Type;
57         New_Item : Queue_Interfaces.Element_Type);
58
59      procedure Dequeue
60        (List    : in out List_Type;
61         Element : out Queue_Interfaces.Element_Type);
62
63      function Length (List : List_Type) return Count_Type;
64
65      function Max_Length (List : List_Type) return Count_Type;
66
67   private
68
69      --  Need proper heap data structure here ???
70
71      type Element_Array is
72        array (Count_Type range <>) of Queue_Interfaces.Element_Type;
73
74      type List_Type (Capacity : Count_Type) is tagged limited record
75         First, Last : Count_Type := 0;
76         Length      : Count_Type := 0;
77         Max_Length  : Count_Type := 0;
78         Elements    : Element_Array (1 .. Capacity) := (others => <>);
79      end record;
80
81   end Implementation;
82
83   protected type Queue
84     (Capacity : Count_Type := Default_Capacity;
85      Ceiling  : System.Any_Priority := Default_Ceiling)
86   with
87     Priority => Ceiling
88   is new Queue_Interfaces.Queue with
89
90      overriding entry Enqueue (New_Item : Queue_Interfaces.Element_Type);
91
92      overriding entry Dequeue (Element : out Queue_Interfaces.Element_Type);
93
94      overriding function Current_Use return Count_Type;
95
96      overriding function Peak_Use return Count_Type;
97
98   private
99      List : Implementation.List_Type (Capacity);
100   end Queue;
101
102end Ada.Containers.Bounded_Synchronized_Queues;
103