The ahungry-fleece Reference Manual

4.1.1 ahungry-fleece/ahungry-fleece.asd

Source

ahungry-fleece.asd.

Parent Component

ahungry-fleece (system).

ASDF Systems

ahungry-fleece.

Packages

ahungry-fleece-asd.

---

4.1.2 ahungry-fleece/af.contrib.compiler/package.lisp

Source

ahungry-fleece.asd.

Parent Component

af.contrib.compiler (module).

Packages

af.contrib.sb-rotate-byte.

---

4.1.3 ahungry-fleece/af.contrib.compiler/compiler.lisp

Dependency

package.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

af.contrib.compiler (module).

Internals

%rotate-byte-derive-type-optimizer (function).

---

4.1.4 ahungry-fleece/af.contrib.vm/arm-vm.lisp

If Feature

:arm

Source

ahungry-fleece.asd.

Parent Component

af.contrib.vm (module).

---

4.1.5 ahungry-fleece/af.contrib.vm/arm64-vm.lisp

If Feature

:arm64

Source

ahungry-fleece.asd.

Parent Component

af.contrib.vm (module).

---

4.1.6 ahungry-fleece/af.contrib.vm/x86-vm.lisp

If Feature

:x86

Source

ahungry-fleece.asd.

Parent Component

af.contrib.vm (module).

---

4.1.7 ahungry-fleece/af.contrib.vm/x86-64-vm.lisp

If Feature

:x86-64

Source

ahungry-fleece.asd.

Parent Component

af.contrib.vm (module).

---

4.1.8 ahungry-fleece/af.contrib.vm/ppc-vm.lisp

If Feature

:ppc

Source

ahungry-fleece.asd.

Parent Component

af.contrib.vm (module).

---

4.1.9 ahungry-fleece/af.contrib.sb-rotate-byte/rotate-byte.lisp

Source

ahungry-fleece.asd.

Parent Component

af.contrib.sb-rotate-byte (module).

Public Interface

rotate-byte (function).

Internals

• %rotate-byte (function).
• %unsigned-32-rotate-byte (function).
• %unsigned-64-rotate-byte (function).

---

4.1.10 ahungry-fleece/af.contrib.sb-md5/md5.lisp

Source

ahungry-fleece.asd.

Parent Component

af.contrib.sb-md5 (module).

Packages

af.contrib.sb-md5.

Public Interface

• fill-block (function).
• fill-block-char (function).
• fill-block-ub8 (function).
• finalize-md5-state (function).
• initial-md5-regs (function).
• make-md5-state (function).
• md5-regs (type).
• md5-state (structure).
• md5-state-p (function).
• md5regs-digest (function).
• md5sum-file (function).
• md5sum-sequence (function).
• md5sum-stream (function).
• md5sum-string (function).
• update-md5-block (function).
• update-md5-state (function).

Internals

• *t* (special variable).
• +buffer-size+ (constant).
• +md5-magic-a+ (constant).
• +md5-magic-b+ (constant).
• +md5-magic-c+ (constant).
• +md5-magic-d+ (constant).
• assemble-ub32 (macro).
• buffer-index (type).
• copy-md5-state (function).
• copy-to-buffer (function).
• f (function).
• g (function).
• h (function).
• i (function).
• md5-regs-a (macro).
• md5-regs-b (macro).
• md5-regs-c (macro).
• md5-regs-d (macro).
• md5-state-amount (reader).
• (setf md5-state-amount) (writer).
• md5-state-block (reader).
• md5-state-buffer (reader).
• md5-state-buffer-index (reader).
• (setf md5-state-buffer-index) (writer).
• md5-state-finalized-p (reader).
• (setf md5-state-finalized-p) (writer).
• md5-state-regs (reader).
• mod32+ (compiler macro).
• mod32+ (function).
• rol32 (function).
• ub32 (type).
• with-md5-round (macro).

---

4.1.11 ahungry-fleece/af.contrib.sb-cover/cover.lisp

Source

ahungry-fleece.asd.

Parent Component

af.contrib.sb-cover (module).

Packages

af.contrib.sb-cover.

Public Interface

