The hu.dwim.sdl Reference Manual

This is the hu.dwim.sdl Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 06:22:20 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 hu.dwim.sdl

Common Lisp FFI wrapper for libSDL2.

Author

Attila Lendvai

License

BSD or Bugroff

Version

0.1

Defsystem Dependency

cffi/c2ffi (system).

Dependencies
  • alexandria (system).
  • cffi (system).
  • cffi/c2ffi (system).
  • cffi-libffi (system).
Source

hu.dwim.sdl.asd.

Child Components

3 Modules

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


3.1 hu.dwim.sdl/source

Dependencies
Source

hu.dwim.sdl.asd.

Parent Component

hu.dwim.sdl (system).

Child Components

3.2 hu.dwim.sdl/c2ffi-spec

Dependency

ffi-prelude.lisp (file).

Source

hu.dwim.sdl.asd.

Parent Component

hu.dwim.sdl (system).

Child 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/hu.dwim.sdl.asd

Source

hu.dwim.sdl.asd.

Parent Component

hu.dwim.sdl (system).

ASDF Systems

hu.dwim.sdl.


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

Source

hu.dwim.sdl.asd.

Parent Component

hu.dwim.sdl (system).

Packages

hu.dwim.sdl.


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

Dependency

package-stage-1.lisp (file).

Source

hu.dwim.sdl.asd.

Parent Component

hu.dwim.sdl (system).

Public Interface
Internals

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

Source

hu.dwim.sdl.asd.

Parent Component

source (module).

Internals

import-all-owned-symbols (function).


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

Dependency

package-stage-2.lisp (file).

Source

hu.dwim.sdl.asd.

Parent Component

source (module).


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

Dependency

package-stage-3.lisp (file).

Source

hu.dwim.sdl.asd.

Parent Component

source (module).

Public Interface
Internals

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

Source

hu.dwim.sdl.asd.

Parent Component

c2ffi-spec (module).


5 Packages

Packages are listed by definition order.


5.1 hu.dwim.sdl

Source

package-stage-1.lisp.

Use List
  • alexandria.
  • cffi.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: c-fun/not-null (fn-name &rest args)
Package

hu.dwim.sdl.

Source

sdl.lisp.

Macro: c-fun/rc (fn-name &rest args)
Package

hu.dwim.sdl.

Source

sdl.lisp.


6.1.2 Standalone methods

Method: expand-from-foreign (value (type sdl-error-code))
Package

cffi.

Source

ffi-prelude.lisp.


6.1.3 Conditions

Condition: sdl-error
Package

hu.dwim.sdl.

Source

ffi-prelude.lisp.

Direct superclasses

error.

Direct subclasses

sdl-error/negative-return-code.


6.2 Internals


6.2.1 Ordinary functions

Function: %c-fun/not-null/check-error (rc fn-name whole-form)
Package

hu.dwim.sdl.

Source

sdl.lisp.

Function: %c-fun/rc/check-error (rc fn-name whole-form)
Package

hu.dwim.sdl.

Source

sdl.lisp.

Function: ffi-name-transformer (name kind &key &allow-other-keys)
Package

hu.dwim.sdl.

Source

ffi-prelude.lisp.

Function: ffi-type-transformer (type context &rest args &key &allow-other-keys)
Package

hu.dwim.sdl.

Source

ffi-prelude.lisp.

Function: import-all-owned-symbols (source-package target-package &key overwrite)
Package

hu.dwim.sdl.

Source

package-stage-2.lisp.


6.2.2 Generic functions

Generic Reader: error-code-of (condition)
Generic Writer: (setf error-code-of) (condition)
Package

hu.dwim.sdl.

Methods
Reader Method: error-code-of ((condition sdl-error/negative-return-code))
Writer Method: (setf error-code-of) ((condition sdl-error/negative-return-code))
Source

ffi-prelude.lisp.

Target Slot

error-code.


6.2.3 Conditions

Condition: sdl-error/negative-return-code
Package

hu.dwim.sdl.

Source

ffi-prelude.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: error-code
Initform

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

Initargs

:error-code

Readers

error-code-of.

Writers

(setf error-code-of).


6.2.4 Classes

Class: sdl-error-code
Package

hu.dwim.sdl.

Source

ffi-prelude.lisp.

Direct superclasses

foreign-type-alias.

Direct methods

expand-from-foreign.

Direct Default Initargs
InitargValue
:actual-type(parse-type int)

Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   E   S  
Index Entry  Section

E
error-code: Private conditions

S
Slot, error-code: Private conditions


A.4 Data types

Jump to:   C   F   H   M   P   S  
Index Entry  Section

C
c2ffi-spec: The hu․dwim․sdl/c2ffi-spec module
Class, sdl-error-code: Private classes
Condition, sdl-error: Public conditions
Condition, sdl-error/negative-return-code: Private conditions

F
ffi-prelude.lisp: The hu․dwim․sdl/ffi-prelude․lisp file
File, ffi-prelude.lisp: The hu․dwim․sdl/ffi-prelude․lisp file
File, hu.dwim.sdl.asd: The hu․dwim․sdl/hu․dwim․sdl․asd file
File, package-stage-1.lisp: The hu․dwim․sdl/package-stage-1․lisp file
File, package-stage-2.lisp: The hu․dwim․sdl/source/package-stage-2․lisp file
File, package-stage-3.lisp: The hu․dwim․sdl/source/package-stage-3․lisp file
File, sdl.h: The hu․dwim․sdl/c2ffi-spec/sdl․h file
File, sdl.lisp: The hu․dwim․sdl/source/sdl․lisp file

H
hu.dwim.sdl: The hu․dwim․sdl system
hu.dwim.sdl: The hu․dwim․sdl package
hu.dwim.sdl.asd: The hu․dwim․sdl/hu․dwim․sdl․asd file

M
Module, c2ffi-spec: The hu․dwim․sdl/c2ffi-spec module
Module, source: The hu․dwim․sdl/source module

P
Package, hu.dwim.sdl: The hu․dwim․sdl package
package-stage-1.lisp: The hu․dwim․sdl/package-stage-1․lisp file
package-stage-2.lisp: The hu․dwim․sdl/source/package-stage-2․lisp file
package-stage-3.lisp: The hu․dwim․sdl/source/package-stage-3․lisp file

S
sdl-error: Public conditions
sdl-error-code: Private classes
sdl-error/negative-return-code: Private conditions
sdl.h: The hu․dwim․sdl/c2ffi-spec/sdl․h file
sdl.lisp: The hu․dwim․sdl/source/sdl․lisp file
source: The hu․dwim․sdl/source module
System, hu.dwim.sdl: The hu․dwim․sdl system