This is the cl-progress-bar Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:21:33 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-progress-bar
Display progress bars directly in REPL.
Marek Kochanowicz
Marek Kochanowicz
MIT
bordeaux-threads
(system).
documentation-utils-extensions
(system).
package.lisp
(file).
progress.lisp
(file).
control.lisp
(file).
docstrings.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-progress-bar/cl-progress-bar.asd
cl-progress-bar/package.lisp
cl-progress-bar/progress.lisp
cl-progress-bar/control.lisp
cl-progress-bar/docstrings.lisp
cl-progress-bar/cl-progress-bar.asd
cl-progress-bar
(system).
cl-progress-bar/progress.lisp
package.lisp
(file).
cl-progress-bar
(system).
finish-display
(generic function).
mutex
(reader method).
progress-bar
(class).
start-display
(generic function).
uncertain-size-progress-bar
(class).
update-progress
(generic function).
*uncertain-progress-chars*
(special variable).
+seconds-in-one-hour+
(constant).
+seconds-in-one-minute+
(constant).
character-count
(reader method).
(setf character-count)
(writer method).
characters-so-far
(reader method).
(setf characters-so-far)
(writer method).
elapsed-time
(generic function).
end-time
(reader method).
(setf end-time)
(writer method).
last-update-time
(reader method).
(setf last-update-time)
(writer method).
pending
(reader method).
(setf pending)
(writer method).
progress
(reader method).
(setf progress)
(writer method).
progress-char-index
(reader method).
(setf progress-char-index)
(writer method).
progress-character
(method).
progress-character
(reader method).
(setf progress-character)
(writer method).
start-time
(reader method).
(setf start-time)
(writer method).
time-in-seconds-minutes-hours
(function).
total
(reader method).
(setf total)
(writer method).
units-per-char
(reader method).
(setf units-per-char)
(writer method).
units-per-second
(generic function).
update-display
(generic function).
update-interval
(reader method).
(setf update-interval)
(writer method).
cl-progress-bar/control.lisp
progress.lisp
(file).
cl-progress-bar
(system).
*progress-bar*
(special variable).
*progress-bar-enabled*
(special variable).
update
(function).
with-progress-bar
(macro).
make-progress-bar
(function).
cl-progress-bar/docstrings.lisp
control.lisp
(file).
cl-progress-bar
(system).
Packages are listed by definition order.
cl-progress-bar.progress
common-lisp
.
finish-display
(generic function).
mutex
(generic reader).
progress-bar
(class).
start-display
(generic function).
uncertain-size-progress-bar
(class).
update-progress
(generic function).
*uncertain-progress-chars*
(special variable).
+seconds-in-one-hour+
(constant).
+seconds-in-one-minute+
(constant).
character-count
(generic reader).
(setf character-count)
(generic writer).
characters-so-far
(generic reader).
(setf characters-so-far)
(generic writer).
elapsed-time
(generic function).
end-time
(generic reader).
(setf end-time)
(generic writer).
last-update-time
(generic reader).
(setf last-update-time)
(generic writer).
pending
(generic reader).
(setf pending)
(generic writer).
progress
(generic reader).
(setf progress)
(generic writer).
progress-char-index
(generic reader).
(setf progress-char-index)
(generic writer).
progress-character
(generic function).
(setf progress-character)
(generic writer).
start-time
(generic reader).
(setf start-time)
(generic writer).
time-in-seconds-minutes-hours
(function).
total
(generic reader).
(setf total)
(generic writer).
units-per-char
(generic reader).
(setf units-per-char)
(generic writer).
units-per-second
(generic function).
update-display
(generic function).
update-interval
(generic reader).
(setf update-interval)
(generic writer).
cl-progress-bar
common-lisp
.
*progress-bar*
(special variable).
*progress-bar-enabled*
(special variable).
update
(function).
with-progress-bar
(macro).
make-progress-bar
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Description:
Current progress bar or NIL if there is no progress bar active. Should not be manipulated manually.
Description:
Boolean. T if progress bar should be outputed.
Description:
Macro. Build active progress bar. Requires size and description that will be printed out to the REPL. If *progress-bar-endabled* is nil or there is another progress bar active already progress bar will not be shown.
Notes:
Because with-progress-bar handles cases where another progress-bar is active it is generally safe to nest code with this macro on call stack. However, top level with-progress-bar should contain correct steps-count.
Description:
Notify progress bar about step completion.
Thread Safety:
This function is thread safe.
progress-bar
)) ¶Just a mutex, allows progress bar to be thread safe.
uncertain-size-progress-bar
) unit-count) ¶(setf character-count)
.
character-count
.
(setf characters-so-far)
.
characters-so-far
.
(setf end-time)
.
end-time
.
(setf last-update-time)
.
last-update-time
.
mutex
.
(setf pending)
.
pending
.
(setf progress)
.
progress
.
(setf progress-character)
.
progress-character
.
(setf start-time)
.
start-time
.
(setf total)
.
total
.
(setf update-interval)
.
update-interval
.
Initarg | Value |
---|---|
:mutex | (make-lock) |
:progress-character | = |
:character-count | 50 |
:characters-so-far | 0 |
:update-interval | (floor internal-time-units-per-second 4) |
:last-update-time | 0 |
:total | 0 |
:progress | 0 |
:pending | 0 |
:start-time
:end-time
:progress-character
How many characters wide is the progress bar?
:character-count
:characters-so-far
Update the progress bar display after this many internal-time units.
:update-interval
The display was last updated at this time.
:last-update-time
The total number of units tracked by this progress bar.
:total
How far in the progress are we?
:progress
Just a mutex, allows progress bar to be thread safe.
:mutex
This slot is read-only.
How many raw units should be tracked in the next display update?
:pending
Initarg | Value |
---|---|
:total | 0 |
:progress-char-index | 0 |
:units-per-char | (floor (expt 1024 2) 50) |
:progress-char-index
:units-per-char
progress-bar
)) ¶progress-bar
)) ¶How many characters wide is the progress bar?
progress-bar
)) ¶automatically generated reader method
progress-bar
)) ¶automatically generated writer method
progress-bar
)) ¶automatically generated reader method
progress-bar
)) ¶automatically generated writer method
progress-bar
)) ¶progress-bar
)) ¶The display was last updated at this time.
progress-bar
)) ¶progress-bar
)) ¶How many raw units should be tracked in the next display update?
progress-bar
)) ¶progress-bar
)) ¶How far in the progress are we?
uncertain-size-progress-bar
)) ¶automatically generated reader method
uncertain-size-progress-bar
)) ¶automatically generated writer method
uncertain-size-progress-bar
)) ¶progress-bar
)) ¶automatically generated reader method
progress-bar
)) ¶automatically generated writer method
progress-bar
)) ¶automatically generated reader method
progress-bar
)) ¶automatically generated writer method
progress-bar
)) ¶progress-bar
)) ¶The total number of units tracked by this progress bar.
uncertain-size-progress-bar
)) ¶automatically generated reader method
uncertain-size-progress-bar
)) ¶automatically generated writer method
uncertain-size-progress-bar
)) ¶progress-bar
)) ¶progress-bar
)) ¶Update the progress bar display after this many internal-time units.
Jump to: | (
C E F G L M P S T U W |
---|
Jump to: | (
C E F G L M P S T U W |
---|
Jump to: | *
+
C E L M P S T U |
---|
Jump to: | *
+
C E L M P S T U |
---|
Jump to: | C D F P S U |
---|
Jump to: | C D F P S U |
---|