• clear-coverage (function).
• get-coverage (function).
• report (function).
• reset-coverage (function).
• restore-coverage (function).
• restore-coverage-from-file (function).
• save-coverage (function).
• save-coverage-in-file (function).

Internals

• %find-coverage-map (function).
• *counts* (special variable).
• *current-package* (special variable).
• *source-path-mode* (special variable).
• all-of (reader method).
• (setf all-of) (writer method).
• check-source-path (function).
• code-coverage-hashtable (macro).
• code-coverage-marks (function).
• convert-records (function).
• detabify (function).
• extract-package (function).
• fill-with-state (function).
• look-for-in-package-form (function).
• look-for-in-package-form-in-stream (function).
• make-recording-read-list (function).
• make-source-recorder (function).
• make-source-recording-readtable (function).
• mode-of (reader method).
• (setf mode-of) (writer method).
• ok-of (reader method).
• (setf ok-of) (writer method).
• pathname-as-directory (function).
• percent (function).
• print-report (function).
• read-and-record-source-map (function).
• read-file (function).
• read-source-form (function).
• refresh-coverage-info (function).
• report-file (function).
• sample-count (class).
• source-path-file-position (function).
• source-path-source-position (function).
• source-path-stream-position (function).
• source-path-string-position (function).
• starts-with-p (function).
• suppress-sharp-dot (function).
• write-styles (function).

---

4.1.12 ahungry-fleece/libs/af.lib.coverage.lisp

Dependencies

• af.lib.hashy.lisp (file).
• af.lib.ansi-colors.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.coverage.

Public Interface

• report-cli (function).
• report-json (function).
• with-coverage (macro).

Internals

code-coverage-hashtable (macro).

---

4.1.13 ahungry-fleece/libs/af.lib.hashy.lisp

Dependencies

• af.lib.loggy.lisp (file).
• af.lib.io.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.hashy.

Public Interface

• alist-to-hash (function).
• dotp (function).
• dump (function).
• hash-from-json-file (function).
• hash-from-json-string (function).
• hash-from-yaml-file (function).
• hash-from-yaml-string (function).
• ref (function).
• stringify (function).
• with-hashy (macro).

---

4.1.14 ahungry-fleece/libs/af.lib.testy.lisp

Dependencies

• af.lib.ansi-colors.lisp (file).
• af.lib.coverage.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.testy.

Public Interface

• desc (macro).
• it (function).
• suite (macro).

Internals

test-wrapper (macro).

---

4.1.15 ahungry-fleece/libs/af.lib.loggy.lisp

Dependency

af.lib.io.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.loggy.

Public Interface

• *loggy* (special variable).
• flog (function).
• level (reader method).
• (setf level) (writer method).
• log-> (generic function).
• loggy (class).
• output (reader method).
• (setf output) (writer method).
• output-args (reader method).
• (setf output-args) (writer method).
• output-stream (reader method).
• (setf output-stream) (writer method).

Internals

get-level (function).

---

4.1.16 ahungry-fleece/libs/af.lib.ansi-colors.lisp

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.ansi-colors.

Public Interface

• *colorize-p* (special variable).
• colorize (function).
• with-color (macro).

Internals

*colors* (special variable).

---

4.1.17 ahungry-fleece/libs/af.lib.clone.lisp

Dependency

af.lib.io.lisp (file).

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.clone.

Public Interface

• clone-project (function).
• rename-path (function).

---

4.1.18 ahungry-fleece/libs/af.lib.io.lisp

Source

ahungry-fleece.asd.

Parent Component

libs (module).

Packages

af.lib.io.

Public Interface

• directory-p (function).
• directory-structure (function).
• directory-tree (function).
• file-get-binary-contents (function).
• file-get-contents (function).
• file-p (function).
• file-put-binary-contents (function).
• file-put-contents (function).
• file-replace-strings (function).
• find-file (function).
• find-file-matches (function).
• pathname-to-string (function).

Internals

• directory-structure-helper (function).
• extract-tarball (function).

---

4.1.19 ahungry-fleece/ahungry-fleece/ahungry-fleece.lisp

Source

ahungry-fleece.asd.

Parent Component

ahungry-fleece (module).

Packages

ahungry-fleece.

Public Interface

• main (function).
• make-skelly-project (function).
• print-usage (function).

