The binge Reference Manual

Table of Contents

The binge Reference Manual

This is the binge Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:48:57 2018 GMT+0.

1 Introduction

* INSTALLATION.

To compile and load BINGE an ASDF file is provided.  Just install it
in your system directory and do

  (asdf:oos 'asdf:load-op :binge)

BINGE depends on NPG (the Naive Parser Generator) and SCLF.  NPG can
be found in the same place you found BINGE.


* USAGE.

The compilation of a FFI goes through three steps: the parsing (or
extraction), the creation of the C namespace, and the generation of
the FFI itself.

For example, to generate a FFI for all the functions, types, and
global variables of the a header file foo.h (and its included
headers), you can do:

  (binge:make-ffi #P"foo-ffi.lisp"
  		  (binge:make-namespace
		    (binge:extract-from-headers '("foo.h"))))

This won't extract any symbolic constant unless you explicitly specify
them with the :constants argument of extract-from-headers.

BINGE should be able to parse C source files as well, but this is
currently untested.

Both make-ffi and extract-from-headers have keyword arguments you may
want to look at, they let you specify what to extract and what type of
backend to use (in case you want to cross-generate).  In particular
the :defines and :preamble keywords of extract-from-headers come handy
to cope with weird extensions of certain compilers; for instance on
gcc-based systems you may want to use something like:

  :defines '(("__attribute__(x)" "")
  	     ("__extension__(x)" "0")
	     ("__inline" "")
	     ("__asm(x)" ""))

There is a global variable binge:*gcc-null-defines* just for this
purpose, so on FreeBSD and Linux you just need to write

  (binge:extract-from-headers '("ncurses.h")
    :defines binge:*gcc-null-defines*)

Actually gcc has many more nasty extensions and some cannot be tamed
with just few defines; the __builtin_va_list, for example.  This
needs to be manually added to the namespace as a separate declaration.

The special variable *compress-types* is an experimental feature made
to reduce the number of type declarations in the generated FFI.  It
can be set to three values:

    - NIL, don't compress, keep all the necessary declarations
    - :TYPEDEFS, remove the superfluous typedefs
    - :ALL, remove all the non strictly necessary types, converting
      the pointers to them into void pointers

A real life version of the example above would be something like:

  (setf constants-list '(...))

  (setf namespace
    (binge:make-namespace
      (binge:extract-from-headers '("ncurses.h")
        :defines binge:*gcc-null-defines*
	:constants constants-list)))

  (binge-compiler:add-declaration
     (make-instance 'binge-decl:c-typedef-declaration
		    :name "__builtin_va_list"
		    :type :vararg) namespace)

  (binge:make-ffi #P"ncurses-ffi.lisp" namespace
		  :functions t	; all functions
		  :constants t	; all constants
		  :backend (make-instance 'binge-backend:sbcl-backend
		  	   		  :package "NCURSES"
		  	   		  :prefix "%"))

Where you specify a list of symbolic constants to extract (:constants
some-var), tell BINGE to get all the functions, and prepend all the
exported symbols with an percentage sign (:prefix "%").

So if everything works as expected, you should be able to simply

  (sb-alien:load-1-foreign "/usr/lib/libncurses.so") ; if running SBCL
  (load "ncurses-ffi.lisp")

and use the new curses library.

In reality, this won't be enough; things must be adjusted and many
macros need to be written from scratch (the C macros).  For instance,
in this particular case, ncurses.h declares several functions which
aren't actually in the library (libncurses.so), so either you specify
a limited set of functions you want to extract, with the :functions
keyword argument of make-ffi, or you manually remove from the output
file those missing in the library.  As the former solution may be a
daunting task, given the size of the ncurses library, you'll probably
settle for the latter.

More examples can be found in the example directory.  They are
normally compiled and loaded together with the rest of BINGE and
they'll be available in the binge-examples package (see
example/package.lisp).  For instance, to generate the FFI for the
Berkeley DB library simply type

  (binge-examples:create-db-ffi)

If you want to try a different backend than your default one, try for
instance

  (let ((binge:*backend* (make-instance 'binge-backend:uffi-backend)))
    (binge-examples:create-db-ffi))

The UFFI backend is unconditionally loaded first, so, if your platform
has its own specific backend, UFFI's won't be the default one.  If,
for whatever reason, you need to cross-generate a FFI for another Lisp
system you have to load the appropriate backend manually:

  (load "binge:backends;your-backend.lisp")


* HACKING.

You might want to temper with binge:*c-preprocessor* if, to invoke the
C preprocessor, you don't use "cc -E".

If the general mechanism provided by extract-from-headers doesn't suit
your needs, you could try using binge:extract, which is a generic
function specialised on pathnames and streams.  You have to provide
your own preprocessed file or stream as the sole argument.

If you want to spare a couple of hours to write your own backend, have
a look in src/backend/sbcl.lisp for an example.  That's at the moment
the backend which is likely to be most up to date.

Although BINGE is known to compile on LispWorks 4.2 you may want to
check out this page if you run into stack limit problems:

http://www1.xanalys.com/support/lisp/kbase.nsf/51fe6e1cdfe748a180256639005a2ba9/f35acd8100dfd9ba8525670b0074a8d6!OpenDocument

The parsing of constant expression is still somehow limited and may
result in parser errors in some particularly complex cases; please let
me know.

Some regression tests are provided in the directory test.  You can run
them with

  (asdf:oos 'asdf:load-op :binge-tests)
  (rtest:do-tests)

or simply

  (asdf:oos 'asdf:test-op :binge)


* LEGAL

BINGE is copyright Walter C. Pelissero (walter@pelissero.de) and under
GPL, though the files it produces are not.  See the file COPYING for
further details.

2 Systems

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

2.1 binge

Maintainer

Walter C. Pelissero <walter@pelissero.de>

Author

Walter C. Pelissero <walter@pelissero.de>

License

GPL

Description

Bovine INterface GEnerator

Long Description

Bovine INterface GEnerator is a Common Lisp program that extracts types, variable/function declarations and symbolic constants from C header files and dumps a foreign function interface for them.

Dependencies

• npg
• sb-posix
• sclf

Source

binge.asd (file)

Components

• copying (file)
• readme (file)
• announce (file)
• .project (file)
• src (module)
• example (module)

3 Modules

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

3.1 binge/src

Parent

binge (system)

Location

src/

Components

• backends (module)
• package.lisp (file)
• ss.lisp (file)
• lexer.lisp (file)
• grammar.lisp (file)
• decl.lisp (file)
• binge.lisp (file)
• parser.lisp (file)
• backend.lisp (file)
• namespace.lisp (file)
• compiler.lisp (file)

3.2 binge/src/backends

Dependencies

• package.lisp (file)
• backend.lisp (file)
• compiler.lisp (file)

Parent

src (module)

Location

src/backends/

Components

• uffi.lisp (file)
• sbcl.lisp (file)
• cmucl (file)
• lispworks (file)
• clisp (file)

3.3 binge/example

Dependency

src (module)

Parent

binge (system)

Location

example/

Components

• package.lisp (file)
• zlib.lisp (file)
• ncurses.lisp (file)
• db.lisp (file)
• gtk.lisp (file)
• xlib.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 binge.asd

Location

binge.asd

Systems

binge (system)

Packages

binge-system

Internal Definitions

• *binge-base-directory* (special variable)
• inactive-file (class)

4.1.2 binge/src/backends/uffi.lisp

Parent

backends (module)

Location

src/backends/uffi.lisp

Exported Definitions

• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• uffi-backend (class)
• use-packages (method)

Internal Definitions

• ffi-sizeof (method)
• uffi-format-compound (function)

4.1.3 binge/src/backends/sbcl.lisp

Dependency

uffi.lisp (file)

Parent

backends (module)

Location

src/backends/sbcl.lisp

Exported Definitions

• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• sbcl-backend (class)
• use-packages (method)

Internal Definitions

• ffi-sizeof (method)
• sbcl-format-compound (function)

4.1.4 binge/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

• binge
• binge-compiler
• binge-backend
• binge-parser
• binge-lexer
• binge-grammar
• binge-decl
• binge-ss

4.1.5 binge/src/ss.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/ss.lisp

Exported Definitions

• file-offset (structure)
• fpos-column (function)
• (setf fpos-column) (function)
• fpos-line (function)
• (setf fpos-line) (function)
• get-position (generic function)
• get-position (method)
• open-stateful-stream (function)
• ss-bol (method)
• ss-column (method)
• ss-line (method)
• stateful-stream (class)
• with-open-stateful-stream (macro)

Internal Definitions

• copy-file-offset (function)
• file-offset-p (function)
• make-file-offset (function)

4.1.6 binge/src/lexer.lisp

Dependencies

• package.lisp (file)
• ss.lisp (file)
• grammar.lisp (file)

Parent

src (module)

Location

src/lexer.lisp

Exported Definitions

• get-position (method)
• make-parsable-stream (function)
• scan-file (function)
• skip-block (function)
• with-parsable-file (macro)

Internal Definitions

• +word-component-table+ (special variable)
• +word-start-table+ (special variable)
• copy-lexer-position (function)
• digit-value (function)
• fpos-file-name (function)
• (setf fpos-file-name) (function)
• fpos-token (function)
• (setf fpos-token) (function)
• get-rid-of-optional-ul (function)
• lexer-position (structure)
• lexer-position-p (function)
• make-lexer-position (function)
• make-parsable-file (function)
• make-presence-table (function)
• parsable-stream (class)
• read-character-sequence (function)
• read-dots (function)
• read-escape-sequence (function)
• read-integer-from-string (function)
• read-integer-number (function)
• read-number (function)
• read-pound-line (function)
• read-string (function)
• read-word (function)
• skip-to-eol (function)
• skip-whitespace (function)
• word-component-p (function)
• word-start-p (function)

4.1.7 binge/src/grammar.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/grammar.lisp

Exported Definitions

define-grammar (special variable)

Internal Definitions

• populate-grammar (function)
• typify-names (function)

4.1.8 binge/src/decl.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/decl.lisp

Exported Definitions

• anonymous-declaration-p (function)
• c-alternate-name (method)
• (setf c-alternate-name) (method)
• c-argument (class)
• c-arguments (method)
• (setf c-arguments) (method)
• c-array (class)
• c-bitfield (class)
• c-bits (method)
• (setf c-bits) (method)
• c-constant-declaration (class)
• c-constants (method)
• (setf c-constants) (method)
• c-container (class)
• c-declaration (class)
• c-dimensions (method)
• (setf c-dimensions) (method)
• c-documentation (method)
• (setf c-documentation) (method)
• c-enum-declaration (class)
• c-enum-ref (class)
• c-function (class)
• c-function-declaration (class)
• c-library (method)
• (setf c-library) (method)
• c-name (method)
• (setf c-name) (method)
• c-named-object (class)
• c-object (class)
• c-pointer (class)
• c-ref-name (method)
• (setf c-ref-name) (method)
• c-required (method)
• (setf c-required) (method)
• c-slot (class)
• c-slots (method)
• (setf c-slots) (method)
• c-struct-declaration (class)
• c-struct-ref (class)
• c-type (method)
• (setf c-type) (method)
• c-type (class)
• c-type-ref (class)
• c-typed-name (class)
• c-typed-object (class)
• c-typedef-declaration (class)
• c-union-declaration (class)
• c-union-ref (class)
• c-user-type-ref (class)
• c-value (method)
• (setf c-value) (method)
• c-variable-declaration (class)
• make-c-reference (generic function)
• make-c-reference (method)
• make-c-reference (method)
• make-c-reference (method)
• make-c-reference (method)
• primitive-type-p (function)

4.1.9 binge/src/binge.lisp

Dependencies

• package.lisp (file)
• compiler.lisp (file)
• decl.lisp (file)

Parent

src (module)

Location

src/binge.lisp

Exported Definitions

• *gcc-builtin-va_list* (special variable)
• make-ffi (generic function)
• make-ffi (method)
• make-ffi (method)
• make-ffi (method)
• make-ffi (method)

Internal Definitions

gather-all-requested-declarations (function)

4.1.10 binge/src/parser.lisp

Dependencies

• package.lisp (file)
• grammar.lisp (file)

Parent

src (module)

Location

src/parser.lisp

Exported Definitions

• *c-compiler* (special variable)
• *c-preprocessor* (special variable)
• *gcc-null-defines* (special variable)
• explain (function)
• extract (generic function)
• extract (method)
• extract (method)
• extract (method)
• extract-from-headers (function)

Internal Definitions

• *extract-constants-with-cc* (special variable)
• explain-c-object (generic function)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• extract-constants (function)
• write-c-source-for-compilation (function)
• write-c-source-for-parser (function)

4.1.11 binge/src/backend.lisp

Dependencies

• package.lisp (file)
• decl.lisp (file)

Parent

src (module)

Location

src/backend.lisp

Exported Definitions

• backend (class)
• backend-define-package (method)
• (setf backend-define-package) (method)
• backend-package (method)
• (setf backend-package) (method)
• c-object->ffi-notation (generic function)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object-lisp-name (generic function)
• c-object-lisp-name (method)
• c-object-lisp-name (method)
• c-object-lisp-name (method)
• use-packages (generic function)
• use-packages (method)
• write-epilogue (generic function)
• write-epilogue (method)
• write-prologue (generic function)
• write-prologue (method)

Internal Definitions

• backend-library (method)
• (setf backend-library) (method)
• backend-prefix (method)
• (setf backend-prefix) (method)
• convert-array-dimensions (function)
• convert-constant-expression (function)
• ffi-sizeof (generic function)

4.1.12 binge/src/namespace.lisp

Dependencies

• package.lisp (file)
• decl.lisp (file)

Parent

src (module)

Location

src/namespace.lisp

Exported Definitions

• add-declaration (generic function)
• add-declaration (method)
• add-declaration (method)
• add-declaration (method)
• c-constants (method)
• c-namespace (class)
• find-c-constant (generic function)
• find-c-constant (method)
• (setf find-c-constant) (method)
• (setf find-c-constant) (generic function)
• find-c-enum (generic function)
• find-c-enum (method)
• (setf find-c-enum) (method)
• (setf find-c-enum) (generic function)
• find-c-function (generic function)
• find-c-function (method)
• (setf find-c-function) (method)
• (setf find-c-function) (generic function)
• find-c-struct (generic function)
• find-c-struct (method)
• (setf find-c-struct) (method)
• (setf find-c-struct) (generic function)
• find-c-typedef (generic function)
• find-c-typedef (method)
• (setf find-c-typedef) (method)
• (setf find-c-typedef) (generic function)
• find-c-union (generic function)
• find-c-union (method)
• (setf find-c-union) (method)
• (setf find-c-union) (generic function)
• find-c-variable (generic function)
• find-c-variable (method)
• (setf find-c-variable) (method)
• (setf find-c-variable) (generic function)
• get-all-c-constants (function)
• get-all-c-functions (function)
• get-all-c-structs (function)
• get-all-c-typedefs (function)
• get-all-c-variables (function)
• populate-namespace (function)

Internal Definitions

• add-new-declaration (function)
• c-functions (method)
• c-structs (method)
• c-typedefs (method)
• c-variables (method)
• check-reference (generic function)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• find-declaration (generic function)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• (setf find-declaration) (generic function)
• hash-table-values-list (function)
• make-sure-referred-types-exist (generic function)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• substitute-declarations-with-references (generic function)
• substitute-declarations-with-references (method)
• substitute-declarations-with-references (method)
• substitute-declarations-with-references (method)
• transform-to-reference (generic function)
• transform-to-reference (method)
• transform-to-reference (method)
• transform-to-reference (method)

4.1.13 binge/src/compiler.lisp

Dependencies

• package.lisp (file)
• decl.lisp (file)
• namespace.lisp (file)

Parent

src (module)

Location

src/compiler.lisp

Exported Definitions

• *backend* (special variable)
• *compress-types* (special variable)
• c-object->ffi-notation (method)
• compilation-unsupported-error (condition)
• complete-declarations (function)
• write-declarations (function)
• write-package (function)

Internal Definitions

• add-presence-into-fslist (function)
• c-expression (generic function)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• collect-declarations (generic function)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• comp-error-declaration (method)
• (setf comp-error-declaration) (method)
• comp-error-item (method)
• compilation-error (condition)
• convert-compound-to-c-syntax (function)
• convert-to-c-syntax (generic function)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• fast-searchable-list (class)
• get-list (method)
• member-of-fslist (function)
• push-into-fslist (function)
• unalias-reference (generic function)
• unalias-reference (method)
• unalias-reference (method)

4.1.14 binge/example/package.lisp

Parent

example (module)

Location

example/package.lisp

Packages

binge-examples

4.1.15 binge/example/zlib.lisp

Dependency

package.lisp (file)

Parent

example (module)

Location

example/zlib.lisp

Exported Definitions

create-zlib-ffi (function)

Internal Definitions

*zlib-ffi-c-constants* (special variable)

4.1.16 binge/example/ncurses.lisp

Dependency

package.lisp (file)

Parent

example (module)

Location

example/ncurses.lisp

Exported Definitions

create-ncurses-ffi (function)

Internal Definitions

*ncurses-ffi-c-constants* (special variable)

4.1.17 binge/example/db.lisp

Dependency

package.lisp (file)

Parent

example (module)

Location

example/db.lisp

Exported Definitions

create-db-ffi (function)

Internal Definitions

*db-ffi-c-constants* (special variable)

4.1.18 binge/example/gtk.lisp

Dependency

package.lisp (file)

Parent

example (module)

Location

example/gtk.lisp

Exported Definitions

create-gtk-ffi (function)

Internal Definitions

*gtk-ffi-c-constants* (special variable)

4.1.19 binge/example/xlib.lisp

Dependency

package.lisp (file)

Parent

example (module)

Location

example/xlib.lisp

Exported Definitions

create-xlib-ffi (function)

Internal Definitions

*xlib-ffi-c-constants* (special variable)

4.2 Doc

4.2.1 binge/COPYING

Parent

binge (system)

Location

COPYING

4.2.2 binge/README

Parent

binge (system)

Location

README

4.2.3 binge/ANNOUNCE

Parent

binge (system)

Location

ANNOUNCE

4.3 Other

4.3.1 binge/.project

Parent

binge (system)

Location

.project

4.3.2 binge/src/backends/cmucl

Dependency

sbcl.lisp (file)

Parent

backends (module)

Location

src/backends/cmucl.lisp

4.3.3 binge/src/backends/lispworks

Dependency

cmucl (file)

Parent

backends (module)

Location

src/backends/lispworks.lisp

4.3.4 binge/src/backends/clisp

Dependency

lispworks (file)

Parent

backends (module)

Location

src/backends/clisp.lisp

5 Packages

Packages are listed by definition order.

5.1 binge-system

Source

binge.asd

Use List

• asdf/interface
• common-lisp

Internal Definitions

• *binge-base-directory* (special variable)
• inactive-file (class)

5.2 binge

Source

package.lisp (file)

Use List

• sclf
• binge-parser
• binge-compiler
• binge-decl
• common-lisp

Used By List

binge-examples

Exported Definitions

• *gcc-builtin-va_list* (special variable)
• make-ffi (generic function)
• make-ffi (method)
• make-ffi (method)
• make-ffi (method)
• make-ffi (method)

Internal Definitions

gather-all-requested-declarations (function)

5.3 binge-compiler

Source

package.lisp (file)

Use List

• binge-backend
• sclf
• binge-parser
• binge-decl
• common-lisp

Used By List

binge

Exported Definitions

• *backend* (special variable)
• *compress-types* (special variable)
• add-declaration (generic function)
• add-declaration (method)
• add-declaration (method)
• add-declaration (method)
• c-namespace (class)
• compilation-unsupported-error (condition)
• complete-declarations (function)
• find-c-constant (generic function)
• find-c-constant (method)
• (setf find-c-constant) (method)
• (setf find-c-constant) (generic function)
• find-c-enum (generic function)
• find-c-enum (method)
• (setf find-c-enum) (method)
• (setf find-c-enum) (generic function)
• find-c-function (generic function)
• find-c-function (method)
• (setf find-c-function) (method)
• (setf find-c-function) (generic function)
• find-c-struct (generic function)
• find-c-struct (method)
• (setf find-c-struct) (method)
• (setf find-c-struct) (generic function)
• find-c-typedef (generic function)
• find-c-typedef (method)
• (setf find-c-typedef) (method)
• (setf find-c-typedef) (generic function)
• find-c-union (generic function)
• find-c-union (method)
• (setf find-c-union) (method)
• (setf find-c-union) (generic function)
• find-c-variable (generic function)
• find-c-variable (method)
• (setf find-c-variable) (method)
• (setf find-c-variable) (generic function)
• get-all-c-constants (function)
• get-all-c-functions (function)
• get-all-c-structs (function)
• get-all-c-typedefs (function)
• get-all-c-variables (function)
• populate-namespace (function)
• write-declarations (function)
• write-package (function)

Internal Definitions

• add-new-declaration (function)
• add-presence-into-fslist (function)
• c-expression (generic function)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-expression (method)
• c-functions (generic function)
• c-functions (method)
• c-structs (generic function)
• c-structs (method)
• c-typedefs (generic function)
• c-typedefs (method)
• c-variables (generic function)
• c-variables (method)
• check-reference (generic function)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• check-reference (method)
• collect-declarations (generic function)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• collect-declarations (method)
• comp-error-declaration (generic function)
• comp-error-declaration (method)
• (setf comp-error-declaration) (method)
• (setf comp-error-declaration) (generic function)
• comp-error-item (generic function)
• comp-error-item (method)
• compilation-error (condition)
• convert-compound-to-c-syntax (function)
• convert-to-c-syntax (generic function)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• convert-to-c-syntax (method)
• fast-searchable-list (class)
• find-declaration (generic function)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• find-declaration (method)
• (setf find-declaration) (method)
• (setf find-declaration) (generic function)
• get-list (generic function)
• get-list (method)
• hash-table-values-list (function)
• make-sure-referred-types-exist (generic function)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• make-sure-referred-types-exist (method)
• member-of-fslist (function)
• push-into-fslist (function)
• substitute-declarations-with-references (generic function)
• substitute-declarations-with-references (method)
• substitute-declarations-with-references (method)
• substitute-declarations-with-references (method)
• transform-to-reference (generic function)
• transform-to-reference (method)
• transform-to-reference (method)
• transform-to-reference (method)
• unalias-reference (generic function)
• unalias-reference (method)
• unalias-reference (method)

5.4 binge-backend

Source

package.lisp (file)

Use List

• binge-decl
• sclf
• common-lisp

Used By List

binge-compiler

Exported Definitions

• backend (class)
• backend-define-package (generic function)
• backend-define-package (method)
• (setf backend-define-package) (method)
• (setf backend-define-package) (generic function)
• backend-package (generic function)
• backend-package (method)
• (setf backend-package) (method)
• (setf backend-package) (generic function)
• c-object->ffi-notation (generic function)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object->ffi-notation (method)
• c-object-lisp-name (generic function)
• c-object-lisp-name (method)
• c-object-lisp-name (method)
• c-object-lisp-name (method)
• sbcl-backend (class)
• uffi-backend (class)
• use-packages (generic function)
• use-packages (method)
• use-packages (method)
• use-packages (method)
• write-epilogue (generic function)
• write-epilogue (method)
• write-prologue (generic function)
• write-prologue (method)

Internal Definitions

• backend-library (generic function)
• backend-library (method)
• (setf backend-library) (method)
• (setf backend-library) (generic function)
• backend-prefix (generic function)
• backend-prefix (method)
• (setf backend-prefix) (method)
• (setf backend-prefix) (generic function)
• convert-array-dimensions (function)
• convert-constant-expression (function)
• ffi-sizeof (generic function)
• ffi-sizeof (method)
• ffi-sizeof (method)
• sbcl-format-compound (function)
• uffi-format-compound (function)

5.5 binge-parser

Source

package.lisp (file)

Use List

• binge-decl
• sclf
• common-lisp

Used By List

• binge
• binge-compiler

Exported Definitions

• *c-compiler* (special variable)
• *c-preprocessor* (special variable)
• *gcc-null-defines* (special variable)
• explain (function)
• extract (generic function)
• extract (method)
• extract (method)
• extract (method)
• extract-from-headers (function)

Internal Definitions

• *extract-constants-with-cc* (special variable)
• explain-c-object (generic function)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• explain-c-object (method)
• extract-constants (function)
• write-c-source-for-compilation (function)
• write-c-source-for-parser (function)

5.6 binge-lexer

Source

package.lisp (file)

Use List

• binge-ss
• binge-grammar
• naive-parser-generator
• sclf
• common-lisp

Exported Definitions

• make-parsable-stream (function)
• scan-file (function)
• skip-block (function)
• with-parsable-file (macro)

Internal Definitions

• +word-component-table+ (special variable)
• +word-start-table+ (special variable)
• copy-lexer-position (function)
• digit-value (function)
• fpos-file-name (function)
• (setf fpos-file-name) (function)
• fpos-token (function)
• (setf fpos-token) (function)
• get-rid-of-optional-ul (function)
• lexer-position (structure)
• lexer-position-p (function)
• make-lexer-position (function)
• make-parsable-file (function)
• make-presence-table (function)
• parsable-stream (class)
• read-character-sequence (function)
• read-dots (function)
• read-escape-sequence (function)
• read-integer-from-string (function)
• read-integer-number (function)
• read-number (function)
• read-pound-line (function)
• read-string (function)
• read-word (function)
• skip-to-eol (function)
• skip-whitespace (function)
• word-component-p (function)
• word-start-p (function)

5.7 binge-grammar

Source

package.lisp (file)

Use List

• binge-decl
• naive-parser-generator
• sclf
• common-lisp

Used By List

binge-lexer

Exported Definitions

define-grammar (special variable)

Internal Definitions

• populate-grammar (function)
• typify-names (function)

5.8 binge-decl

Source

package.lisp (file)

Use List

common-lisp

Used By List

• binge
• binge-compiler
• binge-backend
• binge-parser
• binge-grammar

Exported Definitions

• anonymous-declaration-p (function)
• c-alternate-name (generic function)
• c-alternate-name (method)
• (setf c-alternate-name) (method)
• (setf c-alternate-name) (generic function)
• c-argument (class)
• c-arguments (generic function)
• c-arguments (method)
• (setf c-arguments) (method)
• (setf c-arguments) (generic function)
• c-array (class)
• c-bitfield (class)
• c-bits (generic function)
• c-bits (method)
• (setf c-bits) (method)
• (setf c-bits) (generic function)
• c-constant-declaration (class)
• c-constants (generic function)
• c-constants (method)
• c-constants (method)
• (setf c-constants) (method)
• (setf c-constants) (generic function)
• c-container (class)
• c-declaration (class)
• c-dimensions (generic function)
• c-dimensions (method)
• (setf c-dimensions) (method)
• (setf c-dimensions) (generic function)
• c-documentation (generic function)
• c-documentation (method)
• (setf c-documentation) (method)
• (setf c-documentation) (generic function)
• c-enum-declaration (class)
• c-enum-ref (class)
• c-function (class)
• c-function-declaration (class)
• c-library (generic function)
• c-library (method)
• (setf c-library) (method)
• (setf c-library) (generic function)
• c-name (generic function)
• c-name (method)
• (setf c-name) (method)
• (setf c-name) (generic function)
• c-named-object (class)
• c-object (class)
• c-pointer (class)
• c-ref-name (generic function)
• c-ref-name (method)
• (setf c-ref-name) (method)
• (setf c-ref-name) (generic function)
• c-required (generic function)
• c-required (method)
• (setf c-required) (method)
• (setf c-required) (generic function)
• c-slot (class)
• c-slots (generic function)
• c-slots (method)
• (setf c-slots) (method)
• (setf c-slots) (generic function)
• c-struct-declaration (class)
• c-struct-ref (class)
• c-type (generic function)
• c-type (method)
• (setf c-type) (method)
• (setf c-type) (generic function)
• c-type (class)
• c-type-ref (class)
• c-typed-name (class)
• c-typed-object (class)
• c-typedef-declaration (class)
• c-union-declaration (class)
• c-union-ref (class)
• c-user-type-ref (class)
• c-value (generic function)
• c-value (method)
• (setf c-value) (method)
• (setf c-value) (generic function)
• c-variable-declaration (class)
• make-c-reference (generic function)
• make-c-reference (method)
• make-c-reference (method)
• make-c-reference (method)
• make-c-reference (method)
• primitive-type-p (function)

5.9 binge-ss

Source

package.lisp (file)

Use List

• sb-gray
• common-lisp

Used By List

binge-lexer

Exported Definitions

• file-offset (structure)
• fpos-column (function)
• (setf fpos-column) (function)
• fpos-line (function)
• (setf fpos-line) (function)
• get-position (generic function)
• get-position (method)
• get-position (method)
• open-stateful-stream (function)
• ss-bol (generic function)
• ss-bol (method)
• ss-column (generic function)
• ss-column (method)
• ss-line (generic function)
• ss-line (method)
• stateful-stream (class)
• with-open-stateful-stream (macro)

Internal Definitions

• copy-file-offset (function)
• file-offset-p (function)
• make-file-offset (function)

5.10 binge-examples

Source

package.lisp (file)

Use List

• binge
• common-lisp

Exported Definitions

• create-db-ffi (function)
• create-gtk-ffi (function)
• create-ncurses-ffi (function)
• create-xlib-ffi (function)
• create-zlib-ffi (function)

Internal Definitions

• *db-ffi-c-constants* (special variable)
• *gtk-ffi-c-constants* (special variable)
• *ncurses-ffi-c-constants* (special variable)
• *xlib-ffi-c-constants* (special variable)
• *zlib-ffi-c-constants* (special variable)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *backend*

Should hold the current backend to be used by the compiler.

Package

binge-compiler

Source

compiler.lisp (file)

Special Variable: *c-compiler*

Pathname or just the name of the C compiler program.

Package

binge-parser

Source

parser.lisp (file)

Special Variable: *c-preprocessor*

Pathname or just the name of the C preprocessor program.

Package

binge-parser

Source

parser.lisp (file)

Special Variable: *compress-types*

Whether or not the compiler should try to compress the type hierarchy to avoid writing unnecessary type declarations in the generated FFI. This variable can have one of the following values:

- NIL, don’t compress
- :TYPEDEFS, remove all the typedefs not required by user - :ALL, remove all the types that are not strictly required or requested by user.

Package

binge-compiler

Source

compiler.lisp (file)

Special Variable: *gcc-builtin-va_list*

If you parse gcc header files you might need this declaration added to your namespace.

Package

binge

Source

binge.lisp (file)

Special Variable: *gcc-null-defines*

List of preprocessor defines necessary to remove some special GCC features that would interfere with the parser.

Package

binge-parser

Source

parser.lisp (file)

Special Variable: define-grammar

Package

binge-grammar

Source

grammar.lisp (file)

6.1.2 Macros

Macro: with-open-stateful-stream (STREAM PATHNAME &rest OPEN-OPTIONS) &body BODY

Package

binge-ss

Source

ss.lisp (file)

Macro: with-parsable-file (VAR PATHNAME GRAMMAR) &body BODY

Package

binge-lexer

Source

lexer.lisp (file)

6.1.3 Functions

Function: anonymous-declaration-p DECL

Package

binge-decl

Source

decl.lisp (file)

Function: complete-declarations DECLARATION-LIST NAMESPACE

Package

binge-compiler

Source

compiler.lisp (file)

Function: create-db-ffi ()

Package

binge-examples

Source

db.lisp (file)

Function: create-gtk-ffi ()

Package

binge-examples

Source

gtk.lisp (file)

Function: create-ncurses-ffi ()

Package

binge-examples

Source

ncurses.lisp (file)

Function: create-xlib-ffi ()

Package

binge-examples

Source

xlib.lisp (file)

Function: create-zlib-ffi ()

Package

binge-examples

Source

zlib.lisp (file)

Function: explain STRING

Package

binge-parser

Source

parser.lisp (file)

Function: extract-from-headers INCLUDES &key PREAMBLE DEFINES CONSTANTS INCLUDE-PATHS

Extract all the definitions from INCLUDES files.

Package

binge-parser

Source

parser.lisp (file)

Function: fpos-column INSTANCE

Function: (setf fpos-column) VALUE INSTANCE

Package

binge-ss

Source

ss.lisp (file)

Function: fpos-line INSTANCE

Function: (setf fpos-line) VALUE INSTANCE

Package

binge-ss

Source

ss.lisp (file)

Function: get-all-c-constants NAMESPACE

Package

binge-compiler

Source

namespace.lisp (file)

Function: get-all-c-functions NAMESPACE

Package

binge-compiler

Source

namespace.lisp (file)

Function: get-all-c-structs NAMESPACE

Package

binge-compiler

Source

namespace.lisp (file)

Function: get-all-c-typedefs NAMESPACE

Package

binge-compiler

Source

namespace.lisp (file)

Function: get-all-c-variables NAMESPACE

Package

binge-compiler

Source

namespace.lisp (file)

Function: make-parsable-stream STREAM GRAMMAR

Package

binge-lexer

Source

lexer.lisp (file)

Function: open-stateful-stream PATHNAME &rest OPEN-OPTIONS

Package

binge-ss

Source

ss.lisp (file)

Function: populate-namespace NAMESPACE DECLARATIONS-LIST

Populate NAMESPACE it with declarations from DECLARATIONS-LIST.

Package

binge-compiler

Source

namespace.lisp (file)

Function: primitive-type-p OBJECT

Package

binge-decl

Source

decl.lisp (file)

Function: scan-file PATHNAME

Package

binge-lexer

Source

lexer.lisp (file)

Function: skip-block STREAM

This function is called upon seeing an open curly bracket, to skip everything up to the matching close bracket.

Package

binge-lexer

Source

lexer.lisp (file)

Function: write-declarations OUTPUT-STREAM DECLARATIONS-LIST

Write a list of declarations to OUTPUT-STREAM.

Package

binge-compiler

Source

compiler.lisp (file)

Function: write-package OUTPUT-STREAM DECLARATIONS

Write the package declaration to OUTPUT-STREAM. The package declaration is taken from DECLARATIONS. The package name is taken from BACKEND. If that slot is not set the whole declaration is skipped.

Package

binge-compiler

Source

compiler.lisp (file)

6.1.4 Generic functions

Generic Function: add-declaration DECLARATION NAMESPACE

Add DECLARATION in NAMESPACE, replacing original declaration if already present.

Package

binge-compiler

Source

namespace.lisp (file)

Methods

Method: add-declaration DECL (NAMESPACE c-namespace) after

Method: add-declaration (DECL c-variable-declaration) (NAMESPACE c-namespace)

Method: add-declaration (DECL c-declaration) (NAMESPACE c-namespace)

Generic Function: backend-define-package OBJECT

Generic Function: (setf backend-define-package) NEW-VALUE OBJECT

Package

binge-backend

Methods

Method: backend-define-package (BACKEND backend)

Method: (setf backend-define-package) NEW-VALUE (BACKEND backend)

If true define it’s own package.

Source

backend.lisp (file)

Generic Function: backend-package OBJECT

Generic Function: (setf backend-package) NEW-VALUE OBJECT

Package

binge-backend

Methods

Method: backend-package (BACKEND backend)

Method: (setf backend-package) NEW-VALUE (BACKEND backend)

Name of the package to write the FFI in.

Source

backend.lisp (file)

Generic Function: c-alternate-name OBJECT

Generic Function: (setf c-alternate-name) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-alternate-name (C-DECLARATION c-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-alternate-name) NEW-VALUE (C-DECLARATION c-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-arguments OBJECT

Generic Function: (setf c-arguments) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-arguments (C-FUNCTION c-function)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-arguments) NEW-VALUE (C-FUNCTION c-function)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-bits OBJECT

Generic Function: (setf c-bits) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-bits (C-BITFIELD c-bitfield)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-bits) NEW-VALUE (C-BITFIELD c-bitfield)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-constants OBJECT

Generic Function: (setf c-constants) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-constants (C-NAMESPACE c-namespace)

automatically generated reader method

Source

namespace.lisp (file)

Method: c-constants (C-ENUM-DECLARATION c-enum-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-constants) NEW-VALUE (C-ENUM-DECLARATION c-enum-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-dimensions OBJECT

Generic Function: (setf c-dimensions) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-dimensions (C-ARRAY c-array)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-dimensions) NEW-VALUE (C-ARRAY c-array)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-documentation OBJECT

Generic Function: (setf c-documentation) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-documentation (C-DECLARATION c-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-documentation) NEW-VALUE (C-DECLARATION c-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-library OBJECT

Generic Function: (setf c-library) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-library (C-DECLARATION c-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-library) NEW-VALUE (C-DECLARATION c-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-name OBJECT

Generic Function: (setf c-name) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-name (C-NAMED-OBJECT c-named-object)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-name) NEW-VALUE (C-NAMED-OBJECT c-named-object)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-object->ffi-notation OBJECT BACKEND

Convert a C object into a string according to the syntax of the specific FFI.

Package

binge-backend

Source

backend.lisp (file)

Methods

Method: c-object->ffi-notation (DECL c-variable-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-function-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-enum-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-union-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-struct-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-typedef-declaration) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT symbol) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-array) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-function) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-enum-ref) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-union-ref) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-struct-ref) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-user-type-ref) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-pointer) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-slot) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (OBJECT c-argument) (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: c-object->ffi-notation (DECL c-variable-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECL c-function-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECL c-enum-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECL c-union-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECL c-struct-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECL c-typedef-declaration) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT symbol) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-array) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-function) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-type-ref) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-pointer) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-slot) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (OBJECT c-argument) (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: c-object->ffi-notation (DECLARATION c-declaration) BACKEND around

Source

compiler.lisp (file)

Method: c-object->ffi-notation (OBJECT c-object) (BACKEND backend)

Method: c-object->ffi-notation (DECL c-constant-declaration) (BACKEND backend)

Generic Function: c-object-lisp-name DECLARATION BACKEND

Return the string of the Lisp name used for the DECLARATION. This may be different from the C name and is affected by BACKEND.

Package

binge-backend

Source

backend.lisp (file)

Methods

Method: c-object-lisp-name (DECLARATION c-type-ref) (BACKEND backend)

Method: c-object-lisp-name (DECLARATION c-named-object) (BACKEND backend)

Method: c-object-lisp-name (DECLARATION c-declaration) (BACKEND backend)

Generic Function: c-ref-name OBJECT

Generic Function: (setf c-ref-name) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-ref-name (C-TYPE-REF c-type-ref)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-ref-name) NEW-VALUE (C-TYPE-REF c-type-ref)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-required OBJECT

