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 --                                                                          --
  10 --          Copyright (C) 1993-2000 Free Software Foundation, Inc.          --
  11 --                                                                          --
  12 -- This specification is derived from the Ada Reference Manual for use with --
  13 -- GNAT. The copyright notice above, and the license provisions that follow --
  14 -- apply solely to the  contents of the part following the private keyword. --
  15 --                                                                          --
  16 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  17 -- terms of the  GNU General Public License as published  by the Free Soft- --
  18 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  19 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  20 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  21 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  22 -- for  more details.  You should have  received  a copy of the GNU General --
  23 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  24 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  25 -- MA 02111-1307, USA.                                                      --
  26 --                                                                          --
  27 -- As a special exception,  if other files  instantiate  generics from this --
  28 -- unit, or you link  this unit with other files  to produce an executable, --
  29 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  30 -- covered  by the  GNU  General  Public  License.  This exception does not --
  31 -- however invalidate  any other reasons why  the executable file  might be --
  32 -- covered by the  GNU Public License.                                      --
  33 --                                                                          --
  34 -- GNAT was originally developed  by the GNAT team at  New York University. --
  35 -- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
  36 --                                                                          --
  37 ------------------------------------------------------------------------------
  38
  39 with System.Storage_Elements;
  40
  41 package Interfaces.C.Strings is
  42 pragma Preelaborate (Strings);
  43
  44    type char_array_access is access all char_array;
  45
  46    type chars_ptr is private;
  47
  48    type chars_ptr_array is array (size_t range <>) of chars_ptr;
  49
  50    Null_Ptr : constant chars_ptr;
  51
  52    function To_Chars_Ptr
  53      (Item      : in char_array_access;
  54       Nul_Check : in Boolean := False)
  55       return      chars_ptr;
  56
  57    function New_Char_Array (Chars : in char_array) return chars_ptr;
  58
  59    function New_String (Str : in String) return chars_ptr;
  60
  61    procedure Free (Item : in out chars_ptr);
  62
  63    Dereference_Error : exception;
  64
  65    function Value (Item : in chars_ptr) return char_array;
  66
  67    function Value
  68      (Item   : in chars_ptr;
  69       Length : in size_t)
  70       return   char_array;
  71
  72    function Value (Item : in chars_ptr) return String;
  73
  74    function Value
  75      (Item   : in chars_ptr;
  76       Length : in size_t)
  77       return   String;
  78
  79    function Strlen (Item : in chars_ptr) return size_t;
  80
  81    procedure Update
  82      (Item   : in chars_ptr;
  83       Offset : in size_t;
  84       Chars  : in char_array;
  85       Check  : Boolean := True);
  86
  87    procedure Update
  88      (Item   : in chars_ptr;
  89       Offset : in size_t;
  90       Str    : in String;
  91       Check  : in Boolean := True);
  92
  93    Update_Error : exception;
  94
  95 private
  96    type chars_ptr is new System.Storage_Elements.Integer_Address;
  97
  98    Null_Ptr : constant chars_ptr := 0;
  99    --  A little cleaner might be To_Integer (System.Null_Address) but this is
 100    --  non-preelaborable, and in fact we jolly well know this value is zero.
 101    --  Indeed, given the C interface nature, it is probably more correct to
 102    --  write zero here (even if Null_Address were non-zero).
 103
 104 end Interfaces.C.Strings;