The cffi Reference Manual

Table of Contents

The cffi Reference Manual

This is the cffi Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 09:58:20 2020 GMT+0.

1 Introduction

CFFI, the Common Foreign Function Interface, purports to be a portable foreign function interface for Common Lisp. The CFFI library is composed of a Lisp-implementation-specific backend in the CFFI-SYS package, and a portable frontend in the CFFI package.

The CFFI-SYS backend package defines a low-level interface to the native FFI support in the Lisp implementation. It offers operators for allocating and dereferencing foreign memory, calling foreign functions, and loading shared libraries. The CFFI frontend provides a declarative interface for defining foreign functions, structures, typedefs, enumerated types, etc. It is implemented in portable ANSI CL making use of the low-level operators exported by CFFI-SYS.

CFFI/C2FFI is a mechanism to automatically generate CFFI bindings based on the output of c2ffi. Until it is properly documented please see [these]((https://github.com/hu-dwim/hu.dwim.bluez) projects as examples.

Please consult the manual for further details, including installation instructions.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cffi

Maintainer

Luis Oliveira <loliveira@common-lisp.net>

Author

James Bielman <jamesjb@jamesjb.com>

License

MIT

Description

The Common Foreign Function Interface

Dependencies

• uiop
• alexandria
• trivial-features
• babel

Source

cffi.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cffi/src

Parent

cffi (system)

Location

src/

Components

• cffi-sbcl.lisp (file)
• package.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)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cffi.asd

Location

cffi.asd

Systems

cffi (system)

4.1.2 cffi/src/cffi-sbcl.lisp

Parent

src (module)

Location

src/cffi-sbcl.lisp

Packages

cffi-sys

Exported Definitions

• %callback (function)
• %close-foreign-library (function)
• %defcallback (macro)
• %foreign-alloc (function)
• %foreign-funcall (macro)
• %foreign-funcall-pointer (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)

Internal Definitions

• %%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)

4.1.3 cffi/src/package.lisp

Dependency

cffi-sbcl.lisp (file)

Parent

src (module)

Location

src/package.lisp

Packages

cffi

4.1.4 cffi/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

• discard-docstring (macro)
• new-arg (method)
• obsolete-argument-warning (condition)
• old-arg (method)
• single-bit-p (function)
• split-if (function)
• warn-if-kw-or-belongs-to-cl (function)
• warn-obsolete-argument (function)

4.1.5 cffi/src/libraries.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/libraries.lisp

Exported Definitions

• *darwin-framework-directories* (special variable)
• *foreign-library-directories* (special variable)
• close-foreign-library (function)
• define-foreign-library (macro)
• foreign-library (class)
• foreign-library-loaded-p (function)
• foreign-library-name (method)
• (setf foreign-library-name) (method)
• foreign-library-pathname (function)
• foreign-library-type (function)
• list-foreign-libraries (function)
• load-foreign-library (function)
• load-foreign-library-error (condition)
• reload-foreign-libraries (function)
• use-foreign-library (macro)

Internal Definitions

• %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 (method)
• foreign-library-handle (method)
• (setf foreign-library-handle) (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)

4.1.6 cffi/src/early-types.lisp

Dependency

libraries.lisp (file)

Parent

src (module)

Location

src/early-types.lisp

Exported Definitions

• *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-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-into-foreign-memory (generic function)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-to-foreign (generic function)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign-dyn (generic function)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (method)
• foreign-type-alignment (generic function)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-size (generic function)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• free-converted-object (function)
• free-translated-object (generic function)
• free-translated-object (method)
• free-translated-object (method)
• translate-from-foreign (generic function)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-into-foreign-memory (generic function)
• translate-into-foreign-memory (method)
• translate-to-foreign (generic function)
• translate-to-foreign (method)
• translate-to-foreign (method)

Internal Definitions

• *runtime-translator-form* (special variable)
• *type-parsers* (special variable)
• actual-type (method)
• (setf actual-type) (method)
• aggregatep (generic function)
• aggregatep (method)
• aggregatep (method)
• aggregatep (method)
• alignment (method)
• (setf alignment) (method)
• bare-struct-type-p (generic function)
• bare-struct-type-p (method)
• bare-struct-type-p (method)
• bare-struct-type-p (method)
• c-namespace-name (type)
• canonicalize (generic function)
• canonicalize (method)
• canonicalize (method)
• canonicalize (method)
• canonicalize (method)
• 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)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• 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 (method)
• (setf foreign-type-error/namespace) (method)
• foreign-type-error/type-name (method)
• (setf foreign-type-error/type-name) (method)
• foreign-typedef (class)
• foreign-union-type (class)
• name (method)
• (setf name) (method)
• named-foreign-type (class)
• notice-foreign-type (function)
• parse-type (function)
• pointer-type (method)
• (setf pointer-type) (method)
• simple-foreign-type-error (function)
• simple-foreign-type-error (condition)
• size (method)
• (setf size) (method)
• slots (method)
• (setf slots) (method)
• slots-in-order (function)
• structure-slots (function)
• translatable-foreign-type (class)
• translate-aggregate-to-foreign (generic function)
• type-keyword (method)
• (setf type-keyword) (method)
• undefine-foreign-type (function)
• undefined-foreign-type-error (function)
• undefined-foreign-type-error (condition)
• unparse-type (generic function)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparsed-type (method)
• (setf unparsed-type) (method)

4.1.7 cffi/src/types.lisp

Dependency

early-types.lisp (file)

Parent

src (module)

Location

src/types.lisp

Exported Definitions