Generic Function: (setf c-required) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-required (C-DECLARATION c-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-required) NEW-VALUE (C-DECLARATION c-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-slots OBJECT

Generic Function: (setf c-slots) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-slots (C-CONTAINER c-container)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-slots) NEW-VALUE (C-CONTAINER c-container)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-type OBJECT

Generic Function: (setf c-type) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-type (C-TYPED-OBJECT c-typed-object)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-type) NEW-VALUE (C-TYPED-OBJECT c-typed-object)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: c-value OBJECT

Generic Function: (setf c-value) NEW-VALUE OBJECT

Package

binge-decl

Methods

Method: c-value (C-CONSTANT-DECLARATION c-constant-declaration)

automatically generated reader method

Source

decl.lisp (file)

Method: (setf c-value) NEW-VALUE (C-CONSTANT-DECLARATION c-constant-declaration)

automatically generated writer method

Source

decl.lisp (file)

Generic Function: extract INPUT

Extract a list of all the definitions from INPUT. Return a tagged list.

Package

binge-parser

Source

parser.lisp (file)

Methods

Method: extract (INPUT string)

Method: extract (INPUT pathname)

Method: extract (INPUT stream)

Generic Function: find-c-constant NAMESPACE NAME

Find constant declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-constant) (generic function)

