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 Mon Apr 19 14:16:51 2021 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

• packages.lisp (file)
• utils.lisp (file)
• time.lisp (file)
• language.lisp (file)
• collections.lisp (file)
• foreign.lisp (file)
• strings.lisp (file)
• trees.lisp (file)
• arrays.lisp (file)
• streams.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 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

• current-executable-path (function)
• current-file-truename (function)
• deflogger (macro)
• getenv (function)
• (setf getenv) (function)
• in-development-mode (macro)
• log-errors (macro)
• shout (function)
• system-relative-pathname (function)

Internal Definitions

• invoke-bodgy (function)
• raise-ignorable (function)

3.1.4 bodge-utilities/time.lisp

Dependency

utils.lisp (file)

Parent

bodge-utilities (system)

Location

time.lisp

Exported Definitions

• epoch-seconds (function)
• real-time-seconds (function)
• universal-time->epoch (function)

3.1.5 bodge-utilities/language.lisp

Dependency

time.lisp (file)

Parent

bodge-utilities (system)

Location

language.lisp

Exported Definitions

• apply-argument-list (function)
• bind-for-serious-condition (macro)
• bound-symbol-value (macro)
• class-name-of (function)
• defenum (macro)
• define-package (macro)
• definline (macro)
• ensure-not-null (macro)
• f (function)
• if-bound (macro)
• if-null (function)
• parse-initargs-and-list (function)
• when-bound (macro)

3.1.6 bodge-utilities/collections.lisp

Dependency

language.lisp (file)

Parent

bodge-utilities (system)

Location

collections.lisp

Exported Definitions

• list->array (function)
• make-hash-table-with-entries (macro)
• search-sorted (function)
• with-hash-entries (macro)

3.1.7 bodge-utilities/foreign.lisp

Dependency

collections.lisp (file)

Parent

bodge-utilities (system)

Location

foreign.lisp

Exported Definitions

• translate-name-from-foreign (function)
• translate-name-to-foreign (function)
• with-locale (macro)

Internal Definitions

• +lc-all+ (constant)
• set-locale (function)

3.1.8 bodge-utilities/strings.lisp

Dependency

foreign.lisp (file)

Parent

bodge-utilities (system)

Location

strings.lisp

Exported Definitions

• dolines (macro)
• make-mutable-string (function)
• mutate-string (function)
• replace-all (function)
• string->immutable (function)
• string->mutable (function)
• stringify (function)

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

• abandon (generic function)
• abandon (method)
• abandon-all (generic function)
• abandon-all (method)
• abandoned (generic function)
• abandoned (method)
• adopt (generic function)
• adopt (method)
• adopted (generic function)
• adopted (method)
• children-of (method)
• dochildren (macro)
• dotree (macro)
• parent (class)
• parent-tree (macro)

Internal Definitions

• %do-tree-postorder (function)
• %do-tree-preorder (function)

3.1.10 bodge-utilities/arrays.lisp

Dependency

trees.lisp (file)

Parent

bodge-utilities (system)

Location

arrays.lisp

Exported Definitions

• expand-array (function)
• flatten-array (function)
• float-array (macro)
• with-simple-array-pointer (macro)

Internal Definitions

• %next-slice (function)
• array-slice (class)
• find-dimensions (function)
• flat-index (function)
• next-slice (function)
• slice (function)

3.1.11 bodge-utilities/streams.lisp

Dependency

arrays.lisp (file)

Parent

bodge-utilities (system)

Location

streams.lisp

Exported Definitions

• file->byte-array (function)
• make-bounded-input-stream (function)
• stream->byte-array (function)

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

• abandon (generic function)
• abandon (method)
• abandon-all (generic function)
• abandon-all (method)
• abandoned (generic function)
• abandoned (method)
• adopt (generic function)
• adopt (method)
• adopted (generic function)
• adopted (method)
• apply-argument-list (function)
• bind-for-serious-condition (macro)
• bound-symbol-value (macro)
• children-of (generic function)
• children-of (method)
• class-name-of (function)
• current-executable-path (function)
• current-file-truename (function)
• defenum (macro)
• define-package (macro)
• definline (macro)
• deflogger (macro)
• dochildren (macro)
• dolines (macro)
• dotree (macro)
• ensure-not-null (macro)
• epoch-seconds (function)
• expand-array (function)
• f (function)
• file->byte-array (function)
• flatten-array (function)
• float-array (macro)
• getenv (function)
• (setf getenv) (function)
• if-bound (macro)
• if-null (function)
• in-development-mode (macro)
• list->array (function)
• log-errors (macro)
• make-bounded-input-stream (function)
• make-hash-table-with-entries (macro)
• make-mutable-string (function)
• mutate-string (function)
• parent (class)
• parent-tree (macro)
• parse-initargs-and-list (function)
• real-time-seconds (function)
• replace-all (function)
• search-sorted (function)
• shout (function)
• stream->byte-array (function)
• string->immutable (function)
• string->mutable (function)
• stringify (function)
• system-relative-pathname (function)
• translate-name-from-foreign (function)
• translate-name-to-foreign (function)
• universal-time->epoch (function)
• when-bound (macro)
• with-hash-entries (macro)
• with-locale (macro)
• with-simple-array-pointer (macro)

Internal Definitions

• %do-tree-postorder (function)
• %do-tree-preorder (function)
• %next-slice (function)
• +lc-all+ (constant)
• array-slice (class)
• bounded-input-stream (class)
• find-dimensions (function)
• flat-index (function)
• for-each-line (function)
• invoke-bodgy (function)
• next-slice (function)
• raise-ignorable (function)
• set-locale (function)
• slice (function)

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

• abandon-all (method)
• abandon (method)
• adopt (method)
• children-of (method)

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

A.2 Functions

A.3 Variables

A.4 Data types