---

6.2.5 Generic functions

Generic Function: argument CONDITION ¶

Package

net.didierverna.clon

Methods

Method: argument (CONDITION unknown-cmdline-option-error) ¶

Source

context.lisp (file)

Method: argument (CONDITION spurious-cmdline-argument) ¶

Source

cmdline.lisp (file)

Method: argument (CONDITION invalid-argument) ¶

Source

valued.lisp (file)

Generic Function: argument-name OBJECT ¶

Package

net.didierverna.clon

Methods

Method: argument-name (VALUED-OPTION valued-option) ¶

The option’s argument display name.

Source

valued.lisp (file)

Generic Function: argument-required-p OBJECT ¶

Package

net.didierverna.clon

Methods

Method: argument-required-p (VALUED-OPTION valued-option) ¶

Whether the option’s argument is required.

Source

valued.lisp (file)

Generic Function: argument-style OBJECT ¶

Package

net.didierverna.clon

Methods

Method: argument-style (SWITCH-BASE switch-base) ¶

The selected argument style.

Source

switch-base.lisp (file)

Generic Function: argument-styles OBJECT ¶

Generic Function: (setf argument-styles) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: argument-styles (SWITCH-BASE switch-base) ¶

Method: (setf argument-styles) NEW-VALUE (SWITCH-BASE switch-base) ¶

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.

Source

switch-base.lisp (file)

Generic Function: background OBJECT ¶

Package

net.didierverna.clon

Methods

Method: background (FACE face) ¶

The face background.

Source

face.lisp (file)

Generic Function: blink OBJECT ¶

Package

net.didierverna.clon

Methods

Method: blink (FACE face) ¶

The face’s blink speed.

Source

face.lisp (file)

Generic Function: bottom-padding OBJECT ¶

Package

net.didierverna.clon

Methods

Method: bottom-padding (FACE face) ¶

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.

Source

face.lisp (file)

Generic Function: check VALUED-OPTION VALUE ¶

Check that VALUE is valid for VALUED-OPTION.
If VALUE is valid, return it. Otherwise, raise an invalid-value error.

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods

Method: check (XSWITCH xswitch) VALUE ¶

Check that VALUE is valid for XSWITCH.

Source

xswitch.lisp (file)

Method: check (ENUM enum) VALUE ¶

Check that VALUE is valid for ENUM.

Source

enum.lisp (file)

Method: check (PATH path) VALUE ¶

Check that VALUE is valid for PATH.

Source

path.lisp (file)

Method: check (LISPOBJ lispobj) VALUE ¶

Check that VALUE is valid for LISPOBJ.

Source

lispobj.lisp (file)

Method: check (STROPT stropt) VALUE ¶

Check that VALUE is valid for STROPT.

Source

stropt.lisp (file)

Method: check (SWITCH switch) VALUE ¶

Check that VALUE is valid for SWITCH.

Source

switch.lisp (file)

Generic Function: check-name-clash ITEM1 ITEM2 ¶

Check for name clash between ITEM1’s options and ITEM2’s options.

Package

net.didierverna.clon

Source

option.lisp (file)

Methods

Method: check-name-clash (CONTAINER1 container) (CONTAINER2 container) ¶

Check for name clash between CONTAINER1’s options and CONTAINER2’s ones.

Source

container.lisp (file)

Method: check-name-clash ITEM1 (CONTAINER container) ¶

Check for name clash between ITEM1’s options and CONTAINER’s ones.

Source

container.lisp (file)

Method: check-name-clash (CONTAINER container) ITEM2 ¶

Check for name clash between CONTAINER’s options and ITEM2’s ones.

Source

container.lisp (file)

Method: check-name-clash ITEM1 (TEXT text) ¶

