| ------------------------------------------------------------------------------ |
| -- -- |
| -- GNAT LIBRARY COMPONENTS -- |
| -- -- |
| -- ADA.CONTAINERS.INDEFINITE_DOUBLY_LINKED_LISTS -- |
| -- -- |
| -- S p e c -- |
| -- -- |
| -- Copyright (C) 2004-2021, Free Software Foundation, Inc. -- |
| -- -- |
| -- This specification is derived from the Ada Reference Manual for use with -- |
| -- GNAT. The copyright notice above, and the license provisions that follow -- |
| -- apply solely to the contents of the part following the private keyword. -- |
| -- -- |
| -- GNAT is free software; you can redistribute it and/or modify it under -- |
| -- terms of the GNU General Public License as published by the Free Soft- -- |
| -- ware Foundation; either version 3, or (at your option) any later ver- -- |
| -- sion. GNAT is distributed in the hope that it will be useful, but WITH- -- |
| -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY -- |
| -- or FITNESS FOR A PARTICULAR PURPOSE. -- |
| -- -- |
| -- As a special exception under Section 7 of GPL version 3, you are granted -- |
| -- additional permissions described in the GCC Runtime Library Exception, -- |
| -- version 3.1, as published by the Free Software Foundation. -- |
| -- -- |
| -- You should have received a copy of the GNU General Public License and -- |
| -- a copy of the GCC Runtime Library Exception along with this program; -- |
| -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see -- |
| -- <http://www.gnu.org/licenses/>. -- |
| -- -- |
| -- This unit was originally developed by Matthew J Heaney. -- |
| ------------------------------------------------------------------------------ |
| |
| with Ada.Iterator_Interfaces; |
| |
| with Ada.Containers.Helpers; |
| private with Ada.Finalization; |
| private with Ada.Streams; |
| private with Ada.Strings.Text_Buffers; |
| |
| generic |
| type Element_Type (<>) is private; |
| |
| with function "=" (Left, Right : Element_Type) |
| return Boolean is <>; |
| |
| package Ada.Containers.Indefinite_Doubly_Linked_Lists with |
| SPARK_Mode => Off |
| is |
| pragma Annotate (CodePeer, Skip_Analysis); |
| pragma Preelaborate; |
| pragma Remote_Types; |
| |
| type List is tagged private with |
| Constant_Indexing => Constant_Reference, |
| Variable_Indexing => Reference, |
| Default_Iterator => Iterate, |
| Iterator_Element => Element_Type, |
| Aggregate => (Empty => Empty, |
| Add_Unnamed => Append); |
| |
| pragma Preelaborable_Initialization (List); |
| |
| type Cursor is private; |
| pragma Preelaborable_Initialization (Cursor); |
| |
| Empty_List : constant List; |
| |
| function Empty return List; |
| pragma Ada_2022 (Empty); |
| |
| No_Element : constant Cursor; |
| |
| function Has_Element (Position : Cursor) return Boolean; |
| |
| package List_Iterator_Interfaces is new |
| Ada.Iterator_Interfaces (Cursor, Has_Element); |
| |
| function "=" (Left, Right : List) return Boolean; |
| |
| function Length (Container : List) return Count_Type; |
| |
| function Is_Empty (Container : List) return Boolean; |
| |
| procedure Clear (Container : in out List); |
| |
| function Element (Position : Cursor) return Element_Type; |
| |
| procedure Replace_Element |
| (Container : in out List; |
| Position : Cursor; |
| New_Item : Element_Type); |
| |
| procedure Query_Element |
| (Position : Cursor; |
| Process : not null access procedure (Element : Element_Type)); |
| |
| procedure Update_Element |
| (Container : in out List; |
| Position : Cursor; |
| Process : not null access procedure (Element : in out Element_Type)); |
| |
| type Constant_Reference_Type |
| (Element : not null access constant Element_Type) is private |
| with |
| Implicit_Dereference => Element; |
| |
| type Reference_Type |
| (Element : not null access Element_Type) is private |
| with |
| Implicit_Dereference => Element; |
| |
| function Constant_Reference |
| (Container : aliased List; |
| Position : Cursor) return Constant_Reference_Type; |
| pragma Inline (Constant_Reference); |
| |
| function Reference |
| (Container : aliased in out List; |
| Position : Cursor) return Reference_Type; |
| pragma Inline (Reference); |
| |
| procedure Assign (Target : in out List; Source : List); |
| |
| function Copy (Source : List) return List; |
| |
| procedure Move |
| (Target : in out List; |
| Source : in out List); |
| |
| procedure Insert |
| (Container : in out List; |
| Before : Cursor; |
| New_Item : Element_Type; |
| Count : Count_Type := 1); |
| |
| procedure Insert |
| (Container : in out List; |
| Before : Cursor; |
| New_Item : Element_Type; |
| Position : out Cursor; |
| Count : Count_Type := 1); |
| |
| procedure Prepend |
| (Container : in out List; |
| New_Item : Element_Type; |
| Count : Count_Type := 1); |
| |
| procedure Append |
| (Container : in out List; |
| New_Item : Element_Type; |
| Count : Count_Type); |
| |
| procedure Append |
| (Container : in out List; |
| New_Item : Element_Type); |
| |
| procedure Delete |
| (Container : in out List; |
| Position : in out Cursor; |
| Count : Count_Type := 1); |
| |
| procedure Delete_First |
| (Container : in out List; |
| Count : Count_Type := 1); |
| |
| procedure Delete_Last |
| (Container : in out List; |
| Count : Count_Type := 1); |
| |
| procedure Reverse_Elements (Container : in out List); |
| |
| procedure Swap (Container : in out List; I, J : Cursor); |
| |
| procedure Swap_Links (Container : in out List; I, J : Cursor); |
| |
| procedure Splice |
| (Target : in out List; |
| Before : Cursor; |
| Source : in out List); |
| |
| procedure Splice |
| (Target : in out List; |
| Before : Cursor; |
| Source : in out List; |
| Position : in out Cursor); |
| |
| procedure Splice |
| (Container : in out List; |
| Before : Cursor; |
| Position : Cursor); |
| |
| function First (Container : List) return Cursor; |
| |
| function First_Element (Container : List) return Element_Type; |
| |
| function Last (Container : List) return Cursor; |
| |
| function Last_Element (Container : List) return Element_Type; |
| |
| function Next (Position : Cursor) return Cursor; |
| |
| procedure Next (Position : in out Cursor); |
| |
| function Previous (Position : Cursor) return Cursor; |
| |
| procedure Previous (Position : in out Cursor); |
| |
| function Find |
| (Container : List; |
| Item : Element_Type; |
| Position : Cursor := No_Element) return Cursor; |
| |
| function Reverse_Find |
| (Container : List; |
| Item : Element_Type; |
| Position : Cursor := No_Element) return Cursor; |
| |
| function Contains |
| (Container : List; |
| Item : Element_Type) return Boolean; |
| |
| procedure Iterate |
| (Container : List; |
| Process : not null access procedure (Position : Cursor)); |
| |
| procedure Reverse_Iterate |
| (Container : List; |
| Process : not null access procedure (Position : Cursor)); |
| |
| function Iterate |
| (Container : List) |
| return List_Iterator_Interfaces.Reversible_Iterator'class; |
| |
| function Iterate |
| (Container : List; |
| Start : Cursor) |
| return List_Iterator_Interfaces.Reversible_Iterator'class; |
| |
| generic |
| with function "<" (Left, Right : Element_Type) return Boolean is <>; |
| package Generic_Sorting is |
| |
| function Is_Sorted (Container : List) return Boolean; |
| |
| procedure Sort (Container : in out List); |
| |
| procedure Merge (Target, Source : in out List); |
| |
| end Generic_Sorting; |
| |
| private |
| |
| pragma Inline (Next); |
| pragma Inline (Previous); |
| |
| use Ada.Containers.Helpers; |
| package Implementation is new Generic_Implementation; |
| use Implementation; |
| |
| type Node_Type; |
| type Node_Access is access Node_Type; |
| |
| type Element_Access is access all Element_Type; |
| |
| type Node_Type is |
| limited record |
| Element : Element_Access; |
| Next : Node_Access; |
| Prev : Node_Access; |
| end record; |
| |
| use Ada.Finalization; |
| use Ada.Streams; |
| |
| type List is |
| new Controlled with record |
| First : Node_Access := null; |
| Last : Node_Access := null; |
| Length : Count_Type := 0; |
| TC : aliased Tamper_Counts; |
| end record with Put_Image => Put_Image; |
| |
| procedure Put_Image |
| (S : in out Ada.Strings.Text_Buffers.Root_Buffer_Type'Class; V : List); |
| |
| overriding procedure Adjust (Container : in out List); |
| |
| overriding procedure Finalize (Container : in out List) renames Clear; |
| |
| procedure Read |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : out List); |
| |
| for List'Read use Read; |
| |
| procedure Write |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : List); |
| |
| for List'Write use Write; |
| |
| type List_Access is access all List; |
| for List_Access'Storage_Size use 0; |
| |
| type Cursor is |
| record |
| Container : List_Access; |
| Node : Node_Access; |
| end record; |
| |
| procedure Read |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : out Cursor); |
| |
| for Cursor'Read use Read; |
| |
| procedure Write |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : Cursor); |
| |
| for Cursor'Write use Write; |
| |
| subtype Reference_Control_Type is Implementation.Reference_Control_Type; |
| -- It is necessary to rename this here, so that the compiler can find it |
| |
| type Constant_Reference_Type |
| (Element : not null access constant Element_Type) is |
| record |
| Control : Reference_Control_Type := |
| raise Program_Error with "uninitialized reference"; |
| -- The RM says, "The default initialization of an object of |
| -- type Constant_Reference_Type or Reference_Type propagates |
| -- Program_Error." |
| end record; |
| |
| procedure Write |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : Constant_Reference_Type); |
| |
| for Constant_Reference_Type'Write use Write; |
| |
| procedure Read |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : out Constant_Reference_Type); |
| |
| for Constant_Reference_Type'Read use Read; |
| |
| type Reference_Type |
| (Element : not null access Element_Type) is |
| record |
| Control : Reference_Control_Type := |
| raise Program_Error with "uninitialized reference"; |
| -- The RM says, "The default initialization of an object of |
| -- type Constant_Reference_Type or Reference_Type propagates |
| -- Program_Error." |
| end record; |
| |
| procedure Write |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : Reference_Type); |
| |
| for Reference_Type'Write use Write; |
| |
| procedure Read |
| (Stream : not null access Root_Stream_Type'Class; |
| Item : out Reference_Type); |
| |
| for Reference_Type'Read use Read; |
| |
| -- Three operations are used to optimize in the expansion of "for ... of" |
| -- loops: the Next(Cursor) procedure in the visible part, and the following |
| -- Pseudo_Reference and Get_Element_Access functions. See Exp_Ch5 for |
| -- details. |
| |
| function Pseudo_Reference |
| (Container : aliased List'Class) return Reference_Control_Type; |
| pragma Inline (Pseudo_Reference); |
| -- Creates an object of type Reference_Control_Type pointing to the |
| -- container, and increments the Lock. Finalization of this object will |
| -- decrement the Lock. |
| |
| function Get_Element_Access |
| (Position : Cursor) return not null Element_Access; |
| -- Returns a pointer to the element designated by Position. |
| |
| Empty_List : constant List := List'(Controlled with others => <>); |
| function Empty return List is (Empty_List); |
| |
| No_Element : constant Cursor := Cursor'(null, null); |
| |
| type Iterator is new Limited_Controlled and |
| List_Iterator_Interfaces.Reversible_Iterator with |
| record |
| Container : List_Access; |
| Node : Node_Access; |
| end record |
| with Disable_Controlled => not T_Check; |
| |
| overriding procedure Finalize (Object : in out Iterator); |
| |
| overriding function First (Object : Iterator) return Cursor; |
| overriding function Last (Object : Iterator) return Cursor; |
| |
| overriding function Next |
| (Object : Iterator; |
| Position : Cursor) return Cursor; |
| |
| overriding function Previous |
| (Object : Iterator; |
| Position : Cursor) return Cursor; |
| |
| end Ada.Containers.Indefinite_Doubly_Linked_Lists; |
