1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.BOUNDED_PRIORITY_QUEUES --
9 -- Copyright (C) 2011-2017, Free Software Foundation, Inc. --
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. --
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. --
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. --
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/>. --
31 -- This unit was originally developed by Matthew J Heaney. --
32 ------------------------------------------------------------------------------
36 with Ada
.Containers
.Synchronized_Queue_Interfaces
;
37 with Ada
.Containers
.Bounded_Doubly_Linked_Lists
;
40 with package Queue_Interfaces
is
41 new Ada
.Containers
.Synchronized_Queue_Interfaces
(<>);
43 type Queue_Priority
is private;
45 with function Get_Priority
46 (Element
: Queue_Interfaces
.Element_Type
) return Queue_Priority
is <>;
49 (Left
, Right
: Queue_Priority
) return Boolean is <>;
51 Default_Capacity
: Count_Type
;
52 Default_Ceiling
: System
.Any_Priority
:= System
.Priority
'Last;
54 package Ada
.Containers
.Bounded_Priority_Queues
is
55 pragma Annotate
(CodePeer
, Skip_Analysis
);
58 package Implementation
is
60 -- All identifiers in this unit are implementation defined
62 pragma Implementation_Defined
;
64 type List_Type
(Capacity
: Count_Type
) is tagged limited private;
67 (List
: in out List_Type
;
68 New_Item
: Queue_Interfaces
.Element_Type
);
71 (List
: in out List_Type
;
72 Element
: out Queue_Interfaces
.Element_Type
);
75 (List
: in out List_Type
;
76 At_Least
: Queue_Priority
;
77 Element
: in out Queue_Interfaces
.Element_Type
;
78 Success
: out Boolean);
80 function First_Element
81 (List
: List_Type
) return Queue_Interfaces
.Element_Type
;
83 function Length
(List
: List_Type
) return Count_Type
;
85 function Max_Length
(List
: List_Type
) return Count_Type
;
89 -- We need a better data structure here, such as a proper heap. ???
91 pragma Warnings
(Off
);
92 -- Otherwise, we get warnings for the uninitialized variable in Insert
93 -- in Ada.Containers.Bounded_Doubly_Linked_Lists.
94 package List_Types
is new Bounded_Doubly_Linked_Lists
95 (Element_Type
=> Queue_Interfaces
.Element_Type
,
96 "=" => Queue_Interfaces
."=");
99 type List_Type
(Capacity
: Count_Type
) is tagged limited record
100 Container
: List_Types
.List
(Capacity
);
101 Max_Length
: Count_Type
:= 0;
107 (Capacity
: Count_Type
:= Default_Capacity
;
108 Ceiling
: System
.Any_Priority
:= Default_Ceiling
)
111 is new Queue_Interfaces
.Queue
with
113 overriding
entry Enqueue
(New_Item
: Queue_Interfaces
.Element_Type
);
115 overriding
entry Dequeue
(Element
: out Queue_Interfaces
.Element_Type
);
117 -- The priority queue operation Dequeue_Only_High_Priority had been a
118 -- protected entry in early drafts of AI05-0159, but it was discovered
119 -- that that operation as specified was not in fact implementable. The
120 -- operation was changed from an entry to a protected procedure per the
121 -- ARG meeting in Edinburgh (June 2011), with a different signature and
124 procedure Dequeue_Only_High_Priority
125 (At_Least
: Queue_Priority
;
126 Element
: in out Queue_Interfaces
.Element_Type
;
127 Success
: out Boolean);
129 overriding
function Current_Use
return Count_Type
;
131 overriding
function Peak_Use
return Count_Type
;
134 List
: Implementation
.List_Type
(Capacity
);
137 end Ada
.Containers
.Bounded_Priority_Queues
;