• *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)
• foreign-slot-value (function)
• (setf foreign-slot-value) (setf expander)
• 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)
• mem-aref (function)
• (setf mem-aref) (setf expander)
• mem-ref (compiler macro)
• mem-ref (function)
• (setf mem-ref) (setf expander)
• 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)

Internal Definitions

• *defcstruct-hook* (special variable)
• *possible-float-types* (special variable)
• adjust-for-alignment (function)
• aggregate-struct-slot (class)
• aggregatep (method)
• array-element-size (function)
• dimensions (method)
• element-type (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 (method)
• foreign-struct-slot-pointer-form (generic function)
• foreign-struct-slot-pointer-form (method)
• foreign-struct-slot-set-form (generic function)
• foreign-struct-slot-set-form (method)
• foreign-struct-slot-set-form (method)
• foreign-struct-slot-value (generic function)
• foreign-struct-slot-value (method)
• (setf foreign-struct-slot-value) (method)
• foreign-struct-slot-value (method)
• (setf foreign-struct-slot-value) (method)
• (setf foreign-struct-slot-value) (generic function)
• foreign-struct-slot-value-form (generic function)
• foreign-struct-slot-value-form (method)
• foreign-struct-slot-value-form (method)
• 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 (method)
• (setf slot-count) (method)
• slot-name (method)
• slot-offset (method)
• (setf slot-offset) (method)
• slot-type (method)
• (setf slot-type) (method)
• translate-aggregate-to-foreign (method)
• translate-aggregate-to-foreign (method)
• with-tentative-type-definition (macro)
• wrapper-from-c (method)
• wrapper-to-c (method)

4.1.8 cffi/src/enum.lisp

Dependency

types.lisp (file)

Parent

src (module)

Location

src/enum.lisp

Exported Definitions

• 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)

Internal Definitions

• %defcenum-like (function)
• %foreign-bitfield-symbols (function)
• %foreign-bitfield-value (function)
• %foreign-enum-keyword (function)
• %foreign-enum-value (function)
• +valid-enum-base-types+ (special variable)
• allow-undeclared-values (method)
• bit-index->keyword (method)
• enum-key (type)
• expand-to-foreign-dyn-indirect (method)
• field-keywords (method)
• foreign-bitfield (class)
• foreign-enum (class)
• hash-keys-to-list (function)
• keyword-values (method)
• make-foreign-bitfield (function)
• make-foreign-enum (function)
• parse-foreign-enum-like (function)
• value-keywords (method)

4.1.9 cffi/src/strings.lisp

Dependency

enum.lisp (file)

Parent

src (module)

Location

src/strings.lisp

Exported Definitions

• *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)
• 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)

Internal Definitions

• %foreign-string-length (macro)
• *foreign-string-mappings* (special variable)
• bget (macro)
• bset (macro)
• encoding (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 (method)
• fst-free-to-foreign-p (method)
• null-terminator-len (function)

4.1.10 cffi/src/structures.lisp

Dependency

strings.lisp (file)

Parent

src (module)

Location

src/structures.lisp

Exported Definitions

• 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)

4.1.11 cffi/src/functions.lisp

Dependency

structures.lisp (file)

Parent

src (module)

Location

src/functions.lisp

Exported Definitions

• callback (macro)
• defcallback (macro)
• defcfun (macro)
• 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-camelcase-name (method)
• translate-camelcase-name (method)
• translate-name-from-foreign (generic function)
• translate-name-from-foreign (method)
• translate-name-to-foreign (generic function)
• translate-name-to-foreign (method)
• translate-underscore-separated-name (generic function)
• translate-underscore-separated-name (method)
• translate-underscore-separated-name (method)

Internal Definitions

• %defcfun (function)
• %defcfun-varargs (function)
• %foreign-funcall-pointer-varargs (macro)
• %foreign-funcall-varargs (macro)
• %parse-name-and-options (function)
• *foreign-structures-by-value* (special variable)
• check-prefix (function)
• collapse-prefix (function)
• defcfun-helper-forms (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)

4.1.12 cffi/src/foreign-vars.lisp

Dependency

functions.lisp (file)

Parent

src (module)

Location

src/foreign-vars.lisp

Exported Definitions

• defcvar (macro)
• foreign-symbol-pointer (function)
• get-var-pointer (function)

Internal Definitions

• fs-pointer-or-lose (function)
• parse-defcvar-options (function)

4.1.13 cffi/src/features.lisp

Dependency

foreign-vars.lisp (file)

Parent

src (module)

Location

src/features.lisp

Packages

cffi-features

Exported Definitions

cffi-feature-p (function)

5 Packages

Packages are listed by definition order.

5.1 cffi-sys

Source

cffi-sbcl.lisp (file)

Use List

• sb-alien
• common-lisp

Used By List

cffi

Exported Definitions

• %callback (function)
• %close-foreign-library (function)
• %defcallback (macro)
• %foreign-alloc (function)
• %foreign-funcall (macro)
• %foreign-funcall-pointer (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 (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)

Internal Definitions

• %%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)

5.2 cffi

Source

package.lisp (file)

Use List

• babel-encodings
• cffi-sys
• common-lisp

Exported Definitions

