* 5oosinte.adb: Add 2001 to copyright notice.
[platform/upstream/gcc.git] / gcc / ada / s-pooloc.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT COMPILER COMPONENTS                         --
4 --                                                                          --
5 --                    S Y S T E M . P O O L _ L O C A L                     --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --                            $Revision: 1.6 $                              --
10 --                                                                          --
11 --          Copyright (C) 1992-1998, Free Software Foundation, Inc.         --
12 --                                                                          --
13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
14 -- terms of the  GNU General Public License as published  by the Free Soft- --
15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
19 -- for  more details.  You should have  received  a copy of the GNU General --
20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
22 -- MA 02111-1307, USA.                                                      --
23 --                                                                          --
24 -- As a special exception,  if other files  instantiate  generics from this --
25 -- unit, or you link  this unit with other files  to produce an executable, --
26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
27 -- covered  by the  GNU  General  Public  License.  This exception does not --
28 -- however invalidate  any other reasons why  the executable file  might be --
29 -- covered by the  GNU Public License.                                      --
30 --                                                                          --
31 -- GNAT was originally developed  by the GNAT team at  New York University. --
32 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
33 --                                                                          --
34 ------------------------------------------------------------------------------
35
36 with System.Storage_Elements;
37 with System.Pool_Global;
38
39 package System.Pool_Local is
40
41 pragma Elaborate_Body;
42 --  Needed to ensure that library routines can execute allocators
43
44    ----------------------------
45    -- Unbounded_Reclaim_Pool --
46    ----------------------------
47
48    --  Allocation strategy:
49
50    --    Call to malloc/free for each Allocate/Deallocate
51    --    no user specifiable size
52    --    Space of allocated objects is reclaimed at pool finalization
53    --    Manages a list of allocated objects
54
55    --  Default pool in the compiler for access types locally declared
56
57    type Unbounded_Reclaim_Pool is new
58      System.Pool_Global.Unbounded_No_Reclaim_Pool with
59        record
60           First : System.Address := Null_Address;
61        end record;
62
63    --  function Storage_Size is inherited
64
65    procedure Allocate
66      (Pool         : in out Unbounded_Reclaim_Pool;
67       Address      : out System.Address;
68       Storage_Size : System.Storage_Elements.Storage_Count;
69       Alignment    : System.Storage_Elements.Storage_Count);
70
71    procedure Deallocate
72      (Pool         : in out Unbounded_Reclaim_Pool;
73       Address      : System.Address;
74       Storage_Size : System.Storage_Elements.Storage_Count;
75       Alignment    : System.Storage_Elements.Storage_Count);
76
77    procedure Finalize (Pool : in out Unbounded_Reclaim_Pool);
78
79 end System.Pool_Local;