ForeignObject -- foreign object

Description

A ForeignObject represents some C object. It consists of a Pointer with its address in memory.

i1 : x = int 5

o1 = 5

o1 : ForeignObject of type int32

i2 : peek x

o2 = int32{Address => 0x7f13103ce9e0}

To get this, use address.

i3 : address x

o3 = 0x7f13103ce9e0

o3 : Pointer

Use class to determine the type of the object.

i4 : class x

o4 = int32

o4 : ForeignIntegerType

foreignObject -- construct a foreign object
foreignSymbol -- get a foreign symbol
value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
ForeignType ForeignObject -- cast a foreign object to the given foreign type
registerFinalizer(ForeignObject,Function) -- register a finalizer for a foreign object

int8 -- see ForeignIntegerType -- foreign integer type
int16 -- see ForeignIntegerType -- foreign integer type
int32 -- see ForeignIntegerType -- foreign integer type
int64 -- see ForeignIntegerType -- foreign integer type
uint8 -- see ForeignIntegerType -- foreign integer type
uint16 -- see ForeignIntegerType -- foreign integer type
uint32 -- see ForeignIntegerType -- foreign integer type
uint64 -- see ForeignIntegerType -- foreign integer type
charstarstar -- see ForeignPointerArrayType -- foreign type for NULL-terminated arrays of pointers
voidstarstar -- see ForeignPointerArrayType -- foreign type for NULL-terminated arrays of pointers
voidstar -- see ForeignPointerType -- foreign pointer type
double -- see ForeignRealType -- foreign real type
float -- see ForeignRealType -- foreign real type
charstar -- see ForeignStringType -- foreign string type
void -- see ForeignVoidType -- foreign void type
mpfrT -- MPFR multiple-precision floating-point type
mpzT -- GMP arbitrary-precision integer type

address(ForeignObject) -- see address -- pointer to type or object
foreignObject(ForeignObject) -- see foreignObject -- construct a foreign object
ForeignStructType ForeignObject -- see ForeignType ForeignObject -- cast a foreign object to the given foreign type
ForeignType ForeignObject -- cast a foreign object to the given foreign type
registerFinalizer(ForeignObject,Function) -- register a finalizer for a foreign object
describe(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
expression(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
net(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
texMath(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
toExternalString(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
toString(ForeignObject) -- see value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing
value(ForeignObject) -- get the value of a foreign object as a Macaulay2 thing

The source of this document is in ForeignFunctions.m2:1634:0.