The net.didierverna.clon Reference Manual

4.1.1 net.didierverna.clon/net.didierverna.clon.asd

Source

net.didierverna.clon.asd.

Parent Component

net.didierverna.clon (system).

ASDF Systems

net.didierverna.clon.

---

4.1.2 net.didierverna.clon.setup/termio/net.didierverna.clon.setup.asd

Source

net.didierverna.clon.setup.asd.

Parent Component

net.didierverna.clon.setup/termio (system).

ASDF Systems

• net.didierverna.clon.setup/termio.
• net.didierverna.clon.setup.

---

4.1.3 net.didierverna.clon.core/net.didierverna.clon.core.asd

Source

net.didierverna.clon.core.asd.

Parent Component

net.didierverna.clon.core (system).

ASDF Systems

net.didierverna.clon.core.

---

4.1.4 net.didierverna.clon.termio/net.didierverna.clon.termio.asd

Source

net.didierverna.clon.termio.asd.

Parent Component

net.didierverna.clon.termio (system).

ASDF Systems

net.didierverna.clon.termio.

---

4.1.5 net.didierverna.clon.setup/package.lisp

Source

net.didierverna.clon.setup.asd.

Parent Component

net.didierverna.clon.setup (system).

Packages

net.didierverna.clon.setup.

---

4.1.6 net.didierverna.clon.setup/src/configuration.lisp

Source

net.didierverna.clon.setup.asd.

Parent Component

src (module).

Public Interface

• configuration (function).
• configure (function).

Internals

*configuration* (special variable).

---

4.1.7 net.didierverna.clon.setup/src/readtable.lisp

Dependency

configuration.lisp (file).

Source

net.didierverna.clon.setup.asd.

Parent Component

src (module).

Internals

• clindent (function).
• defindent (macro).
• i-reader (function).
• ~-reader (function).

---

4.1.8 net.didierverna.clon.setup/src/version.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.clon.setup.asd.

Parent Component

src (module).

Public Interface

• *copyright-years* (special variable).
• *release-major-level* (special variable).
• *release-minor-level* (special variable).
• *release-name* (special variable).
• *release-status* (special variable).
• *release-status-level* (special variable).
• version (function).

Internals

• %version (function).
• release-status-number (function).

---

4.1.9 net.didierverna.clon.setup/src/termio.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.clon.setup.asd.

Parent Component

src (module).

Public Interface

setup-termio (function).

Internals

restrict-because (function).

---

4.1.10 net.didierverna.clon.core/package.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

net.didierverna.clon.core (system).

Packages

net.didierverna.clon.

Public Interface

nickname-package (function).

---

4.1.11 net.didierverna.clon.core/src/util.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

• *executablep* (special variable).
• cmdline (function).
• dump (macro).
• executablep (function).
• exit (function).
• make-instance (method).
• validate-superclass (method).
• validate-superclass (method).

Internals

• abstract-class (class).
• accumulate (macro).
• beginning-of-string-p (function).
• closest-match (function).
• complete-string (function).
• copy-instance (generic function).
• declare-valid-superclass (macro).
• defabstract (macro).
• econd (macro).
• endpush (macro).
• error-string (reader method).
• (setf error-string) (writer method).
• getenv (function).
• home-directory (function).
• home-directory (condition).
• list-to-string (function).
• macosp (function).
• maybe-push (macro).
• putenv (function).
• remove-keys (function).
• replace-in-keys (macro).
• replace-key (function).
• replace-keys (function).
• select-keys (function).

---

4.1.12 net.didierverna.clon.core/src/item.lisp

Dependency

util.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Internals

• help-spec (generic function).
• hiddenp (reader method).
• item (class).
• traversedp (reader method).
• (setf traversedp) (writer method).
• untraverse (generic function).

---

4.1.13 net.didierverna.clon.core/src/text.lisp

Dependency

item.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

make-text (function).

Internals

• contents (reader method).
• help-spec (method).
• make-internal-text (function).
• text (class).
• untraverse (method).

---

4.1.14 net.didierverna.clon.core/src/options/option.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).

Internals

• check-name-clash (generic function).
• description (reader method).
• env-var (reader method).
• help-spec (method).
• long-name (reader method).
• match-option (function).
• negated-pack-char (generic function).
• option (reader method).
• option (class).
• option-abbreviation-distance (function).
• option-error (condition).
• option-sticky-distance (generic function).
• potential-pack-char (function).
• short-name (reader method).
• short-pack-char (generic function).
• untraverse (method).

---

4.1.15 net.didierverna.clon.core/src/options/flag.lisp

Dependency

option.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-flag (function).

Internals

• flag (class).
• make-internal-flag (function).

---

4.1.16 net.didierverna.clon.core/src/options/valued.lisp

Dependency

option.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).

Internals

• *item-names* (special variable).
• argument (reader method).
• argument-name (reader method).
• argument-required-p (reader method).
• check (generic function).
• comment (reader method).
• comment (reader method).
• convert (generic function).
• default-value (reader method).
• defoption (macro).
• fallback-value (reader method).
• help-spec (method).
• invalid-argument (condition).
• invalid-value (condition).
• option-sticky-distance (method).
• read-argument (function).
• read-value (function).
• restartable-check (function).
• restartable-convert (function).
• short-pack-char (method).
• short-syntax-help-spec-prefix (generic function).
• stringify (generic function).
• value (reader method).
• valued-option (class).

---

4.1.17 net.didierverna.clon.core/src/options/negatable.lisp

Dependency

valued.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Internals

• negatable (class).
• negated-pack-char (method).
• short-syntax-help-spec-prefix (method).

---

4.1.18 net.didierverna.clon.core/src/options/switch-base.lisp

Dependency

negatable.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).

Internals

• argument-style (reader method).
• argument-styles (reader method).
• (setf argument-styles) (writer method).
• no-values (reader method).
• (setf no-values) (writer method).
• switch-base (class).
• yes-values (reader method).
• (setf yes-values) (writer method).

---

4.1.19 net.didierverna.clon.core/src/options/switch.lisp

Dependency

switch-base.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

• initialize-instance (method).
• make-switch (function).

Internals

• check (method).
• convert (method).
• make-internal-switch (function).
• stringify (method).
• switch (class).

---

4.1.20 net.didierverna.clon.core/src/options/stropt.lisp

Dependency

valued.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-stropt (function).

Internals

• check (method).
• convert (method).
• make-internal-stropt (function).
• stringify (method).
• stropt (class).

---

4.1.21 net.didierverna.clon.core/src/options/lispobj.lisp

Dependency

valued.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-lispobj (function).

Internals

• check (method).
• convert (method).
• lispobj (class).
• make-internal-lispobj (function).
• stringify (method).
• typespec (reader method).

---

4.1.22 net.didierverna.clon.core/src/options/path.lisp

Dependency

valued.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-path (function).

Internals

• check (method).
• convert (method).
• directory-pathname-p (function).
• make-internal-path (function).
• path (class).
• path-type (reader method).
• pathname-component-null-p (function).
• split-path (function).
• stringify (method).

---

4.1.23 net.didierverna.clon.core/src/options/enum-base.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

