The golden-utils Reference Manual

Table of Contents

The golden-utils Reference Manual

This is the golden-utils Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 11:54:56 2020 GMT+0.

1 Introduction

golden-utils

Auxiliary Utilities (AU).

Overview

A collection of personal utilities that have been found useful.

Install

(ql:quickload :golden-utils)

Usage

TODO

License

Copyright © 2017-2018 Michael Fiano.

Licensed under the MIT License.

2 Systems

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

2.1 golden-utils

Maintainer

Michael Fiano <mail@michaelfiano.com>

Author

Michael Fiano <mail@michaelfiano.com>

Home Page

https://github.com/mfiano/golden-utils

Source Control

(:git "https://github.com/mfiano/golden-utils.git")

Bug Tracker

https://github.com/mfiano/golden-utils/issues

License

MIT

Description

A utility library.

Dependencies

• uiop
• alexandria

Source

golden-utils.asd (file)

Components

• package.lisp (file)
• macro.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)
• filesystem.lisp (file)
• math.lisp (file)
• misc.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 golden-utils.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/golden-utils-20200325-git/golden-utils.asd

Systems

golden-utils (system)

3.1.2 golden-utils/package.lisp

Parent

golden-utils (system)

Location

package.lisp

Packages

golden-utils

3.1.3 golden-utils/macro.lisp

Dependency

package.lisp (file)

Parent

golden-utils (system)

Location

macro.lisp

Exported Definitions

• 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)

3.1.4 golden-utils/closure.lisp

Dependency

macro.lisp (file)

Parent

golden-utils (system)

Location

closure.lisp

Exported Definitions

• define-pfun (macro)
• dlambda (macro)
• plambda (macro)
• with-pvars (macro)

Internal Definitions

• pget (function)
• (setf pget) (setf expander)
• plet/get (function)
• plet/set (function)

3.1.5 golden-utils/type.lisp

Dependency

closure.lisp (file)

Parent

golden-utils (system)

Location

type.lisp

Exported Definitions

• b16 (type)
• b16-array (type)
• b24 (type)
• b24-array (type)
• b32 (type)
• b32-array (type)
• b64 (type)
• b64-array (type)
• b8 (type)
• b8-array (type)
• fn-> (type)
• octet (type)
• ub16 (type)
• ub16-array (type)
• ub24 (type)
• ub24-array (type)
• ub32 (type)
• ub32-array (type)
• ub64 (type)
• ub64-array (type)
• ub8 (type)
• ub8-array (type)

3.1.6 golden-utils/symbol.lisp

Dependency

type.lisp (file)

Parent

golden-utils (system)

Location

symbol.lisp

Exported Definitions

• collect-external-symbols (function)
• collect-symbols (function)
• make-keyword (function)

3.1.7 golden-utils/number.lisp

Dependency

symbol.lisp (file)

Parent

golden-utils (system)

Location

number.lisp

Exported Definitions

count-digits (function)

3.1.8 golden-utils/character.lisp

Dependency

number.lisp (file)

Parent

golden-utils (system)

Location

character.lisp

Exported Definitions

• 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)

3.1.9 golden-utils/array.lisp

Dependency

character.lisp (file)

Parent

golden-utils (system)

Location

array.lisp

Exported Definitions

make-ub8-array (function)

3.1.10 golden-utils/string.lisp

Dependency

array.lisp (file)

Parent

golden-utils (system)

Location

string.lisp

Exported Definitions

• string->keyword (function)
• string-ends-with-p (function)
• string-explode (function)
• string-merge (function)
• string-starts-with-p (function)
• string-trim-whitespace (function)

3.1.11 golden-utils/sequence.lisp

Dependency

string.lisp (file)

Parent

golden-utils (system)

Location

sequence.lisp

Exported Definitions

• do-seq (macro)
• enumerate (function)
• flatten-numbers (function)
• flatten-tree (function)

3.1.12 golden-utils/list.lisp

Dependency

sequence.lisp (file)

Parent

golden-utils (system)

Location

list.lisp

Exported Definitions

• combinations/repetition (function)
• interleave (function)
• tree-leaves (function)
• zip (function)

3.1.13 golden-utils/list-alist.lisp

Dependency

list.lisp (file)

Parent

golden-utils (system)

Location

list-alist.lisp

Exported Definitions

• 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)

3.1.14 golden-utils/list-plist.lisp

Dependency

list-alist.lisp (file)

Parent

golden-utils (system)

Location

list-plist.lisp

Exported Definitions

• 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)

3.1.15 golden-utils/hash-table.lisp

Dependency

list-plist.lisp (file)

