Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The clack-pretend Reference Manual

This is the clack-pretend Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:49:24 2023 GMT+0.

Table of Contents

Next: Systems, Previous: The clack-pretend Reference Manual, Up: The clack-pretend Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The clack-pretend Reference Manual [Contents][Index]

2 Systems

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

clack-pretend

Previous: Systems, Up: Systems [Contents][Index]

2.1 `clack-pretend`

A testing and debugging tool for Clack

Author

Ben McGunigle <bnmcgn@gmail.com>

License

Apache License, version 2.0

Dependencies

clack (system).
alexandria (system).
lack-request (system).
circular-streams (system).
cl-hash-util (system).

Source

clack-pretend.asd.

Child Components

package.lisp (file).
clack-pretend.lisp (file).

Next: Packages, Previous: Systems, Up: The clack-pretend Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

clack-pretend/clack-pretend.asd
clack-pretend/package.lisp
clack-pretend/clack-pretend.lisp

Next: clack-pretend/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `clack-pretend/clack-pretend.asd`

Source: clack-pretend.asd.
Parent Component: clack-pretend (system).
ASDF Systems: clack-pretend.

Next: clack-pretend/clack-pretend.lisp, Previous: clack-pretend/clack-pretend.asd, Up: Lisp [Contents][Index]

3.1.2 `clack-pretend/package.lisp`

Source: clack-pretend.asd.
Parent Component: clack-pretend (system).
Packages: clack-pretend.

Previous: clack-pretend/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `clack-pretend/clack-pretend.lisp`

Dependency

package.lisp (file).

Source

clack-pretend.asd.

Parent Component

clack-pretend (system).

Public Interface

last-as-code (function).
last-input (function).
last-output (function).
last-request-object (function).
last-request-url (function).
last-session (function).
pretend-builder (macro).
quick-summary (function).
run-pretend (function).
verbose-builder (macro).
verbose-component (function).

Internals

*logfile* (special variable).
*pretend-app-chain* (special variable).
*pretend-storage* (special variable).
*pretend-storage-size* (special variable).
*watch-symbols* (special variable).
hash-table->source (function).
pretend-component (function).
store-results (function).

Next: Definitions, Previous: Files, Up: The clack-pretend Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

clack-pretend

Previous: Packages, Up: Packages [Contents][Index]

4.1 `clack-pretend`

Source

package.lisp.

Use List

alexandria.
common-lisp.
lack.component.
lack.request.

Public Interface

last-as-code (function).
last-input (function).
last-output (function).
last-request-object (function).
last-request-url (function).
last-session (function).
pretend-builder (macro).
quick-summary (function).
run-pretend (function).
verbose-builder (macro).
verbose-component (function).

Internals

*logfile* (special variable).
*pretend-app-chain* (special variable).
*pretend-storage* (special variable).
*pretend-storage-size* (special variable).
*watch-symbols* (special variable).
hash-table->source (function).
pretend-component (function).
store-results (function).

Next: Indexes, Previous: Packages, Up: The clack-pretend Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Ordinary functions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: pretend-builder ((&key insert watch-symbols errors-only logfile) &rest middles-and-app) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Macro: verbose-builder (&rest middles-and-app) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: last-as-code (&optional index) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: last-input (&optional index) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: last-output (&optional index) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: last-request-object (&optional index) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: last-request-url () ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: last-session (&optional index) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: quick-summary () ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: run-pretend (&key index path-info app-chain) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: verbose-component (message) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *logfile* ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Special Variable: *pretend-app-chain* ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Special Variable: *pretend-storage* ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Special Variable: *pretend-storage-size* ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Special Variable: *watch-symbols* ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: hash-table->source (ht) ¶

Returns a source code representation of a hash table.

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: pretend-component (app watch-symbols error-only logfile) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Function: store-results (input output) ¶

Package: clack-pretend.
Source: clack-pretend.lisp.

Previous: Definitions, Up: The clack-pretend Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	F H L M P Q R S V

	Index Entry		Section

F
	`Function, hash-table->source`:		Private ordinary functions
	`Function, last-as-code`:		Public ordinary functions
	`Function, last-input`:		Public ordinary functions
	`Function, last-output`:		Public ordinary functions
	`Function, last-request-object`:		Public ordinary functions
	`Function, last-request-url`:		Public ordinary functions
	`Function, last-session`:		Public ordinary functions
	`Function, pretend-component`:		Private ordinary functions
	`Function, quick-summary`:		Public ordinary functions
	`Function, run-pretend`:		Public ordinary functions
	`Function, store-results`:		Private ordinary functions
	`Function, verbose-component`:		Public ordinary functions

H
	`hash-table->source`:		Private ordinary functions

L
	`last-as-code`:		Public ordinary functions
	`last-input`:		Public ordinary functions
	`last-output`:		Public ordinary functions
	`last-request-object`:		Public ordinary functions
	`last-request-url`:		Public ordinary functions
	`last-session`:		Public ordinary functions

M
	`Macro, pretend-builder`:		Public macros
	`Macro, verbose-builder`:		Public macros

P
	`pretend-builder`:		Public macros
	`pretend-component`:		Private ordinary functions

Q
	`quick-summary`:		Public ordinary functions

R
	`run-pretend`:		Public ordinary functions

S
	`store-results`:		Private ordinary functions

V
	`verbose-builder`:		Public macros
	`verbose-component`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`logfile`:		Private special variables
	`pretend-app-chain`:		Private special variables
	`pretend-storage`:		Private special variables
	`pretend-storage-size`:		Private special variables
	`watch-symbols`:		Private special variables

S
	`Special Variable, logfile`:		Private special variables
	`Special Variable, pretend-app-chain`:		Private special variables
	`Special Variable, pretend-storage`:		Private special variables
	`Special Variable, pretend-storage-size`:		Private special variables
	`Special Variable, watch-symbols`:		Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F P S

	Index Entry		Section

C
	`clack-pretend`:		The clack-pretend system
	`clack-pretend`:		The clack-pretend package
	`clack-pretend.asd`:		The clack-pretend/clack-pretend․asd file
	`clack-pretend.lisp`:		The clack-pretend/clack-pretend․lisp file

F
	`File, clack-pretend.asd`:		The clack-pretend/clack-pretend․asd file
	`File, clack-pretend.lisp`:		The clack-pretend/clack-pretend․lisp file
	`File, package.lisp`:		The clack-pretend/package․lisp file

P
	`Package, clack-pretend`:		The clack-pretend package
	`package.lisp`:		The clack-pretend/package․lisp file

S
	`System, clack-pretend`:		The clack-pretend system