The cl-cram Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-cram Reference Manual

This is the cl-cram Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:41:50 2022 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 cl-cram

Author

hikettei

License

MIT

Description

A simple, Progress bar for Common Lisp

Source

cl-cram.asd (file)

Component

cl-cram.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-cram.asd

Location

cl-cram.asd

Systems

cl-cram (system)


Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-cram/cl-cram.lisp

Parent

cl-cram (system)

Location

cl-cram.lisp

Packages

cl-cram

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

3.1 cl-cram

Source

cl-cram.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *blank*
Package

cl-cram

Source

cl-cram.lisp (file)

Special Variable: *progress-bar-ascii*
Package

cl-cram

Source

cl-cram.lisp (file)

Special Variable: *progress-bar-enabled*
Package

cl-cram

Source

cl-cram.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Macros

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

cl-cram

Source

cl-cram.lisp (file)

Macro: init-progress-bar VAR DESC TOTAL
Package

cl-cram

Source

cl-cram.lisp (file)

Macro: pdolist (VAR LIST) &body BODY
Package

cl-cram

Source

cl-cram.lisp (file)

Macro: pdotimes (VAR COUNT) &body BODY
Package

cl-cram

Source

cl-cram.lisp (file)

Macro: pmap RESULT-TYPE FUNCTION FIRST-SEQUENCE
Package

cl-cram

Source

cl-cram.lisp (file)

Macro: with-progress-bar VAR DESC TOTAL &body BODY
Package

cl-cram

Source

cl-cram.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Functions

Function: update ()
Package

cl-cram

Source

cl-cram.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

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

cl-cram

Source

cl-cram.lisp (file)

Special Variable: *indent*
Package

cl-cram

Source

cl-cram.lisp (file)

Special Variable: *number-of-bar*
Package

cl-cram

Source

cl-cram.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: progress-percent STATUS
Package

cl-cram

Source

cl-cram.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Functions

Function: backward-lines ()
Package

cl-cram

Source

cl-cram.lisp (file)

Function: copy-progress-bar-status INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: make-progress-bar-status &key (TOTAL TOTAL) (COUNT COUNT) (DESC DESC) (DESC-LEN DESC-LEN) (START-TIME START-TIME) (NTH-BAR NTH-BAR)
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-count INSTANCE
Function: (setf pbar-count) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-desc INSTANCE
Function: (setf pbar-desc) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-desc-len INSTANCE
Function: (setf pbar-desc-len) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-nth-bar INSTANCE
Function: (setf pbar-nth-bar) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-start-time INSTANCE
Function: (setf pbar-start-time) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: pbar-total INSTANCE
Function: (setf pbar-total) VALUE INSTANCE
Package

cl-cram

Source

cl-cram.lisp (file)

Function: progress-bar OBJECT
Package

cl-cram

Source

cl-cram.lisp (file)

Function: render ()
Package

cl-cram

Source

cl-cram.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Structures

Structure: progress-bar-status ()
Package

cl-cram

Source

cl-cram.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: total
Type

fixnum

Readers

pbar-total (function)

Writers

(setf pbar-total) (function)

Slot: count
Type

fixnum

Initform

0

Readers

pbar-count (function)

Writers

(setf pbar-count) (function)

Slot: desc
Type

string

Initform

"prog"

Readers

pbar-desc (function)

Writers

(setf pbar-desc) (function)

Slot: desc-len
Type

fixnum

Readers

pbar-desc-len (function)

Writers

(setf pbar-desc-len) (function)

Slot: start-time
Type

fixnum

Readers

pbar-start-time (function)

Writers

(setf pbar-start-time) (function)

Slot: nth-bar
Type

fixnum

Readers

pbar-nth-bar (function)

Writers

(setf pbar-nth-bar) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

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

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

L
Lisp File, cl-cram.asd: The cl-cram․asd file
Lisp File, cl-cram/cl-cram.lisp: The cl-cram/cl-cram․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

(
(setf pbar-count): Internal functions
(setf pbar-desc): Internal functions
(setf pbar-desc-len): Internal functions
(setf pbar-nth-bar): Internal functions
(setf pbar-start-time): Internal functions
(setf pbar-total): Internal functions

B
backward-lines: Internal functions

C
copy-progress-bar-status: Internal functions

D
discard-all-progress-bar: Exported macros

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

I
init-progress-bar: Exported macros

M
Macro, discard-all-progress-bar: Exported macros
Macro, init-progress-bar: Exported macros
Macro, pdolist: Exported macros
Macro, pdotimes: Exported macros
Macro, pmap: Exported macros
Macro, progress-percent: Internal macros
Macro, with-progress-bar: Exported macros
make-progress-bar-status: Internal functions

P
pbar-count: Internal functions
pbar-desc: Internal functions
pbar-desc-len: Internal functions
pbar-nth-bar: Internal functions
pbar-start-time: Internal functions
pbar-total: Internal functions
pdolist: Exported macros
pdotimes: Exported macros
pmap: Exported macros
progress-bar: Internal functions
progress-percent: Internal macros

R
render: Internal functions

U
update: Exported functions

W
with-progress-bar: Exported macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   D   N   S   T  
Index Entry  Section

*
*all-of-progress-bars*: Internal special variables
*blank*: Exported special variables
*indent*: Internal special variables
*number-of-bar*: Internal special variables
*progress-bar-ascii*: Exported special variables
*progress-bar-enabled*: Exported special variables

C
count: Internal structures

D
desc: Internal structures
desc-len: Internal structures

N
nth-bar: Internal structures

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

T
total: Internal structures

Jump to:   *  
C   D   N   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-cram: The cl-cram system
cl-cram: The cl-cram package

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

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

Jump to:   C   P   S