This is the phoe-toolbox Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:33:45 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
phoe-toolboxA personal utility library
Michał "phoe" Herda <phoe@teknik.io>
BSD 2-clause
alexandria (system).
trivial-indent (system).
closer-mop (system).
package.lisp (file).
phoe-toolbox.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
phoe-toolbox/phoe-toolbox.lisppackage.lisp (file).
phoe-toolbox (system).
*whitespace* (special variable).
+universal-unix-time-difference+ (constant).
alternatingly (function).
assoc-value-or-die (function).
bound-slot-names (function).
call-with-handler (function).
call-with-restart (function).
cat (function).
catn (function).
check-slot-boundp (macro).
circular-graph-p (function).
constantly* (function).
count-digits (function).
define-constructor (macro).
define-print (macro).
define-readable-print (macro).
downcase-lisp-file (function).
dsubseq (function).
fbind (macro).
fformat (function).
finalized-let* (macro).
get-unix-time (function).
gethash-or-die (function).
graph-roots (function).
handler-case* (macro).
hexadecimal-string-p (function).
identity* (function).
list-of (type).
make-dumped-stream (function).
mod-decf (macro).
mod-incf (macro).
multiple-value-mapcar (function).
notf (macro).
nth-funcall (function).
peek-char-no-hang (function).
print-hash-table-readably (function).
print-instance-readably (generic function).
rassoc-value-or-die (function).
read-data-file (function).
replace-all (function).
robust-subseq (function).
shallow-copy-object (function).
signals* (macro).
sleepcar (function).
split (function).
string=-getf (function).
trim-whitespace (function).
unintern-all-symbols (function).
unix-time-to-datestring (function).
upcase-lisp-file (function).
url-filename (function).
urls-pathnames (function).
vector-times (function).
wait (macro).
wait-until (macro).
whitespacep (function).
with-input-from-binary (macro).
with-output-to-binary (macro).
with-temp-package (macro).
zip (function).
*call-with-handler-cache* (special variable).
*call-with-restart-cache* (special variable).
case-lisp-file (function).
ensure-call-with-handler-function (function).
ensure-call-with-restart-function (function).
make-handler-case*-with-no-error-case (function).
make-handler-case*-without-no-error-case (function).
Packages are listed by definition order.
phoe-toolboxalexandria.
common-lisp.
*whitespace* (special variable).
+universal-unix-time-difference+ (constant).
alternatingly (function).
assoc-value-or-die (function).
bound-slot-names (function).
call-with-handler (function).
call-with-restart (function).
cat (function).
catn (function).
check-slot-boundp (macro).
circular-graph-p (function).
constantly* (function).
count-digits (function).
define-constructor (macro).
define-print (macro).
define-readable-print (macro).
downcase-lisp-file (function).
dsubseq (function).
fbind (macro).
fformat (function).
finalized-let* (macro).
get-unix-time (function).
gethash-or-die (function).
graph-roots (function).
handler-case* (macro).
hexadecimal-string-p (function).
identity* (function).
list-of (type).
make-dumped-stream (function).
mod-decf (macro).
mod-incf (macro).
multiple-value-mapcar (function).
notf (macro).
nth-funcall (function).
peek-char-no-hang (function).
print-hash-table-readably (function).
print-instance-readably (generic function).
rassoc-value-or-die (function).
read-data-file (function).
replace-all (function).
robust-subseq (function).
shallow-copy-object (function).
signals* (macro).
sleepcar (function).
split (function).
string=-getf (function).
trim-whitespace (function).
unintern-all-symbols (function).
unix-time-to-datestring (function).
upcase-lisp-file (function).
url-filename (function).
urls-pathnames (function).
vector-times (function).
wait (macro).
wait-until (macro).
whitespacep (function).
with-input-from-binary (macro).
with-output-to-binary (macro).
with-temp-package (macro).
zip (function).
*call-with-handler-cache* (special variable).
*call-with-restart-cache* (special variable).
case-lisp-file (function).
ensure-call-with-handler-function (function).
ensure-call-with-restart-function (function).
make-handler-case*-with-no-error-case (function).
make-handler-case*-without-no-error-case (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The difference between universal time and Unix time in seconds.
Standard whitespace characters.
Asserts that the provided slot is bound.
Defines an INITIALIZE-INSTANCE :AFTER method on the given object.
Defines a PRINT-OBJECT method on the given object with inserting BODY inside PRINT-UNREADABLE-OBJECT.
Defines a PRINT-OBJECT method on the given object, which depends on the value of *PRINT-READABLY*. If it is true, then the object is printed using PRINT-INSTANCE-READABLY; else, it is printed with inserting BODY inside PRINT-UNREADABLE-OBJECT.
Binds the function objects in the function namespace.
Like LET*, except each variable binding is of form (var initform . forms) where FORMS will be evaluated when leaving the LET* by means of UNWIND-PROTECT. These forms will be evaluated from last binding to first. Each binding has its own individual UNWIND-PROTECT cleanup.
A variant of HANDLER-CASE, in which the case forms are evaluating before performing a transfer of control. This ensures that the case forms are evaluated in the dynamic scope of the signaling form.
Like DECF, except the final value set in PLACE is always a modulus modulo DIVISOR.
Like INCF, except the final value set in PLACE is always a modulus modulo DIVISOR.
Sets the value of PLACE to its logical negation and returns the new value.
Testing macro analogous to 1AM:SIGNALS, except it does not perform a non-local transfer of control and therefore is not suitable for any code that makes calls to INVOKE-DEBUGGER. Instead, it allows the caller to assert that a condition of type CONDITION-TYPE was signaled exactly N times.
Evaluates BODY each STEP seconds until it evaluates to true, at which point it returns the value of BODY, or until TIMEOUT seconds pass, at which point it returns NIL.
Evaluates BODY each STEP seconds until it evaluates to true, at which point it returns the value of BODY.
Like WITH-OPEN-FILE, except with defaults suitable for reading from binary.
Like WITH-OPEN-FILE, except with defaults suitable for wriiting to binary.
Evaluates BODY with *PACKAGE* bound to a freshly created temporary package that will be deleted once control leaves the BODY, uninterning all symbols that were interned into it during that time.
Returns a function that acts like CL:CONSTANTLY, but its return value alternates between VALUE-WHEN-TRUE and VALUE-WHEN-FALSE (default NIL). INITIALLY-TRUE-P specifies whether VALUE-WHEN-TRUE is returned as the first value from the returned function.
Like ALEXANDRIA:ASSOC-VALUE, except it signals an error if the value is not found.
Given a generalized instance of STANDARD-OBJECT, returns a list of all slot names which are bound in that instance.
The functional variant of HANDLER-BIND.
The functional variant of RESTART-BIND.
Concatenates targets into a string.
Concatenates targets into a string, inserting a newline between each of them.
Accepts a list of directed edges (two-element lists of EQL-comparable nodes). If the graph does not contain a cycle, returns (VALUES NIL NIL). If the graph contains a cycle, returns (VALUES T VERTEX), where VERTEX is one of the vertices in the cycle.
Like CONSTANTLY, except the returned closure may return multiple values, denoted by ARGS.
Returns the number of digits in an integer, sans any sign.
Downcases a Common Lisp source file.
Like SUBSEQ, except the created array is an array displaced to SEQUENCE ~ and therefore shares structure with it.
Acts like FORMAT, except it calls FORCE-OUTPUT on STREAM afterwards.
Returns the current Unix timestamp.
Like GETHASH, except it signals an error if the value is not found.
Accepts a list of directed edges (two-element lists of EQL-comparable nodes). Returns a list of root vertices (vertices that are not pointed at).
Returns true if the string contains only digits 0-9 and lowercase/uppercase characters #A-#F, false otherwise.
Like CONSTANTLY, except the list of ARGS is returned instead.
Returns a wrapper stream around the original stream. All data read from the wrapper stream is additionally sent to DUMP-INPUT-STREAM. All data written to the wrapper stream is additionally sent to the DUMP-OUTPUT-STREAM.
Returns multiple lists of all multiple values returned by repeatedly applying FUNCTION to consecutive arguments from LISTS.
Funcall FUNCTION composed COUNT times with itself on ARGUMENT.
Like PEEK-CHAR, except it immediately returns NIL if no character is available for reading on the input stream.
Prints a hash table readably.
Deprecated: please use (PRINT-INSTANCE-READABLY HASH-TABLE &OPTIONAL STREAM) instead.
Like ALEXANDRIA:RASSOC-VALUE, except it signals an error if the value is not found.
Reads the data file from the provided pathname. The pathname should be a system relative pathname.
Returns a new string in which all the occurences of the part is replaced with replacement.
Like SUBSEQ, but handles out-of-range bounding index designators gracefully.
Creates a shallow copy of a standard object, copying the values of all slots, before calling REINITIALIZE-INSTANCE on it with the provided keyword-value pairs.
Collects the element of funcalling FUNCTION on successive elements of LIST, sleeping for SLEEP-INTERVAL seconds every N elements.
Separates the list into a sublist of elements for which the predicate returns true and a sublist of elements for which the predicate returns false. Returns them as two values.
Like GETF, except it tests with STRING= and is there suitable for use with strings and symbols.
Trims whitespace characters from both sides of a string.
Returns a copy of the provided tree, in which all symbols have been uninterned. The tree must not contain improper lists.
Decodes the unix time and returns its textual form in format "YYYY-MM-DD HH:MM:SS".
Upcases a Common Lisp source file.
Given a URL, returns everything after its last slash.
Provided a list of URLs and a valid directory pathname, returns a list of pathnames that end with the filenames suitable for downloaded files.
Returns a fresh vector which is VECTOR concatenated to itself N times.
Returns true if the provided character is whitespace.
Collects a list of lists, where the first list contains the first element of the argument lists, the second list - second, etc.. The lists are as long as the shortest list.
Prints an instance readably, using the #. notation.
The standard method is a hack. Its functioning depends on all direct slots of a
class being of form %FOO or FOO and having an initarg keyword called :FOO. All
values stored in these slots need to be printable readably. Moreover, indirect
slots are not restored. Before you use it, make sure you know what you are
doing.
The hash-table method uses ALEXANDRIA:ALIST-HASH-TABLE.
Programmers may define methods on this generic function in case the standard method is not enough to print the object they have.
A type specifier that matches a list whose all elements are of the given type.
| Jump to: | A B C D E F G H I M N P R S T U V W Z |
|---|
| Jump to: | A B C D E F G H I M N P R S T U V W Z |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | F L P S T |
|---|
| Jump to: | F L P S T |
|---|