• *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-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-from-foreign (method)
• expand-into-foreign-memory (generic function)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-into-foreign-memory (method)
• expand-to-foreign (generic function)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign (method)
• expand-to-foreign-dyn (generic function)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (method)
• expand-to-foreign-dyn (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-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-loaded-p (function)
• foreign-library-name (generic function)
• foreign-library-name (method)
• (setf foreign-library-name) (method)
• (setf foreign-library-name) (generic function)
• 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)
• foreign-slot-value (function)
• (setf foreign-slot-value) (setf expander)
• foreign-string-alloc (function)
• foreign-string-free (function)
• foreign-string-to-lisp (function)
• foreign-symbol-pointer (function)
• foreign-type-alignment (generic function)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-size (generic function)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• free-converted-object (function)
• free-translated-object (generic function)
• free-translated-object (method)
• free-translated-object (method)
• free-translated-object (method)
• free-translated-object (method)
• free-translated-object (method)
• 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)
• mem-aref (function)
• (setf mem-aref) (setf expander)
• mem-ref (compiler macro)
• mem-ref (function)
• (setf mem-ref) (setf expander)
• reload-foreign-libraries (function)
• translate-camelcase-name (generic function)
• translate-camelcase-name (method)
• translate-camelcase-name (method)
• translate-from-foreign (generic function)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-from-foreign (method)
• translate-into-foreign-memory (generic function)
• translate-into-foreign-memory (method)
• translate-into-foreign-memory (method)
• translate-into-foreign-memory (method)
• translate-into-foreign-memory (method)
• translate-into-foreign-memory (method)
• translate-name-from-foreign (generic function)
• translate-name-from-foreign (method)
• translate-name-to-foreign (generic function)
• translate-name-to-foreign (method)
• translate-to-foreign (generic function)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-to-foreign (method)
• translate-underscore-separated-name (generic function)
• translate-underscore-separated-name (method)
• translate-underscore-separated-name (method)
• 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)

Internal Definitions

• %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 (function)
• %foreign-funcall-pointer-varargs (macro)
• %foreign-funcall-varargs (macro)
• %foreign-library-spec (function)
• %foreign-string-length (macro)
• %parse-name-and-options (function)
• *cffi-feature-suffix-map* (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)
• *type-parsers* (special variable)
• +valid-enum-base-types+ (special variable)
• actual-type (generic function)
• actual-type (method)
• (setf actual-type) (method)
• (setf actual-type) (generic function)
• adjust-for-alignment (function)
• aggregate-struct-slot (class)
• aggregatep (generic function)
• aggregatep (method)
• aggregatep (method)
• aggregatep (method)
• aggregatep (method)
• alignment (generic function)
• alignment (method)
• (setf alignment) (method)
• (setf alignment) (generic function)
• allow-undeclared-values (generic function)
• allow-undeclared-values (method)
• array-element-size (function)
• bare-struct-type-p (generic function)
• bare-struct-type-p (method)
• bare-struct-type-p (method)
• bare-struct-type-p (method)
• bget (macro)
• bit-index->keyword (generic function)
• bit-index->keyword (method)
• bset (macro)
• c-namespace-name (type)
• canonicalize (generic function)
• canonicalize (method)
• canonicalize (method)
• canonicalize (method)
• canonicalize (method)
• 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)
• defcfun-helper-forms (function)
• defctype* (macro)
• define-built-in-foreign-type (macro)
• dimensions (generic function)
• dimensions (method)
• discard-docstring (macro)
• element-type (generic function)
• element-type (method)
• encoding (generic function)
• encoding (method)
• enhanced-foreign-type (class)
• enhanced-typedef (class)
• ensure-parsed-base-type (function)
• enum-key (type)
• expand-to-foreign-dyn-indirect (generic function)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• expand-to-foreign-dyn-indirect (method)
• explode-path-environment-variable (function)
• fallback-darwin-framework-directories (function)
• field-keywords (generic function)
• field-keywords (method)
• filter-pathname (function)
• find-darwin-framework (function)
• find-file (function)
• find-type-parser (function)
• (setf find-type-parser) (function)
• fl-error (function)
• fl-name (generic function)
• fl-name (method)
• 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 function)
• foreign-library-handle (method)
• (setf foreign-library-handle) (method)
• (setf foreign-library-handle) (generic function)
• 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 (method)
• foreign-struct-slot-pointer-form (generic function)
• foreign-struct-slot-pointer-form (method)
• foreign-struct-slot-set-form (generic function)
• foreign-struct-slot-set-form (method)
• foreign-struct-slot-set-form (method)
• foreign-struct-slot-value (generic function)
• foreign-struct-slot-value (method)
• (setf foreign-struct-slot-value) (method)
• foreign-struct-slot-value (method)
• (setf foreign-struct-slot-value) (method)
• (setf foreign-struct-slot-value) (generic function)
• foreign-struct-slot-value-form (generic function)
• foreign-struct-slot-value-form (method)
• foreign-struct-slot-value-form (method)
• 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 function)
• foreign-type-error/namespace (method)
• (setf foreign-type-error/namespace) (method)
• (setf foreign-type-error/namespace) (generic function)
• foreign-type-error/type-name (generic function)
• foreign-type-error/type-name (method)
• (setf foreign-type-error/type-name) (method)
• (setf foreign-type-error/type-name) (generic function)
• 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 function)
• fst-free-from-foreign-p (method)
• fst-free-to-foreign-p (generic function)
• fst-free-to-foreign-p (method)
• 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 function)
• keyword-values (method)
• 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 function)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• named-foreign-type (class)
• new-arg (generic function)
• new-arg (method)
• 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 function)
• old-arg (method)
• 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 function)
• pointer-type (method)
• (setf pointer-type) (method)
• (setf pointer-type) (generic function)
• 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 function)
• size (method)
• (setf size) (method)
• (setf size) (generic function)
• slot-count (generic function)
• slot-count (method)
• (setf slot-count) (method)
• (setf slot-count) (generic function)
• slot-name (generic function)
• slot-name (method)
• slot-offset (generic function)
• slot-offset (method)
• (setf slot-offset) (method)
• (setf slot-offset) (generic function)
• slot-type (generic function)
• slot-type (method)
• (setf slot-type) (method)
• (setf slot-type) (generic function)
• slots (generic function)
• slots (method)
• (setf slots) (method)
• (setf slots) (generic function)
• 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-aggregate-to-foreign (method)
• translate-aggregate-to-foreign (method)
• translate-objects (function)
• try-foreign-library-alternatives (function)
• type-keyword (generic function)
• type-keyword (method)
• (setf type-keyword) (method)
• (setf type-keyword) (generic function)
• undefine-foreign-type (function)
• undefined-foreign-type-error (function)
• undefined-foreign-type-error (condition)
• unparse-type (generic function)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparse-type (method)
• unparsed-type (generic function)
• unparsed-type (method)
• (setf unparsed-type) (method)
• (setf unparsed-type) (generic function)
• value-keywords (generic function)
• value-keywords (method)
• warn-if-kw-or-belongs-to-cl (function)
• warn-obsolete-argument (function)
• with-tentative-type-definition (macro)
• wrapper-from-c (generic function)
• wrapper-from-c (method)
• wrapper-to-c (generic function)
• wrapper-to-c (method)