Internals

*base-directory* (special variable).

---

4.1.20 ahungry-fleece/t/af.run.tests.lisp

Source

ahungry-fleece.asd.

Parent Component

t (module).

Packages

af.run.tests.

Public Interface

• coverage (function).
• main (function).

Internals

• *base-directory* (special variable).
• *yml* (special variable).
• test (function).

---

6.1.1 Special variables

Special Variable: *colorize-p* ¶

Package

af.lib.ansi-colors.

Source

af.lib.ansi-colors.lisp.

Special Variable: *loggy* ¶

Package

af.lib.loggy.

Source

af.lib.loggy.lisp.

---

6.1.2 Macros

Macro: desc (desc &rest results) ¶

Describe a set of test.

Package

af.lib.testy.

Source

af.lib.testy.lisp.

Macro: suite (desc &rest results) ¶

Describe a suite of tests.

Package

af.lib.testy.

Source

af.lib.testy.lisp.

Macro: with-color (color &rest body) ¶

Activate COLOR and execute BODY (while reseting back to base color).

Package

af.lib.ansi-colors.

Source

af.lib.ansi-colors.lisp.

Macro: with-coverage (package &rest body) ¶

Run BODY with coverage enabled.

Package

af.lib.coverage.

Source

af.lib.coverage.lisp.

Macro: with-hashy ((hashy-sym target &key type) &body body) ¶

Create and bind to HASHY object (hash-table) from the TARGET.

- If TARGET is a pathname, will read in the file and decode.
- If TARGET is a string, will decode the contents.
- todo: If TARGET is a URI, will retrieve remote contents and decode.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

---

6.1.3 Ordinary functions

Function: alist-to-hash (alist) ¶

Convert ALIST into a nested hash.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: clear-coverage () ¶

Clear all files from the coverage database. The files will be re-entered into the database when the FASL files (produced by compiling STORE-COVERAGE-DATA optimization policy set to 3) are loaded again into the image.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: clone-project (from-path to-path from-name to-name) ¶

Recursively copy FROM-PATH to TO-PATH, while replacing all occurences of FROM-NAME to TO-NAME.

Package

af.lib.clone.

Source

af.lib.clone.lisp.

Function: colorize (color) ¶

Set the active color of the terminal.

Package

af.lib.ansi-colors.

Source

af.lib.ansi-colors.lisp.

Function: coverage () ¶

Begin the tests!

Package

af.run.tests.

Source

af.run.tests.lisp.

Function: directory-p (path) ¶

Check if PATH is a directory (a directory will have the trailing slash).

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: directory-structure (directory) ¶

Directory structure (including the root dir).

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: directory-tree (directory) ¶

Recursively get all files in a DIRECTORY.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: dotp (pair) ¶

T if PAIR is a dotted pair and not a list.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: dump (object) ¶

Return the object as json.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: file-get-binary-contents (filename) ¶

Read in FILENAME and return as a byte list.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: file-get-contents (filename) ¶

Read in FILENAME and return as a single string.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: file-p (path) ¶

Check if PATH is a file (a directory will have the trailing slash).

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: file-put-binary-contents (filename content &key overwrite) ¶

Write to FILENAME the CONTENT bytes sent in.

If the file exists, will append to the file.

If the file does not exist, will create it.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: file-put-contents (filename content &key overwrite) ¶

Write to FILENAME the CONTENT string sent in.

If the file exists, will append to the file.

If the file does not exist, will create it.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: file-replace-strings (file-name regex-list) ¶

Iterate across REGEX-LIST, which should be an alist, replacing each occurence of car with cdr.

For instance, calling as such:

(file-replace-strings ’(("dog" . "cat") ("rules" . "rocks")))

to change a file containing text such as:

"The dog rules" to "The cat rocks"

This will replace the content inline.

Note that the car is a cl-ppcre compatible regex expression, and the cdr is a cl-ppcre compatible replacement string.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: fill-block (block buffer offset) ¶

Convert a complete 64 byte input vector segment into the given 16 word MD5 block. This currently works on (unsigned-byte 8) and character simple-arrays, via the functions ‘fill-block-ub8’ and ‘fill-block-char’ respectively.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: fill-block-char (block buffer offset) ¶

