4.1.1 cffi/cffi.asd

Source

cffi.asd.

Parent Component

cffi (system).

ASDF Systems

cffi.

---

4.1.2 cffi/src/cffi-sbcl.lisp

Source

cffi.asd.

Parent Component

src (module).

Packages

cffi-sys.

Public Interface

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

Internals

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

Source

cffi.asd.

Parent Component

src (module).

Packages

cffi.

---

4.1.4 cffi/src/utils.lisp

Dependency

package.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Internals

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

---

4.1.5 cffi/src/libraries.lisp

Dependency

utils.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.6 cffi/src/early-types.lisp

Dependency

libraries.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.7 cffi/src/types.lisp

Dependency

early-types.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.8 cffi/src/enum.lisp

Dependency

types.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.9 cffi/src/strings.lisp

Dependency

enum.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.10 cffi/src/structures.lisp

Dependency

strings.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Source

cffi.asd.

Parent Component

src (module).

Public Interface

• 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-name-from-foreign (generic function).
• translate-name-to-foreign (generic function).
• translate-underscore-separated-name (generic function).

Internals

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

Source

cffi.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

4.1.13 cffi/src/features.lisp

Dependency

foreign-vars.lisp (file).

Source

cffi.asd.

Parent Component

src (module).

Packages

cffi-features.

Public Interface

cffi-feature-p (function).

---

6.1.1 Special variables

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

List of real float types supported by CFFI.

Package

cffi.

Source

types.lisp.

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

Package

cffi.

Source

early-types.lisp.

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

List of integer types supported by CFFI.

Package

cffi.

Source

types.lisp.

Special Variable: *darwin-framework-directories* ¶

List of directories where Frameworks are searched for.

Package

cffi.

Source

libraries.lisp.

Special Variable: *default-foreign-encoding* ¶

Default foreign encoding.

Package

cffi.

Source

strings.lisp.

Special Variable: *foreign-library-directories* ¶

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

Package

cffi.

Source

libraries.lisp.

Special Variable: *other-builtin-types* ¶

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

Package

cffi.

Source

types.lisp.

---

6.1.2 Macros

Macro: %defcallback (name rettype arg-names arg-types body &key convention) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Macro: %foreign-funcall (name args &key library convention) ¶

Perform a foreign function call, document it more later.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Macro: %foreign-funcall-pointer (ptr args &key convention) ¶

Funcall a pointer to a foreign function.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Macro: callback (name) ¶

Package

cffi.

Source

functions.lisp.

Macro: defbitfield (name-and-options &body masks) ¶

Define an foreign enumerated type.

Package

cffi.

Source

enum.lisp.

Macro: defcallback (name-and-options return-type args &body body) ¶

Package

cffi.

Source

functions.lisp.

Macro: defcenum (name-and-options &body enum-list) ¶

Define an foreign enumerated type.

Package

cffi.

Source

enum.lisp.

Macro: defcfun (name-and-options return-type &body args) ¶

Defines a Lisp function that calls a foreign function.

Package

cffi.

Source

functions.lisp.

Macro: defcstruct (name-and-options &body fields) ¶

Define the layout of a foreign structure.

Package

cffi.

Source

types.lisp.

Macro: defctype (name base-type &optional documentation) ¶

Utility macro for simple C-like typedefs.

Package

cffi.

Source

early-types.lisp.

Macro: defcunion (name-and-options &body fields) ¶

Define the layout of a foreign union.

Package

cffi.

Source

types.lisp.

Macro: defcvar (name-and-options type &optional documentation) ¶

Define a foreign global variable.

Package

cffi.

Source

foreign-vars.lisp.

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.

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.

Macro: define-foreign-type (name supers slots &rest options) ¶

Package

cffi.

Source

early-types.lisp.

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.

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.

Macro: foreign-funcall (name-and-options &rest args) ¶

Wrapper around %FOREIGN-FUNCALL that translates its arguments.

Package

cffi.

Source

functions.lisp.

Macro: foreign-funcall-pointer (pointer options &rest args) ¶

Package

cffi.

Source

functions.lisp.

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.

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.

Macro: incf-pointer (place &optional offset) ¶

Package

cffi.

Source

types.lisp.

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.

Macro: use-foreign-library (name) ¶

Package

cffi.

Source

libraries.lisp.

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.

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.

Macro: with-foreign-objects (bindings &body body) ¶