5.3 cffi-features

Source

features.lisp (file)

Use List

common-lisp

Exported Definitions

cffi-feature-p (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *built-in-float-types*

List of real float types supported by CFFI.

Package

cffi

Source

types.lisp (file)

Special Variable: *built-in-foreign-types*

Package

cffi

Source

early-types.lisp (file)

Special Variable: *built-in-integer-types*

List of integer types supported by CFFI.

Package

cffi

Source

types.lisp (file)

Special Variable: *darwin-framework-directories*

List of directories where Frameworks are searched for.

Package

cffi

Source

libraries.lisp (file)

Special Variable: *default-foreign-encoding*

Default foreign encoding.

Package

cffi

Source

strings.lisp (file)

Special Variable: *foreign-library-directories*

List onto which user-defined library paths can be pushed.

Package

cffi

Source

libraries.lisp (file)

Special Variable: *other-builtin-types*

List of types other than integer or float built in to CFFI.

Package

cffi

Source

types.lisp (file)

6.1.2 Macros

Macro: %defcallback NAME RETTYPE ARG-NAMES ARG-TYPES BODY &key CONVENTION

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Macro: %foreign-funcall NAME ARGS &key LIBRARY CONVENTION

Perform a foreign function call, document it more later.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Macro: %foreign-funcall-pointer PTR ARGS &key CONVENTION

Funcall a pointer to a foreign function.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Macro: callback NAME

Package

cffi

Source

functions.lisp (file)

Macro: defbitfield NAME-AND-OPTIONS &body MASKS

Define an foreign enumerated type.

Package

cffi

Source

enum.lisp (file)

Macro: defcallback NAME-AND-OPTIONS RETURN-TYPE ARGS &body BODY

Package

cffi

Source

functions.lisp (file)

Macro: defcenum NAME-AND-OPTIONS &body ENUM-LIST

Define an foreign enumerated type.

Package

cffi

Source

enum.lisp (file)

Macro: defcfun NAME-AND-OPTIONS RETURN-TYPE &body ARGS

Defines a Lisp function that calls a foreign function.

Package

cffi

Source

functions.lisp (file)

Macro: defcstruct NAME-AND-OPTIONS &body FIELDS

Define the layout of a foreign structure.

Package

cffi

Source

types.lisp (file)

Macro: defctype NAME BASE-TYPE &optional DOCUMENTATION

Utility macro for simple C-like typedefs.

Package

cffi

Source

early-types.lisp (file)

Macro: defcunion NAME-AND-OPTIONS &body FIELDS

Define the layout of a foreign union.

Package

cffi

Source

types.lisp (file)

Macro: defcvar NAME-AND-OPTIONS TYPE &optional DOCUMENTATION

Define a foreign global variable.

Package

cffi

Source

foreign-vars.lisp (file)

Macro: define-c-struct-wrapper CLASS-AND-TYPE SUPERS &optional SLOTS

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.

Package

cffi

Source

types.lisp (file)

Macro: define-foreign-library NAME-AND-OPTIONS &body PAIRS

Defines a foreign library NAME that can be posteriorly used with the USE-FOREIGN-LIBRARY macro.

Package

cffi

Source

libraries.lisp (file)

Macro: define-foreign-type NAME SUPERS SLOTS &rest OPTIONS

Package

cffi

Source

early-types.lisp (file)

Macro: define-parse-method NAME LAMBDA-LIST &body BODY

Define a type parser on NAME and lists whose CAR is NAME.

Package

cffi

Source

early-types.lisp (file)

Macro: define-translation-method (OBJECT TYPE METHOD) &body BODY

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.

Package

cffi

Source

structures.lisp (file)

Macro: foreign-funcall NAME-AND-OPTIONS &rest ARGS

Wrapper around %FOREIGN-FUNCALL that translates its arguments.

Package

cffi

Source

functions.lisp (file)

Macro: foreign-funcall-pointer POINTER OPTIONS &rest ARGS

Package

cffi

Source

functions.lisp (file)

Macro: foreign-funcall-pointer-varargs POINTER OPTIONS FIXED-ARGS &rest VARARGS

Wrapper around %FOREIGN-FUNCALL-POINTER that translates its arguments and does type promotion for the variadic arguments.

Package

cffi

Source

functions.lisp (file)

Macro: foreign-funcall-varargs NAME-AND-OPTIONS FIXED-ARGS &rest VARARGS

Wrapper around %FOREIGN-FUNCALL that translates its arguments and does type promotion for the variadic arguments.

Package

cffi

Source

functions.lisp (file)

Macro: incf-pointer PLACE &optional OFFSET

Package

cffi

Source

types.lisp (file)

Macro: translation-forms-for-class CLASS TYPE-CLASS

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.

Package

cffi

Source

structures.lisp (file)

Macro: use-foreign-library NAME

Package

cffi

Source

libraries.lisp (file)

Macro: with-foreign-array (VAR LISP-ARRAY ARRAY-TYPE) &body BODY

Bind var to a foreign array containing lisp-array elements in body.

Package

cffi

Source

types.lisp (file)

Macro: with-foreign-object (VAR TYPE &optional COUNT) &body BODY

Bind VAR to a pointer to COUNT objects of TYPE during BODY. The buffer has dynamic extent and may be stack allocated.

Package

cffi

Source

types.lisp (file)

Macro: with-foreign-objects BINDINGS &body BODY

Package

cffi

Source

types.lisp (file)

Macro: with-foreign-pointer (VAR SIZE &optional SIZE-VAR) &body BODY

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.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Macro: with-foreign-pointer-as-string (VAR-OR-VARS SIZE &rest ARGS) &body 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.

Package

cffi

Source

strings.lisp (file)

Macro: with-foreign-slots (VARS PTR TYPE) &body BODY

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: slot-name - in which case slot-name will be bound to the value of the slot or: (:pointer slot-name) - in which case slot-name will be bound to the pointer to that slot.

Package

cffi

Source

types.lisp (file)

Macro: with-foreign-string (VAR-OR-VARS LISP-STRING &rest ARGS) &body BODY

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.

Package

cffi

Source

strings.lisp (file)

Macro: with-foreign-strings BINDINGS &body BODY

See WITH-FOREIGN-STRING’s documentation.

Package

cffi

Source

strings.lisp (file)

Macro: with-pointer-to-vector-data (PTR-VAR VECTOR) &body BODY

Bind PTR-VAR to a foreign pointer to the data in VECTOR.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

6.1.3 Compiler macros

Compiler Macro: %mem-ref PTR TYPE &optional OFFSET

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Compiler Macro: %mem-set VALUE PTR TYPE &optional OFFSET

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Compiler Macro: convert-from-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Compiler Macro: convert-into-foreign-memory VALUE TYPE PTR

Package

cffi

Source

early-types.lisp (file)

Compiler Macro: convert-to-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Compiler Macro: foreign-alloc TYPE &rest ARGS &key COUNT &allow-other-keys

Package

cffi

Source

types.lisp (file)

Compiler Macro: foreign-bitfield-symbols TYPE VALUE

Optimize for when TYPE and SYMBOLS are constant.

Package

cffi

Source

enum.lisp (file)

Compiler Macro: foreign-bitfield-value TYPE SYMBOLS

Optimize for when TYPE and SYMBOLS are constant.

Package

cffi

Source

enum.lisp (file)

Compiler Macro: foreign-slot-pointer PTR TYPE SLOT-NAME

Package

cffi

Source

types.lisp (file)

Compiler Macro: foreign-slot-value PTR TYPE SLOT-NAME

Optimizer for FOREIGN-SLOT-VALUE when TYPE is constant.

Package

cffi

Source

types.lisp (file)

Compiler Macro: inc-pointer POINTER OFFSET

Package

cffi-sys

Source

types.lisp (file)

Compiler Macro: mem-aptr PTR TYPE &optional INDEX

The pointer to the element.

Package

cffi

Source

types.lisp (file)

Compiler Macro: mem-aref PTR TYPE &optional INDEX

Compiler macro to open-code MEM-AREF when TYPE (and eventually INDEX).

Package

cffi

Source

types.lisp (file)

Compiler Macro: mem-ref PTR TYPE &optional OFFSET

Compiler macro to open-code MEM-REF when TYPE is constant.

Package

cffi

Source

types.lisp (file)

6.1.4 Functions

Function: %callback NAME

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %close-foreign-library HANDLE

Closes a foreign library.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %foreign-alloc SIZE

Allocate SIZE bytes on the heap and return a pointer.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %foreign-symbol-pointer NAME LIBRARY

Returns a pointer to a foreign symbol NAME.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %foreign-type-alignment TYPE-KEYWORD

Return the alignment in bytes of a foreign type.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %foreign-type-size TYPE-KEYWORD

Return the size in bytes of a foreign type.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %load-foreign-library NAME PATH

Load a foreign library.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %mem-ref PTR TYPE &optional OFFSET

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: %mem-set VALUE PTR TYPE &optional OFFSET

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: canonicalize-symbol-name-case NAME

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: cffi-feature-p FEATURE-EXPRESSION

Matches a FEATURE-EXPRESSION against those symbols in *FEATURES* that belong to the CFFI-FEATURES package.

Package

cffi-features

Source

features.lisp (file)

Function: close-foreign-library LIBRARY

Closes a foreign library.

Package

cffi

Source

libraries.lisp (file)

Function: convert-from-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Function: convert-into-foreign-memory VALUE TYPE PTR

Package

cffi

Source

early-types.lisp (file)

Function: convert-to-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Function: foreign-alloc TYPE &key INITIAL-ELEMENT INITIAL-CONTENTS COUNT NULL-TERMINATED-P

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.

Package

cffi

Source

types.lisp (file)

Function: foreign-aref PTR ARRAY-TYPE &rest INDEXES

Function: (setf foreign-aref) VALUE PTR ARRAY-TYPE &rest INDEXES

Package

cffi

Source

types.lisp (file)

Function: foreign-array-alloc ARRAY ARRAY-TYPE

Allocate a foreign array containing the elements of lisp array. The foreign array must be freed with foreign-array-free.

Package

cffi

Source

types.lisp (file)

Function: foreign-array-free PTR

Free a foreign array allocated by foreign-array-alloc.

Package

cffi

Source

types.lisp (file)

Function: foreign-array-to-lisp POINTER ARRAY-TYPE &rest MAKE-ARRAY-ARGS

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.

Package

cffi

Source

types.lisp (file)

Function: foreign-bitfield-symbol-list BITFIELD-TYPE

Return a list of SYMBOLS defined in BITFIELD-TYPE.

Package

cffi

Source

enum.lisp (file)

Function: foreign-bitfield-symbols TYPE VALUE

Convert an integer VALUE into a list of matching symbols according to the bitfield TYPE.

Package

cffi

Source

enum.lisp (file)

Function: foreign-bitfield-value TYPE SYMBOLS

Convert a list of symbols into an integer according to the TYPE bitfield.

Package

cffi

Source

enum.lisp (file)

Function: foreign-enum-keyword TYPE VALUE &key ERRORP

Convert an integer VALUE into a keyword according to the enum TYPE.

Package

cffi

Source

enum.lisp (file)

Function: foreign-enum-keyword-list ENUM-TYPE

Return a list of KEYWORDS defined in ENUM-TYPE.

Package

cffi

Source

enum.lisp (file)

Function: foreign-enum-value TYPE KEYWORD &key ERRORP

Convert a KEYWORD into an integer according to the enum TYPE.

Package

cffi

Source

enum.lisp (file)

Function: foreign-free PTR

Free a PTR allocated by FOREIGN-ALLOC.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: foreign-library-loaded-p LIB

Package

cffi

Source

libraries.lisp (file)

Function: foreign-library-pathname LIB

Package

cffi

Source

libraries.lisp (file)

Function: foreign-library-type LIB

Package

cffi

Source

libraries.lisp (file)

Function: foreign-slot-count TYPE SLOT-NAME

Return the number of items in SLOT in a struct TYPE.

Package

cffi

Source

types.lisp (file)

Function: foreign-slot-names TYPE

Returns a list of TYPE’s slot names in no particular order.

Package

cffi

Source

types.lisp (file)

Function: foreign-slot-offset TYPE SLOT-NAME

Return the offset of SLOT in a struct TYPE.

Package

cffi

Source

types.lisp (file)

Function: foreign-slot-pointer PTR TYPE SLOT-NAME

Return the address of SLOT-NAME in the structure at PTR.

Package

cffi

Source

types.lisp (file)

Function: foreign-slot-type TYPE SLOT-NAME

Return the type of SLOT in a struct TYPE.

Package

cffi

Source

types.lisp (file)

Function: foreign-slot-value PTR TYPE SLOT-NAME

Return the value of SLOT-NAME in the foreign structure at PTR.

Package

cffi

Source

types.lisp (file)

Setf Expander

(setf foreign-slot-value) (setf expander)

Setf Expander: (setf foreign-slot-value) PTR TYPE SLOT-NAME

SETF expander for FOREIGN-SLOT-VALUE.

Package

cffi

Source

types.lisp (file)

Reader

foreign-slot-value (function)

Function: foreign-string-alloc STRING &key ENCODING NULL-TERMINATED-P START END

Allocate a foreign string containing Lisp string STRING. The string must be freed with FOREIGN-STRING-FREE.

Package

cffi

Source

strings.lisp (file)

Function: foreign-string-free PTR

Free a foreign string allocated by FOREIGN-STRING-ALLOC.

Package

cffi

Source

strings.lisp (file)

Function: foreign-string-to-lisp POINTER &key OFFSET COUNT MAX-CHARS ENCODING

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.

Package

cffi

Source

strings.lisp (file)

Function: foreign-symbol-pointer NAME &key LIBRARY

Package

cffi

Source

foreign-vars.lisp (file)

Function: free-converted-object VALUE TYPE PARAM

Package

cffi

Source

early-types.lisp (file)

Function: get-callback SYMBOL

Package

cffi

Source

functions.lisp (file)

Function: get-var-pointer SYMBOL

Return a pointer to the foreign global variable relative to SYMBOL.

Package

cffi

Source

foreign-vars.lisp (file)

Function: inc-pointer PTR OFFSET

Return a pointer pointing OFFSET bytes past PTR.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: lisp-array-to-foreign ARRAY POINTER ARRAY-TYPE

Copy elements from a Lisp array to POINTER. ARRAY-TYPE must be a CFFI array type.

Package

cffi

Source

types.lisp (file)

Function: lisp-string-to-foreign STRING BUFFER BUFSIZE &key START END OFFSET ENCODING

Package

cffi

Source

strings.lisp (file)

Function: list-foreign-libraries &key LOADED-ONLY TYPE

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.

Package

cffi

Source

libraries.lisp (file)

Function: load-foreign-library LIBRARY &key SEARCH-PATH

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>).