Convert a complete 64 character input string segment starting from offset into the given 16 word MD5 block.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: fill-block-ub8 (block buffer offset) ¶

Convert a complete 64 (unsigned-byte 8) input vector segment starting from offset into the given 16 word MD5 block.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: finalize-md5-state (state) ¶

If the given md5-state has not already been finalized, finalize it, by processing any remaining input in its buffer, with suitable padding and appended bit-length, as specified by the MD5 standard.

The resulting MD5 message-digest is returned as an array of sixteen (unsigned-byte 8) values. Calling ‘update-md5-state’ after a call to ‘finalize-md5-state’ results in unspecified behaviour.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: find-file (path file-name) ¶

Get all files matching a portion of FILE-NAME. @todo use threading here

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: find-file-matches (path text &optional file-name) ¶

Recursively find all files in PATH with FILE-NAME matches that contain TEXT.

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: flog (level &rest message) ¶

Log to the singleton.

Package

af.lib.loggy.

Source

af.lib.loggy.lisp.

Function: get-coverage (code) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: hash-from-json-file (filename) ¶

Read in FILENAME and create a hash.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: hash-from-json-string (json-string) ¶

Create a hash from the JSON-STRING.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: hash-from-yaml-file (filename) ¶

Read in FILENAME and create a hash.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: hash-from-yaml-string (yaml-string) ¶

Read in YAML-STRING and create a hash.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: initial-md5-regs () ¶

Create the initial working state of an MD5 run.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: it (desc result) ¶

Assert the body evaluates as expected.

Package

af.lib.testy.

Source

af.lib.testy.lisp.

Function: main (&rest argv) ¶

Package

ahungry-fleece.

Source

ahungry-fleece.lisp.

Function: main () ¶

Run the tests, or the tests with coverage.

Package

af.run.tests.

Source

af.run.tests.lisp.

Function: make-md5-state () ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: make-skelly-project (directory) ¶

Create a new project in DIREcTORY with name equal to the directory.

Similar to quickproject:make-project, but also ensures the created files closely match what is available in this own project’s directory structure setup (with CLI based unit test etc.).

Package

ahungry-fleece.

Source

ahungry-fleece.lisp.

Function: md5-state-p (object) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: md5regs-digest (regs) ¶

Create the final 16 byte message-digest from the MD5 working state in regs. Returns a (simple-array (unsigned-byte 8) (16)).

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: md5sum-file (pathname) ¶

Calculate the MD5 message-digest of the file designated by pathname.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: md5sum-sequence (sequence &key start end) ¶

Calculate the MD5 message-digest of data bounded by START and END in SEQUENCE , which must be a vector with element-type (UNSIGNED-BYTE 8).

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: md5sum-stream (stream) ¶

Calculate an MD5 message-digest of the contents of STREAM, whose element-type has to be (UNSIGNED-BYTE 8).

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: md5sum-string (string &key external-format start end) ¶

Calculate the MD5 message-digest of the binary representation of STRING (as octets) in EXTERNAL-FORMAT. The boundaries START and END refer to character positions in the string, not to octets in the resulting binary representation.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: pathname-to-string (pathname) ¶

Change PATHNAME into a string. @todo Add test

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: print-usage () ¶

Package

ahungry-fleece.

Source

ahungry-fleece.lisp.

Function: ref (path object &optional value split-char) ¶

Query a reference to a json or yaml object.

PATH is a path such as #/key/anotherKey/anotherKey/node.

OBJECT is a hash table (optionally made up of nested ones or lists).

VALUE is an optional value to change the node to.

For example, calling on a JSON object like:

{"definitions": {"Pet": {"name": "Fido"}}}

or YML object like:

definitions:
Pet:
name: Fido

as such:

(ref "#/definitions/Pet/name" obj)

Will return the setf’able value "Fido".

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: rename-path (from-path to-path file-name from-name to-name) ¶

Rename a file in a path, as such:

Given a FILE-NAME /one/two/sub/three with a FROM-PATH of /one/two and a TO-PATH of /uno/dos/sub/, with a FROM-NAME three and TO-NAME tres, produce a path of /uno/dos/sub/tres.

@todo Add test

Package

