This is the progressons Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:20:48 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
progressonsDisplay a progress bar on one line.
vindarel
MIT
0.1
str (system).
cl-ansi-text (system).
packages.lisp (file).
utils.lisp (file).
termp.lisp (file).
progressons.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
progressons/progressons.asdprogressons/packages.lispprogressons/utils.lispprogressons/termp.lispprogressons/progressons.lispprogressons/progressons.lispprogressons (system).
initialize-instance (method).
make-progress (function).
print-object (method).
progressbar (function).
step! (function).
*progress* (special variable).
*rainbow-steps* (special variable).
current-percent (method).
current-width (method).
default-fill-character (reader method).
(setf default-fill-character) (writer method).
make-string-with-random-color (function).
percent-width (reader method).
(setf percent-width) (writer method).
print-opening (method).
print-rainbow-step (method).
print-step (method).
print-step-dumb (method).
progress (function).
progress (class).
progress-data (reader method).
(setf progress-data) (writer method).
progress-fill-character (reader method).
(setf progress-fill-character) (writer method).
progress-finished (reader method).
(setf progress-finished) (writer method).
progress-length (method).
progress-percent (method).
progress-rainbow (reader method).
(setf progress-rainbow) (writer method).
progress-width (reader method).
(setf progress-width) (writer method).
reinit (method).
step-length (function).
step-width (reader method).
(setf step-width) (writer method).
steps-counter (reader method).
(setf steps-counter) (writer method).
Packages are listed by definition order.
progressonscommon-lisp.
make-progress (function).
progressbar (function).
step! (function).
*progress* (special variable).
*rainbow-steps* (special variable).
*termp* (special variable).
*tty-p* (special variable).
current-percent (generic function).
current-width (generic function).
default-fill-character (generic reader).
(setf default-fill-character) (generic writer).
make-string-with-random-color (function).
percent-width (generic reader).
(setf percent-width) (generic writer).
print-opening (generic function).
print-rainbow-step (generic function).
print-step (generic function).
print-step-dumb (generic function).
progress (function).
progress (class).
progress-data (generic reader).
(setf progress-data) (generic writer).
progress-fill-character (generic reader).
(setf progress-fill-character) (generic writer).
progress-finished (generic reader).
(setf progress-finished) (generic writer).
progress-length (generic function).
progress-percent (generic function).
progress-rainbow (generic reader).
(setf progress-rainbow) (generic writer).
progress-width (generic reader).
(setf progress-width) (generic writer).
quit (function).
reinit (generic function).
step-length (function).
step-width (generic reader).
(setf step-width) (generic writer).
steps-counter (generic reader).
(setf steps-counter) (generic writer).
termp (function).
tty-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A more manual way to create a progressbar than ‘progressbar’.
DATA can be a sequence or an integer.
Create a progress bar with this data. Return the data, so we can iterate over it.
At the end of each iteration, you must call (step!) to print the progress.
If ‘rainbow’ is non-nil, print the steps in a random color.
Increment and print the bar.
the current progress bar.
If non-nil, print each step character in a random color.
You should rather create a progressbar with this preference enabled:
(progressbar :rainbow t)
Return a string with a random color (amongst the 8 basic ones).
Only works on the terminal.
If we are in a real terminal, really quit. Otherwise, error out.
Return the length (integer) of the new step string.
Return T if we run on a terminal.
This must fail on Slime (on Emacs’ default shell prompt) and succeed on a Lisp in a terminal window.
Return T if we run on a terminal.
This must fail on Slime (on Emacs’ default shell prompt) and succeed on a Lisp in a terminal window.
progress) &key stream) ¶Print the progress step in a dumb terminal (like Emacs Slime).
We can’t erase a line (it prints the ^M character instead), so we can’t update
the percentage and the ratio of done items. We print progress indicators in a row,
one after the other, and we print the percent in the end.
current-percent.
current-width.
(setf default-fill-character).
default-fill-character.
initialize-instance.
(setf percent-width).
percent-width.
print-object.
print-opening.
print-rainbow-step.
print-step.
print-step-dumb.
(setf progress-data).
progress-data.
(setf progress-fill-character).
progress-fill-character.
progress-finished.
(setf progress-finished).
progress-length.
progress-percent.
(setf progress-rainbow).
progress-rainbow.
(setf progress-width).
progress-width.
reinit.
(setf step-width).
step-width.
(setf steps-counter).
steps-counter.
:data
Screen width.
80
length (width, characters count) of each step to print.
The percent to increment each step.
A counter to increment each time we increase the bar.
0
Boolean. T after 100% of completion.
#\full_block
:fill-character
:class
#\full_block
If non-nil, print each step in a different color. It uses the dumb print method (it doesn’t update the progress percent at the beginning of the line).
:rainbow
| Jump to: | (
C D F G I M P Q R S T |
|---|
| Jump to: | (
C D F G I M P Q R S T |
|---|
| Jump to: | *
D F P R S W |
|---|
| Jump to: | *
D F P R S W |
|---|
| Jump to: | C F P S T U |
|---|
| Jump to: | C F P S T U |
|---|