The cl-with Reference Manual

This is the cl-with Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 05:35:39 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-with

WITH- group with- macros, allocate objects and rebind slots

Author

stacksmith <>

License

BSD 3-clause

Version

0.0.1

Dependencies
  • cffi (system).
  • closer-mop (system).
Source

cl-with.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-with/cl-with.asd

Source

cl-with.asd.

Parent Component

cl-with (system).

ASDF Systems

cl-with.


3.1.2 cl-with/package.lisp

Source

cl-with.asd.

Parent Component

cl-with (system).

Packages

with.


3.1.3 cl-with/util.lisp

Dependency

package.lisp (file).

Source

cl-with.asd.

Parent Component

cl-with (system).

Internals

3.1.4 cl-with/with-foreign-slots.lisp

Dependency

util.lisp (file).

Source

cl-with.asd.

Parent Component

cl-with (system).


3.1.5 cl-with/with.lisp

Dependency

with-foreign-slots.lisp (file).

Source

cl-with.asd.

Parent Component

cl-with (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 with

Source

package.lisp.

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

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with- (descriptor-or-descriptors &body body)

Expand descriptors, which may be:
* Existing with-foo forms, specified as (:open-file ...);
* Let-like forms, e.g. (x 5);
* Multiple-value-bind-like forms, ((x y z)(foo));
* Slots of structs, class instances or foreign objects:
(p :temp :int); create a foreign :int called p
(gpt :old (:struct gtk-g-point) "P1-") make slots x and y of an existing GTK point object called gpt available as ’p1-x’ and ’p1-y’.
Refer to docs for more examples

Package

with.

Source

with.lisp.

Macro: with-code ((&rest code) &body body)
Package

with.

Source

with.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *banlist*
Package

with.

Source

with.lisp.

Special Variable: cpoint
Package

with.

Source

with.lisp.


5.2.2 Macros

Macro: bancheck (inst descriptor)
Package

with.

Source

with.lisp.

Macro: listify (thing)
Package

with.

Source

util.lisp.

Macro: with-many ((descriptor &rest descriptors) &body body)
Package

with.

Source

with.lisp.

Macro: with-one (descriptor &body body)
Package

with.

Source

with.lisp.

Macro: with-with ((symbol &rest rest) &body body)
Package

with.

Source

with.lisp.


5.2.3 Ordinary functions

Function: as-string (thing)

Create a string from thing. If thing is a list or tree, flatten

Package

with.

Source

util.lisp.

Function: catstring (&rest things)

Convert every thing to a string, and return concatenation.

Package

with.

Source

util.lisp.

Function: clause-get-prefix-binds (params)
Package

with.

Source

with.lisp.

Function: copy-point (instance)
Package

with.

Source

with.lisp.

Function: default-bindings (prefix slots)
Package

with.

Source

with.lisp.

Function: find-symbol-or-die (name package &rest rest)
Package

with.

Source

util.lisp.

Function: fix-cffi-bindings (prefix binds slots)
Package

with.

Source

with.lisp.

Function: fix-lisp-bindings (prefix binds slots)
Package

with.

Source

with.lisp.

Function: make-point (&key x y)
Package

with.

Source

with.lisp.

Function: parse-foreign-built-in-type-params (inst cffitype params)
Package

with.

Source

with.lisp.

Function: point-p (object)
Package

with.

Source

with.lisp.

Reader: point-x (instance)
Writer: (setf point-x) (instance)
Package

with.

Source

with.lisp.

Target Slot

x.

Reader: point-y (instance)
Writer: (setf point-y) (instance)
Package

with.

Source

with.lisp.

Target Slot

y.

Function: symbolicate (&rest things)
Package

with.

Source

util.lisp.


5.2.4 Generic functions

Generic Function: get-new-clause (inst class body &rest rest)
Package

with.

Methods
Method: get-new-clause (inst (cffitype foreign-built-in-type) body &rest rest)
Source

with.lisp.

Method: get-new-clause (inst (cffitype foreign-type) body &rest rest)
Source

with.lisp.

Method: get-new-clause (inst (class class) body &rest rest)
Source

with.lisp.

Generic Function: get-old-clause (inst class body &rest rest)
Package

with.

Methods
Method: get-old-clause (inst (cffitype foreign-built-in-type) body &rest rest)
Source

with.lisp.

Method: get-old-clause (inst (cffitype foreign-type) body &rest rest)
Source

with.lisp.

Method: get-old-clause (inst (class class) body &rest rest)
Source

with.lisp.

Generic Function: get-slots (class)
Package

with.

Methods
Method: get-slots ((cffitype foreign-type))
Source

with.lisp.

Method: get-slots ((class class))
Source

with.lisp.

Generic Function: get-temp-clause (inst class body &rest rest)
Package

with.

Methods
Method: get-temp-clause (inst (cffitype foreign-built-in-type) body &rest rest)
Source

with.lisp.

Method: get-temp-clause (inst (cffitype foreign-type) body &rest rest)
Source

with.lisp.

Method: get-temp-clause (inst (class class) body &rest rest)
Source

with.lisp.

Generic Function: get-type-info (type clause &optional recursing)
Package

with.

Methods
Method: get-type-info ((class standard-class) clause &optional recursing)
Source

with.lisp.

Method: get-type-info ((class structure-class) clause &optional recursing)
Source

with.lisp.

Method: get-type-info ((type foreign-type) clause &optional recursing)
Source

with.lisp.

Method: get-type-info ((type symbol) clause &optional recursing)
Source

with.lisp.

Method: get-type-info ((type cons) clause &optional recursing)
Source

with.lisp.

Method: get-type-info (type clause &optional recursing)
Source

with.lisp.


5.2.5 Structures

Structure: point
Package

with.

Source

with.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: x
Readers

point-x.

Writers

(setf point-x).

Slot: y
Readers

point-y.

Writers

(setf point-y).


5.2.6 Classes

Class: cpoint
Package

with.

Source

with.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   F   G   L   M   P   S   W  
Index Entry  Section

(
(setf point-x): Private ordinary functions
(setf point-y): Private ordinary functions

A
as-string: Private ordinary functions

B
bancheck: Private macros

C
catstring: Private ordinary functions
clause-get-prefix-binds: Private ordinary functions
copy-point: Private ordinary functions

D
default-bindings: Private ordinary functions

F
find-symbol-or-die: Private ordinary functions
fix-cffi-bindings: Private ordinary functions
fix-lisp-bindings: Private ordinary functions
Function, (setf point-x): Private ordinary functions
Function, (setf point-y): Private ordinary functions
Function, as-string: Private ordinary functions
Function, catstring: Private ordinary functions
Function, clause-get-prefix-binds: Private ordinary functions
Function, copy-point: Private ordinary functions
Function, default-bindings: Private ordinary functions
Function, find-symbol-or-die: Private ordinary functions
Function, fix-cffi-bindings: Private ordinary functions
Function, fix-lisp-bindings: Private ordinary functions
Function, make-point: Private ordinary functions
Function, parse-foreign-built-in-type-params: Private ordinary functions
Function, point-p: Private ordinary functions
Function, point-x: Private ordinary functions
Function, point-y: Private ordinary functions
Function, symbolicate: Private ordinary functions

G
Generic Function, get-new-clause: Private generic functions
Generic Function, get-old-clause: Private generic functions
Generic Function, get-slots: Private generic functions
Generic Function, get-temp-clause: Private generic functions
Generic Function, get-type-info: Private generic functions
get-new-clause: Private generic functions
get-new-clause: Private generic functions
get-new-clause: Private generic functions
get-new-clause: Private generic functions
get-old-clause: Private generic functions
get-old-clause: Private generic functions
get-old-clause: Private generic functions
get-old-clause: Private generic functions
get-slots: Private generic functions
get-slots: Private generic functions
get-slots: Private generic functions
get-temp-clause: Private generic functions
get-temp-clause: Private generic functions
get-temp-clause: Private generic functions
get-temp-clause: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions
get-type-info: Private generic functions

L
listify: Private macros

M
Macro, bancheck: Private macros
Macro, listify: Private macros
Macro, with-: Public macros
Macro, with-code: Public macros
Macro, with-many: Private macros
Macro, with-one: Private macros
Macro, with-with: Private macros
make-point: Private ordinary functions
Method, get-new-clause: Private generic functions
Method, get-new-clause: Private generic functions
Method, get-new-clause: Private generic functions
Method, get-old-clause: Private generic functions
Method, get-old-clause: Private generic functions
Method, get-old-clause: Private generic functions
Method, get-slots: Private generic functions
Method, get-slots: Private generic functions
Method, get-temp-clause: Private generic functions
Method, get-temp-clause: Private generic functions
Method, get-temp-clause: Private generic functions
Method, get-type-info: Private generic functions
Method, get-type-info: Private generic functions
Method, get-type-info: Private generic functions
Method, get-type-info: Private generic functions
Method, get-type-info: Private generic functions
Method, get-type-info: Private generic functions

P
parse-foreign-built-in-type-params: Private ordinary functions
point-p: Private ordinary functions
point-x: Private ordinary functions
point-y: Private ordinary functions

S
symbolicate: Private ordinary functions

W
with-: Public macros
with-code: Public macros
with-many: Private macros
with-one: Private macros
with-with: Private macros