1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- A D A . C O N T A I N E R S . D O U B L Y _ L I N K E D _ L I S T S --
9 -- Copyright (C) 2004-2007, 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 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, 51 Franklin Street, Fifth Floor, --
24 -- Boston, MA 02110-1301, USA. --
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. --
33 -- This unit was originally developed by Matthew J Heaney. --
34 ------------------------------------------------------------------------------
36 with Ada
.Finalization
;
40 type Element_Type
is private;
42 with function "=" (Left
, Right
: Element_Type
)
45 package Ada
.Containers
.Doubly_Linked_Lists
is
49 type List
is tagged private;
50 pragma Preelaborable_Initialization
(List
);
52 type Cursor
is private;
53 pragma Preelaborable_Initialization
(Cursor
);
55 Empty_List
: constant List
;
57 No_Element
: constant Cursor
;
59 function "=" (Left
, Right
: List
) return Boolean;
61 function Length
(Container
: List
) return Count_Type
;
63 function Is_Empty
(Container
: List
) return Boolean;
65 procedure Clear
(Container
: in out List
);
67 function Element
(Position
: Cursor
) return Element_Type
;
69 procedure Replace_Element
70 (Container
: in out List
;
72 New_Item
: Element_Type
);
74 procedure Query_Element
76 Process
: not null access procedure (Element
: Element_Type
));
78 procedure Update_Element
79 (Container
: in out List
;
81 Process
: not null access procedure (Element
: in out Element_Type
));
84 (Target
: in out List
;
85 Source
: in out List
);
88 (Container
: in out List
;
90 New_Item
: Element_Type
;
91 Count
: Count_Type
:= 1);
94 (Container
: in out List
;
96 New_Item
: Element_Type
;
97 Position
: out Cursor
;
98 Count
: Count_Type
:= 1);
101 (Container
: in out List
;
103 Position
: out Cursor
;
104 Count
: Count_Type
:= 1);
107 (Container
: in out List
;
108 New_Item
: Element_Type
;
109 Count
: Count_Type
:= 1);
112 (Container
: in out List
;
113 New_Item
: Element_Type
;
114 Count
: Count_Type
:= 1);
117 (Container
: in out List
;
118 Position
: in out Cursor
;
119 Count
: Count_Type
:= 1);
121 procedure Delete_First
122 (Container
: in out List
;
123 Count
: Count_Type
:= 1);
125 procedure Delete_Last
126 (Container
: in out List
;
127 Count
: Count_Type
:= 1);
129 procedure Reverse_Elements
(Container
: in out List
);
132 (Container
: in out List
;
136 (Container
: in out List
;
140 (Target
: in out List
;
142 Source
: in out List
);
145 (Target
: in out List
;
147 Source
: in out List
;
148 Position
: in out Cursor
);
151 (Container
: in out List
;
155 function First
(Container
: List
) return Cursor
;
157 function First_Element
(Container
: List
) return Element_Type
;
159 function Last
(Container
: List
) return Cursor
;
161 function Last_Element
(Container
: List
) return Element_Type
;
163 function Next
(Position
: Cursor
) return Cursor
;
165 procedure Next
(Position
: in out Cursor
);
167 function Previous
(Position
: Cursor
) return Cursor
;
169 procedure Previous
(Position
: in out Cursor
);
174 Position
: Cursor
:= No_Element
) return Cursor
;
176 function Reverse_Find
179 Position
: Cursor
:= No_Element
) return Cursor
;
183 Item
: Element_Type
) return Boolean;
185 function Has_Element
(Position
: Cursor
) return Boolean;
189 Process
: not null access procedure (Position
: Cursor
));
191 procedure Reverse_Iterate
193 Process
: not null access procedure (Position
: Cursor
));
196 with function "<" (Left
, Right
: Element_Type
) return Boolean is <>;
197 package Generic_Sorting
is
199 function Is_Sorted
(Container
: List
) return Boolean;
201 procedure Sort
(Container
: in out List
);
203 procedure Merge
(Target
, Source
: in out List
);
209 pragma Inline
(Next
);
210 pragma Inline
(Previous
);
213 type Node_Access
is access Node_Type
;
217 Element
: Element_Type
;
222 use Ada
.Finalization
;
225 new Controlled
with record
228 Length
: Count_Type
:= 0;
233 procedure Adjust
(Container
: in out List
);
235 procedure Finalize
(Container
: in out List
) renames Clear
;
240 (Stream
: not null access Root_Stream_Type
'Class;
243 for List
'Read use Read
;
246 (Stream
: not null access Root_Stream_Type
'Class;
249 for List
'Write use Write
;
251 type List_Access
is access constant List
;
252 for List_Access
'Storage_Size use 0;
256 Container
: List_Access
;
261 (Stream
: not null access Root_Stream_Type
'Class;
264 for Cursor
'Read use Read
;
267 (Stream
: not null access Root_Stream_Type
'Class;
270 for Cursor
'Write use Write
;
272 Empty_List
: constant List
:= (Controlled
with null, null, 0, 0, 0);
274 No_Element
: constant Cursor
:= Cursor
'(null, null);
276 end Ada.Containers.Doubly_Linked_Lists;