The claw Reference Manual

Table of Contents

The claw Reference Manual

This is the claw Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 09:56:04 2019 GMT+0.

1 Introduction

claw

Common Lisp autowrapping facility for quickly creating bindings to foreign libraries with C-compatible ABI interface.

cl-autowrap relationship

This is a fork of awesome cl-autowrap library streamlined for making simple wrappers over C libraries.

Differences

Feature | cl-autowrap | claw | --------|---------------|--------| Foreign symbols | Included by default | Excluded by default | Struct-by-value | via libffi | via autogenerated C wrapper | Foreign symbols filtering | compile time | .spec generation time | .spec formatting | pretty-printed VCS friendly | compact | Foreign types introspection | yes | no | Default platforms | many | x86_64/i686 GNU/Linux, macOS, Windows | CL<->C string autoconversion | yes | no |

claw pros over cl-autowrap:

• simplified interface
• cleaner resulting wrapper due to default filtering rule
• faster invocation of functions that pass structs/unions by value
• small .spec size
• tailored to work in GNU environments on Windows (msys2), GNU/Linux and macOS
• maintained by borodust

claw cons:

• maintained by borodust
• maintained by borodust
• not maintained by rpav
• needs C wrapper for struct-by-value functions

Example

Please, have a look at bodge-chipmunk wrapper.

2 Systems

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

2.1 claw

Author

Ryan Pavlik, Pavel Korolev

License

BSD-2-Clause

Description

Import c2ffi specs and generate CFFI wrappers

Version

1.0

Dependencies

• alexandria
• cffi
• cl-json
• cl-ppcre
• uiop
• trivial-features

Source

claw.asd (file)

Components

• package.lisp (file)
• util.lisp (file)
• conditions.lisp (file)
• c2ffi.lisp (file)
• wrapper.lisp (file)
• sffi.lisp (file)
• alloc.lisp (file)
• errno.lisp (file)
• processing.lisp (file)
• parse.lisp (file)
• bitmask.lisp (file)
• cbv.lisp (file)
• bodged.lisp (file)
• plus-c.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 claw.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/claw-stable-9877cb7d-git/claw.asd

Systems

claw (system)

3.1.2 claw/package.lisp

Parent

claw (system)

Location

package.lisp

Packages

claw

3.1.3 claw/util.lisp

Dependency

package.lisp (file)

Parent

claw (system)

Location

util.lisp

Exported Definitions

• by-changing (function)
• by-removing-complex-prefix (function)
• by-removing-prefixes (function)
• in-pipeline (function)
• with-float-traps-masked (macro)

Internal Definitions

• +byte-size+ (constant)
• akey (function)
• alist-bind (macro)
• anonymous-p (function)
• asdf-path (function)
• aval (function)
• (setf aval) (function)
• by-removing-prefix (function)
• define-simple-condition-for (macro)
• define-simple-error-for (macro)
• dump-gcc-version (function)
• excluded-p (function)
• find-file-for-paths (function)
• find-prefix (function)
• included-p (function)
• path-or-asdf (function)
• prefix-trim (function)
• report-simple-condition (function)
• string+ (function)
• substr* (function)
• trim-symbols-to-alist (function)
• write-nicely (function)

3.1.4 claw/conditions.lisp

Dependency

util.lisp (file)

Parent

claw (system)

Location

conditions.lisp

Internal Definitions

• *failed-wraps* (special variable)
• *mute-reporting-p* (special variable)
• *wrap-failers* (special variable)
• autowrap-condition (condition)
• autowrap-continuable-error (function)
• autowrap-continuable-error (condition)
• autowrap-error (condition)
• c-unknown-field (condition)
• c-unknown-function (condition)
• call-with-wrap-attempt (function)
• clear-wrap-failures (function)
• compile-time-report-wrap-failures (macro)
• incomplete-type (condition)
• incomplete-type-type (method)
• (setf incomplete-type-type) (method)
• invalid-pointer-object (method)
• (setf invalid-pointer-object) (method)
• invalid-wrapper (condition)
• report-wrap-failures (function)
• sffi-condition (condition)
• sffi-continuable-error (function)
• sffi-continuable-error (condition)
• sffi-error (condition)
• simple-autowrap-continuable-error (condition)
• simple-sffi-continuable-error (condition)
• undefined-foreign-type (condition)
• undefined-foreign-type-contextualised (condition)
• with-wrap-attempt (macro)

3.1.5 claw/c2ffi.lisp

Dependency

conditions.lisp (file)

Parent

claw (system)

Location

c2ffi.lisp

Exported Definitions

• *c2ffi-program* (special variable)
• *trace-c2ffi* (special variable)

Internal Definitions

• *known-arches* (special variable)
• c2ffi-p (function)
• ensure-local-spec (function)
• find-local-spec (function)
• local-arch (function)
• local-cpu (function)
• local-environment (function)
• local-os (function)
• local-vendor (function)
• pass-through-processor (function)
• run-c2ffi (function)
• run-check (function)
• with-temporary-file (macro)

3.1.6 claw/wrapper.lisp

Dependency

c2ffi.lisp (file)

Parent

claw (system)

Location

wrapper.lisp

Exported Definitions

• invalidate (function)
• ptr (function)
• valid-p (function)
• wrap-pointer (function)
• wrapper-null-p (function)

Internal Definitions

• *definition-circles* (special variable)
• *wrapper-constructors* (special variable)
• anonymous-type (structure)
• anonymous-type-p (function)
• anonymous-type-ptr (function)
• (setf anonymous-type-ptr) (function)
• anonymous-type-validity (function)
• (setf anonymous-type-validity) (function)
• autocollect (macro)
• autocollect-cancel (macro)
• copy-anonymous-type (function)
• copy-wrapper (function)
• make-anonymous-type (function)
• make-wrapper (function)
• make-wrapper-instance (function)
• making-autocollect-instance (macro)
• with-autocollect-cancel (macro)
• wrapper (structure)
• wrapper-p (function)
• wrapper-ptr (function)
• (setf wrapper-ptr) (function)
• wrapper-valid-p (function)
• wrapper-validity (function)
• (setf wrapper-validity) (function)

3.1.7 claw/sffi.lisp

Dependency

wrapper.lisp (file)

Parent

claw (system)

Location

sffi.lisp

Exported Definitions

• bitfield-mask (function)
• callback (macro)
• defcallback (macro)
• define-enum-from-constants (macro)
• enum-key (function)
• enum-value (function)
• foreign-function-pointer (function)

Internal Definitions

