The cl-tqdm Reference Manual

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

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-tqdm

Simple And Fast Progress Bar Library for Common Lisp

Author

hikettei

Source Control

(GIT git@github.com:hikettei/cl-tqdm.git)

License

MIT

Source

cl-tqdm.asd.

Child Component

cl-tqdm.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 cl-tqdm/cl-tqdm.asd

Source

cl-tqdm.asd.

Parent Component

cl-tqdm (system).

ASDF Systems

cl-tqdm.


3.1.2 cl-tqdm/cl-tqdm.lisp

Source

cl-tqdm.asd.

Parent Component

cl-tqdm (system).

Packages

cl-tqdm.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-tqdm

Source

cl-tqdm.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: with-config (config &body body)

Example:
(with-config (config :animation nil) (with-tqdm
~~~))

Package

cl-tqdm.

Source

cl-tqdm.lisp.

Macro: with-no-animation (&body body)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Macro: with-tqdm (out total-size description &body body)

Example:
(with-tqdm x :ProgressBar1 100 "" (update x))

Package

cl-tqdm.

Source

cl-tqdm.lisp.


5.1.2 Ordinary functions

Function: config (&key animation space-string bar-string indent)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: tqdm (total-count &optional identifier description)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: update (tqdm &key incf description stream)
Package

cl-tqdm.

Source

cl-tqdm.lisp.


5.1.3 Standalone methods

Method: print-object ((object tqdmconfig) stream)
Source

cl-tqdm.lisp.

Method: print-object ((object tqdmbar) stream)
Source

cl-tqdm.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *in-update-method*
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Special Variable: *tqdm-config*
Package

cl-tqdm.

Source

cl-tqdm.lisp.


5.2.2 Ordinary functions

Function: backward-lines ()
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Reader: config-animation (instance)
Writer: (setf config-animation) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

animation.

Reader: config-bar-string (instance)
Writer: (setf config-bar-string) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

bar-string.

Reader: config-indent (instance)
Writer: (setf config-indent) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

indent.

Reader: config-space-string (instance)
Writer: (setf config-space-string) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

space-string.

Function: copy-tqdmbar (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: copy-tqdmconfig (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: progress-percent (status)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: render (status)

Rendering given status (which is the structure of tqdmbar), render returns the output string.

Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: render-progress-bar (stream tqdm)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Reader: tqdm-call-timestamps (instance)
Writer: (setf tqdm-call-timestamps) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

call-timestamps.

Reader: tqdm-count-idx (instance)
Writer: (setf tqdm-count-idx) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

count-idx.

Reader: tqdm-creation-time (instance)
Writer: (setf tqdm-creation-time) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

creation-time.

Reader: tqdm-description (instance)
Writer: (setf tqdm-description) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

description.

Reader: tqdm-identifier (instance)
Writer: (setf tqdm-identifier) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

identifier.

Reader: tqdm-total-count (instance)
Writer: (setf tqdm-total-count) (instance)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Target Slot

total-count.

Function: tqdmbar-p (object)
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Function: tqdmconfig-p (object)
Package

cl-tqdm.

Source

cl-tqdm.lisp.


5.2.3 Structures

Structure: tqdmbar

Tqdm Structure that contains informations.

APIs read this structure and update, rendering progress-bar in terminals.

Example:

“‘lisp
(print (tqdm :FirstBar 100))
“‘

Package

cl-tqdm.

Source

cl-tqdm.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: identifier
Type

symbol

Initform

:no-name

Readers

tqdm-identifier.

Writers

(setf tqdm-identifier).

Slot: total-count
Type

fixnum

Initform

0

Readers

tqdm-total-count.

Writers

(setf tqdm-total-count).

Slot: count-idx
Type

fixnum

Initform

0

Readers

tqdm-count-idx.

Writers

(setf tqdm-count-idx).

Slot: call-timestamps
Type

list

Readers

tqdm-call-timestamps.

Writers

(setf tqdm-call-timestamps).

Slot: creation-time
Type

(integer 0 4611686018427387903)

Initform

0

Readers

tqdm-creation-time.

Writers

(setf tqdm-creation-time).

Slot: description
Type

string

Initform

""

Readers

tqdm-description.

Writers

(setf tqdm-description).

Structure: tqdmconfig
Package

cl-tqdm.

Source

cl-tqdm.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: animation
Type

boolean

Initform

t

Readers

config-animation.

Writers

(setf config-animation).

Slot: space-string
Type

string

Initform

" "

Readers

config-space-string.

Writers

(setf config-space-string).

Slot: bar-string
Type

string

Initform

"█"

Readers

config-bar-string.

Writers

(setf config-bar-string).

Slot: indent
Type

fixnum

Initform

0

Readers

config-indent.

Writers

(setf config-indent).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   F   M   P   R   T   U   W  
Index Entry  Section

(
(setf config-animation): Private ordinary functions
(setf config-bar-string): Private ordinary functions
(setf config-indent): Private ordinary functions
(setf config-space-string): Private ordinary functions
(setf tqdm-call-timestamps): Private ordinary functions
(setf tqdm-count-idx): Private ordinary functions
(setf tqdm-creation-time): Private ordinary functions
(setf tqdm-description): Private ordinary functions
(setf tqdm-identifier): Private ordinary functions
(setf tqdm-total-count): Private ordinary functions

B
backward-lines: Private ordinary functions

C
config: Public ordinary functions
config-animation: Private ordinary functions
config-bar-string: Private ordinary functions
config-indent: Private ordinary functions
config-space-string: Private ordinary functions
copy-tqdmbar: Private ordinary functions
copy-tqdmconfig: Private ordinary functions

F
Function, (setf config-animation): Private ordinary functions
Function, (setf config-bar-string): Private ordinary functions
Function, (setf config-indent): Private ordinary functions
Function, (setf config-space-string): Private ordinary functions
Function, (setf tqdm-call-timestamps): Private ordinary functions
Function, (setf tqdm-count-idx): Private ordinary functions
Function, (setf tqdm-creation-time): Private ordinary functions
Function, (setf tqdm-description): Private ordinary functions
Function, (setf tqdm-identifier): Private ordinary functions
Function, (setf tqdm-total-count): Private ordinary functions
Function, backward-lines: Private ordinary functions
Function, config: Public ordinary functions
Function, config-animation: Private ordinary functions
Function, config-bar-string: Private ordinary functions
Function, config-indent: Private ordinary functions
Function, config-space-string: Private ordinary functions
Function, copy-tqdmbar: Private ordinary functions
Function, copy-tqdmconfig: Private ordinary functions
Function, progress-percent: Private ordinary functions
Function, render: Private ordinary functions
Function, render-progress-bar: Private ordinary functions
Function, tqdm: Public ordinary functions
Function, tqdm-call-timestamps: Private ordinary functions
Function, tqdm-count-idx: Private ordinary functions
Function, tqdm-creation-time: Private ordinary functions
Function, tqdm-description: Private ordinary functions
Function, tqdm-identifier: Private ordinary functions
Function, tqdm-total-count: Private ordinary functions
Function, tqdmbar-p: Private ordinary functions
Function, tqdmconfig-p: Private ordinary functions
Function, update: Public ordinary functions

M
Macro, with-config: Public macros
Macro, with-no-animation: Public macros
Macro, with-tqdm: Public macros
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
print-object: Public standalone methods
print-object: Public standalone methods
progress-percent: Private ordinary functions

R
render: Private ordinary functions
render-progress-bar: Private ordinary functions

T
tqdm: Public ordinary functions
tqdm-call-timestamps: Private ordinary functions
tqdm-count-idx: Private ordinary functions
tqdm-creation-time: Private ordinary functions
tqdm-description: Private ordinary functions
tqdm-identifier: Private ordinary functions
tqdm-total-count: Private ordinary functions
tqdmbar-p: Private ordinary functions
tqdmconfig-p: Private ordinary functions

U
update: Public ordinary functions

W
with-config: Public macros
with-no-animation: Public macros
with-tqdm: Public macros