Parent

golden-utils (system)

Location

hash-table.lisp

Exported Definitions

• 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 (function)
• (setf href) (function)

3.1.16 golden-utils/filesystem.lisp

Dependency

hash-table.lisp (file)

Parent

golden-utils (system)

Location

filesystem.lisp

Exported Definitions

• 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)

3.1.17 golden-utils/math.lisp

Dependency

filesystem.lisp (file)

Parent

golden-utils (system)

Location

math.lisp

Exported Definitions

• average (function)
• degrees->radians (function)
• map-domain (function)
• radians->degrees (function)

3.1.18 golden-utils/misc.lisp

Dependency

math.lisp (file)

Parent

golden-utils (system)

Location

misc.lisp

Exported Definitions

noop (function)

4 Packages

Packages are listed by definition order.

4.1 golden-utils

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• 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)
• b16-array (type)
• b24 (type)
• b24-array (type)
• b32 (type)
• b32-array (type)
• b64 (type)
• b64-array (type)
• b8 (type)
• b8-array (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)
• file->string (function)
• 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 (function)
• (setf href) (function)
• if-found (macro)
• interleave (function)
• make-keyword (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)
• 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)
• ub16-array (type)
• ub24 (type)
• ub24-array (type)
• ub32 (type)
• ub32-array (type)
• ub64 (type)
• ub64-array (type)
• ub8 (type)
• ub8-array (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)
• zip (function)

Internal Definitions

