1------------------------------------------------------------------------------
2--                                                                          --
3--                         GNAT LIBRARY COMPONENTS                          --
4--                                                                          --
5--    A D A . C O N T A I N E R S . I N D E F I N I T E _ H O L D E R S     --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--             Copyright (C) 2011, 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
32private with Ada.Finalization;
33private with Ada.Streams;
34
35generic
36   type Element_Type (<>) is private;
37   with function "=" (Left, Right : Element_Type) return Boolean is <>;
38
39package Ada.Containers.Indefinite_Holders is
40   pragma Preelaborate (Indefinite_Holders);
41   pragma Remote_Types (Indefinite_Holders);
42
43   type Holder is tagged private;
44   pragma Preelaborable_Initialization (Holder);
45
46   Empty_Holder : constant Holder;
47
48   function "=" (Left, Right : Holder) return Boolean;
49
50   function To_Holder (New_Item : Element_Type) return Holder;
51
52   function Is_Empty (Container : Holder) return Boolean;
53
54   procedure Clear (Container : in out Holder);
55
56   function Element (Container : Holder) return Element_Type;
57
58   procedure Replace_Element
59     (Container : in out Holder;
60      New_Item  : Element_Type);
61
62   procedure Query_Element
63     (Container : Holder;
64      Process   : not null access procedure (Element : Element_Type));
65   procedure Update_Element
66     (Container : Holder;
67      Process   : not null access procedure (Element : in out Element_Type));
68
69   procedure Assign (Target : in out Holder; Source : Holder);
70
71   function Copy (Source : Holder) return Holder;
72
73   procedure Move (Target : in out Holder; Source : in out Holder);
74
75private
76
77   package AF renames Ada.Finalization;
78
79   type Element_Access is access all Element_Type;
80
81   procedure Read
82     (Stream    : not null access Ada.Streams.Root_Stream_Type'Class;
83      Container : out Holder);
84
85   procedure Write
86     (Stream    : not null access Ada.Streams.Root_Stream_Type'Class;
87      Container : Holder);
88
89   type Holder is new Ada.Finalization.Controlled with record
90      Element : Element_Access;
91      Busy    : Natural := 0;
92   end record;
93   for Holder'Read use Read;
94   for Holder'Write use Write;
95
96   overriding procedure Adjust (Container : in out Holder);
97   overriding procedure Finalize (Container : in out Holder);
98
99   Empty_Holder : constant Holder := (AF.Controlled with null, 0);
100
101end Ada.Containers.Indefinite_Holders;
102