Package

cffi

Source

libraries.lisp (file)

Function: make-pointer ADDRESS

Return a pointer pointing to ADDRESS.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: make-shareable-byte-vector SIZE

Create a Lisp vector of SIZE bytes that can be passed to WITH-POINTER-TO-VECTOR-DATA.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: mem-aptr PTR TYPE &optional INDEX

The pointer to the element.

Package

cffi

Source

types.lisp (file)

Function: mem-aref PTR TYPE &optional INDEX

Like MEM-REF except for accessing 1d arrays.

Package

cffi

Source

types.lisp (file)

Setf Expander

(setf mem-aref) (setf expander)

Setf Expander: (setf mem-aref) PTR TYPE &optional INDEX

SETF expander for MEM-AREF.

Package

cffi

Source

types.lisp (file)

Reader

mem-aref (function)

Function: mem-ref PTR TYPE &optional OFFSET

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.

Package

cffi

Source

types.lisp (file)

Setf Expander

(setf mem-ref) (setf expander)

Setf Expander: (setf mem-ref) PTR TYPE &optional OFFSET

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.

Package

cffi

Source

types.lisp (file)

Reader

mem-ref (function)

Function: native-namestring PATHNAME

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: null-pointer ()

Construct and return a null pointer.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: null-pointer-p PTR

