The bodge-utilities Reference Manual

This is the bodge-utilities Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 16:31:33 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 bodge-utilities

Utility library

Author

Pavel Korolev

Contact

License

MIT

Version

1.0.0

Dependencies
  • alexandria (system).
  • uiop (system).
  • log4cl (system).
  • local-time (system).
  • dissect (system).
  • split-sequence (system).
  • cffi (system).
  • claw (system).
  • static-vectors (system).
  • trivial-gray-streams (system).
Source

bodge-utilities.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 bodge-utilities/bodge-utilities.asd

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

ASDF Systems

bodge-utilities.


3.1.2 bodge-utilities/packages.lisp

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Packages

bodge-util.


3.1.3 bodge-utilities/utils.lisp

Dependency

packages.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

3.1.4 bodge-utilities/time.lisp

Dependency

utils.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface

3.1.5 bodge-utilities/language.lisp

Dependency

time.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface

3.1.6 bodge-utilities/collections.lisp

Dependency

language.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface

3.1.7 bodge-utilities/foreign.lisp

Dependency

collections.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

3.1.8 bodge-utilities/strings.lisp

Dependency

foreign.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

for-each-line (function).


3.1.9 bodge-utilities/trees.lisp

Dependency

strings.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

3.1.10 bodge-utilities/arrays.lisp

Dependency

trees.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

3.1.11 bodge-utilities/streams.lisp

Dependency

arrays.lisp (file).

Source

bodge-utilities.asd.

Parent Component

bodge-utilities (system).

Public Interface
Internals

bounded-input-stream (class).


4 Packages

Packages are listed by definition order.


4.1 bodge-util

Source

packages.lisp.

Use List
  • alexandria.
  • common-lisp.
  • local-time.
  • split-sequence.
  • static-vectors.
  • trivial-gray-streams.
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: bind-for-serious-condition ((handler) &body body)
Package

bodge-util.

Source

language.lisp.

Macro: bound-symbol-value (symbol &optional default-value)
Package

bodge-util.

Source

language.lisp.

Macro: defenum (name &body values)
Package

bodge-util.

Source

language.lisp.

Macro: define-package (package &body clauses)
Package

bodge-util.

Source

language.lisp.

Macro: definline (name lambda-list &body body)
Package

bodge-util.

Source

language.lisp.

Macro: deflogger (name-and-opts)
Package

bodge-util.

Source

utils.lisp.

Macro: dochildren ((var parent) &body body)
Package

bodge-util.

Source

trees.lisp.

Macro: dolines ((line-var text &optional result-form) &body body)
Package

bodge-util.

Source

strings.lisp.

Macro: dotree ((var root &optional order) &body body)
Package

bodge-util.

Source

trees.lisp.

Macro: ensure-not-null (value)
Package

bodge-util.

Source

language.lisp.

Macro: float-array (initial-contents)
Package

bodge-util.

Source

arrays.lisp.

Macro: if-bound (symbol-or-list then-form &optional else-form)
Package

bodge-util.

Source

language.lisp.

Macro: in-development-mode (&body body)
Package

bodge-util.

Source

utils.lisp.

Macro: log-errors (&body body)
Package

bodge-util.

Source

utils.lisp.

Macro: make-hash-table-with-entries ((&rest initargs) &body pairs)
Package

bodge-util.

Source

collections.lisp.

Macro: parent-tree ((parent &optional child-ctor) &body children)
Package

bodge-util.

Source

trees.lisp.

Macro: when-bound (symbol-or-list &body body)
Package

bodge-util.

Source

language.lisp.

Macro: with-hash-entries ((&rest keys) hash-table &body body)
Package

bodge-util.

Source

collections.lisp.

Macro: with-locale ((name) &body body)
Package

bodge-util.

Source

foreign.lisp.

Macro: with-simple-array-pointer ((pointer-var simple-array) &body body)
Package

bodge-util.

Source

arrays.lisp.


5.1.2 Ordinary functions

Function: apply-argument-list (lambda-list)
Package

bodge-util.

Source

language.lisp.

Function: class-name-of (obj)
Package

bodge-util.

Source

language.lisp.

Function: current-executable-path ()
Package

bodge-util.

Source

utils.lisp.

Function: current-file-truename ()
Package

bodge-util.

Source

utils.lisp.

Function: epoch-seconds (&optional timestamp)
Package

bodge-util.

Source

time.lisp.

Function: expand-array (array dimensions)
Package

bodge-util.

Source

arrays.lisp.

Function: f (value)
Package

bodge-util.

Source

language.lisp.

Function: file->byte-array (pathname &optional element-type)
Package

bodge-util.

Source

streams.lisp.

