Generic package: Interfaces.C.Pointers

Description

GNAT COMPILER COMPONENTS

I N T E R F A C E S . C . P O I N T E R S

S p e c

$Revision: 1.6 $

Copyright (C) 1993-2000 Free Software Foundation, Inc.

This specification is derived from the Ada Reference Manual for use with GNAT. The copyright notice above, and the license provisions that follow apply solely to the contents of the part following the private keyword.

GNAT is free software; you can redistribute it and/or modify it under terms of the GNU General Public License as published by the Free Soft- ware Foundation; either version 2, or (at your option) any later ver- sion. GNAT is distributed in the hope that it will be useful, but WITH- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License distributed with GNAT; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License.

GNAT was originally developed by the GNAT team at New York University. It is now maintained by Ada Core Technologies Inc (http://www.gnat.com).


Header

generic
   type Index is (<>);
   type Element is private;
   type Element_Array is array (Index range <>) of aliased Element;
   Default_Terminator : Element;

package Interfaces.C.Pointers is
 
pragma Preelaborate (Pointers);

Exceptions

Pointer_Error
C-style Pointer Arithmetic

Type Summary

Pointer

Other Items:

type Pointer is access all Element;

function Value
  (Ref        : in Pointer;
   Terminator : in Element := Default_Terminator)
   return       Element_Array;

function Value
  (Ref    : in Pointer;
   Length : in ptrdiff_t)
   return   Element_Array;

function "+" (Left : in Pointer;   Right : in ptrdiff_t) return Pointer;

function "+" (Left : in ptrdiff_t; Right : in Pointer)   return Pointer;

function "-" (Left : in Pointer;   Right : in ptrdiff_t) return Pointer;

function "-" (Left : in Pointer;   Right : in Pointer)   return ptrdiff_t;

procedure Increment (Ref : in out Pointer);
pragma Convention (Intrinsic, Increment);

procedure Decrement (Ref : in out Pointer);
pragma Convention (Intrinsic, Decrement);

pragma Convention (Intrinsic, "+");

pragma Convention (Intrinsic, "-");

function Virtual_Length
  (Ref        : in Pointer;
   Terminator : in Element := Default_Terminator)
   return       ptrdiff_t;

procedure Copy_Terminated_Array
  (Source     : in Pointer;
   Target     : in Pointer;
   Limit      : in ptrdiff_t := ptrdiff_t'Last;
   Terminator : in Element := Default_Terminator);

procedure Copy_Array
  (Source  : in Pointer;
   Target  : in Pointer;
   Length  : in ptrdiff_t);

private

   --  Implementation-defined ...
end Interfaces.C.Pointers;