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 --          Copyright (C) 1993-2005, 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 generic
  39    type Index is (<>);
  40    type Element is private;
  41    type Element_Array is array (Index range <>) of aliased Element;
  42    Default_Terminator : Element;
  43
  44 package Interfaces.C.Pointers is
  45    pragma Preelaborate;
  46
  47    type Pointer is access all Element;
  48
  49    pragma No_Strict_Aliasing (Pointer);
  50    --  We turn off any strict aliasing assumptions for the pointer type,
  51    --  since it is possible to create "improperly" aliased values.
  52
  53    function Value
  54      (Ref        : Pointer;
  55       Terminator : Element := Default_Terminator) return Element_Array;
  56
  57    function Value
  58      (Ref    : Pointer;
  59       Length : ptrdiff_t) return Element_Array;
  60
  61    Pointer_Error : exception;
  62
  63    --------------------------------
  64    -- C-style Pointer Arithmetic --
  65    --------------------------------
  66
  67    function "+" (Left : Pointer;   Right : ptrdiff_t) return Pointer;
  68    function "+" (Left : ptrdiff_t; Right : Pointer)   return Pointer;
  69    function "-" (Left : Pointer;   Right : ptrdiff_t) return Pointer;
  70    function "-" (Left : Pointer;   Right : 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        : Pointer;
  82       Terminator : Element := Default_Terminator) return ptrdiff_t;
  83
  84    procedure Copy_Terminated_Array
  85      (Source     : Pointer;
  86       Target     : Pointer;
  87       Limit      : ptrdiff_t := ptrdiff_t'Last;
  88       Terminator : Element := Default_Terminator);
  89
  90    procedure Copy_Array
  91      (Source  : Pointer;
  92       Target  : Pointer;
  93       Length  : ptrdiff_t);
  94
  95 private
  96    pragma Inline ("+");
  97    pragma Inline ("-");
  98    pragma Inline (Decrement);
  99    pragma Inline (Increment);
 100
 101 end Interfaces.C.Pointers;