The hu.dwim.sdl Reference Manual

Table of Contents

The hu.dwim.sdl Reference Manual

This is the hu.dwim.sdl Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 13:35:19 2021 GMT+0.

1 Introduction

hu.dwim.sdl

What

It's a Common Lisp FFI for http://libsdl.org/ (SDL2).

Why

The alternative projects are partial, while this one uses cffi/c2ffi to automatically generate the CFFI bindings for the various subsystems of SDL2.

It only requires vanilla CFFI when used, no extra dependencies.

Who

Written by attila@lendvai.name.

Where

The primary communication channel is the facilities on the project's GitHub page.

How

The project uses CFFI/C2FFI. Its ASDF extension does two things:

1. If needed it can invoke c2ffi to process a C header file and emit a c2ffi spec file (a json file) that contains every detail needed for a given platform to generate its FFI. Yours truely has run this phase and checked in the resulting spec files into the c2ffi-spec/ directory, so that users don't need to have a working c2ffi executable and the SDL dev headers installed.

2. Based on the spec file it generates the CFFI forms into a lisp file (placed next to the spec file) and continues as if it was just another lisp file written by hand. (These lisp files could also be checked in the repo, but for now they are not.)

Status

It contains a complete FFI for sdl.h, sdl-gfx.h, sdl-ttf.h, and sdl-image.h. Not much has been added yet to lispify the SDL API, but the CFFI binding part is complete.

2 Systems

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

2.1 hu.dwim.sdl

Author

Attila Lendvai

License

BSD or Bugroff

Description

Common Lisp FFI wrapper for libSDL2.

Version

0.1

Defsystem Dependency

cffi/c2ffi

Dependencies

• alexandria
• cffi
• cffi/c2ffi
• cffi-libffi

Source

hu.dwim.sdl.asd (file)

Components

• package-stage-1.lisp (file)
• ffi-prelude.lisp (file)
• source (module)
• c2ffi-spec (module)

3 Modules

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

3.1 hu.dwim.sdl/source

Dependencies

• c2ffi-spec (module)
• package-stage-1.lisp (file)

Parent

hu.dwim.sdl (system)

Location

source/

Components

• package-stage-2.lisp (file)
• package-stage-3.lisp (file)
• sdl.lisp (file)

3.2 hu.dwim.sdl/c2ffi-spec

Dependency

ffi-prelude.lisp (file)

Parent

hu.dwim.sdl (system)

Location

c2ffi-spec/

Component

sdl.h (file)

4 Files

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

4.1 Lisp

4.1.1 hu.dwim.sdl.asd

Location

hu.dwim.sdl.asd

Systems

hu.dwim.sdl (system)

4.1.2 hu.dwim.sdl/package-stage-1.lisp

Parent

hu.dwim.sdl (system)

Location

source/package-stage-1.lisp

Packages

hu.dwim.sdl

4.1.3 hu.dwim.sdl/ffi-prelude.lisp

Dependency

package-stage-1.lisp (file)

Parent

hu.dwim.sdl (system)

Location

source/ffi-prelude.lisp

Exported Definitions

sdl-error (condition)

Internal Definitions

• error-code-of (method)
• (setf error-code-of) (method)
• ffi-name-transformer (function)
• ffi-type-transformer (function)
• sdl-error-code (class)
• sdl-error/negative-return-code (condition)

4.1.4 hu.dwim.sdl/source/package-stage-2.lisp

Parent

source (module)

Location

source/package-stage-2.lisp

Internal Definitions

import-all-owned-symbols (function)

4.1.5 hu.dwim.sdl/source/package-stage-3.lisp

Dependency

package-stage-2.lisp (file)

Parent

source (module)

Location

source/package-stage-3.lisp

4.1.6 hu.dwim.sdl/source/sdl.lisp

Dependency

package-stage-3.lisp (file)

Parent

source (module)

Location

source/sdl.lisp

Exported Definitions

• c-fun/not-null (macro)
• c-fun/rc (macro)

Internal Definitions

• %c-fun/not-null/check-error (function)
• %c-fun/rc/check-error (function)

4.1.7 hu.dwim.sdl/c2ffi-spec/sdl.h

Parent

c2ffi-spec (module)

Location

c2ffi-spec/sdl.h

5 Packages

Packages are listed by definition order.

5.1 hu.dwim.sdl

Source

package-stage-1.lisp (file)

Use List

• cffi
• alexandria
• common-lisp

Exported Definitions

• c-fun/not-null (macro)
• c-fun/rc (macro)
• sdl-error (condition)

Internal Definitions

• %c-fun/not-null/check-error (function)
• %c-fun/rc/check-error (function)
• error-code-of (generic function)
• error-code-of (method)
• (setf error-code-of) (method)
• (setf error-code-of) (generic function)
• ffi-name-transformer (function)
• ffi-type-transformer (function)
• import-all-owned-symbols (function)
• sdl-error-code (class)
• sdl-error/negative-return-code (condition)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: c-fun/not-null FN-NAME &rest ARGS

Package

hu.dwim.sdl

Source

sdl.lisp (file)

Macro: c-fun/rc FN-NAME &rest ARGS

Package

hu.dwim.sdl

Source

sdl.lisp (file)

6.1.2 Conditions

Condition: sdl-error ()

Package

hu.dwim.sdl

Source

ffi-prelude.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

sdl-error/negative-return-code (condition)

6.2 Internal definitions

6.2.1 Functions

Function: %c-fun/not-null/check-error RC FN-NAME WHOLE-FORM

Package

hu.dwim.sdl

Source

sdl.lisp (file)

Function: %c-fun/rc/check-error RC FN-NAME WHOLE-FORM

Package

hu.dwim.sdl

Source

sdl.lisp (file)

Function: ffi-name-transformer NAME KIND &key &allow-other-keys

Package

hu.dwim.sdl

Source

ffi-prelude.lisp (file)

Function: ffi-type-transformer TYPE CONTEXT &rest ARGS &key &allow-other-keys

Package

hu.dwim.sdl

Source

ffi-prelude.lisp (file)

Function: import-all-owned-symbols SOURCE-PACKAGE TARGET-PACKAGE &key OVERWRITE

Package

hu.dwim.sdl

Source

package-stage-2.lisp (file)

6.2.2 Generic functions

Generic Function: error-code-of CONDITION

Generic Function: (setf error-code-of) NEW-VALUE CONDITION

Package

hu.dwim.sdl

Methods

Method: error-code-of (CONDITION sdl-error/negative-return-code)

Method: (setf error-code-of) NEW-VALUE (CONDITION sdl-error/negative-return-code)

Source

ffi-prelude.lisp (file)

6.2.3 Conditions

Condition: sdl-error/negative-return-code ()

Package

hu.dwim.sdl

Source

ffi-prelude.lisp (file)

Direct superclasses

• sdl-error (condition)
• simple-error (condition)

Direct methods

• error-code-of (method)
• error-code-of (method)

Direct slots

Slot: error-code

Initargs

:error-code

Initform

(quote (error "must specify error-code."))

Readers

error-code-of (generic function)

Writers

(setf error-code-of) (generic function)

6.2.4 Classes

Class: sdl-error-code ()

Package

hu.dwim.sdl

Source

ffi-prelude.lisp (file)

Direct superclasses

foreign-type-alias (class)

Direct methods

expand-from-foreign (method)

Direct Default Initargs

Initarg	Value
:actual-type	(cffi::parse-type :int)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types