This is the cffi Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 16:37:43 2024 GMT+0.
cffi/cffi.asd
cffi/src/package.lisp
cffi/src/sys-utils.lisp
cffi/src/cffi-openmcl.lisp
cffi/src/cffi-mcl.lisp
cffi/src/cffi-sbcl.lisp
cffi/src/cffi-cmucl.lisp
cffi/src/cffi-scl.lisp
cffi/src/cffi-clisp.lisp
cffi/src/cffi-lispworks.lisp
cffi/src/cffi-ecl.lisp
cffi/src/cffi-allegro.lisp
cffi/src/cffi-corman.lisp
cffi/src/cffi-abcl.lisp
cffi/src/cffi-mkcl.lisp
cffi/src/cffi-clasp.lisp
cffi/src/utils.lisp
cffi/src/libraries.lisp
cffi/src/early-types.lisp
cffi/src/types.lisp
cffi/src/enum.lisp
cffi/src/strings.lisp
cffi/src/structures.lisp
cffi/src/functions.lisp
cffi/src/foreign-vars.lisp
cffi/src/features.lisp
The main system appears first, followed by any subsystem dependency.
cffi
The Common Foreign Function Interface
Luis Oliveira <loliveira@common-lisp.net>
James Bielman <jamesjb@jamesjb.com>
MIT
uiop
(system).
alexandria
(system).
trivial-features
(system).
babel
(system).
src
(module).
Modules are listed depth-first from the system components tree.
cffi/src
cffi
(system).
package.lisp
(file).
sys-utils.lisp
(file).
cffi-openmcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-scl.lisp
(file).
cffi-clisp.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-ecl.lisp
(file).
cffi-allegro.lisp
(file).
cffi-corman.lisp
(file).
cffi-abcl.lisp
(file).
cffi-mkcl.lisp
(file).
cffi-clasp.lisp
(file).
utils.lisp
(file).
libraries.lisp
(file).
early-types.lisp
(file).
types.lisp
(file).
enum.lisp
(file).
strings.lisp
(file).
structures.lisp
(file).
functions.lisp
(file).
foreign-vars.lisp
(file).
features.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cffi/cffi.asd
cffi/src/package.lisp
cffi/src/sys-utils.lisp
cffi/src/cffi-openmcl.lisp
cffi/src/cffi-mcl.lisp
cffi/src/cffi-sbcl.lisp
cffi/src/cffi-cmucl.lisp
cffi/src/cffi-scl.lisp
cffi/src/cffi-clisp.lisp
cffi/src/cffi-lispworks.lisp
cffi/src/cffi-ecl.lisp
cffi/src/cffi-allegro.lisp
cffi/src/cffi-corman.lisp
cffi/src/cffi-abcl.lisp
cffi/src/cffi-mkcl.lisp
cffi/src/cffi-clasp.lisp
cffi/src/utils.lisp
cffi/src/libraries.lisp
cffi/src/early-types.lisp
cffi/src/types.lisp
cffi/src/enum.lisp
cffi/src/strings.lisp
cffi/src/structures.lisp
cffi/src/functions.lisp
cffi/src/foreign-vars.lisp
cffi/src/features.lisp
cffi/src/sys-utils.lisp
package.lisp
(file).
src
(module).
constant-form-p
(function).
constant-form-value
(function).
quoted-form-p
(function).
cffi/src/cffi-openmcl.lisp
:openmcl
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-mcl.lisp
:mcl
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-sbcl.lisp
:sbcl
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
%callback
(function).
%close-foreign-library
(function).
%defcallback
(macro).
%foreign-alloc
(function).
%foreign-funcall
(macro).
%foreign-funcall-pointer
(macro).
%foreign-funcall-pointer-varargs
(macro).
%foreign-funcall-varargs
(macro).
%foreign-symbol-pointer
(function).
%foreign-type-alignment
(function).
%foreign-type-size
(function).
%load-foreign-library
(function).
%mem-ref
(compiler macro).
%mem-ref
(function).
%mem-set
(compiler macro).
%mem-set
(function).
canonicalize-symbol-name-case
(function).
foreign-free
(function).
foreign-pointer
(type).
inc-pointer
(function).
make-pointer
(function).
make-shareable-byte-vector
(function).
native-namestring
(function).
null-pointer
(function).
null-pointer-p
(function).
pointer-address
(function).
pointer-eq
(function).
pointerp
(function).
with-foreign-pointer
(macro).
with-pointer-to-vector-data
(macro).
%%foreign-funcall
(macro).
*callbacks*
(special variable).
convert-foreign-type
(function).
define-mem-accessors
(macro).
define-type-mapping
(macro).
foreign-funcall-type-and-args
(function).
unload-shared-object-present-p
(function).
cffi/src/cffi-cmucl.lisp
:cmucl
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-scl.lisp
:scl
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-clisp.lisp
:clisp
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-lispworks.lisp
:lispworks
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-ecl.lisp
:ecl
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-allegro.lisp
:allegro
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-corman.lisp
:cormanlisp
cffi-allegro.lisp
(file).
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-abcl.lisp
:abcl
cffi-corman.lisp
(file).
cffi-allegro.lisp
(file).
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-mkcl.lisp
:mkcl
cffi-abcl.lisp
(file).
cffi-corman.lisp
(file).
cffi-allegro.lisp
(file).
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/cffi-clasp.lisp
:clasp
cffi-mkcl.lisp
(file).
cffi-abcl.lisp
(file).
cffi-corman.lisp
(file).
cffi-allegro.lisp
(file).
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
cffi/src/utils.lisp
cffi-clasp.lisp
(file).
cffi-mkcl.lisp
(file).
cffi-abcl.lisp
(file).
cffi-corman.lisp
(file).
cffi-allegro.lisp
(file).
cffi-ecl.lisp
(file).
cffi-lispworks.lisp
(file).
cffi-clisp.lisp
(file).
cffi-scl.lisp
(file).
cffi-cmucl.lisp
(file).
cffi-sbcl.lisp
(file).
cffi-mcl.lisp
(file).
cffi-openmcl.lisp
(file).
sys-utils.lisp
(file).
src
(module).
discard-docstring
(macro).
new-arg
(reader method).
obsolete-argument-warning
(condition).
old-arg
(reader method).
single-bit-p
(function).
split-if
(function).
warn-if-kw-or-belongs-to-cl
(function).
warn-obsolete-argument
(function).
cffi/src/libraries.lisp
utils.lisp
(file).
src
(module).
*darwin-framework-directories*
(special variable).
*foreign-library-directories*
(special variable).
close-foreign-library
(function).
define-foreign-library
(macro).
foreign-library
(class).
foreign-library-load-state
(reader method).
(setf foreign-library-load-state)
(writer method).
foreign-library-loaded-p
(function).
foreign-library-name
(reader method).
(setf foreign-library-name)
(writer method).
foreign-library-pathname
(function).
foreign-library-type
(function).
initialize-instance
(method).
list-foreign-libraries
(function).
load-foreign-library
(function).
load-foreign-library-error
(condition).
print-object
(method).
reload-foreign-libraries
(function).
use-foreign-library
(macro).
%do-load-foreign-library
(function).
%foreign-library-spec
(function).
*cffi-feature-suffix-map*
(special variable).
*foreign-libraries*
(special variable).
clean-spec-up
(function).
darwin-fallback-library-path
(function).
default-library-suffix
(function).
explode-path-environment-variable
(function).
fallback-darwin-framework-directories
(function).
filter-pathname
(function).
find-darwin-framework
(function).
find-file
(function).
fl-error
(function).
fl-name
(reader method).
foreign-library-handle
(reader method).
(setf foreign-library-handle)
(writer method).
foreign-library-options
(function).
foreign-library-search-path
(function).
foreign-library-spec
(function).
foreign-library-undefined-error
(condition).
get-foreign-library
(function).
(setf get-foreign-library)
(function).
load-darwin-framework
(function).
load-foreign-library-helper
(function).
load-foreign-library-path
(function).
mini-eval
(function).
parse-directories
(function).
read-new-value
(function).
register-foreign-library
(function).
report-simple-error
(function).
try-foreign-library-alternatives
(function).
cffi/src/early-types.lisp
libraries.lisp
(file).
src
(module).
*built-in-foreign-types*
(special variable).
convert-from-foreign
(compiler macro).
convert-from-foreign
(function).
convert-into-foreign-memory
(compiler macro).
convert-into-foreign-memory
(function).
convert-to-foreign
(compiler macro).
convert-to-foreign
(function).
defctype
(macro).
define-foreign-type
(macro).
define-parse-method
(macro).
expand-from-foreign
(generic function).
expand-into-foreign-memory
(generic function).
expand-to-foreign
(generic function).
expand-to-foreign-dyn
(generic function).
foreign-type-alignment
(generic function).
foreign-type-size
(compiler macro).
foreign-type-size
(generic function).
free-converted-object
(function).
free-translated-object
(generic function).
initialize-instance
(method).
make-load-form
(method).
print-object
(method).
print-object
(method).
print-object
(method).
translate-from-foreign
(generic function).
translate-into-foreign-memory
(generic function).
translate-to-foreign
(generic function).
*default-type-parsers*
(special variable).
*runtime-translator-form*
(special variable).
*struct-type-parsers*
(special variable).
*union-type-parsers*
(special variable).
actual-type
(reader method).
(setf actual-type)
(writer method).
aggregatep
(generic function).
alignment
(reader method).
(setf alignment)
(writer method).
bare-struct-type-p
(generic function).
c-namespace-name
(type).
canonicalize
(generic function).
canonicalize-foreign-type
(function).
cffi-error
(condition).
check-for-typedef-cycles
(function).
defctype*
(macro).
define-built-in-foreign-type
(macro).
enhanced-foreign-type
(class).
enhanced-typedef
(class).
ensure-parsed-base-type
(function).
expand-to-foreign-dyn-indirect
(generic function).
find-default-type-parser
(function).
find-type-parser
(function).
(setf find-type-parser)
(function).
follow-typedefs
(function).
foreign-built-in-type
(class).
foreign-expand-runtime-translator-or-binding
(function).
foreign-pointer-type
(class).
foreign-struct-type
(class).
foreign-type
(class).
foreign-type-alias
(class).
foreign-type-error
(condition).
foreign-type-error/compound-name
(function).
foreign-type-error/namespace
(reader method).
(setf foreign-type-error/namespace)
(writer method).
foreign-type-error/type-name
(reader method).
(setf foreign-type-error/type-name)
(writer method).
foreign-typedef
(class).
foreign-union-type
(class).
name
(reader method).
(setf name)
(writer method).
named-foreign-type
(class).
namespace-table
(function).
notice-foreign-type
(function).
parse-type
(function).
pointer-type
(reader method).
(setf pointer-type)
(writer method).
simple-foreign-type-error
(function).
simple-foreign-type-error
(condition).
size
(reader method).
(setf size)
(writer method).
slots
(reader method).
(setf slots)
(writer method).
slots-in-order
(function).
structure-slots
(function).
translatable-foreign-type
(class).
translate-aggregate-to-foreign
(generic function).
type-keyword
(reader method).
(setf type-keyword)
(writer method).
undefine-foreign-type
(function).
undefined-foreign-type-error
(function).
undefined-foreign-type-error
(condition).
unparse-type
(generic function).
unparsed-type
(reader method).
(setf unparsed-type)
(writer method).
cffi/src/types.lisp
early-types.lisp
(file).
src
(module).
*built-in-float-types*
(special variable).
*built-in-integer-types*
(special variable).
*other-builtin-types*
(special variable).
defcstruct
(macro).
defcunion
(macro).
define-c-struct-wrapper
(macro).
expand-from-foreign
(method).
expand-to-foreign
(method).
foreign-alloc
(compiler macro).
foreign-alloc
(function).
foreign-aref
(function).
(setf foreign-aref)
(function).
foreign-array-alloc
(function).
foreign-array-free
(function).
foreign-array-to-lisp
(function).
foreign-slot-count
(function).
foreign-slot-names
(function).
foreign-slot-offset
(function).
foreign-slot-pointer
(compiler macro).
foreign-slot-pointer
(function).
foreign-slot-type
(function).
foreign-slot-value
(compiler macro).
(setf foreign-slot-value)
(setf expander).
foreign-slot-value
(function).
foreign-type-alignment
(method).
foreign-type-alignment
(method).
foreign-type-size
(method).
free-translated-object
(method).
inc-pointer
(compiler macro).
incf-pointer
(macro).
lisp-array-to-foreign
(function).
mem-aptr
(compiler macro).
mem-aptr
(function).
mem-aref
(compiler macro).
(setf mem-aref)
(setf expander).
mem-aref
(function).
mem-ref
(compiler macro).
(setf mem-ref)
(setf expander).
mem-ref
(function).
print-object
(method).
translate-from-foreign
(method).
translate-from-foreign
(method).
translate-from-foreign
(method).
translate-into-foreign-memory
(method).
translate-into-foreign-memory
(method).
translate-to-foreign
(method).
translate-to-foreign
(method).
translate-to-foreign
(method).
with-foreign-array
(macro).
with-foreign-object
(macro).
with-foreign-objects
(macro).
with-foreign-slots
(macro).
*defcstruct-hook*
(special variable).
*possible-float-types*
(special variable).
adjust-for-alignment
(function).
aggregate-struct-slot
(class).
aggregatep
(method).
array-element-size
(function).
defctype-matching
(macro).
dimensions
(reader method).
element-type
(reader method).
foreign-array-type
(class).
foreign-boolean-type
(class).
foreign-slot-set
(compiler macro).
foreign-slot-set
(function).
foreign-struct-slot
(class).
foreign-struct-slot-pointer
(generic function).
foreign-struct-slot-pointer-form
(generic function).
foreign-struct-slot-set-form
(generic function).
foreign-struct-slot-value
(generic function).
(setf foreign-struct-slot-value)
(generic function).
foreign-struct-slot-value-form
(generic function).
foreign-type-wrapper
(class).
generate-struct-accessors
(function).
get-alignment
(function).
get-slot-info
(function).
indexes-to-row-major-index
(function).
make-struct-slot
(function).
mem-set
(compiler macro).
mem-set
(function).
notice-foreign-struct-definition
(function).
notice-foreign-union-definition
(function).
parse-deprecated-struct-type
(function).
row-major-index-to-indexes
(function).
simple-struct-slot
(class).
slot-count
(reader method).
(setf slot-count)
(writer method).
slot-name
(reader method).
slot-offset
(reader method).
(setf slot-offset)
(writer method).
slot-type
(reader method).
(setf slot-type)
(writer method).
translate-aggregate-to-foreign
(method).
translate-aggregate-to-foreign
(method).
with-tentative-type-definition
(macro).
wrapper-from-c
(reader method).
wrapper-to-c
(reader method).
cffi/src/enum.lisp
types.lisp
(file).
src
(module).
defbitfield
(macro).
defcenum
(macro).
expand-from-foreign
(method).
expand-to-foreign
(method).
expand-to-foreign
(method).
foreign-bitfield-symbol-list
(function).
foreign-bitfield-symbols
(compiler macro).
foreign-bitfield-symbols
(function).
foreign-bitfield-value
(compiler macro).
foreign-bitfield-value
(function).
foreign-enum-keyword
(function).
foreign-enum-keyword-list
(function).
foreign-enum-value
(function).
translate-from-foreign
(method).
translate-from-foreign
(method).
translate-into-foreign-memory
(method).
translate-to-foreign
(method).
translate-to-foreign
(method).
%defcenum-like
(function).
%foreign-bitfield-symbols
(function).
%foreign-bitfield-value
(function).
%foreign-enum-keyword
(function).
%foreign-enum-value
(compiler macro).
%foreign-enum-value
(function).
+valid-enum-base-types+
(special variable).
allow-undeclared-values
(reader method).
bit-index->keyword
(reader method).
enum-key
(type).
expand-to-foreign-dyn-indirect
(method).
field-keywords
(reader method).
foreign-bitfield
(class).
foreign-enum
(class).
hash-keys-to-list
(function).
keyword-values
(reader method).
make-foreign-bitfield
(function).
make-foreign-enum
(function).
parse-foreign-enum-like
(function).
value-keywords
(reader method).
cffi/src/strings.lisp
enum.lisp
(file).
src
(module).
*default-foreign-encoding*
(special variable).
foreign-string-alloc
(function).
foreign-string-free
(function).
foreign-string-to-lisp
(function).
free-translated-object
(method).
lisp-string-to-foreign
(function).
print-object
(method).
translate-from-foreign
(method).
translate-from-foreign
(method).
translate-to-foreign
(method).
translate-to-foreign
(method).
with-foreign-pointer-as-string
(macro).
with-foreign-string
(macro).
with-foreign-strings
(macro).
%foreign-string-length
(macro).
*foreign-string-mappings*
(special variable).
bget
(macro).
bset
(macro).
encoding
(reader method).
expand-to-foreign-dyn-indirect
(method).
foreign-string+ptr-type
(class).
foreign-string-length
(function).
foreign-string-type
(class).
fst-encoding
(function).
fst-free-from-foreign-p
(reader method).
fst-free-to-foreign-p
(reader method).
null-terminator-len
(function).
cffi/src/structures.lisp
strings.lisp
(file).
src
(module).
define-translation-method
(macro).
free-translated-object
(method).
translate-from-foreign
(method).
translate-into-foreign-memory
(method).
translate-to-foreign
(method).
translation-forms-for-class
(macro).
cffi/src/functions.lisp
structures.lisp
(file).
src
(module).
callback
(macro).
defcallback
(macro).
defcfun
(macro).
defcfun-helper-forms
(function).
foreign-funcall
(macro).
foreign-funcall-pointer
(macro).
foreign-funcall-pointer-varargs
(macro).
foreign-funcall-varargs
(macro).
get-callback
(function).
translate-camelcase-name
(generic function).
translate-name-from-foreign
(generic function).
translate-name-to-foreign
(generic function).
translate-underscore-separated-name
(generic function).
%defcfun
(function).
%defcfun-varargs
(function).
%parse-name-and-options
(function).
*foreign-structures-by-value*
(special variable).
check-prefix
(function).
collapse-prefix
(function).
fn-call-by-value-p
(function).
foreign-funcall-form
(function).
foreign-funcall-varargs-form
(function).
foreign-name
(function).
foreign-options
(function).
inverse-translate-objects
(function).
lisp-name
(function).
lisp-name-p
(function).
parse-args-and-types
(function).
parse-defcallback-options
(function).
parse-function-options
(function).
parse-name-and-options
(function).
promote-varargs-type
(function).
structure-by-value-p
(function).
translate-objects
(function).
cffi/src/foreign-vars.lisp
functions.lisp
(file).
src
(module).
defcvar
(macro).
foreign-symbol-pointer
(function).
get-var-pointer
(function).
fs-pointer-or-lose
(function).
parse-defcvar-options
(function).
cffi/src/features.lisp
foreign-vars.lisp
(file).
src
(module).
cffi-feature-p
(function).
Packages are listed by definition order.
cffi-sys
alexandria
.
common-lisp
.
sb-alien
.
cffi
.
%callback
(function).
%close-foreign-library
(function).
%defcallback
(macro).
%foreign-alloc
(function).
%foreign-funcall
(macro).
%foreign-funcall-pointer
(macro).
%foreign-funcall-pointer-varargs
(macro).
%foreign-funcall-varargs
(macro).
%foreign-symbol-pointer
(function).
%foreign-type-alignment
(function).
%foreign-type-size
(function).
%load-foreign-library
(function).
%mem-ref
(compiler macro).
%mem-ref
(function).
%mem-set
(compiler macro).
%mem-set
(function).
canonicalize-symbol-name-case
(function).
constant-form-p
(function).
constant-form-value
(function).
defcfun-helper-forms
(function).
foreign-free
(function).
foreign-pointer
(type).
inc-pointer
(compiler macro).
inc-pointer
(function).
make-pointer
(function).
make-shareable-byte-vector
(function).
native-namestring
(function).
null-pointer
(function).
null-pointer-p
(function).
pointer-address
(function).
pointer-eq
(function).
pointerp
(function).
with-foreign-pointer
(macro).
with-pointer-to-vector-data
(macro).
%%foreign-funcall
(macro).
*callbacks*
(special variable).
convert-foreign-type
(function).
define-mem-accessors
(macro).
define-type-mapping
(macro).
foreign-funcall-type-and-args
(function).
quoted-form-p
(function).
unload-shared-object-present-p
(function).
cffi
babel-encodings
.
cffi-sys
.
common-lisp
.
*built-in-float-types*
(special variable).
*built-in-foreign-types*
(special variable).
*built-in-integer-types*
(special variable).
*darwin-framework-directories*
(special variable).
*default-foreign-encoding*
(special variable).
*foreign-library-directories*
(special variable).
*other-builtin-types*
(special variable).
callback
(macro).
close-foreign-library
(function).
convert-from-foreign
(compiler macro).
convert-from-foreign
(function).
convert-into-foreign-memory
(compiler macro).
convert-into-foreign-memory
(function).
convert-to-foreign
(compiler macro).
convert-to-foreign
(function).
defbitfield
(macro).
defcallback
(macro).
defcenum
(macro).
defcfun
(macro).
defcstruct
(macro).
defctype
(macro).
defcunion
(macro).
defcvar
(macro).
define-c-struct-wrapper
(macro).
define-foreign-library
(macro).
define-foreign-type
(macro).
define-parse-method
(macro).
define-translation-method
(macro).
expand-from-foreign
(generic function).
expand-into-foreign-memory
(generic function).
expand-to-foreign
(generic function).
expand-to-foreign-dyn
(generic function).
foreign-alloc
(compiler macro).
foreign-alloc
(function).
foreign-aref
(function).
(setf foreign-aref)
(function).
foreign-array-alloc
(function).
foreign-array-free
(function).
foreign-array-to-lisp
(function).
foreign-bitfield-symbol-list
(function).
foreign-bitfield-symbols
(compiler macro).
foreign-bitfield-symbols
(function).
foreign-bitfield-value
(compiler macro).
foreign-bitfield-value
(function).
foreign-enum-keyword
(function).
foreign-enum-keyword-list
(function).
foreign-enum-value
(function).
foreign-funcall
(macro).
foreign-funcall-pointer
(macro).
foreign-funcall-pointer-varargs
(macro).
foreign-funcall-varargs
(macro).
foreign-library
(class).
foreign-library-load-state
(generic reader).
(setf foreign-library-load-state)
(generic writer).
foreign-library-loaded-p
(function).
foreign-library-name
(generic reader).
(setf foreign-library-name)
(generic writer).
foreign-library-pathname
(function).
foreign-library-type
(function).
foreign-slot-count
(function).
foreign-slot-names
(function).
foreign-slot-offset
(function).
foreign-slot-pointer
(compiler macro).
foreign-slot-pointer
(function).
foreign-slot-type
(function).
foreign-slot-value
(compiler macro).
(setf foreign-slot-value)
(setf expander).
foreign-slot-value
(function).
foreign-string-alloc
(function).
foreign-string-free
(function).
foreign-string-to-lisp
(function).
foreign-symbol-pointer
(function).
foreign-type-alignment
(generic function).
foreign-type-size
(compiler macro).
foreign-type-size
(generic function).
free-converted-object
(function).
free-translated-object
(generic function).
get-callback
(function).
get-var-pointer
(function).
incf-pointer
(macro).
lisp-array-to-foreign
(function).
lisp-string-to-foreign
(function).
list-foreign-libraries
(function).
load-foreign-library
(function).
load-foreign-library-error
(condition).
mem-aptr
(compiler macro).
mem-aptr
(function).
mem-aref
(compiler macro).
(setf mem-aref)
(setf expander).
mem-aref
(function).
mem-ref
(compiler macro).
(setf mem-ref)
(setf expander).
mem-ref
(function).
reload-foreign-libraries
(function).
translate-camelcase-name
(generic function).
translate-from-foreign
(generic function).
translate-into-foreign-memory
(generic function).
translate-name-from-foreign
(generic function).
translate-name-to-foreign
(generic function).
translate-to-foreign
(generic function).
translate-underscore-separated-name
(generic function).
translation-forms-for-class
(macro).
use-foreign-library
(macro).
with-foreign-array
(macro).
with-foreign-object
(macro).
with-foreign-objects
(macro).
with-foreign-pointer-as-string
(macro).
with-foreign-slots
(macro).
with-foreign-string
(macro).
with-foreign-strings
(macro).
%defcenum-like
(function).
%defcfun
(function).
%defcfun-varargs
(function).
%do-load-foreign-library
(function).
%foreign-bitfield-symbols
(function).
%foreign-bitfield-value
(function).
%foreign-enum-keyword
(function).
%foreign-enum-value
(compiler macro).
%foreign-enum-value
(function).
%foreign-library-spec
(function).
%foreign-string-length
(macro).
%parse-name-and-options
(function).
*cffi-feature-suffix-map*
(special variable).
*default-type-parsers*
(special variable).
*defcstruct-hook*
(special variable).
*foreign-libraries*
(special variable).
*foreign-string-mappings*
(special variable).
*foreign-structures-by-value*
(special variable).
*possible-float-types*
(special variable).
*runtime-translator-form*
(special variable).
*struct-type-parsers*
(special variable).
*union-type-parsers*
(special variable).
+valid-enum-base-types+
(special variable).
actual-type
(generic reader).
(setf actual-type)
(generic writer).
adjust-for-alignment
(function).
aggregate-struct-slot
(class).
aggregatep
(generic function).
alignment
(generic reader).
(setf alignment)
(generic writer).
allow-undeclared-values
(generic reader).
array-element-size
(function).
bare-struct-type-p
(generic function).
bget
(macro).
bit-index->keyword
(generic reader).
bset
(macro).
c-namespace-name
(type).
canonicalize
(generic function).
canonicalize-foreign-type
(function).
cffi-error
(condition).
check-for-typedef-cycles
(function).
check-prefix
(function).
clean-spec-up
(function).
collapse-prefix
(function).
darwin-fallback-library-path
(function).
default-library-suffix
(function).
defctype*
(macro).
defctype-matching
(macro).
define-built-in-foreign-type
(macro).
dimensions
(generic reader).
discard-docstring
(macro).
element-type
(generic reader).
encoding
(generic reader).
enhanced-foreign-type
(class).
enhanced-typedef
(class).
ensure-parsed-base-type
(function).
enum-key
(type).
expand-to-foreign-dyn-indirect
(generic function).
explode-path-environment-variable
(function).
fallback-darwin-framework-directories
(function).
field-keywords
(generic reader).
filter-pathname
(function).
find-darwin-framework
(function).
find-default-type-parser
(function).
find-file
(function).
find-type-parser
(function).
(setf find-type-parser)
(function).
fl-error
(function).
fl-name
(generic reader).
fn-call-by-value-p
(function).
follow-typedefs
(function).
foreign-array-type
(class).
foreign-bitfield
(class).
foreign-boolean-type
(class).
foreign-built-in-type
(class).
foreign-enum
(class).
foreign-expand-runtime-translator-or-binding
(function).
foreign-funcall-form
(function).
foreign-funcall-varargs-form
(function).
foreign-library-handle
(generic reader).
(setf foreign-library-handle)
(generic writer).
foreign-library-options
(function).
foreign-library-search-path
(function).
foreign-library-spec
(function).
foreign-library-undefined-error
(condition).
foreign-name
(function).
foreign-options
(function).
foreign-pointer-type
(class).
foreign-slot-set
(compiler macro).
foreign-slot-set
(function).
foreign-string+ptr-type
(class).
foreign-string-length
(function).
foreign-string-type
(class).
foreign-struct-slot
(class).
foreign-struct-slot-pointer
(generic function).
foreign-struct-slot-pointer-form
(generic function).
foreign-struct-slot-set-form
(generic function).
foreign-struct-slot-value
(generic function).
(setf foreign-struct-slot-value)
(generic function).
foreign-struct-slot-value-form
(generic function).
foreign-struct-type
(class).
foreign-type
(class).
foreign-type-alias
(class).
foreign-type-error
(condition).
foreign-type-error/compound-name
(function).
foreign-type-error/namespace
(generic reader).
(setf foreign-type-error/namespace)
(generic writer).
foreign-type-error/type-name
(generic reader).
(setf foreign-type-error/type-name)
(generic writer).
foreign-type-wrapper
(class).
foreign-typedef
(class).
foreign-union-type
(class).
fs-pointer-or-lose
(function).
fst-encoding
(function).
fst-free-from-foreign-p
(generic reader).
fst-free-to-foreign-p
(generic reader).
generate-struct-accessors
(function).
get-alignment
(function).
get-foreign-library
(function).
(setf get-foreign-library)
(function).
get-slot-info
(function).
hash-keys-to-list
(function).
indexes-to-row-major-index
(function).
inverse-translate-objects
(function).
keyword-values
(generic reader).
lisp-name
(function).
lisp-name-p
(function).
load-darwin-framework
(function).
load-foreign-library-helper
(function).
load-foreign-library-path
(function).
make-foreign-bitfield
(function).
make-foreign-enum
(function).
make-struct-slot
(function).
mem-set
(compiler macro).
mem-set
(function).
mini-eval
(function).
name
(generic reader).
(setf name)
(generic writer).
named-foreign-type
(class).
namespace-table
(function).
new-arg
(generic reader).
notice-foreign-struct-definition
(function).
notice-foreign-type
(function).
notice-foreign-union-definition
(function).
null-terminator-len
(function).
obsolete-argument-warning
(condition).
old-arg
(generic reader).
parse-args-and-types
(function).
parse-defcallback-options
(function).
parse-defcvar-options
(function).
parse-deprecated-struct-type
(function).
parse-directories
(function).
parse-foreign-enum-like
(function).
parse-function-options
(function).
parse-name-and-options
(function).
parse-type
(function).
pointer-type
(generic reader).
(setf pointer-type)
(generic writer).
promote-varargs-type
(function).
read-new-value
(function).
register-foreign-library
(function).
report-simple-error
(function).
row-major-index-to-indexes
(function).
simple-foreign-type-error
(function).
simple-foreign-type-error
(condition).
simple-struct-slot
(class).
single-bit-p
(function).
size
(generic reader).
(setf size)
(generic writer).
slot-count
(generic reader).
(setf slot-count)
(generic writer).
slot-name
(generic reader).
slot-offset
(generic reader).
(setf slot-offset)
(generic writer).
slot-type
(generic reader).
(setf slot-type)
(generic writer).
slots
(generic reader).
(setf slots)
(generic writer).
slots-in-order
(function).
split-if
(function).
structure-by-value-p
(function).
structure-slots
(function).
translatable-foreign-type
(class).
translate-aggregate-to-foreign
(generic function).
translate-objects
(function).
try-foreign-library-alternatives
(function).
type-keyword
(generic reader).
(setf type-keyword)
(generic writer).
undefine-foreign-type
(function).
undefined-foreign-type-error
(function).
undefined-foreign-type-error
(condition).
unparse-type
(generic function).
unparsed-type
(generic reader).
(setf unparsed-type)
(generic writer).
value-keywords
(generic reader).
warn-if-kw-or-belongs-to-cl
(function).
warn-obsolete-argument
(function).
with-tentative-type-definition
(macro).
wrapper-from-c
(generic reader).
wrapper-to-c
(generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
List of real float types supported by CFFI.
cffi
.
List of integer types supported by CFFI.
cffi
.
List of directories where Frameworks are searched for.
cffi
.
List onto which user-defined library paths can be pushed.
cffi
.
List of types other than integer or float built in to CFFI.
cffi
.
Perform a foreign function call, document it more later.
Funcall a pointer to a foreign function.
Define an foreign enumerated type.
Define an foreign enumerated type.
Defines a Lisp function that calls a foreign function.
cffi
.
Define the layout of a foreign structure.
cffi
.
Utility macro for simple C-like typedefs.
cffi
.
Define the layout of a foreign union.
cffi
.
Define a foreign global variable.
cffi
.
Define a new class with CLOS slots matching those of a foreign
struct type. An INITIALIZE-INSTANCE method is defined which
takes a :POINTER initarg that is used to store the slots of a
foreign object. This pointer is only used for initialization and
it is not retained.
CLASS-AND-TYPE is either a list of the form (class-name struct-type) or a single symbol naming both. The class will inherit SUPERS. If a list of SLOTS is specified, only those slots will be defined and stored.
cffi
.
Defines a foreign library NAME that can be posteriorly used with the USE-FOREIGN-LIBRARY macro.
cffi
.
Define a type parser on NAME and lists whose CAR is NAME.
cffi
.
Define a translation method for the foreign structure type; ’method is one of :into, :from, or :to, meaning relation to foreign memory. If :into, the variable ’pointer is the foreign pointer. Note: type must be defined and loaded before this macro is expanded, and just the bare name (without :struct) should be specified.
cffi
.
Wrapper around %FOREIGN-FUNCALL that translates its arguments.
cffi
.
Wrapper around %FOREIGN-FUNCALL-POINTER that translates its arguments and does type promotion for the variadic arguments.
cffi
.
Wrapper around %FOREIGN-FUNCALL that translates its arguments and does type promotion for the variadic arguments.
cffi
.
Make forms for translation of foreign structures to and from a standard class. The class slots are assumed to have the same name as the foreign structure.
cffi
.
Bind var to a foreign array containing lisp-array elements in body.
cffi
.
Bind VAR to a pointer to COUNT objects of TYPE during BODY. The buffer has dynamic extent and may be stack allocated.
cffi
.
Bind VAR to SIZE bytes of foreign memory during BODY. The pointer in VAR is invalid beyond the dynamic extent of BODY, and may be stack-allocated if supported by the implementation. If SIZE-VAR is supplied, it will be bound to SIZE during BODY.
VAR-OR-VARS is not evaluated and should be a list of the form (VAR &OPTIONAL SIZE-VAR) or just a VAR symbol. VAR is bound to a foreign buffer of size SIZE within BODY. The return value is constructed by calling FOREIGN-STRING-TO-LISP on the foreign buffer along with ARGS.
cffi
.
Create local symbol macros for each var in VARS to reference
foreign slots in PTR of TYPE. Similar to WITH-SLOTS.
Each var can be of the form:
name name bound to slot of same name
(:pointer name) name bound to pointer to slot of same name
(name slot-name) name bound to slot-name
(name :pointer slot-name) name bound to pointer to slot-name
cffi
.
VAR-OR-VARS is not evaluated and should be a list of the form (VAR &OPTIONAL BYTE-SIZE-VAR) or just a VAR symbol. VAR is bound to a foreign string containing LISP-STRING in BODY. When BYTE-SIZE-VAR is specified then bind the C buffer size (including the possible null terminator(s)) to this variable.
cffi
.
See WITH-FOREIGN-STRING’s documentation.
cffi
.
Bind PTR-VAR to a foreign pointer to the data in VECTOR.
Optimize for when TYPE and SYMBOLS are constant.
Optimize for when TYPE and SYMBOLS are constant.
Optimizer for FOREIGN-SLOT-VALUE when TYPE is constant.
cffi
.
The pointer to the element.
cffi
.
Compiler macro to open-code MEM-AREF when TYPE (and eventually INDEX).
cffi
.
Compiler macro to open-code MEM-REF when TYPE is constant.
cffi
.
SETF expander for FOREIGN-SLOT-VALUE.
cffi
.
foreign-slot-value
(function).
SETF expander for MEM-AREF.
SETF expander for MEM-REF that doesn’t rebind TYPE.
This is necessary for the compiler macro on MEM-SET to be able
to open-code (SETF MEM-REF) forms.
Closes a foreign library.
Allocate SIZE bytes on the heap and return a pointer.
Returns a pointer to a foreign symbol NAME.
Return the alignment in bytes of a foreign type.
Return the size in bytes of a foreign type.
Load a foreign library.
Matches a FEATURE-EXPRESSION against those symbols in *FEATURES* that belong to the CFFI-FEATURES package.
Allocate enough memory to hold COUNT objects of type TYPE. If INITIAL-ELEMENT is supplied, each element of the newly allocated memory is initialized with its value. If INITIAL-CONTENTS is supplied, each of its elements will be used to initialize the contents of the newly allocated memory.
cffi
.
Allocate a foreign array containing the elements of lisp array. The foreign array must be freed with foreign-array-free.
cffi
.
Free a foreign array allocated by foreign-array-alloc.
cffi
.
Copy elements from pointer into a Lisp array. ARRAY-TYPE must be a CFFI array type; the type of the resulting Lisp array can be defined in MAKE-ARRAY-ARGS that are then passed to MAKE-ARRAY. If POINTER is a null pointer, returns NIL.
cffi
.
Return a list of SYMBOLS defined in BITFIELD-TYPE.
Convert an integer VALUE into a list of matching symbols according to the bitfield TYPE.
Convert a list of symbols into an integer according to the TYPE bitfield.
Convert an integer VALUE into a keyword according to the enum TYPE.
Return a list of KEYWORDS defined in ENUM-TYPE.
Convert a KEYWORD into an integer according to the enum TYPE.
Free a PTR allocated by FOREIGN-ALLOC.
Return the number of items in SLOT in a struct TYPE.
cffi
.
Returns a list of TYPE’s slot names in no particular order.
cffi
.
Return the offset of SLOT in a struct TYPE.
cffi
.
Return the address of SLOT-NAME in the structure at PTR.
cffi
.
Return the type of SLOT in a struct TYPE.
cffi
.
Return the value of SLOT-NAME in the foreign structure at PTR.
cffi
.
Allocate a foreign string containing Lisp string STRING. The string must be freed with FOREIGN-STRING-FREE.
cffi
.
Free a foreign string allocated by FOREIGN-STRING-ALLOC.
cffi
.
Copy at most COUNT bytes from POINTER plus OFFSET encoded in ENCODING into a Lisp string and return it. If POINTER is a null pointer, NIL is returned.
cffi
.
Return a pointer to the foreign global variable relative to SYMBOL.
cffi
.
Return a pointer pointing OFFSET bytes past PTR.
Copy elements from a Lisp array to POINTER. ARRAY-TYPE must be a CFFI array type.
cffi
.
cffi
.
Return a list of defined foreign libraries.
If LOADED-ONLY is non-null only loaded libraries are returned.
TYPE restricts the output to a specific library type: if NIL
all libraries are returned.
cffi
.
Loads a foreign LIBRARY which can be a symbol denoting a library defined through DEFINE-FOREIGN-LIBRARY; a pathname or string in which case we try to load it directly first then search for it in *FOREIGN-LIBRARY-DIRECTORIES*; or finally list: either (:or lib1 lib2) or (:framework <framework-name>). The option :CANARY can specify a symbol that will be searched to detect if the library is already loaded, in which case DEFINE-FOREIGN-LIBRARY will mark the library as loaded and return.
cffi
.
Return a pointer pointing to ADDRESS.
Create a Lisp vector of SIZE bytes that can be passed to WITH-POINTER-TO-VECTOR-DATA.
Like MEM-REF except for accessing 1d arrays.
cffi
.
Return the value of TYPE at OFFSET bytes from PTR. If TYPE is aggregate, we don’t return its ’value’ but a pointer to it, which is PTR itself.
cffi
.
Construct and return a null pointer.
Return true if PTR is a null pointer.
Return the address pointed to by PTR.
Return true if PTR1 and PTR2 point to the same address.
Return true if PTR is a foreign pointer.
(Re)load all currently loaded foreign libraries.
cffi
.
cffi
.
foreign-bitfield
)) ¶foreign-boolean-type
)) ¶Optimization for the :boolean type.
enhanced-typedef
)) ¶translatable-foreign-type
)) ¶translatable-foreign-type
)) ¶cffi
.
enhanced-typedef
) ptr) ¶translatable-foreign-type
) ptr) ¶translatable-foreign-type
) ptr) ¶cffi
.
foreign-bitfield
)) ¶foreign-enum
)) ¶foreign-boolean-type
)) ¶Optimization for the :boolean type.
enhanced-typedef
)) ¶translatable-foreign-type
)) ¶translatable-foreign-type
)) ¶cffi
.
enhanced-typedef
)) ¶enhanced-foreign-type
)) ¶enhanced-foreign-type
)) ¶cffi
.
foreign-library
)) ¶automatically generated reader method
cffi
.
foreign-library
)) ¶automatically generated writer method
cffi
.
foreign-library
)) ¶automatically generated reader method
name
.
cffi
.
foreign-library
)) ¶automatically generated writer method
name
.
Return the structure alignment in bytes of a foreign type.
cffi
.
Return the alignment in bytes of a foreign type.
foreign-array-type
)) ¶foreign-type-alias
)) ¶Return the alignment of a foreign typedef.
foreign-struct-type
)) ¶Return the alignment requirements for this struct.
foreign-built-in-type
)) ¶Return the alignment of a built-in type.
Return the size in bytes of a foreign type.
cffi
.
foreign-array-type
)) ¶foreign-type-alias
)) ¶Return the size in bytes of a foreign typedef.
foreign-struct-type
)) ¶Return the size in bytes of a foreign structure type.
foreign-built-in-type
)) ¶Return the size of a built-in type.
Return the size in bytes of a foreign type.
cffi
.
foreign-struct-type
) freep) ¶foreign-string-type
) free-p) ¶foreign-array-type
) param) ¶enhanced-typedef
) param) ¶cffi
.
foreign-struct-type
)) ¶foreign-string+ptr-type
)) ¶foreign-string-type
)) ¶foreign-bitfield
)) ¶foreign-enum
)) ¶foreign-boolean-type
)) ¶foreign-type-wrapper
)) ¶foreign-array-type
)) ¶enhanced-typedef
)) ¶Translate the Lisp value into the foreign memory location given by pointer. Return value is not used.
cffi
.
list
) (type foreign-struct-type
) p) ¶foreign-enum
) pointer) ¶foreign-built-in-type
) pointer) ¶foreign-pointer-type
) pointer) ¶enhanced-typedef
) pointer) ¶cffi
.
foreign-struct-type
)) ¶foreign-string-type
)) ¶string
) (type foreign-string-type
)) ¶foreign-bitfield
)) ¶foreign-enum
)) ¶foreign-boolean-type
)) ¶foreign-type-wrapper
)) ¶foreign-array-type
)) ¶enhanced-typedef
)) ¶foreign-library
) &key canary search-path cconv calling-convention convention) ¶enhanced-foreign-type
) &key) ¶foreign-type
) &optional env) ¶Return the form used to dump types to a FASL file.
foreign-library
) stream) ¶foreign-array-type
) stream) ¶Print a FOREIGN-ARRAY-TYPE instance to STREAM unreadably.
foreign-pointer-type
) stream) ¶named-foreign-type
) stream) ¶Print a FOREIGN-TYPEDEF instance to STREAM unreadably.
foreign-string-type
) stream) ¶foreign-built-in-type
) stream) ¶Print a FOREIGN-TYPE instance to STREAM unreadably.
cffi
.
:name
common-lisp
.
:system
:type
:spec
:options
:load-state
:handle
common-lisp
.
Mapping of OS feature keywords to shared library suffixes.
cffi
.
A function that produces a form suitable for calling structures by value.
cffi
.
Internal guts of %FOREIGN-FUNCALL.
Like DEFCTYPE but defers instantiation until parse-time.
cffi
.
Defines a built-in foreign-type.
cffi
.
Discards the first element of the list in body-var if it’s a string.
cffi
.
Optimizer when TYPE and SLOT-NAME are constant.
cffi
.
Compiler macro to open-code (SETF MEM-REF) when type is constant.
cffi
.
cffi
.
cffi
.
Return OFFSET aligned properly for TYPE according to ALIGNMENT-TYPE.
cffi
.
Convert TYPE to a built-in type by following aliases. Signals an error if the type cannot be resolved.
cffi
.
Return a string to use as default library suffix based on the operating system. This is used to implement the :DEFAULT option. This will need to be extended as we test on more OSes.
cffi
.
Searches for FRAMEWORK-NAME in *DARWIN-FRAMEWORK-DIRECTORIES*.
cffi
.
Searches for PATH in a list of DIRECTORIES and returns the first it finds.
cffi
.
Return the type parser for SYMBOL. NAMESPACE is either :DEFAULT (for variables, functions, and typedefs) or :STRUCT (for structs, unions, and enums).
cffi
.
Set the type parser for SYMBOL.
cffi
.
One or more structures in the arguments or return from the function are called by value.
cffi
.
Return an SB-ALIEN function type for ARGS.
cffi
.
Set the value of SLOT-NAME in a foreign structure.
cffi
.
Like foreign-symbol-ptr but throws an error instead of returning nil when foreign-name is not found.
cffi
.
Return alignment for TYPE according to ALIGNMENT-TYPE.
cffi
.
Look up a library by NAME, signalling an error if not found.
cffi
.
Return the slot info for SLOT-NAME or raise an error.
cffi
.
Tries to find and load a darwin framework in one of the directories in *DARWIN-FRAMEWORK-DIRECTORIES*. If unable to find FRAMEWORK-NAME, it signals a LOAD-FOREIGN-LIBRARY-ERROR.
cffi
.
Tries to load PATH using %LOAD-FOREIGN-LIBRARY which should try and find it using the OS’s usual methods. If that fails we try to find it ourselves.
cffi
.
Makes a new instance of the foreign-bitfield class.
Makes a new instance of the foreign-enum class.
Make the appropriate type of structure slot.
cffi
.
Set the value of TYPE at OFFSET bytes from PTR to VALUE.
cffi
.
Simple EVAL-like function to evaluate the elements of *FOREIGN-LIBRARY-DIRECTORIES* and *DARWIN-FRAMEWORK-DIRECTORIES*.
cffi
.
Parse and install a foreign structure definition.
cffi
.
Parse and install a foreign union definition.
cffi
.
Returns 4 values: types, canonicalized types, args and return type.
cffi
.
cffi
.
Answer whether INTEGER, which must be an integer, is a single set twos-complement bit.
cffi
.
A list of the structure’s slots in order.
cffi
.
A structure or union is to be called or returned by value.
cffi
.
The hash table of slots for the structure type.
cffi
.
Helper function for FOREIGN-FUNCALL and DEFCFUN. If ’indirect is T, all arguments are represented by foreign pointers, even those that can be represented by CL objects.
cffi
.
Goes through a list of alternatives and only signals an error when none of alternatives were successfully loaded.
cffi
.
cffi
.
foreign-type-alias
)) ¶automatically generated reader method
cffi
.
foreign-type-alias
)) ¶automatically generated writer method
Return true if FOREIGN-TYPE is an aggregate type.
cffi
.
foreign-array-type
)) ¶foreign-type-alias
)) ¶Return true if TYPE’s actual type is aggregate.
foreign-struct-type
)) ¶Returns true, structure types are aggregate.
foreign-built-in-type
)) ¶Returns false, built-in types are never aggregate types.
cffi
.
foreign-struct-type
)) ¶automatically generated reader method
cffi
.
foreign-struct-type
)) ¶automatically generated writer method
cffi
.
foreign-enum
)) ¶automatically generated reader method
Return true if FOREIGN-TYPE is a bare struct type or an alias of a bare struct type.
cffi
.
foreign-typedef
)) ¶foreign-struct-type
)) ¶automatically generated reader method
bare
.
foreign-type
)) ¶Return true if FOREIGN-TYPE is a bare struct type or an alias of a bare struct type.
cffi
.
foreign-bitfield
)) ¶automatically generated reader method
Return the most primitive foreign type for FOREIGN-TYPE, either a built-in type–a keyword–or a struct/union type–a list of the form (:STRUCT/:UNION name). Signals an error if FOREIGN-TYPE is undefined.
cffi
.
foreign-type-alias
)) ¶Return the built-in type keyword for TYPE.
foreign-union-type
)) ¶foreign-struct-type
)) ¶foreign-built-in-type
)) ¶Return the built-in type keyword for TYPE.
cffi
.
foreign-array-type
)) ¶automatically generated reader method
cffi
.
foreign-array-type
)) ¶automatically generated reader method
cffi
.
foreign-string-type
)) ¶automatically generated reader method
cffi
.
foreign-string-type
)) ¶foreign-enum
)) ¶foreign-type-alias
)) ¶translatable-foreign-type
)) ¶foreign-built-in-type
)) ¶foreign-pointer-type
)) ¶translatable-foreign-type
)) ¶cffi
.
foreign-bitfield
)) ¶automatically generated reader method
cffi
.
foreign-library-undefined-error
)) ¶name
.
cffi
.
foreign-library
)) ¶automatically generated reader method
cffi
.
foreign-library
)) ¶automatically generated writer method
Get the address of SLOT relative to PTR.
cffi
.
foreign-struct-slot
)) ¶Return the address of SLOT relative to PTR.
Return a form to get the address of SLOT in PTR.
cffi
.
foreign-struct-slot
)) ¶Return a form to get the address of SLOT relative to PTR.
Return a form to set the value of SLOT in struct PTR.
cffi
.
aggregate-struct-slot
)) ¶Return a form to get the value of an aggregate SLOT relative to PTR.
simple-struct-slot
)) ¶Return a form to set the value of a simple structure slot.
Return the value of SLOT in structure PTR.
cffi
.
aggregate-struct-slot
)) ¶Return a pointer to SLOT relative to PTR.
simple-struct-slot
)) ¶Return the value of a simple SLOT from a struct at PTR.
Set the value of a SLOT in structure PTR.
cffi
.
aggregate-struct-slot
)) ¶Set the value of an aggregate SLOT to VALUE in PTR.
simple-struct-slot
)) ¶Set the value of a simple SLOT to VALUE in PTR.
Return a form to get the value of SLOT in struct PTR.
cffi
.
aggregate-struct-slot
)) ¶Return a form to get the value of SLOT relative to PTR.
simple-struct-slot
)) ¶Return a form to get the value of a slot from PTR.
cffi
.
foreign-type-error
)) ¶foreign-type-error
)) ¶cffi
.
foreign-type-error
)) ¶foreign-type-error
)) ¶cffi
.
foreign-string-type
)) ¶automatically generated reader method
cffi
.
foreign-string-type
)) ¶automatically generated reader method
cffi
.
foreign-enum
)) ¶automatically generated reader method
cffi
.
named-foreign-type
)) ¶automatically generated reader method
name
.
cffi
.
named-foreign-type
)) ¶automatically generated writer method
name
.
cffi
.
obsolete-argument-warning
)) ¶cffi
.
obsolete-argument-warning
)) ¶cffi
.
foreign-pointer-type
)) ¶automatically generated reader method
cffi
.
foreign-pointer-type
)) ¶automatically generated writer method
cffi
.
foreign-struct-type
)) ¶automatically generated reader method
size
.
cffi
.
foreign-struct-type
)) ¶automatically generated writer method
size
.
cffi
.
aggregate-struct-slot
)) ¶automatically generated reader method
cffi
.
aggregate-struct-slot
)) ¶automatically generated writer method
cffi
.
foreign-struct-slot
)) ¶automatically generated reader method
name
.
cffi
.
foreign-struct-slot
)) ¶automatically generated reader method
cffi
.
foreign-struct-slot
)) ¶automatically generated writer method
cffi
.
foreign-struct-slot
)) ¶automatically generated reader method
type
.
cffi
.
foreign-struct-slot
)) ¶automatically generated writer method
type
.
cffi
.
foreign-struct-type
)) ¶automatically generated reader method
cffi
.
foreign-struct-type
)) ¶automatically generated writer method
cffi
.
foreign-struct-type
)) ¶foreign-array-type
)) ¶cffi
.
foreign-built-in-type
)) ¶automatically generated reader method
cffi
.
foreign-built-in-type
)) ¶automatically generated writer method
Unparse FOREIGN-TYPE to a type specification (symbol or list).
cffi
.
enhanced-foreign-type
)) ¶foreign-struct-type
)) ¶foreign-pointer-type
)) ¶foreign-built-in-type
)) ¶Returns the symbolic representation of a built-in type.
named-foreign-type
)) ¶cffi
.
enhanced-foreign-type
)) ¶automatically generated reader method
cffi
.
enhanced-foreign-type
)) ¶automatically generated writer method
cffi
.
foreign-enum
)) ¶automatically generated reader method
cffi
.
foreign-type-wrapper
)) ¶automatically generated reader method
cffi
.
foreign-type-wrapper
)) ¶automatically generated reader method
to-c
.
cffi
.
error
.
cffi
.
foreign-type-error
.
simple-error
.
Aggregate structure slots.
Describes a foreign bitfield type.
cffi
.
(error "must specify field-keywords.")
:field-keywords
This slot is read-only.
(error "must specify bit-index->keyword")
:bit-index->keyword
This slot is read-only.
A built-in foreign type.
Describes a foreign enumerated type.
cffi
.
(error "must specify keyword-values.")
:keyword-values
This slot is read-only.
(error "must specify value-keywords.")
:value-keywords
This slot is read-only.
:allow-undeclared-values
This slot is read-only.
cffi
.
Initarg | Value |
---|---|
:actual-type | (quote (pointer)) |
boolean
:free-from-foreign
This slot is read-only.
boolean
t
:free-to-foreign
This slot is read-only.
Base class for simple and aggregate slots.
cffi
.
aggregatep
.
(setf alignment)
.
alignment
.
bare-struct-type-p
.
canonicalize
.
foreign-type-alignment
.
foreign-type-size
.
free-translated-object
.
(setf size)
.
size
.
(setf slots)
.
slots
.
translate-aggregate-to-foreign
.
translate-from-foreign
.
translate-into-foreign-memory
.
translate-to-foreign
.
unparse-type
.
(make-hash-table)
:slots
:alignment
:bare
This slot is read-only.
Base class for all foreign types.
cffi
.
A type that aliases another type.
Wrapper type.
Non-aggregate structure slots.
cffi
.
cffi
.
Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
---|
Jump to: | %
(
A B C D E F G H I K L M N O P Q R S T U V W |
---|
Jump to: | *
+
A B C D E F H K L N O P S T U V |
---|
Jump to: | *
+
A B C D E F H K L N O P S T U V |
---|
Jump to: | A C E F L M N O P S T U |
---|
Jump to: | A C E F L M N O P S T U |
---|