Package

cffi.

Source

types.lisp.

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.

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.

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.

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.

Macro: with-foreign-strings (bindings &body body) ¶

See WITH-FOREIGN-STRING’s documentation.

Package

cffi.

Source

strings.lisp.

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.

---

6.1.3 Compiler macros

Compiler Macro: %mem-ref (ptr type &optional offset) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Compiler Macro: %mem-set (value ptr type &optional offset) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Compiler Macro: convert-from-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Compiler Macro: convert-into-foreign-memory (value type ptr) ¶

Package

cffi.

Source

early-types.lisp.

Compiler Macro: convert-to-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Compiler Macro: foreign-alloc (type &rest args &key count &allow-other-keys) ¶

Package

cffi.

Source

types.lisp.

Compiler Macro: foreign-bitfield-symbols (type value) ¶

Optimize for when TYPE and SYMBOLS are constant.

Package

cffi.

Source

enum.lisp.

Compiler Macro: foreign-bitfield-value (type symbols) ¶

Optimize for when TYPE and SYMBOLS are constant.

Package

cffi.

Source

enum.lisp.

Compiler Macro: foreign-slot-pointer (ptr type slot-name) ¶

Package

cffi.

Source

types.lisp.

Compiler Macro: foreign-slot-value (ptr type slot-name) ¶

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

Package

cffi.

Source

types.lisp.

Compiler Macro: inc-pointer (pointer offset) ¶

Package

cffi-sys.

Source

types.lisp.

Compiler Macro: mem-aptr (ptr type &optional index) ¶

The pointer to the element.

Package

cffi.

Source

types.lisp.

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.

Compiler Macro: mem-ref (ptr type &optional offset) ¶

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

Package

cffi.

Source

types.lisp.

---

6.1.4 Setf expanders

Setf Expander: (setf foreign-slot-value) (ptr type slot-name) ¶

SETF expander for FOREIGN-SLOT-VALUE.

Package

cffi.

Source

types.lisp.

Reader

foreign-slot-value (function).

Setf Expander: (setf mem-aref) (ptr type &optional index) ¶

SETF expander for MEM-AREF.

Package

cffi.

Source

types.lisp.

Reader

mem-aref (function).

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.

Reader

mem-ref (function).

---

6.1.5 Ordinary functions

Function: %callback (name) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %close-foreign-library (handle) ¶

Closes a foreign library.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %foreign-alloc (size) ¶

Allocate SIZE bytes on the heap and return a pointer.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %foreign-symbol-pointer (name library) ¶

Returns a pointer to a foreign symbol NAME.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %foreign-type-alignment (type-keyword) ¶

Return the alignment in bytes of a foreign type.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %foreign-type-size (type-keyword) ¶

Return the size in bytes of a foreign type.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %load-foreign-library (name path) ¶

Load a foreign library.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %mem-ref (ptr type &optional offset) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: %mem-set (value ptr type &optional offset) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: canonicalize-symbol-name-case (name) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

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.

Function: close-foreign-library (library) ¶

Closes a foreign library.

Package

cffi.

Source

libraries.lisp.

Function: convert-from-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Function: convert-into-foreign-memory (value type ptr) ¶

Package

cffi.

Source

early-types.lisp.

Function: convert-to-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

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.

Function: foreign-aref (ptr array-type &rest indexes) ¶

Package

cffi.

Source

types.lisp.

Function: (setf foreign-aref) (ptr array-type &rest indexes) ¶

Package

cffi.

Source

types.lisp.

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.

Function: foreign-array-free (ptr) ¶

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

Package

cffi.

Source

types.lisp.

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.

Function: foreign-bitfield-symbol-list (bitfield-type) ¶

Return a list of SYMBOLS defined in BITFIELD-TYPE.

Package

cffi.

Source

enum.lisp.

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.

Function: foreign-bitfield-value (type symbols) ¶

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

Package

cffi.

Source

enum.lisp.

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.

Function: foreign-enum-keyword-list (enum-type) ¶

Return a list of KEYWORDS defined in ENUM-TYPE.

Package

cffi.

Source

enum.lisp.

Function: foreign-enum-value (type keyword &key errorp) ¶

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

Package

cffi.

Source

enum.lisp.

Function: foreign-free (ptr) ¶

Free a PTR allocated by FOREIGN-ALLOC.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: foreign-library-loaded-p (lib) ¶

