The printv Reference Manual

This is the printv Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:34:58 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 printv

printv: a batteries-included tracing and debug-logging macro

Maintainer

Dan Lentz <>

Author

Dan Corkill <>

License

Apache 2.0

Long Description

PRINTV is a ’batteries-included’ tracing and debug-logging macro
based on ’The Handy PRINTV’ by Dan Corkill Copyright (C) 2006-2010, Dan Corkill <corkill@GBBopen.org>, and open-source licensed under terms of Apache License 2.0. printv is available from http://github.com/danlentz/printv or from a current quicklisp dist.

Version

0.1.0

Source

printv.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 printv/printv.asd

Source

printv.asd.

Parent Component

printv (system).

ASDF Systems

printv.


3.1.2 printv/package.lisp

Dependency

readme.md (file).

Source

printv.asd.

Parent Component

printv (system).

Packages

printv.


3.1.3 printv/lock.lisp

Dependency

package.lisp (file).

Source

printv.asd.

Parent Component

printv (system).

Internals

3.1.4 printv/time.lisp

Dependency

lock.lisp (file).

Source

printv.asd.

Parent Component

printv (system).

Public Interface
Internals

3.1.5 printv/printv.lisp

Dependency

time.lisp (file).

Source

printv.asd.

Parent Component

printv (system).

Public Interface
Internals

3.2 Static


3.2.1 printv/README.md

Source

printv.asd.

Parent Component

printv (system).


4 Packages

Packages are listed by definition order.


4.1 printv

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 Special variables

Special Variable: *default-printv-output*
Package

printv.

Source

printv.lisp.

Special Variable: *figlet-executable*
Package

printv.

Source

printv.lisp.

Special Variable: *figlet-font*
Package

printv.

Source

printv.lisp.

Special Variable: *major-separator*
Package

printv.

Source

printv.lisp.

Special Variable: *minor-separator*
Package

printv.

Source

printv.lisp.

Special Variable: *ppmx-macro-char*
Package

printv.

Source

printv.lisp.

Special Variable: *printv-macro-char*
Package

printv.

Source

printv.lisp.

Special Variable: *printv-output*
Package

printv.

Source

printv.lisp.

Special Variable: *timestamp-designator*
Package

printv.

Source

printv.lisp.


5.1.2 Macros

Macro: ppmx (form)

Pretty prints the macro expansion of FORM.

Package

printv.

Source

printv.lisp.

Macro: printv (&rest forms)
Package

printv.

Source

printv.lisp.

Macro: with-printv-disabled (&body body)
Package

printv.

Source

printv.lisp.

Macro: with-printv-enabled (&body body)
Package

printv.

Source

printv.lisp.

Macro: with-printv-output-to ((&optional destination) &body body)
Package

printv.

Source

printv.lisp.


5.1.3 Ordinary functions

Function: disable-printv ()
Package

printv.

Source

printv.lisp.

Function: disable-printv-output ()
Package

printv.

Source

printv.lisp.

Function: enable-ppmx-reader (&optional char)
Package

printv.

Source

printv.lisp.

Function: enable-printv ()
Package

printv.

Source

printv.lisp.

Function: enable-printv-output (&optional stream)
Package

printv.

Source

printv.lisp.

Function: enable-printv-reader (&optional char)
Package

printv.

Source

printv.lisp.

Function: format-decoded-time (destination seconds minutes hours day month year &key timezone style date-first print-seconds print-meridian print-timezone print-weekday)

FORMAT-DECODED-TIME formats a string containing decoded time
expressed in a humanly-readable manner. The destination is any destination which can be accepted by the FORMAT function. The timezone keyword is an integer specifying hours west of Greenwich. The style keyword can be :SHORT (numeric date), :LONG (months and weekdays expressed as words), or :ABBREVIATED (like :LONG but words are abbreviated). The keyword DATE-FIRST, if NIL, will cause the time to be printed first instead of the date (the default). The PRINT- keywords, if nil, inhibit the printing of certain semi-obvious parts of the string.

Package

printv.

Source

time.lisp.

Function: format-universal-time (destination universal-time &key timezone style date-first print-seconds print-meridian print-timezone print-weekday)

Format-Universal-Time formats a string containing the time and date given by universal-time in a common manner. The destination is any destination which can be accepted by the Format function. The timezone keyword is an integer specifying hours west of Greenwich. The style keyword can be :SHORT (numeric date), :LONG (months and weekdays expressed as words), :ABBREVIATED (like :LONG but words are abbreviated), or :GOVERNMENT (of the form "XX Month XXXX XX:XX:XX") The &KEY argument :DATE-FIRST, if NIL, will print the time first instead of the date (the default). The PRINT- keywords, if NIL, inhibit
the printing of the obvious part of the time/date.

Package

printv.

Source

time.lisp.

Function: ppmx-reader (stream char)
Package

printv.

Source

printv.lisp.

Function: printv-reader (stream char)
Package

printv.

Source

printv.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *abbrev-month-table*
Package

printv.

Source

time.lisp.

Special Variable: *abbrev-weekday-table*
Package

printv.

Source

time.lisp.

Special Variable: *daylight-table*
Package

printv.

Source

time.lisp.

Special Variable: *long-month-table*
Package

printv.

Source

time.lisp.

Special Variable: *long-weekday-table*
Package

printv.

Source

time.lisp.

Special Variable: *printv-lock*
Package

printv.

Source

printv.lisp.

