alien vocabulary
Factor handbook » Vocabulary index

Documentation
C library interface

Metadata

Tags:	compiler, ffi
Authors:	Slava Pestov

Words

Builtin classes

alien

dll

Tuple classes

Class	Superclass	Slots
callsite-not-compiled	tuple	word

Singleton classes

cdecl

fastcall

mingw

stdcall

thiscall

Predicate classes

Class	Superclass
pinned-alien	alien

Union classes

abi

c-ptr

pinned-c-ptr

Generic words

Word	Stack effect
>c-ptr	( obj -- c-ptr )
byte-length	( obj -- n )
element-size	( seq -- n )
expired?	( c-ptr -- ? )

Primitives

Word	Stack effect
<callback>	( word return-rewind -- alien )
<displaced-alien>	( displacement c-ptr -- alien )
alien-address	( c-ptr -- addr )
free-callback	( alien -- )

Ordinary words

Word	Stack effect
<alien>	( address -- alien )
<bad-alien>	( -- alien )
alien-assembly	( args... return parameters abi quot -- return... )
alien-callback	( return parameters abi quot -- alien )
alien-indirect	( args... funcptr return parameters abi -- return... )
alien-invoke	( args... return library function parameters varargs? -- return... )
binary-object	( obj -- c-ptr n )
callee-cleanup?	( abi -- ? )
callsite-not-compiled	( word -- * )
initialize-alien	( symbol quot -- )
unregister-and-free-callback	( alien -- )
with-callback	( alien quot -- )

Class predicate words

Word	Stack effect
abi?	( object -- ? )
alien?	( object -- ? )
c-ptr?	( object -- ? )
callsite-not-compiled?	( object -- ? )
cdecl?	( object -- ? )
dll?	( object -- ? )
fastcall?	( object -- ? )
mingw?	( object -- ? )
pinned-alien?	( object -- ? )
pinned-c-ptr?	( object -- ? )
stdcall?	( object -- ? )
thiscall?	( object -- ? )

Files

resource:core/alien/alien.factor
resource:core/alien/alien-docs.factor
resource:core/alien/alien-tests.factor

Metadata files

resource:core/alien/authors.txt
resource:core/alien/summary.txt
resource:core/alien/tags.txt

Children from resource:core

Vocabulary	Summary
alien.accessors	Support reading and writing alien memory.
alien.strings	Passing Factor strings as C strings and vice versa

Children from resource:basis

Vocabulary	Summary
alien.arrays	C array support
alien.c-types	C data type support
alien.complex	Implementation details for C99 complex float and complex double types
alien.data	Words for allocating objects and arrays of C types
alien.destructors	Functor for defining destructors which call a C function to dispose of resources
alien.endian
alien.enums
alien.libraries
alien.parser	Utilities used in implementation of alien parsing words
alien.prettyprint	Prettyprinting aliens and DLLs
alien.remote-control	Support for embedding Factor in other applications
alien.syntax	C library interface parsing words
alien.utilities

Children from resource:extra

Vocabulary	Summary
alien.cxx
alien.data	Words for allocating objects and arrays of C types
alien.fortran	GNU Fortran/G77/F2C alien interface
alien.handles	Generate integer handle values to allow Factor object references to be passed through the FFI