gcc/ada/i-cstrin.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                 I N T E R F A C E S . C . S T R I N G S                  --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1993-2007, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  21 -- for  more details.  You should have  received  a copy of the GNU General --
  22 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  23 -- to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, --
  24 -- Boston, MA 02110-1301, USA.                                              --
  25 --                                                                          --
  26 -- As a special exception,  if other files  instantiate  generics from this --
  27 -- unit, or you link  this unit with other files  to produce an executable, --
  28 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  29 -- covered  by the  GNU  General  Public  License.  This exception does not --
  30 -- however invalidate  any other reasons why  the executable file  might be --
  31 -- covered by the  GNU Public License.                                      --
  32 --                                                                          --
  33 -- GNAT was originally developed  by the GNAT team at  New York University. --
  34 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  35 --                                                                          --
  36 ------------------------------------------------------------------------------
  37
  38 package Interfaces.C.Strings is
  39    pragma Preelaborate;
  40
  41    type char_array_access is access all char_array;
  42
  43    pragma Warnings (Off);
  44    pragma No_Strict_Aliasing (char_array_access);
  45    pragma Warnings (On);
  46    --  Since this type is used for external interfacing, with the pointer
  47    --  coming from who knows where, it seems a good idea to turn off any
  48    --  strict aliasing assumptions for this type. We turn off warnings for
  49    --  this pragma to deal with being compiled with an earlier GNAT version
  50    --  that does not recognize this pragma.
  51
  52    type chars_ptr is private;
  53
  54    type chars_ptr_array is array (size_t range <>) of chars_ptr;
  55
  56    Null_Ptr : constant chars_ptr;
  57
  58    function To_Chars_Ptr
  59      (Item      : char_array_access;
  60       Nul_Check : Boolean := False) return chars_ptr;
  61
  62    function New_Char_Array (Chars : char_array) return chars_ptr;
  63
  64    function New_String (Str : String) return chars_ptr;
  65
  66    procedure Free (Item : in out chars_ptr);
  67
  68    Dereference_Error : exception;
  69
  70    function Value (Item : chars_ptr) return char_array;
  71
  72    function Value
  73      (Item   : chars_ptr;
  74       Length : size_t) return char_array;
  75
  76    function Value (Item : chars_ptr) return String;
  77
  78    function Value
  79      (Item   : chars_ptr;
  80       Length : size_t) return String;
  81
  82    function Strlen (Item : chars_ptr) return size_t;
  83
  84    procedure Update
  85      (Item   : chars_ptr;
  86       Offset : size_t;
  87       Chars  : char_array;
  88       Check  : Boolean := True);
  89
  90    procedure Update
  91      (Item   : chars_ptr;
  92       Offset : size_t;
  93       Str    : String;
  94       Check  : Boolean := True);
  95
  96    Update_Error : exception;
  97
  98 private
  99    type chars_ptr is access all Character;
 100    pragma Convention (C, chars_ptr);
 101
 102    pragma No_Strict_Aliasing (chars_ptr);
 103    --  Since this type is used for external interfacing, with the pointer
 104    --  coming from who knows where, it seems a good idea to turn off any
 105    --  strict aliasing assumptions for this type.
 106
 107    Null_Ptr : constant chars_ptr := null;
 108 end Interfaces.C.Strings;