Methods

Method: find-c-constant (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-constant) DECLARATION NAMESPACE NAME

Insert constant DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-constant (generic function)

Methods

Method: (setf find-c-constant) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-enum NAMESPACE NAME

Find enum declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-enum) (generic function)

Methods

Method: find-c-enum (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-enum) DECLARATION NAMESPACE NAME

Insert enum DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-enum (generic function)

Methods

Method: (setf find-c-enum) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-function NAMESPACE NAME

Find function declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-function) (generic function)

Methods

Method: find-c-function (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-function) DECLARATION NAMESPACE NAME

Insert function DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-function (generic function)

Methods

Method: (setf find-c-function) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-struct NAMESPACE NAME

Find struct declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-struct) (generic function)

Methods

Method: find-c-struct (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-struct) DECLARATION NAMESPACE NAME

Insert struct DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-struct (generic function)

Methods

Method: (setf find-c-struct) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-typedef NAMESPACE NAME

Find typedef declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-typedef) (generic function)

Methods

Method: find-c-typedef (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-typedef) DECLARATION NAMESPACE NAME

Insert typedef DECLARATION with NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-typedef (generic function)

Methods

Method: (setf find-c-typedef) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-union NAMESPACE NAME

Find union declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-union) (generic function)

Methods

