gcc/ada/a-stunau.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                          GNAT RUN-TIME COMPONENTS                        --
   4 --                                                                          --
   5 --            A D A . S T R I N G S . U N B O U N D E D . A U X             --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-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 ------------------------------------------------------------------------------
  33
  34 --  This child package of Ada.Strings.Unbounded provides some specialized
  35 --  access functions which are intended to allow more efficient use of the
  36 --  facilities of Ada.Strings.Unbounded, particularly by other layered
  37 --  utilities (such as GNAT.SPITBOL.Patterns).
  38
  39 package Ada.Strings.Unbounded.Aux is
  40    pragma Preelaborate;
  41
  42    procedure Get_String
  43      (U : Unbounded_String;
  44       S : out String_Access;
  45       L : out Natural);
  46    pragma Inline (Get_String);
  47    --  This procedure returns the internal string pointer used in the
  48    --  representation of an unbounded string as well as the actual current
  49    --  length (which may be less than S.all'Length because in general there
  50    --  can be extra space assigned). The characters of this string may be
  51    --  not be modified via the returned pointer,  and are valid only as
  52    --  long as the original unbounded string is not accessed or modified.
  53    --
  54    --  This procedure is much more efficient than the use of To_String
  55    --  since it avoids the need to copy the string. The lower bound of the
  56    --  referenced string returned by this call is always one, so the actual
  57    --  string data is always accessible as S (1 .. L).
  58
  59    procedure Set_String (UP : in out Unbounded_String; S : String);
  60    pragma Inline (Set_String);
  61    --  This function sets the string contents of the referenced unbounded
  62    --  string to the given string value. It is significantly more efficient
  63    --  than the use of To_Unbounded_String with an assignment, since it
  64    --  avoids the necessity of messing with finalization chains. The lower
  65    --  bound of the string S is not required to be one.
  66
  67    procedure Set_String (UP : in out Unbounded_String; S : String_Access);
  68    pragma Inline (Set_String);
  69    --  This version of Set_String takes a string access value, rather than a
  70    --  string. The lower bound of the string value is required to be one, and
  71    --  this requirement is not checked.
  72
  73 end Ada.Strings.Unbounded.Aux;