gcc/ada/i-cpoint.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                I N T E R F A C E S . C . P O I N T E R S                 --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                            $Revision: 1.1 $
  10 --                                                                          --
  11 --          Copyright (C) 1993-2000 Free Software Foundation, Inc.          --
  12 --                                                                          --
  13 -- This specification is derived from the Ada Reference Manual for use with --
  14 -- GNAT. The copyright notice above, and the license provisions that follow --
  15 -- apply solely to the  contents of the part following the private keyword. --
  16 --                                                                          --
  17 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  18 -- terms of the  GNU General Public License as published  by the Free Soft- --
  19 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
  20 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  21 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  22 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
  23 -- for  more details.  You should have  received  a copy of the GNU General --
  24 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
  25 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
  26 -- MA 02111-1307, USA.                                                      --
  27 --                                                                          --
  28 -- As a special exception,  if other files  instantiate  generics from this --
  29 -- unit, or you link  this unit with other files  to produce an executable, --
  30 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
  31 -- covered  by the  GNU  General  Public  License.  This exception does not --
  32 -- however invalidate  any other reasons why  the executable file  might be --
  33 -- covered by the  GNU Public License.                                      --
  34 --                                                                          --
  35 -- GNAT was originally developed  by the GNAT team at  New York University. --
  36 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  37 --                                                                          --
  38 ------------------------------------------------------------------------------
  39
  40 generic
  41    type Index is (<>);
  42    type Element is private;
  43    type Element_Array is array (Index range <>) of aliased Element;
  44    Default_Terminator : Element;
  45
  46 package Interfaces.C.Pointers is
  47 pragma Preelaborate (Pointers);
  48
  49    type Pointer is access all Element;
  50
  51    function Value
  52      (Ref        : in Pointer;
  53       Terminator : in Element := Default_Terminator)
  54       return       Element_Array;
  55
  56    function Value
  57      (Ref    : in Pointer;
  58       Length : in ptrdiff_t)
  59       return   Element_Array;
  60
  61    Pointer_Error : exception;
  62
  63    --------------------------------
  64    -- C-style Pointer Arithmetic --
  65    --------------------------------
  66
  67    function "+" (Left : in Pointer;   Right : in ptrdiff_t) return Pointer;
  68    function "+" (Left : in ptrdiff_t; Right : in Pointer)   return Pointer;
  69    function "-" (Left : in Pointer;   Right : in ptrdiff_t) return Pointer;
  70    function "-" (Left : in Pointer;   Right : in Pointer)   return ptrdiff_t;
  71
  72    procedure Increment (Ref : in out Pointer);
  73    procedure Decrement (Ref : in out Pointer);
  74
  75    pragma Convention (Intrinsic, "+");
  76    pragma Convention (Intrinsic, "-");
  77    pragma Convention (Intrinsic, Increment);
  78    pragma Convention (Intrinsic, Decrement);
  79
  80    function Virtual_Length
  81      (Ref        : in Pointer;
  82       Terminator : in Element := Default_Terminator)
  83       return       ptrdiff_t;
  84
  85    procedure Copy_Terminated_Array
  86      (Source     : in Pointer;
  87       Target     : in Pointer;
  88       Limit      : in ptrdiff_t := ptrdiff_t'Last;
  89       Terminator : in Element := Default_Terminator);
  90
  91    procedure Copy_Array
  92      (Source  : in Pointer;
  93       Target  : in Pointer;
  94       Length  : in ptrdiff_t);
  95
  96 private
  97    pragma Inline ("+");
  98    pragma Inline ("-");
  99    pragma Inline (Decrement);
 100    pragma Inline (Increment);
 101
 102 end Interfaces.C.Pointers;