af.lib.clone.

Source

af.lib.clone.lisp.

Function: report (directory &key form-mode if-matches external-format) ¶

Print a code coverage report of all instrumented files into DIRECTORY. If DIRECTORY does not exist, it will be created. The main report will be printed to the file cover-index.html. The external format of the source files can be specified with the EXTERNAL-FORMAT parameter.

If the keyword argument FORM-MODE has the value :CAR, the annotations in the coverage report will be placed on the CARs of any cons-forms, while if it has the value :WHOLE the whole form will be annotated (the default). The former mode shows explicitly which forms were instrumented, while the latter mode is generally easier to read.

The keyword argument IF-MATCHES should be a designator for a function of one argument, called for the namestring of each file with code coverage info. If it returns true, the file’s info is included in the report, otherwise ignored. The default value is CL:IDENTITY.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: report-cli (directory) ¶

Print a code coverage report of all instrumented files into DIRECTORY. If DIRECTORY does not exist, it will be created. The main report will be printed to the file cover-index.html. The external format of the source files can be specified with the EXTERNAL-FORMAT parameter.

If the keyword argument FORM-MODE has the value :CAR, the annotations in the coverage report will be placed on the CARs of any cons-forms, while if it has the value :WHOLE the whole form will be annotated (the default). The former mode shows explicitly which forms were instrumented, while the latter mode is generally easier to read.

Package

af.lib.coverage.

Source

af.lib.coverage.lisp.

Function: report-json (directory) ¶

Print a code coverage report of all instrumented files into DIRECTORY. If DIRECTORY does not exist, it will be created. The main report will be printed to the file cover-index.html. The external format of the source files can be specified with the EXTERNAL-FORMAT parameter.

If the keyword argument FORM-MODE has the value :CAR, the annotations in the coverage report will be placed on the CARs of any cons-forms, while if it has the value :WHOLE the whole form will be annotated (the default). The former mode shows explicitly which forms were instrumented, while the latter mode is generally easier to read.

Package

af.lib.coverage.

Source

af.lib.coverage.lisp.

Function: reset-coverage (&optional object) ¶

Reset all coverage data back to the ‘Not executed‘ state.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: restore-coverage (coverage-state) ¶

Restore the code coverage data back to an earlier state produced by SAVE-COVERAGE.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: restore-coverage-from-file (pathname) ¶

READ the contents of the file designated by PATHNAME and pass the result to RESTORE-COVERAGE.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: rotate-byte (count bytespec integer) ¶

Rotates a field of bits within INTEGER; specifically, returns an integer that contains the bits of INTEGER rotated COUNT times leftwards within the byte specified by BYTESPEC, and elsewhere contains the bits of INTEGER.

Package

af.contrib.sb-rotate-byte.

Source

rotate-byte.lisp.

Function: save-coverage () ¶

Returns an opaque representation of the current code coverage state.
The only operation that may be done on the state is passing it to RESTORE-COVERAGE. The representation is guaranteed to be readably printable. A representation that has been printed and read back will work identically in RESTORE-COVERAGE.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: save-coverage-in-file (pathname) ¶

Call SAVE-COVERAGE and write the results of that operation into the file designated by PATHNAME.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: stringify (symbol) ¶

Convert a cl-json symbol back into original representation.

Package

af.lib.hashy.

Source

af.lib.hashy.lisp.

Function: update-md5-block (regs block) ¶

This is the core part of the MD5 algorithm. It takes a complete 16 word block of input, and updates the working state in A, B, C, and D accordingly.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: update-md5-state (state sequence &key start end) ¶

Update the given md5-state from sequence, which is either a simple-string or a simple-array with element-type (unsigned-byte 8), bounded by start and end, which must be numeric bounding-indices.

Package

af.contrib.sb-md5.

Source

md5.lisp.

---

6.1.4 Generic functions

Generic Reader: level (object) ¶

Package

af.lib.loggy.

Methods

Reader Method: level ((loggy loggy)) ¶

automatically generated reader method

Source

af.lib.loggy.lisp.

Target Slot

level.

Generic Writer: (setf level) (object) ¶

Package

af.lib.loggy.

Methods

Writer Method: (setf level) ((loggy loggy)) ¶

