Subversion Repositories scarts

------------------------------------------------------------------------------

--                                                                          --

--                          GNAT RUN-TIME COMPONENTS                        --

--                                                                          --

--            A D A . S T R I N G S . U N B O U N D E D . A U X             --

--                                                                          --

--                                 S p e c                                  --

--                                                                          --

--          Copyright (C) 1992-2005, Free Software Foundation, Inc.         --

--                                                                          --

-- GNAT is free software;  you can  redistribute it  and/or modify it under --

-- terms of the  GNU General Public License as published  by the Free Soft- --

-- ware  Foundation;  either version 2,  or (at your option) any later ver- --

-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --

-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --

-- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --

-- for  more details.  You should have  received  a copy of the GNU General --

-- Public License  distributed with GNAT;  see file COPYING.  If not, write --

-- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --

-- Boston, MA 02110-1301, USA.                                              --

--                                                                          --

-- As a special exception,  if other files  instantiate  generics from this --

-- unit, or you link  this unit with other files  to produce an executable, --

-- this  unit  does not  by itself cause  the resulting  executable  to  be --

-- covered  by the  GNU  General  Public  License.  This exception does not --

-- however invalidate  any other reasons why  the executable file  might be --

-- covered by the  GNU Public License.                                      --

--                                                                          --

-- GNAT was originally developed  by the GNAT team at  New York University. --

-- Extensive contributions were provided by Ada Core Technologies Inc.      --

--                                                                          --

------------------------------------------------------------------------------

--  This child package of Ada.Strings.Unbounded provides some specialized

--  access functions which are intended to allow more efficient use of the

--  facilities of Ada.Strings.Unbounded, particularly by other layered

--  utilities (such as GNAT.SPITBOL.Patterns).

package Ada.Strings.Unbounded.Aux is

   pragma Preelaborate;

   procedure Get_String

     (U : Unbounded_String;

      S : out String_Access;

      L : out Natural);

   pragma Inline (Get_String);

   --  This procedure returns the internal string pointer used in the

   --  representation of an unbounded string as well as the actual current

   --  length (which may be less than S.all'Length because in general there

   --  can be extra space assigned). The characters of this string may be

   --  not be modified via the returned pointer,  and are valid only as

   --  long as the original unbounded string is not accessed or modified.

   --

   --  This procedure is much more efficient than the use of To_String

   --  since it avoids the need to copy the string. The lower bound of the

   --  referenced string returned by this call is always one, so the actual

   --  string data is always accessible as S (1 .. L).

   procedure Set_String (UP : in out Unbounded_String; S : String);

   pragma Inline (Set_String);

   --  This function sets the string contents of the referenced unbounded

   --  string to the given string value. It is significantly more efficient

   --  than the use of To_Unbounded_String with an assignment, since it

   --  avoids the necessity of messing with finalization chains. The lower

   --  bound of the string S is not required to be one.

   procedure Set_String (UP : in out Unbounded_String; S : String_Access);

   pragma Inline (Set_String);

   --  This version of Set_String takes a string access value, rather than a

   --  string. The lower bound of the string value is required to be one, and

   --  this requirement is not checked.

end Ada.Strings.Unbounded.Aux;