Method: find-c-union (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-union) DECLARATION NAMESPACE NAME

Insert union DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-union (generic function)

Methods

Method: (setf find-c-union) VALUE (NAMESPACE c-namespace) NAME

Generic Function: find-c-variable NAMESPACE NAME

Find variable declaration named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Writer

(setf find-c-variable) (generic function)

Methods

Method: find-c-variable (NAMESPACE c-namespace) NAME

Generic Function: (setf find-c-variable) DECLARATION NAMESPACE NAME

Insert variable DECLARATION named NAME in NAMESPACE.

Package

binge-compiler

Source

namespace.lisp (file)

Reader

find-c-variable (generic function)

Methods

Method: (setf find-c-variable) VALUE (NAMESPACE c-namespace) NAME

Generic Function: get-position STREAM

Return position of stream. The position may be an object of the class FILE-OFFSET.

Package

binge-ss

Source

ss.lisp (file)

Methods

Method: get-position (STREAM parsable-stream)

Source

lexer.lisp (file)

Method: get-position (STREAM stateful-stream)

Generic Function: make-c-reference TYPE

Make a reference to TYPE if TYPE is among those referenciables (struct, union, enum), otherwise return NIL.

Package

binge-decl

Source

decl.lisp (file)

Methods

Method: make-c-reference (TYPE c-enum-declaration)

