The ABSTRACT-CLASS class.
This is the meta-class for abstract classes.
util.lisp (file)
standard-class (class)
validate-superclass (method)
validate-superclass (method)
make-instance (method)
The CONTAINER class.
This class is a mixin used in synopsis and groups to represent the program’s
command-line hierarchy.
container.lisp (file)
item (class)
mapoptions (method)
initialize-instance (method)
initialize-instance (method)
help-spec (method)
check-name-clash (method)
check-name-clash (method)
check-name-clash (method)
untraverse (method)
items (method)
The CONTEXT class.
This class represents the associatiion of a synopsis and a set of command-line
options based on it.
context.lisp (file)
standard-object (class)
initialize-instance (method)
untraverse (method)
mapoptions (method)
potential-pack-p (method)
clon-options-group (method)
negated-pack (method)
short-pack (method)
postfix (method)
error-handler (method)
highlight (method)
line-width (method)
theme (method)
search-path (method)
cmdline-options (method)
cmdline-options (method)
synopsis (method)
The program synopsis.
net.didierverna.clon::synopsis
:synopsis
net.didierverna.clon:*synopsis*
synopsis (generic function)
The program name as it appears on the command-line.
string
The options from the command-line.
list
cmdline-options (generic function)
(setf cmdline-options) (generic function)
The non-Clon part of the command-line.
list
The search path for Clon files.
search-path (generic function)
The line width for help display.
line-width (generic function)
The behavior to adopt on option retrieval errors.
symbol
:quit
error-handler (generic function)
| Initarg | Value |
|---|---|
:cmdline | (net.didierverna.clon:cmdline) |
The ENUM class.
This class implements options whose values belong to a set of keywords.
enum.lisp (file)
valued-option (class)
enum-base (class)
"type"
The ENUM-BASE abstract class.
This class provides support for options including enumerated values.
enum-base.lisp (file)
standard-object (class)
initialize-instance (method)
enum (method)
The FACE class.
face.lisp (file)
standard-object (class)
sface (class)
initialize-instance (method)
initialize-instance (method)
initialize-instance (method)
slot-unbound (method)
parent (method)
subfaces (method)
background (method)
foreground (method)
framedp (method)
crossed-out-p (method)
concealedp (method)
inversep (method)
blink (method)
underline (method)
italicp (method)
intensity (method)
item-separator (method)
bottom-padding (method)
top-padding (method)
right-padding (method)
left-padding (method)
visiblep (method)
name (method)
Whether the face is visible.
:visible
t
visiblep (generic function)
The face left padding.
This property can take the following forms:
- <NUMBER>: the padding is relative to the enclosing face,
- SELF: the padding is set to wherever the face happens to be opened,
- (<NUMBER> ABSOLUTE): the padding is set in absolute value,
- (<NUMBER> :RELATIVE-TO <FACE-NAME>): the padding is set relatively to a
parent face named FACE-NAME.
:padding-left
0
left-padding (generic function)
The face right padding.
This property can take the following forms:
- <NUMBER>: the padding is relative to the enclosing face,
- SELF: the padding is set to wherever the face happens to be closed,
- (<NUMBER> ABSOLUTE): the padding is set in absolute value,
- (<NUMBER> :RELATIVE-TO <FACE-NAME>): the padding is set relatively to a
parent face named FACE-NAME.
:padding-right
(quote net.didierverna.clon::self)
right-padding (generic function)
The face top padding.
This property can take the following forms:
- nil: the output can start right away,
- 0: the output should start on the next line,
- N>0: there should be N empty lines before the output.
:padding-top
top-padding (generic function)
The face bottom padding.
This property can take the following forms:
- nil: the next output can start right at the end of this face’s,
- 0: the next output should start on the next line,
- N>0: there should be N empty lines before the next output.
:padding-bottom
bottom-padding (generic function)
The face item separator.
:item-separator
#\
item-separator (generic function)
The face’s underline level.
:underline
underline (generic function)
The face’s inverse video status.
:inverse
inversep (generic function)
The face’s concealed status.
:concealed
concealedp (generic function)
The face’s crossed out status.
:crossed-out
crossed-out-p (generic function)
The face foreground.
:foreground
foreground (generic function)
The face background.
:background
background (generic function)
The FLAG class.
This class implements options that don’t take any argument.
flag.lisp (file)
option (class)
retrieve-from-environment (method)
The GROUP class.
This class groups other groups, options or strings together, effectively
implementing hierarchical program command-line.
group.lisp (file)
container (class)
The ITEM class.
This class is the base class for all synopsis items.
item.lisp (file)
standard-object (class)
mapoptions (method)
help-spec (method)
untraverse (method)
hiddenp (method)
traversedp (method)
traversedp (method)
The item’s traversal state.
traversedp (generic function)
(setf traversedp) (generic function)
Whether the item is hidden in help strings.
:hidden
hiddenp (generic function)
The LISPOBJ class.
This class implements read-from-string options.
lispobj.lisp (file)
valued-option (class)
"obj"
The NEGATABLE Class.
This class implements the negated syntax for the switch-based hierarchy.
negatable.lisp (file)
standard-object (class)
switch-base (class)
retrieve-from-negated-call (method)
negated-pack-char (method)
short-syntax-help-spec-prefix (method)
The OPTION class.
This is the base class for all options.
option.lisp (file)
item (class)
flag (class)
valued-option (class)
mapoptions (method)
retrieve-from-negated-call (method)
retrieve-from-short-call (method)
retrieve-from-long-call (method)
initialize-instance (method)
initialize-instance (method)
negated-pack-char (method)
short-pack-char (method)
option-sticky-distance (method)
check-name-clash (method)
help-spec (method)
untraverse (method)
env-var (method)
description (method)
long-name (method)
short-name (method)
The option’s short name.
(or null string)
:short-name
short-name (generic function)
The option’s long name.
(or null string)
:long-name
long-name (generic function)
The option’s description.
(or null string)
:description
description (generic function)
| Initarg | Value |
|---|---|
:internal | nil |
The PATH class.
This class implements options whose values are (colon-separated lists of)
pathnames.
path.lisp (file)
valued-option (class)
"path"
The SFACE class.
An SFace is the association of a face and its raw sibling. The sibling is used
to create subfaces which would be missing from the original, user defined one.
sheet.lisp (file)
face (class)
sibling (method)
The SHEET class.
This class implements the notion of sheet for printing Clon help.
sheet.lisp (file)
standard-object (class)
initialize-instance (method)
initialize-instance (method)
frames (method)
frames (method)
column (method)
column (method)
sface-tree (method)
highlightp (method)
line-width (method)
output-stream (method)
The sheet’s output stream.
stream
:output-stream
output-stream (generic function)
The sheet’s line width.
(integer 1)
:line-width
line-width (generic function)
Whether to highlight SHEET’s output.
:highlightp
highlightp (generic function)
The sheet’s sface tree.
sface-tree (generic function)
The sheet’s current column.
(integer 0)
0
column (generic function)
(setf column) (generic function)
The stack of currently open frames.
list
frames (generic function)
(setf frames) (generic function)
The STROPT class.
This class implements options the values of which are strings.
stropt.lisp (file)
valued-option (class)
"str"
The SWITCH class.
This class implements boolean options.
switch.lisp (file)
valued-option (class)
switch-base (class)
The SWITCH-BASE abstract class.
This class provides support for options including boolean values.
switch-base.lisp (file)
negatable (class)
initialize-instance (method)
initialize-instance (method)
argument-style (method)
no-values (method)
no-values (method)
yes-values (method)
yes-values (method)
argument-styles (method)
argument-styles (method)
The possible argument styles.
The position of every argument style in the list must correspond to the
position of the associated strings in the yes-values and no-values slots.
list
:argument-styles
argument-styles (generic function)
(setf argument-styles) (generic function)
The possible ’yes’ values.
list
:yes-values
yes-values (generic function)
(setf yes-values) (generic function)
The possible ’no’ values.
list
:no-values
no-values (generic function)
(setf no-values) (generic function)
The selected argument style.
keyword
:argument-style
:yes/no
argument-style (generic function)
| Initarg | Value |
|---|---|
:argument-type | :optional |
:argument-styles | (quote (:yes/no :on/off :true/false :yup/nope :yeah/nah)) |
:yes-values | (quote ("yes" "on" "true" "yup" "yeah")) |
:no-values | (quote ("no" "off" "false" "nope" "nah")) |
The SYNOPSIS class.
This class handles the description of the program’s command-line options.
synopsis.lisp (file)
container (class)
initialize-instance (method)
initialize-instance (method)
potential-pack-p (method)
help-spec (method)
clon-options-group (method)
potential-pack (method)
negated-pack (method)
short-pack (method)
postfix (method)
A postfix to the program synopsis.
(or null string)
:postfix
postfix (generic function)
The short pack string.
(or null string)
short-pack (generic function)
The negated pack string.
(or null string)
negated-pack (generic function)
The potential pack string.
(or null string)
potential-pack (generic function)
The Clon options group.
net.didierverna.clon::group
:clon-options-group
clon-options-group (generic function)
The TEXT class.
This class implements plain text objects appearing in a synopsis.
text.lisp (file)
item (class)
check-name-clash (method)
check-name-clash (method)
help-spec (method)
untraverse (method)
contents (method)
The VALUED-OPTION class.
This is the base class for options accepting arguments.
valued.lisp (file)
option (class)
retrieve-from-environment (method)
retrieve-from-negated-call (method)
retrieve-from-short-call (method)
retrieve-from-long-call (method)
initialize-instance (method)
initialize-instance (method)
help-spec (method)
short-syntax-help-spec-prefix (method)
short-pack-char (method)
option-sticky-distance (method)
default-value (method)
fallback-value (method)
argument-required-p (method)
argument-name (method)
The option’s argument display name.
:argument-name
"arg"
argument-name (generic function)
Whether the option’s argument is required.
argument-required-p (generic function)
The option’s fallback value.
:fallback-value
fallback-value (generic function)
The option’s default value.
:default-value
default-value (generic function)
| Initarg | Value |
|---|---|
:argument-type | :required |
The XSWITCH class.
This class merges the functionalities of switches and enumerations.
As such, the negated syntax is available for extended xswitches.
xswitch.lisp (file)
valued-option (class)
enum-base (class)
switch-base (class)
The set of possible non-boolean values.