automatically generated writer method

Source

af.lib.loggy.lisp.

Target Slot

level.

Generic Function: log-> (object level &rest message) ¶

Write a log level message.

Package

af.lib.loggy.

Source

af.lib.loggy.lisp.

Methods

Method: log-> ((logger loggy) level &rest message) ¶

Produce a log level message.

Sample call:

(log-> *loggy* ’debug "Hello World")

Generic Reader: output (object) ¶

Package

af.lib.loggy.

Methods

Reader Method: output ((loggy loggy)) ¶

automatically generated reader method

Source

af.lib.loggy.lisp.

Target Slot

output.

Generic Writer: (setf output) (object) ¶

Package

af.lib.loggy.

Methods

Writer Method: (setf output) ((loggy loggy)) ¶

automatically generated writer method

Source

af.lib.loggy.lisp.

Target Slot

output.

Generic Reader: output-args (object) ¶

Package

af.lib.loggy.

Methods

Reader Method: output-args ((loggy loggy)) ¶

automatically generated reader method

Source

af.lib.loggy.lisp.

Target Slot

output-args.

Generic Writer: (setf output-args) (object) ¶

Package

af.lib.loggy.

Methods

Writer Method: (setf output-args) ((loggy loggy)) ¶

automatically generated writer method

Source

af.lib.loggy.lisp.

Target Slot

output-args.

Generic Reader: output-stream (object) ¶

Package

af.lib.loggy.

Methods

Reader Method: output-stream ((loggy loggy)) ¶

automatically generated reader method

Source

af.lib.loggy.lisp.

Target Slot

output-stream.

Generic Writer: (setf output-stream) (object) ¶

Package

af.lib.loggy.

Methods

Writer Method: (setf output-stream) ((loggy loggy)) ¶

automatically generated writer method

Source

af.lib.loggy.lisp.

Target Slot

output-stream.

---

6.1.5 Structures

Structure: md5-state ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: regs ¶

Type

af.contrib.sb-md5:md5-regs

Initform

(af.contrib.sb-md5:initial-md5-regs)

Readers

md5-state-regs.

Writers

This slot is read-only.

Slot: amount ¶

Type

(integer 0 *)

Initform

0

Readers

md5-state-amount.

Writers

(setf md5-state-amount).

Slot: block ¶

Package

common-lisp.

Type

(simple-array (unsigned-byte 32) (16))

Initform

(make-array 16 :element-type (quote (unsigned-byte 32)))

Readers

md5-state-block.

Writers

This slot is read-only.

Slot: buffer ¶

Type

(simple-array (unsigned-byte 8) (64))

Initform

(make-array 64 :element-type (quote (unsigned-byte 8)))

Readers

md5-state-buffer.

Writers

This slot is read-only.

Slot: buffer-index ¶

Type

(integer 0 63)

Initform

0

Readers

md5-state-buffer-index.

Writers

(setf md5-state-buffer-index).

Slot: finalized-p ¶

Readers

md5-state-finalized-p.

Writers

(setf md5-state-finalized-p).

---

6.1.6 Classes

Class: loggy ¶

Package

af.lib.loggy.

Source

af.lib.loggy.lisp.

Direct methods

• (setf level).
• level.
• log->.
• (setf output).
• output.
• (setf output-args).
• output-args.
• (setf output-stream).
• output-stream.

Direct slots

Slot: level ¶

Initform

(quote debug)

Initargs

:level

Readers

level.

Writers

(setf level).

Slot: output ¶

Initform

(quote format)

Initargs

:output

Readers

output.

Writers

(setf output).

Slot: output-args ¶

Initform

(quote ("~a~%"))

Initargs

:output-args

Readers

output-args.

Writers

(setf output-args).

Slot: output-stream ¶

Initform

t

Initargs

:output-stream

Readers

output-stream.

Writers

(setf output-stream).

---

6.1.7 Types

Type: md5-regs () ¶

The working state of the MD5 algorithm, which contains the 4 32-bit registers A, B, C and D.

Package

af.contrib.sb-md5.

Source

md5.lisp.

---

6.2.1 Constants

Constant: +buffer-size+ ¶