Package

cffi.

Source

libraries.lisp.

Function: foreign-library-pathname (lib) ¶

Package

cffi.

Source

libraries.lisp.

Function: foreign-library-type (lib) ¶

Package

cffi.

Source

libraries.lisp.

Function: foreign-slot-count (type slot-name) ¶

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

Package

cffi.

Source

types.lisp.

Function: foreign-slot-names (type) ¶

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

Package

cffi.

Source

types.lisp.

Function: foreign-slot-offset (type slot-name) ¶

Return the offset of SLOT in a struct TYPE.

Package

cffi.

Source

types.lisp.

Function: foreign-slot-pointer (ptr type slot-name) ¶

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

Package

cffi.

Source

types.lisp.

Function: foreign-slot-type (type slot-name) ¶

Return the type of SLOT in a struct TYPE.

Package

cffi.

Source

types.lisp.

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.

Setf expander for this function

(setf foreign-slot-value).

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.

Function: foreign-string-free (ptr) ¶

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

Package

cffi.

Source

strings.lisp.

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.

Function: foreign-symbol-pointer (name &key library) ¶

Package

cffi.

Source

foreign-vars.lisp.

Function: free-converted-object (value type param) ¶

Package

cffi.

Source

early-types.lisp.

Function: get-callback (symbol) ¶

Package

cffi.

Source

functions.lisp.

Function: get-var-pointer (symbol) ¶

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

Package

cffi.

Source

foreign-vars.lisp.

Function: inc-pointer (ptr offset) ¶

Return a pointer pointing OFFSET bytes past PTR.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

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.

Function: lisp-string-to-foreign (string buffer bufsize &key start end offset encoding) ¶

Package

cffi.

Source

strings.lisp.

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.

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

Package

cffi.

Source

libraries.lisp.

Function: make-pointer (address) ¶

Return a pointer pointing to ADDRESS.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

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.

Function: mem-aptr (ptr type &optional index) ¶

The pointer to the element.

Package

cffi.

Source

types.lisp.

Function: mem-aref (ptr type &optional index) ¶

Like MEM-REF except for accessing 1d arrays.

Package

cffi.

Source

types.lisp.

Setf expander for this function

(setf mem-aref).

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.

Setf expander for this function

(setf mem-ref).

Function: native-namestring (pathname) ¶

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: null-pointer () ¶

Construct and return a null pointer.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: null-pointer-p (ptr) ¶

Return true if PTR is a null pointer.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: pointer-address (ptr) ¶

Return the address pointed to by PTR.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: pointer-eq (ptr1 ptr2) ¶

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

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: pointerp (ptr) ¶

Return true if PTR is a foreign pointer.

Package

cffi-sys.

Source

cffi-sbcl.lisp.

Function: reload-foreign-libraries (&key test) ¶

(Re)load all currently loaded foreign libraries.

Package

cffi.

Source

libraries.lisp.

---

6.1.6 Generic functions

Generic Function: expand-from-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Methods

Method: expand-from-foreign (value (type foreign-bitfield)) ¶

Source

enum.lisp.

Method: expand-from-foreign (value (type foreign-boolean-type)) ¶

Optimization for the :boolean type.

Source

types.lisp.

Method: expand-from-foreign (value (type enhanced-typedef)) ¶

Method: expand-from-foreign (value (type translatable-foreign-type)) ¶

Method: expand-from-foreign :around (value (type translatable-foreign-type)) ¶

Method: expand-from-foreign (value type) ¶

Generic Function: expand-into-foreign-memory (value type ptr) ¶

Package

cffi.

Source

early-types.lisp.

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 :around (value (type translatable-foreign-type) ptr) ¶

Method: expand-into-foreign-memory (value type ptr) ¶

Generic Function: expand-to-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Methods

Method: expand-to-foreign (value (type foreign-bitfield)) ¶

Source

enum.lisp.

Method: expand-to-foreign (value (type foreign-enum)) ¶

Source

enum.lisp.

Method: expand-to-foreign (value (type foreign-boolean-type)) ¶

Optimization for the :boolean type.

Source

types.lisp.

Method: expand-to-foreign (value (type enhanced-typedef)) ¶

Method: expand-to-foreign (value (type translatable-foreign-type)) ¶

Method: expand-to-foreign :around (value (type translatable-foreign-type)) ¶

Method: expand-to-foreign (value type) ¶

Generic Function: expand-to-foreign-dyn (value var body type) ¶

Package

cffi.

Source

early-types.lisp.

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 :around (value var body (type enhanced-foreign-type)) ¶

Method: expand-to-foreign-dyn (value var body type) ¶

Generic Reader: foreign-library-load-state (object) ¶

Package

cffi.

Methods

Reader Method: foreign-library-load-state ((foreign-library foreign-library)) ¶

automatically generated reader method

Source

libraries.lisp.

Target Slot

load-state.

Generic Writer: (setf foreign-library-load-state) (object) ¶

Package

cffi.

Methods

Writer Method: (setf foreign-library-load-state) ((foreign-library foreign-library)) ¶

automatically generated writer method

Source

libraries.lisp.

Target Slot

load-state.

Generic Reader: foreign-library-name (object) ¶

Package

cffi.

Methods

Reader Method: foreign-library-name ((foreign-library foreign-library)) ¶

automatically generated reader method

Source

libraries.lisp.

Target Slot

name.

Generic Writer: (setf foreign-library-name) (object) ¶

Package

cffi.

Methods

Writer Method: (setf foreign-library-name) ((foreign-library foreign-library)) ¶

automatically generated writer method

Source

libraries.lisp.

Target Slot

name.

Generic Function: foreign-type-alignment (foreign-type) ¶

Return the structure alignment in bytes of a foreign type.

Package

cffi.

Source

early-types.lisp.

Methods

Method: foreign-type-alignment (type) ¶

Return the alignment in bytes of a foreign type.

Source

types.lisp.

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

Source

types.lisp.

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.

Methods

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

Source

types.lisp.

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.

Methods

Method: free-translated-object (ptr (type foreign-struct-type) freep) ¶

Source

structures.lisp.

Method: free-translated-object (ptr (type foreign-string-type) free-p) ¶

Source

strings.lisp.

Method: free-translated-object (pointer (type foreign-array-type) param) ¶

Source

types.lisp.

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.

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.

Methods

Method: translate-from-foreign (p (type foreign-struct-type)) ¶

Source

structures.lisp.

Method: translate-from-foreign (value (type foreign-string+ptr-type)) ¶

Source

strings.lisp.

Method: translate-from-foreign (ptr (type foreign-string-type)) ¶

Source

strings.lisp.

Method: translate-from-foreign (value (type foreign-bitfield)) ¶

Source

enum.lisp.

Method: translate-from-foreign (value (type foreign-enum)) ¶

Source

enum.lisp.

Method: translate-from-foreign (value (type foreign-boolean-type)) ¶

Source

types.lisp.

Method: translate-from-foreign (value (type foreign-type-wrapper)) ¶

Source

types.lisp.

Method: translate-from-foreign (pointer (type foreign-array-type)) ¶

Source

types.lisp.

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.

Methods

Method: translate-into-foreign-memory ((object list) (type foreign-struct-type) p) ¶

Source

structures.lisp.

Method: translate-into-foreign-memory (value (type foreign-enum) pointer) ¶

Source

enum.lisp.

Method: translate-into-foreign-memory (value (type foreign-built-in-type) pointer) ¶

Source

types.lisp.

Method: translate-into-foreign-memory (value (type foreign-pointer-type) pointer) ¶

Source

types.lisp.

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.

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.

Methods

Method: translate-name-to-foreign (lisp-name package &optional varp) ¶

Generic Function: translate-to-foreign (value type) ¶

Package

cffi.

Source

early-types.lisp.

Methods

Method: translate-to-foreign (value (type foreign-struct-type)) ¶

Source

structures.lisp.

Method: translate-to-foreign (obj (type foreign-string-type)) ¶

Source

strings.lisp.

Method: translate-to-foreign ((s string) (type foreign-string-type)) ¶

Source

strings.lisp.

Method: translate-to-foreign (value (type foreign-bitfield)) ¶

Source

enum.lisp.

Method: translate-to-foreign (value (type foreign-enum)) ¶

Source

enum.lisp.

Method: translate-to-foreign (value (type foreign-boolean-type)) ¶

Source

types.lisp.

Method: translate-to-foreign (value (type foreign-type-wrapper)) ¶

Source

types.lisp.

Method: translate-to-foreign (array (type foreign-array-type)) ¶

Source

types.lisp.

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.

Methods

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

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

---