home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / adav313.zip / gnat-3_13p-os2-bin-20010916.zip / emx / gnatlib / a-stunau.ads < prev    next >
Text File  |  2000-07-19  |  5KB  |  73 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT RUNTIME 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. --                            $Revision: 1.3 $                              --
  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. --  This child package of Ada.Strings.Unbounded provides some specialized
  37. --  access functions which are intended to allow more efficient use of the
  38. --  facilities of Ada.Strings.Unbounded, particularly by other layered
  39. --  utilities (such as GNAT.Patterns).
  40.  
  41. package Ada.Strings.Unbounded.Aux is
  42. pragma Preelaborate (Aux);
  43.  
  44.    function Get_String (U  : Unbounded_String) return String_Access;
  45.    pragma Inline (Get_String);
  46.    --  This function returns the internal string pointer used in the
  47.    --  representation of an unbounded string. There is no copy involved,
  48.    --  so the value obtained references the same string as the original
  49.    --  unbounded string. The characters of this string may not be modified
  50.    --  via the returned pointer, and are valid only as long as the original
  51.    --  unbounded string is not modified. Violating either of these two
  52.    --  rules results in erroneous execution.
  53.    --
  54.    --  This function 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.
  57.  
  58.    procedure Set_String (UP : in out Unbounded_String; S : String);
  59.    pragma Inline (Set_String);
  60.    --  This function sets the string contents of the referenced unbounded
  61.    --  string to the given string value. It is significantly more efficient
  62.    --  than the use of To_Unbounded_String with an assignment, since it
  63.    --  avoids the necessity of messing with finalization chains. The lower
  64.    --  bound of the string S is not required to be one.
  65.  
  66.    procedure Set_String (UP : in out Unbounded_String; S : String_Access);
  67.    pragma Inline (Set_String);
  68.    --  This version of Set_String takes a string access value, rather than a
  69.    --  string. The lower bound of the string value is required to be one, and
  70.    --  this requirement is not checked.
  71.  
  72. end Ada.Strings.Unbounded.Aux;
  73.