initialize-instance (method).

Internals

• enum (reader method).
• enum-base (class).

---

4.1.24 net.didierverna.clon.core/src/options/enum.lisp

Dependencies

• valued.lisp (file).
• enum-base.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-enum (function).

Internals

• check (method).
• convert (method).
• enum (class).
• make-internal-enum (function).
• stringify (method).

---

4.1.25 net.didierverna.clon.core/src/options/xswitch.lisp

Dependencies

• valued.lisp (file).
• switch-base.lisp (file).
• enum-base.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-xswitch (function).

Internals

• check (method).
• convert (method).
• make-internal-xswitch (function).
• stringify (method).
• xswitch (class).

---

4.1.26 net.didierverna.clon.core/src/container.lisp

Dependency

options (module).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).

Internals

• check-name-clash (method).
• check-name-clash (method).
• check-name-clash (method).
• container (class).
• help-spec (method).
• items (reader method).
• untraverse (method).

---

4.1.27 net.didierverna.clon.core/src/group.lisp

Dependency

container.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

• defgroup (macro).
• make-group (function).

Internals

• %defgroup (macro).
• group (class).
• header (reader method).
• help-spec (method).

---

4.1.28 net.didierverna.clon.core/src/retrieval/cmdline.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

retrieval (module).

Internals

• argument (reader method).
• argument-popable-p (function).
• cmdline-convert (function).
• cmdline-error (condition).
• cmdline-option-error (condition).
• invalid-cmdline-argument (condition).
• invalid-negated-syntax (condition).
• item (reader method).
• maybe-pop-argument (macro).
• missing-cmdline-argument (condition).
• name (reader method).
• option-call-p (function).
• restartable-cmdline-convert (function).
• restartable-invalid-negated-syntax-error (macro).
• restartable-spurious-cmdline-argument-error (macro).
• retrieve-from-long-call (generic function).
• retrieve-from-negated-call (generic function).
• retrieve-from-short-call (generic function).
• spurious-cmdline-argument (condition).

---

4.1.29 net.didierverna.clon.core/src/retrieval/environ.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

retrieval (module).

Internals

• env-val (reader method).
• env-var (reader method).
• environment-convert (function).
• environment-error (condition).
• environmental-option-error (condition).
• invalid-environment-value (condition).
• read-env-val (function).
• restartable-environment-convert (function).
• retrieve-from-environment (generic function).

---

4.1.30 net.didierverna.clon.core/src/synopsis.lisp

Dependency

group.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

• *synopsis* (special variable).
• defsynopsis (macro).
• initialize-instance (method).
• initialize-instance (method).
• make-synopsis (function).

Internals

• clon-options-group (reader method).
• do-options (macro).
• help-spec (method).
• mapoptions (generic function).
• negated-pack (reader method).
• postfix (reader method).
• potential-pack (reader method).
• potential-pack-p (generic function).
• short-pack (reader method).
• synopsis (class).

---

4.1.31 net.didierverna.clon.core/src/output/face.lisp

Source

net.didierverna.clon.core.asd.

Parent Component