Size of internal buffer to use for md5sum-stream and md5sum-file operations. This should be a multiple of 64, the MD5 block size.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Constant: +md5-magic-a+ ¶

Initial value of Register A of the MD5 working state.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Constant: +md5-magic-b+ ¶

Initial value of Register B of the MD5 working state.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Constant: +md5-magic-c+ ¶

Initial value of Register C of the MD5 working state.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Constant: +md5-magic-d+ ¶

Initial value of Register D of the MD5 working state.

Package

af.contrib.sb-md5.

Source

md5.lisp.

---

6.2.2 Special variables

Special Variable: *base-directory* ¶

Package

ahungry-fleece.

Source

ahungry-fleece.lisp.

Special Variable: *base-directory* ¶

Package

af.run.tests.

Source

af.run.tests.lisp.

Special Variable: *colors* ¶

Package

af.lib.ansi-colors.

Source

af.lib.ansi-colors.lisp.

Special Variable: *counts* ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Special Variable: *current-package* ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Special Variable: *source-path-mode* ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Special Variable: *t* ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Special Variable: *yml* ¶

The yml file for testing.

Package

af.run.tests.

Source

af.run.tests.lisp.

---

6.2.3 Macros

Macro: assemble-ub32 (a b c d) ¶

Assemble an ub32 value from the given (unsigned-byte 8) values, where a is the intended low-order byte and d the high-order byte.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Macro: code-coverage-hashtable () ¶

Package

af.lib.coverage.

Source

af.lib.coverage.lisp.

Macro: code-coverage-hashtable () ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Macro: md5-regs-a (regs) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Macro: md5-regs-b (regs) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Macro: md5-regs-c (regs) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Macro: md5-regs-d (regs) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Macro: test-wrapper (format-title format-summary desc &rest results) ¶

Describe a suite of tests.

Package

af.lib.testy.

Source

af.lib.testy.lisp.

Macro: with-md5-round ((op block) &rest clauses) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

---

6.2.4 Compiler macros

Compiler Macro: mod32+ (a b) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

---

6.2.5 Ordinary functions

Function: %find-coverage-map (code) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: %rotate-byte (count size pos integer) ¶

Package

af.contrib.sb-rotate-byte.

Source

rotate-byte.lisp.

Function: %rotate-byte-derive-type-optimizer (g0 &rest g3) ¶

Package

af.contrib.sb-rotate-byte.

Source

compiler.lisp.

Function: %unsigned-32-rotate-byte (count integer) ¶

Package

af.contrib.sb-rotate-byte.

Source

rotate-byte.lisp.

Function: %unsigned-64-rotate-byte (count integer) ¶

Package

af.contrib.sb-rotate-byte.

Source

rotate-byte.lisp.

