pointer

Vocabulary

alien.c-types

Class description

Represents a pointer C type. The to slot contains the C type being pointed to. Both byte-array and alien values can be provided as pointer function inputs, but see Byte arrays and the garbage collector for notes about passing byte arrays into C functions. Objects with methods on >c-ptr, such as structs and specialized arrays, may also be used as pointer inputs.

Pointer output values are represented in Factor as aliens. If the pointed-to type is a struct, the alien will automatically be wrapped in a struct object if it is not null.

In TYPEDEF:, FUNCTION:, CALLBACK:, and STRUCT: definitions, pointer types can be created by suffixing * to a C type name. Outside of FFI definitions, a pointer C type can be created using the pointer: syntax word:

FUNCTION: int* foo ( char* bar )

: foo ( bar -- int* )
pointer: int f "foo" { pointer: char } f alien-invoke ;

Definition

IN: alien.c-types

TUPLE: pointer { to read-only initial: void } ;

Methods

USING: alien.c-types alien.data kernel ;

M: pointer (c-array) drop void* (c-array) ;


USING: alien.c-types alien.data kernel ;

M: pointer <c-array> drop void* <c-array> ;


USING: alien.c-types alien.data kernel ;

M: pointer <c-direct-array> drop void* <c-direct-array> ;


USING: alien.c-types alien.data kernel ;

M: pointer >c-array drop void* >c-array ;


USING: accessors alien.c-types stack-checker.dependencies ;

M: pointer add-depends-on-c-type to>> add-depends-on-c-type ;


USING: alien.c-types alien.data kernel ;

M: pointer c-(array)-constructor
    drop void* c-(array)-constructor ;


USING: alien.c-types alien.data kernel ;

M: pointer c-array-constructor drop void* c-array-constructor ;


USING: alien.c-types alien.data kernel ;

M: pointer c-array-type drop void* c-array-type ;


USING: alien.c-types alien.data kernel ;

M: pointer c-array-type? drop void* c-array-type? ;


USING: alien.c-types alien.data kernel ;

M: pointer c-array? drop void* c-array? ;


USING: alien.c-types alien.data kernel ;

M: pointer c-direct-array-constructor
    drop void* c-direct-array-constructor ;


USING: alien.c-types ;

M: pointer c-type-string pointer-string ;


USING: accessors alien.c-types alien.c-types.private kernel ;

M: pointer lookup-c-type
    [ \ void* lookup-c-type ] dip
    to>> dup primitive-pointer-type?
    [ drop ] [ (pointer-c-type) ] if ;


USING: accessors alien.c-types kernel sequences ;

M: pointer pointer-string
    to>> pointer-string [ 42 suffix ] [ f ] if* ;


USING: accessors alien.c-types alien.syntax prettyprint.backend
prettyprint.custom prettyprint.sections ;

M: pointer pprint*
    <flow \ pointer: pprint-word to>> pprint* block> ;


USING: accessors alien.c-types present sequences ;

M: pointer present to>> name>> "*" append ;


USING: alien.c-types alien.prettyprint.private ;

M: pointer record-c-type record-pointer ;


USING: accessors alien.c-types alien.prettyprint.private ;

M: pointer record-pointer to>> record-pointer ;


USING: alien.c-types kernel specialized-arrays ;

M: pointer underlying-type drop void* ;