The claw-utils Reference Manual

This is the claw-utils Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:50:25 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 claw-utils

Dependencies
  • alexandria (system).
  • cffi (system).
  • claw (system).
Source

claw-utils.asd.

Child Component

claw-utils.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-utils/claw-utils.asd

Source

claw-utils.asd.

Parent Component

claw-utils (system).

ASDF Systems

claw-utils.


3.1.2 claw-utils/claw-utils.lisp

Source

claw-utils.asd.

Parent Component

claw-utils (system).

Packages

claw-utils.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 claw-utils

Source

claw-utils.lisp.

Use List
  • alexandria.
  • 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: define-bitfield-from-constants (name &body constants)
Package

claw-utils.

Source

claw-utils.lisp.

Macro: define-bitfield-from-enum (name enum)
Package

claw-utils.

Source

claw-utils.lisp.


5.1.2 Standalone methods

Method: expand-from-foreign (value (type claw-pointer))
Package

cffi.

Source

claw-utils.lisp.

Method: expand-from-foreign (value (type claw-string))
Package

cffi.

Source

claw-utils.lisp.

Method: expand-from-foreign (value (type claw-array))
Package

cffi.

Source

claw-utils.lisp.

Method: expand-to-foreign (value (type claw-pointer))
Package

cffi.

Source

claw-utils.lisp.

Method: expand-to-foreign-dyn (value var body (type claw-string))
Package

cffi.

Source

claw-utils.lisp.

Method: expand-to-foreign-dyn (value var body (type claw-array))
Package

cffi.

Source

claw-utils.lisp.


5.1.3 Classes

Class: claw-array
Package

claw-utils.

Source

claw-utils.lisp.

Direct superclasses

enhanced-foreign-type.

Direct methods
Direct slots
Slot: array-type
Initform

(error ":array-type missing")

Initargs

:array-type

Readers

array-type-of.

Writers

This slot is read-only.

Class: claw-pointer
Package

claw-utils.

Source

claw-utils.lisp.

Direct superclasses

enhanced-foreign-type.

Direct methods
Class: claw-string
Package

claw-utils.

Source

claw-utils.lisp.

Direct superclasses

enhanced-foreign-type.

Direct methods

5.2 Internals


5.2.1 Macros

Macro: with-foreign-array* ((var array-or-ptr type) &body body)
Package

claw-utils.

Source

claw-utils.lisp.

Macro: with-foreign-string* ((var string-or-ptr &rest args) &body body)
Package

claw-utils.

Source

claw-utils.lisp.


5.2.2 Generic functions

Generic Reader: array-type-of (object)
Package

claw-utils.

Methods
Reader Method: array-type-of ((claw-array claw-array))

automatically generated reader method

Source

claw-utils.lisp.

Target Slot

array-type.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   A   S  
Index Entry  Section

A
array-type: Public classes

S
Slot, array-type: Public classes