• %ensure-type (function)
• %make-accessors (function)
• %undefined-type-error (function)
• %undefined-type-error-no-context (function)
• *accessor-declare* (special variable)
• *accessor-forms* (special variable)
• *accessor-index* (special variable)
• *accessor-params* (special variable)
• *accessor-record-name* (special variable)
• *accessor-recursive-max-depth* (special variable)
• *accessor-seen-types* (special variable)
• *foreign-externs* (special variable)
• *foreign-functions* (special variable)
• *foreign-record-index* (special variable)
• *foreign-types* (special variable)
• *signed-types* (special variable)
• *wrapped-type-names* (special variable)
• +cbv-prefix+ (constant)
• accessor-params (function)
• basic-foreign-type (generic function)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• builtin-type-p (function)
• cbv-return-p (function)
• create-type-from-complex-typespec (function)
• define-accessors (macro)
• define-cextern (macro)
• define-cfun (macro)
• define-foreign-alias (function)
• define-foreign-enum (function)
• define-foreign-extern (function)
• define-foreign-function (function)
• define-foreign-record (function)
• define-foreign-type (function)
• define-wrapper (macro)
• define-wrapper* (macro)
• ensure-type (function)
• find-extern (function)
• find-function (function)
• find-record-field (function)
• find-type (function)
• foreign-alias (class)
• foreign-anonymous (function)
• (setf foreign-anonymous) (function)
• foreign-array (class)
• foreign-array-size (method)
• (setf foreign-array-size) (method)
• foreign-enum (class)
• foreign-enum-values (method)
• foreign-enum-values (method)
• (setf foreign-enum-values) (method)
• foreign-extern (class)
• foreign-field (class)
• foreign-function (function)
• foreign-function (class)
• foreign-function-cbv-p (function)
• foreign-function-variadic-p (method)
• (setf foreign-function-variadic-p) (method)
• foreign-pointer (class)
• foreign-qualified-name (generic function)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-record (class)
• foreign-record-bit-alignment (method)
• (setf foreign-record-bit-alignment) (method)
• foreign-record-bit-size (method)
• (setf foreign-record-bit-size) (method)
• foreign-record-field (class)
• foreign-record-fields (method)
• (setf foreign-record-fields) (method)
• foreign-scalar-p (generic function)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-string (class)
• foreign-symbol (class)
• foreign-symbol-c-symbol (method)
• (setf foreign-symbol-c-symbol) (method)
• foreign-to-ffi (generic function)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-type (method)
• (setf foreign-type) (method)
• foreign-type (class)
• 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-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-id (method)
• (setf foreign-type-id) (method)
• foreign-type-name (method)
• foreign-type-name (method)
• foreign-type-name (method)
• (setf foreign-type-name) (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)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-to-lisp (function)
• foreign-wrap-up (generic function)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• frf-bit-alignment (method)
• (setf frf-bit-alignment) (method)
• frf-bit-offset (method)
• (setf frf-bit-offset) (method)
• frf-bit-size (method)
• (setf frf-bit-size) (method)
• frf-bit-width (method)
• (setf frf-bit-width) (method)
• frf-bitfield-p (method)
• (setf frf-bitfield-p) (method)
• looks-like-a-string (function)
• make-accessor-name (function)
• make-array-accessor (function)
• make-array-ref (function)
• make-bitfield-accessor (function)
• make-bitfield-deref (function)
• make-bitfield-merge (function)
• make-child-accessor (function)
• make-field-deref (function)
• make-field-ref (function)
• make-field-setter (function)
• make-foreign-funcall (function)
• make-normal-accessor (function)
• make-normal-type-accessor (function)
• make-simple-accessor (function)
• next-ffi (macro)
• parse-one-field (function)
• parse-record-fields (function)
• parse-record-name (function)
• require-type (function)
• require-type-no-context (function)
• struct-or-union-p (function)
• transform-call-by-value-function (function)
• unaliased-type (generic function)
• unaliased-type (method)
• unaliased-type (method)
• unaliased-type (method)
• undefined-enum-value (function)
• undefined-type-error (function)
• undefined-type-error-no-context (function)
• with-anonymous-indexing (macro)

3.1.8 claw/alloc.lisp

Dependency

sffi.lisp (file)

Parent

claw (system)

Location

alloc.lisp

Exported Definitions

• alignof (function)
• alloc (function)
• calloc (function)
• free (function)
• memcpy (function)
• offsetof (function)
• realloc (function)
• sizeof (function)
• with-alloc (macro)
• with-calloc (macro)
• with-free (macro)
• with-many-alloc (macro)
• with-many-free (macro)

Internal Definitions

• alloc-ptr (function)
• alloc-string (function)
• c-aptr (compiler macro)
• c-aptr (function)
• c-aref (compiler macro)
• c-aref (function)
• (setf c-aref) (function)
• c-calloc (function)
• c-free (function)
• c-malloc (function)
• c-memcpy (function)
• c-memset (function)
• c-realloc (function)
• calloc-ptr (function)

3.1.9 claw/errno.lisp

Dependency

alloc.lisp (file)

Parent

claw (system)

Location

errno.lisp

Exported Definitions

• errno (symbol macro)
• get-errno-pointer (function)

Internal Definitions

__errno_location (function)

3.1.10 claw/processing.lisp

Dependency

errno.lisp (file)

Parent

claw (system)

Location

processing.lisp

Internal Definitions

• exclude-type (function)
• explicitly-excluded-p (function)
• explicitly-included-p (function)
• extract-dependencies (function)
• extract-field-types (function)
• extract-function-types (function)
• extract-struct-types (function)
• extract-type (function)
• extract-types (function)
• filter-struct-fields (function)
• filter-types (function)
• finally-included-p (function)
• make-dependency-graph (function)
• make-type-dependency (function)
• name-exist-p (function)
• process-descriptor (function)
• register-dependency (function)
• register-type (function)
• squash-unrelated-definitions (function)
• traverse-dependencies (function)
• type-dependency-dependent-name (function)
• (setf type-dependency-dependent-name) (function)
• type-dependency-weak-p (function)
• (setf type-dependency-weak-p) (function)

3.1.11 claw/parse.lisp

Dependency

processing.lisp (file)

Parent

claw (system)

Location

parse.lisp

Internal Definitions

• %c-include (macro)
• *foreign-alias-list* (special variable)
• *foreign-c-to-lisp-function* (special variable)
• *foreign-constant-excludes* (special variable)
• *foreign-constant-list* (special variable)
• *foreign-extern-list* (special variable)
• *foreign-function-list* (special variable)
• *foreign-other-exports-list* (special variable)
• *foreign-raw-constant-list* (special variable)
• *foreign-record-list* (special variable)
• *foreign-symbol-exceptions* (special variable)
• *foreign-symbol-regex* (special variable)
• *foreign-type-symbol-function* (special variable)
• apply-regexps (function)
• collecting-symbols (macro)
• default-c-to-lisp (function)
• default-foreign-type-symbol (function)
• foreign-symbol-exception-p (function)
• foreign-type-symbol (function)
• make-constant-accessor (function)
• make-define-list (function)
• make-export-list (function)
• make-foreign-record-name (function)
• make-record-ref (function)
• make-scanners (function)
• maybe-add-constant (function)
• parse-enum-fields (function)
• parse-enum-to-const (function)
• parse-fields (function)
• parse-form (generic function)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-type (generic function)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• pointer*-to-record-form-p (function)
• pointer-alias-form-p (function)
• read-json (function)
• read-parse-forms (function)
• record-form-p (function)