Return true if PTR is a null pointer.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: pointer-address PTR

Return the address pointed to by PTR.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: pointer-eq PTR1 PTR2

Return true if PTR1 and PTR2 point to the same address.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: pointerp PTR

Return true if PTR is a foreign pointer.

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Function: reload-foreign-libraries &key TEST

(Re)load all currently loaded foreign libraries.

Package

cffi

Source

libraries.lisp (file)

6.1.5 Generic functions

Generic Function: expand-from-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Methods

Method: expand-from-foreign VALUE (TYPE foreign-bitfield)

Source

enum.lisp (file)

Method: expand-from-foreign VALUE (TYPE foreign-boolean-type)

Optimization for the :boolean type.

Source

types.lisp (file)

Method: expand-from-foreign VALUE (TYPE enhanced-typedef)

Method: expand-from-foreign VALUE (TYPE translatable-foreign-type)

Method: expand-from-foreign VALUE (TYPE translatable-foreign-type) around

Method: expand-from-foreign VALUE TYPE

Generic Function: expand-into-foreign-memory VALUE TYPE PTR

Package

cffi

Source

early-types.lisp (file)

Methods

Method: expand-into-foreign-memory VALUE (TYPE enhanced-typedef) PTR

Method: expand-into-foreign-memory VALUE (TYPE translatable-foreign-type) PTR

