1 ------------------------------------------------------------------------------
3 -- GNAT LIBRARY COMPONENTS --
5 -- ADA.CONTAINERS.INDEFINITE_DOUBLY_LINKED_LISTS --
9 -- Copyright (C) 2004-2008, 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 private with Ada
.Finalization
;
37 private with Ada
.Streams
;
40 type Element_Type
(<>) is private;
42 with function "=" (Left
, Right
: Element_Type
)
45 package Ada
.Containers
.Indefinite_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
;
102 New_Item
: Element_Type
;
103 Count
: Count_Type
:= 1);
106 (Container
: in out List
;
107 New_Item
: Element_Type
;
108 Count
: Count_Type
:= 1);
111 (Container
: in out List
;
112 Position
: in out Cursor
;
113 Count
: Count_Type
:= 1);
115 procedure Delete_First
116 (Container
: in out List
;
117 Count
: Count_Type
:= 1);
119 procedure Delete_Last
120 (Container
: in out List
;
121 Count
: Count_Type
:= 1);
123 procedure Reverse_Elements
(Container
: in out List
);
125 procedure Swap
(Container
: in out List
; I
, J
: Cursor
);
127 procedure Swap_Links
(Container
: in out List
; I
, J
: Cursor
);
130 (Target
: in out List
;
132 Source
: in out List
);
135 (Target
: in out List
;
137 Source
: in out List
;
138 Position
: in out Cursor
);
141 (Container
: in out List
;
145 function First
(Container
: List
) return Cursor
;
147 function First_Element
(Container
: List
) return Element_Type
;
149 function Last
(Container
: List
) return Cursor
;
151 function Last_Element
(Container
: List
) return Element_Type
;
153 function Next
(Position
: Cursor
) return Cursor
;
155 procedure Next
(Position
: in out Cursor
);
157 function Previous
(Position
: Cursor
) return Cursor
;
159 procedure Previous
(Position
: in out Cursor
);
164 Position
: Cursor
:= No_Element
) return Cursor
;
166 function Reverse_Find
169 Position
: Cursor
:= No_Element
) return Cursor
;
173 Item
: Element_Type
) return Boolean;
175 function Has_Element
(Position
: Cursor
) return Boolean;
179 Process
: not null access procedure (Position
: Cursor
));
181 procedure Reverse_Iterate
183 Process
: not null access procedure (Position
: Cursor
));
186 with function "<" (Left
, Right
: Element_Type
) return Boolean is <>;
187 package Generic_Sorting
is
189 function Is_Sorted
(Container
: List
) return Boolean;
191 procedure Sort
(Container
: in out List
);
193 procedure Merge
(Target
, Source
: in out List
);
199 pragma Inline
(Next
);
200 pragma Inline
(Previous
);
203 type Node_Access
is access Node_Type
;
205 type Element_Access
is access Element_Type
;
209 Element
: Element_Access
;
214 use Ada
.Finalization
;
217 new Controlled
with record
220 Length
: Count_Type
:= 0;
226 procedure Adjust
(Container
: in out List
);
229 procedure Finalize
(Container
: in out List
) renames Clear
;
234 (Stream
: not null access Root_Stream_Type
'Class;
237 for List
'Read use Read
;
240 (Stream
: not null access Root_Stream_Type
'Class;
243 for List
'Write use Write
;
245 type List_Access
is access constant List
;
246 for List_Access
'Storage_Size use 0;
250 Container
: List_Access
;
255 (Stream
: not null access Root_Stream_Type
'Class;
258 for Cursor
'Read use Read
;
261 (Stream
: not null access Root_Stream_Type
'Class;
264 for Cursor
'Write use Write
;
266 Empty_List
: constant List
:= List
'(Controlled with null, null, 0, 0, 0);
268 No_Element : constant Cursor := Cursor'(null, null);
270 end Ada
.Containers
.Indefinite_Doubly_Linked_Lists
;