3.1.12 claw/bitmask.lisp

Dependency

parse.lisp (file)

Parent

claw (system)

Location

bitmask.lisp

Exported Definitions

• define-bitmask (function)
• define-bitmask-from-constants (macro)
• define-bitmask-from-enum (macro)
• find-bitmask (function)
• mask (compiler macro)
• mask (function)
• mask-apply (function)
• mask-keywords (function)
• mask-symbol-value (function)
• remove-bitmask (function)

Internal Definitions

• *bit-table* (special variable)
• *foreign-bitmasks* (special variable)
• +debruijn64+ (constant)
• ctz (function)

3.1.13 claw/cbv.lisp

Dependency

bitmask.lisp (file)

Parent

claw (system)

Location

cbv.lisp

Internal Definitions

• make-cbv-wrapper (function)
• write-c-library-implementation (function)

3.1.14 claw/bodged.lisp

Dependency

cbv.lisp (file)

Parent

claw (system)

Location

bodged.lisp

Exported Definitions

c-include (macro)

Internal Definitions

• package-functions (function)
• parse-sysincludes (function)

3.1.15 claw/plus-c.lisp

Dependency

bodged.lisp (file)

Parent

claw (system)

Location

plus-c.lisp

Exported Definitions

• c-fun (macro)
• c-let (macro)
• c-ref (macro)
• (setf c-ref) (setf expander)
• c-val (macro)
• c-with (macro)

Internal Definitions

• %ensure-*&-keywords (function)
• *final-value-set* (special variable)
• *topmost-parent* (special variable)
• build-ref (generic function)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• make-bindings (function)
• mem-ref (function)
• (setf mem-ref) (function)

4 Packages

Packages are listed by definition order.

4.1 claw

Source

package.lisp (file)

Use List

• alexandria.1.0.0
• common-lisp

Exported Definitions

• *c2ffi-program* (special variable)
• *trace-c2ffi* (special variable)
• alignof (function)
• alloc (function)
• bitfield-mask (function)
• by-changing (function)
• by-removing-complex-prefix (function)
• by-removing-prefixes (function)
• c-fun (macro)
• c-include (macro)
• c-let (macro)
• c-ref (macro)
• (setf c-ref) (setf expander)
• c-val (macro)
• c-with (macro)
• callback (macro)
• calloc (function)
• defcallback (macro)
• define-bitmask (function)
• define-bitmask-from-constants (macro)
• define-bitmask-from-enum (macro)
• define-enum-from-constants (macro)
• enum-key (function)
• enum-value (function)
• errno (symbol macro)
• find-bitmask (function)
• foreign-function-pointer (function)
• free (function)
• get-errno-pointer (function)
• in-pipeline (function)
• invalidate (function)
• mask (compiler macro)
• mask (function)
• mask-apply (function)
• mask-keywords (function)
• mask-symbol-value (function)
• memcpy (function)
• offsetof (function)
• ptr (function)
• realloc (function)
• remove-bitmask (function)
• sizeof (function)
• valid-p (function)
• with-alloc (macro)
• with-calloc (macro)
• with-float-traps-masked (macro)
• with-free (macro)
• with-many-alloc (macro)
• with-many-free (macro)
• wrap-pointer (function)
• wrapper-null-p (function)

Internal Definitions