Method: expand-into-foreign-memory VALUE (TYPE translatable-foreign-type) PTR around

Method: expand-into-foreign-memory VALUE TYPE PTR

Generic Function: expand-to-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Methods

Method: expand-to-foreign VALUE (TYPE foreign-bitfield)

Source

enum.lisp (file)

Method: expand-to-foreign VALUE (TYPE foreign-enum)

Source

enum.lisp (file)

Method: expand-to-foreign VALUE (TYPE foreign-boolean-type)

Optimization for the :boolean type.

Source

types.lisp (file)

Method: expand-to-foreign VALUE (TYPE enhanced-typedef)

Method: expand-to-foreign VALUE (TYPE translatable-foreign-type)

Method: expand-to-foreign VALUE (TYPE translatable-foreign-type) around

Method: expand-to-foreign VALUE TYPE

Generic Function: expand-to-foreign-dyn VALUE VAR BODY TYPE

Package

cffi

Source

early-types.lisp (file)

Methods

Method: expand-to-foreign-dyn VALUE VAR BODY (TYPE enhanced-typedef)

Method: expand-to-foreign-dyn VALUE VAR BODY (TYPE enhanced-foreign-type)

Method: expand-to-foreign-dyn VALUE VAR BODY (TYPE enhanced-foreign-type) around

Method: expand-to-foreign-dyn VALUE VAR BODY TYPE

Generic Function: foreign-library-name OBJECT

Generic Function: (setf foreign-library-name) NEW-VALUE OBJECT

Package

cffi

Methods

Method: foreign-library-name (FOREIGN-LIBRARY foreign-library)

automatically generated reader method

Source

libraries.lisp (file)

Method: (setf foreign-library-name) NEW-VALUE (FOREIGN-LIBRARY foreign-library)

automatically generated writer method

Source

libraries.lisp (file)

Generic Function: foreign-type-alignment FOREIGN-TYPE

Return the structure alignment in bytes of a foreign type.

Package

cffi

Source

early-types.lisp (file)

Methods

Method: foreign-type-alignment TYPE

Return the alignment in bytes of a foreign type.

Source

types.lisp (file)

Method: foreign-type-alignment (TYPE foreign-array-type)

Source

types.lisp (file)

Method: foreign-type-alignment (TYPE foreign-type-alias)

Return the alignment of a foreign typedef.

Method: foreign-type-alignment (TYPE foreign-struct-type)

Return the alignment requirements for this struct.

Method: foreign-type-alignment (TYPE foreign-built-in-type)

Return the alignment of a built-in type.

Generic Function: foreign-type-size FOREIGN-TYPE

Return the size in bytes of a foreign type.

Package

cffi

Source

early-types.lisp (file)

Methods

Method: foreign-type-size (TYPE foreign-array-type)

Source

types.lisp (file)

Method: foreign-type-size (TYPE foreign-type-alias)

Return the size in bytes of a foreign typedef.

Method: foreign-type-size (TYPE foreign-struct-type)

Return the size in bytes of a foreign structure type.

Method: foreign-type-size (TYPE foreign-built-in-type)

Return the size of a built-in type.

Method: foreign-type-size TYPE

Return the size in bytes of a foreign type.

Generic Function: free-translated-object VALUE TYPE PARAM

Package

cffi

Source

early-types.lisp (file)

Methods

Method: free-translated-object PTR (TYPE foreign-struct-type) FREEP

Source

structures.lisp (file)

Method: free-translated-object PTR (TYPE foreign-string-type) FREE-P