Method: make-c-reference (TYPE c-union-declaration)

Method: make-c-reference (TYPE c-struct-declaration)

Method: make-c-reference TYPE

Generic Function: make-ffi OUTPUT NAMESPACE &key CONSTANTS TYPES FUNCTIONS VARIABLES BACKEND

Write a FFI to OUTPUT from C declarations found in NAMESPACE. Select those you need sepcifying CONSTANTS, TYPES (struct, union, enum or typedef), FUNCTIONS and VARIABLES. If any of them is given the value T, all the declarations in that category are written.

Package

binge

Source

binge.lisp (file)

Methods

Method: make-ffi (OUTPUT (eql nil)) NAMESPACE &key CONSTANTS TYPES FUNCTIONS VARIABLES BACKEND

Method: make-ffi (OUTPUT (eql t)) NAMESPACE &key CONSTANTS TYPES FUNCTIONS VARIABLES BACKEND

Method: make-ffi (OUTPUT pathname) NAMESPACE &key CONSTANTS TYPES FUNCTIONS VARIABLES BACKEND

Method: make-ffi (OUTPUT stream) NAMESPACE &key CONSTANTS TYPES FUNCTIONS VARIABLES BACKEND

Generic Function: ss-bol OBJECT

Package

binge-ss

Methods