Special Variable: *timezone-table*
Package

printv.

Source

time.lisp.


5.2.2 Macros

Macro: vcond (&body clauses)
Package

printv.

Source

printv.lisp.

Macro: vlet (bind-forms &body body)
Package

printv.

Source

printv.lisp.

Macro: vlet* (bind-forms &body body)
Package

printv.

Source

printv.lisp.

Macro: with-recursive-lock-held ((place) &body body)
Package

printv.

Source

lock.lisp.


5.2.3 Ordinary functions

Function: expander (forms &optional values-trans-fn)
Package

printv.

Source

printv.lisp.

Function: form-printer (form)
Package

printv.

Source

printv.lisp.

Function: format-date-range (start-year start-month start-day end-year end-month end-day)
Package

printv.

Source

time.lisp.

Function: major-separator ()
Package

printv.

Source

printv.lisp.

Function: make-recursive-lock (&optional name)
Package

printv.

Source

lock.lisp.

Function: minor-separator ()
Package

printv.

Source

printv.lisp.

Function: register-readtable (&optional package)
Package

printv.

Source

printv.lisp.

Function: timestamp (&optional time)
Package

printv.

Source

printv.lisp.

Function: timezone-name (dst tz)
Package

printv.

Source

time.lisp.

Function: valid-destination-p (destination)
Package

printv.

Source

time.lisp.

Function: values-printer (values-list)
Package

printv.

Source

printv.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   E   F   M   P   R   T   V   W  
Index Entry  Section

D
disable-printv: Public ordinary functions
disable-printv-output: Public ordinary functions

E
enable-ppmx-reader: Public ordinary functions
enable-printv: Public ordinary functions
enable-printv-output: Public ordinary functions
enable-printv-reader: Public ordinary functions
expander: Private ordinary functions

F
form-printer: Private ordinary functions
format-date-range: Private ordinary functions
format-decoded-time: Public ordinary functions
format-universal-time: Public ordinary functions
Function, disable-printv: Public ordinary functions
Function, disable-printv-output: Public ordinary functions
Function, enable-ppmx-reader: Public ordinary functions
Function, enable-printv: Public ordinary functions
Function, enable-printv-output: Public ordinary functions
Function, enable-printv-reader: Public ordinary functions
Function, expander: Private ordinary functions
Function, form-printer: Private ordinary functions
Function, format-date-range: Private ordinary functions
Function, format-decoded-time: Public ordinary functions
Function, format-universal-time: Public ordinary functions
Function, major-separator: Private ordinary functions
Function, make-recursive-lock: Private ordinary functions
Function, minor-separator: Private ordinary functions
Function, ppmx-reader: Public ordinary functions
Function, printv-reader: Public ordinary functions
Function, register-readtable: Private ordinary functions
Function, timestamp: Private ordinary functions
Function, timezone-name: Private ordinary functions
Function, valid-destination-p: Private ordinary functions
Function, values-printer: Private ordinary functions

M
Macro, ppmx: Public macros
Macro, printv: Public macros
Macro, vcond: Private macros
Macro, vlet: Private macros
Macro, vlet*: Private macros
Macro, with-printv-disabled: Public macros
Macro, with-printv-enabled: Public macros
Macro, with-printv-output-to: Public macros
Macro, with-recursive-lock-held: Private macros
major-separator: Private ordinary functions
make-recursive-lock: Private ordinary functions
minor-separator: Private ordinary functions

P
ppmx: Public macros
ppmx-reader: Public ordinary functions
printv: Public macros
printv-reader: Public ordinary functions

R
register-readtable: Private ordinary functions

T
timestamp: Private ordinary functions
timezone-name: Private ordinary functions

V
valid-destination-p: Private ordinary functions
values-printer: Private ordinary functions
vcond: Private macros
vlet: Private macros
vlet*: Private macros

W
with-printv-disabled: Public macros
with-printv-enabled: Public macros
with-printv-output-to: Public macros
with-recursive-lock-held: Private macros


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*abbrev-month-table*: Private special variables
*abbrev-weekday-table*: Private special variables
*daylight-table*: Private special variables
*default-printv-output*: Public special variables
*figlet-executable*: Public special variables
*figlet-font*: Public special variables
*long-month-table*: Private special variables
*long-weekday-table*: Private special variables
*major-separator*: Public special variables
*minor-separator*: Public special variables
*ppmx-macro-char*: Public special variables
*printv-lock*: Private special variables
*printv-macro-char*: Public special variables
*printv-output*: Public special variables
*timestamp-designator*: Public special variables
*timezone-table*: Private special variables

S
Special Variable, *abbrev-month-table*: Private special variables
Special Variable, *abbrev-weekday-table*: Private special variables
Special Variable, *daylight-table*: Private special variables
Special Variable, *default-printv-output*: Public special variables
Special Variable, *figlet-executable*: Public special variables
Special Variable, *figlet-font*: Public special variables
Special Variable, *long-month-table*: Private special variables
Special Variable, *long-weekday-table*: Private special variables
Special Variable, *major-separator*: Public special variables
Special Variable, *minor-separator*: Public special variables
Special Variable, *ppmx-macro-char*: Public special variables
Special Variable, *printv-lock*: Private special variables
Special Variable, *printv-macro-char*: Public special variables
Special Variable, *printv-output*: Public special variables
Special Variable, *timestamp-designator*: Public special variables
Special Variable, *timezone-table*: Private special variables