The ahungry-fleece Reference Manual

Table of Contents

The ahungry-fleece Reference Manual

This is the ahungry-fleece Reference Manual, version 0.3.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:37:54 2020 GMT+0.

1 Introduction

Ahungry Fleece

A minimalist utility library for Common Lisp

In Greek mythology, the Golden Fleece (Greek: χρυσόμαλλον δέρας chrysómallon déras) is the fleece of the gold-hair winged ram, which was held in Colchis. The fleece is a symbol of authority and kingship. It figures in the tale of the hero Jason...

In my mythology, the Ahungry Fleece simplifies the programmer's job of rapid development in one of the greatest languages around (Lisp!)

TOC

• Setup
  • Install
• Usage
  • IO
  • JSON/YAML
  • Logging
  • Testing
  • Colorizing
  • Clone
• About
  • Maintainer
  • License

Setup

Installation

Quicklisp/REPL

Currently the library is not on quicklisp (yet), so you'll have to add to your local projects directory after cloning it, as such:

cd ~/some/path
git clone https://github.com/ahungry/ahungry-fleece

(push #P"~/some/path/ahungry-fleece" ql:*local-project-directories*)
(ql:quickload :ahungry-fleece)
;; Optionally confirm all is working by running the tests
(af.lib.test:main)

Roswell

Simply run:

ros install ahungry/ahungry-fleece

Then you can use it in your roswell image, or run the CLI scripts directly via:

~/.roswell/bin/ahungry-fleece -h

Usage

IO

You can easily write to and read from files with some of the following convenience functions.

(use-package :af.lib.io)
(file-put-contents "/tmp/helloWorld" "Hello World!")
(file-get-contents "/tmp/helloWorld")

Or get directory/file status with:

(directory-p "/dev") ;; t
(directory-p "/dev/null") ;; nil
(file-p "/dev") ;; nil
(file-p "/dev/null") ;; t

JSON/YAML

RefPath

There is a way to quickly select a node in some given YAML or JSON or HASH-TABLE.

When given some YAML such as this (for example):

definitions:
  Pet:
    type: object
    required:
    - name
    - petType

You can get the first element of the 'required' array as such (assume that YAML above is in a file named 'pets.yml'):

(use-package :af.lib.hashy)
(defparameter *yml* (hash-from-yaml-file "pets.yml"))
(ref "#/definitions/Pet/required/0" *yml*) ;; returns "name"

You can also set values by passing in the optional third parameter:

;; To set the value (changing 'object' to 'array')
(ref "#/definitions/Pet/type" *yml* "array")

The above would also work with json (just use the #'hash-from-json-file call instead).

Logging

There is also support for a small and easy to use logging interface.

To log using the *loggy* singleton instance of the Loggy class, you can simply:

(use-package :af.lib.loggy)

;; Will print only if log level is set to 'debug (default)
(flog 'debug "Hello world")

;; If you want to suppress those calls in the code on a prod instance
(setf (Level *loggy*) 'warn)

;; Will now no longer print at all (using a specific log call, but to
;; singleton again, so equivalent to the #'flog call):
(log-> *loggy* 'debug "Hello world")

You can customize the following properties in the Loggy class:

• Level (can use 'debug, 'warn, 'info, 'crit): controls when to invoke log output
• Output (default #'format): function called for outputting
• Output-Args (default '("~a~%")): Extra arguments passed to Output
• Output-Stream (default t): The stream target (primarily for format output)

Testing

A tiny BDD test framework exists, and can be used as such:

(use-package :af.lib.testy)
(suite "your.suite"
  (desc "your.suite.function"
    (it "Should add two numbers"
      (and
        (eq 4 (+ 2 2))
        (eq 8 (+ 6 2))))

    (it "Should fail here"
      (eq 10 (+ 2 2)))))

which will produce some output such as this when run:

your.suite

  your.suite.function

    + Should add two numbers
    - Should fail here

  2 assertions, 1 failures

1 tests, 1 failures

Colorizing

You can colorize shell output (via the shell escape codes) by using:

(use-package :af.lib.ansi-colors)
(with-color :blue (format t "Blue text!"))

To avoid colors in the SLIME REPL, simply set:

(setq af.lib.ansi-colors:*colorize-p* nil)

Clone

You can also quickly create/bootstrap a project with a similar directory / makefile setup as this one, by using:

(ahungry-fleece:make-skelly-project "/some/path/here")

About

Maintainer

You can reach me at Matthew Carter m@ahungry.com or file an issue here.

2 Systems

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

2.1 ahungry-fleece

Author

Matthew Carter <m@ahungry.com>

License

GPLv3

Description

A general utility library of convenience functions and features.

Version

0.3.0

Dependencies

• cl-json
• cl-yaml
• md5
• chipz
• archive
• split-sequence

Source

ahungry-fleece.asd (file)

Components

• af.contrib.compiler (module)
• af.contrib.vm (module)
• af.contrib.sb-rotate-byte (module)
• af.contrib.sb-md5 (module)
• af.contrib.sb-cover (module)
• libs (module)
• ahungry-fleece (module)
• t (module)

3 Modules

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

3.1 ahungry-fleece/af.contrib.compiler

Parent

ahungry-fleece (system)

Location

contrib/sb-rotate-byte/

Components

• package.lisp (file)
• compiler.lisp (file)

3.2 ahungry-fleece/af.contrib.vm

Dependencies

• af.contrib.compiler (module)
• af.contrib.compiler (module)

Parent

ahungry-fleece (system)

Location

contrib/sb-rotate-byte/

Components

• arm-vm.lisp (file)
• arm64-vm.lisp (file)
• x86-vm.lisp (file)
• x86-64-vm.lisp (file)
• ppc-vm.lisp (file)

3.3 ahungry-fleece/af.contrib.sb-rotate-byte

Dependencies

• af.contrib.vm (module)
• af.contrib.vm (module)

Parent

ahungry-fleece (system)

Location

contrib/sb-rotate-byte/

Component

rotate-byte.lisp (file)

3.4 ahungry-fleece/af.contrib.sb-md5

Dependencies

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

Parent

ahungry-fleece (system)

Location

contrib/sb-md5/

Component

md5.lisp (file)

3.5 ahungry-fleece/af.contrib.sb-cover

Dependencies

• af.contrib.sb-md5 (module)
• af.contrib.sb-md5 (module)

Parent

ahungry-fleece (system)

Location

contrib/sb-cover/

Component

cover.lisp (file)

3.6 ahungry-fleece/libs

Dependencies

• af.contrib.sb-cover (module)
• af.contrib.sb-cover (module)

Parent

ahungry-fleece (system)

Location

src/libs/

Components

• af.lib.coverage.lisp (file)
• af.lib.hashy.lisp (file)
• af.lib.testy.lisp (file)
• af.lib.loggy.lisp (file)
• af.lib.ansi-colors.lisp (file)
• af.lib.clone.lisp (file)
• af.lib.io.lisp (file)

3.7 ahungry-fleece/ahungry-fleece

Dependencies

• libs (module)
• libs (module)

Parent

ahungry-fleece (system)

Location

src/

Component

ahungry-fleece.lisp (file)

3.8 ahungry-fleece/t

Dependencies

• ahungry-fleece (module)
• libs (module)
• ahungry-fleece (module)

Parent

ahungry-fleece (system)

Location

t/

Component

af.run.tests.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 ahungry-fleece.asd

Location

ahungry-fleece.asd

Systems

ahungry-fleece (system)

Packages

ahungry-fleece-asd

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

Parent

af.contrib.compiler (module)

Location

contrib/sb-rotate-byte/package.lisp

Packages

af.contrib.sb-rotate-byte

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

Dependency

package.lisp (file)

Parent

af.contrib.compiler (module)

Location

contrib/sb-rotate-byte/compiler.lisp

Internal Definitions

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

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

If Feature

arm

Parent

af.contrib.vm (module)

Location

contrib/sb-rotate-byte/arm-vm.lisp

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

If Feature

arm64

Parent

af.contrib.vm (module)

Location

contrib/sb-rotate-byte/arm64-vm.lisp

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

If Feature

x86

Parent

af.contrib.vm (module)

Location

contrib/sb-rotate-byte/x86-vm.lisp

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

If Feature

x86-64

Parent

af.contrib.vm (module)

Location

contrib/sb-rotate-byte/x86-64-vm.lisp

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

If Feature

ppc

Parent

af.contrib.vm (module)

Location

contrib/sb-rotate-byte/ppc-vm.lisp

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

Parent

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

Location

contrib/sb-rotate-byte/rotate-byte.lisp

Exported Definitions

rotate-byte (function)

Internal Definitions

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

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

Parent

af.contrib.sb-md5 (module)

Location

contrib/sb-md5/md5.lisp

Packages

af.contrib.sb-md5

Exported Definitions

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

Internal Definitions

• *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 (function)
• (setf md5-state-amount) (function)
• md5-state-block (function)
• md5-state-buffer (function)
• md5-state-buffer-index (function)
• (setf md5-state-buffer-index) (function)
• md5-state-finalized-p (function)
• (setf md5-state-finalized-p) (function)
• md5-state-regs (function)
• mod32+ (compiler macro)
• mod32+ (function)
• rol32 (function)
• ub32 (type)
• with-md5-round (macro)

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

Parent

af.contrib.sb-cover (module)

Location

contrib/sb-cover/cover.lisp

Packages

af.contrib.sb-cover

Exported Definitions

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

Internal Definitions

• %find-coverage-map (function)
• *counts* (special variable)
• *source-path-mode* (special variable)
• all-of (method)
• (setf all-of) (method)
• check-source-path (function)
• code-coverage-hashtable (macro)
• convert-records (function)
• detabify (function)
• fill-with-state (function)
• make-recording-read-list (function)
• make-source-recorder (function)
• make-source-recording-readtable (function)
• mode-of (method)
• (setf mode-of) (method)
• ok-of (method)
• (setf ok-of) (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)
• 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)

Parent

libs (module)

Location

src/libs/af.lib.coverage.lisp

Packages

af.lib.coverage

Exported Definitions

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

Internal Definitions

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)

Parent

libs (module)

Location

src/libs/af.lib.hashy.lisp

Packages

af.lib.hashy

Exported Definitions

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

Parent

libs (module)

Location

src/libs/af.lib.testy.lisp

Packages

af.lib.testy

Exported Definitions

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

Internal Definitions

test-wrapper (macro)

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

Dependency

af.lib.io.lisp (file)

Parent

libs (module)

Location

src/libs/af.lib.loggy.lisp

Packages

af.lib.loggy

Exported Definitions

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

Internal Definitions

get-level (function)

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

Parent

libs (module)

Location

src/libs/af.lib.ansi-colors.lisp

Packages

af.lib.ansi-colors

Exported Definitions

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

Internal Definitions

*colors* (special variable)

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

Dependency

af.lib.io.lisp (file)

Parent

libs (module)

Location

src/libs/af.lib.clone.lisp

Packages

af.lib.clone

Exported Definitions

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

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

Parent

libs (module)

Location

src/libs/af.lib.io.lisp

Packages

af.lib.io

Exported Definitions

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

Internal Definitions

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

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

Parent

ahungry-fleece (module)

Location

src/ahungry-fleece.lisp

Packages

ahungry-fleece

Exported Definitions

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

Internal Definitions

*base-directory* (special variable)

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

Parent

t (module)

Location

t/af.run.tests.lisp

Packages

af.run.tests

Exported Definitions

• coverage (function)
• main (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 ahungry-fleece-asd

Source

ahungry-fleece.asd

Use List

• asdf/interface
• common-lisp

5.2 af.contrib.sb-rotate-byte

Source

package.lisp (file)

Use List

• sb-assem
• sb-kernel
• sb-int
• sb-vm
• sb-c
• common-lisp

Exported Definitions

rotate-byte (function)

Internal Definitions

• %rotate-byte (function)
• %rotate-byte-derive-type-optimizer (function)
• %unsigned-32-rotate-byte (function)
• %unsigned-64-rotate-byte (function)

5.3 af.contrib.sb-md5

Source

md5.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

• *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 (function)
• (setf md5-state-amount) (function)
• md5-state-block (function)
• md5-state-buffer (function)
• md5-state-buffer-index (function)
• (setf md5-state-buffer-index) (function)
• md5-state-finalized-p (function)
• (setf md5-state-finalized-p) (function)
• md5-state-regs (function)
• mod32+ (compiler macro)
• mod32+ (function)
• rol32 (function)
• ub32 (type)
• with-md5-round (macro)

5.4 af.contrib.sb-cover

Source

cover.lisp (file)

Use List

• sb-c
• common-lisp

Used By List

af.lib.coverage

Exported Definitions

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

Internal Definitions

• %find-coverage-map (function)
• *counts* (special variable)
• *source-path-mode* (special variable)
• all-of (generic function)
• all-of (method)
• (setf all-of) (method)
• (setf all-of) (generic function)
• check-source-path (function)
• code-coverage-hashtable (macro)
• convert-records (function)
• detabify (function)
• fill-with-state (function)
• make-recording-read-list (function)
• make-source-recorder (function)
• make-source-recording-readtable (function)
• mode-of (generic function)
• mode-of (method)
• (setf mode-of) (method)
• (setf mode-of) (generic function)
• ok-of (generic function)
• ok-of (method)
• (setf ok-of) (method)
• (setf ok-of) (generic function)
• 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)
• suppress-sharp-dot (function)
• write-styles (function)

5.5 af.lib.coverage

Source

af.lib.coverage.lisp (file)

Use List

• af.lib.hashy
• af.lib.io
• af.lib.ansi-colors
• af.contrib.sb-cover
• sb-c
• common-lisp

Used By List

af.run.tests

Exported Definitions

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

Internal Definitions

code-coverage-hashtable (macro)

5.6 af.lib.hashy

Source

af.lib.hashy.lisp (file)

Use List

• af.lib.io
• af.lib.loggy
• split-sequence
• cl-yaml
• json
• common-lisp

Used By List

• af.run.tests
• ahungry-fleece
• af.lib.coverage

Exported Definitions

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

5.7 af.lib.testy

Source

af.lib.testy.lisp (file)

Use List

• af.lib.ansi-colors
• json
• common-lisp

Used By List

af.run.tests

Exported Definitions

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

Internal Definitions

test-wrapper (macro)

5.8 af.lib.loggy

Source

af.lib.loggy.lisp (file)

Use List

• json
• common-lisp

Used By List

• af.run.tests
• af.lib.hashy

Exported Definitions

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

Internal Definitions

get-level (function)

5.9 af.lib.ansi-colors

Source

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

Use List

• split-sequence
• common-lisp

Used By List

• af.run.tests
• af.lib.testy
• af.lib.coverage

Exported Definitions

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

Internal Definitions

*colors* (special variable)

5.10 af.lib.clone

Source

af.lib.clone.lisp (file)

Use List

• json
• cl-ppcre
• af.lib.io
• common-lisp

Used By List

ahungry-fleece

Exported Definitions

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

5.11 af.lib.io

Source

af.lib.io.lisp (file)

Use List

• json
• common-lisp

Used By List

• af.run.tests
• ahungry-fleece
• af.lib.clone
• af.lib.coverage
• af.lib.hashy

Exported Definitions

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

Internal Definitions

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

5.12 ahungry-fleece

Source

ahungry-fleece.lisp (file)

Use List

• af.lib.hashy
• af.lib.clone
• af.lib.io
• json
• common-lisp

Exported Definitions

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

Internal Definitions

*base-directory* (special variable)

5.13 af.run.tests

Source

af.run.tests.lisp (file)

Use List

• af.lib.testy
• af.lib.coverage
• af.lib.hashy
• af.lib.loggy
• af.lib.ansi-colors
• af.lib.io
• common-lisp

Exported Definitions

• coverage (function)
• main (function)

Internal Definitions

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

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *colorize-p*

Package

af.lib.ansi-colors

Source

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

Special Variable: *loggy*

Package

af.lib.loggy

Source

af.lib.loggy.lisp (file)

6.1.2 Macros

Macro: desc DESC &rest RESULTS

Describe a set of test.

Package

af.lib.testy

Source

af.lib.testy.lisp (file)

Macro: suite DESC &rest RESULTS

Describe a suite of tests.

Package

af.lib.testy

Source

af.lib.testy.lisp (file)

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 (file)

Macro: with-coverage PACKAGE &rest BODY

Run BODY with coverage enabled.

Package

af.lib.coverage

Source

af.lib.coverage.lisp (file)

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 (file)

6.1.3 Functions

Function: alist-to-hash ALIST

Convert ALIST into a nested hash.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

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 (file)

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 (file)

Function: colorize COLOR

Set the active color of the terminal.

Package

af.lib.ansi-colors

Source

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

Function: coverage ()

Begin the tests!

Package

af.run.tests

Source

af.run.tests.lisp (file)

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 (file)

Function: directory-structure DIRECTORY

Directory structure (including the root dir).

Package

af.lib.io

Source

af.lib.io.lisp (file)

Function: directory-tree DIRECTORY

Recursively get all files in a DIRECTORY.

Package

af.lib.io

Source

af.lib.io.lisp (file)

Function: dotp PAIR

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

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: dump OBJECT

Return the object as json.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: file-get-binary-contents FILENAME

Read in FILENAME and return as a byte list.

Package

af.lib.io

Source

af.lib.io.lisp (file)

Function: file-get-contents FILENAME

Read in FILENAME and return as a single string.

Package

af.lib.io

Source

af.lib.io.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: fill-block ()

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 (file)

Function: fill-block-char ()

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 (file)

Function: fill-block-ub8 ()

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 (file)

Function: finalize-md5-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 (file)

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 (file)

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 (file)

Function: flog LEVEL &rest MESSAGE

Log to the singleton.

Package

af.lib.loggy

Source

af.lib.loggy.lisp (file)

Function: get-coverage CODE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: hash-from-json-file FILENAME

Read in FILENAME and create a hash.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: hash-from-json-string JSON-STRING

Create a hash from the JSON-STRING.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: hash-from-yaml-file FILENAME

Read in FILENAME and create a hash.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: hash-from-yaml-string YAML-STRING

Read in YAML-STRING and create a hash.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: initial-md5-regs ()

Create the initial working state of an MD5 run.

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: it DESC RESULT

Assert the body evaluates as expected.

Package

af.lib.testy

Source

af.lib.testy.lisp (file)

Function: main &rest ARGV

Package

ahungry-fleece

Source

ahungry-fleece.lisp (file)

Function: main ()

Run the tests, or the tests with coverage.

Package

af.run.tests

Source

af.run.tests.lisp (file)

Function: make-md5-state ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

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 (file)

Function: md5-state-p OBJECT

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5regs-digest ()

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 (file)

Function: md5sum-file PATHNAME

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

Package

af.contrib.sb-md5

Source

md5.lisp (file)

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 (file)

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 (file)

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 (file)

Function: pathname-to-string PATHNAME

Change PATHNAME into a string. @todo Add test

Package

af.lib.io

Source

af.lib.io.lisp (file)

Function: print-usage ()

Package

ahungry-fleece

Source

ahungry-fleece.lisp (file)

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 (file)

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 (file)

Function: report DIRECTORY &key (FORM-MODE *SOURCE-PATH-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 (file)

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 (file)

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 (file)

Function: reset-coverage &optional OBJECT

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

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: stringify SYMBOL

Convert a cl-json symbol back into original representation.

Package

af.lib.hashy

Source

af.lib.hashy.lisp (file)

Function: update-md5-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 (file)

Function: update-md5-state ()

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 (file)

6.1.4 Generic functions

Generic Function: level OBJECT

Generic Function: (setf level) NEW-VALUE OBJECT

Package

af.lib.loggy

Methods

Method: level (LOGGY loggy)

automatically generated reader method

Source

af.lib.loggy.lisp (file)

Method: (setf level) NEW-VALUE (LOGGY loggy)

automatically generated writer method

Source

af.lib.loggy.lisp (file)

Generic Function: log-> OBJECT LEVEL &rest MESSAGE

Write a log level message.

Package

af.lib.loggy

Source

af.lib.loggy.lisp (file)

Methods

Method: log-> (LOGGER loggy) LEVEL &rest MESSAGE

Produce a log level message.

Sample call:

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

Generic Function: output OBJECT

Generic Function: (setf output) NEW-VALUE OBJECT

Package

af.lib.loggy

Methods

Method: output (LOGGY loggy)

automatically generated reader method

Source

af.lib.loggy.lisp (file)

Method: (setf output) NEW-VALUE (LOGGY loggy)

automatically generated writer method

Source

af.lib.loggy.lisp (file)

Generic Function: output-args OBJECT

Generic Function: (setf output-args) NEW-VALUE OBJECT

Package

af.lib.loggy

Methods

Method: output-args (LOGGY loggy)

automatically generated reader method

Source

af.lib.loggy.lisp (file)

Method: (setf output-args) NEW-VALUE (LOGGY loggy)

automatically generated writer method

Source

af.lib.loggy.lisp (file)

Generic Function: output-stream OBJECT

Generic Function: (setf output-stream) NEW-VALUE OBJECT

Package

af.lib.loggy

Methods

Method: output-stream (LOGGY loggy)

automatically generated reader method

Source

af.lib.loggy.lisp (file)

Method: (setf output-stream) NEW-VALUE (LOGGY loggy)

automatically generated writer method

Source

af.lib.loggy.lisp (file)

6.1.5 Structures

Structure: md5-state ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: regs

Type

af.contrib.sb-md5:md5-regs

Initform

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

Readers

md5-state-regs (function)

Writers

(setf md5-state-regs) (function)

Slot: amount

Type

(integer 0 *)

Initform

0

Readers

md5-state-amount (function)

Writers

(setf md5-state-amount) (function)

Slot: block

Type

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

Initform

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

Readers

md5-state-block (function)

Writers

(setf md5-state-block) (function)

Slot: buffer

Type

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

Initform

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

Readers

md5-state-buffer (function)

Writers

(setf md5-state-buffer) (function)

Slot: buffer-index

Type

(integer 0 63)

Initform

0

Readers

md5-state-buffer-index (function)

Writers

(setf md5-state-buffer-index) (function)

Slot: finalized-p

Readers

md5-state-finalized-p (function)

Writers

(setf md5-state-finalized-p) (function)

6.1.6 Classes

Class: loggy ()

Package

af.lib.loggy

Source

af.lib.loggy.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• log-> (method)
• output-stream (method)
• output-stream (method)
• output-args (method)
• output-args (method)
• output (method)
• output (method)
• level (method)
• level (method)

Direct slots

Slot: level

Initargs

:level

Initform

(quote debug)

Readers

level (generic function)

Writers

(setf level) (generic function)

Slot: output

Initargs

:output

Initform

(quote format)

Readers

output (generic function)

Writers

(setf output) (generic function)

Slot: output-args

Initargs

:output-args

Initform

(quote ("~a~%"))

Readers

output-args (generic function)

Writers

(setf output-args) (generic function)

Slot: output-stream

Initargs

:output-stream

Initform

t

Readers

output-stream (generic function)

Writers

(setf output-stream) (generic function)

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 (file)

6.2 Internal definitions

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 (file)

Constant: +md5-magic-a+

Initial value of Register A of the MD5 working state.

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Constant: +md5-magic-b+

Initial value of Register B of the MD5 working state.

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Constant: +md5-magic-c+

Initial value of Register C of the MD5 working state.

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Constant: +md5-magic-d+

Initial value of Register D of the MD5 working state.

Package

af.contrib.sb-md5

Source

md5.lisp (file)

6.2.2 Special variables

Special Variable: *base-directory*

Package

ahungry-fleece

Source

ahungry-fleece.lisp (file)

Special Variable: *base-directory*

Package

af.run.tests

Source

af.run.tests.lisp (file)

Special Variable: *colors*

Package

af.lib.ansi-colors

Source

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

Special Variable: *counts*

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Special Variable: *source-path-mode*

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Special Variable: *t*

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Special Variable: *yml*

The yml file for testing.

Package

af.run.tests

Source

af.run.tests.lisp (file)

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 (file)

Macro: code-coverage-hashtable ()

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Macro: code-coverage-hashtable ()

Package

af.lib.coverage

Source

af.lib.coverage.lisp (file)

Macro: md5-regs-a REGS

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Macro: md5-regs-b REGS

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Macro: md5-regs-c REGS

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Macro: md5-regs-d REGS

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Macro: test-wrapper FORMAT-TITLE FORMAT-SUMMARY DESC &rest RESULTS

Describe a suite of tests.

Package

af.lib.testy

Source

af.lib.testy.lisp (file)

Macro: with-md5-round (OP BLOCK) &rest CLAUSES

Package

af.contrib.sb-md5

Source

md5.lisp (file)

6.2.4 Compiler macros

Compiler Macro: mod32+ A B

Package

af.contrib.sb-md5

Source

md5.lisp (file)

6.2.5 Functions

Function: %find-coverage-map CODE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: %rotate-byte COUNT SIZE POS INTEGER

Package

af.contrib.sb-rotate-byte

Source

rotate-byte.lisp (file)

Function: %rotate-byte-derive-type-optimizer NODE

Package

af.contrib.sb-rotate-byte

Source

compiler.lisp (file)

Function: %unsigned-32-rotate-byte COUNT INTEGER

Package

af.contrib.sb-rotate-byte

Source

rotate-byte.lisp (file)

Function: %unsigned-64-rotate-byte COUNT INTEGER

Package

af.contrib.sb-rotate-byte

Source

rotate-byte.lisp (file)

Function: check-source-path PATH

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: convert-records RECORDS MODE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: copy-md5-state INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: copy-to-buffer ()

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 (file)

Function: detabify SOURCE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: directory-structure-helper DIRECTORY

List the directories (recursively).

Package

af.lib.io

Source

af.lib.io.lisp (file)

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 (file)

Function: f ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: fill-with-state SOURCE STATES STATE START END

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: g ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: get-level LEVEL

Get a numeric level from LEVEL.

Package

af.lib.loggy

Source

af.lib.loggy.lisp (file)

Function: h ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: i ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: make-recording-read-list SOURCE-MAP

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

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 (file)

Function: md5-state-amount INSTANCE

Function: (setf md5-state-amount) VALUE INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5-state-block INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5-state-buffer INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5-state-buffer-index INSTANCE

Function: (setf md5-state-buffer-index) VALUE INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5-state-finalized-p INSTANCE

Function: (setf md5-state-finalized-p) VALUE INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: md5-state-regs INSTANCE

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: mod32+ ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: pathname-as-directory PATHNAME &optional ERRORP

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: percent COUNT

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: print-report HTML-STREAM FILE COUNTS STATES SOURCE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

Function: read-file FILENAME EXTERNAL-FORMAT

Return the entire contents of FILENAME as a string.

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

Function: refresh-coverage-info &optional FILENAME

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

Function: rol32 ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Function: source-path-file-position PATH FILENAME

Package

af.contrib.sb-cover

Source

cover.lisp (file)

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 (file)

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 (file)

Function: source-path-string-position PATH STRING

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: suppress-sharp-dot READTABLE

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Function: test ()

Begin the tests!

Package

af.run.tests

Source

af.run.tests.lisp (file)

Function: write-styles HTML-STREAM

Package

af.contrib.sb-cover

Source

cover.lisp (file)

6.2.6 Generic functions

Generic Function: all-of OBJECT

Generic Function: (setf all-of) NEW-VALUE OBJECT

Package

af.contrib.sb-cover

Methods

Method: all-of (SAMPLE-COUNT sample-count)

automatically generated reader method

Source

cover.lisp (file)

Method: (setf all-of) NEW-VALUE (SAMPLE-COUNT sample-count)

automatically generated writer method

Source

cover.lisp (file)

Generic Function: mode-of OBJECT

Generic Function: (setf mode-of) NEW-VALUE OBJECT

Package

af.contrib.sb-cover

Methods

Method: mode-of (SAMPLE-COUNT sample-count)

automatically generated reader method

Source

cover.lisp (file)

Method: (setf mode-of) NEW-VALUE (SAMPLE-COUNT sample-count)

automatically generated writer method

Source

cover.lisp (file)

Generic Function: ok-of OBJECT

Generic Function: (setf ok-of) NEW-VALUE OBJECT

Package

af.contrib.sb-cover

Methods

Method: ok-of (SAMPLE-COUNT sample-count)

automatically generated reader method

Source

cover.lisp (file)

Method: (setf ok-of) NEW-VALUE (SAMPLE-COUNT sample-count)

automatically generated writer method

Source

cover.lisp (file)

6.2.7 Classes

Class: sample-count ()

Package

af.contrib.sb-cover

Source

cover.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• ok-of (method)
• ok-of (method)
• all-of (method)
• all-of (method)
• mode-of (method)
• mode-of (method)

Direct slots

Slot: mode

Initargs

:mode

Readers

mode-of (generic function)

Writers

(setf mode-of) (generic function)

Slot: all

Initform

0

Readers

all-of (generic function)

Writers

(setf all-of) (generic function)

Slot: ok

Initform

0

Readers

ok-of (generic function)

Writers

(setf ok-of) (generic function)

6.2.8 Types

Type: buffer-index ()

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Type: ub32 ()

Corresponds to the 32bit quantity word of the MD5 Spec

Package

af.contrib.sb-md5

Source

md5.lisp (file)

Appendix A Indexes

A.1 Concepts