The bodge-utilities Reference Manual
Table of Contents
The bodge-utilities Reference Manual
This is the bodge-utilities Reference Manual, version 1.0.0,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 11:52:13 2020 GMT+0.
1 Introduction
bodge-utilities
Various utilities for bodge
library collection.
ВНИМАНИЕ!
This system's sole purpose is to serve bodge libraries collection. Its API ain't
stable and you shouldn't use it in your systems. If you like something
bodge-util
provides, just copy-paste the thing into your p
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 bodge-utilities
- Author
Pavel Korolev
- Contact
dev@borodust.org
- License
MIT
- Description
Utility library
- Version
1.0.0
- Dependencies
- alexandria
- uiop
- log4cl
- local-time
- dissect
- split-sequence
- cffi
- claw
- static-vectors
- trivial-gray-streams
- Source
bodge-utilities.asd (file)
- Components
-
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 bodge-utilities.asd
- Location
/home/quickref/quicklisp/dists/quicklisp/software/bodge-utilities-stable-git/bodge-utilities.asd
- Systems
bodge-utilities (system)
3.1.2 bodge-utilities/packages.lisp
- Parent
bodge-utilities (system)
- Location
packages.lisp
- Packages
bodge-util
3.1.3 bodge-utilities/utils.lisp
- Dependency
packages.lisp (file)
- Parent
bodge-utilities (system)
- Location
utils.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.4 bodge-utilities/time.lisp
- Dependency
utils.lisp (file)
- Parent
bodge-utilities (system)
- Location
time.lisp
- Exported Definitions
-
3.1.5 bodge-utilities/language.lisp
- Dependency
time.lisp (file)
- Parent
bodge-utilities (system)
- Location
language.lisp
- Exported Definitions
-
3.1.6 bodge-utilities/collections.lisp
- Dependency
language.lisp (file)
- Parent
bodge-utilities (system)
- Location
collections.lisp
- Exported Definitions
-
3.1.7 bodge-utilities/foreign.lisp
- Dependency
collections.lisp (file)
- Parent
bodge-utilities (system)
- Location
foreign.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.8 bodge-utilities/strings.lisp
- Dependency
foreign.lisp (file)
- Parent
bodge-utilities (system)
- Location
strings.lisp
- Exported Definitions
-
- Internal Definitions
for-each-line (function)
3.1.9 bodge-utilities/trees.lisp
- Dependency
strings.lisp (file)
- Parent
bodge-utilities (system)
- Location
trees.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.10 bodge-utilities/arrays.lisp
- Dependency
trees.lisp (file)
- Parent
bodge-utilities (system)
- Location
arrays.lisp
- Exported Definitions
-
- Internal Definitions
-
3.1.11 bodge-utilities/streams.lisp
- Dependency
arrays.lisp (file)
- Parent
bodge-utilities (system)
- Location
streams.lisp
- Exported Definitions
-
- Internal Definitions
bounded-input-stream (class)
4 Packages
Packages are listed by definition order.
4.1 bodge-util
- Source
packages.lisp (file)
- Use List
- trivial-gray-streams
- static-vectors
- split-sequence
- alexandria
- local-time
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
5 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
5.1 Exported definitions
5.1.1 Macros
- Macro: bind-for-serious-condition (HANDLER) &body BODY
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: bound-symbol-value SYMBOL &optional DEFAULT-VALUE
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: defenum NAME &body VALUES
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: define-package PACKAGE &body CLAUSES
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: definline NAME LAMBDA-LIST &body BODY
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: deflogger NAME-AND-OPTS
-
- Package
bodge-util
- Source
utils.lisp (file)
- Macro: dochildren (VAR PARENT) &body BODY
-
- Package
bodge-util
- Source
trees.lisp (file)
- Macro: dolines (LINE-VAR TEXT &optional RESULT-FORM) &body BODY
-
- Package
bodge-util
- Source
strings.lisp (file)
- Macro: dotree (VAR ROOT &optional ORDER) &body BODY
-
- Package
bodge-util
- Source
trees.lisp (file)
- Macro: ensure-not-null VALUE
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: float-array INITIAL-CONTENTS
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Macro: if-bound SYMBOL-OR-LIST THEN-FORM &optional ELSE-FORM
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: in-development-mode &body BODY
-
- Package
bodge-util
- Source
utils.lisp (file)
- Macro: log-errors &body BODY
-
- Package
bodge-util
- Source
utils.lisp (file)
- Macro: make-hash-table-with-entries (&rest INITARGS) &body PAIRS
-
- Package
bodge-util
- Source
collections.lisp (file)
- Macro: parent-tree (PARENT &optional CHILD-CTOR) &body CHILDREN
-
- Package
bodge-util
- Source
trees.lisp (file)
- Macro: when-bound SYMBOL-OR-LIST &body BODY
-
- Package
bodge-util
- Source
language.lisp (file)
- Macro: with-hash-entries (&rest KEYS) HASH-TABLE &body BODY
-
- Package
bodge-util
- Source
collections.lisp (file)
- Macro: with-locale (NAME) &body BODY
-
- Package
bodge-util
- Source
foreign.lisp (file)
- Macro: with-simple-array-pointer (POINTER-VAR SIMPLE-ARRAY) &body BODY
-
- Package
bodge-util
- Source
arrays.lisp (file)
5.1.2 Functions
- Function: apply-argument-list LAMBDA-LIST
-
- Package
bodge-util
- Source
language.lisp (file)
- Function: class-name-of OBJ
-
- Package
bodge-util
- Source
language.lisp (file)
- Function: current-executable-path ()
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: current-file-truename ()
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: epoch-seconds &optional TIMESTAMP
-
- Package
bodge-util
- Source
time.lisp (file)
- Function: expand-array ARRAY DIMENSIONS
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: f VALUE
-
- Package
bodge-util
- Source
language.lisp (file)
- Function: file->byte-array PATHNAME &optional ELEMENT-TYPE
-
- Package
bodge-util
- Source
streams.lisp (file)
- Function: flatten-array ARRAY
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: getenv NAME
-
- Function: (setf getenv) VALUE NAME
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: if-null VALUE DEFAULT
-
- Package
bodge-util
- Source
language.lisp (file)
- Function: list->array LIST &rest DIMENSIONS
-
- Package
bodge-util
- Source
collections.lisp (file)
- Function: make-bounded-input-stream STREAM BOUND
-
- Package
bodge-util
- Source
streams.lisp (file)
- Function: make-mutable-string &optional LENGTH
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: mutate-string STRING CONTROL-STRING &rest ARGUMENTS
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: parse-initargs-and-list INITARGS-AND-LIST
-
- Package
bodge-util
- Source
language.lisp (file)
- Function: real-time-seconds ()
-
- Package
bodge-util
- Source
time.lisp (file)
- Function: replace-all STRING PART REPLACEMENT &key TEST
-
Returns a new string in which all the occurences of the part is replaced with replacement.
- Package
bodge-util
- Source
strings.lisp (file)
- Function: search-sorted VALUE SORTED-ARRAY &key TEST PREDICATE KEY
-
- Package
bodge-util
- Source
collections.lisp (file)
- Function: shout CONTROL-STRING &rest ARGS
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: stream->byte-array STREAM &key INITIAL-SIZE
-
- Package
bodge-util
- Source
streams.lisp (file)
- Function: string->immutable STRING
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: string->mutable STRING
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: stringify VALUE &optional FORMAT-STRING
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: system-relative-pathname SYSTEM-NAME PATHNAME
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: translate-name-from-foreign NAME
-
- Package
bodge-util
- Source
foreign.lisp (file)
- Function: translate-name-to-foreign SYMBOL
-
- Package
bodge-util
- Source
foreign.lisp (file)
- Function: universal-time->epoch UNIVERSAL
-
- Package
bodge-util
- Source
time.lisp (file)
5.1.3 Generic functions
- Generic Function: abandon PARENT CHILD
-
- Package
bodge-util
- Source
trees.lisp (file)
- Methods
- Method: abandon (THIS parent) CHILD
-
- Generic Function: abandon-all PARENT
-
- Package
bodge-util
- Source
trees.lisp (file)
- Methods
- Method: abandon-all (THIS parent)
-
- Generic Function: abandoned CHILD PARENT
-
- Package
bodge-util
- Source
trees.lisp (file)
- Methods
- Method: abandoned CHILD PARENT
-
- Generic Function: adopt PARENT CHILD
-
- Package
bodge-util
- Source
trees.lisp (file)
- Methods
- Method: adopt (THIS parent) CHILD
-
- Generic Function: adopted CHILD PARENT
-
- Package
bodge-util
- Source
trees.lisp (file)
- Methods
- Method: adopted CHILD PARENT
-
- Generic Function: children-of OBJECT
-
- Package
bodge-util
- Methods
- Method: children-of (PARENT parent)
-
automatically generated reader method
- Source
trees.lisp (file)
5.1.4 Classes
- Class: parent ()
-
- Package
bodge-util
- Source
trees.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
-
- Direct slots
- Slot: children
-
- Initform
(quote nil)
- Readers
children-of (generic function)
5.2 Internal definitions
5.2.1 Constants
- Constant: +lc-all+
-
- Package
bodge-util
- Source
foreign.lisp (file)
5.2.2 Functions
- Function: %do-tree-postorder ROOT ACTION
-
- Package
bodge-util
- Source
trees.lisp (file)
- Function: %do-tree-preorder ROOT ACTION
-
- Package
bodge-util
- Source
trees.lisp (file)
- Function: %next-slice DIMENSIONS SLICE
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: find-dimensions SEQUENCE
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: flat-index OBJ
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: for-each-line TEXT ACTION
-
- Package
bodge-util
- Source
strings.lisp (file)
- Function: invoke-bodgy FU
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: next-slice OBJ
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Function: raise-ignorable E
-
- Package
bodge-util
- Source
utils.lisp (file)
- Function: set-locale CATEGORY LOCALE
-
- Package
bodge-util
- Source
foreign.lisp (file)
- Function: slice OBJ
-
Current indices
- Package
bodge-util
- Source
arrays.lisp (file)
5.2.3 Classes
- Class: array-slice ()
-
- Package
bodge-util
- Source
arrays.lisp (file)
- Direct superclasses
standard-object (class)
- Direct methods
initialize-instance (method)
- Direct slots
- Slot: dimensions
-
- Slot: slice
-
- Class: bounded-input-stream ()
-
- Package
bodge-util
- Source
streams.lisp (file)
- Direct superclasses
fundamental-input-stream (class)
- Direct methods
- stream-read-line (method)
- stream-read-char-no-hang (method)
- stream-read-char (method)
- stream-read-byte (method)
- stream-read-sequence (method)
- stream-peek-char (method)
- stream-file-position (method)
- stream-file-position (method)
- Direct slots
- Slot: stream
-
- Initargs
:stream
- Initform
(error ":stream missing")
- Slot: position
-
- Type
fixnum
- Initargs
:position
- Initform
0
- Slot: bound
-
- Type
fixnum
- Initargs
:bound
- Initform
-1
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
B | | |
| bodge-utilities.asd: | | The bodge-utilities․asd file |
| bodge-utilities/arrays.lisp: | | The bodge-utilities/arrays․lisp file |
| bodge-utilities/collections.lisp: | | The bodge-utilities/collections․lisp file |
| bodge-utilities/foreign.lisp: | | The bodge-utilities/foreign․lisp file |
| bodge-utilities/language.lisp: | | The bodge-utilities/language․lisp file |
| bodge-utilities/packages.lisp: | | The bodge-utilities/packages․lisp file |
| bodge-utilities/streams.lisp: | | The bodge-utilities/streams․lisp file |
| bodge-utilities/strings.lisp: | | The bodge-utilities/strings․lisp file |
| bodge-utilities/time.lisp: | | The bodge-utilities/time․lisp file |
| bodge-utilities/trees.lisp: | | The bodge-utilities/trees․lisp file |
| bodge-utilities/utils.lisp: | | The bodge-utilities/utils․lisp file |
|
F | | |
| File, Lisp, bodge-utilities.asd: | | The bodge-utilities․asd file |
| File, Lisp, bodge-utilities/arrays.lisp: | | The bodge-utilities/arrays․lisp file |
| File, Lisp, bodge-utilities/collections.lisp: | | The bodge-utilities/collections․lisp file |
| File, Lisp, bodge-utilities/foreign.lisp: | | The bodge-utilities/foreign․lisp file |
| File, Lisp, bodge-utilities/language.lisp: | | The bodge-utilities/language․lisp file |
| File, Lisp, bodge-utilities/packages.lisp: | | The bodge-utilities/packages․lisp file |
| File, Lisp, bodge-utilities/streams.lisp: | | The bodge-utilities/streams․lisp file |
| File, Lisp, bodge-utilities/strings.lisp: | | The bodge-utilities/strings․lisp file |
| File, Lisp, bodge-utilities/time.lisp: | | The bodge-utilities/time․lisp file |
| File, Lisp, bodge-utilities/trees.lisp: | | The bodge-utilities/trees․lisp file |
| File, Lisp, bodge-utilities/utils.lisp: | | The bodge-utilities/utils․lisp file |
|
L | | |
| Lisp File, bodge-utilities.asd: | | The bodge-utilities․asd file |
| Lisp File, bodge-utilities/arrays.lisp: | | The bodge-utilities/arrays․lisp file |
| Lisp File, bodge-utilities/collections.lisp: | | The bodge-utilities/collections․lisp file |
| Lisp File, bodge-utilities/foreign.lisp: | | The bodge-utilities/foreign․lisp file |
| Lisp File, bodge-utilities/language.lisp: | | The bodge-utilities/language․lisp file |
| Lisp File, bodge-utilities/packages.lisp: | | The bodge-utilities/packages․lisp file |
| Lisp File, bodge-utilities/streams.lisp: | | The bodge-utilities/streams․lisp file |
| Lisp File, bodge-utilities/strings.lisp: | | The bodge-utilities/strings․lisp file |
| Lisp File, bodge-utilities/time.lisp: | | The bodge-utilities/time․lisp file |
| Lisp File, bodge-utilities/trees.lisp: | | The bodge-utilities/trees․lisp file |
| Lisp File, bodge-utilities/utils.lisp: | | The bodge-utilities/utils․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
% | | |
| %do-tree-postorder : | | Internal functions |
| %do-tree-preorder : | | Internal functions |
| %next-slice : | | Internal functions |
|
( | | |
| (setf getenv) : | | Exported functions |
|
A | | |
| abandon : | | Exported generic functions |
| abandon : | | Exported generic functions |
| abandon-all : | | Exported generic functions |
| abandon-all : | | Exported generic functions |
| abandoned : | | Exported generic functions |
| abandoned : | | Exported generic functions |
| adopt : | | Exported generic functions |
| adopt : | | Exported generic functions |
| adopted : | | Exported generic functions |
| adopted : | | Exported generic functions |
| apply-argument-list : | | Exported functions |
|
B | | |
| bind-for-serious-condition : | | Exported macros |
| bound-symbol-value : | | Exported macros |
|
C | | |
| children-of : | | Exported generic functions |
| children-of : | | Exported generic functions |
| class-name-of : | | Exported functions |
| current-executable-path : | | Exported functions |
| current-file-truename : | | Exported functions |
|
D | | |
| defenum : | | Exported macros |
| define-package : | | Exported macros |
| definline : | | Exported macros |
| deflogger : | | Exported macros |
| dochildren : | | Exported macros |
| dolines : | | Exported macros |
| dotree : | | Exported macros |
|
E | | |
| ensure-not-null : | | Exported macros |
| epoch-seconds : | | Exported functions |
| expand-array : | | Exported functions |
|
F | | |
| f : | | Exported functions |
| file->byte-array : | | Exported functions |
| find-dimensions : | | Internal functions |
| flat-index : | | Internal functions |
| flatten-array : | | Exported functions |
| float-array : | | Exported macros |
| for-each-line : | | Internal functions |
| Function, %do-tree-postorder : | | Internal functions |
| Function, %do-tree-preorder : | | Internal functions |
| Function, %next-slice : | | Internal functions |
| Function, (setf getenv) : | | Exported functions |
| Function, apply-argument-list : | | Exported functions |
| Function, class-name-of : | | Exported functions |
| Function, current-executable-path : | | Exported functions |
| Function, current-file-truename : | | Exported functions |
| Function, epoch-seconds : | | Exported functions |
| Function, expand-array : | | Exported functions |
| Function, f : | | Exported functions |
| Function, file->byte-array : | | Exported functions |
| Function, find-dimensions : | | Internal functions |
| Function, flat-index : | | Internal functions |
| Function, flatten-array : | | Exported functions |
| Function, for-each-line : | | Internal functions |
| Function, getenv : | | Exported functions |
| Function, if-null : | | Exported functions |
| Function, invoke-bodgy : | | Internal functions |
| Function, list->array : | | Exported functions |
| Function, make-bounded-input-stream : | | Exported functions |
| Function, make-mutable-string : | | Exported functions |
| Function, mutate-string : | | Exported functions |
| Function, next-slice : | | Internal functions |
| Function, parse-initargs-and-list : | | Exported functions |
| Function, raise-ignorable : | | Internal functions |
| Function, real-time-seconds : | | Exported functions |
| Function, replace-all : | | Exported functions |
| Function, search-sorted : | | Exported functions |
| Function, set-locale : | | Internal functions |
| Function, shout : | | Exported functions |
| Function, slice : | | Internal functions |
| Function, stream->byte-array : | | Exported functions |
| Function, string->immutable : | | Exported functions |
| Function, string->mutable : | | Exported functions |
| Function, stringify : | | Exported functions |
| Function, system-relative-pathname : | | Exported functions |
| Function, translate-name-from-foreign : | | Exported functions |
| Function, translate-name-to-foreign : | | Exported functions |
| Function, universal-time->epoch : | | Exported functions |
|
G | | |
| Generic Function, abandon : | | Exported generic functions |
| Generic Function, abandon-all : | | Exported generic functions |
| Generic Function, abandoned : | | Exported generic functions |
| Generic Function, adopt : | | Exported generic functions |
| Generic Function, adopted : | | Exported generic functions |
| Generic Function, children-of : | | Exported generic functions |
| getenv : | | Exported functions |
|
I | | |
| if-bound : | | Exported macros |
| if-null : | | Exported functions |
| in-development-mode : | | Exported macros |
| invoke-bodgy : | | Internal functions |
|
L | | |
| list->array : | | Exported functions |
| log-errors : | | Exported macros |
|
M | | |
| Macro, bind-for-serious-condition : | | Exported macros |
| Macro, bound-symbol-value : | | Exported macros |
| Macro, defenum : | | Exported macros |
| Macro, define-package : | | Exported macros |
| Macro, definline : | | Exported macros |
| Macro, deflogger : | | Exported macros |
| Macro, dochildren : | | Exported macros |
| Macro, dolines : | | Exported macros |
| Macro, dotree : | | Exported macros |
| Macro, ensure-not-null : | | Exported macros |
| Macro, float-array : | | Exported macros |
| Macro, if-bound : | | Exported macros |
| Macro, in-development-mode : | | Exported macros |
| Macro, log-errors : | | Exported macros |
| Macro, make-hash-table-with-entries : | | Exported macros |
| Macro, parent-tree : | | Exported macros |
| Macro, when-bound : | | Exported macros |
| Macro, with-hash-entries : | | Exported macros |
| Macro, with-locale : | | Exported macros |
| Macro, with-simple-array-pointer : | | Exported macros |
| make-bounded-input-stream : | | Exported functions |
| make-hash-table-with-entries : | | Exported macros |
| make-mutable-string : | | Exported functions |
| Method, abandon : | | Exported generic functions |
| Method, abandon-all : | | Exported generic functions |
| Method, abandoned : | | Exported generic functions |
| Method, adopt : | | Exported generic functions |
| Method, adopted : | | Exported generic functions |
| Method, children-of : | | Exported generic functions |
| mutate-string : | | Exported functions |
|
N | | |
| next-slice : | | Internal functions |
|
P | | |
| parent-tree : | | Exported macros |
| parse-initargs-and-list : | | Exported functions |
|
R | | |
| raise-ignorable : | | Internal functions |
| real-time-seconds : | | Exported functions |
| replace-all : | | Exported functions |
|
S | | |
| search-sorted : | | Exported functions |
| set-locale : | | Internal functions |
| shout : | | Exported functions |
| slice : | | Internal functions |
| stream->byte-array : | | Exported functions |
| string->immutable : | | Exported functions |
| string->mutable : | | Exported functions |
| stringify : | | Exported functions |
| system-relative-pathname : | | Exported functions |
|
T | | |
| translate-name-from-foreign : | | Exported functions |
| translate-name-to-foreign : | | Exported functions |
|
U | | |
| universal-time->epoch : | | Exported functions |
|
W | | |
| when-bound : | | Exported macros |
| with-hash-entries : | | Exported macros |
| with-locale : | | Exported macros |
| with-simple-array-pointer : | | Exported macros |
|
A.3 Variables
A.4 Data types