Function: flatten-array (array)
Package

bodge-util.

Source

arrays.lisp.

Function: getenv (name)
Package

bodge-util.

Source

utils.lisp.

Function: (setf getenv) (name)
Package

bodge-util.

Source

utils.lisp.

Function: if-null (value default)
Package

bodge-util.

Source

language.lisp.

Function: list->array (list &rest dimensions)
Package

bodge-util.

Source

collections.lisp.

Function: make-bounded-input-stream (stream bound)
Package

bodge-util.

Source

streams.lisp.

Function: make-mutable-string (&optional length)
Package

bodge-util.

Source

strings.lisp.

Function: mutate-string (string control-string &rest arguments)
Package

bodge-util.

Source

strings.lisp.

Function: parse-initargs-and-list (initargs-and-list)
Package

bodge-util.

Source

language.lisp.

Function: real-time-seconds ()
Package

bodge-util.

Source

time.lisp.

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.

Function: search-sorted (value sorted-array &key test predicate key)
Package

bodge-util.

Source

collections.lisp.

Function: shout (control-string &rest args)
Package

bodge-util.

Source

utils.lisp.

Function: stream->byte-array (stream &key initial-size)
Package

bodge-util.

Source

streams.lisp.

Function: string->immutable (string)
Package

bodge-util.

Source

strings.lisp.

Function: string->mutable (string)
Package

bodge-util.

Source

strings.lisp.

Function: stringify (value &optional format-string)
Package

bodge-util.

Source

strings.lisp.

Function: system-relative-pathname (system-name pathname)
Package

bodge-util.

Source

utils.lisp.

Function: translate-name-from-foreign (name)
Package

bodge-util.

Source

foreign.lisp.

Function: translate-name-to-foreign (symbol)
Package

bodge-util.

Source

foreign.lisp.

Function: universal-time->epoch (universal)
Package

bodge-util.

Source

time.lisp.


5.1.3 Generic functions

Generic Function: abandon (parent child)
Package

bodge-util.

Source

trees.lisp.

Methods
Method: abandon ((this parent) child)
Generic Function: abandon-all (parent)
Package

bodge-util.

Source

trees.lisp.

Methods
Method: abandon-all ((this parent))
Generic Function: abandoned (child parent)
Package

bodge-util.

Source

trees.lisp.

Methods
Method: abandoned (child parent)
Generic Function: adopt (parent child)
Package

bodge-util.

Source

trees.lisp.

Methods
Method: adopt ((this parent) child)
Generic Function: adopted (child parent)
Package

bodge-util.

Source

trees.lisp.

Methods
Method: adopted (child parent)
Generic Reader: children-of (object)
Package

bodge-util.

Methods
Reader Method: children-of ((parent parent))

automatically generated reader method

Source

trees.lisp.

Target Slot

children.


5.1.4 Standalone methods

Method: initialize-instance :after ((this array-slice) &key dimensions)
Source

arrays.lisp.

Method: (setf stream-file-position) ((this bounded-input-stream))
Package

trivial-gray-streams.

Source

streams.lisp.

Method: stream-file-position ((this bounded-input-stream))
Package

trivial-gray-streams.

Source

streams.lisp.