output (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• slot-unbound (method).

Internals

• *highlight-properties* (special variable).
• add-subface (function).
• attach-face-tree (function).
• background (reader method).
• blink (reader method).
• bottom-padding (reader method).
• concealedp (reader method).
• crossed-out-p (reader method).
• face (class).
• face-highlight-property-set-p (function).
• face-highlight-property-value (function).
• foreground (reader method).
• framedp (reader method).
• intensity (reader method).
• inversep (reader method).
• italicp (reader method).
• item-separator (reader method).
• left-padding (reader method).
• make-face-tree (generic function).
• make-raw-face-tree (function).
• name (reader method).
• parent (reader method).
• parent-generation (function).
• right-padding (reader method).
• search-branch (function).
• search-face (function).
• subface (generic function).
• subfaces (reader method).
• top-padding (reader method).
• underline (reader method).
• visiblep (reader method).

---

4.1.32 net.didierverna.clon.core/src/output/sheet.lisp

Dependency

face.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

output (module).

Public Interface

• initialize-instance (method).
• initialize-instance (method).

Internals

• available-right-margin (function).
• close-frame (generic function).
• close-line (function).
• close-sface (function).
• column (reader method).
• (setf column) (writer method).
• copy-frame (function).
• copy-highlight-frame (function).
• copy-highlight-property-instance (function).
• current-frame (function).
• current-left-margin (function).
• current-right-margin (function).
• current-sface (function).
• find-sface (function).
• flush-sheet (function).
• frame (structure).
• frame-left-margin (reader).
• (setf frame-left-margin) (writer).
• frame-p (function).
• frame-right-margin (reader).
• (setf frame-right-margin) (writer).
• frame-sface (reader).
• (setf frame-sface) (writer).
• frames (reader method).
• (setf frames) (writer method).
• get-bottom-padding (generic function).
• get-top-padding (function).
• help-spec-items-will-print (function).
• help-spec-will-print (generic function).
• highlight-frame (structure).
• highlight-frame-highlight-property-instances (reader).
• (setf highlight-frame-highlight-property-instances) (writer).
• highlight-frame-left-margin (function).
• (setf highlight-frame-left-margin) (function).
• highlight-frame-p (function).
• highlight-frame-right-margin (function).
• (setf highlight-frame-right-margin) (function).
• highlight-frame-sface (function).
• (setf highlight-frame-sface) (function).
• highlight-property-ecase (macro).
• highlight-property-instance (structure).
• highlight-property-instance-escape-sequence (function).
• highlight-property-instance-name (reader).
• (setf highlight-property-instance-name) (writer).
• highlight-property-instance-p (function).
• highlight-property-instance-value (reader).
• (setf highlight-property-instance-value) (writer).
• highlightp (reader method).
• line-width (reader method).
• make-frame (function).
• make-highlight-frame (function).
• make-highlight-property-instance (function).
• make-raw-sface (function).
• make-sheet (function).
• map-frames (macro).
• open-frame (generic function).
• open-line (function).
• open-next-line (function).
• open-sface (function).
• output-stream (reader method).
• pop-frame (function).
• princ-char (function).
• princ-highlight-property-instances (function).
• princ-spaces (function).
• princ-string (function).
• print-faced-help-spec (function).
• print-help (function).
• print-help-spec (generic function).
• print-string (function).
• push-frame (function).
• reach-column (function).
• read-sface-tree (function).
• safe-left-margin (function).
• safe-right-margin (function).
• sface (class).
• sface-tree (reader method).
• sheet (class).
• sibling (reader method).
• top-padding (method).
• top-padding (method).
• try-read-sface-tree (function).
• try-read-theme (function).

---

4.1.33 net.didierverna.clon.core/src/context.lisp

Dependency

output (module).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Public Interface

• *context* (special variable).
• cmdline-options-p (function).
• cmdline-p (function).
• do-cmdline-options (macro).
• getopt (function).
• getopt-cmdline (function).
• help (function).
• initialize-instance (method).
• make-context (function).
• multiple-value-getopt-cmdline (macro).
• progname (function).
• remainder (function).
• with-context (macro).

Internals

• argument (reader method).
• clon-options-group (method).
• cmdline-junk-error (condition).
• cmdline-option (structure).
• cmdline-option-name (reader).
• (setf cmdline-option-name) (writer).
• cmdline-option-option (reader).
• (setf cmdline-option-option) (writer).
• cmdline-option-p (function).
• cmdline-option-source (reader).
• (setf cmdline-option-source) (writer).
• cmdline-option-value (reader).
• (setf cmdline-option-value) (writer).
• cmdline-options (reader method).
• (setf cmdline-options) (writer method).
• context (class).
• copy-cmdline-option (function).
• error-handler (reader method).
• exit-abnormally (function).
• highlight (reader method).
• invalid-negated-equal-syntax (condition).
• invalid-short-equal-syntax (condition).
• junk (reader method).
• line-width (reader method).
• make-cmdline-option (function).
• mapoptions (method).
• name (reader method).
• negated-call (reader method).
• negated-pack (method).
• postfix (method).
• potential-pack-p (method).
• print-error (function).
• read-call (function).
• read-long-name (function).
• restart-on-error (function).
• restartable-cmdline-junk-error (function).
• search-option (function).
• search-option-by-abbreviation (function).
• search-option-by-name (function).
• search-path (reader method).
• search-sticky-option (function).
• short-call (reader method).
• short-pack (method).
• synopsis (reader method).
• theme (reader method).
• unknown-cmdline-option-error (condition).
• unrecognized-negated-call-error (condition).
• unrecognized-short-call-error (condition).
• untraverse (method).
• with-context-error-handler (macro).

---

4.1.34 net.didierverna.clon.termio/sbcl/constants.lisp

Source

net.didierverna.clon.termio.asd.

Parent Component

net.didierverna.clon.termio (system).

---

4.1.35 net.didierverna.clon.termio/termio.lisp

Dependency

sbcl/constants.lisp (file).

Source

net.didierverna.clon.termio.asd.

Parent Component

net.didierverna.clon.termio (system).

Internals

• stream-ioctl-output-handle (generic function).
• stream-line-width (function).

---

6.1.1 Special variables

Special Variable: *context* ¶

The current context.

Package

net.didierverna.clon.

Source

context.lisp.

Special Variable: *copyright-years* ¶

A string denoting the copyright years for the whole project.

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *executablep* ¶

Whether the current Lisp image is a standalone executable.
This information is needed in several implementations to distinguish user options from implementation-specific ones on the command-line.

It is set automatically to T by the ‘dump’ function, which see.
If the image is dumped by ASDF’s program-op, this variable is ignored. In any other case, that is, when dumping via an implementation-specific function, it must be set manually to T just before dumping.

Package

net.didierverna.clon.

Source

util.lisp.

Special Variable: *release-major-level* ¶

The major level of this release.

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *release-minor-level* ¶

The minor level of this release.

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *release-name* ¶

The name of this release.
The general naming theme for Clon is "Great Jazz musicians".

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *release-status* ¶

The status of this release.

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *release-status-level* ¶

The status level of this release.

Package

net.didierverna.clon.setup.

Source

version.lisp.

Special Variable: *synopsis* ¶

The current synopsis.

Package

net.didierverna.clon.

Source

synopsis.lisp.

---

6.1.2 Macros

Macro: defgroup ((&rest keys &key header hidden) &body forms) ¶

Define a new group.
KEYS are initargs to MAKE-GROUP (currently, only :header).
Each form in FORMS will be treated as a new :item.
The CAR of each form is the name of the operation to perform: TEXT, GROUP, or an option class name. The rest are the arguments to the MAKE-<OP> function or the DEFGROUP macro.

Package

net.didierverna.clon.

Source

group.lisp.

Macro: defsynopsis ((&rest keys &key postfix make-default) &body forms) ¶

Define a new synopsis.

Package

net.didierverna.clon.

Source

synopsis.lisp.

Macro: do-cmdline-options ((option name value source &key context) &body body) ¶

Evaluate BODY over all command-line options in CONTEXT.
OPTION, NAME and VALUE are bound to each option’s object, name used on the command-line and retrieved value.

Package

net.didierverna.clon.

Source

context.lisp.

Macro: dump (name function &rest args) ¶

Dump a standalone executable named NAME starting with FUNCTION.
ARGS may be any arguments understood by the underlying implementation’s dumping facility. They will simply be passed along. Note that DUMP already passes some such arguments. Some of them are critical for the dumping facility (e.g. :executable) and cannot be overridden. Some others, however, will be if you provide them as well (e.g. :load-init-file).

Since executable dumping is not available in all supported implementations, this function behaves differently in some cases, as described below.

- ECL doesn’t create executables by dumping a Lisp image, but relies on having toplevel code to execute instead, so this macro simply expands to a call to FUNCTION. This also means that ARGS is unused.
- ABCL can’t dump executables at all because of the underlying Java implementation, so this macro expands to just (PROGN) but creates a Java class file with a main function that creates an interpreter, loads
the file in which this macro call appears and calls FUNCTION. This also means that ARGS is unused.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: multiple-value-getopt-cmdline ((option name value source &key context) &body body) ¶

Get the next command-line option in CONTEXT. and evaluate BODY. OPTION, NAME and VALUE are bound to the values returned by GETOPT-CMDLINE. BODY is executed only if there is a next command-line option.

Package

net.didierverna.clon.

Source

context.lisp.

Macro: with-context (context &body body) ¶

Execute BODY with *context* bound to CONTEXT.

Package

net.didierverna.clon.

Source

context.lisp.

---

6.1.3 Ordinary functions

Function: cmdline () ¶

Get the current application’s command-line.
This command-line is not supposed to contain any Lisp implementation specific option; only user-level ones. When a standalone executable is dumped, this is always the case. When used interactively, this depends on the underlying Lisp implementation. See appendix A.5 of the user manual for more information.

Package

net.didierverna.clon.

Source

util.lisp.

Function: cmdline-options-p (&key context) ¶

Return T if CONTEXT has any unprocessed options left.

Package

net.didierverna.clon.

Source

context.lisp.

Function: cmdline-p (&key context) ¶

Return T if CONTEXT has anything on its command-line.

Package

net.didierverna.clon.

Source

context.lisp.

Function: configuration (key) ¶

Return KEY’s value in the current Clon configuration.

Package

net.didierverna.clon.setup.

Source

configuration.lisp.

Function: configure (key value) ¶

Set KEY to VALUE in the current Clon configuration.

Package

net.didierverna.clon.setup.

Source

configuration.lisp.

Function: executablep () ¶

Return T if the current Lisp image is a standalone executable.
This function detects executables dumped by ASDF’s program-op operation, those dumped by Clon’s ‘dump’ function (which see), and those in which ‘*executablep*’ (which see) has been set to T manually.

Package

net.didierverna.clon.

Source

util.lisp.

Function: exit (&optional status) ¶

Quit the current application with STATUS.
This function is considered deprecated. Please use UIOP:QUIT instead.

Package

net.didierverna.clon.

Source

util.lisp.

Function: getopt (&rest keys &key context short-name long-name option) ¶

Get an option’s value in CONTEXT.
The option can be specified either by SHORT-NAME, LONG-NAME, or directly via an OPTION object.
Return two values:
- the retrieved value,
- the value’s source.

Package

net.didierverna.clon.

Source

context.lisp.

Function: getopt-cmdline (&key context) ¶

Get the next command-line option in CONTEXT.
When there is no next command-line option, return nil. Otherwise, return four values:
- the option object,
- the option’s name used on the command-line,
- the retrieved value,
- the value source.

Package

net.didierverna.clon.

Source

context.lisp.

Function: help (&key context item output-stream search-path theme line-width highlight) ¶

Print CONTEXT’s help.

Package

net.didierverna.clon.

Source

context.lisp.

Function: make-context (&rest keys &key synopsis cmdline progname make-current) ¶

Make a new context.
- SYNOPSIS is the program synopsis to use in that context.
It defaults to *SYNOPSIS*.
- CMDLINE is the argument list (strings) to process.
It defaults to a POSIX conformant argv.
- PROGNAME is an alternate value for argv[0].
It defaults to NIL, in which case the actual argv[0] is used. Otherwise, it can be a non-empty string, standing for itself,
or :environment meaning to retrieve the value of the __CL_ARGV0 environment variable (ignored if it’s empty).
value.
- If MAKE-CURRENT, make the new context current. This is the default.

Package

net.didierverna.clon.

Source

context.lisp.

Function: make-enum (&rest keys &key short-name long-name description argument-name argument-type enum env-var fallback-value default-value hidden) ¶

Make a new enum option.
- SHORT-NAME is the option’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the option’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the option’s description appearing in help strings.
It defaults to nil.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible values.
- ENV-VAR is the option’s associated environment variable.
It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

enum.lisp.

Function: make-flag (&rest keys &key short-name long-name description env-var hidden) ¶

Make a new flag.
- SHORT-NAME is the option’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the option’s long name (without the double-dash). It defaults to nil.
- DESCRIPTION is the option’s description appearing in help strings. It defaults to nil.
- ENV-VAR is the flag’s associated environment variable.
It defaults to nil.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

flag.lisp.

Function: make-group (&rest keys &key header item hidden) ¶

Make a new group.

Package

net.didierverna.clon.

Source

group.lisp.

Function: make-lispobj (&rest keys &key short-name long-name description argument-name argument-type env-var typespec fallback-value default-value hidden) ¶

Make a new lispobj option.
- SHORT-NAME is the option’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the option’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the option’s description appearing in help strings.
It defaults to nil.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable.
It defaults to nil.
- TYPESPEC is a type specifier the option’s value should satisfy.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

lispobj.lisp.

Function: make-path (&rest keys &key short-name long-name description argument-name argument-type env-var fallback-value default-value type hidden) ¶

Make a new path option.
- SHORT-NAME is the option’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the option’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the option’s description appearing in help strings.
It defaults to nil.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable.
It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- TYPE is the pathname type. It can be one of :file, :directory, :file-list, :directory-list or nil meaning that everything is allowed.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

path.lisp.

Function: make-stropt (&rest keys &key short-name long-name description argument-name argument-type env-var fallback-value default-value hidden) ¶

Make a new string option.
- SHORT-NAME is the option’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the option’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the option’s description appearing in help strings.
It defaults to nil.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable.
It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

stropt.lisp.

Function: make-switch (&rest keys &key short-name long-name description argument-style argument-type env-var default-value hidden) ¶

Make a new switch.
- SHORT-NAME is the switch’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the switch’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the switch’s description appearing in help strings.
It defaults to nil.
- ARGUMENT-STYLE is the switch’s argument display style. It can be one of :yes/no, :on/off, :true/false, :yup/nope or :yeah/nah.
It defaults to :yes/no.
- ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the switch’s associated environment variable.
It defaults to nil.
- DEFAULT-VALUE is the switch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

switch.lisp.

Function: make-synopsis (&rest keys &key postfix item make-default) ¶

Make a new SYNOPSIS.
- POSTFIX is a string to append to the program synopsis, in case it accepts a remainder.
- If MAKE-DEFAULT, make the new synopsis the default one.

Package

net.didierverna.clon.

Source

synopsis.lisp.

Function: make-text (&rest keys &key contents hidden) ¶

Make a new text.
- CONTENTS is the actual text to display.
- When HIDDEN, the text doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

text.lisp.

Function: make-xswitch (&rest keys &key short-name long-name description argument-name argument-type enum env-var default-value hidden) ¶

Make a new xswitch.
- SHORT-NAME is the xswitch’s short name (without the dash).
It defaults to nil.
- LONG-NAME is the xswitch’s long name (without the double-dash).
It defaults to nil.
- DESCRIPTION is the xswitch’s description appearing in help strings. It defaults to nil.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible non-boolean values.
- ENV-VAR is the xswitch’s associated environment variable.
It defaults to nil.
- DEFAULT-VALUE is the xswitch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

xswitch.lisp.

Function: nickname-package (&optional nickname) ¶

Add NICKNAME (:CLON by default) to the :NET.DIDIERVERNA.CLON package.

Package

net.didierverna.clon.

Source

package.lisp.

Function: progname (&key context) ¶

Return CONTEXT’s program name.

Package

net.didierverna.clon.

Source

context.lisp.

Function: remainder (&key context) ¶

Return CONTEXT’s remainder.

Package

net.didierverna.clon.

Source

context.lisp.

Function: setup-termio () ¶

Autodetect termio support.
Update Clon configuration and *FEATURES* accordingly.

Package

net.didierverna.clon.setup.

Source

termio.lisp.

Function: version (&optional type) ¶

Return the current version of Clon.
TYPE can be one of :number, :short or :long.

A version number is computed as major*10000 + minor*100 + patchlevel, leaving two digits for each level. Alpha, beta and rc status are ignored in version numbers.

A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel. Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored in the output, so that 1.3.0 appears as just 1.3.

A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "Michael Brecker". As for the short version, a patchlevel of 0 is ignored in the output.

Package

net.didierverna.clon.setup.

Source

version.lisp.

---

6.1.4 Standalone methods

Method: initialize-instance :after ((face face) &key) ¶

Fill in the parent slot of all subfaces.

Source

face.lisp.

Method: initialize-instance :before ((face face) &key name subfaces) ¶

Check for unicity of FACE subfaces.

Source

face.lisp.

Method: initialize-instance :around ((instance face) &rest keys &key face bold display hidden revealed) ¶

Canonicalize initialization arguments.
This involves:
- computing the :subfaces initarg from the :face ones, - handling convenience highlight properties.

Source

face.lisp.

Method: initialize-instance :before ((enum-base enum-base) &key enum) ¶

Source

enum-base.lisp.

Method: initialize-instance :after ((sheet sheet) &key theme search-path) ¶

Finish initialization of SHEET.
This involves:
- computing SHEET’s sface tree from THEME and SEARCH-PATH,
- initializing SHEET’s toplevel sface’s sibling to a raw face tree.

Source

sheet.lisp.

Method: initialize-instance :around ((sheet sheet) &rest keys &key output-stream line-width highlight) ¶

Handle unset line width and AUTO highlight according to OUTPUT-STREAM.

Source

sheet.lisp.

Method: initialize-instance :around ((switch-base switch-base) &rest keys &key argument-type) ¶

Provide a fallback value of t when ARGUMENT-TYPE is optional.

Source

switch-base.lisp.

Method: initialize-instance :before ((switch-base switch-base) &key argument-style argument-styles) ¶

Check for validity of the :ARGUMENT-STYLE initarg.

Source

switch-base.lisp.

Method: initialize-instance :after ((switch switch) &key) ¶

Provide an argument name conformant to the selected argument style.

Source

switch.lisp.

Method: initialize-instance :after ((context context) &key cmdline progname) ¶

Parse CMDLINE.

Source

context.lisp.

Method: initialize-instance :after ((option valued-option) &key argument-type fallback-value default-value) ¶

Compute uninitialized OPTION slots with indirect initargs.
This currently involves the conversion of the ARGUMENT-TYPE key to the ARGUMENT-REQUIRED-P slot.

Source

valued.lisp.

Method: initialize-instance :before ((option valued-option) &key argument-type fallback-value default-value) ¶

Check validity of the value-related initargs.

Source

valued.lisp.

Method: initialize-instance :around ((option option) &rest keys &key long-name env-var internal) ¶

If INTERNAL, prefix LONG-NAME with "clon-" and ENV-VAR with "CLON_".

Source

option.lisp.

Method: initialize-instance :before ((option option) &key short-name long-name description internal) ¶

Check validity of the name-related initargs.

Source

option.lisp.

Method: initialize-instance :after ((container container) &key) ¶

Perform name clash check on CONTAINER’s items.

Source

container.lisp.

Method: initialize-instance :around ((container container) &rest keys &key item) ¶

Canonicalize initialization arguments.
This involves:
- computing the :items initarg from the :item ones.

Source

container.lisp.

Method: initialize-instance :after ((synopsis synopsis) &key) ¶

Compute SYNOSPSIS’s short and negated packs.

Source

synopsis.lisp.

Method: initialize-instance :around ((synopsis synopsis) &rest keys) ¶

Prepare Clon specific options.

Source

synopsis.lisp.

Method: make-instance ((class abstract-class) &rest initargs) ¶

Source

util.lisp.

Method: slot-unbound (class (face face) slot) ¶

Look up SLOT’s value in FACE’s parent if it’s a highlight property. If FACE has no parent, return nil.
For other properties, trigger an error.

Source

face.lisp.

Method: validate-superclass ((class standard-class) (superclass abstract-class)) ¶

Package

sb-mop.

Source

util.lisp.

Method: validate-superclass ((class abstract-class) (superclass standard-class)) ¶

Package

sb-mop.

Source

util.lisp.

---

6.2.1 Special variables

Special Variable: *configuration* ¶

The Clon configuration settings.
This variable contains a property list of configuration options. Current options are:
- :swank-eval-in-emacs (Boolean)
- :restricted (Boolean)
- :dump (Boolean)

See section A.1 of the user manual for more information.

Package

net.didierverna.clon.setup.

Source

configuration.lisp.

Special Variable: *highlight-properties* ¶

The highlight face properties.

Package

net.didierverna.clon.

Source

face.lisp.

Special Variable: *item-names* ¶

The list of defined item names.

Package

net.didierverna.clon.

Source

valued.lisp.

---

6.2.2 Macros

Macro: %defgroup (internalp (&rest keys &key header hidden) &body forms) ¶

Define a new group.

Package

net.didierverna.clon.

Source

group.lisp.

Macro: accumulate ((initial-value) &body body) ¶

Accumulate BODY forms in a list beginning with INITIAL-VALUE. INITIAL-VALUE is not evaluated. BODY forms are accumulated only when their value is non-nil.
If nothing to accumulate, then return nil instead of the list of INITIAL-VALUE.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: declare-valid-superclass (class superclass) ¶

Validate SUPERCLASS classes for CLASS classes.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: defabstract (class super-classes slots &rest options) ¶

Like DEFCLASS, but define an abstract class.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: defindent (symbol indent) ¶

Wrapper around ‘clindent’ to avoid quoting SYMBOL and INDENT.

Package

net.didierverna.clon.setup.

Source

readtable.lisp.

Macro: defoption (class superclasses slots &rest options) ¶

Create a new option CLASS and register it with Clon.

Package

net.didierverna.clon.

Source

valued.lisp.

Macro: do-options ((opt there) &body body) ¶

Execute BODY with OPT bound to every option in THERE.

Package

net.didierverna.clon.

Source

synopsis.lisp.

Macro: econd (&body clauses) ¶

Like COND, but signal an error if no clause evaluates to t.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: endpush (object place) ¶

Like push, but at the end.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: highlight-property-ecase (property value &body clauses) ¶

Create an ECASE form to extract PROPERTY’s VALUE escape sequence.
Each clause looks like: (PROPERTY-NAME (VALUE-OR-VALUE-LIST ESCAPE-SEQUENCE)*). The value-matching part will itself be enclosed in an ECASE expression.
In addition, the special clause syntax (BOOLEAN <PROPERTY-NAME> <YES> <NO>) is a shortcut for: (PROPERTY-NAME ((on t) YES) ((off nil) NO)).

Package

net.didierverna.clon.

Source

sheet.lisp.

Macro: map-frames (function (sheet &key reverse)) ¶

Map FUNCTION over SHEET’s frames. If REVERSE, map in reverse order.

Package

net.didierverna.clon.

Source

sheet.lisp.

Macro: maybe-pop-argument (cmdline option cmdline-argument) ¶

Pop OPTION’s argument from CMDLINE if needed. If so, store it in CMDLINE-ARGUMENT.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Macro: maybe-push (object place) ¶

Like push, but only if OBJECT is non-nil.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: replace-in-keys ((key val) keys the-key form) ¶

Replace every occurrence of THE-KEY in KEYS with FORM.
At every KEYS round, KEY and VAL are bound to the current key-value pair. FORM is evaluated each time and should return a key-value list.

Package

net.didierverna.clon.

Source

util.lisp.

Macro: restartable-invalid-negated-syntax-error ((option) &body body) ¶

Restartably throw an invalid-negated-syntax error.
The error relates to the command-line use of OPTION.
BODY constitutes the body of the only restart available,
use-short-call, and should act as if OPTION had been normally called by short name.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Macro: restartable-spurious-cmdline-argument-error ((option name argument) &body body) ¶

Restartably throw a spurious-cmdline-argument error.
The error relates to the command-line use of OPTION called by NAME with ARGUMENT.
BODY constitutes the body of the only restart available, discard-argument, and should act as if ARGUMENT had not been provided.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Macro: with-context-error-handler (context &body body) ¶

Execute BODY with CONTEXT’s error handler bound for CONDITION.

Package

net.didierverna.clon.

Source

context.lisp.

---

6.2.3 Ordinary functions

Function: %version (type major minor status level name) ¶

Package

net.didierverna.clon.setup.

Source

version.lisp.

Function: add-subface (face subface) ¶

Add SUBFACE to FACE’s subfaces and return it.

Package

net.didierverna.clon.

Source

face.lisp.

Function: argument-popable-p (cmdline) ¶

Return true if the first CMDLINE item is an argument.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Function: attach-face-tree (face face-tree) ¶

Create a copy of FACE-TREE, attach it to FACE and return it.
Apart from the parenting information, the copied faces share slot values with the original ones.

Package

net.didierverna.clon.

Source

face.lisp.

Function: available-right-margin (sheet) ¶

Return SHEET’s available right margin.
This margin is the first non-self margin specified by a frame. All inner self frames can potentially write until the available right margin.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: beginning-of-string-p (beginning string &optional ignore-case) ¶

Check that STRING starts with BEGINNING. If IGNORE-CASE, well, ignore case.

Package

net.didierverna.clon.

Source

util.lisp.

Function: clindent (symbol indent) ¶

Send SYMBOL’s INDENTation information to Emacs.
Emacs will set the ’common-lisp-indent-function property.
If INDENT is a symbol, use its indentation definition. Otherwise, INDENT is considered as an indentation definition.

Package

net.didierverna.clon.setup.

Source

readtable.lisp.

Function: close-line (sheet) ¶

Close all frames on SHEET’s current line and go to next line.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: close-sface (sheet) ¶

Close SHEET’s current sface.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: closest-match (match list &key ignore-case key) ¶

Return the LIST element closest to MATCH, or nil.
If IGNORE-CASE, well, ignore case.
KEY should provide a way to get a string from each LIST element.

Package

net.didierverna.clon.

Source

util.lisp.

Function: cmdline-convert (valued-option cmdline-name cmdline-argument) ¶

Convert CMDLINE-ARGUMENT to VALUED-OPTION’s value.
This function is used when the conversion comes from a command-line usage of VALUED-OPTION, called by CMDLINE-NAME, and intercepts invalid-argument errors to raise the higher level invalid-cmdline-argument error instead.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Reader: cmdline-option-name (instance) ¶

Writer: (setf cmdline-option-name) (instance) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Target Slot

name.

Reader: cmdline-option-option (instance) ¶

Writer: (setf cmdline-option-option) (instance) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Target Slot

option.

Function: cmdline-option-p (object) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Reader: cmdline-option-source (instance) ¶

Writer: (setf cmdline-option-source) (instance) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Target Slot

source.

Reader: cmdline-option-value (instance) ¶

Writer: (setf cmdline-option-value) (instance) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Target Slot

value.

Function: complete-string (beginning complete) ¶

Complete BEGINNING with the rest of COMPLETE in parentheses. For instance, completing ’he’ with ’help’ will produce ’he(lp)’.

Package

net.didierverna.clon.

Source

util.lisp.

Function: copy-cmdline-option (instance) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Function: copy-frame (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: copy-highlight-frame (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: copy-highlight-property-instance (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: current-frame (sheet) ¶

Return SHEET’s current frame.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: current-left-margin (sheet) ¶

Return SHEET’s current left margin.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: current-right-margin (sheet) ¶

Return SHEET’s current right margin.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: current-sface (sheet) ¶

Return SHEET’s current sface or nil.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: directory-pathname-p (pathname) ¶

Return true if PATHNAME denotes a directory.

Package

net.didierverna.clon.

Source

path.lisp.

Function: environment-convert (valued-option env-val) ¶

Convert ENV-VAL to VALUED-OPTION’s value.
This function is used when the conversion comes from an environment variable associated with VALUED-OPTION, and intercepts invalid-argument errors
to raise the higher level invalid-environment-value error instead.

Package

net.didierverna.clon.

Source

environ.lisp.

Function: exit-abnormally (error) ¶

Print ERROR on *ERROR-OUTPUT* and exit with status code 1.

Package

net.didierverna.clon.

Source

context.lisp.

Function: face-highlight-property-set-p (face property) ¶

Return t if PROPERTY is set explicitely in FACE.

Package

net.didierverna.clon.

Source

face.lisp.

Function: face-highlight-property-value (face property) ¶

Return PROPERTY’s value in FACE.
Since faces inherit highlight properties, the actual value might come from one of FACE’s ancestors.
if PROPERTY is not et, return nil.

Package

net.didierverna.clon.

Source

face.lisp.

Function: find-sface (sface name) ¶

Find an sface starting at SFACE named NAME.
If the sface can’t be found in SFACE’s face tree, find one in SFACE’s sibling instead, and make a copy of it.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: flush-sheet (sheet) ¶

Flush SHEET.

Package

net.didierverna.clon.

Source

sheet.lisp.

Reader: frame-left-margin (instance) ¶

Writer: (setf frame-left-margin) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

left-margin.

Function: frame-p (object) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Reader: frame-right-margin (instance) ¶

Writer: (setf frame-right-margin) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

right-margin.

Reader: frame-sface (instance) ¶

Writer: (setf frame-sface) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

sface.

Function: get-top-padding (sface items) ¶

Return top padding of the next item in ITEMS that will print under SFACE.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: getenv (variable) ¶

Get environment VARIABLE’s value. VARIABLE may be null.

Package

net.didierverna.clon.

Source

util.lisp.

Function: help-spec-items-will-print (sface items) ¶

Return t if at least one of ITEMS will print under SFACE.

Package

net.didierverna.clon.

Source

sheet.lisp.

Reader: highlight-frame-highlight-property-instances (instance) ¶

Writer: (setf highlight-frame-highlight-property-instances) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

highlight-property-instances.

Function: highlight-frame-left-margin (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: (setf highlight-frame-left-margin) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: highlight-frame-p (object) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: highlight-frame-right-margin (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: (setf highlight-frame-right-margin) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: highlight-frame-sface (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: (setf highlight-frame-sface) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: highlight-property-instance-escape-sequence (instance) ¶

Return highlight property INSTANCE’s escape sequence.

Package

net.didierverna.clon.

Source

sheet.lisp.

Reader: highlight-property-instance-name (instance) ¶

Writer: (setf highlight-property-instance-name) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

name.

Function: highlight-property-instance-p (object) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Reader: highlight-property-instance-value (instance) ¶

Writer: (setf highlight-property-instance-value) (instance) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Target Slot

value.

Function: home-directory () ¶

Return user’s home directory in canonical form.
If the user’s home directory cannot be computed, signal a warning and return NIL.

Package

net.didierverna.clon.

Source

util.lisp.

Function: i-reader (stream subchar arg) ¶

Construct a call to ‘defindent’ by reading an argument list from STREAM. This dispatch macro character function is installed on #i in the NET.DIDIERVERNA.CLON named readtable.

Package

net.didierverna.clon.setup.

Source

readtable.lisp.

Function: list-to-string (list &key key separator) ¶

Return a SEPARATOR-separated string of all LIST elements.
- KEY should provide a way to get a string from each LIST element. - SEPARATOR is the string to insert between elements.

Package

net.didierverna.clon.

Source

util.lisp.

Function: macosp () ¶

Return t if running on Mac OS.

Package

net.didierverna.clon.

Source

util.lisp.

Function: make-cmdline-option (&key name option value source) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Function: make-frame (&key sface left-margin right-margin) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: make-highlight-frame (&key sface left-margin right-margin highlight-property-instances) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: make-highlight-property-instance (&key name value) ¶

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: make-internal-enum (long-name description &rest keys &key argument-name argument-type enum env-var fallback-value default-value hidden) ¶

Make a new internal (Clon-specific) enum option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible values.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

enum.lisp.

Function: make-internal-flag (long-name description &rest keys &key env-var hidden) ¶

Make a new internal (Clon-specific) flag.
- LONG-NAME is the flag’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the flag’s description.
- ENV-VAR is the flag’s associated environment variable, sans the ’CLON_’ prefix. It default to nil.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

flag.lisp.

Function: make-internal-lispobj (long-name description &rest keys &key argument-name argument-type env-var typespec fallback-value default-value hidden) ¶

Make a new internal (Clon-specific) string option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- TYPESPEC is a type specifier the option’s value should satisfy.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

lispobj.lisp.

Function: make-internal-path (long-name description &rest keys &key argument-name argument-type env-var fallback-value default-value type hidden) ¶

Make a new internal (Clon-specific) path option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- TYPE is the pathname type. It can be one of :file, :directory, :file-list, :directory-list or nil meaning that everything is allowed.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

path.lisp.

Function: make-internal-stropt (long-name description &rest keys &key argument-name argument-type env-var fallback-value default-value hidden) ¶

Make a new internal (Clon-specific) string option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

stropt.lisp.

Function: make-internal-switch (long-name description &rest keys &key argument-style argument-type env-var default-value hidden) ¶

Make a new internal (Clon-specific) switch.
- LONG-NAME is the switch’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the switch’s description.
- ARGUMENT-STYLE is the switch’s argument display style. It can be one of :yes/no, :on/off, :true/false, :yup/nope or :yeah/nah.
It defaults to :yes/no.
- ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the switch’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- DEFAULT-VALUE is the switch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

switch.lisp.

Function: make-internal-text (&rest keys &key contents hidden) ¶

Package

net.didierverna.clon.

Source

text.lisp.

Function: make-internal-xswitch (long-name description &rest keys &key argument-name argument-type enum env-var default-value hidden) ¶

Make a new internal (Clon-specific) xswitch.
- LONG-NAME is the xswitch’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the xswitch’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible non-boolean values.
- ENV-VAR is the xswitch’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- DEFAULT-VALUE is the xswitch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon.

Source

xswitch.lisp.

Function: make-raw-face-tree (&optional face-class) ¶

Make a raw (boring yet functional) face tree.

Package

net.didierverna.clon.

Source

face.lisp.

Function: make-raw-sface (sibling) ¶

Return a new SFace based on SIBLING.
This function does not consider SIBLING as a face tree:
only face properties are copied; the face parent and children are set to nil.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: make-sheet (&rest keys &key output-stream search-path theme line-width highlight) ¶

Make a new SHEET.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: match-option (option &key short-name long-name) ¶

Try to match OPTION against SHORT-NAME, LONG-NAME. If OPTION matches, return the name that matched.

Package

net.didierverna.clon.

Source

option.lisp.

Function: open-line (sheet) ¶

Open all frames on SHEET’s current line.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: open-next-line (sheet) ¶

Close SHEET’s current line and open the next one.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: open-sface (sheet sface) ¶

Create a frame for SFACE and open it.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: option-abbreviation-distance (option partial-name) ¶

Return the distance between OPTION’s long name and PARTIAL-NAME. If PARTIAL-NAME does not abbreviate OPTION’s long name, return MOST-POSITIVE-FIXNUM.

Package

net.didierverna.clon.

Source

option.lisp.

Function: option-call-p (str) ¶

Return true if STR looks like an option call.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Function: parent-generation (face parent-name) ¶

Return FACE’s parent generation for PARENT-NAME.
That is, 1 if PARENT-NAME names FACE’s parent, 2 if it names its grand-parent etc. If PARENT-NAME does not name one of FACE’s ancestors, trigger an error.

Package

net.didierverna.clon.

Source

face.lisp.

Function: pathname-component-null-p (component) ¶

Return true if COMPONENT is either null or :unspecific.

Package

net.didierverna.clon.

Source

path.lisp.

Function: pop-frame (sheet) ¶

Pop SHEET’s current frame.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: potential-pack-char (option &optional as-string) ¶

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

Package

net.didierverna.clon.

Source

option.lisp.

Function: princ-char (sheet char) ¶

Princ CHAR on SHEET’s stream and increment the column position.
The effect of printing CHAR must be exactly to move right by one column, so control characters, as well as newlines and tabs are forbidden here.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: princ-highlight-property-instances (sheet instances) ¶

Princ highlight proeprty INSTANCES on SHEET’s stream.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: princ-spaces (sheet number) ¶

Princ NUMBER spaces to SHEET’s stream and update the column position.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: princ-string (sheet string) ¶

Princ STRING on SHEET’s stream and update the column position.
The effect of printing STRING must be exactly to move right by the corresponding string length, so control characters, as well as newlines and tabs are forbidden here.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: print-error (error &optional interactivep) ¶

Print ERROR on *ERROR-OUTPUT*.
When INTERACTIVEP, print on *QUERY-IO* instead.

Package

net.didierverna.clon.

Source

context.lisp.

Function: print-faced-help-spec (sheet sface items) ¶

Print all help specification ITEMS on SHEET with SFACE.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: print-help (sheet help) ¶

Open the toplevel help face and print HELP on SHEET with it.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: print-string (sheet string) ¶

Output STRING to SHEET.
STRING is output within the current frame’s bounds.
Spacing characters are honored but newlines might replace spaces when the output reaches the rightmost bound.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: push-frame (sheet frame) ¶

Push a new frame to SHEET’s frames.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: putenv (variable value) ¶

Set environment VARIABLE to VALUE.

Package

net.didierverna.clon.

Source

util.lisp.

Function: reach-column (sheet column) ¶

Reach COLUMN on SHEET by princ’ing spaces.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: read-argument () ¶

Read an option argument from standard input.

Package

net.didierverna.clon.

Source

valued.lisp.

Function: read-call (&optional negated) ¶

Read an option’s call or pack from standard input.
If NEGATED, read a negated call or pack. Otherwise, read a short call or pack.

Package

net.didierverna.clon.

Source

context.lisp.

Function: read-env-val (env-var) ¶

Read ENV-VAR’s new value from standard input.

Package

net.didierverna.clon.

Source

environ.lisp.

Function: read-long-name () ¶

Read an option’s long name from standard input.

Package

net.didierverna.clon.

Source

context.lisp.

Function: read-sface-tree (pathname) ¶

Read an sface tree from PATHNAME.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: read-value () ¶

Read an option value from standard input.

Package

net.didierverna.clon.

Source

valued.lisp.

Function: release-status-number (release-status) ¶

Package

net.didierverna.clon.setup.

Source

version.lisp.

Function: remove-keys (keys &rest removed) ¶

Return a new property list from KEYS without REMOVED ones.

Package

net.didierverna.clon.

Source

util.lisp.

Function: replace-key (replacement keys) ¶

Return a new property list from KEYS with REPLACEMENT.
REPLACEMENT can take the following forms:
- :KEY
The effect is to remove :KEY from KEYS, as per REMOVE-KEYS.
- (:KEY :NEW-KEY)
The effect is to replace :KEY with :NEW-KEY, leaving the values unchanged. - (:KEY :NEW-KEY (VAL-OR-VALS NEW-VAL)*), with VAL-OR-VALS being
either a value or a list of values. The effect is to replace :KEY with :NEW-KEY and a value matching one of the VAL-OR-VALS with the corresponding NEW-VAL. Values not matching any VAL-OR-VALS remain unchanged. - (:KEY (VAL-OR-VALS :NEW-KEY NEW-VAL...)*), with VAL-OR-VALS as above. The effect is the same as above, but :NEW-KEY additionally depends on the matched value. If multiple :NEW-KEY NEW-VAL couples are provided, that many new keys are inserted along with their values. For values not matching any VAL-OR-VALS, :KEY and its value remain unchanged.

Package

net.didierverna.clon.

Source

util.lisp.

Function: replace-keys (keys &rest replacements) ¶

Return a new property list from KEYS with REPLACEMENTS.
See REPLACE-KEY for more information on the replacement syntax.

Package

net.didierverna.clon.

Source

util.lisp.

Function: restart-on-error (error) ¶

Print ERROR and offer available restarts on *QUERY-IO*.

Package

net.didierverna.clon.

Source

context.lisp.

Function: restartable-check (valued-option value) ¶

Restartably check that VALUE is valid for VALUED-OPTION.
The only restart available, use-value, offers to try a different value from the one that was provided.

Package

net.didierverna.clon.

Source

valued.lisp.

Function: restartable-cmdline-convert (valued-option cmdline-name cmdline-argument) ¶

Restartably convert CMDLINE-ARGUMENT to VALUED-OPTION’s value.
This function is used when the conversion comes from a command-line usage of VALUED-OPTION, called by CMDLINE-NAME.

As well as conversion errors, this function might raise a missing-cmdline-argument error if CMDLINE-ARGUMENT is nil and an argument is required.

Available restarts are (depending on the context):
- use-fallback-value: return FALLBACK-VALUE,
- use-default-value: return VALUED-OPTION’s default value,
- use-value: return another (already converted) value,
- use-argument: return the conversion of another argument.

Return two values: VALUED-OPTION’s value and the actual value source. The value source may be :cmdline, :fallback or :default.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Function: restartable-cmdline-junk-error (junk) ¶

Package

net.didierverna.clon.

Source

context.lisp.

Function: restartable-convert (valued-option argument) ¶

Restartably convert ARGUMENT to VALUED-OPTION’s value. Available restarts are:
- use-default-value: return OPTION’s default value,
- use-value: return another (already converted) value, - use-argument: return the conversion of another argument.

Package

net.didierverna.clon.

Source

valued.lisp.

Function: restartable-environment-convert (valued-option env-val) ¶

Restartably convert ENV-VAL to VALUED-OPTION’s value.
This function is used when the conversion comes from an environment variable associated with VALUED-OPTION.

Available restarts are:
- use-default-value: return VALUED-OPTION’s default value,
- use-value: return another (already converted) value,
- use-argument: return the conversion of another argument,
- modify-env: modify the environment variable’s value.

Package

net.didierverna.clon.

Source

environ.lisp.

Function: restrict-because (reason) ¶

Put Clon in restricted mode because of REASON.

Package

net.didierverna.clon.setup.

Source

termio.lisp.

Function: safe-left-margin (sheet margin) ¶

Return either MARGIN or a safe value instead.
To be safe, margin must be greater than the current left margin and smaller than the currently available margin.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: safe-right-margin (sheet left-margin margin) ¶

Return either MARGIN or a safe value instead.
To be safe, margin must be greater than LEFT-MARGIN and smaller than the currently available right margin.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: search-branch (face names) ¶

Search for a branch of faces named NAMES starting at FACE.
The branch is searched for as a direct subbranch of FACE, or as a direct subbranch of FACE’s ancestors.
If a branch is found, return its leaf face. Otherwise return nil.

Package

net.didierverna.clon.

Source

face.lisp.

Function: search-face (face name &optional error-me) ¶

Search for a face named NAME starting at FACE.
The face is looked for as a direct subface of FACE (in which case it is simply returned), or up in the hierarchy and by successive upper branches (in which case it is copied and attached to FACE).
If ERROR-ME, trigger an error if no face is found; otherwise, return nil.

Package

net.didierverna.clon.

Source

face.lisp.

Function: search-option (context &rest keys &key short-name long-name partial-name) ¶

Search for an option in CONTEXT.
The search is done with SHORT-NAME, LONG-NAME, or PARTIAL-NAME.
In case of a PARTIAL-NAME search, look for an option the long name of which begins with it.
In case of multiple matches by PARTIAL-NAME, the longest match is selected. When such an option exists, return wo values:
- the option itself,
- the name used to find the option, possibly completed if partial.

Package

net.didierverna.clon.

Source

context.lisp.

Function: search-option-by-abbreviation (context partial-name) ¶

Search for option abbreviated with PARTIAL-NAME in CONTEXT. When such an option exists, return two values:
- the option itself,
- the completed name.

Package

net.didierverna.clon.

Source

context.lisp.

Function: search-option-by-name (context &rest keys &key short-name long-name) ¶

Search for option with either SHORT-NAME or LONG-NAME in CONTEXT. When such an option exists, return two values:
- the option itself,
- the name that matched.

Package

net.didierverna.clon.

Source

context.lisp.

Function: search-sticky-option (context namearg) ¶

Search for a sticky option in CONTEXT, matching NAMEARG.
NAMEARG is the concatenation of the option’s short name and its argument. In case of multiple matches, the option with the longest name is selected. When such an option exists, return two values:
- the option itself,
- the argument part of NAMEARG.

Package

net.didierverna.clon.

Source

context.lisp.

Function: select-keys (keys &rest selected) ¶

Return a new property list from KEYS with only SELECTED ones.

Package

net.didierverna.clon.

Source

util.lisp.

Function: split-path (path) ¶

Split PATH into a list of directories.

Package

net.didierverna.clon.

Source

path.lisp.

Function: stream-line-width (stream) ¶

Get STREAM’s line width.
Return two values:
- the stream’s line width, or nil if it can’t be computed (typically when the stream does not denote a tty), - an error message if the operation failed.

Package

net.didierverna.clon.

Source

termio.lisp.

Function: try-read-sface-tree (pathname) ¶

Read an sface tree from PATHNAME if it exists or return nil.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: try-read-theme (pathname) ¶

Read a theme from PATHNAME or PATHNAME.cth if it exists or return nil.

Package

net.didierverna.clon.

Source

sheet.lisp.

Function: ~-reader (stream char) ¶

Read a series of ~"string" to be concatenated together.

Package

net.didierverna.clon.setup.

Source

readtable.lisp.

---