The hu.dwim.util Reference Manual

Table of Contents

The hu.dwim.util Reference Manual

This is the hu.dwim.util Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:25:09 2021 GMT+0.

1 Introduction

http://dwim.hu/project/hu.dwim.util

2 Systems

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

2.1 hu.dwim.util

Authors

Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>

License

BSD or Bugroff

Description

Various utilities, this is the most basic system that only introduce a small number of external dependencies.

Defsystem Dependency

hu.dwim.asdf

Dependencies

• hu.dwim.def+hu.dwim.common
• hu.dwim.defclass-star+hu.dwim.def
• hu.dwim.syntax-sugar
• sb-sprof

Source

hu.dwim.util.asd (file)

Components

• source (module)
• integration (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 hu.dwim.util/source

Parent

hu.dwim.util (system)

Location

source/

Components

• anaphora.lisp (file)
• dynamic-context.lisp (file)
• error-handling-early.lisp (file)
• generic-operator.lisp (file)
• hash-table.lisp (file)
• integer-to-string.lisp (file)
• iterate.lisp (file)
• number.lisp (file)
• package.lisp (file)
• pattern-matcher.lisp (file)
• place.lisp (file)
• sequence.lisp (file)
• string.lisp (file)
• string-early.lisp (file)
• threads-early.lisp (file)
• type.lisp (file)
• miscellaneous.lisp (file)

3.2 hu.dwim.util/integration

Parent

hu.dwim.util (system)

Location

integration/

Component

sbcl.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 hu.dwim.util.asd

Location

hu.dwim.util.asd

Systems

hu.dwim.util (system)

4.1.2 hu.dwim.util/source/anaphora.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/anaphora.lisp

Exported Definitions

• cond-bind (macro)
• if-bind (macro)
• prog1-bind (macro)
• when-bind (macro)

4.1.3 hu.dwim.util/source/dynamic-context.lisp

Dependency

miscellaneous.lisp (file)

Parent

source (module)

Location

source/dynamic-context.lisp

Exported Definitions

• define-dynamic-context (macro)
• define-dynamic-context* (macro)

4.1.4 hu.dwim.util/source/error-handling-early.lisp

Dependencies

• package.lisp (file)
• miscellaneous.lisp (file)

Parent

source (module)

Location

source/error-handling-early.lisp

Exported Definitions

• *debug-on-error* (special variable)
• collect-backtrace (function)
• collect-call-path (function)
• debug-on-error? (generic function)
• debug-on-error? (method)
• make-error-log-decorator (macro)
• make-special-variable-printing-error-log-decorator (macro)
• maybe-invoke-debugger (function)
• nested-condition (condition)
• print-error-safely (function)
• with-error-log-decorator (macro)
• with-error-log-decorators (macro)

Internal Definitions

• *error-log-decorators* (special variable)
• nested-condition-of (method)
• (setf nested-condition-of) (method)

4.1.5 hu.dwim.util/source/generic-operator.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/generic-operator.lisp

Exported Definitions

• g* (generic function)
• g* (method)
• g+ (generic function)
• g+ (method)
• g- (generic function)
• g- (method)
• g/ (generic function)
• g/ (method)
• g< (generic function)
• g< (method)
• g< (method)
• g<= (generic function)
• g<= (method)
• g<= (method)
• g= (generic function)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g> (generic function)
• g> (method)
• g> (method)
• g>= (generic function)
• g>= (method)
• g>= (method)

4.1.6 hu.dwim.util/source/hash-table.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/hash-table.lisp

Exported Definitions

• hash-key (generic function)
• hash-key (method)
• hash-value (function)
• (setf hash-value) (function)
• remove-hash-value (function)

4.1.7 hu.dwim.util/source/integer-to-string.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/integer-to-string.lisp

Exported Definitions

integer-to-string (function)

Internal Definitions

• %integer-to-string (function)
• +cached-integer-names/base-10/unindented+ (constant)
• +integer-to-string-cache-size+ (constant)

4.1.8 hu.dwim.util/source/iterate.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/iterate.lisp

Internal Definitions

• clause-anding-2 (function)
• clause-oring-3 (function)
• clause-summing*-1 (function)

4.1.9 hu.dwim.util/source/number.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/number.lisp

Exported Definitions

• product (function)
• product* (function)
• round* (function)
• sum* (function)

4.1.10 hu.dwim.util/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

hu.dwim.util

4.1.11 hu.dwim.util/source/pattern-matcher.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/pattern-matcher.lisp

Exported Definitions

• pattern-case (macro)
• pattern-match (function)

Internal Definitions

• +failed-match+ (constant)
• +no-bindings+ (constant)
• binding-val (function)
• binding-var (function)
• collect-pattern-variables (function)
• extend-bindings (function)
• first-match-pos (function)
• get-binding (function)
• lookup (function)
• make-binding (function)
• match-and (function)
• match-if (function)
• match-is (function)
• match-not (function)
• match-or (function)
• match-variable (function)
• object-matcher (function)
• object-pattern-p (function)
• pattern-variable-p (function)
• segment-match (function)
• segment-match+ (function)
• segment-match-fn (function)
• segment-match? (function)
• segment-matcher (function)
• segment-pattern-p (function)
• single-match-fn (function)
• single-matcher (function)
• single-pattern-p (function)

4.1.12 hu.dwim.util/source/place.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/place.lisp

Exported Definitions

• clearf (macro)
• notf (macro)
• symbol-global-value (function)
• (setf symbol-global-value) (function)

4.1.13 hu.dwim.util/source/sequence.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/sequence.lisp

Exported Definitions

• all-the-same? (function)
• collect-if (function)
• ensure-sequence (function)
• find/tree (function)
• foreach (macro)
• map/tree (function)
• optional-list (function)
• optional-list* (function)
• partition (function)
• shrink-vector (function)
• split-sequence (function)
• split-sequence-by-partitioning (function)
• subseq-if-longer (function)
• substitute-all (function)
• substitute/tree (function)
• the-non-nil (compiler macro)
• the-non-nil (function)
• the-only-element (compiler macro)
• the-only-element (function)

4.1.14 hu.dwim.util/source/string.lisp

Dependency

miscellaneous.lisp (file)

Parent

source (module)

Location

source/string.lisp

Exported Definitions

• +alphanumeric-ascii-alphabet+ (constant)
• +ascii-alphabet+ (constant)
• +base64-alphabet+ (constant)
• +lower-case-ascii-alphabet+ (constant)
• +upper-case-ascii-alphabet+ (constant)
• +whitespace-characters+ (constant)
• find-symbol* (function)
• levenshtein-distance (function)
• levenshtein-relative-distance (function)
• make-adjustable-string (function)
• make-string-of-spaces (function)
• parse-roman-numeral (function)
• random-string (function)
• roman-numeral-digit-character? (function)
• sanitize-string (function)
• sanitize-string/printable-ascii (function)
• string-trim-whitespace (function)
• string-with-integers< (function)
• string-with-numeric< (function)
• string-with-roman-numerals< (function)
• string/trim-whitespace-and-maybe-nil-it (macro)
• whitespace? (function)
• with-string-type-dispatch (macro)
• write-characters (function)
• write-spaces (function)

Internal Definitions

• +indent-length->string-of-spaces+ (constant)
• +string-of-spaces/cache-size+ (constant)

4.1.15 hu.dwim.util/source/string-early.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/string-early.lisp

Exported Definitions

• join-strings (function)
• string+ (compiler macro)
• string+ (function)

4.1.16 hu.dwim.util/source/threads-early.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/threads-early.lisp

Exported Definitions

• atomic-counter (structure)
• atomic-counter/decrement (function)
• atomic-counter/increment (function)
• atomic-counter/value (function)
• make-atomic-counter (function)

Internal Definitions

• ac/counter (function)
• (setf ac/counter) (function)
• atomic-counter-p (function)
• copy-atomic-counter (function)

4.1.17 hu.dwim.util/source/type.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/type.lisp

Exported Definitions

• +bottom-type+ (constant)
• +top-type+ (constant)
• expand-type (function)
• expand-type-1 (function)
• function-designator (type)
• function-name (type)
• type-instance-count-upper-bound (function)
• type-instance-list (function)

4.1.18 hu.dwim.util/source/miscellaneous.lisp

Dependencies

• package.lisp (file)
• string-early.lisp (file)

Parent

source (module)

Location

source/miscellaneous.lisp

Exported Definitions

• +process-return-code/no-error+ (constant)
• +xml-namespace-uri+ (constant)
• bit-value (macro)
• (setf bit-value) (setf expander)
• econd (macro)
• enable-standard-hu.dwim-syntaxes (function)
• eval-always (macro)
• eval/interpret (function)
• find-direct-slot (function)
• find-fully-qualified-symbol (function)
• find-function (function)
• find-slot (function)
• fully-qualified-symbol-name (function)
• get-monotonic-time (function)
• handle-otherwise (macro)
• handle-otherwise* (macro)
• handle-otherwise/value (function)
• if-symbol-exists (function)
• mandatory-argument (function)
• not-yet-implemented (function)
• not-yet-implemented/crucial-api (function)
• not-yet-implemented/form (function)
• operation-not-supported (function)
• quit (function)
• quoted-form? (function)
• quoted-symbol? (function)
• rebind (macro)
• surround-body-unless (macro)
• surround-body-unless* (macro)
• surround-body-when (macro)
• surround-body-when* (macro)
• to-boolean (macro)
• with-dynamic-memoize (macro)
• with-keyword-package (macro)
• with-muffled-boring-compiler-warnings (macro)
• with-muffled-redefinition-warnings (macro)
• with-muffled-warnings (macro)
• with-thread-activity-description (macro)
• with-thread-name (macro)

4.1.19 hu.dwim.util/integration/sbcl.lisp

If Feature

(and sbcl (not windows))

Parent

integration (module)

Location

integration/sbcl.lisp

Exported Definitions

with-profiling (macro)

Internal Definitions

call-with-profiling (function)

5 Packages

Packages are listed by definition order.

5.1 hu.dwim.util

Source

package.lisp (file)

Use List

• hu.dwim.syntax-sugar
• hu.dwim.def
• hu.dwim.common
• hu.dwim.asdf

Exported Definitions

• *debug-on-error* (special variable)
• +alphanumeric-ascii-alphabet+ (constant)
• +ascii-alphabet+ (constant)
• +base64-alphabet+ (constant)
• +bottom-type+ (constant)
• +lower-case-ascii-alphabet+ (constant)
• +process-return-code/no-error+ (constant)
• +top-type+ (constant)
• +upper-case-ascii-alphabet+ (constant)
• +whitespace-characters+ (constant)
• +xml-namespace-uri+ (constant)
• all-the-same? (function)
• atomic-counter (structure)
• atomic-counter/decrement (function)
• atomic-counter/increment (function)
• atomic-counter/value (function)
• bit-value (macro)
• (setf bit-value) (setf expander)
• clearf (macro)
• collect-backtrace (function)
• collect-call-path (function)
• collect-if (function)
• cond-bind (macro)
• debug-on-error? (generic function)
• debug-on-error? (method)
• define-dynamic-context (macro)
• define-dynamic-context* (macro)
• econd (macro)
• enable-standard-hu.dwim-syntaxes (function)
• ensure-sequence (function)
• eval-always (macro)
• eval/interpret (function)
• expand-type (function)
• expand-type-1 (function)
• find-direct-slot (function)
• find-fully-qualified-symbol (function)
• find-function (function)
• find-slot (function)
• find-symbol* (function)
• find/tree (function)
• foreach (macro)
• fully-qualified-symbol-name (function)
• function-designator (type)
• function-name (type)
• g* (generic function)
• g* (method)
• g+ (generic function)
• g+ (method)
• g- (generic function)
• g- (method)
• g/ (generic function)
• g/ (method)
• g< (generic function)
• g< (method)
• g< (method)
• g<= (generic function)
• g<= (method)
• g<= (method)
• g= (generic function)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g= (method)
• g> (generic function)
• g> (method)
• g> (method)
• g>= (generic function)
• g>= (method)
• g>= (method)
• get-monotonic-time (function)
• handle-otherwise (macro)
• handle-otherwise* (macro)
• handle-otherwise/value (function)
• hash-key (generic function)
• hash-key (method)
• hash-value (function)
• (setf hash-value) (function)
• if-bind (macro)
• if-symbol-exists (function)
• integer-to-string (function)
• join-strings (function)
• levenshtein-distance (function)
• levenshtein-relative-distance (function)
• make-adjustable-string (function)
• make-atomic-counter (function)
• make-error-log-decorator (macro)
• make-special-variable-printing-error-log-decorator (macro)
• make-string-of-spaces (function)
• mandatory-argument (function)
• map/tree (function)
• maybe-invoke-debugger (function)
• nested-condition (condition)
• not-yet-implemented (function)
• not-yet-implemented/crucial-api (function)
• not-yet-implemented/form (function)
• notf (macro)
• operation-not-supported (function)
• optional-list (function)
• optional-list* (function)
• parse-roman-numeral (function)
• partition (function)
• pattern-case (macro)
• pattern-match (function)
• print-error-safely (function)
• product (function)
• product* (function)
• prog1-bind (macro)
• quit (function)
• quoted-form? (function)
• quoted-symbol? (function)
• random-string (function)
• rebind (macro)
• remove-hash-value (function)
• roman-numeral-digit-character? (function)
• round* (function)
• sanitize-string (function)
• sanitize-string/printable-ascii (function)
• shrink-vector (function)
• split-sequence (function)
• split-sequence-by-partitioning (function)
• string+ (compiler macro)
• string+ (function)
• string-trim-whitespace (function)
• string-with-integers< (function)
• string-with-numeric< (function)
• string-with-roman-numerals< (function)
• string/trim-whitespace-and-maybe-nil-it (macro)
• subseq-if-longer (function)
• substitute-all (function)
• substitute/tree (function)
• sum* (function)
• surround-body-unless (macro)
• surround-body-unless* (macro)
• surround-body-when (macro)
• surround-body-when* (macro)
• symbol-global-value (function)
• (setf symbol-global-value) (function)
• the-non-nil (compiler macro)
• the-non-nil (function)
• the-only-element (compiler macro)
• the-only-element (function)
• to-boolean (macro)
• type-instance-count-upper-bound (function)
• type-instance-list (function)
• when-bind (macro)
• whitespace? (function)
• with-dynamic-memoize (macro)
• with-error-log-decorator (macro)
• with-error-log-decorators (macro)
• with-keyword-package (macro)
• with-muffled-boring-compiler-warnings (macro)
• with-muffled-redefinition-warnings (macro)
• with-muffled-warnings (macro)
• with-profiling (macro)
• with-string-type-dispatch (macro)
• with-thread-activity-description (macro)
• with-thread-name (macro)
• write-characters (function)
• write-spaces (function)

Internal Definitions

• %integer-to-string (function)
• *error-log-decorators* (special variable)
• +cached-integer-names/base-10/unindented+ (constant)
• +failed-match+ (constant)
• +indent-length->string-of-spaces+ (constant)
• +integer-to-string-cache-size+ (constant)
• +no-bindings+ (constant)
• +string-of-spaces/cache-size+ (constant)
• ac/counter (function)
• (setf ac/counter) (function)
• atomic-counter-p (function)
• binding-val (function)
• binding-var (function)
• call-with-profiling (function)
• clause-anding-2 (function)
• clause-oring-3 (function)
• clause-summing*-1 (function)
• collect-pattern-variables (function)
• copy-atomic-counter (function)
• extend-bindings (function)
• first-match-pos (function)
• get-binding (function)
• lookup (function)
• make-binding (function)
• match-and (function)
• match-if (function)
• match-is (function)
• match-not (function)
• match-or (function)
• match-variable (function)
• nested-condition-of (generic function)
• nested-condition-of (method)
• (setf nested-condition-of) (method)
• (setf nested-condition-of) (generic function)
• object-matcher (function)
• object-pattern-p (function)
• pattern-variable-p (function)
• segment-match (function)
• segment-match+ (function)
• segment-match-fn (function)
• segment-match? (function)
• segment-matcher (function)
• segment-pattern-p (function)
• single-match-fn (function)
• single-matcher (function)
• single-pattern-p (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: +alphanumeric-ascii-alphabet+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +ascii-alphabet+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +base64-alphabet+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +bottom-type+

Package

hu.dwim.util

Source

type.lisp (file)

Constant: +lower-case-ascii-alphabet+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +process-return-code/no-error+

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Constant: +top-type+

Package

hu.dwim.util

Source

type.lisp (file)

Constant: +upper-case-ascii-alphabet+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +whitespace-characters+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +xml-namespace-uri+

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

6.1.2 Special variables

Special Variable: *debug-on-error*

The default, system wide, value for debug-on-error.

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

6.1.3 Macros

Macro: bit-value INDEX INTEGER

Returns the INDEX’th bit of INTEGER as a boolean.

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Setf Expander

(setf bit-value) (setf expander)

Setf Expander: (setf bit-value) INDEX INTEGER

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Reader

bit-value (macro)

Macro: clearf &rest PLACES

Package

hu.dwim.util

Source

place.lisp (file)

Macro: cond-bind VAR &body CLAUSES

Just like COND but VAR will be bound to the result of the condition in the clause when executing the body of the clause.

Package

hu.dwim.util

Source

anaphora.lisp (file)

Macro: define-dynamic-context NAME DIRECT-SLOTS &key DIRECT-SUPERCLASSES EXPORT-SYMBOLS CLASS-NAME CHAIN-PARENTS CREATE-STRUCT CREATE-CLASS STRUCT-OPTIONS DEFCLASS-MACRO-NAME

The purpose of this macro is to provide an easy way to access a group of related special variables. To do so, it generates with-NAME/in-NAME/current-NAME/has-NAME macros to access either a CLOS instance or a defstruct in a special variable. Optionally it can chain the "parent" bindings (use :CHAIN-PARENTS T and access with PARENT-CONTEXT-OF).

Package

hu.dwim.util

Source

dynamic-context.lisp (file)

Macro: define-dynamic-context* NAME DIRECT-SLOTS &rest ARGS &key DEFCLASS-MACRO-NAME &allow-other-keys

Package

hu.dwim.util

Source

dynamic-context.lisp (file)

Macro: econd &rest CLAUSES

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: eval-always &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: foreach FUNCTION FIRST-SEQUENCE &rest MORE-SEQUENCES

Package

hu.dwim.util

Source

sequence.lisp (file)

Macro: handle-otherwise &body DEFAULT-ERROR-FORMS

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: handle-otherwise* (&key DEFAULT-MESSAGE) &body DEFAULT-FORMS

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: if-bind VAR TEST &body THEN/ELSE

Package

hu.dwim.util

Source

anaphora.lisp (file)

Macro: make-error-log-decorator &body BODY

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Macro: make-special-variable-printing-error-log-decorator &rest VARIABLES

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Macro: notf &rest PLACES

Package

hu.dwim.util

Source

place.lisp (file)

Macro: pattern-case EXPR &body CLAUSES

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Macro: prog1-bind VAR RET &body BODY

Package

hu.dwim.util

Source

anaphora.lisp (file)

Macro: rebind BINDINGS &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: string/trim-whitespace-and-maybe-nil-it VARIABLE

Package

hu.dwim.util

Source

string.lisp (file)

Macro: surround-body-unless TEST SURROUND-WITH &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: surround-body-unless* (TEST SURROUND-WITH &key BODY-NAME) &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: surround-body-when TEST SURROUND-WITH &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: surround-body-when* (TEST SURROUND-WITH &key BODY-NAME) &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: to-boolean FORM

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: when-bind VAR TEST &body BODY

Package

hu.dwim.util

Source

anaphora.lisp (file)

Macro: with-dynamic-memoize (NAME &rest KEYS) &body FORMS

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-error-log-decorator DECORATOR &body BODY

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Macro: with-error-log-decorators BINDINGS &body BODY

Multiple binding version of with-error-log-decorator.

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Macro: with-keyword-package &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-muffled-boring-compiler-warnings &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-muffled-redefinition-warnings &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-muffled-warnings (&rest TYPES) &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-profiling () &body WITH-BODY1

Package

hu.dwim.util

Source

sbcl.lisp (file)

Macro: with-string-type-dispatch (VARIABLE &optional TYPES) &body BODY

Package

hu.dwim.util

Source

string.lisp (file)

Macro: with-thread-activity-description (NAME) &body BODY

This is a debugging helper tool. Information provided here may show up in backtraces unless compiled without the debug helpers.

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Macro: with-thread-name NAME &body BODY

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

6.1.4 Compiler macros

Compiler Macro: string+ &rest ARGS

Package

hu.dwim.util

Source

string-early.lisp (file)

Compiler Macro: the-non-nil VALUE

Package

hu.dwim.util

Source

sequence.lisp (file)

Compiler Macro: the-only-element ELEMENTS

Package

hu.dwim.util

Source

sequence.lisp (file)

6.1.5 Functions

Function: all-the-same? SEQUENCE &key TEST KEY

Returns true if every element in the LIST are equal to each other using TEST.

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: atomic-counter/decrement ATOMIC-COUNTER &optional DELTA

A convenience version of ATOMIC-COUNTER/INCREMENT, mostly to keep the user code readable.

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: atomic-counter/increment ATOMIC-COUNTER &optional DELTA

Increments a special place holding a machine word sized integer in a way that paralell CPU’s don’t step on each other’s toes when incrementing/decrementing it. These operation don’t expand to bignums, they just overflow/underflow when the high/low bound of the word sized integer is crossed.

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: atomic-counter/value ATOMIC-COUNTER

See ATOMIC-COUNTER for details.

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: collect-backtrace &key START COUNT

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Function: collect-call-path &key START COUNT

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Function: collect-if PREDICATE SEQUENCE &key KEY

Collects elements from SEQUENCE for which the PREDICATE is true into a freshly allocated sequence.

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: enable-standard-hu.dwim-syntaxes ()

This function sets up the common readtable modifications we (http://dwim.hu) use in almost all of our projects. Some projects enable more, but this is available almost everywhere.

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: ensure-sequence THING

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: eval/interpret FORM

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: expand-type TYPE &optional ENV

Package

hu.dwim.util

Source

type.lisp (file)

Function: expand-type-1 TYPE &optional ENV

Package

hu.dwim.util

Source

type.lisp (file)

Function: find-direct-slot CLASS-OR-NAME SLOT-NAME &key OTHERWISE

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: find-fully-qualified-symbol NAME &key OTHERWISE

The inverse of FULLY-QUALIFIED-SYMBOL-NAME. Does not INTERN but it does instantiate package-less symbols.

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: find-function NAME &key OTHERWISE

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: find-slot CLASS-OR-NAME SLOT-NAME &key OTHERWISE

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: find-symbol* SYMBOL-NAME &key PACKAGES OTHERWISE

Package

hu.dwim.util

Source

string.lisp (file)

Function: find/tree ITEM SEQUENCE &key KEY TEST

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: fully-qualified-symbol-name SYMBOL &key SEPARATOR

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: get-monotonic-time ()

Returns such a time measure that constantly grows (it’s a number in seconds, and it’s unaffected by setting the system clock).

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: handle-otherwise/value OTHERWISE &key DEFAULT-MESSAGE

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: hash-value KEY HASHTABLE

Function: (setf hash-value) VALUE KEY HASHTABLE

Package

hu.dwim.util

Source

hash-table.lisp (file)

Function: if-symbol-exists PACKAGE NAME

Can be used to conditionalize at read-time like this: #+#.(hu.dwim.util:if-symbol-exists "PKG" "FOO")(pkg::foo ...)

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: integer-to-string INTEGER &key MINIMUM-COLUMN-COUNT MAXIMUM-DIGIT-COUNT BASE

Package

hu.dwim.util

Source

integer-to-string.lisp (file)

Function: join-strings STRINGS &optional SEPARATOR

Package

hu.dwim.util

Source

string-early.lisp (file)

Function: levenshtein-distance S1 S2

Package

hu.dwim.util

Source

string.lisp (file)

Function: levenshtein-relative-distance S1 S2

Package

hu.dwim.util

Source

string.lisp (file)

Function: make-adjustable-string INITIAL-CONTENTS

Package

hu.dwim.util

Source

string.lisp (file)

Function: make-atomic-counter &key (COUNTER COUNTER)

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: make-string-of-spaces COUNT

Package

hu.dwim.util

Source

string.lisp (file)

Function: mandatory-argument ()

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: map/tree VISITOR SEQUENCE &key KEY

Depth-first, returns with (VALUES).

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: maybe-invoke-debugger CONDITION &key CONTEXT

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Function: not-yet-implemented &optional DATUM &rest ARGS

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: not-yet-implemented/crucial-api NAME

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: not-yet-implemented/form NAME &key RUNTIME-SIGNAL-KIND

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: operation-not-supported &optional DATUM &rest ARGS

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: optional-list &rest ELEMENTS

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: optional-list* &rest ELEMENTS

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: parse-roman-numeral STR &key START END

Package

hu.dwim.util

Source

string.lisp (file)

Function: partition SEQUENCE &rest PREDICATES

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: pattern-match PATTERN INPUT &optional BINDINGS

Match pattern against input in the context of the bindings

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: print-error-safely &optional MESSAGE &rest ARGS

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Function: product &rest ARGS

Package

hu.dwim.util

Source

number.lisp (file)

Function: product* LIST &key KEY IGNORE-NON-NUMBERS

Package

hu.dwim.util

Source

number.lisp (file)

Function: quit STATUS-CODE

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: quoted-form? THING

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: quoted-symbol? THING

Package

hu.dwim.util

Source

miscellaneous.lisp (file)

Function: random-string &optional LENGTH ALPHABET PREFIX

Package

hu.dwim.util

Source

string.lisp (file)

Function: remove-hash-value KEY HASHTABLE

Package

hu.dwim.util

Source

hash-table.lisp (file)

Function: roman-numeral-digit-character? CHAR

Package

hu.dwim.util

Source

string.lisp (file)

Function: round* NUMBER &optional DIVISOR

CL:ROUND rounds so that .5 is rounded up for odd and down for even quotients. ROUND* always rounds .5 up.

Package

hu.dwim.util

Source

number.lisp (file)

Function: sanitize-string STRING LOWER-LIMIT UPPER-LIMIT &key REPLACEMENT

By default sanitize for the printable ASCII range. Limits are inclusive.

Package

hu.dwim.util

Source

string.lisp (file)

Function: sanitize-string/printable-ascii STRING &key REPLACEMENT

Package

hu.dwim.util

Source

string.lisp (file)

Function: shrink-vector VECTOR &optional SIZE

Fast shrinking for simple vectors. It’s not thread-safe, use only on local vectors!

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: split-sequence DELIMITER SEQ &key COUNT REMOVE-EMPTY-SUBSEQS FROM-END START END TEST TEST-NOT KEY

Return a list of subsequences in seq delimited by delimiter.

If :remove-empty-subseqs is NIL, empty subsequences will be included in the result; otherwise they will be discarded. All other keywords work analogously to those for CL:SUBSTITUTE. In particular, the behaviour of :from-end is possibly different from other versions of this function; :from-end values of NIL and T are equivalent unless :count is supplied. The second return value is an index suitable as an argument to CL:SUBSEQ into the sequence indicating where processing stopped.

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: split-sequence-by-partitioning SEQUENCE &rest PREDICATES

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: string+ &rest ARGS

Package

hu.dwim.util

Source

string-early.lisp (file)

Function: string-trim-whitespace TEXT

Package

hu.dwim.util

Source

string.lisp (file)

Function: string-with-integers< STR1 STR2 &key START1 START2

Package

hu.dwim.util

Source

string.lisp (file)

Function: string-with-numeric< STR1 STR2 DIGIT-P PARSE-NUMBER &key START1 START2

Package

hu.dwim.util

Source

string.lisp (file)

Function: string-with-roman-numerals< STR1 STR2 &key START1 START2

Package

hu.dwim.util

Source

string.lisp (file)

Function: subseq-if-longer LIMIT SEQUENCE &key POSTFIX

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: substitute-all OLD-ELEMENTS NEW-ELEMENT SEQUENCE &key TEST START COUNT END KEY FROM-END

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: substitute/tree NEW OLD LIST &key FROM-END TEST TEST-NOT END COUNT KEY START

Starting from LIST non-destructively replaces OLD with NEW.

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: sum* LIST &key KEY IGNORE-NON-NUMBERS

Package

hu.dwim.util

Source

number.lisp (file)

Function: symbol-global-value SYMBOL

Function: (setf symbol-global-value) VALUE SYMBOL

Operates on the global binding of SYMBOL (as opposed to the thread local binding accessed by CL:SYMBOL-VALUE).

Package

hu.dwim.util

Source

place.lisp (file)

Function: the-non-nil VALUE

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: the-only-element ELEMENTS

Package

hu.dwim.util

Source

sequence.lisp (file)

Function: type-instance-count-upper-bound INPUT-TYPE

Package

hu.dwim.util

Source

type.lisp (file)

Function: type-instance-list TYPE

Package

hu.dwim.util

Source

type.lisp (file)

Function: whitespace? CHARACTER

Package

hu.dwim.util

Source

string.lisp (file)

Function: write-characters CHARACTER COUNT &optional STREAM

Package

hu.dwim.util

Source

string.lisp (file)

Function: write-spaces COUNT &optional STREAM

Package

hu.dwim.util

Source

string.lisp (file)

6.1.6 Generic functions

Generic Function: debug-on-error? CONTEXT ERROR

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Methods

Method: debug-on-error? CONTEXT ERROR

Generic Function: g* OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g* (OBJECT-1 number) (OBJECT-2 number)

Generic Function: g+ OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g+ (OBJECT-1 number) (OBJECT-2 number)

Generic Function: g- OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g- (OBJECT-1 number) (OBJECT-2 number)

Generic Function: g/ OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g/ (OBJECT-1 number) (OBJECT-2 number)

Generic Function: g< OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g< (OBJECT-1 number) (OBJECT-2 number)

Method: g< (OBJECT-1 string) (OBJECT-2 string)

Generic Function: g<= OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g<= (OBJECT-1 number) (OBJECT-2 number)

Method: g<= (OBJECT-1 string) (OBJECT-2 string)

Generic Function: g= OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g= OBJECT-1 OBJECT-2

Method: g= (OBJECT-1 number) (OBJECT-2 number)

Method: g= (OBJECT-1 string) (OBJECT-2 string)

Method: g= (OBJECT-1 symbol) (OBJECT-2 symbol)

Method: g= (OBJECT-1 list) (OBJECT-2 list)

Method: g= (OBJECT-1 array) (OBJECT-2 array)

Method: g= (OBJECT-1 hash-table) (OBJECT-2 hash-table)

Method: g= (OBJECT-1 structure-object) (OBJECT-2 structure-object)

Method: g= (OBJECT-1 standard-object) (OBJECT-2 standard-object)

Generic Function: g> OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g> (OBJECT-1 number) (OBJECT-2 number)

Method: g> (OBJECT-1 string) (OBJECT-2 string)

Generic Function: g>= OBJECT-1 OBJECT-2

Package

hu.dwim.util

Source

generic-operator.lisp (file)

Methods

Method: g>= (OBJECT-1 number) (OBJECT-2 number)

Method: g>= (OBJECT-1 string) (OBJECT-2 string)

Generic Function: hash-key OBJECT

Package

hu.dwim.util

Source

hash-table.lisp (file)

Methods

Method: hash-key OBJECT

6.1.7 Conditions

Condition: nested-condition ()

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

Direct superclasses

condition (condition)

Direct methods

• nested-condition-of (method)
• nested-condition-of (method)

Direct slots

Slot: nested-condition

Initargs

:nested-condition

Initform

(quote nil)

Readers

nested-condition-of (generic function)

Writers

(setf nested-condition-of) (generic function)

6.1.8 Structures

Structure: atomic-counter ()

Package

hu.dwim.util

Source

threads-early.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: counter

Type

(unsigned-byte 64)

Initform

0

Readers

ac/counter (function)

Writers

(setf ac/counter) (function)

6.1.9 Types

Type: function-designator ()

Package

hu.dwim.util

Source

type.lisp (file)

Type: function-name ()

Package

hu.dwim.util

Source

type.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: +cached-integer-names/base-10/unindented+

Package

hu.dwim.util

Source

integer-to-string.lisp (file)

Constant: +failed-match+

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Constant: +indent-length->string-of-spaces+

Package

hu.dwim.util

Source

string.lisp (file)

Constant: +integer-to-string-cache-size+

Package

hu.dwim.util

Source

integer-to-string.lisp (file)

Constant: +no-bindings+

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Constant: +string-of-spaces/cache-size+

Package

hu.dwim.util

Source

string.lisp (file)

6.2.2 Special variables

Special Variable: *error-log-decorators*

List of decorators that will be invoked when an error backtrace is logged. A decorator is a closure that will be FUNCALL’d and can print to *STANDARD-OUTPUT* (caret will not be on a new line when called).

Package

hu.dwim.util

Source

error-handling-early.lisp (file)

6.2.3 Functions

Function: %integer-to-string INTEGER MINIMUM-COLUMN-COUNT MAXIMUM-DIGIT-COUNT BASE

Package

hu.dwim.util

Source

integer-to-string.lisp (file)

Function: ac/counter INSTANCE

Function: (setf ac/counter) VALUE INSTANCE

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: atomic-counter-p OBJECT

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: binding-val BINDING

Get the value part of a single binding.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: binding-var BINDING

Get the variable part of a single binding.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: call-with-profiling FN0

Package

hu.dwim.util

Source

sbcl.lisp (file)

Function: clause-anding-2 &key (ANDING EXPR) (INTO VAR)

Package

hu.dwim.util

Source

iterate.lisp (file)

Function: clause-oring-3 &key (ORING EXPR) (INTO VAR)

Package

hu.dwim.util

Source

iterate.lisp (file)

Function: clause-summing*-1 &key (SUMMING* EXPR) (INTO VAR)

Sum into a variable when expr evaluates to non nil at least once, otherwise nil

Package

hu.dwim.util

Source

iterate.lisp (file)

Function: collect-pattern-variables SYNTAX &optional FOUND-SO-FAR

Return a list of leaves of tree satisfying predicate, with duplicates removed.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: copy-atomic-counter INSTANCE

Package

hu.dwim.util

Source

threads-early.lisp (file)

Function: extend-bindings VAR VAL BINDINGS

Add a (var . value) pair to a binding list.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: first-match-pos PAT1 INPUT START

Find the first position that pat1 could possibly match input, starting at position start. If pat1 is non-constant, then just return start.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: get-binding VAR BINDINGS

Find a (variable . value) pair in a binding list.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: lookup VAR BINDINGS

Get the value part (for var) from a binding list.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: make-binding VAR VAL

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-and PATTERNS INPUT BINDINGS

Succeed if all the patterns match the input.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-if PATTERN INPUT BINDINGS

Test an arbitrary expression involving variables. The pattern looks like ((?if code) . rest).

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-is VAR-AND-PRED INPUT BINDINGS

Succeed and bind var if the input satisfies pred, where var-and-pred is the list (var pred).

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-not PATTERNS INPUT BINDINGS

Succeed if none of the patterns match the input. This will never bind any variables.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-or PATTERNS INPUT BINDINGS

Succeed if any one of the patterns match the input.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: match-variable VAR INPUT BINDINGS

Does VAR match input? Uses (or updates) and returns bindings.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: object-matcher PATTERN INPUT BINDINGS

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: object-pattern-p PATTERN

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: pattern-variable-p X

Is x a variable (a symbol beginning with ‘?’)?

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-match PATTERN INPUT BINDINGS &optional START

Match the segment pattern ((?* var) . pat) against input.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-match+ PATTERN INPUT BINDINGS

Match one or more elements of input.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-match-fn X

Get the segment-match function for x, if it is a symbol that has one.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-match? PATTERN INPUT BINDINGS

Match zero or one element of input.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-matcher PATTERN INPUT BINDINGS

Call the right function for this kind of segment pattern.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: segment-pattern-p PATTERN

Is this a segment-matching pattern like ((?* var) . pat)?

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: single-match-fn X

Get the single-match function for x, if it is a symbol that has one.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: single-matcher PATTERN INPUT BINDINGS

Call the right function for this kind of single pattern.

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

Function: single-pattern-p PATTERN

Is this a single-matching pattern?
E.g. (?is x predicate) (?and . patterns) (?or . patterns).

Package

hu.dwim.util

Source

pattern-matcher.lisp (file)

6.2.4 Generic functions

Generic Function: nested-condition-of CONDITION

Generic Function: (setf nested-condition-of) NEW-VALUE CONDITION

Package

hu.dwim.util

Methods

Method: nested-condition-of (CONDITION nested-condition)

Method: (setf nested-condition-of) NEW-VALUE (CONDITION nested-condition)

Source

error-handling-early.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions