The cl-cram Reference Manual

This is the cl-cram Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:40:28 2022 GMT+0.

1 Systems

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

cl-cram

1.1 `cl-cram`

A simple, Progress bar for Common Lisp

Author: hikettei
License: MIT
Source: cl-cram.asd.
Child Component: cl-cram.lisp (file).

2 Files

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

Lisp

2.1.1 `cl-cram/cl-cram.asd`

Source: cl-cram.asd.
Parent Component: cl-cram (system).
ASDF Systems: cl-cram.

2.1.2 `cl-cram/cl-cram.lisp`

Source

cl-cram.asd.

Parent Component

cl-cram (system).

Packages

cl-cram.

Public Interface

*blank* (special variable).
*progress-bar-ascii* (special variable).
*progress-bar-enabled* (special variable).
discard-all-progress-bar (macro).
init-progress-bar (macro).
pdolist (macro).
pdotimes (macro).
pmap (macro).
update (function).
with-progress-bar (macro).

Internals

*all-of-progress-bars* (special variable).
*indent* (special variable).
*number-of-bar* (special variable).
backward-lines (function).
copy-progress-bar-status (function).
make-progress-bar-status (function).
pbar-count (reader).
(setf pbar-count) (writer).
pbar-desc (reader).
(setf pbar-desc) (writer).
pbar-desc-len (reader).
(setf pbar-desc-len) (writer).
pbar-nth-bar (reader).
(setf pbar-nth-bar) (writer).
pbar-start-time (reader).
(setf pbar-start-time) (writer).
pbar-total (reader).
(setf pbar-total) (writer).
progress-bar (function).
progress-bar-status (structure).
progress-percent (macro).
render (function).

3 Packages

Packages are listed by definition order.

cl-cram

3.1 `cl-cram`

Source

cl-cram.lisp.

Use List

common-lisp.

Public Interface

*blank* (special variable).
*progress-bar-ascii* (special variable).
*progress-bar-enabled* (special variable).
discard-all-progress-bar (macro).
init-progress-bar (macro).
pdolist (macro).
pdotimes (macro).
pmap (macro).
update (function).
with-progress-bar (macro).

Internals

*all-of-progress-bars* (special variable).
*indent* (special variable).
*number-of-bar* (special variable).
backward-lines (function).
copy-progress-bar-status (function).
make-progress-bar-status (function).
pbar-count (reader).
(setf pbar-count) (writer).
pbar-desc (reader).
(setf pbar-desc) (writer).
pbar-desc-len (reader).
(setf pbar-desc-len) (writer).
pbar-nth-bar (reader).
(setf pbar-nth-bar) (writer).
pbar-start-time (reader).
(setf pbar-start-time) (writer).
pbar-total (reader).
(setf pbar-total) (writer).
progress-bar (function).
progress-bar-status (structure).
progress-percent (macro).
render (function).

4 Definitions

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

Public Interface
Internals

4.1 Public Interface

Special variables
Macros
Ordinary functions

4.1.1 Special variables

Special Variable: *blank* ¶

Package: cl-cram.
Source: cl-cram.lisp.

Special Variable: *progress-bar-ascii* ¶

Package: cl-cram.
Source: cl-cram.lisp.

Special Variable: *progress-bar-enabled* ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.1.2 Macros

Macro: discard-all-progress-bar () ¶

Package: cl-cram.
Source: cl-cram.lisp.

Macro: init-progress-bar (var desc total) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Macro: pdolist ((var list) &body body) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Macro: pdotimes ((var count) &body body) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Macro: pmap (result-type function first-sequence) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Macro: with-progress-bar (var desc total &body body) ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.1.3 Ordinary functions

Function: update () ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.2 Internals

Special variables
Macros
Ordinary functions
Structures

4.2.1 Special variables

Special Variable: *all-of-progress-bars* ¶

Package: cl-cram.
Source: cl-cram.lisp.

Special Variable: *indent* ¶

Package: cl-cram.
Source: cl-cram.lisp.

Special Variable: *number-of-bar* ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.2.2 Macros

Macro: progress-percent (status) ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.2.3 Ordinary functions

Function: backward-lines () ¶

Package: cl-cram.
Source: cl-cram.lisp.

Function: copy-progress-bar-status (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Function: make-progress-bar-status (&key total count desc desc-len start-time nth-bar) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Reader: pbar-count (instance) ¶

Writer: (setf pbar-count) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: count.

Reader: pbar-desc (instance) ¶

Writer: (setf pbar-desc) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: desc.

Reader: pbar-desc-len (instance) ¶

Writer: (setf pbar-desc-len) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: desc-len.

Reader: pbar-nth-bar (instance) ¶

Writer: (setf pbar-nth-bar) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: nth-bar.

Reader: pbar-start-time (instance) ¶

Writer: (setf pbar-start-time) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: start-time.

Reader: pbar-total (instance) ¶

Writer: (setf pbar-total) (instance) ¶

Package: cl-cram.
Source: cl-cram.lisp.
Target Slot: total.

Function: progress-bar (object) ¶

Package: cl-cram.
Source: cl-cram.lisp.

Function: render () ¶

Package: cl-cram.
Source: cl-cram.lisp.

4.2.4 Structures

Structure: progress-bar-status ¶

Package

cl-cram.

Source

cl-cram.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: total ¶

Type: fixnum
Readers: pbar-total.
Writers: (setf pbar-total).

Slot: count ¶

Package: common-lisp.
Type: fixnum
Initform: 0
Readers: pbar-count.
Writers: (setf pbar-count).

Slot: desc ¶

Type: string
Initform: "prog"
Readers: pbar-desc.
Writers: (setf pbar-desc).

Slot: desc-len ¶

Type: fixnum
Readers: pbar-desc-len.
Writers: (setf pbar-desc-len).

Slot: start-time ¶

Type: fixnum
Readers: pbar-start-time.
Writers: (setf pbar-start-time).

Slot: nth-bar ¶

Type: fixnum
Readers: pbar-nth-bar.
Writers: (setf pbar-nth-bar).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( B C D F I M P R U W

	Index Entry	Section

(
	`(setf pbar-count)`:	Private ordinary functions
	`(setf pbar-desc)`:	Private ordinary functions
	`(setf pbar-desc-len)`:	Private ordinary functions
	`(setf pbar-nth-bar)`:	Private ordinary functions
	`(setf pbar-start-time)`:	Private ordinary functions
	`(setf pbar-total)`:	Private ordinary functions

B
	`backward-lines`:	Private ordinary functions

C
	`copy-progress-bar-status`:	Private ordinary functions

D
	`discard-all-progress-bar`:	Public macros

F
	`Function, (setf pbar-count)`:	Private ordinary functions
	`Function, (setf pbar-desc)`:	Private ordinary functions
	`Function, (setf pbar-desc-len)`:	Private ordinary functions
	`Function, (setf pbar-nth-bar)`:	Private ordinary functions
	`Function, (setf pbar-start-time)`:	Private ordinary functions
	`Function, (setf pbar-total)`:	Private ordinary functions
	`Function, backward-lines`:	Private ordinary functions
	`Function, copy-progress-bar-status`:	Private ordinary functions
	`Function, make-progress-bar-status`:	Private ordinary functions
	`Function, pbar-count`:	Private ordinary functions
	`Function, pbar-desc`:	Private ordinary functions
	`Function, pbar-desc-len`:	Private ordinary functions
	`Function, pbar-nth-bar`:	Private ordinary functions
	`Function, pbar-start-time`:	Private ordinary functions
	`Function, pbar-total`:	Private ordinary functions
	`Function, progress-bar`:	Private ordinary functions
	`Function, render`:	Private ordinary functions
	`Function, update`:	Public ordinary functions

I
	`init-progress-bar`:	Public macros

M
	`Macro, discard-all-progress-bar`:	Public macros
	`Macro, init-progress-bar`:	Public macros
	`Macro, pdolist`:	Public macros
	`Macro, pdotimes`:	Public macros
	`Macro, pmap`:	Public macros
	`Macro, progress-percent`:	Private macros
	`Macro, with-progress-bar`:	Public macros
	`make-progress-bar-status`:	Private ordinary functions

P
	`pbar-count`:	Private ordinary functions
	`pbar-desc`:	Private ordinary functions
	`pbar-desc-len`:	Private ordinary functions
	`pbar-nth-bar`:	Private ordinary functions
	`pbar-start-time`:	Private ordinary functions
	`pbar-total`:	Private ordinary functions
	`pdolist`:	Public macros
	`pdotimes`:	Public macros
	`pmap`:	Public macros
	`progress-bar`:	Private ordinary functions
	`progress-percent`:	Private macros

R
	`render`:	Private ordinary functions

U
	`update`:	Public ordinary functions

W
	`with-progress-bar`:	Public macros

Jump to:	( B C D F I M P R U W

A.3 Variables

Jump to:	* C D N S T

	Index Entry	Section

*
	`all-of-progress-bars`:	Private special variables
	`blank`:	Public special variables
	`indent`:	Private special variables
	`number-of-bar`:	Private special variables
	`progress-bar-ascii`:	Public special variables
	`progress-bar-enabled`:	Public special variables

C
	`count`:	Private structures

D
	`desc`:	Private structures
	`desc-len`:	Private structures

N
	`nth-bar`:	Private structures

S
	`Slot, count`:	Private structures
	`Slot, desc`:	Private structures
	`Slot, desc-len`:	Private structures
	`Slot, nth-bar`:	Private structures
	`Slot, start-time`:	Private structures
	`Slot, total`:	Private structures
	`Special Variable, all-of-progress-bars`:	Private special variables
	`Special Variable, blank`:	Public special variables
	`Special Variable, indent`:	Private special variables
	`Special Variable, number-of-bar`:	Private special variables
	`Special Variable, progress-bar-ascii`:	Public special variables
	`Special Variable, progress-bar-enabled`:	Public special variables
	`start-time`:	Private structures

T
	`total`:	Private structures

Jump to:	* C D N S T

A.4 Data types

Jump to:	C F P S

	Index Entry	Section

C
	`cl-cram`:	The cl-cram system
	`cl-cram`:	The cl-cram package
	`cl-cram.asd`:	The cl-cram/cl-cram․asd file
	`cl-cram.lisp`:	The cl-cram/cl-cram․lisp file

F
	`File, cl-cram.asd`:	The cl-cram/cl-cram․asd file
	`File, cl-cram.lisp`:	The cl-cram/cl-cram․lisp file

P
	`Package, cl-cram`:	The cl-cram package
	`progress-bar-status`:	Private structures

S
	`Structure, progress-bar-status`:	Private structures
	`System, cl-cram`:	The cl-cram system

Jump to:	C F P S

The cl-cram Reference Manual

The cl-cram Reference Manual

Table of Contents

1 Systems

1.1 cl-cram

2 Files

2.1 Lisp

2.1.1 cl-cram/cl-cram.asd

2.1.2 cl-cram/cl-cram.lisp

3 Packages

3.1 cl-cram

4 Definitions

4.1 Public Interface

4.1.1 Special variables

4.1.2 Macros

4.1.3 Ordinary functions

4.2 Internals

4.2.1 Special variables

4.2.2 Macros

4.2.3 Ordinary functions

4.2.4 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `cl-cram`

2.1.1 `cl-cram/cl-cram.asd`

2.1.2 `cl-cram/cl-cram.lisp`

3.1 `cl-cram`