The cl-stopwatch Reference Manual

This is the cl-stopwatch Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:31:33 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-stopwatch

Timing and clocking in Common Lisp.

Author

Robert Smith

License

BSD 3-clause. See LICENSE.

Version

0.1

Source

cl-stopwatch.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-stopwatch/cl-stopwatch.asd

Source

cl-stopwatch.asd.

Parent Component

cl-stopwatch (system).

ASDF Systems

cl-stopwatch.

Packages

cl-stopwatch-asd.


3.1.2 cl-stopwatch/package.lisp

Source

cl-stopwatch.asd.

Parent Component

cl-stopwatch (system).

Packages

cl-stopwatch.


3.1.3 cl-stopwatch/stopwatch.lisp

Dependency

package.lisp (file).

Source

cl-stopwatch.asd.

Parent Component

cl-stopwatch (system).

Public Interface
Internals

3.1.4 cl-stopwatch/progress.lisp

Dependency

stopwatch.lisp (file).

Source

cl-stopwatch.asd.

Parent Component

cl-stopwatch (system).

Public Interface
Internals

*progress-indent* (special variable).


3.1.5 cl-stopwatch/time.lisp

Dependency

progress.lisp (file).

Source

cl-stopwatch.asd.

Parent Component

cl-stopwatch (system).

Public Interface

time* (macro).


4 Packages

Packages are listed by definition order.


4.1 cl-stopwatch-asd

Source

cl-stopwatch.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-stopwatch

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: progress-task (kw string &body body)

Execute BODY, reporting the task, labeled by the keyword KW and commented with STRING. Report its end time and return the value returned by BODY.

Package

cl-stopwatch.

Source

progress.lisp.

Macro: time* (form)

Freshly compile FORM and time its execution.

Package

cl-stopwatch.

Source

time.lisp.

Macro: with-stopwatch (&body body)

Execute BODY, returning its value as well as the value of the watch.

Package

cl-stopwatch.

Source

stopwatch.lisp.


5.1.2 Ordinary functions

Function: progress-task-done (kw &optional stream)

End the task designated by the keyword KW and report its completion time to STREAM.

Package

cl-stopwatch.

Source

progress.lisp.

Function: progress-task-start (kw string &optional stream)

Start a task designated by the keyword KW, with a comment STRING, and print an indication that the task has started and start a stopwatch. Print everything to STREAM.

Package

cl-stopwatch.

Source

progress.lisp.

Function: stopwatch-read (kw)

Read a stopwatch designated by KW.

Package

cl-stopwatch.

Source

stopwatch.lisp.

Function: stopwatch-reset (kw)

Resets the stopwatch designated by KW. Equivalent to starting it.

Package

cl-stopwatch.

Source

stopwatch.lisp.

Function: stopwatch-start (kw)

Start a stopwatch designated by KW.

Package

cl-stopwatch.

Source

stopwatch.lisp.

Function: stopwatch-stop (kw)

Stop the stopwatch designated by KW and return the reading in milliseconds.

Package

cl-stopwatch.

Source

stopwatch.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *progress-indent*
Package

cl-stopwatch.

Source

progress.lisp.

Special Variable: *stopwatch-timing*
Package

cl-stopwatch.

Source

stopwatch.lisp.


5.2.2 Macros

Macro: get-accurate-time ()

Get the time in milliseconds, accurately.

Package

cl-stopwatch.

Source

stopwatch.lisp.


Appendix A Indexes


A.1 Concepts