Source

strings.lisp (file)

Method: free-translated-object POINTER (TYPE foreign-array-type) PARAM

Source

types.lisp (file)

Method: free-translated-object VALUE (TYPE enhanced-typedef) PARAM

Method: free-translated-object VALUE TYPE PARAM

Generic Function: translate-camelcase-name NAME &key UPPER-INITIAL-P SPECIAL-WORDS

Package

cffi

Source

functions.lisp (file)

Methods

Method: translate-camelcase-name (NAME string) &key UPPER-INITIAL-P SPECIAL-WORDS

Method: translate-camelcase-name (NAME symbol) &key UPPER-INITIAL-P SPECIAL-WORDS

Generic Function: translate-from-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Methods

Method: translate-from-foreign P (TYPE foreign-struct-type)

Source

structures.lisp (file)

Method: translate-from-foreign VALUE (TYPE foreign-string+ptr-type)

Source

strings.lisp (file)

Method: translate-from-foreign PTR (TYPE foreign-string-type)

Source

strings.lisp (file)

Method: translate-from-foreign VALUE (TYPE foreign-bitfield)

Source

enum.lisp (file)

Method: translate-from-foreign VALUE (TYPE foreign-enum)

Source

enum.lisp (file)

Method: translate-from-foreign VALUE (TYPE foreign-boolean-type)

Source

types.lisp (file)

Method: translate-from-foreign VALUE (TYPE foreign-type-wrapper)

Source

types.lisp (file)

Method: translate-from-foreign POINTER (TYPE foreign-array-type)

Source

types.lisp (file)

Method: translate-from-foreign VALUE (TYPE enhanced-typedef)

Method: translate-from-foreign VALUE TYPE

Generic Function: translate-into-foreign-memory VALUE TYPE POINTER

Translate the Lisp value into the foreign memory location given by pointer. Return value is not used.

Package

cffi

Source

early-types.lisp (file)

Methods

Method: translate-into-foreign-memory (OBJECT list) (TYPE foreign-struct-type) P

Source

structures.lisp (file)

Method: translate-into-foreign-memory VALUE (TYPE foreign-enum) POINTER

Source

enum.lisp (file)

Method: translate-into-foreign-memory VALUE (TYPE foreign-built-in-type) POINTER

Source

types.lisp (file)

Method: translate-into-foreign-memory VALUE (TYPE foreign-pointer-type) POINTER

Source

types.lisp (file)

Method: translate-into-foreign-memory VALUE (TYPE enhanced-typedef) POINTER

Generic Function: translate-name-from-foreign FOREIGN-NAME PACKAGE &optional VARP

Package

cffi

Source

functions.lisp (file)

Methods

Method: translate-name-from-foreign FOREIGN-NAME PACKAGE &optional VARP

Generic Function: translate-name-to-foreign LISP-NAME PACKAGE &optional VARP

Package

cffi

Source

functions.lisp (file)

Methods

Method: translate-name-to-foreign LISP-NAME PACKAGE &optional VARP

Generic Function: translate-to-foreign VALUE TYPE

Package

cffi

Source

early-types.lisp (file)

Methods

Method: translate-to-foreign VALUE (TYPE foreign-struct-type)

Source

structures.lisp (file)

Method: translate-to-foreign OBJ (TYPE foreign-string-type)

Source

strings.lisp (file)

Method: translate-to-foreign (S string) (TYPE foreign-string-type)

Source

strings.lisp (file)

Method: translate-to-foreign VALUE (TYPE foreign-bitfield)

Source

enum.lisp (file)

Method: translate-to-foreign VALUE (TYPE foreign-enum)

Source

enum.lisp (file)

Method: translate-to-foreign VALUE (TYPE foreign-boolean-type)

Source

types.lisp (file)

Method: translate-to-foreign VALUE (TYPE foreign-type-wrapper)

Source

types.lisp (file)

Method: translate-to-foreign ARRAY (TYPE foreign-array-type)

Source

types.lisp (file)

Method: translate-to-foreign VALUE (TYPE enhanced-typedef)

Method: translate-to-foreign VALUE TYPE

Generic Function: translate-underscore-separated-name NAME

Package

cffi

Source

functions.lisp (file)

Methods

Method: translate-underscore-separated-name (NAME string)

Method: translate-underscore-separated-name (NAME symbol)

6.1.6 Conditions

Condition: load-foreign-library-error ()

Package

cffi

Source

libraries.lisp (file)

Direct superclasses

simple-error (condition)

6.1.7 Classes

Class: foreign-library ()

Package

cffi

Source

libraries.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• print-object (method)
• foreign-library-handle (method)
• foreign-library-handle (method)
• foreign-library-name (method)
• foreign-library-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

foreign-library-name (generic function)

Writers

(setf foreign-library-name) (generic function)

Slot: type

Initargs

:type

Initform

:system

Slot: spec

Initargs

:spec

Slot: options

Initargs

:options

Slot: handle

Initargs

:handle

Readers

foreign-library-handle (generic function)

Writers

(setf foreign-library-handle) (generic function)

Slot: pathname

6.1.8 Types

Type: foreign-pointer ()

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *callbacks*

Package

cffi-sys

Source

cffi-sbcl.lisp (file)

Special Variable: *cffi-feature-suffix-map*

Mapping of OS feature keywords to shared library suffixes.

Package

cffi

Source

libraries.lisp (file)

Special Variable: *defcstruct-hook*

Package

cffi

Source

types.lisp (file)

Special Variable: *foreign-libraries*

Hashtable of defined libraries.

Package

cffi

Source

libraries.lisp (file)