Method: stream-peek-char ((this bounded-input-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-byte ((this bounded-input-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-char ((this bounded-input-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-char-no-hang ((this bounded-input-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-line ((this bounded-input-stream))
Package

sb-gray.

Source

streams.lisp.

Method: stream-read-sequence ((this bounded-input-stream) sequence start end &key)
Package

trivial-gray-streams.

Source

streams.lisp.


5.1.5 Classes

Class: parent
Package

bodge-util.

Source

trees.lisp.

Direct methods
Direct slots
Slot: children
Initform

(quote nil)

Readers

children-of.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Constants

Constant: +lc-all+
Package

bodge-util.

Source

foreign.lisp.


5.2.2 Ordinary functions

Function: %do-tree-postorder (root action)
Package

bodge-util.

Source

trees.lisp.

Function: %do-tree-preorder (root action)
Package

bodge-util.

Source

trees.lisp.

Function: %next-slice (dimensions slice)
Package

bodge-util.

Source

arrays.lisp.

Function: find-dimensions (sequence)
Package

bodge-util.

Source

arrays.lisp.

Function: flat-index (obj)
Package

bodge-util.

Source

arrays.lisp.

Function: for-each-line (text action)
Package

bodge-util.

Source

strings.lisp.

Function: invoke-bodgy (fu)
Package

bodge-util.

Source

utils.lisp.

Function: next-slice (obj)
Package

bodge-util.

Source

arrays.lisp.

Function: raise-ignorable (e)
Package

bodge-util.

Source

utils.lisp.

Function: set-locale (category locale)
Package

bodge-util.

Source

foreign.lisp.

Function: slice (obj)

Current indices

Package

bodge-util.

Source

arrays.lisp.


5.2.3 Classes

Class: array-slice
Package

bodge-util.

Source

arrays.lisp.

Direct methods

initialize-instance.

Direct slots
Slot: dimensions
Slot: slice
Class: bounded-input-stream
Package

bodge-util.

Source

streams.lisp.

Direct superclasses

fundamental-input-stream.

Direct methods
Direct slots
Slot: stream
Package

common-lisp.

Initform

(error ":stream missing")

Initargs

:stream

Slot: position
Package

common-lisp.

Type

fixnum

Initform

0

Initargs

:position

Slot: bound
Type

fixnum

Initform

-1

Initargs

:bound


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   T   U   W  
Index Entry  Section

%
%do-tree-postorder: Private ordinary functions
%do-tree-preorder: Private ordinary functions
%next-slice: Private ordinary functions

(
(setf getenv): Public ordinary functions
(setf stream-file-position): Public standalone methods

A
abandon: Public generic functions
abandon: Public generic functions
abandon-all: Public generic functions
abandon-all: Public generic functions
abandoned: Public generic functions
abandoned: Public generic functions
adopt: Public generic functions
adopt: Public generic functions
adopted: Public generic functions
adopted: Public generic functions
apply-argument-list: Public ordinary functions

B
bind-for-serious-condition: Public macros
bound-symbol-value: Public macros

C
children-of: Public generic functions
children-of: Public generic functions
class-name-of: Public ordinary functions
current-executable-path: Public ordinary functions
current-file-truename: Public ordinary functions

D
defenum: Public macros
define-package: Public macros
definline: Public macros
deflogger: Public macros
dochildren: Public macros
dolines: Public macros
dotree: Public macros

E
ensure-not-null: Public macros
epoch-seconds: Public ordinary functions
expand-array: Public ordinary functions

F
f: Public ordinary functions
file->byte-array: Public ordinary functions
find-dimensions: Private ordinary functions
flat-index: Private ordinary functions
flatten-array: Public ordinary functions
float-array: Public macros
for-each-line: Private ordinary functions
Function, %do-tree-postorder: Private ordinary functions
Function, %do-tree-preorder: Private ordinary functions
Function, %next-slice: Private ordinary functions
Function, (setf getenv): Public ordinary functions
Function, apply-argument-list: Public ordinary functions
Function, class-name-of: Public ordinary functions
Function, current-executable-path: Public ordinary functions
Function, current-file-truename: Public ordinary functions
Function, epoch-seconds: Public ordinary functions
Function, expand-array: Public ordinary functions
Function, f: Public ordinary functions
Function, file->byte-array: Public ordinary functions
Function, find-dimensions: Private ordinary functions
Function, flat-index: Private ordinary functions
Function, flatten-array: Public ordinary functions
Function, for-each-line: Private ordinary functions
Function, getenv: Public ordinary functions
Function, if-null: Public ordinary functions
Function, invoke-bodgy: Private ordinary functions
Function, list->array: Public ordinary functions
Function, make-bounded-input-stream: Public ordinary functions
Function, make-mutable-string: Public ordinary functions
Function, mutate-string: Public ordinary functions
Function, next-slice: Private ordinary functions
Function, parse-initargs-and-list: Public ordinary functions
Function, raise-ignorable: Private ordinary functions
Function, real-time-seconds: Public ordinary functions
Function, replace-all: Public ordinary functions
Function, search-sorted: Public ordinary functions
Function, set-locale: Private ordinary functions
Function, shout: Public ordinary functions
Function, slice: Private ordinary functions
Function, stream->byte-array: Public ordinary functions
Function, string->immutable: Public ordinary functions
Function, string->mutable: Public ordinary functions
Function, stringify: Public ordinary functions
Function, system-relative-pathname: Public ordinary functions
Function, translate-name-from-foreign: Public ordinary functions
Function, translate-name-to-foreign: Public ordinary functions
Function, universal-time->epoch: Public ordinary functions

G
Generic Function, abandon: Public generic functions
Generic Function, abandon-all: Public generic functions
Generic Function, abandoned: Public generic functions
Generic Function, adopt: Public generic functions
Generic Function, adopted: Public generic functions
Generic Function, children-of: Public generic functions
getenv: Public ordinary functions

I
if-bound: Public macros
if-null: Public ordinary functions
in-development-mode: Public macros
initialize-instance: Public standalone methods
invoke-bodgy: Private ordinary functions

L
list->array: Public ordinary functions
log-errors: Public macros

M
Macro, bind-for-serious-condition: Public macros
Macro, bound-symbol-value: Public macros
Macro, defenum: Public macros
Macro, define-package: Public macros
Macro, definline: Public macros
Macro, deflogger: Public macros
Macro, dochildren: Public macros
Macro, dolines: Public macros
Macro, dotree: Public macros
Macro, ensure-not-null: Public macros
Macro, float-array: Public macros
Macro, if-bound: Public macros
Macro, in-development-mode: Public macros
Macro, log-errors: Public macros
Macro, make-hash-table-with-entries: Public macros
Macro, parent-tree: Public macros
Macro, when-bound: Public macros
Macro, with-hash-entries: Public macros
Macro, with-locale: Public macros
Macro, with-simple-array-pointer: Public macros
make-bounded-input-stream: Public ordinary functions
make-hash-table-with-entries: Public macros
make-mutable-string: Public ordinary functions
Method, (setf stream-file-position): Public standalone methods
Method, abandon: Public generic functions
Method, abandon-all: Public generic functions
Method, abandoned: Public generic functions
Method, adopt: Public generic functions
Method, adopted: Public generic functions
Method, children-of: Public generic functions
Method, initialize-instance: Public standalone methods
Method, stream-file-position: Public standalone methods
Method, stream-peek-char: Public standalone methods
Method, stream-read-byte: Public standalone methods
Method, stream-read-char: Public standalone methods
Method, stream-read-char-no-hang: Public standalone methods
Method, stream-read-line: Public standalone methods
Method, stream-read-sequence: Public standalone methods
mutate-string: Public ordinary functions

N
next-slice: Private ordinary functions

P
parent-tree: Public macros
parse-initargs-and-list: Public ordinary functions

R
raise-ignorable: Private ordinary functions
real-time-seconds: Public ordinary functions
replace-all: Public ordinary functions

S
search-sorted: Public ordinary functions
set-locale: Private ordinary functions
shout: Public ordinary functions
slice: Private ordinary functions
stream->byte-array: Public ordinary functions
stream-file-position: Public standalone methods
stream-peek-char: Public standalone methods
stream-read-byte: Public standalone methods
stream-read-char: Public standalone methods
stream-read-char-no-hang: Public standalone methods
stream-read-line: Public standalone methods
stream-read-sequence: Public standalone methods
string->immutable: Public ordinary functions
string->mutable: Public ordinary functions
stringify: Public ordinary functions
system-relative-pathname: Public ordinary functions

T
translate-name-from-foreign: Public ordinary functions
translate-name-to-foreign: Public ordinary functions

U
universal-time->epoch: Public ordinary functions

W
when-bound: Public macros
with-hash-entries: Public macros
with-locale: Public macros
with-simple-array-pointer: Public macros


A.4 Data types

Jump to:   A   B   C   F   L   P   S   T   U  
Index Entry  Section

A
array-slice: Private classes
arrays.lisp: The bodge-utilities/arrays․lisp file

B
bodge-util: The bodge-util package
bodge-utilities: The bodge-utilities system
bodge-utilities.asd: The bodge-utilities/bodge-utilities․asd file
bounded-input-stream: Private classes

C
Class, array-slice: Private classes
Class, bounded-input-stream: Private classes
Class, parent: Public classes
collections.lisp: The bodge-utilities/collections․lisp file

F
File, arrays.lisp: The bodge-utilities/arrays․lisp file
File, bodge-utilities.asd: The bodge-utilities/bodge-utilities․asd file
File, collections.lisp: The bodge-utilities/collections․lisp file
File, foreign.lisp: The bodge-utilities/foreign․lisp file
File, language.lisp: The bodge-utilities/language․lisp file
File, packages.lisp: The bodge-utilities/packages․lisp file
File, streams.lisp: The bodge-utilities/streams․lisp file
File, strings.lisp: The bodge-utilities/strings․lisp file
File, time.lisp: The bodge-utilities/time․lisp file
File, trees.lisp: The bodge-utilities/trees․lisp file
File, utils.lisp: The bodge-utilities/utils․lisp file
foreign.lisp: The bodge-utilities/foreign․lisp file

L
language.lisp: The bodge-utilities/language․lisp file

P
Package, bodge-util: The bodge-util package
packages.lisp: The bodge-utilities/packages․lisp file
parent: Public classes

S
streams.lisp: The bodge-utilities/streams․lisp file
strings.lisp: The bodge-utilities/strings․lisp file
System, bodge-utilities: The bodge-utilities system

T
time.lisp: The bodge-utilities/time․lisp file
trees.lisp: The bodge-utilities/trees․lisp file

U
utils.lisp: The bodge-utilities/utils․lisp file