This is the golden-utils Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:46:20 2025 GMT+0.
golden-utils/golden-utils.asdgolden-utils/package.lispgolden-utils/closure.lispgolden-utils/type.lispgolden-utils/symbol.lispgolden-utils/number.lispgolden-utils/character.lispgolden-utils/array.lispgolden-utils/string.lispgolden-utils/sequence.lispgolden-utils/list.lispgolden-utils/list-alist.lispgolden-utils/list-plist.lispgolden-utils/hash-table.lispgolden-utils/macro.lispgolden-utils/filesystem.lispgolden-utils/math.lispgolden-utils/misc.lispThe main system appears first, followed by any subsystem dependency.
golden-utilsA utility library.
Michael Fiano <mail@mfiano.net>
MIT
alexandria (system).
uiop (system).
package.lisp (file).
closure.lisp (file).
type.lisp (file).
symbol.lisp (file).
number.lisp (file).
character.lisp (file).
array.lisp (file).
string.lisp (file).
sequence.lisp (file).
list.lisp (file).
list-alist.lisp (file).
list-plist.lisp (file).
hash-table.lisp (file).
macro.lisp (file).
filesystem.lisp (file).
math.lisp (file).
misc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
golden-utils/golden-utils.asdgolden-utils/package.lispgolden-utils/closure.lispgolden-utils/type.lispgolden-utils/symbol.lispgolden-utils/number.lispgolden-utils/character.lispgolden-utils/array.lispgolden-utils/string.lispgolden-utils/sequence.lispgolden-utils/list.lispgolden-utils/list-alist.lispgolden-utils/list-plist.lispgolden-utils/hash-table.lispgolden-utils/macro.lispgolden-utils/filesystem.lispgolden-utils/math.lispgolden-utils/misc.lispgolden-utils/closure.lisppackage.lisp (file).
golden-utils (system).
define-pfun (macro).
dlambda (macro).
plambda (macro).
with-pvars (macro).
(setf pget) (setf expander).
pget (function).
plet/get (function).
plet/set (function).
golden-utils/type.lispclosure.lisp (file).
golden-utils (system).
b16 (type).
b16a (type).
b24 (type).
b24a (type).
b32 (type).
b32a (type).
b64 (type).
b64a (type).
b8 (type).
b8a (type).
f32 (type).
f32a (type).
f64 (type).
f64a (type).
fixnum-array (type).
fn-> (type).
octet (type).
octet-vector (type).
ub16 (type).
ub16a (type).
ub24 (type).
ub24a (type).
ub32 (type).
ub32a (type).
ub64 (type).
ub64a (type).
ub8 (type).
ub8a (type).
golden-utils/symbol.lisptype.lisp (file).
golden-utils (system).
collect-external-symbols (function).
collect-symbols (function).
make-keyword (function).
golden-utils/number.lispsymbol.lisp (file).
golden-utils (system).
count-digits (function).
golden-utils/character.lispnumber.lisp (file).
golden-utils (system).
ascii-alphanumeric-p (function).
ascii-char-p (function).
ascii-control-p (function).
ascii-letter-p (function).
ascii-lowercase-p (function).
ascii-number-p (function).
ascii-uppercase-p (function).
hex-char-p (function).
null-char-p (function).
golden-utils/array.lispcharacter.lisp (file).
golden-utils (system).
make-b16-array (function).
make-b24-array (function).
make-b32-array (function).
make-b8-array (function).
make-bit-vector (function).
make-f32-array (function).
make-f64-array (function).
make-fixnum-array (function).
make-ub16-array (function).
make-ub24-array (function).
make-ub32-array (function).
make-ub8-array (function).
golden-utils/string.lisparray.lisp (file).
golden-utils (system).
string->keyword (function).
string-ends-with-p (function).
string-explode (function).
string-merge (function).
string-starts-with-p (function).
string-trim-whitespace (function).
golden-utils/sequence.lispstring.lisp (file).
golden-utils (system).
do-seq (macro).
enumerate (function).
flatten-numbers (function).
flatten-tree (function).
golden-utils/list.lispsequence.lisp (file).
golden-utils (system).
combinations/repetition (function).
interleave (function).
tree-leaves (function).
zip (function).
golden-utils/list-alist.lisplist.lisp (file).
golden-utils (system).
alist (type).
alist->hash (function).
alist->plist (function).
alist-get (function).
alist-keys (function).
alist-p (function).
alist-remove (function).
alist-removef (macro).
alist-rget (function).
alist-values (function).
do-alist (macro).
do-alist-keys (macro).
do-alist-values (macro).
map-alist (function).
map-alist-keys (function).
map-alist-values (function).
golden-utils/list-plist.lisplist-alist.lisp (file).
golden-utils (system).
do-plist (macro).
do-plist-keys (macro).
do-plist-values (macro).
map-plist (function).
map-plist-keys (function).
map-plist-values (function).
plist (type).
plist->alist (function).
plist->hash (function).
plist-get (function).
plist-keys (function).
plist-p (function).
plist-remove (function).
plist-removef (macro).
plist-values (function).
golden-utils/hash-table.lisplist-plist.lisp (file).
golden-utils (system).
dict (function).
do-hash (macro).
do-hash-keys (macro).
do-hash-values (macro).
hash->alist (function).
hash->plist (function).
hash-keys (function).
hash-merge (function).
hash-values (function).
href (compiler macro).
(setf href) (compiler macro).
href (function).
(setf href) (function).
expand-href (function).
golden-utils/macro.lisphash-table.lisp (file).
golden-utils (system).
define-printer (macro).
defun-inline (macro).
eval-always (macro).
fn-> (macro).
if-found (macro).
mvlet (macro).
mvlet* (macro).
unless-found (macro).
until (macro).
when-found (macro).
while (macro).
with-temp-package (macro).
golden-utils/filesystem.lispmacro.lisp (file).
golden-utils (system).
file->string (function).
map-files (function).
safe-read-file-form (function).
safe-read-file-forms (function).
string->file (function).
with-binary-input (macro).
with-binary-output (macro).
with-file-input (macro).
with-file-output (macro).
golden-utils/math.lispfilesystem.lisp (file).
golden-utils (system).
average (function).
degrees->radians (function).
map-domain (function).
radians->degrees (function).
golden-utils/misc.lispmath.lisp (file).
golden-utils (system).
noop (function).
Packages are listed by definition order.
golden-utilsalexandria.
common-lisp.
alist (type).
alist->hash (function).
alist->plist (function).
alist-get (function).
alist-keys (function).
alist-p (function).
alist-remove (function).
alist-removef (macro).
alist-rget (function).
alist-values (function).
ascii-alphanumeric-p (function).
ascii-char-p (function).
ascii-control-p (function).
ascii-letter-p (function).
ascii-lowercase-p (function).
ascii-number-p (function).
ascii-uppercase-p (function).
average (function).
b16 (type).
b16a (type).
b24 (type).
b24a (type).
b32 (type).
b32a (type).
b64 (type).
b64a (type).
b8 (type).
b8a (type).
collect-external-symbols (function).
collect-symbols (function).
combinations/repetition (function).
count-digits (function).
define-pfun (macro).
define-printer (macro).
defun-inline (macro).
degrees->radians (function).
dict (function).
dlambda (macro).
do-alist (macro).
do-alist-keys (macro).
do-alist-values (macro).
do-hash (macro).
do-hash-keys (macro).
do-hash-values (macro).
do-plist (macro).
do-plist-keys (macro).
do-plist-values (macro).
do-seq (macro).
enumerate (function).
eval-always (macro).
f32 (type).
f32a (type).
f64 (type).
f64a (type).
file->string (function).
fixnum-array (type).
flatten-numbers (function).
flatten-tree (function).
fn-> (macro).
fn-> (type).
hash->alist (function).
hash->plist (function).
hash-keys (function).
hash-merge (function).
hash-values (function).
hex-char-p (function).
href (compiler macro).
(setf href) (compiler macro).
href (function).
(setf href) (function).
if-found (macro).
interleave (function).
make-b16-array (function).
make-b24-array (function).
make-b32-array (function).
make-b8-array (function).
make-bit-vector (function).
make-f32-array (function).
make-f64-array (function).
make-fixnum-array (function).
make-keyword (function).
make-ub16-array (function).
make-ub24-array (function).
make-ub32-array (function).
make-ub8-array (function).
map-alist (function).
map-alist-keys (function).
map-alist-values (function).
map-domain (function).
map-files (function).
map-plist (function).
map-plist-keys (function).
map-plist-values (function).
mvlet (macro).
mvlet* (macro).
noop (function).
null-char-p (function).
octet (type).
octet-vector (type).
plambda (macro).
plist (type).
plist->alist (function).
plist->hash (function).
plist-get (function).
plist-keys (function).
plist-p (function).
plist-remove (function).
plist-removef (macro).
plist-values (function).
radians->degrees (function).
safe-read-file-form (function).
safe-read-file-forms (function).
string->file (function).
string->keyword (function).
string-ends-with-p (function).
string-explode (function).
string-merge (function).
string-starts-with-p (function).
string-trim-whitespace (function).
tree-leaves (function).
ub16 (type).
ub16a (type).
ub24 (type).
ub24a (type).
ub32 (type).
ub32a (type).
ub64 (type).
ub64a (type).
ub8 (type).
ub8a (type).
unless-found (macro).
until (macro).
when-found (macro).
while (macro).
with-binary-input (macro).
with-binary-output (macro).
with-file-input (macro).
with-file-output (macro).
with-pvars (macro).
with-temp-package (macro).
zip (function).
expand-href (function).
(setf pget) (setf expander).
pget (function).
plet/get (function).
plet/set (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Place-modifying macro for ALIST-REMOVE.
Define a PRINT-OBJECT method for ‘OBJECT‘.
Conveniently define the function ‘NAME‘ and also inline it.
Iterate over the association list, ‘ALIST‘, binding each key and value to ‘KEY‘ and ‘VALUE‘ respectively, performing ‘BODY‘.
Iterate over the association list, ‘ALIST‘, binding each key to ‘KEY‘, performing ‘BODY‘.
Iterate over the association list, ‘ALIST‘, binding each value to ‘VALUE‘, performing ‘BODY‘.
Iterates over hash table ‘TABLE‘, binding each key to ‘KEY‘, and its value to ‘VALUE‘.
Iterate over hash table ‘TABLE‘, binding each key to ‘KEY‘.
Iterate over hash table ‘TABLE‘, binding each value to ‘VALUE‘.
Iterate over the property list, ‘PLIST‘, binding each key and value to ‘KEY‘ and ‘VALUE‘ respectively, performing ‘BODY‘.
Iterate over the property list, ‘PLIST‘, binding each key to ‘KEY‘, performing ‘BODY‘.
Iterate over the property list, ‘PLIST‘, binding each value to ‘VALUE‘, performing ‘BODY‘.
Iterates over ‘SEQUENCE‘, binding ‘VAR‘ to each element. Like DOLIST, but for all sequence types.
Declaim the ‘FTYPE‘ of function from ‘ARGS‘ to ‘VALUES‘.
Depending if ‘LOOKUP‘ is successful or not, perform ‘THEN‘ or ‘ELSE‘ with ‘VAR‘ bound to the result. ‘LOOKUP‘ is an expression that returns two values, with the second value indicating if the lookup was successful, such as with GETHASH.
Place-modifying macro for PLIST-REMOVE.
If ‘LOOKUP‘ is unsuccessful, perform ‘BODY‘ with ‘VAR‘ bound to the result. ‘LOOKUP‘ is an expression that returns two values, with the second value indicating if the lookup was successful, such as with GETHASH.
Loop until ‘PREDICATE‘ is satisfied.
If ‘LOOKUP‘ is successful, perform ‘BODY‘ with ‘VAR‘ bound to the result. ‘LOOKUP‘ is an expression that returns two values, with the second value indicating if the lookup was successful, such as with GETHASH.
Loop while ‘PREDICATE‘ is satisfied.
Open the file at location ‘PATH‘ as binary input and perform ‘BODY‘.
Open the file at location ‘PATH‘, as binary output and perform ‘BODY‘.
If the file already exists, it is overwritten.
If the file does not exist, it is created.
Open the file at location ‘PATH‘ as input and perform ‘BODY‘.
Open the file at location ‘PATH‘, as output and perform ‘BODY‘.
If the file already exists, it is overwritten.
If the file does not exist, it is created.
Convert ‘ALIST‘ to a hash table.
Convert ‘ALIST‘ to a property list. A property list in this context has keyword symbols for its keys.
Get the value associated with ‘KEY‘ in ‘ALIST‘.
Get a list of all keys in ‘ALIST‘.
Check whether or not ‘ITEM‘ is an association list.
Remove all ‘KEYS‘ and their associated values from ‘ALIST‘. Non-destructive.
Get the key associated with ‘VALUE‘ in ‘ALIST‘.
Get a list of all values in ‘ALIST‘.
Check if the character ‘CHAR‘ is an ASCII alpha-numeric character.
Check if the character ‘CHAR‘ is an ASCII character.
Check if the character ‘CHAR‘ is an ASCII control character.
Check if the character ‘CHAR‘ is an ASCII letter character.
Check if the character ‘CHAR‘ is a lowercase ASCII character.
Check if the character ‘CHAR‘ is an ASCII number character.
Check if the character ‘CHAR‘ is an uppercase ASCII character.
Calculate the mean average of ‘NUMBERS‘, a list of numbers.
Collect a list of all external symbols of ‘PACKAGE‘.
Collect a list of all symbols of ‘PACKAGE‘.
Return a list of all combinations of ‘ITEMS‘ with with a length of ‘N‘, and repetitions allowed.
Return the number of digits of ‘INTEGER‘.
Convert ‘DEGREES‘ to radians.
Return an alist with each car being a number determined by sequentially incrementing from ‘START‘ by ‘STEP‘, and each cdr being the element of ‘SEQUENCE‘ applied to the function ‘KEY‘.
Read the file located at ‘PATH‘ into a string.
Like FLATTEN, except only keeps real numbers and arranges for the result to be a specialized array of element-type ‘TYPE‘.
Traverses a sequence in order, collecting non-nil values into a list. This is different than Alexandria’s version in that this also works for vectors or hybrid sequences.
Convert the keys and values of the hash table ‘TABLE‘ to an association list.
Convert the keys and values of the hash table ‘TABLE‘ to a property list.
Collect a list of all keys in the hash table ‘TABLE‘.
Collect a list of all values in the hash table ‘TABLE.
Check if the character ‘CHAR‘ is a hexadecimal character.
Interleave the elements of ‘LISTS‘.
Interns ‘OBJECT‘, a string designator or number, into the keyword package.
Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 2 arguments, for the key and value of each iteration.
Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 1 arguments for the key of each iteration.
Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 1 arguments for the value of each iteration.
Map ‘VALUE‘ from the domain denoted by ‘SOURCE-MIN‘ and ‘SOURCE-MAX‘ to the domain denoted by ‘DEST-MIN‘ and ‘DEST-MAX‘.
Map over all files located in the directory of ‘PATH‘, applying ‘FUNCTION‘ to each file’s path. ‘TEST‘ is a function that takes a file path and decides if ‘FUNCTION‘ should be applied to it. ‘RECURSIVE-P‘, when non-NIL will descend into sub-directories of ‘PATH‘ recursively.
Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 2 arguments, for the key and value of each iteration.
Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 1 arguments for the key of each iteration.
Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 1 arguments for the value of each iteration.
Do nothing.
Convert ‘PLIST‘ to an association list.
Convert ‘PLIST‘ to a hash table.
Get the value associated with ‘KEY‘ in ‘PLIST‘.
Get a list of all keys in ‘PLIST‘.
Check whether or not ‘ITEM‘ is a property list.
Remove all ‘KEYS‘ and their associated values from ‘PLIST‘. Non-destructive.
Get a list of all values in ‘PLIST‘.
Convert ‘RADIANS‘ to degrees.
Read the first form of the file located at ‘PATH‘, with *PACKAGE* bound to ‘PACKAGE‘.
Read all forms of the file located at ‘PATH‘, with *PACKAGE* bound to ‘PACKAGE‘.
Write ‘STRING‘ to the file located at ‘PATH‘.
Convert ‘STRING‘ to a keyword symbol.
Check if ‘STRING‘ ends with ‘SUFFIX‘.
Explode ‘STRING‘ into a list of its characters.
Merge ‘STRINGS‘ into a single string.
Check if ‘STRING‘ starts with ‘PREFIX‘.
Trim leading and trailing whitespace characters from ‘STRING‘.
Replace leaves of ‘TREE‘ that satisfy ‘TEST‘ with ‘RESULT‘. From Let Over Lambda by Doug Hoyte.
Zip the given ‘LISTS‘.
| Jump to: | (
A C D E F H I M N P R S T U W Z |
|---|
| Jump to: | (
A C D E F H I M N P R S T U W Z |
|---|
| Jump to: | A B C F G H L M N O P S T U |
|---|
| Jump to: | A B C F G H L M N O P S T U |
|---|