• %c-include (macro)
• %ensure-*&-keywords (function)
• %ensure-type (function)
• %make-accessors (function)
• %undefined-type-error (function)
• %undefined-type-error-no-context (function)
• *accessor-declare* (special variable)
• *accessor-forms* (special variable)
• *accessor-index* (special variable)
• *accessor-params* (special variable)
• *accessor-record-name* (special variable)
• *accessor-recursive-max-depth* (special variable)
• *accessor-seen-types* (special variable)
• *bit-table* (special variable)
• *definition-circles* (special variable)
• *exclude-definitions* (special variable)
• *exclude-sources* (special variable)
• *failed-wraps* (special variable)
• *filter-spec-p* (special variable)
• *final-value-set* (special variable)
• *foreign-alias-list* (special variable)
• *foreign-bitmasks* (special variable)
• *foreign-c-to-lisp-function* (special variable)
• *foreign-constant-excludes* (special variable)
• *foreign-constant-list* (special variable)
• *foreign-extern-list* (special variable)
• *foreign-externs* (special variable)
• *foreign-function-list* (special variable)
• *foreign-functions* (special variable)
• *foreign-other-exports-list* (special variable)
• *foreign-raw-constant-list* (special variable)
• *foreign-record-index* (special variable)
• *foreign-record-list* (special variable)
• *foreign-symbol-exceptions* (special variable)
• *foreign-symbol-regex* (special variable)
• *foreign-type-symbol-function* (special variable)
• *foreign-types* (special variable)
• *include-definitions* (special variable)
• *include-sources* (special variable)
• *known-arches* (special variable)
• *local-environment* (special variable)
• *local-os* (special variable)
• *mute-reporting-p* (special variable)
• *signed-types* (special variable)
• *topmost-parent* (special variable)
• *wrap-failers* (special variable)
• *wrapped-type-names* (special variable)
• *wrapper-constructors* (special variable)
• +byte-size+ (constant)
• +cbv-prefix+ (constant)
• +debruijn64+ (constant)
• __errno_location (function)
• accessor-params (function)
• akey (function)
• alist-bind (macro)
• alloc-ptr (function)
• alloc-string (function)
• anonymous-p (function)
• anonymous-type (structure)
• anonymous-type-p (function)
• anonymous-type-ptr (function)
• (setf anonymous-type-ptr) (function)
• anonymous-type-validity (function)
• (setf anonymous-type-validity) (function)
• apply-regexps (function)
• asdf-path (function)
• autocollect (macro)
• autocollect-cancel (macro)
• autowrap-condition (condition)
• autowrap-continuable-error (function)
• autowrap-continuable-error (condition)
• autowrap-error (condition)
• aval (function)
• (setf aval) (function)
• basic-foreign-type (generic function)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• basic-foreign-type (method)
• build-ref (generic function)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• build-ref (method)
• builtin-type-p (function)
• by-removing-prefix (function)
• c-aptr (compiler macro)
• c-aptr (function)
• c-aref (compiler macro)
• c-aref (function)
• (setf c-aref) (function)
• c-calloc (function)
• c-free (function)
• c-malloc (function)
• c-memcpy (function)
• c-memset (function)
• c-realloc (function)
• c-unknown-field (condition)
• c-unknown-function (condition)
• c2ffi-p (function)
• call-with-wrap-attempt (function)
• calloc-ptr (function)
• cbv-return-p (function)
• clear-wrap-failures (function)
• collecting-symbols (macro)
• compile-time-report-wrap-failures (macro)
• copy-anonymous-type (function)
• copy-type-dependency (function)
• copy-wrapper (function)
• create-type-from-complex-typespec (function)
• ctz (function)
• default-c-to-lisp (function)
• default-foreign-type-symbol (function)
• define-accessors (macro)
• define-cextern (macro)
• define-cfun (macro)
• define-foreign-alias (function)
• define-foreign-enum (function)
• define-foreign-extern (function)
• define-foreign-function (function)
• define-foreign-record (function)
• define-foreign-type (function)
• define-simple-condition-for (macro)
• define-simple-error-for (macro)
• define-wrapper (macro)
• define-wrapper* (macro)
• dump-gcc-version (function)
• ensure-local-spec (function)
• ensure-type (function)
• exclude-type (function)
• excluded-p (function)
• explicitly-excluded-p (function)
• explicitly-included-p (function)
• extract-dependencies (function)
• extract-field-types (function)
• extract-function-types (function)
• extract-struct-types (function)
• extract-type (function)
• extract-types (function)
• filter-struct-fields (function)
• filter-types (function)
• finally-included-p (function)
• find-extern (function)
• find-file-for-paths (function)
• find-function (function)
• find-local-spec (function)
• find-prefix (function)
• find-record-field (function)
• find-type (function)
• foreign-alias (class)
• foreign-anonymous (function)
• (setf foreign-anonymous) (function)
• foreign-array (class)
• foreign-array-size (generic function)
• foreign-array-size (method)
• (setf foreign-array-size) (method)
• (setf foreign-array-size) (generic function)
• foreign-enum (class)
• foreign-enum-values (generic function)
• foreign-enum-values (method)
• foreign-enum-values (method)
• (setf foreign-enum-values) (method)
• (setf foreign-enum-values) (generic function)
• foreign-extern (class)
• foreign-field (class)
• foreign-function (function)
• foreign-function (class)
• foreign-function-cbv-p (function)
• foreign-function-variadic-p (generic function)
• foreign-function-variadic-p (method)
• (setf foreign-function-variadic-p) (method)
• (setf foreign-function-variadic-p) (generic function)
• foreign-pointer (class)
• foreign-qualified-name (generic function)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-qualified-name (method)
• foreign-record (class)
• foreign-record-bit-alignment (generic function)
• foreign-record-bit-alignment (method)
• (setf foreign-record-bit-alignment) (method)
• (setf foreign-record-bit-alignment) (generic function)
• foreign-record-bit-size (generic function)
• foreign-record-bit-size (method)
• (setf foreign-record-bit-size) (method)
• (setf foreign-record-bit-size) (generic function)
• foreign-record-field (class)
• foreign-record-fields (generic function)
• foreign-record-fields (method)
• (setf foreign-record-fields) (method)
• (setf foreign-record-fields) (generic function)
• foreign-scalar-p (generic function)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-scalar-p (method)
• foreign-string (class)
• foreign-symbol (class)
• foreign-symbol-c-symbol (generic function)
• foreign-symbol-c-symbol (method)
• (setf foreign-symbol-c-symbol) (method)
• (setf foreign-symbol-c-symbol) (generic function)
• foreign-symbol-exception-p (function)
• foreign-to-ffi (generic function)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-to-ffi (method)
• foreign-type (generic function)
• foreign-type (method)
• (setf foreign-type) (method)
• (setf foreign-type) (generic function)
• foreign-type (class)
• 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-alignment (method)
• foreign-type-alignment (method)
• foreign-type-alignment (method)
• foreign-type-id (generic function)
• foreign-type-id (method)
• (setf foreign-type-id) (method)
• (setf foreign-type-id) (generic function)
• foreign-type-name (generic function)
• foreign-type-name (method)
• foreign-type-name (method)
• foreign-type-name (method)
• (setf foreign-type-name) (method)
• (setf foreign-type-name) (generic function)
• 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)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-size (method)
• foreign-type-symbol (function)
• foreign-type-to-lisp (function)
• foreign-wrap-up (generic function)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• foreign-wrap-up (method)
• frf-bit-alignment (generic function)
• frf-bit-alignment (method)
• (setf frf-bit-alignment) (method)
• (setf frf-bit-alignment) (generic function)
• frf-bit-offset (generic function)
• frf-bit-offset (method)
• (setf frf-bit-offset) (method)
• (setf frf-bit-offset) (generic function)
• frf-bit-size (generic function)
• frf-bit-size (method)
• (setf frf-bit-size) (method)
• (setf frf-bit-size) (generic function)
• frf-bit-width (generic function)
• frf-bit-width (method)
• (setf frf-bit-width) (method)
• (setf frf-bit-width) (generic function)
• frf-bitfield-p (generic function)
• frf-bitfield-p (method)
• (setf frf-bitfield-p) (method)
• (setf frf-bitfield-p) (generic function)
• included-p (function)
• incomplete-type (condition)
• incomplete-type-type (generic function)
• incomplete-type-type (method)
• (setf incomplete-type-type) (method)
• (setf incomplete-type-type) (generic function)
• invalid-pointer-object (generic function)
• invalid-pointer-object (method)
• (setf invalid-pointer-object) (method)
• (setf invalid-pointer-object) (generic function)
• invalid-wrapper (condition)
• local-arch (function)
• local-cpu (function)
• local-environment (function)
• local-os (function)
• local-vendor (function)
• looks-like-a-string (function)
• make-accessor-name (function)
• make-anonymous-type (function)
• make-array-accessor (function)
• make-array-ref (function)
• make-bindings (function)
• make-bitfield-accessor (function)
• make-bitfield-deref (function)
• make-bitfield-merge (function)
• make-cbv-wrapper (function)
• make-child-accessor (function)
• make-constant-accessor (function)
• make-define-list (function)
• make-dependency-graph (function)
• make-export-list (function)
• make-field-deref (function)
• make-field-ref (function)
• make-field-setter (function)
• make-foreign-funcall (function)
• make-foreign-record-name (function)
• make-normal-accessor (function)
• make-normal-type-accessor (function)
• make-record-ref (function)
• make-scanners (function)
• make-simple-accessor (function)
• make-type-dependency (function)
• make-wrapper (function)
• make-wrapper-instance (function)
• making-autocollect-instance (macro)
• maybe-add-constant (function)
• mem-ref (function)
• (setf mem-ref) (function)
• name-exist-p (function)
• next-ffi (macro)
• package-functions (function)
• parse-enum-fields (function)
• parse-enum-to-const (function)
• parse-fields (function)
• parse-form (generic function)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-form (method)
• parse-one-field (function)
• parse-record-fields (function)
• parse-record-name (function)
• parse-sysincludes (function)
• parse-type (generic function)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• parse-type (method)
• pass-through-processor (function)
• path-or-asdf (function)
• pointer*-to-record-form-p (function)
• pointer-alias-form-p (function)
• prefix-trim (function)
• process-descriptor (function)
• read-json (function)
• read-parse-forms (function)
• record-form-p (function)
• register-dependency (function)
• register-type (function)
• report-simple-condition (function)
• report-wrap-failures (function)
• require-type (function)
• require-type-no-context (function)
• run-c2ffi (function)
• run-check (function)
• sffi-condition (condition)
• sffi-continuable-error (function)
• sffi-continuable-error (condition)
• sffi-error (condition)
• simple-autowrap-continuable-error (condition)
• simple-sffi-continuable-error (condition)
• squash-unrelated-definitions (function)
• string+ (function)
• struct-or-union-p (function)
• substr* (function)
• transform-call-by-value-function (function)
• traverse-dependencies (function)
• trim-symbols-to-alist (function)
• type-dependency-dependent-name (function)
• (setf type-dependency-dependent-name) (function)
• type-dependency-weak-p (function)
• (setf type-dependency-weak-p) (function)
• unaliased-type (generic function)
• unaliased-type (method)
• unaliased-type (method)
• unaliased-type (method)
• undefined-enum-value (function)
• undefined-foreign-type (condition)
• undefined-foreign-type-contextualised (condition)
• undefined-type-error (function)
• undefined-type-error-no-context (function)
• with-anonymous-indexing (macro)
• with-autocollect-cancel (macro)
• with-temporary-file (macro)
• with-wrap-attempt (macro)
• wrapper (structure)
• wrapper-p (function)
• wrapper-ptr (function)
• (setf wrapper-ptr) (function)
• wrapper-valid-p (function)
• wrapper-validity (function)
• (setf wrapper-validity) (function)
• write-c-library-implementation (function)
• write-nicely (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *c2ffi-program*

Package

claw

Source

c2ffi.lisp (file)

Special Variable: *trace-c2ffi*

Package

claw

Source

c2ffi.lisp (file)

5.1.2 Symbol macros

Symbol Macro: errno

Package

claw

Source

errno.lisp (file)

Expansion

(cffi-sys:%mem-ref (claw:get-errno-pointer) :int)

5.1.3 Macros

Macro: c-fun NAME &rest ARGS

Package

claw

Source

plus-c.lisp (file)

Macro: c-include HEADER SYSTEM-NAME &body BODY &key IN-PACKAGE INCLUDE-SOURCES INCLUDE-DEFINITIONS EXCLUDE-SOURCES EXCLUDE-DEFINITIONS RENAME-SYMBOLS SYSINCLUDES WINDOWS-ENVIRONMENT

Package

claw

Source

bodged.lisp (file)

Macro: c-let BINDINGS &body BODY

Package

claw

Source

plus-c.lisp (file)

Macro: c-ref WRAPPER TYPE &rest FIELDS

Setf Expander: (setf c-ref) WRAPPER TYPE &rest FIELDS

Package

claw

Source

plus-c.lisp (file)

Macro: c-val BINDINGS &body BODY

Package

claw

Source

plus-c.lisp (file)

Macro: c-with BINDINGS &body BODY

Package

claw

Source

plus-c.lisp (file)

Macro: callback NAME

Package

claw

Source

sffi.lisp (file)

Macro: defcallback NAME RETURN-TYPE LAMBDA-LIST &body BODY

This acts much like CFFI:DEFCALLBACK except it allows SFFI type aliases to be specified.

Package

claw

Source

sffi.lisp (file)

Macro: define-bitmask-from-constants (NAME &optional REGEX) &body VALUES

Define a bitmask ‘NAME‘ from a list of constants ‘VALUES‘. Each value should evaluate to actual values, e.g. actual ‘+CONSTANTS+‘, or be a list in the form ‘’(SYMBOL VALUE)‘. If a symbol is given alone, it is by default pruned of any common prefix and made into a keyword. If a list is specified, the symbol given is used exactly.

Package

claw

Source

bitmask.lisp (file)

Macro: define-bitmask-from-enum (NAME ENUM-NAME) &body VALUES

Define a bitmask ‘NAME‘ from the values specified in the previously-defined foreign-enum named ‘ENUM-NAME‘ and any additional values, ‘VALUES‘. (A foreign-alias of an enum may also be specified.)

Package

claw

Source

bitmask.lisp (file)

Macro: define-enum-from-constants (NAME &optional REGEX) &body VALUES

Define an enum *and alias* ‘NAME‘ from a list of constants ‘VALUES‘. Each value should evaluate to actual values, e.g. actual ‘+CONSTANTS+‘, or be a list in the form ‘’(SYMBOL VALUE)‘. If a symbol is given alone, it is by default pruned of any common prefix and made into a keyword. If a list is specified, the symbol given is used exactly.

Package

claw

Source

sffi.lisp (file)

Macro: with-alloc (NAME TYPE &optional COUNT) &body BODY

Package

claw

Source

alloc.lisp (file)

Macro: with-calloc (NAME TYPE &optional COUNT) &body BODY

Package

claw

Source

alloc.lisp (file)

Macro: with-float-traps-masked (&rest MASKS) &body BODY

Package

claw

Source

util.lisp (file)

Macro: with-free (NAME VALUE) &body BODY

Package

claw

Source

alloc.lisp (file)

Macro: with-many-alloc (&rest BINDINGS) &body BODY

Package

claw

Source

alloc.lisp (file)

Macro: with-many-free (&rest BINDINGS) &body BODY

Package

claw

Source

alloc.lisp (file)

5.1.4 Compiler macros

Compiler Macro: mask NAME &rest SYMBOLS

Package

claw

Source

bitmask.lisp (file)

5.1.5 Functions

Function: alignof TYPE

Package

claw

Source

alloc.lisp (file)

Function: alloc TYPE &optional COUNT

Return a foreign wrapper for ‘TYPE‘ with its pointer allocated. Freeing is up to you!

Package

claw

Source

alloc.lisp (file)

Function: bitfield-mask BIT-OFFSET BIT-SIZE BIT-ALIGNMENT FIELD-WIDTH

Package

claw

Source

sffi.lisp (file)

Function: by-changing FROM TO

Package

claw

Source

util.lisp (file)

Function: by-removing-complex-prefix REGEX SYMBOLS-TO-CUT

Package

claw

Source

util.lisp (file)

Function: by-removing-prefixes &rest PREFIXES

Package

claw

Source

util.lisp (file)

Function: calloc TYPE &optional COUNT

Return a foreign wrapper for ‘TYPE‘ with its pointer allocated, and its contents initialized to zero. Freeing is up to you!

Package

claw

Source

alloc.lisp (file)

Function: define-bitmask NAME MASK

Package

claw

Source

bitmask.lisp (file)

Function: enum-key FOREIGN-ENUM VAL

Package

claw

Source

sffi.lisp (file)

Function: enum-value FOREIGN-ENUM KEY

Package

claw

Source

sffi.lisp (file)

Function: find-bitmask NAME

Package

claw

Source

bitmask.lisp (file)

Function: foreign-function-pointer SYMBOL

Package

claw

Source

sffi.lisp (file)

Function: free OBJECT

Free WRAPPER via FOREIGN-FREE and invalidate.

Package

claw

Source

alloc.lisp (file)

Function: get-errno-pointer ()

Package

claw

Source

errno.lisp (file)

Function: in-pipeline &rest PROCESSORS

Package

claw

Source

util.lisp (file)

Function: invalidate WRAPPER

Package

claw

Source

wrapper.lisp (file)

Function: mask NAME &rest SYMBOLS

Create a mask by ‘LOGIOR‘ using the *list* of symbols ‘SYMBOLS‘ from the bitmask ‘NAME‘.

Package

claw

Source

bitmask.lisp (file)

Function: mask-apply NAME SYMBOLS

Package

claw

Source

bitmask.lisp (file)

Function: mask-keywords NAME VALUE

Return the list of keywords which describe the integer mask ‘VALUE‘ for the bitmask called ‘NAME‘. Limited to 64 bits at the moment.

Package

claw

Source

bitmask.lisp (file)

Function: mask-symbol-value MASK SYMBOL

Package

claw

Source

bitmask.lisp (file)

Function: memcpy DEST SRC &key N TYPE

Package

claw

Source

alloc.lisp (file)

Function: offsetof STRUCT FIELD

Package

claw

Source

alloc.lisp (file)

Function: ptr WRAPPER

Package

claw

Source

wrapper.lisp (file)

Function: realloc PTR TYPE COUNT

Package

claw

Source

alloc.lisp (file)

Function: remove-bitmask NAME

Package

claw

Source

bitmask.lisp (file)

Function: sizeof TYPE

Package

claw

Source

alloc.lisp (file)

Function: valid-p WRAPPER

Package

claw

Source

wrapper.lisp (file)

Function: wrap-pointer POINTER TYPE &optional VALIDITY

Package

claw

Source

wrapper.lisp (file)

Function: wrapper-null-p WRAPPER

Package

claw

Source

wrapper.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +byte-size+

Package

claw

Source

util.lisp (file)

Constant: +cbv-prefix+

Package

claw

Source

sffi.lisp (file)

Constant: +debruijn64+

Package

claw

Source

bitmask.lisp (file)

5.2.2 Special variables

Special Variable: *accessor-declare*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-forms*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-index*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-params*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-record-name*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-recursive-max-depth*

Package

claw

Source

sffi.lisp (file)

Special Variable: *accessor-seen-types*

Package

claw

Source

sffi.lisp (file)

Special Variable: *bit-table*

Package

claw

Source

bitmask.lisp (file)

Special Variable: *definition-circles*

Detect circular type members

Package

claw

Source

wrapper.lisp (file)

Special Variable: *exclude-definitions*

Package

claw

Special Variable: *exclude-sources*

Package

claw

Special Variable: *failed-wraps*

A list of things we couldn’t wrap.

Package

claw

Source

conditions.lisp (file)

Special Variable: *filter-spec-p*

Package

claw

Special Variable: *final-value-set*

Package

claw

Source

plus-c.lisp (file)

Special Variable: *foreign-alias-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-bitmasks*

Package

claw

Source

bitmask.lisp (file)

Special Variable: *foreign-c-to-lisp-function*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-constant-excludes*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-constant-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-extern-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-externs*

Package

claw

Source

sffi.lisp (file)

Special Variable: *foreign-function-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-functions*

Package

claw

Source

sffi.lisp (file)

Special Variable: *foreign-other-exports-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-raw-constant-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-record-index*

Package

claw

Source

sffi.lisp (file)

Special Variable: *foreign-record-list*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-symbol-exceptions*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-symbol-regex*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-type-symbol-function*

Package

claw

Source

parse.lisp (file)

Special Variable: *foreign-types*

Package

claw

Source

sffi.lisp (file)

Special Variable: *include-definitions*

Package

claw

Special Variable: *include-sources*

Package

claw

Special Variable: *known-arches*

Package

claw

Source

c2ffi.lisp (file)

Special Variable: *local-environment*

Package

claw

Special Variable: *local-os*

Package

claw

Special Variable: *mute-reporting-p*

Definition-skipped reports tend to cause panic; set this to non-NIL to suppress them.

Package

claw

Source

conditions.lisp (file)

Special Variable: *signed-types*

Package

claw

Source

sffi.lisp (file)

Special Variable: *topmost-parent*

Package

claw

Source

plus-c.lisp (file)

Special Variable: *wrap-failers*

A list of things whose absence caused other things to fail to wrap.

Package

claw

Source

conditions.lisp (file)

Special Variable: *wrapped-type-names*

Package

claw

Source

sffi.lisp (file)

Special Variable: *wrapper-constructors*

Package

claw

Source

wrapper.lisp (file)

5.2.3 Macros

Macro: %c-include H-FILE &key SPEC-PATH SYMBOL-EXCEPTIONS SYMBOL-REGEX EXCLUDE-DEFINITIONS EXCLUDE-SOURCES EXCLUDE-ARCH INCLUDE-DEFINITIONS INCLUDE-SOURCES INCLUDE-ARCH SYSINCLUDES DEFINITION-PACKAGE FUNCTION-PACKAGE WRAPPER-PACKAGE ACCESSOR-PACKAGE CONSTANT-PACKAGE EXTERN-PACKAGE CONSTANT-ACCESSOR EXCLUDE-CONSTANTS TRACE-C2FFI NO-ACCESSORS NO-FUNCTIONS RELEASE-P VERSION FILTER-SPEC-P TYPE-SYMBOL-FUNCTION C-TO-LISP-FUNCTION LOCAL-OS LOCAL-ENVIRONMENT

Package

claw

Source

parse.lisp (file)

Macro: alist-bind (&rest VARS) ALIST &body BODY

Inefficient but doesn’t really matter here

Package

claw

Source

util.lisp (file)

Macro: autocollect (&optional PTR) WRAPPER-FORM &body BODY

Package

claw

Source

wrapper.lisp (file)

Macro: autocollect-cancel WRAPPER

Package

claw

Source

wrapper.lisp (file)

Macro: collecting-symbols &body BODY

Package

claw

Source

parse.lisp (file)

Macro: compile-time-report-wrap-failures ()

Package

claw

Source

conditions.lisp (file)

Macro: define-accessors FOREIGN-RECORD &optional PACKAGE

Package

claw

Source

sffi.lisp (file)

Macro: define-cextern NAME &optional PACKAGE

Package

claw

Source

sffi.lisp (file)

Macro: define-cfun NAME-OR-FUNCTION &optional PACKAGE

Package

claw

Source

sffi.lisp (file)

Macro: define-simple-condition-for BASE-TYPE &key OBJECT-INITARG SIMPLE-CONDITION-TYPE SIGNALER NAME

Package

claw

Source

util.lisp (file)

Macro: define-simple-error-for BASE-TYPE &key NAME OBJECT-INITARG

Define a simple error subclassing from BASE-TYPE and a corresponding function, analogous to ERROR, but also optionally taking the object against which to err, and passing it to ERROR via the OBJECT-INITARG keyword. The name of the simple error is constructed by prepending ’SIMPLE-’ to BASE-TYPE.
Whether or not the error signaller will require and pass the object is specified by OBJECT-INITARG being non-NIL.

Package

claw

Source

util.lisp (file)

Macro: define-wrapper TYPE &optional PACKAGE

Package

claw

Source

sffi.lisp (file)

Macro: define-wrapper* TYPE WRAPPER-NAME PACKAGE-NAME

Package

claw

Source

sffi.lisp (file)

Macro: making-autocollect-instance (PTR-VAR TYPE-NAME) POINTER-FORM &body CLEANUP-BODY

Package

claw

Source

wrapper.lisp (file)

Macro: next-ffi ()

Package

claw

Source

sffi.lisp (file)

Macro: with-anonymous-indexing &body BODY

Package

claw

Source

sffi.lisp (file)

Macro: with-autocollect-cancel (WRAPPER &key INVALIDATE-P) &body BODY

Run ‘BODY‘, and (by default, with ‘:invalidate-p‘ as ‘T‘) invalidate ‘WRAPPER‘. This is protected; a non-local exit from ‘BODY‘ will still invalidate ‘WRAPPER‘.

Package

claw

Source

wrapper.lisp (file)

Macro: with-temporary-file (&key PATHNAME KEEP STREAM) &body BODY

Package

claw

Source

c2ffi.lisp (file)

Macro: with-wrap-attempt (&optional FORMAT-CONTROL &rest FORMAT-ARGS) WRAPPABLE-NAME &body BODY

Package

claw

Source

conditions.lisp (file)

5.2.4 Compiler macros

Compiler Macro: c-aptr WRAPPER INDEX &optional TYPE

Package

claw

Source

alloc.lisp (file)

Compiler Macro: c-aref WRAPPER INDEX &optional TYPE

Package

claw

Source

alloc.lisp (file)

5.2.5 Functions

Function: %ensure-*&-keywords VALUE

Package

claw

Source

plus-c.lisp (file)

Function: %ensure-type TYPESPEC CONTEXT-FORMAT-CONTROL CONTEXT-FORMAT-ARGS

Package

claw

Source

sffi.lisp (file)

Function: %make-accessors FOREIGN-RECORD &key PREFIX REF

Package

claw

Source

sffi.lisp (file)

Function: %undefined-type-error TYPESPEC CONTEXT-FORMAT-CONTROL CONTEXT-FORMAT-ARGUMENTS

Package

claw

Source

sffi.lisp (file)

Function: %undefined-type-error-no-context TYPESPEC

Package

claw

Source

sffi.lisp (file)

Function: __errno_location ()

Package

claw

Source

errno.lisp (file)

Function: accessor-params ()

Package

claw

Source

sffi.lisp (file)

Function: akey VAL ALIST &key TEST

Package

claw

Source

util.lisp (file)

Function: alloc-ptr TYPE &optional COUNT

Return a pointer allocated to the size of ‘TYPE‘

Package

claw

Source

alloc.lisp (file)

Function: alloc-string STRING

Package

claw

Source

alloc.lisp (file)

Function: anonymous-p FORM

Package

claw

Source

util.lisp (file)

Function: anonymous-type-p OBJECT

Package

claw

Source

wrapper.lisp (file)

Function: anonymous-type-ptr INSTANCE

Function: (setf anonymous-type-ptr) VALUE INSTANCE

Package

claw

Source

wrapper.lisp (file)

Function: anonymous-type-validity INSTANCE

Function: (setf anonymous-type-validity) VALUE INSTANCE

Package

claw

Source

wrapper.lisp (file)

Function: apply-regexps STRING REGEX-LIST

Package

claw

Source

parse.lisp (file)

Function: asdf-path SYSTEM &rest PATH

Package

claw

Source

util.lisp (file)

Function: autowrap-continuable-error FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Package

claw

Source

conditions.lisp (file)

Function: aval KEY ALIST &key TEST

Function: (setf aval) VALUE KEY ALIST &key TEST

Package

claw

Source

util.lisp (file)

Function: builtin-type-p TYPE

Determine if TYPE is a builtin type (e.g., :char, :int, etc) or alias, vs anything else (including enums).

Package

claw

Source

sffi.lisp (file)

Function: by-removing-prefix PREFIX

Package

claw

Source

util.lisp (file)

Function: c-aptr WRAPPER INDEX &optional TYPE

Package

claw

Source

alloc.lisp (file)

Function: c-aref WRAPPER INDEX &optional TYPE

Function: (setf c-aref) V PTR INDEX TYPE

Package

claw

Source

alloc.lisp (file)

Function: c-calloc NMEMB SIZE

Package

claw

Source

alloc.lisp (file)

Function: c-free PTR

Package

claw

Source

alloc.lisp (file)

Function: c-malloc SIZE

Package

claw

Source

alloc.lisp (file)

Function: c-memcpy DEST SRC N

Package

claw

Source

alloc.lisp (file)

Function: c-memset S C N

Package

claw

Source

alloc.lisp (file)

Function: c-realloc PTR SIZE

Package

claw

Source

alloc.lisp (file)

Function: c2ffi-p ()

This is a hack to determine if c2ffi exists; it assumes if it doesn’t exist, we will get a return code other than 0.

Package

claw

Source

c2ffi.lisp (file)

Function: call-with-wrap-attempt WRAPPABLE-NAME FN FORMAT-CONTROL FORMAT-ARGS

Package

claw

Source

conditions.lisp (file)

Function: calloc-ptr TYPE &optional COUNT

Return a pointer allocated to the size of ‘TYPE‘, initialized to zero

Package

claw

Source

alloc.lisp (file)

Function: cbv-return-p FUN

Package

claw

Source

sffi.lisp (file)

Function: clear-wrap-failures ()

Package

claw

Source

conditions.lisp (file)

Function: copy-anonymous-type INSTANCE

Package

claw

Source

wrapper.lisp (file)

Function: copy-type-dependency SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

claw

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-wrapper INSTANCE

Package

claw

Source

wrapper.lisp (file)

Function: create-type-from-complex-typespec TYPESPEC CONTEXT-FORMAT-CONTROL CONTEXT-FORMAT-ARGS

=> TYPE

Create a type from ‘TYPESPEC‘ and return the ‘TYPE‘ structure representing it.

Package

claw

Source

sffi.lisp (file)

Function: ctz X

Package

claw

Source

bitmask.lisp (file)

Function: default-c-to-lisp STRING

Package

claw

Source

parse.lisp (file)

Function: default-foreign-type-symbol STRING TYPE PACKAGE

Package

claw

Source

parse.lisp (file)

Function: define-foreign-alias NAME ID TYPE

Package

claw

Source

sffi.lisp (file)

Function: define-foreign-enum NAME ID C-NAME VALUE-LIST

Define a foreign enum given ‘NAME‘, a symbol, and a list of symbol-to-integer mappings, ‘VALUE-LIST‘. ID should be 0 unless anonymous-indexing is enabled and this will be later typedef’d by ID.

Package

claw

Source

sffi.lisp (file)

Function: define-foreign-extern NAME C-SYMBOL TYPE

Define symbol ‘NAME‘ to be an extern of type ‘TYPE‘.

Package

claw

Source

sffi.lisp (file)

Function: define-foreign-function NAME-AND-OPTIONS RETURN-TYPE PARAMS

=> FOREIGN-FUNCTION

Define a foreign function given a lisp symbol, C symbol (as a string), return type and parameters. Note this just defines to SFFI what the foreign function looks like .. it doesn’t actually DEFUN something to call it.

Package

claw

Source

sffi.lisp (file)

Function: define-foreign-record NAME ID TYPE BIT-SIZE BIT-ALIGNMENT FIELD-LIST

Define a foreign record (struct or union) given ‘NAME‘, a symbol, ‘TYPE‘, either :struct or :union, and a list of fields. The actual name for the type will be ‘(:struct NAME)‘ or ‘(:union NAME)‘, as appropriate.

Package

claw

Source

sffi.lisp (file)

Function: define-foreign-type NAME TYPE

Trivially define a foreign type given ‘NAME‘ and a ‘foreign-type‘ object, ‘TYPE‘

Package

claw

Source

sffi.lisp (file)

Function: dump-gcc-version ()

Package

claw

Source

util.lisp (file)

Function: ensure-local-spec NAME &key SPEC-PATH ARCH-EXCLUDES ARCH-INCLUDES SYSINCLUDES VERSION SPEC-PROCESSOR

Package

claw

Source

c2ffi.lisp (file)

Function: ensure-type TYPESPEC CONTEXT-FORMAT-CONTROL &rest CONTEXT-FORMAT-ARGS

Package

claw

Source

sffi.lisp (file)

Function: exclude-type GRAPH NAME

Package

claw

Source

processing.lisp (file)

Function: excluded-p NAME LOCATION

Package

claw

Source

util.lisp (file)

Function: explicitly-excluded-p NAME LOCATION

Package

claw

Source

processing.lisp (file)

Function: explicitly-included-p NAME LOCATION

Package

claw

Source

processing.lisp (file)

Function: extract-dependencies DESCRIPTOR

Package

claw

Source

processing.lisp (file)

Function: extract-field-types DESCRIPTOR

Package

claw

Source

processing.lisp (file)

Function: extract-function-types DESCRIPTOR

Package

claw

Source

processing.lisp (file)

Function: extract-struct-types DESCRIPTOR

Package

claw

Source

processing.lisp (file)

Function: extract-type TYPE-DESCRIPTOR

Package

claw

Source

processing.lisp (file)

Function: extract-types RAW-SPEC

Extracts names and their first-level dependencies into a graph.

Package

claw

Source

processing.lisp (file)

Function: filter-struct-fields DESCRIPTOR DEPENDENCIES

Package

claw

Source

processing.lisp (file)

Function: filter-types TYPES DEPENDENCIES

Leaves only included names and their dependencies unless explicitly excluded.

Package

claw

Source

processing.lisp (file)

Function: finally-included-p NAME LOCATION

Package

claw

Source

processing.lisp (file)

Function: find-extern NAME

Package

claw

Source

sffi.lisp (file)

Function: find-file-for-paths FILE PATHS

Package

claw

Source

util.lisp (file)

Function: find-function NAME-OR-FUNCTION

Package

claw

Source

sffi.lisp (file)

Function: find-local-spec NAME &optional SPEC-PATH

Return the path of the SPEC for this machine’s architecture, or NIL if the file does not exist.

Package

claw

Source

c2ffi.lisp (file)

Function: find-prefix LIST &key PRED

Package

claw

Source

util.lisp (file)

Function: find-record-field NAME-OR-TYPE FIELD-NAME

=> FOREIGN-RECORD-FIELD

Given ‘NAME-OR-TYPE‘, return the field object called ‘FIELD-NAME‘.

Package

claw

Source

sffi.lisp (file)

Function: find-type TYPESPEC

Package

claw

Source

sffi.lisp (file)

Function: foreign-anonymous ID

Function: (setf foreign-anonymous) V ID

Package

claw

Source

sffi.lisp (file)

Function: foreign-function FUNCTION-NAME

Return a lambda which calls function ‘FUNCTION-NAME‘. This is useful if you need to funcall foreign functions (which is quite handy!), since CFFI-SYS and thus SFFI use macros for ordinary calls.

Package

claw

Source

sffi.lisp (file)

Function: foreign-function-cbv-p FUN

Package

claw

Source

sffi.lisp (file)

Function: foreign-symbol-exception-p STRING

Package

claw

Source

parse.lisp (file)

Function: foreign-type-symbol STRING TYPE PACKAGE

Package

claw

Source

parse.lisp (file)

Function: foreign-type-to-lisp TYPE

Package

claw

Source

sffi.lisp (file)

Function: included-p THING INCLUDES

Package

claw

Source

util.lisp (file)

Function: local-arch ()

Package

claw

Source

c2ffi.lisp (file)

Function: local-cpu ()

Package

claw

Source

c2ffi.lisp (file)

Function: local-environment ()

Package

claw

Source

c2ffi.lisp (file)