Macro

Summary

Defines a new FLI pointer type.

Package

fli

Signature

define-foreign-pointer name-and-options points-to-type &rest slots => type-name

name-and-options ::= type-name | ( type-name ( option *))

option ::= ( option-name option-value )

Arguments

type-name

A symbol naming the new FLI type.

option-name

:allow-null or a defstruct option.

option-value

A symbol.

points-to-type

A foreign type.

slots

Slots of the new type.

Values

type-name

The name of the new FLI pointer type.

Description

The macro define-foreign-pointer defines a new FLI pointer type called type-name .

type-name is a subtype of pointer .

The option :allow-null takes an option-value of either t or nil , defaulting to nil . It controls whether the type type-name accepts nil .

The other allowed options are the defstruct options :conc-name , :constructor , :predicate , :print-object , :print-function . In each case the symbol supplied as option-value provides the corresponding operator for type-name .