• pget (function)
• (setf pget) (setf expander)
• plet/get (function)
• plet/set (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: alist-removef PLACE &rest KEYS

Place-modifying macro for ALIST-REMOVE.

Package

golden-utils

Source

list-alist.lisp (file)

Macro: define-pfun NAME ARGS &body BODY

Package

golden-utils

Source

closure.lisp (file)

Macro: define-printer (OBJECT STREAM &key TYPE IDENTITY) &body BODY

Define a PRINT-OBJECT method for ‘OBJECT‘.

Package

golden-utils

Source

macro.lisp (file)

Macro: defun-inline NAME ARGS &body BODY

Conveniently define the function ‘NAME‘ and also inline it.

Package

golden-utils

Source

macro.lisp (file)

Macro: dlambda &body DS

Package

golden-utils

Source

closure.lisp (file)

Macro: do-alist (KEY VALUE ALIST) &body BODY

Iterate over the association list, ‘ALIST‘, binding each key and value to ‘KEY‘ and ‘VALUE‘ respectively, performing ‘BODY‘.

Package

golden-utils

Source

list-alist.lisp (file)

Macro: do-alist-keys (KEY ALIST) &body BODY

Iterate over the association list, ‘ALIST‘, binding each key to ‘KEY‘, performing ‘BODY‘.

Package

golden-utils

Source

list-alist.lisp (file)

Macro: do-alist-values (VALUE ALIST) &body BODY

Iterate over the association list, ‘ALIST‘, binding each value to ‘VALUE‘, performing ‘BODY‘.

Package

golden-utils

Source

list-alist.lisp (file)

Macro: do-hash (KEY VALUE TABLE &optional RESULT) &body BODY

Iterates over hash table ‘TABLE‘, binding each key to ‘KEY‘, and its value to ‘VALUE‘.

Package

golden-utils

Source

hash-table.lisp (file)

Macro: do-hash-keys (KEY TABLE) &body BODY

Iterate over hash table ‘TABLE‘, binding each key to ‘KEY‘.

Package

golden-utils

Source

hash-table.lisp (file)

Macro: do-hash-values (VALUE TABLE) &body BODY

Iterate over hash table ‘TABLE‘, binding each value to ‘VALUE‘.

Package

golden-utils

Source

hash-table.lisp (file)

Macro: do-plist (KEY VALUE PLIST) &body BODY

Iterate over the property list, ‘PLIST‘, binding each key and value to ‘KEY‘ and ‘VALUE‘ respectively, performing ‘BODY‘.

Package

golden-utils

Source

list-plist.lisp (file)

Macro: do-plist-keys (KEY PLIST) &body BODY

Iterate over the property list, ‘PLIST‘, binding each key to ‘KEY‘, performing ‘BODY‘.

Package

golden-utils

Source

list-plist.lisp (file)

Macro: do-plist-values (VALUE PLIST) &body BODY

Iterate over the property list, ‘PLIST‘, binding each value to ‘VALUE‘, performing ‘BODY‘.

Package

golden-utils

Source

list-plist.lisp (file)

Macro: do-seq (VAR SEQUENCE) &body BODY

Iterates over ‘SEQUENCE‘, binding ‘VAR‘ to each element. Like DOLIST, but for all sequence types.

Package

golden-utils

Source

sequence.lisp (file)

Macro: eval-always &body BODY

Package

golden-utils

Source

macro.lisp (file)

Macro: fn-> FUNCTION ARGS VALUES

Declaim the ‘FTYPE‘ of function from ‘ARGS‘ to ‘VALUES‘.

Package

golden-utils

Source

macro.lisp (file)

Macro: if-found (VAR LOOKUP) THEN ELSE

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.

Package

golden-utils

Source

macro.lisp (file)

Macro: mvlet (&rest BINDINGS) &body BODY

Package

golden-utils

Source

macro.lisp (file)

Macro: mvlet* (&rest BINDINGS) &body BODY

Package

golden-utils

Source

macro.lisp (file)

Macro: plambda ARGS EXPORTS &body BODY

Package

golden-utils

Source

closure.lisp (file)

Macro: plist-removef PLACE &rest KEYS

Place-modifying macro for PLIST-REMOVE.

Package

golden-utils

Source

list-plist.lisp (file)

Macro: unless-found (VAR LOOKUP) &body BODY

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.

Package

golden-utils

Source

macro.lisp (file)

Macro: until PREDICATE &body BODY

Loop until ‘PREDICATE‘ is satisfied.

Package

golden-utils

Source

macro.lisp (file)

Macro: when-found (VAR LOOKUP) &body BODY

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.

Package

golden-utils

Source

macro.lisp (file)

Macro: while PREDICATE &body BODY

Loop while ‘PREDICATE‘ is satisfied.

Package

golden-utils

Source

macro.lisp (file)

Macro: with-binary-input (STREAM FILE) &body BODY

Open the file at location ‘PATH‘ as binary input and perform ‘BODY‘.

Package

golden-utils

Source

filesystem.lisp (file)

Macro: with-binary-output (STREAM FILE &optional APPEND-P) &body 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.

Package

golden-utils

Source

filesystem.lisp (file)

Macro: with-file-input (STREAM PATH) &body BODY

Open the file at location ‘PATH‘ as input and perform ‘BODY‘.

Package

golden-utils

Source

filesystem.lisp (file)

Macro: with-file-output (STREAM PATH &optional APPEND-P) &body 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.

Package

golden-utils

Source

filesystem.lisp (file)

Macro: with-pvars SYMBOLS BOX &body BODY

Package

golden-utils

Source

closure.lisp (file)

5.1.2 Functions

Function: alist->hash ALIST &rest ARGS

Convert ‘ALIST‘ to a hash table.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist->plist ALIST

Convert ‘ALIST‘ to a property list. A property list in this context has keyword symbols for its keys.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-get ALIST KEY &rest ARGS

Get the value associated with ‘KEY‘ in ‘ALIST‘.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-keys ALIST

Get a list of all keys in ‘ALIST‘.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-p ITEM

Check whether or not ‘ITEM‘ is an association list.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-remove ALIST &rest KEYS

Remove all ‘KEYS‘ and their associated values from ‘ALIST‘. Non-destructive.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-rget ALIST VALUE &rest ARGS

Get the key associated with ‘VALUE‘ in ‘ALIST‘.

Package

golden-utils

Source

list-alist.lisp (file)

Function: alist-values ALIST

Get a list of all values in ‘ALIST‘.

Package

golden-utils

Source

list-alist.lisp (file)

Function: ascii-alphanumeric-p CHAR

Check if the character ‘CHAR‘ is an ASCII alpha-numeric character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-char-p CHAR

Check if the character ‘CHAR‘ is an ASCII character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-control-p CHAR

Check if the character ‘CHAR‘ is an ASCII control character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-letter-p CHAR

Check if the character ‘CHAR‘ is an ASCII letter character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-lowercase-p CHAR

Check if the character ‘CHAR‘ is a lowercase ASCII character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-number-p CHAR

Check if the character ‘CHAR‘ is an ASCII number character.

Package

golden-utils

Source

character.lisp (file)

Function: ascii-uppercase-p CHAR

Check if the character ‘CHAR‘ is an uppercase ASCII character.

Package

golden-utils

Source

character.lisp (file)

Function: average &rest NUMBERS

Calculate the mean average of ‘NUMBERS‘, a list of numbers.

Package

golden-utils

Source

math.lisp (file)

Function: collect-external-symbols &optional PACKAGE

Collect a list of all external symbols of ‘PACKAGE‘.

Package

golden-utils

Source

symbol.lisp (file)

Function: collect-symbols &optional PACKAGE

Collect a list of all symbols of ‘PACKAGE‘.

Package

golden-utils

Source

symbol.lisp (file)

Function: combinations/repetition N ITEMS

Return a list of all combinations of ‘ITEMS‘ with with a length of ‘N‘, and repetitions allowed.

Package

golden-utils

Source

list.lisp (file)

Function: count-digits INTEGER

Return the number of digits of ‘INTEGER‘.

Package

golden-utils

Source

number.lisp (file)

Function: degrees->radians DEGREES

Convert ‘DEGREES‘ to radians.

Package

golden-utils

Source

math.lisp (file)

Function: dict &rest KEYS/VALUES

Package

golden-utils

Source

hash-table.lisp (file)

Function: enumerate SEQUENCE &key START STEP KEY

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‘.

Package

golden-utils

Source

sequence.lisp (file)

Function: file->string PATH

Read the file located at ‘PATH‘ into a string.

Package

golden-utils

Source

filesystem.lisp (file)

Function: flatten-numbers SEQUENCE &key TYPE

Like FLATTEN, except only keeps real numbers and arranges for the result to be a specialized array of element-type ‘TYPE‘.

Package

golden-utils

Source

sequence.lisp (file)

Function: flatten-tree SEQUENCE

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.

Package

golden-utils

Source

sequence.lisp (file)

Function: hash->alist TABLE

Convert the keys and values of the hash table ‘TABLE‘ to an association list.

Package

golden-utils

Source

hash-table.lisp (file)

Function: hash->plist TABLE

Convert the keys and values of the hash table ‘TABLE‘ to a property list.

Package

golden-utils

Source

hash-table.lisp (file)

Function: hash-keys TABLE

Collect a list of all keys in the hash table ‘TABLE‘.

Package

golden-utils

Source

hash-table.lisp (file)

Function: hash-merge TABLE &rest TABLES

Package

golden-utils

Source

hash-table.lisp (file)

Function: hash-values TABLE

Collect a list of all values in the hash table ‘TABLE.

Package

golden-utils

Source

hash-table.lisp (file)

Function: hex-char-p CHAR

Check if the character ‘CHAR‘ is a hexadecimal character.

Package

golden-utils

Source

character.lisp (file)

Function: href TABLE &rest KEYS

Function: (setf href) VALUE TABLE &rest KEYS

Package

golden-utils

Source

hash-table.lisp (file)

Function: interleave &rest LISTS

Interleave the elements of ‘LISTS‘.

Package

golden-utils

Source

list.lisp (file)

Function: make-keyword OBJECT

Interns ‘OBJECT‘, a string designator or number, into the keyword package.

Package

golden-utils

Source

symbol.lisp (file)

Function: make-ub8-array SIZE

Package

golden-utils

Source

array.lisp (file)

Function: map-alist FN ALIST

Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 2 arguments, for the key and value of each iteration.

Package

golden-utils

Source

list-alist.lisp (file)

Function: map-alist-keys FN ALIST

Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 1 arguments for the key of each iteration.

Package

golden-utils

Source

list-alist.lisp (file)

Function: map-alist-values FN ALIST

Map over the association list, ‘ALIST‘ applying ‘FN‘, a function that takes 1 arguments for the value of each iteration.

Package

golden-utils

Source

list-alist.lisp (file)

Function: map-domain SOURCE-MIN SOURCE-MAX DEST-MIN DEST-MAX VALUE

Map ‘VALUE‘ from the domain denoted by ‘SOURCE-MIN‘ and ‘SOURCE-MAX‘ to the domain denoted by ‘DEST-MIN‘ and ‘DEST-MAX‘.

Package

golden-utils

Source

math.lisp (file)

Function: map-files PATH FUNCTION &key TEST RECURSIVE-P

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.

Package

golden-utils

Source

filesystem.lisp (file)

Function: map-plist FN PLIST

Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 2 arguments, for the key and value of each iteration.

Package

golden-utils

Source

list-plist.lisp (file)

Function: map-plist-keys FN PLIST

Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 1 arguments for the key of each iteration.

Package

golden-utils

Source

list-plist.lisp (file)

Function: map-plist-values FN PLIST

Map over the property list, ‘PLIST‘ applying ‘FN‘, a function that takes 1 arguments for the value of each iteration.

Package

golden-utils

Source

list-plist.lisp (file)

Function: noop &rest ARGS

Do nothing.

Package

golden-utils

Source

misc.lisp (file)

Function: null-char-p CHAR

Package

golden-utils

Source

character.lisp (file)

Function: plist->alist PLIST

Convert ‘PLIST‘ to an association list.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist->hash PLIST &rest ARGS

Convert ‘PLIST‘ to a hash table.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist-get PLIST KEY

Get the value associated with ‘KEY‘ in ‘PLIST‘.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist-keys PLIST

Get a list of all keys in ‘PLIST‘.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist-p ITEM

Check whether or not ‘ITEM‘ is a property list.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist-remove PLIST &rest KEYS

Remove all ‘KEYS‘ and their associated values from ‘PLIST‘. Non-destructive.

Package

golden-utils

Source

list-plist.lisp (file)

Function: plist-values PLIST

Get a list of all values in ‘PLIST‘.

Package

golden-utils

Source

list-plist.lisp (file)

Function: radians->degrees RADIANS

Convert ‘RADIANS‘ to degrees.

Package

golden-utils

Source

math.lisp (file)

Function: safe-read-file-form PATH &key PACKAGE

Read the first form of the file located at ‘PATH‘, with *PACKAGE* bound to ‘PACKAGE‘.

Package

golden-utils

Source

filesystem.lisp (file)

Function: safe-read-file-forms PATH &key PACKAGE

Read all forms of the file located at ‘PATH‘, with *PACKAGE* bound to ‘PACKAGE‘.

Package

golden-utils

Source

filesystem.lisp (file)

Function: string->file STRING PATH

Write ‘STRING‘ to the file located at ‘PATH‘.

Package

golden-utils

Source

filesystem.lisp (file)

Function: string->keyword STRING

Convert ‘STRING‘ to a keyword symbol.

Package

golden-utils

Source

string.lisp (file)

Function: string-ends-with-p STRING SUFFIX

Check if ‘STRING‘ ends with ‘SUFFIX‘.

Package

golden-utils

Source

string.lisp (file)

Function: string-explode STRING

Explode ‘STRING‘ into a list of its characters.

Package

golden-utils

Source

string.lisp (file)

Function: string-merge &rest STRINGS

Merge ‘STRINGS‘ into a single string.

Package

golden-utils

Source

string.lisp (file)

Function: string-starts-with-p STRING PREFIX

Check if ‘STRING‘ starts with ‘PREFIX‘.

Package

golden-utils

Source

string.lisp (file)

Function: string-trim-whitespace STRING

Trim leading and trailing whitespace characters from ‘STRING‘.

Package

golden-utils

Source

string.lisp (file)

Function: tree-leaves TREE TEST RESULT

Replace leaves of ‘TREE‘ that satisfy ‘TEST‘ with ‘RESULT‘. From Let Over Lambda by Doug Hoyte.

Package

golden-utils

Source

list.lisp (file)

Function: zip &rest LISTS

Zip the given ‘LISTS‘.

Package

golden-utils

Source

list.lisp (file)

5.1.3 Types

Type: alist ()

Package

golden-utils

Source

list-alist.lisp (file)

Type: b16 ()

Package

golden-utils

Source

type.lisp (file)

Type: b16-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: b24 ()

Package

golden-utils

Source

type.lisp (file)

Type: b24-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: b32 ()

Package

golden-utils

Source

type.lisp (file)

Type: b32-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: b64 ()

Package

golden-utils

Source

type.lisp (file)

Type: b64-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: b8 ()

Package

golden-utils

Source

type.lisp (file)

Type: b8-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: fn-> ARGS VALUES

Package

golden-utils

Source

type.lisp (file)

Type: octet ()

Package

golden-utils

Source

type.lisp (file)

Type: plist ()

Package

golden-utils

Source

list-plist.lisp (file)

Type: ub16 ()

Package

golden-utils

Source

type.lisp (file)

Type: ub16-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: ub24 ()

Package

golden-utils

Source

type.lisp (file)

Type: ub24-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: ub32 ()

Package

golden-utils

Source

type.lisp (file)

Type: ub32-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: ub64 ()

Package

golden-utils

Source

type.lisp (file)

Type: ub64-array SIZE

Package

golden-utils

Source

type.lisp (file)

Type: ub8 ()

Package

golden-utils

Source

type.lisp (file)

Type: ub8-array SIZE

Package

golden-utils

Source

type.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: pget BOX SYMBOL

Package

golden-utils

Source

closure.lisp (file)

Setf Expander

(setf pget) (setf expander)

Setf Expander: (setf pget) BOX SYMBOL

Package

golden-utils

Source

closure.lisp (file)

Reader

pget (function)

Function: plet/get ARGS

Package

golden-utils

Source

closure.lisp (file)

Function: plet/set ARGS

Package

golden-utils

Source

closure.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types