File : s-string.ads


   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . S T R I N G S                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1995-2013, 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 --                                                                          --
  19 --                                                                          --
  20 --                                                                          --
  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 --  Common String access types and related subprograms
  33 
  34 --  Note: this package is in the System hierarchy so that it can be directly
  35 --  be used by other predefined packages. User access to this package is via
  36 --  a renaming of this package in GNAT.String (file g-string.ads).
  37 
  38 pragma Compiler_Unit_Warning;
  39 
  40 with Ada.Unchecked_Deallocation;
  41 
  42 package System.Strings is
  43    pragma Preelaborate;
  44 
  45    type String_Access is access all String;
  46    --  General purpose string access type. Note that the caller is
  47    --  responsible for freeing allocated strings to avoid memory leaks.
  48 
  49    procedure Free is new Ada.Unchecked_Deallocation
  50      (Object => String, Name => String_Access);
  51    --  This procedure is provided for freeing allocated values of type
  52    --  String_Access.
  53 
  54    type String_List is array (Positive range <>) of String_Access;
  55    type String_List_Access is access all String_List;
  56    --  General purpose array and pointer for list of string accesses
  57 
  58    procedure Free (Arg : in out String_List_Access);
  59    --  Frees the given array and all strings that its elements reference,
  60    --  and then sets the argument to null. Provided for freeing allocated
  61    --  values of this type.
  62 
  63 end System.Strings;