Function: check-source-path (path) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: code-coverage-marks (code) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: convert-records (records mode) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: copy-md5-state (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: copy-to-buffer (from from-offset count buffer buffer-offset) ¶

Copy a partial segment from input vector from starting at from-offset and copying count elements into the 64 byte buffer starting at buffer-offset.

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: detabify (source) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: directory-structure-helper (directory) ¶

List the directories (recursively).

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: extract-package (line) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: extract-tarball (pathname) ¶

Extract a tarball (.tar.gz) file to a directory (*default-pathname-defaults*).

TODO: Put in fleece

Package

af.lib.io.

Source

af.lib.io.lisp.

Function: f (x y z) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: fill-with-state (source states state start end) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: g (x y z) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: get-level (level) ¶

Get a numeric level from LEVEL.

Package

af.lib.loggy.

Source

af.lib.loggy.lisp.

Function: h (x y z) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: i (x y z) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: look-for-in-package-form (string) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: look-for-in-package-form-in-stream (stream start-position end-position) ¶

Scans the stream between start-position up to end-position for something that looks like an in-package form. If it does find something, the function updates *current-package*. In all cases, the stream is reset to end-position on exit.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: make-recording-read-list (source-map) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: make-source-recorder (fn source-map) ¶

Return a macro character function that does the same as FN, but additionally stores the result together with the stream positions before and after of calling FN in the hashtable SOURCE-MAP.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: make-source-recording-readtable (readtable source-map) ¶

Return a source position recording copy of READTABLE. The source locations are stored in SOURCE-MAP.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Reader: md5-state-amount (instance) ¶

Writer: (setf md5-state-amount) (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

amount.

Reader: md5-state-block (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

block.

Reader: md5-state-buffer (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

buffer.

Reader: md5-state-buffer-index (instance) ¶

Writer: (setf md5-state-buffer-index) (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

buffer-index.

Reader: md5-state-finalized-p (instance) ¶

Writer: (setf md5-state-finalized-p) (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

finalized-p.

Reader: md5-state-regs (instance) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Target Slot

regs.

Function: mod32+ (a b) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: pathname-as-directory (pathname &optional errorp) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: percent (count) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: print-report (html-stream file counts states source) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: read-and-record-source-map (stream) ¶

Read the next object from STREAM.
Return the object together with a hashtable that maps subexpressions of the object to stream positions.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: read-file (filename external-format) ¶

Return the entire contents of FILENAME as a string.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: read-source-form (n stream) ¶

Read the Nth toplevel form number with source location recording. Return the form and the source-map.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: refresh-coverage-info (&optional filename) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: report-file (file html-stream external-format) ¶

Print a code coverage report of FILE into the stream HTML-STREAM.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: rol32 (a s) ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Function: source-path-file-position (path filename) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: source-path-source-position (path form source-map) ¶

Return the start position of PATH from FORM and SOURCE-MAP. All subforms along the path are considered and the start and end position of the deepest (i.e. smallest) possible form is returned.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: source-path-stream-position (path stream) ¶

Search the source-path PATH in STREAM and return its position.

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: source-path-string-position (path string) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: starts-with-p (string prefix) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: suppress-sharp-dot (readtable) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Function: test () ¶

Begin the tests!

Package

af.run.tests.

Source

af.run.tests.lisp.

Function: write-styles (html-stream) ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

---

6.2.6 Generic functions

Generic Reader: all-of (object) ¶

Package

af.contrib.sb-cover.

Methods

Reader Method: all-of ((sample-count sample-count)) ¶

automatically generated reader method

Source

cover.lisp.

Target Slot

all.

Generic Writer: (setf all-of) (object) ¶

Package

af.contrib.sb-cover.

Methods

Writer Method: (setf all-of) ((sample-count sample-count)) ¶

automatically generated writer method

Source

cover.lisp.

Target Slot

all.

Generic Reader: mode-of (object) ¶

Package

af.contrib.sb-cover.

Methods

Reader Method: mode-of ((sample-count sample-count)) ¶

automatically generated reader method

Source

cover.lisp.

Target Slot

mode.

Generic Writer: (setf mode-of) (object) ¶

Package

af.contrib.sb-cover.

Methods

Writer Method: (setf mode-of) ((sample-count sample-count)) ¶

automatically generated writer method

Source

cover.lisp.

Target Slot

mode.

Generic Reader: ok-of (object) ¶

Package

af.contrib.sb-cover.

Methods

Reader Method: ok-of ((sample-count sample-count)) ¶

automatically generated reader method

Source

cover.lisp.

Target Slot

ok.

Generic Writer: (setf ok-of) (object) ¶

Package

af.contrib.sb-cover.

Methods

Writer Method: (setf ok-of) ((sample-count sample-count)) ¶

automatically generated writer method

Source

cover.lisp.

Target Slot

ok.

---

6.2.7 Classes

Class: sample-count ¶

Package

af.contrib.sb-cover.

Source

cover.lisp.

Direct methods

• (setf all-of).
• all-of.
• (setf mode-of).
• mode-of.
• (setf ok-of).
• ok-of.

Direct slots

Slot: mode ¶

Initargs

:mode

Readers

mode-of.

Writers

(setf mode-of).

Slot: all ¶

Initform

0

Readers

all-of.

Writers

(setf all-of).

Slot: ok ¶

Initform

0

Readers

ok-of.

Writers

(setf ok-of).

---

6.2.8 Types

Type: buffer-index () ¶

Package

af.contrib.sb-md5.

Source

md5.lisp.

Type: ub32 () ¶

Corresponds to the 32bit quantity word of the MD5 Spec

Package

af.contrib.sb-md5.

Source

md5.lisp.

---