Do nothing (no name clash with a text object.

Method: check-name-clash (TEXT text) ITEM2 ¶

Do nothing (no name clash with a text object.

Method: check-name-clash (OPTION1 option) (OPTION2 option) ¶

Ensure that there is no name clash between OPTION1 and OPTION2.

Generic Function: clon-options-group OBJECT ¶

Package

net.didierverna.clon

Methods

Method: clon-options-group (CONTEXT context) ¶

Return the Clon options group of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: clon-options-group (SYNOPSIS synopsis) ¶

The Clon options group.

Source

synopsis.lisp (file)

Generic Function: close-frame SHEET FRAME ¶

Close FRAME on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods

Method: close-frame SHEET (FRAME frame) &aux RIGHT-MARGIN progn ¶

Reach FRAME’s right margin if it has one.

Method: close-frame SHEET (FRAME highlight-frame) progn ¶

Restore the upper frame’s highlight properties.

Generic Function: cmdline-options OBJECT ¶

Generic Function: (setf cmdline-options) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: cmdline-options (CONTEXT context) ¶

Method: (setf cmdline-options) NEW-VALUE (CONTEXT context) ¶

The options from the command-line.

Source

context.lisp (file)

Generic Function: column OBJECT ¶

Generic Function: (setf column) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: column (SHEET sheet) ¶

Method: (setf column) NEW-VALUE (SHEET sheet) ¶

The sheet’s current column.

Source

sheet.lisp (file)

Generic Function: comment CONDITION ¶

Package

net.didierverna.clon

Methods

Method: comment (CONDITION invalid-argument) ¶

Source

valued.lisp (file)

Method: comment (CONDITION invalid-value) ¶

Source

valued.lisp (file)

Generic Function: concealedp OBJECT ¶

Package

net.didierverna.clon

Methods

Method: concealedp (FACE face) ¶

The face’s concealed status.

Source

face.lisp (file)

Generic Function: contents OBJECT ¶

Package

net.didierverna.clon

Methods

Method: contents (TEXT text) ¶

The actual text string.

Source

text.lisp (file)

Generic Function: convert VALUED-OPTION ARGUMENT ¶

Convert ARGUMENT to VALUED-OPTION’s value.
If ARGUMENT is invalid, raise an invalid-argument error.

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods

Method: convert (XSWITCH xswitch) ARGUMENT ¶

Convert ARGUMENT to an XSWITCH value.

Source

xswitch.lisp (file)

Method: convert (ENUM enum) ARGUMENT ¶

Convert ARGUMENT to an ENUM value.

Source

enum.lisp (file)

Method: convert (PATH path) ARGUMENT ¶

Convert ARGUMENT to a PATH value.

Source

path.lisp (file)

Method: convert (LISPOBJ lispobj) ARGUMENT ¶

Convert ARGUMENT to a LISPOBJ value.

Source

lispobj.lisp (file)

Method: convert (STROPT stropt) ARGUMENT ¶

Convert ARGUMENT to an STROPT value.

Source

stropt.lisp (file)

Method: convert (SWITCH switch) ARGUMENT ¶

Convert ARGUMENT to a SWITCH value.

Source

switch.lisp (file)

Generic Function: copy-instance INSTANCE &optional SUBCLASS ¶

Return a copy of INSTANCE.
Copy is either an object of INSTANCE’s class, or INSTANCE’s SUBCLASS if given.

Package

net.didierverna.clon

Source

util.lisp (file)

Methods

Method: copy-instance INSTANCE &optional SUBCLASS ¶

Return a copy of INSTANCE.
Both instances share the same slot values.

Generic Function: crossed-out-p OBJECT ¶

Package

net.didierverna.clon

Methods

Method: crossed-out-p (FACE face) ¶

The face’s crossed out status.

Source

face.lisp (file)

Generic Function: default-value OBJECT ¶

Package

net.didierverna.clon

Methods

Method: default-value (VALUED-OPTION valued-option) ¶

The option’s default value.

Source

valued.lisp (file)

Generic Function: description OBJECT ¶

Package

net.didierverna.clon

Methods

Method: description (OPTION option) ¶

The option’s description.

Source

option.lisp (file)

Generic Function: enum OBJECT ¶

Package

net.didierverna.clon

Methods

Method: enum (ENUM-BASE enum-base) ¶

The set of possible values.

Source

enum-base.lisp (file)

Generic Function: env-val CONDITION ¶

Package

net.didierverna.clon

Methods

Method: env-val (CONDITION invalid-environment-value) ¶

Source

environ.lisp (file)

Generic Function: env-var OBJECT ¶

Package

net.didierverna.clon

Methods

Method: env-var (CONDITION environment-error) ¶

Source

environ.lisp (file)

Method: env-var (OPTION option) ¶

The option’s associated environment variable.

Source

option.lisp (file)

Generic Function: error-handler OBJECT ¶

Package

net.didierverna.clon

Methods

Method: error-handler (CONTEXT context) ¶

The behavior to adopt on option retrieval errors.

Source

context.lisp (file)

Generic Function: error-string CONDITION ¶

Generic Function: (setf error-string) NEW-VALUE CONDITION ¶

Package

net.didierverna.clon

Methods

Method: error-string (CONDITION home-directory) ¶

Method: (setf error-string) NEW-VALUE (CONDITION home-directory) ¶

Source

util.lisp (file)

Generic Function: fallback-value OBJECT ¶

Package

net.didierverna.clon

Methods

Method: fallback-value (VALUED-OPTION valued-option) ¶

The option’s fallback value.

Source

valued.lisp (file)

Generic Function: foreground OBJECT ¶

Package

net.didierverna.clon

Methods

Method: foreground (FACE face) ¶

The face foreground.

Source

face.lisp (file)

Generic Function: framedp OBJECT ¶

Package

net.didierverna.clon

Methods

Method: framedp (FACE face) ¶

The face’s framed status.

Source

face.lisp (file)

Generic Function: frames OBJECT ¶

Generic Function: (setf frames) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: frames (SHEET sheet) ¶

Method: (setf frames) NEW-VALUE (SHEET sheet) ¶

The stack of currently open frames.

Source

sheet.lisp (file)

Generic Function: get-bottom-padding SFACE HELP-SPEC ¶

Get HELP-SPEC’s bottom-padding under SFACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Methods

Method: get-bottom-padding SFACE HELP-SPEC ¶

Basic help specifications (chars, strings etc) don’t provide a bottom padding.

Method: get-bottom-padding SFACE (HELP-SPEC list) ¶

Return the bottom padding of HELP-SPEC’s face.

Generic Function: header OBJECT ¶

Package

net.didierverna.clon

Methods

Method: header (GROUP group) ¶

The group’s header.

Source

group.lisp (file)

Generic Function: help-spec ITEM &key PROGRAM UNHIDE &allow-other-keys ¶

Return ITEM’s help specification.

Package

net.didierverna.clon

Source

item.lisp (file)

Methods

Method: help-spec (SYNOPSIS synopsis) &key PROGRAM ¶

Return SYNOPSIS’s help specification.

Source

synopsis.lisp (file)

Method: help-spec (GROUP group) &key ¶

Return GROUP’s help specification.

Source

group.lisp (file)

Method: help-spec (CONTAINER container) &key ¶

Return CONTAINER’s help specification.

Source

container.lisp (file)

Method: help-spec (OPTION valued-option) &key ¶

Return OPTION’s help specification.

Source

valued.lisp (file)

Method: help-spec (OPTION option) &key ¶

Return OPTION’s help specification.

Source

option.lisp (file)

Method: help-spec (TEXT text) &key ¶

Return TEXT’s help specification.

Source

text.lisp (file)

Method: help-spec (ITEM item) &key UNHIDE around ¶

Call the actual method only when ITEM is not hidden or UNHIDE.

Generic Function: help-spec-will-print SFACE HELP-SPEC ¶

Return t if HELP-SPEC will print under FACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Methods

Method: help-spec-will-print SFACE HELP-SPEC before ¶

Method: help-spec-will-print SFACE HELP-SPEC ¶

Basic help specifications (chars, strings etc) do print.

Method: help-spec-will-print SFACE (HELP-SPEC list) ¶

Return t if HELP-SPEC’s items will print under HELP-SPEC’s face.

Generic Function: hiddenp OBJECT ¶

Package

net.didierverna.clon

Methods

Method: hiddenp (ITEM item) ¶

Whether the item is hidden in help strings.

Source

item.lisp (file)

Generic Function: highlight OBJECT ¶

Package

net.didierverna.clon

Methods

Method: highlight (CONTEXT context) ¶

Clon’s output highlight mode.

Source

context.lisp (file)

Generic Function: highlightp OBJECT ¶

Package

net.didierverna.clon

Methods

Method: highlightp (SHEET sheet) ¶

Whether to highlight SHEET’s output.

Source

sheet.lisp (file)

Generic Function: intensity OBJECT ¶

Package

net.didierverna.clon

Methods

Method: intensity (FACE face) ¶

The face intensity.

Source

face.lisp (file)

Generic Function: inversep OBJECT ¶

Package

net.didierverna.clon

Methods

Method: inversep (FACE face) ¶

The face’s inverse video status.

Source

face.lisp (file)

Generic Function: italicp OBJECT ¶

Package

net.didierverna.clon

Methods

Method: italicp (FACE face) ¶

The face’s italic status.

Source

face.lisp (file)

Generic Function: item CONDITION ¶

Package

net.didierverna.clon

Methods

Method: item (CONDITION cmdline-error) ¶

Source

cmdline.lisp (file)

Generic Function: item-separator OBJECT ¶

Package

net.didierverna.clon

Methods

Method: item-separator (FACE face) ¶

The face item separator.

Source

face.lisp (file)

Generic Function: items OBJECT ¶

Package

net.didierverna.clon

Methods

Method: items (CONTAINER container) ¶

The items in the container.

Source

container.lisp (file)

Generic Function: junk CONDITION ¶

Package

net.didierverna.clon

Methods

Method: junk (CONDITION cmdline-junk-error) ¶

Source

context.lisp (file)

Generic Function: left-padding OBJECT ¶

Package

net.didierverna.clon

Methods

Method: left-padding (FACE face) ¶

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.

Source

face.lisp (file)

Generic Function: line-width OBJECT ¶

Package

net.didierverna.clon

Methods

Method: line-width (CONTEXT context) ¶

The line width for help display.

Source

context.lisp (file)

Method: line-width (SHEET sheet) ¶

The sheet’s line width.

Source

sheet.lisp (file)

Generic Function: long-name OBJECT ¶

Package

net.didierverna.clon

Methods

Method: long-name (OPTION option) ¶

The option’s long name.

Source

option.lisp (file)

Generic Function: make-face-tree DEFINITION &optional FACE-CLASS ¶

Make a FACE-CLASS face tree from DEFINITION.

Package

net.didierverna.clon

Source

face.lisp (file)

Methods

Method: make-face-tree (DEFINITION list) &optional FACE-CLASS ¶

Make a FACE-CLASS face tree from a list of face name and initargs.

Method: make-face-tree (NAME symbol) &optional FACE-CLASS ¶

Create a face named NAME.

Generic Function: mapoptions FUNC THERE ¶

Map FUNC over all options in THERE.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

Methods

Method: mapoptions FUNC (CONTEXT context) ¶

Map FUNC over all options in CONTEXT synopsis.

Source

context.lisp (file)

Method: mapoptions FUNC ELSEWHERE ¶

Do nothing by default.

Method: mapoptions FUNC (ITEM item) after ¶

Mark TRAVERSABLE as traversed.

Method: mapoptions FUNC (CONTAINER container) ¶

Map FUNC over all containers or options in CONTAINER.

Method: mapoptions FUNC (OPTION option) ¶

Call FUNC on OPTION.

Generic Function: name CONDITION ¶

Package

net.didierverna.clon

Methods

Method: name (CONDITION unknown-cmdline-option-error) ¶

Source

context.lisp (file)

Method: name (FACE face) ¶

The face name.

Source

face.lisp (file)

Method: name (CONDITION cmdline-option-error) ¶

Source

cmdline.lisp (file)

Generic Function: negated-call CONDITION ¶

Package

net.didierverna.clon

Methods

Method: negated-call (CONDITION unrecognized-negated-call-error) ¶

Source

context.lisp (file)

Generic Function: negated-pack OBJECT ¶

Package

net.didierverna.clon

Methods

Method: negated-pack (CONTEXT context) ¶

Return the negated pack of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: negated-pack (SYNOPSIS synopsis) ¶

The negated pack string.

Source

synopsis.lisp (file)

Generic Function: negated-pack-char OPTION &optional AS-STRING ¶

Return OPTION’s negated pack character, if any. If AS-STRING, return a string of that character.

Package

net.didierverna.clon

Source

option.lisp (file)

Methods

Method: negated-pack-char (NEGATABLE negatable) &optional AS-STRING ¶

Return NEGATABLE’s negated pack character, if any.

Source

negatable.lisp (file)

Method: negated-pack-char (OPTION option) &optional AS-STRING ¶

Return nil (only the switch hierarchy is negated-pack’able).

Generic Function: no-values OBJECT ¶

Generic Function: (setf no-values) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: no-values (SWITCH-BASE switch-base) ¶

Method: (setf no-values) NEW-VALUE (SWITCH-BASE switch-base) ¶

The possible ’no’ values.

Source

switch-base.lisp (file)

Generic Function: open-frame SHEET FRAME ¶

Open FRAME on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods

Method: open-frame SHEET (FRAME frame) progn ¶

Reach the frame’s left margin.

Method: open-frame SHEET (FRAME highlight-frame) progn ¶

Reach the frame’s left margin and output its highlight properties.

Generic Function: option CONDITION ¶

Package

net.didierverna.clon

Methods

Method: option (CONDITION option-error) ¶

Source

option.lisp (file)

Generic Function: option-sticky-distance OPTION NAMEARG ¶

Try to match OPTION’s short name with a sticky argument against NAMEARG. If OPTION matches, return the length of OPTION’s short name; otherwise 0.

Package

net.didierverna.clon

Source

option.lisp (file)

Methods

Method: option-sticky-distance (OPTION valued-option) NAMEARG ¶

Try to match OPTION’s short name with a sticky argument against NAMEARG. If OPTION matches, return its short name’s length; otherwise 0.

Source

valued.lisp (file)

Method: option-sticky-distance (OPTION option) NAMEARG ¶

Return 0 (non-valued options don’t take any argument, sticky or not).

Generic Function: output-stream OBJECT ¶

Package

net.didierverna.clon

Methods

Method: output-stream (SHEET sheet) ¶

The sheet’s output stream.

Source

sheet.lisp (file)

Generic Function: parent OBJECT ¶

Package

net.didierverna.clon

Methods

Method: parent (FACE face) ¶

The face parent.

Source

face.lisp (file)

Generic Function: path-type OBJECT ¶

Package

net.didierverna.clon

Methods

Method: path-type (PATH path) ¶

The path type.

Source

path.lisp (file)

Generic Function: postfix OBJECT ¶

Package

net.didierverna.clon

Methods

Method: postfix (CONTEXT context) ¶

Return the postfix of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: postfix (SYNOPSIS synopsis) ¶

A postfix to the program synopsis.

Source

synopsis.lisp (file)

Generic Function: potential-pack OBJECT ¶

Package

net.didierverna.clon

Methods

Method: potential-pack (SYNOPSIS synopsis) ¶

The potential pack string.

Source

synopsis.lisp (file)

Generic Function: potential-pack-p PACK THERE ¶

Return t if PACK is a potential pack in THERE.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

Methods

Method: potential-pack-p PACK (CONTEXT context) ¶

Return t if PACK (a string) is a potential pack in CONTEXT.

Source

context.lisp (file)

Method: potential-pack-p PACK (SYNOPSIS synopsis) ¶

Return t if PACK is a potential pack for SYNOPSIS.

Generic Function: print-help-spec SHEET HELP-SPEC ¶

Print HELP-SPEC on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Methods

Method: print-help-spec SHEET HELP-SPEC before ¶

Method: print-help-spec SHEET (CHAR character) ¶

Print CHAR on SHEET with the current face.

Method: print-help-spec SHEET (CHAR-VECTOR simple-vector) ¶

Print CHAR-VECTOR on SHEET with the current face.

Method: print-help-spec SHEET (STRING string) ¶

Print STRING on SHEET with the current face.

Method: print-help-spec SHEET (HELP-SPEC list) ¶

Open HELP-SPEC’s face and print all of its items with it.

Generic Function: retrieve-from-environment OPTION ENV-VAL ¶

Retrieve OPTION’s value from the environment.
ENV-VAL is the value stored in the associated environment variable.

Package

net.didierverna.clon

Source

environ.lisp (file)

Methods

Method: retrieve-from-environment OPTION ENV-VAL before ¶

Assert that ENV-VAL is not null.

Method: retrieve-from-environment (FLAG flag) ENV-VAL ¶

Method: retrieve-from-environment (OPTION valued-option) ENV-VAL ¶

Generic Function: retrieve-from-long-call OPTION CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE ¶

Retrieve OPTION’s value from a long call.
CMDLINE-NAME is the name used on the command-line.
CMDLINE-ARGUMENT is a potentially already parsed cmdline argument. Otherwise, CMDLINE is where to find an argument.
This function returns three values:
- the retrieved value,
- the value source,
- the new command-line (possibly with the first item popped if the option requires an argument).

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods

Method: retrieve-from-long-call (OPTION option) CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE ¶

Method: retrieve-from-long-call (OPTION valued-option) CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE ¶

Generic Function: retrieve-from-negated-call OPTION ¶

Retrieve OPTION’s value from a negated call.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods

Method: retrieve-from-negated-call (OPTION option) ¶

Method: retrieve-from-negated-call (OPTION valued-option) ¶

Method: retrieve-from-negated-call (NEGATABLE negatable) ¶

Generic Function: retrieve-from-short-call OPTION &optional CMDLINE-ARGUMENT CMDLINE ¶

Retrieve OPTION’s value from a short call.
CMDLINE-ARGUMENT is a potentially already parsed cmdline argument. Otherwise, CMDLINE is where to find an argument.
This function returns three values:
- the retrieved value,
- the value source,
- the new command-line (possibly with the first item popped if the option requires an argument).

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods

Method: retrieve-from-short-call (OPTION option) &optional CMDLINE-ARGUMENT CMDLINE ¶

Method: retrieve-from-short-call (OPTION valued-option) &optional CMDLINE-ARGUMENT CMDLINE ¶

Generic Function: right-padding OBJECT ¶

Package

net.didierverna.clon

Methods

Method: right-padding (FACE face) ¶

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.

Source

face.lisp (file)

Generic Function: search-path OBJECT ¶

Package

net.didierverna.clon

Methods

Method: search-path (CONTEXT context) ¶

The search path for Clon files.

Source

context.lisp (file)

Generic Function: sface-tree OBJECT ¶

Package

net.didierverna.clon

Methods

Method: sface-tree (SHEET sheet) ¶

The sheet’s sface tree.

Source

sheet.lisp (file)

Generic Function: short-call CONDITION ¶

Package

net.didierverna.clon

Methods

Method: short-call (CONDITION unrecognized-short-call-error) ¶

Source

context.lisp (file)

Generic Function: short-name OBJECT ¶

Package

net.didierverna.clon

Methods

Method: short-name (OPTION option) ¶

The option’s short name.

Source

option.lisp (file)

Generic Function: short-pack OBJECT ¶

Package

net.didierverna.clon

Methods

Method: short-pack (CONTEXT context) ¶

Return the short pack of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: short-pack (SYNOPSIS synopsis) ¶

The short pack string.

Source

synopsis.lisp (file)

Generic Function: short-pack-char OPTION &optional AS-STRING ¶

Return OPTION’s short pack character, if any. If AS-STRING, return a string of that character.

Package

net.didierverna.clon

Source

option.lisp (file)

Methods

Method: short-pack-char (OPTION valued-option) &optional AS-STRING ¶

Return OPTION’s short pack character if OPTION’s argument is optional.

Source

valued.lisp (file)

Method: short-pack-char (OPTION option) &optional AS-STRING ¶

Return OPTION’s potential pack character.

Generic Function: short-syntax-help-spec-prefix OPTION ¶

Return the help specification prefix for OPTION’s short call.

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods

Method: short-syntax-help-spec-prefix (OPTION negatable) ¶

Source

negatable.lisp (file)

Method: short-syntax-help-spec-prefix (OPTION valued-option) ¶

Generic Function: sibling OBJECT ¶

Package

net.didierverna.clon

Methods

Method: sibling (SFACE sface) ¶

The SFace’s raw sibling.

Source

sheet.lisp (file)

Generic Function: stream-ioctl-output-handle STREAM ¶

Return STREAM’s ioctl output handle or NIL.

Package

net.didierverna.clon

Source

termio.lisp (file)

Methods

Method: stream-ioctl-output-handle (STREAM synonym-stream) ¶

Method: stream-ioctl-output-handle (STREAM two-way-stream) ¶

Method: stream-ioctl-output-handle (STREAM fd-stream) ¶

Method: stream-ioctl-output-handle STREAM ¶

Generic Function: stringify VALUED-OPTION VALUE ¶

Transform VALUED-OPTION’s VALUE into an argument. This is the opposite of argument conversion.

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods

Method: stringify (XSWITCH xswitch) VALUE ¶

Transform XSWITCH’s VALUE into an argument.

Source

xswitch.lisp (file)

Method: stringify (ENUM enum) VALUE ¶

Transform ENUM’s VALUE into an argument.

Source

enum.lisp (file)

Method: stringify (PATH path) VALUE ¶

Transform PATH’s VALUE into an argument.

Source

path.lisp (file)

Method: stringify (LISPOBJ lispobj) VALUE ¶

Transform LISPOBJ’s VALUE into an argument.

Source

lispobj.lisp (file)

Method: stringify (STROPT stropt) VALUE ¶

Transform STROPT’s VALUE into an argument.

Source

stropt.lisp (file)

Method: stringify (SWITCH switch) VALUE ¶

Transform SWITCH’s VALUE into an argument.

Source

switch.lisp (file)

Generic Function: subface FACE name(s) ¶

Return subface of FACE named NAME(S) or nil.
If a list of names is provided instead of a single one, follow a subface branch matching those names to find the leaf face.

Package

net.didierverna.clon

Source

face.lisp (file)

Methods

Method: subface FACE (NAME symbol) ¶

Return FACE’subface named NAME, or nil.

Method: subface FACE (NAMES list) &aux BRANCH ¶

Return the leaf face from FACE’subbranch matching NAMES, or nil.

Generic Function: subfaces OBJECT ¶

Package

net.didierverna.clon

Methods

Method: subfaces (FACE face) ¶

The face children.

Source

face.lisp (file)

Generic Function: synopsis OBJECT ¶

Package

net.didierverna.clon

Methods

Method: synopsis (CONTEXT context) ¶

The program synopsis.

Source

context.lisp (file)

Generic Function: theme OBJECT ¶

Package

net.didierverna.clon

Methods

Method: theme (CONTEXT context) ¶

The theme filename.

Source

context.lisp (file)

Generic Function: top-padding OBJECT ¶

Package

net.didierverna.clon

Methods

Method: top-padding (HELP-SPEC list) ¶

Source

sheet.lisp (file)

Method: top-padding OTHER ¶

Source

sheet.lisp (file)

Method: top-padding (FACE face) ¶

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.

Source

face.lisp (file)

Generic Function: traversedp OBJECT ¶

Generic Function: (setf traversedp) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: traversedp (ITEM item) ¶

Method: (setf traversedp) NEW-VALUE (ITEM item) ¶

The item’s traversal state.

Source

item.lisp (file)

Generic Function: typespec OBJECT ¶

Package

net.didierverna.clon

Methods

Method: typespec (LISPOBJ lispobj) ¶

A type specifier the option’s value should satisfy.

Source

lispobj.lisp (file)

Generic Function: underline OBJECT ¶

Package

net.didierverna.clon

Methods

Method: underline (FACE face) ¶

The face’s underline level.

Source

face.lisp (file)

Generic Function: untraverse ITEM ¶

Reset ITEM’s traversal state, and return ITEM.

Package

net.didierverna.clon

Source

item.lisp (file)

Methods

Method: untraverse (CONTEXT context) ¶

Untraverse CONTEXT synopsis.

Source

context.lisp (file)

Method: untraverse (CONTAINER container) ¶

Untraverse all CONTAINER items.

Source

container.lisp (file)

Method: untraverse (OPTION option) ¶

OPTION is a terminal object: just return it.

Source

option.lisp (file)

Method: untraverse (TEXT text) ¶

TEXT is a terminal object: just return it.

Source

text.lisp (file)

Method: untraverse (ITEM item) after ¶

Mark ITEM as untraversed.

Generic Function: value CONDITION ¶

Package

net.didierverna.clon

Methods

Method: value (CONDITION invalid-value) ¶

Source

valued.lisp (file)

Generic Function: visiblep OBJECT ¶

Package

net.didierverna.clon

Methods

Method: visiblep (FACE face) ¶

Whether the face is visible.

Source

face.lisp (file)

Generic Function: yes-values OBJECT ¶

Generic Function: (setf yes-values) NEW-VALUE OBJECT ¶

Package

net.didierverna.clon

Methods

Method: yes-values (SWITCH-BASE switch-base) ¶

Method: (setf yes-values) NEW-VALUE (SWITCH-BASE switch-base) ¶

The possible ’yes’ values.

Source

switch-base.lisp (file)