The claw-utils Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The claw-utils Reference Manual

This is the claw-utils Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 12:59:29 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CLAW-UTILS

Various handy utilties to help autowrapping with :claw.

Requirements

Loading

(ql:quickload :claw-utils)

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 claw-utils

Dependencies
Source

claw-utils.asd (file)

Component

claw-utils.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 claw-utils.asd

Location

claw-utils.asd

Systems

claw-utils (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 claw-utils/claw-utils.lisp

Parent

claw-utils (system)

Location

claw-utils.lisp

Packages

claw-utils

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 claw-utils

Source

claw-utils.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-bitfield-from-constants NAME &body CONSTANTS
Package

claw-utils

Source

claw-utils.lisp (file)

Macro: define-bitfield-from-enum NAME ENUM
Package

claw-utils

Source

claw-utils.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: claw-array ()
Package

claw-utils

Source

claw-utils.lisp (file)

Direct superclasses

enhanced-foreign-type (class)

Direct methods
  • expand-to-foreign-dyn (method)
  • expand-from-foreign (method)
  • array-type-of (method)
Direct slots
Slot: array-type
Initargs

:array-type

Initform

(error ":array-type missing")

Readers

array-type-of (generic function)

Class: claw-pointer ()
Package

claw-utils

Source

claw-utils.lisp (file)

Direct superclasses

enhanced-foreign-type (class)

Direct methods
  • expand-from-foreign (method)
  • expand-to-foreign (method)
Class: claw-string ()
Package

claw-utils

Source

claw-utils.lisp (file)

Direct superclasses

enhanced-foreign-type (class)

Direct methods
  • expand-to-foreign-dyn (method)
  • expand-from-foreign (method)

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: with-foreign-array* (VAR ARRAY-OR-PTR TYPE) &body BODY
Package

claw-utils

Source

claw-utils.lisp (file)

Macro: with-foreign-string* (VAR STRING-OR-PTR &rest ARGS) &body BODY
Package

claw-utils

Source

claw-utils.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: array-type-of OBJECT
Package

claw-utils

Methods
Method: array-type-of (CLAW-ARRAY claw-array)

automatically generated reader method

Source

claw-utils.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
claw-utils.asd: The claw-utils․asd file
claw-utils/claw-utils.lisp: The claw-utils/claw-utils․lisp file

F
File, Lisp, claw-utils.asd: The claw-utils․asd file
File, Lisp, claw-utils/claw-utils.lisp: The claw-utils/claw-utils․lisp file

L
Lisp File, claw-utils.asd: The claw-utils․asd file
Lisp File, claw-utils/claw-utils.lisp: The claw-utils/claw-utils․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   D   G   M   W  
Index Entry  Section

A
array-type-of: Internal generic functions
array-type-of: Internal generic functions

D
define-bitfield-from-constants: Exported macros
define-bitfield-from-enum: Exported macros

G
Generic Function, array-type-of: Internal generic functions

M
Macro, define-bitfield-from-constants: Exported macros
Macro, define-bitfield-from-enum: Exported macros
Macro, with-foreign-array*: Internal macros
Macro, with-foreign-string*: Internal macros
Method, array-type-of: Internal generic functions

W
with-foreign-array*: Internal macros
with-foreign-string*: Internal macros

Jump to:   A   D   G   M   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   A   S  
Index Entry  Section

A
array-type: Exported classes

S
Slot, array-type: Exported classes

Jump to:   A   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, claw-array: Exported classes
Class, claw-pointer: Exported classes
Class, claw-string: Exported classes
claw-array: Exported classes
claw-pointer: Exported classes
claw-string: Exported classes
claw-utils: The claw-utils system
claw-utils: The claw-utils package

P
Package, claw-utils: The claw-utils package

S
System, claw-utils: The claw-utils system

Jump to:   C   P   S