Merge from mainline
[official-gcc.git] / gcc / ada / g-string.ads
blobd11298c5f8bd0c51b2d8c229c45fb496dc5e7eea
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- G N A T . S T R I N G S --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 1995-2005, 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 2, 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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
28 -- --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
31 -- --
32 ------------------------------------------------------------------------------
34 -- Common String access types and related subprograms
36 with Unchecked_Deallocation;
38 package GNAT.Strings is
39 pragma Preelaborate;
41 type String_Access is access all String;
42 -- General purpose string access type. Note that the caller is
43 -- responsible for freeing allocated strings to avoid memory leaks.
45 procedure Free is new Unchecked_Deallocation
46 (Object => String, Name => String_Access);
47 -- This procedure is provided for freeing allocated values of type
48 -- String_Access.
50 type String_List is array (Positive range <>) of String_Access;
51 type String_List_Access is access all String_List;
52 -- General purpose array and pointer for list of string accesses
54 procedure Free (Arg : in out String_List_Access);
55 -- Frees the given array and all strings that its elements reference,
56 -- and then sets the argument to null. Provided for freeing allocated
57 -- values of this type.
59 end GNAT.Strings;