Method: ss-bol (STATEFUL-STREAM stateful-stream)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: ss-column OBJECT

Package

binge-ss

Methods

Method: ss-column (STATEFUL-STREAM stateful-stream)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: ss-line OBJECT

Package

binge-ss

Methods

Method: ss-line (STATEFUL-STREAM stateful-stream)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: use-packages BACKEND

Return the list of packages to use in making the package declaration for the FFI. Specialised by every backend.

Package

binge-backend

Source

backend.lisp (file)

Methods

Method: use-packages (BACKEND sbcl-backend)

Source

sbcl.lisp (file)

Method: use-packages (BACKEND uffi-backend)

Source

uffi.lisp (file)

Method: use-packages (BACKEND backend)

Generic Function: write-epilogue OUTPUT-STREAM BACKEND

Write an epilogue to OUTPUT-STREAM. Specialised by every backend.

Package

binge-backend

Source

backend.lisp (file)

Methods

Method: write-epilogue OUTPUT-STREAM (BACKEND backend)

Generic Function: write-prologue OUTPUT-STREAM BACKEND

Write a prologue to OUTPUT-STREAM. Specialised by every backend.

Package

binge-backend

Source

backend.lisp (file)

Methods

Method: write-prologue OUTPUT-STREAM (BACKEND backend)

6.1.5 Conditions

Condition: compilation-unsupported-error ()

Package

binge-compiler

Source

compiler.lisp (file)

Direct superclasses

compilation-error (condition)

Direct methods

comp-error-item (method)

Direct slots

Slot: item

Initargs

:item

Readers

comp-error-item (generic function)