GCC v8.2
[gcc.git] / gcc / ada / libgnat / s-chepoo.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                 S Y S T E M . C H E C K E D _ P O O L S                  --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --          Copyright (C) 1992-2018, Free Software Foundation, Inc.         --
10 --                                                                          --
11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
12 -- terms of the  GNU General Public License as published  by the Free Soft- --
13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
17 --                                                                          --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception,   --
20 -- version 3.1, as published by the Free Software Foundation.               --
21 --                                                                          --
22 -- You should have received a copy of the GNU General Public License and    --
23 -- a copy of the GCC Runtime Library Exception along with this program;     --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
25 -- <http://www.gnu.org/licenses/>.                                          --
26 --                                                                          --
27 -- GNAT was originally developed  by the GNAT team at  New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
29 --                                                                          --
30 ------------------------------------------------------------------------------
31
32 with System.Storage_Elements;
33 with System.Storage_Pools;
34
35 package System.Checked_Pools is
36
37    type Checked_Pool is abstract
38      new System.Storage_Pools.Root_Storage_Pool with private;
39    --  Equivalent of storage pools with the addition that Dereference is
40    --  called on each implicit or explicit dereference of a pointer which
41    --  has such a storage pool.
42
43    procedure Dereference
44      (Pool                     : in out Checked_Pool;
45       Storage_Address          : Address;
46       Size_In_Storage_Elements : System.Storage_Elements.Storage_Count;
47       Alignment                : System.Storage_Elements.Storage_Count)
48    is abstract;
49    --  Called implicitly each time a pointer to a checked pool is dereferenced
50    --  All parameters in the profile are compatible with the profile of
51    --  Allocate/Deallocate: the Storage_Address corresponds to the address of
52    --  the dereferenced object, Size_in_Storage_Elements is its dynamic size
53    --  (and thus may involve an implicit dispatching call to size) and
54    --  Alignment is the alignment of the object.
55
56 private
57    type Checked_Pool is abstract
58      new System.Storage_Pools.Root_Storage_Pool with null record;
59 end System.Checked_Pools;