1------------------------------------------------------------------------------
2--                                                                          --
3--                          GNAT RUN-TIME COMPONENTS                        --
4--                                                                          --
5--        A D A . S T R I N G S . W I D E _ U N B O U N D E D . A U X       --
6--                                                                          --
7--                                 S p e c                                  --
8--                                                                          --
9--          Copyright (C) 1992-2020, 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-- As a special exception under Section 7 of GPL version 3, you are granted --
19-- additional permissions described in the GCC Runtime Library Exception,   --
20-- version 3.1, as published by the Free Software Foundation.               --
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--  This child package of Ada.Strings.Wide_Unbounded provides some specialized
33--  access functions which are intended to allow more efficient use of the
34--  facilities of Ada.Strings.Wide_Unbounded, particularly by other layered
35--  utilities.
36
37package Ada.Strings.Wide_Unbounded.Aux is
38   pragma Preelaborate;
39
40   subtype Big_Wide_String is Wide_String (Positive'Range);
41   type Big_Wide_String_Access is access all Big_Wide_String;
42
43   procedure Get_Wide_String
44     (U : Unbounded_Wide_String;
45      S : out Big_Wide_String_Access;
46      L : out Natural);
47   pragma Inline (Get_Wide_String);
48   --  This procedure returns the internal string pointer used in the
49   --  representation of an unbounded string as well as the actual current
50   --  length (which may be less than S.all'Length because in general there
51   --  can be extra space assigned). The characters of this string may be
52   --  not be modified via the returned pointer,  and are valid only as
53   --  long as the original unbounded string is not accessed or modified.
54   --
55   --  This procedure is much more efficient than the use of To_Wide_String
56   --  since it avoids the need to copy the string. The lower bound of the
57   --  referenced string returned by this call is always one, so the actual
58   --  string data is always accessible as S (1 .. L).
59
60   procedure Set_Wide_String (UP : out Unbounded_Wide_String; S : Wide_String)
61     renames Set_Unbounded_Wide_String;
62   --  This function sets the string contents of the referenced unbounded
63   --  string to the given string value. It is significantly more efficient
64   --  than the use of To_Unbounded_Wide_String with an assignment, since it
65   --  avoids the necessity of messing with finalization chains. The lower
66   --  bound of the string S is not required to be one.
67
68   procedure Set_Wide_String
69     (UP : in out Unbounded_Wide_String;
70      S  : Wide_String_Access);
71   pragma Inline (Set_Wide_String);
72   --  This version of Set_Wide_String takes a string access value, rather
73   --  than string. The lower bound of the string value is required to be one,
74   --  and this requirement is not checked.
75
76end Ada.Strings.Wide_Unbounded.Aux;
77