The net.didierverna.clon Reference Manual

This is the net.didierverna.clon Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:04:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 net.didierverna.clon

Command-line options management for standalone Common Lisp applications

Long Name

The Command-Line Options Nuker

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/clon.php

Source Control

https://github.com/didierverna/clon

License

BSD

Long Description

Clon is a library for command-line options management. It is intended to ease the creation of standalone Common Lisp applications by providing a powerful and uniform command-line options interface. The most important features of Clon are the following.

- From the application programmer’s point of view: centralized command-line options specification and management, including automatic generation of help strings, conversion from command-line / defaults / fallbacks / environment variables to application-level option values, global or on-demand option retrieval, and extensibility (the programmer can define his own option types).

- From the application user’s point of view: uniform command-line option syntax across all Clon applications, customization of the help strings layout (with optional ISO6429 coloring on terminals that support it), automatic completion of abbreviated option names and short/long/pack syntax.

Defsystem Dependency

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

Dependencies
Source

net.didierverna.clon.asd.


2.2 net.didierverna.clon.setup/termio

Clon’s support for automatic configuration of termio support

Long Name

The Command-Line Options Nuker, termio setup

Author

Didier Verna <>

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/clon.php

Source Control

https://github.com/didierverna/clon

License

BSD

Long Description

This is a virtual subsystem or Clon (no actual code). Its purpose is only to autodetect termio support and update Clon’s preload configuration on load. For a more complete description of Clon, see the net.didierverna.clon system.

Dependency

net.didierverna.clon.setup (system).

Source

net.didierverna.clon.setup.asd.


2.3 net.didierverna.clon.setup

Clon’s preload setup library

Long Name

The Command-Line Options Nuker, setup library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/clon.php

Source Control

https://github.com/didierverna/clon

License

BSD

Long Description

The Clon setup library provides support for various preload configuration parameters and meta-utilities. For a more complete description of Clon, see the ‘net.didierverna.clon’ system.

Dependency

named-readtables (system).

Source

net.didierverna.clon.setup.asd.

Child Components

2.4 net.didierverna.clon.core

Clon’s basic, platform-independent functionality

Long Name

The Command-Line Options Nuker, core library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/clon.php

Source Control

https://github.com/didierverna/clon

License

BSD

Long Description

Clon’s core library provides the platform/feature independent part. For a more complete description of Clon, see the net.didierverna.clon system.

Dependencies
Source

net.didierverna.clon.core.asd.

Child Components

2.5 net.didierverna.clon.termio

Clon’s support for termio (tty geometry and fontification)

Long Name

The Command-Line Options Nuker, termio library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/clon.php

Source Control

https://github.com/didierverna/clon

License

BSD

Long Description

Clon’s termio library provides automatic detection of tty geometry and ISO6429 coloring on terminals that support it. For a more complete description of Clon, see the net.didierverna.clon system.

If Feature

:net.didierverna.clon.termio

Defsystem Dependencies
Dependencies
Source

net.didierverna.clon.termio.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 net.didierverna.clon.setup/src

Dependency

package.lisp (file).

Source

net.didierverna.clon.setup.asd.

Parent Component

net.didierverna.clon.setup (system).

Child Components

3.2 net.didierverna.clon.core/src

Dependency

package.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

net.didierverna.clon.core (system).

Child Components

3.3 net.didierverna.clon.core/src/options

Dependency

text.lisp (file).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Child Components

3.4 net.didierverna.clon.core/src/retrieval

Dependency

options (module).

Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Child Components

3.5 net.didierverna.clon.core/src/output

Dependencies
Source

net.didierverna.clon.core.asd.

Parent Component

src (module).

Child Components

4 Files

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


4.1 Lisp


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.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.6 net.didierverna.clon.setup/src/configuration.lisp

Source

net.didierverna.clon.setup.asd.

Parent Component

src (module).

Public Interface
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

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
Internals

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
Internals

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

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

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

Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface
Internals

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

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
Internals

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

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
Internals

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
Internals

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

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

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

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

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

Dependencies
Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-enum (function).

Internals

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

Dependencies
Source

net.didierverna.clon.core.asd.

Parent Component

options (module).

Public Interface

make-xswitch (function).

Internals

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
Internals

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
Internals

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

Source

net.didierverna.clon.core.asd.

Parent Component

retrieval (module).

Internals

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

Source

net.didierverna.clon.core.asd.

Parent Component

retrieval (module).

Internals

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
Internals

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

Source

net.didierverna.clon.core.asd.

Parent Component

output (module).

Public Interface
Internals

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
Internals

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
Internals

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

5 Packages

Packages are listed by definition order.


5.1 net.didierverna.clon

The Clon library’s package.

Source

package.lisp.

Use List
Public Interface
Internals

5.2 net.didierverna.clon.setup

The Clon setup library’s package.

Source

package.lisp.

Use List

common-lisp.

Used By List

net.didierverna.clon.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


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 ((switch switch) &key)

Provide an argument name conformant to the selected argument style.

Source

switch.lisp.

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

enum-base.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 :after ((context context) &key cmdline progname)

Parse CMDLINE.

Source

context.lisp.

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 :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 ((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: 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 ((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: 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 Internals


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.


6.2.4 Generic functions

Generic Reader: argument (condition)
Package

net.didierverna.clon.

Methods
Reader Method: argument ((condition unknown-cmdline-option-error))
Source

context.lisp.

Target Slot

argument.

Reader Method: argument ((condition spurious-cmdline-argument))
Source

cmdline.lisp.

Target Slot

argument.

Reader Method: argument ((condition invalid-argument))
Source

valued.lisp.

Target Slot

argument.

Generic Reader: argument-name (object)
Package

net.didierverna.clon.

Methods
Reader Method: argument-name ((valued-option valued-option))

The option’s argument display name.

Source

valued.lisp.

Target Slot

argument-name.

Generic Reader: argument-required-p (object)
Package

net.didierverna.clon.

Methods
Reader Method: argument-required-p ((valued-option valued-option))

Whether the option’s argument is required.

Source

valued.lisp.

Target Slot

argument-required-p.

Generic Reader: argument-style (object)
Package

net.didierverna.clon.

Methods
Reader Method: argument-style ((switch-base switch-base))

The selected argument style.

Source

switch-base.lisp.

Target Slot

argument-style.

Generic Reader: argument-styles (object)
Generic Writer: (setf argument-styles) (object)
Package

net.didierverna.clon.

Methods
Reader Method: argument-styles ((switch-base switch-base))
Writer Method: (setf argument-styles) ((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.

Target Slot

argument-styles.

Generic Reader: background (object)
Package

net.didierverna.clon.

Methods
Reader Method: background ((face face))

The face background.

Source

face.lisp.

Target Slot

background.

Package

net.didierverna.clon.

Methods

The face’s blink speed.

Source

face.lisp.

Target Slot

blink.

Generic Reader: bottom-padding (object)
Package

net.didierverna.clon.

Methods
Reader 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.

Target Slot

bottom-padding.

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.

Methods
Method: check ((xswitch xswitch) value)

Check that VALUE is valid for XSWITCH.

Source

xswitch.lisp.

Method: check ((enum enum) value)

Check that VALUE is valid for ENUM.

Source

enum.lisp.

Method: check ((path path) value)

Check that VALUE is valid for PATH.

Source

path.lisp.

Method: check ((lispobj lispobj) value)

Check that VALUE is valid for LISPOBJ.

Source

lispobj.lisp.

Method: check ((stropt stropt) value)

Check that VALUE is valid for STROPT.

Source

stropt.lisp.

Method: check ((switch switch) value)

Check that VALUE is valid for SWITCH.

Source

switch.lisp.

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.

Methods
Method: check-name-clash ((container1 container) (container2 container))

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

Source

container.lisp.

Method: check-name-clash (item1 (container container))

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

Source

container.lisp.

Method: check-name-clash ((container container) item2)

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

Source

container.lisp.

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.

Reader Method: clon-options-group ((synopsis synopsis))

The Clon options group.

Source

synopsis.lisp.

Target Slot

clon-options-group.

Generic Function: close-frame (sheet frame)

Close FRAME on SHEET.

Package

net.didierverna.clon.

Source

sheet.lisp.

Method Combination

progn.

Options

:most-specific-last

Methods
Method: close-frame progn (sheet (frame frame))

Reach FRAME’s right margin if it has one.

Method: close-frame progn (sheet (frame highlight-frame))

Restore the upper frame’s highlight properties.

Generic Reader: cmdline-options (object)
Generic Writer: (setf cmdline-options) (object)
Package

net.didierverna.clon.

Methods
Reader Method: cmdline-options ((context context))
Writer Method: (setf cmdline-options) ((context context))

The options from the command-line.

Source

context.lisp.

Target Slot

cmdline-options.

Generic Reader: column (object)
Generic Writer: (setf column) (object)
Package

net.didierverna.clon.

Methods
Reader Method: column ((sheet sheet))
Writer Method: (setf column) ((sheet sheet))

The sheet’s current column.

Source

sheet.lisp.

Target Slot

column.

Generic Reader: comment (condition)
Package

net.didierverna.clon.

Methods
Reader Method: comment ((condition invalid-argument))
Source

valued.lisp.

Target Slot

comment.

Reader Method: comment ((condition invalid-value))
Source

valued.lisp.

Target Slot

comment.

Generic Reader: concealedp (object)
Package

net.didierverna.clon.

Methods
Reader Method: concealedp ((face face))

The face’s concealed status.

Source

face.lisp.

Target Slot

concealedp.

Generic Reader: contents (object)
Package

net.didierverna.clon.

Methods
Reader Method: contents ((text text))

The actual text string.

Source

text.lisp.

Target Slot

contents.

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.

Methods
Method: convert ((xswitch xswitch) argument)

Convert ARGUMENT to an XSWITCH value.

Source

xswitch.lisp.

Method: convert ((enum enum) argument)

Convert ARGUMENT to an ENUM value.

Source

enum.lisp.

Method: convert ((path path) argument)

Convert ARGUMENT to a PATH value.

Source

path.lisp.

Method: convert ((lispobj lispobj) argument)

Convert ARGUMENT to a LISPOBJ value.

Source

lispobj.lisp.

Method: convert ((stropt stropt) argument)

Convert ARGUMENT to an STROPT value.

Source

stropt.lisp.

Method: convert ((switch switch) argument)

Convert ARGUMENT to a SWITCH value.

Source

switch.lisp.

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.

Methods
Method: copy-instance (instance &optional subclass)

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

Generic Reader: crossed-out-p (object)
Package

net.didierverna.clon.

Methods
Reader Method: crossed-out-p ((face face))

The face’s crossed out status.

Source

face.lisp.

Target Slot

crossed-out-p.

Generic Reader: default-value (object)
Package

net.didierverna.clon.

Methods
Reader Method: default-value ((valued-option valued-option))

The option’s default value.

Source

valued.lisp.

Target Slot

default-value.

Generic Reader: description (object)
Package

net.didierverna.clon.

Methods
Reader Method: description ((option option))

The option’s description.

Source

option.lisp.

Target Slot

description.

Generic Reader: enum (object)
Package

net.didierverna.clon.

Methods
Reader Method: enum ((enum-base enum-base))

The set of possible values.

Source

enum-base.lisp.

Target Slot

enum.

Generic Reader: env-val (condition)
Package

net.didierverna.clon.

Methods
Reader Method: env-val ((condition invalid-environment-value))
Source

environ.lisp.

Target Slot

argument.

Generic Reader: env-var (object)
Package

net.didierverna.clon.

Methods
Reader Method: env-var ((condition environment-error))
Source

environ.lisp.

Target Slot

env-var.

Reader Method: env-var ((option option))

The option’s associated environment variable.

Source

option.lisp.

Target Slot

env-var.

Generic Reader: error-handler (object)
Package

net.didierverna.clon.

Methods
Reader Method: error-handler ((context context))

The behavior to adopt on option retrieval errors.

Source

context.lisp.

Target Slot

error-handler.

Generic Reader: error-string (condition)
Generic Writer: (setf error-string) (condition)
Package

net.didierverna.clon.

Methods
Reader Method: error-string ((condition home-directory))
Writer Method: (setf error-string) ((condition home-directory))
Source

util.lisp.

Target Slot

error-string.

Generic Reader: fallback-value (object)
Package

net.didierverna.clon.

Methods
Reader Method: fallback-value ((valued-option valued-option))

The option’s fallback value.

Source

valued.lisp.

Target Slot

fallback-value.

Generic Reader: foreground (object)
Package

net.didierverna.clon.

Methods
Reader Method: foreground ((face face))

The face foreground.

Source

face.lisp.

Target Slot

foreground.

Generic Reader: framedp (object)
Package

net.didierverna.clon.

Methods
Reader Method: framedp ((face face))

The face’s framed status.

Source

face.lisp.

Target Slot

framedp.

Generic Reader: frames (object)
Generic Writer: (setf frames) (object)
Package

net.didierverna.clon.

Methods
Reader Method: frames ((sheet sheet))
Writer Method: (setf frames) ((sheet sheet))

The stack of currently open frames.

Source

sheet.lisp.

Target Slot

frames.

Generic Function: get-bottom-padding (sface help-spec)

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

Package

net.didierverna.clon.

Source

sheet.lisp.

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 Reader: header (object)
Package

net.didierverna.clon.

Methods
Reader Method: header ((group group))

The group’s header.

Source

group.lisp.

Target Slot

header.

Generic Function: help-spec (item &key program unhide &allow-other-keys)

Return ITEM’s help specification.

Package

net.didierverna.clon.

Source

item.lisp.

Methods
Method: help-spec ((synopsis synopsis) &key program)

Return SYNOPSIS’s help specification.

Source

synopsis.lisp.

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

Return GROUP’s help specification.

Source

group.lisp.

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

Return CONTAINER’s help specification.

Source

container.lisp.

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

Return OPTION’s help specification.

Source

valued.lisp.

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

Return OPTION’s help specification.

Source

option.lisp.

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

Return TEXT’s help specification.

Source

text.lisp.

Method: help-spec :around ((item item) &key unhide)

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.

Methods
Method: help-spec-will-print :before (sface help-spec)
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 Reader: hiddenp (object)
Package

net.didierverna.clon.

Methods
Reader Method: hiddenp ((item item))

Whether the item is hidden in help strings.

Source

item.lisp.

Target Slot

hiddenp.

Generic Reader: highlight (object)
Package

net.didierverna.clon.

Methods
Reader Method: highlight ((context context))

Clon’s output highlight mode.

Source

context.lisp.

Target Slot

highlight.

Generic Reader: highlightp (object)
Package

net.didierverna.clon.

Methods
Reader Method: highlightp ((sheet sheet))

Whether to highlight SHEET’s output.

Source

sheet.lisp.

Target Slot

highlightp.

Generic Reader: intensity (object)
Package

net.didierverna.clon.

Methods
Reader Method: intensity ((face face))

The face intensity.

Source

face.lisp.

Target Slot

intensity.

Generic Reader: inversep (object)
Package

net.didierverna.clon.

Methods
Reader Method: inversep ((face face))

The face’s inverse video status.

Source

face.lisp.

Target Slot

inversep.

Generic Reader: italicp (object)
Package

net.didierverna.clon.

Methods
Reader Method: italicp ((face face))

The face’s italic status.

Source

face.lisp.

Target Slot

italicp.

Generic Reader: item (condition)
Package

net.didierverna.clon.

Methods
Reader Method: item ((condition cmdline-error))
Source

cmdline.lisp.

Target Slot

item.

Generic Reader: item-separator (object)
Package

net.didierverna.clon.

Methods
Reader Method: item-separator ((face face))

The face item separator.

Source

face.lisp.

Target Slot

item-separator.

Generic Reader: items (object)
Package

net.didierverna.clon.

Methods
Reader Method: items ((container container))

The items in the container.

Source

container.lisp.

Target Slot

items.

Generic Reader: junk (condition)
Package

net.didierverna.clon.

Methods
Reader Method: junk ((condition cmdline-junk-error))
Source

context.lisp.

Target Slot

item.

Generic Reader: left-padding (object)
Package

net.didierverna.clon.

Methods
Reader 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.

Target Slot

left-padding.

Generic Reader: line-width (object)
Package

net.didierverna.clon.

Methods
Reader Method: line-width ((context context))

The line width for help display.

Source

context.lisp.

Target Slot

line-width.

Reader Method: line-width ((sheet sheet))

The sheet’s line width.

Source

sheet.lisp.

Target Slot

line-width.

Generic Reader: long-name (object)
Package

net.didierverna.clon.

Methods
Reader Method: long-name ((option option))

The option’s long name.

Source

option.lisp.

Target Slot

long-name.

Generic Function: make-face-tree (definition &optional face-class)

Make a FACE-CLASS face tree from DEFINITION.

Package

net.didierverna.clon.

Source

face.lisp.

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.

Methods
Method: mapoptions (func (context context))

Map FUNC over all options in CONTEXT synopsis.

Source

context.lisp.

Method: mapoptions (func elsewhere)

Do nothing by default.

Method: mapoptions :after (func (item item))

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 Reader: name (condition)
Package

net.didierverna.clon.

Methods
Reader Method: name ((condition unknown-cmdline-option-error))
Source

context.lisp.

Target Slot

item.

Reader Method: name ((face face))

The face name.

Source

face.lisp.

Target Slot

name.

Reader Method: name ((condition cmdline-option-error))
Source

cmdline.lisp.

Target Slot

item.

Generic Reader: negated-call (condition)
Package

net.didierverna.clon.

Methods
Reader Method: negated-call ((condition unrecognized-negated-call-error))
Source

context.lisp.

Target Slot

item.

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.

Reader Method: negated-pack ((synopsis synopsis))

The negated pack string.

Source

synopsis.lisp.

Target Slot

negated-pack.

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.

Methods
Method: negated-pack-char ((negatable negatable) &optional as-string)

Return NEGATABLE’s negated pack character, if any.

Source

negatable.lisp.

Method: negated-pack-char ((option option) &optional as-string)

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

Generic Reader: no-values (object)
Generic Writer: (setf no-values) (object)
Package

net.didierverna.clon.

Methods
Reader Method: no-values ((switch-base switch-base))
Writer Method: (setf no-values) ((switch-base switch-base))

The possible ’no’ values.

Source

switch-base.lisp.

Target Slot

no-values.

Generic Function: open-frame (sheet frame)

Open FRAME on SHEET.

Package

net.didierverna.clon.

Source

sheet.lisp.

Method Combination

progn.

Options

:most-specific-last

Methods
Method: open-frame progn (sheet (frame frame))

Reach the frame’s left margin.

Method: open-frame progn (sheet (frame highlight-frame))

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

Generic Reader: option (condition)
Package

net.didierverna.clon.

Methods
Reader Method: option ((condition option-error))
Source

option.lisp.

Target Slot

option.

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.

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.

Method: option-sticky-distance ((option option) namearg)

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

Generic Reader: output-stream (object)
Package

net.didierverna.clon.

Methods
Reader Method: output-stream ((sheet sheet))

The sheet’s output stream.

Source

sheet.lisp.

Target Slot

output-stream.

Generic Reader: parent (object)
Package

net.didierverna.clon.

Methods
Reader Method: parent ((face face))

The face parent.

Source

face.lisp.

Target Slot

parent.

Generic Reader: path-type (object)
Package

net.didierverna.clon.

Methods
Reader Method: path-type ((path path))

The path type.

Source

path.lisp.

Target Slot

path-type.

Generic Function: postfix (object)
Package

net.didierverna.clon.

Methods
Method: postfix ((context context))

Return the postfix of CONTEXT’s synopsis.

Source

context.lisp.

Reader Method: postfix ((synopsis synopsis))

A postfix to the program synopsis.

Source

synopsis.lisp.

Target Slot

postfix.

Generic Reader: potential-pack (object)
Package

net.didierverna.clon.

Methods
Reader Method: potential-pack ((synopsis synopsis))

The potential pack string.

Source

synopsis.lisp.

Target Slot

potential-pack.

Generic Function: potential-pack-p (pack there)

Return t if PACK is a potential pack in THERE.

Package

net.didierverna.clon.

Source

synopsis.lisp.

Methods
Method: potential-pack-p (pack (context context))

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

Source

context.lisp.

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.

Methods
Method: print-help-spec :before (sheet help-spec)
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.

Methods
Method: retrieve-from-environment :before (option env-val)

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.

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.

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.

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 Reader: right-padding (object)
Package

net.didierverna.clon.

Methods
Reader 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.

Target Slot

right-padding.

Generic Reader: search-path (object)
Package

net.didierverna.clon.

Methods
Reader Method: search-path ((context context))

The search path for Clon files.

Source

context.lisp.

Target Slot

search-path.

Generic Reader: sface-tree (object)
Package

net.didierverna.clon.

Methods
Reader Method: sface-tree ((sheet sheet))

The sheet’s sface tree.

Source

sheet.lisp.

Target Slot

sface-tree.

Generic Reader: short-call (condition)
Package

net.didierverna.clon.

Methods
Reader Method: short-call ((condition unrecognized-short-call-error))
Source

context.lisp.

Target Slot

item.

Generic Reader: short-name (object)
Package

net.didierverna.clon.

Methods
Reader Method: short-name ((option option))

The option’s short name.

Source

option.lisp.

Target Slot

short-name.

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.

Reader Method: short-pack ((synopsis synopsis))

The short pack string.

Source

synopsis.lisp.

Target Slot

short-pack.

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.

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.

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.

Methods
Method: short-syntax-help-spec-prefix ((option negatable))
Source

negatable.lisp.

Method: short-syntax-help-spec-prefix ((option valued-option))
Generic Reader: sibling (object)
Package

net.didierverna.clon.

Methods
Reader Method: sibling ((sface sface))

The SFace’s raw sibling.

Source

sheet.lisp.

Target Slot

sibling.

Generic Function: stream-ioctl-output-handle (stream)

Return STREAM’s ioctl output handle or NIL.

Package

net.didierverna.clon.

Source

termio.lisp.

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.

Methods
Method: stringify ((xswitch xswitch) value)

Transform XSWITCH’s VALUE into an argument.

Source

xswitch.lisp.

Method: stringify ((enum enum) value)

Transform ENUM’s VALUE into an argument.

Source

enum.lisp.

Method: stringify ((path path) value)

Transform PATH’s VALUE into an argument.

Source

path.lisp.

Method: stringify ((lispobj lispobj) value)

Transform LISPOBJ’s VALUE into an argument.

Source

lispobj.lisp.

Method: stringify ((stropt stropt) value)

Transform STROPT’s VALUE into an argument.

Source

stropt.lisp.

Method: stringify ((switch switch) value)

Transform SWITCH’s VALUE into an argument.

Source

switch.lisp.

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.

Methods
Method: subface (face (name symbol))

Return FACE’subface named NAME, or nil.

Method: subface (face (names list))

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

Generic Reader: subfaces (object)
Package

net.didierverna.clon.

Methods
Reader Method: subfaces ((face face))

The face children.

Source

face.lisp.

Target Slot

subfaces.

Generic Reader: synopsis (object)
Package

net.didierverna.clon.

Methods
Reader Method: synopsis ((context context))

The program synopsis.

Source

context.lisp.

Target Slot

synopsis.

Generic Reader: theme (object)
Package

net.didierverna.clon.

Methods
Reader Method: theme ((context context))

The theme filename.

Source

context.lisp.

Target Slot

theme.

Generic Function: top-padding (object)
Package

net.didierverna.clon.

Methods
Method: top-padding ((help-spec list))
Source

sheet.lisp.

Method: top-padding (other)
Source

sheet.lisp.

Reader 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.

Target Slot

top-padding.

Generic Reader: traversedp (object)
Generic Writer: (setf traversedp) (object)
Package

net.didierverna.clon.

Methods
Reader Method: traversedp ((item item))
Writer Method: (setf traversedp) ((item item))

The item’s traversal state.

Source

item.lisp.

Target Slot

traversedp.

Generic Reader: typespec (object)
Package

net.didierverna.clon.

Methods
Reader Method: typespec ((lispobj lispobj))

A type specifier the option’s value should satisfy.

Source

lispobj.lisp.

Target Slot

typespec.

Generic Reader: underline (object)
Package

net.didierverna.clon.

Methods
Reader Method: underline ((face face))

The face’s underline level.

Source

face.lisp.

Target Slot

underline.

Generic Function: untraverse (item)

Reset ITEM’s traversal state, and return ITEM.

Package

net.didierverna.clon.

Source

item.lisp.

Methods
Method: untraverse ((context context))

Untraverse CONTEXT synopsis.

Source

context.lisp.

Method: untraverse ((container container))

Untraverse all CONTAINER items.

Source

container.lisp.

Method: untraverse ((option option))

OPTION is a terminal object: just return it.

Source

option.lisp.

Method: untraverse ((text text))

TEXT is a terminal object: just return it.

Source

text.lisp.

Method: untraverse :after ((item item))

Mark ITEM as untraversed.

Generic Reader: value (condition)
Package

net.didierverna.clon.

Methods
Reader Method: value ((condition invalid-value))
Source

valued.lisp.

Target Slot

value.

Generic Reader: visiblep (object)
Package

net.didierverna.clon.

Methods
Reader Method: visiblep ((face face))

Whether the face is visible.

Source

face.lisp.

Target Slot

visiblep.

Generic Reader: yes-values (object)
Generic Writer: (setf yes-values) (object)
Package

net.didierverna.clon.

Methods
Reader Method: yes-values ((switch-base switch-base))
Writer Method: (setf yes-values) ((switch-base switch-base))

The possible ’yes’ values.

Source

switch-base.lisp.

Target Slot

yes-values.


6.2.5 Conditions

Condition: cmdline-error

An error related to a command-line item.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

item.

Direct slots
Slot: item

The concerned command-line item.

Initargs

:item

Readers

item.

Writers

This slot is read-only.

Condition: cmdline-junk-error

An error related to a command-line piece of junk.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Direct methods

junk.

Direct slots
Slot: item

The piece of junk appearing on the command-line.

Initargs

:junk, :item

Readers

junk.

Writers

This slot is read-only.

Condition: cmdline-option-error

An error related to a command-line (known) option.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses
Direct subclasses
Direct methods

name.

Direct slots
Slot: item

The option’s name as it appears on the command-line.

Initargs

:name, :item

Readers

name.

Writers

This slot is read-only.

Condition: environment-error

An error related to an environment variable.

Package

net.didierverna.clon.

Source

environ.lisp.

Direct superclasses

error.

Direct subclasses

environmental-option-error.

Direct methods

env-var.

Direct slots
Slot: env-var

The concerned environment variable.

Initargs

:env-var

Readers

env-var.

Writers

This slot is read-only.

Condition: environmental-option-error

An error related to an option’s environment variable.

Package

net.didierverna.clon.

Source

environ.lisp.

Direct superclasses
Direct subclasses

invalid-environment-value.

Condition: home-directory
Package

net.didierverna.clon.

Source

util.lisp.

Direct superclasses

warning.

Direct methods
Direct slots
Slot: error-string
Initargs

:error-string

Readers

error-string.

Writers

(setf error-string).

Condition: invalid-argument

An invalid argument error.

Package

net.didierverna.clon.

Source

valued.lisp.

Direct superclasses

option-error.

Direct subclasses
Direct methods
Direct slots
Slot: argument

The invalid argument.

Initargs

:argument

Readers

argument.

Writers

This slot is read-only.

Slot: comment

An additional comment about the error.

Initargs

:comment

Readers

comment.

Writers

This slot is read-only.

Condition: invalid-cmdline-argument

An invalid command-line argument error.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses
Condition: invalid-environment-value

An invalid environment variable’s value error.

Package

net.didierverna.clon.

Source

environ.lisp.

Direct superclasses
Direct methods

env-val.

Direct slots
Slot: argument

The invalid environment variable value.

Initargs

:env-val, :argument

Readers

env-val.

Writers

This slot is read-only.

Condition: invalid-negated-equal-syntax

An error related to a negated-equal syntax.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Condition: invalid-negated-syntax

An invalid negated syntax error.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses

cmdline-option-error.

Condition: invalid-short-equal-syntax

An error related to a short-equal syntax.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Condition: invalid-value

An invalid value error.

Package

net.didierverna.clon.

Source

valued.lisp.

Direct superclasses

option-error.

Direct methods
Direct slots
Slot: value

The invalid value.

Initargs

:value

Readers

value.

Writers

This slot is read-only.

Slot: comment

An additional comment about the error.

Initargs

:comment

Readers

comment.

Writers

This slot is read-only.

Condition: missing-cmdline-argument

A missing command-line argument error.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses

cmdline-option-error.

Condition: option-error

An error related to an option.

Package

net.didierverna.clon.

Source

option.lisp.

Direct superclasses

error.

Direct subclasses
Direct methods

option.

Direct slots
Slot: option

The concerned option.

Initargs

:option

Readers

option.

Writers

This slot is read-only.

Condition: spurious-cmdline-argument

A spurious command-line argument error.

Package

net.didierverna.clon.

Source

cmdline.lisp.

Direct superclasses

cmdline-option-error.

Direct methods

argument.

Direct slots
Slot: argument

The spurious argument.

Initargs

:argument

Readers

argument.

Writers

This slot is read-only.

Condition: unknown-cmdline-option-error

An error related to an unknown command-line option.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Direct methods
Direct slots
Slot: item

The option’s name as it appears on the command-line.

Initargs

:name, :item

Readers

name.

Writers

This slot is read-only.

Slot: argument

The option’s command-line argument.

Initargs

:argument

Readers

argument.

Writers

This slot is read-only.

Condition: unrecognized-negated-call-error

An error related to an unrecognized negated call.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Direct methods

negated-call.

Direct slots
Slot: item

The unrecognized negated call on the command-line.

Initargs

:negated-call, :item

Readers

negated-call.

Writers

This slot is read-only.

Condition: unrecognized-short-call-error

An error related to an unrecognized short call.

Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

cmdline-error.

Direct methods

short-call.

Direct slots
Slot: item

The unrecognized short call on the command-line.

Initargs

:short-call, :item

Readers

short-call.

Writers

This slot is read-only.


6.2.6 Structures

Structure: cmdline-option
Package

net.didierverna.clon.

Source

context.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Readers

cmdline-option-name.

Writers

(setf cmdline-option-name).

Slot: option
Readers

cmdline-option-option.

Writers

(setf cmdline-option-option).

Slot: value
Readers

cmdline-option-value.

Writers

(setf cmdline-option-value).

Slot: source
Readers

cmdline-option-source.

Writers

(setf cmdline-option-source).

Structure: frame

The FRAME structure.
This structure hold layout properties used for printing.

Package

net.didierverna.clon.

Source

sheet.lisp.

Direct superclasses

structure-object.

Direct subclasses

highlight-frame.

Direct methods
Direct slots
Slot: sface
Readers

frame-sface.

Writers

(setf frame-sface).

Slot: left-margin
Readers

frame-left-margin.

Writers

(setf frame-left-margin).

Slot: right-margin
Readers

frame-right-margin.

Writers

(setf frame-right-margin).

Structure: highlight-frame

The HIGHLIGHT-FRAME structure.
This structure holds both layout and highlight properties used for printing.

Package

net.didierverna.clon.

Source

sheet.lisp.

Direct superclasses

frame.

Direct methods
Direct slots
Slot: highlight-property-instances
Readers

highlight-frame-highlight-property-instances.

Writers

(setf highlight-frame-highlight-property-instances).

Structure: highlight-property-instance

The HIGHLIGHT-PROPERTY-INSTANCE structure.

Package

net.didierverna.clon.

Source

sheet.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: name
Readers

highlight-property-instance-name.

Writers

(setf highlight-property-instance-name).

Slot: value
Readers

highlight-property-instance-value.

Writers

(setf highlight-property-instance-value).


6.2.7 Classes

Class: abstract-class

The ABSTRACT-CLASS class.
This is the meta-class for abstract classes.

Package

net.didierverna.clon.

Source

util.lisp.

Direct superclasses

standard-class.

Direct methods
Class: container

The CONTAINER class.
This class is a mixin used in synopsis and groups to represent the program’s command-line hierarchy.

Package

net.didierverna.clon.

Source

container.lisp.

Direct superclasses

item.

Direct subclasses
Direct methods
Direct slots
Slot: items

The items in the container.

Type

list

Initargs

:items

Readers

items.

Writers

This slot is read-only.

Class: context

The CONTEXT class.
This class represents the associatiion of a synopsis and a set of command-line options based on it.

Package

net.didierverna.clon.

Source

context.lisp.

Direct methods
Direct Default Initargs
InitargValue
:cmdline(cmdline)
Direct slots
Slot: synopsis

The program synopsis.

Type

net.didierverna.clon::synopsis

Initform

net.didierverna.clon:*synopsis*

Initargs

:synopsis

Readers

synopsis.

Writers

This slot is read-only.

Slot: progname

The program name as it appears on the command-line.

Type

string

Slot: cmdline-options

The options from the command-line.

Type

list

Readers

cmdline-options.

Writers

(setf cmdline-options).

Slot: remainder

The non-Clon part of the command-line.

Type

list

Slot: search-path

The search path for Clon files.

Readers

search-path.

Writers

This slot is read-only.

Slot: theme

The theme filename.

Readers

theme.

Writers

This slot is read-only.

Slot: line-width

The line width for help display.

Readers

line-width.

Writers

This slot is read-only.

Slot: highlight

Clon’s output highlight mode.

Readers

highlight.

Writers

This slot is read-only.

Slot: error-handler

The behavior to adopt on option retrieval errors.

Type

symbol

Initform

:quit

Readers

error-handler.

Writers

This slot is read-only.

Class: enum

The ENUM class.
This class implements options whose values belong to a set of keywords.

Package

net.didierverna.clon.

Source

enum.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: argument-name
Initform

"type"

Class: enum-base

The ENUM-BASE abstract class.
This class provides support for options including enumerated values.

Package

net.didierverna.clon.

Source

enum-base.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: enum

The set of possible values.

Initargs

:enum

Readers

enum.

Writers

This slot is read-only.

Class: face

The FACE class.

Package

net.didierverna.clon.

Source

face.lisp.

Direct subclasses

sface.

Direct methods
Direct slots
Slot: name

The face name.

Initargs

:name

Readers

name.

Writers

This slot is read-only.

Slot: visiblep

Whether the face is visible.

Initform

t

Initargs

:visible

Readers

visiblep.

Writers

This slot is read-only.

Slot: left-padding

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.

Initform

0

Initargs

:padding-left

Readers

left-padding.

Writers

This slot is read-only.

Slot: right-padding

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.

Initform

(quote net.didierverna.clon::self)

Initargs

:padding-right

Readers

right-padding.

Writers

This slot is read-only.

Slot: top-padding

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.

Initargs

:padding-top

Readers

top-padding.

Writers

This slot is read-only.

Slot: bottom-padding

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.

Initargs

:padding-bottom

Readers

bottom-padding.

Writers

This slot is read-only.

Slot: item-separator

The face item separator.

Initform

#\

Initargs

:item-separator

Readers

item-separator.

Writers

This slot is read-only.

Slot: intensity

The face intensity.

Initargs

:intensity

Readers

intensity.

Writers

This slot is read-only.

Slot: italicp

The face’s italic status.

Initargs

:italic

Readers

italicp.

Writers

This slot is read-only.

Slot: underline

The face’s underline level.

Initargs

:underline

Readers

underline.

Writers

This slot is read-only.

The face’s blink speed.

Initargs

:blink

Readers

blink.

Writers

This slot is read-only.

Slot: inversep

The face’s inverse video status.

Initargs

:inverse

Readers

inversep.

Writers

This slot is read-only.

Slot: concealedp

The face’s concealed status.

Initargs

:concealed

Readers

concealedp.

Writers

This slot is read-only.

Slot: crossed-out-p

The face’s crossed out status.

Initargs

:crossed-out

Readers

crossed-out-p.

Writers

This slot is read-only.

Slot: framedp

The face’s framed status.

Initargs

:framed

Readers

framedp.

Writers

This slot is read-only.

Slot: foreground

The face foreground.

Initargs

:foreground

Readers

foreground.

Writers

This slot is read-only.

Slot: background

The face background.

Initargs

:background

Readers

background.

Writers

This slot is read-only.

Slot: subfaces

The face children.

Initargs

:subfaces

Readers

subfaces.

Writers

This slot is read-only.

Slot: parent

The face parent.

Readers

parent.

Writers

This slot is read-only.

Class: flag

The FLAG class.
This class implements options that don’t take any argument.

Package

net.didierverna.clon.

Source

flag.lisp.

Direct superclasses

option.

Direct methods

retrieve-from-environment.

Class: group

The GROUP class.
This class groups other groups, options or strings together, effectively implementing hierarchical program command-line.

Package

net.didierverna.clon.

Source

group.lisp.

Direct superclasses

container.

Direct methods
Direct slots
Slot: header

The group’s header.

Initargs

:header

Readers

header.

Writers

This slot is read-only.

Class: item

The ITEM class.
This class is the base class for all synopsis items.

Package

net.didierverna.clon.

Source

item.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: traversedp

The item’s traversal state.

Readers

traversedp.

Writers

(setf traversedp).

Slot: hiddenp

Whether the item is hidden in help strings.

Initargs

:hidden

Readers

hiddenp.

Writers

This slot is read-only.

Class: lispobj

The LISPOBJ class.
This class implements read-from-string options.

Package

net.didierverna.clon.

Source

lispobj.lisp.

Direct superclasses

valued-option.

Direct methods
Direct slots
Slot: argument-name
Initform

"obj"

Slot: typespec

A type specifier the option’s value should satisfy.

Initform

t

Initargs

:typespec

Readers

typespec.

Writers

This slot is read-only.

Class: negatable

The NEGATABLE Class.
This class implements the negated syntax for the switch-based hierarchy.

Package

net.didierverna.clon.

Source

negatable.lisp.

Direct subclasses

switch-base.

Direct methods
Class: option

The OPTION class.
This is the base class for all options.

Package

net.didierverna.clon.

Source

option.lisp.

Direct superclasses

item.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:internalnil
Direct slots
Slot: short-name

The option’s short name.

Type

(or null string)

Initargs

:short-name

Readers

short-name.

Writers

This slot is read-only.

Slot: long-name

The option’s long name.

Type

(or null string)

Initargs

:long-name

Readers

long-name.

Writers

This slot is read-only.

Slot: description

The option’s description.

Type

(or null string)

Initargs

:description

Readers

description.

Writers

This slot is read-only.

Slot: env-var

The option’s associated environment variable.

Type

(or null string)

Initargs

:env-var

Readers

env-var.

Writers

This slot is read-only.

Class: path

The PATH class.
This class implements options whose values are (colon-separated lists of) pathnames.

Package

net.didierverna.clon.

Source

path.lisp.

Direct superclasses

valued-option.

Direct methods
Direct slots
Slot: argument-name
Initform

"path"

Slot: path-type

The path type.

Initargs

:type

Readers

path-type.

Writers

This slot is read-only.

Class: sface

The SFACE class.
An SFace is the association of a face and its raw sibling. The sibling is used to create subfaces which would be missing from the original, user defined one.

Package

net.didierverna.clon.

Source

sheet.lisp.

Direct superclasses

face.

Direct methods

sibling.

Direct slots
Slot: sibling

The SFace’s raw sibling.

Readers

sibling.

Writers

This slot is read-only.

Class: sheet

The SHEET class.
This class implements the notion of sheet for printing Clon help.

Package

net.didierverna.clon.

Source

sheet.lisp.

Direct methods
Direct slots
Slot: output-stream

The sheet’s output stream.

Type

stream

Initargs

:output-stream

Readers

output-stream.

Writers

This slot is read-only.

Slot: line-width

The sheet’s line width.

Type

(integer 1)

Initargs

:line-width

Readers

line-width.

Writers

This slot is read-only.

Slot: highlightp

Whether to highlight SHEET’s output.

Initargs

:highlightp

Readers

highlightp.

Writers

This slot is read-only.

Slot: sface-tree

The sheet’s sface tree.

Readers

sface-tree.

Writers

This slot is read-only.

Slot: column

The sheet’s current column.

Type

(integer 0)

Initform

0

Readers

column.

Writers

(setf column).

Slot: frames

The stack of currently open frames.

Type

list

Readers

frames.

Writers

(setf frames).

Class: stropt

The STROPT class.
This class implements options the values of which are strings.

Package

net.didierverna.clon.

Source

stropt.lisp.

Direct superclasses

valued-option.

Direct methods
Direct slots
Slot: argument-name
Initform

"str"

Class: switch

The SWITCH class.
This class implements boolean options.

Package

net.didierverna.clon.

Source

switch.lisp.

Direct superclasses
Direct methods
Class: switch-base

The SWITCH-BASE abstract class.
This class provides support for options including boolean values.

Package

net.didierverna.clon.

Source

switch-base.lisp.

Direct superclasses

negatable.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:argument-typeoptional
:argument-styles(quote (yes/no on/off true/false yup/nope yeah/nah))
:yes-values(quote (yes on true yup yeah))
:no-values(quote (no off false nope nah))
Direct slots
Slot: argument-styles

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.

Type

list

Initargs

:argument-styles

Readers

argument-styles.

Writers

(setf argument-styles).

Slot: yes-values

The possible ’yes’ values.

Type

list

Initargs

:yes-values

Readers

yes-values.

Writers

(setf yes-values).

Slot: no-values

The possible ’no’ values.

Type

list

Initargs

:no-values

Readers

no-values.

Writers

(setf no-values).

Slot: argument-style

The selected argument style.

Type

keyword

Initform

:yes/no

Initargs

:argument-style

Readers

argument-style.

Writers

This slot is read-only.

Class: synopsis

The SYNOPSIS class.
This class handles the description of the program’s command-line options.

Package

net.didierverna.clon.

Source

synopsis.lisp.

Direct superclasses

container.

Direct methods
Direct slots
Slot: postfix

A postfix to the program synopsis.

Type

(or null string)

Initargs

:postfix

Readers

postfix.

Writers

This slot is read-only.

Slot: short-pack

The short pack string.

Type

(or null string)

Readers

short-pack.

Writers

This slot is read-only.

Slot: negated-pack

The negated pack string.

Type

(or null string)

Readers

negated-pack.

Writers

This slot is read-only.

Slot: potential-pack

The potential pack string.

Type

(or null string)

Readers

potential-pack.

Writers

This slot is read-only.

Slot: clon-options-group

The Clon options group.

Type

net.didierverna.clon::group

Initargs

:clon-options-group

Readers

clon-options-group.

Writers

This slot is read-only.

Class: text

The TEXT class.
This class implements plain text objects appearing in a synopsis.

Package

net.didierverna.clon.

Source

text.lisp.

Direct superclasses

item.

Direct methods
Direct slots
Slot: contents

The actual text string.

Type

string

Initargs

:contents

Readers

contents.

Writers

This slot is read-only.

Class: valued-option

The VALUED-OPTION class.
This is the base class for options accepting arguments.

Package

net.didierverna.clon.

Source

valued.lisp.

Direct superclasses

option.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:argument-typerequired
Direct slots
Slot: argument-name

The option’s argument display name.

Initform

"arg"

Initargs

:argument-name

Readers

argument-name.

Writers

This slot is read-only.

Slot: argument-required-p

Whether the option’s argument is required.

Readers

argument-required-p.

Writers

This slot is read-only.

Slot: fallback-value

The option’s fallback value.

Initargs

:fallback-value

Readers

fallback-value.

Writers

This slot is read-only.

Slot: default-value

The option’s default value.

Initargs

:default-value

Readers

default-value.

Writers

This slot is read-only.

Class: xswitch

The XSWITCH class.
This class merges the functionalities of switches and enumerations. As such, the negated syntax is available for extended xswitches.

Package

net.didierverna.clon.

Source

xswitch.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: enum

The set of possible non-boolean values.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (   ~  
A   B   C   D   E   F   G   H   I   J   L   M   N   O   P   R   S   T   U   V   W   Y  
Index Entry  Section

%
%defgroup: Private macros
%version: Private ordinary functions

(
(setf argument-styles): Private generic functions
(setf argument-styles): Private generic functions
(setf cmdline-option-name): Private ordinary functions
(setf cmdline-option-option): Private ordinary functions
(setf cmdline-option-source): Private ordinary functions
(setf cmdline-option-value): Private ordinary functions
(setf cmdline-options): Private generic functions
(setf cmdline-options): Private generic functions
(setf column): Private generic functions
(setf column): Private generic functions
(setf error-string): Private generic functions
(setf error-string): Private generic functions
(setf frame-left-margin): Private ordinary functions
(setf frame-right-margin): Private ordinary functions
(setf frame-sface): Private ordinary functions
(setf frames): Private generic functions
(setf frames): Private generic functions
(setf highlight-frame-highlight-property-instances): Private ordinary functions
(setf highlight-frame-left-margin): Private ordinary functions
(setf highlight-frame-right-margin): Private ordinary functions
(setf highlight-frame-sface): Private ordinary functions
(setf highlight-property-instance-name): Private ordinary functions
(setf highlight-property-instance-value): Private ordinary functions
(setf no-values): Private generic functions
(setf no-values): Private generic functions
(setf traversedp): Private generic functions
(setf traversedp): Private generic functions
(setf yes-values): Private generic functions
(setf yes-values): Private generic functions

~
~-reader: Private ordinary functions

A
accumulate: Private macros
add-subface: Private ordinary functions
argument: Private generic functions
argument: Private generic functions
argument: Private generic functions
argument: Private generic functions
argument-name: Private generic functions
argument-name: Private generic functions
argument-popable-p: Private ordinary functions
argument-required-p: Private generic functions
argument-required-p: Private generic functions
argument-style: Private generic functions
argument-style: Private generic functions
argument-styles: Private generic functions
argument-styles: Private generic functions
attach-face-tree: Private ordinary functions
available-right-margin: Private ordinary functions

B
background: Private generic functions
background: Private generic functions
beginning-of-string-p: Private ordinary functions
blink: Private generic functions
blink: Private generic functions
bottom-padding: Private generic functions
bottom-padding: Private generic functions

C
check: Private generic functions
check: Private generic functions
check: Private generic functions
check: Private generic functions
check: Private generic functions
check: Private generic functions
check: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
check-name-clash: Private generic functions
clindent: Private ordinary functions
clon-options-group: Private generic functions
clon-options-group: Private generic functions
clon-options-group: Private generic functions
close-frame: Private generic functions
close-frame: Private generic functions
close-frame: Private generic functions
close-line: Private ordinary functions
close-sface: Private ordinary functions
closest-match: Private ordinary functions
cmdline: Public ordinary functions
cmdline-convert: Private ordinary functions
cmdline-option-name: Private ordinary functions
cmdline-option-option: Private ordinary functions
cmdline-option-p: Private ordinary functions
cmdline-option-source: Private ordinary functions
cmdline-option-value: Private ordinary functions
cmdline-options: Private generic functions
cmdline-options: Private generic functions
cmdline-options-p: Public ordinary functions
cmdline-p: Public ordinary functions
column: Private generic functions
column: Private generic functions
comment: Private generic functions
comment: Private generic functions
comment: Private generic functions
complete-string: Private ordinary functions
concealedp: Private generic functions
concealedp: Private generic functions
configuration: Public ordinary functions
configure: Public ordinary functions
contents: Private generic functions
contents: Private generic functions
convert: Private generic functions
convert: Private generic functions
convert: Private generic functions
convert: Private generic functions
convert: Private generic functions
convert: Private generic functions
convert: Private generic functions
copy-cmdline-option: Private ordinary functions
copy-frame: Private ordinary functions
copy-highlight-frame: Private ordinary functions
copy-highlight-property-instance: Private ordinary functions
copy-instance: Private generic functions
copy-instance: Private generic functions
crossed-out-p: Private generic functions
crossed-out-p: Private generic functions
current-frame: Private ordinary functions
current-left-margin: Private ordinary functions
current-right-margin: Private ordinary functions
current-sface: Private ordinary functions

D
declare-valid-superclass: Private macros
defabstract: Private macros
default-value: Private generic functions
default-value: Private generic functions
defgroup: Public macros
defindent: Private macros
defoption: Private macros
defsynopsis: Public macros
description: Private generic functions
description: Private generic functions
directory-pathname-p: Private ordinary functions
do-cmdline-options: Public macros
do-options: Private macros
dump: Public macros

E
econd: Private macros
endpush: Private macros
enum: Private generic functions
enum: Private generic functions
env-val: Private generic functions
env-val: Private generic functions
env-var: Private generic functions
env-var: Private generic functions
env-var: Private generic functions
environment-convert: Private ordinary functions
error-handler: Private generic functions
error-handler: Private generic functions
error-string: Private generic functions
error-string: Private generic functions
executablep: Public ordinary functions
exit: Public ordinary functions
exit-abnormally: Private ordinary functions

F
face-highlight-property-set-p: Private ordinary functions
face-highlight-property-value: Private ordinary functions
fallback-value: Private generic functions
fallback-value: Private generic functions
find-sface: Private ordinary functions
flush-sheet: Private ordinary functions
foreground: Private generic functions
foreground: Private generic functions
frame-left-margin: Private ordinary functions
frame-p: Private ordinary functions
frame-right-margin: Private ordinary functions
frame-sface: Private ordinary functions
framedp: Private generic functions
framedp: Private generic functions
frames: Private generic functions
frames: Private generic functions
Function, %version: Private ordinary functions
Function, (setf cmdline-option-name): Private ordinary functions
Function, (setf cmdline-option-option): Private ordinary functions
Function, (setf cmdline-option-source): Private ordinary functions
Function, (setf cmdline-option-value): Private ordinary functions
Function, (setf frame-left-margin): Private ordinary functions
Function, (setf frame-right-margin): Private ordinary functions
Function, (setf frame-sface): Private ordinary functions
Function, (setf highlight-frame-highlight-property-instances): Private ordinary functions
Function, (setf highlight-frame-left-margin): Private ordinary functions
Function, (setf highlight-frame-right-margin): Private ordinary functions
Function, (setf highlight-frame-sface): Private ordinary functions
Function, (setf highlight-property-instance-name): Private ordinary functions
Function, (setf highlight-property-instance-value): Private ordinary functions
Function, add-subface: Private ordinary functions
Function, argument-popable-p: Private ordinary functions
Function, attach-face-tree: Private ordinary functions
Function, available-right-margin: Private ordinary functions
Function, beginning-of-string-p: Private ordinary functions
Function, clindent: Private ordinary functions
Function, close-line: Private ordinary functions
Function, close-sface: Private ordinary functions
Function, closest-match: Private ordinary functions
Function, cmdline: Public ordinary functions
Function, cmdline-convert: Private ordinary functions
Function, cmdline-option-name: Private ordinary functions
Function, cmdline-option-option: Private ordinary functions
Function, cmdline-option-p: Private ordinary functions
Function, cmdline-option-source: Private ordinary functions
Function, cmdline-option-value: Private ordinary functions
Function, cmdline-options-p: Public ordinary functions
Function, cmdline-p: Public ordinary functions
Function, complete-string: Private ordinary functions
Function, configuration: Public ordinary functions
Function, configure: Public ordinary functions
Function, copy-cmdline-option: Private ordinary functions
Function, copy-frame: Private ordinary functions
Function, copy-highlight-frame: Private ordinary functions
Function, copy-highlight-property-instance: Private ordinary functions
Function, current-frame: Private ordinary functions
Function, current-left-margin: Private ordinary functions
Function, current-right-margin: Private ordinary functions
Function, current-sface: Private ordinary functions
Function, directory-pathname-p: Private ordinary functions
Function, environment-convert: Private ordinary functions
Function, executablep: Public ordinary functions
Function, exit: Public ordinary functions
Function, exit-abnormally: Private ordinary functions
Function, face-highlight-property-set-p: Private ordinary functions
Function, face-highlight-property-value: Private ordinary functions
Function, find-sface: Private ordinary functions
Function, flush-sheet: Private ordinary functions
Function, frame-left-margin: Private ordinary functions
Function, frame-p: Private ordinary functions
Function, frame-right-margin: Private ordinary functions
Function, frame-sface: Private ordinary functions
Function, get-top-padding: Private ordinary functions
Function, getenv: Private ordinary functions
Function, getopt: Public ordinary functions
Function, getopt-cmdline: Public ordinary functions
Function, help: Public ordinary functions
Function, help-spec-items-will-print: Private ordinary functions
Function, highlight-frame-highlight-property-instances: Private ordinary functions
Function, highlight-frame-left-margin: Private ordinary functions
Function, highlight-frame-p: Private ordinary functions
Function, highlight-frame-right-margin: Private ordinary functions
Function, highlight-frame-sface: Private ordinary functions
Function, highlight-property-instance-escape-sequence: Private ordinary functions
Function, highlight-property-instance-name: Private ordinary functions
Function, highlight-property-instance-p: Private ordinary functions
Function, highlight-property-instance-value: Private ordinary functions
Function, home-directory: Private ordinary functions
Function, i-reader: Private ordinary functions
Function, list-to-string: Private ordinary functions
Function, macosp: Private ordinary functions
Function, make-cmdline-option: Private ordinary functions
Function, make-context: Public ordinary functions
Function, make-enum: Public ordinary functions
Function, make-flag: Public ordinary functions
Function, make-frame: Private ordinary functions
Function, make-group: Public ordinary functions
Function, make-highlight-frame: Private ordinary functions
Function, make-highlight-property-instance: Private ordinary functions
Function, make-internal-enum: Private ordinary functions
Function, make-internal-flag: Private ordinary functions
Function, make-internal-lispobj: Private ordinary functions
Function, make-internal-path: Private ordinary functions
Function, make-internal-stropt: Private ordinary functions
Function, make-internal-switch: Private ordinary functions
Function, make-internal-text: Private ordinary functions
Function, make-internal-xswitch: Private ordinary functions
Function, make-lispobj: Public ordinary functions
Function, make-path: Public ordinary functions
Function, make-raw-face-tree: Private ordinary functions
Function, make-raw-sface: Private ordinary functions
Function, make-sheet: Private ordinary functions
Function, make-stropt: Public ordinary functions
Function, make-switch: Public ordinary functions
Function, make-synopsis: Public ordinary functions
Function, make-text: Public ordinary functions
Function, make-xswitch: Public ordinary functions
Function, match-option: Private ordinary functions
Function, nickname-package: Public ordinary functions
Function, open-line: Private ordinary functions
Function, open-next-line: Private ordinary functions
Function, open-sface: Private ordinary functions
Function, option-abbreviation-distance: Private ordinary functions
Function, option-call-p: Private ordinary functions
Function, parent-generation: Private ordinary functions
Function, pathname-component-null-p: Private ordinary functions
Function, pop-frame: Private ordinary functions
Function, potential-pack-char: Private ordinary functions
Function, princ-char: Private ordinary functions
Function, princ-highlight-property-instances: Private ordinary functions
Function, princ-spaces: Private ordinary functions
Function, princ-string: Private ordinary functions
Function, print-error: Private ordinary functions
Function, print-faced-help-spec: Private ordinary functions
Function, print-help: Private ordinary functions
Function, print-string: Private ordinary functions
Function, progname: Public ordinary functions
Function, push-frame: Private ordinary functions
Function, putenv: Private ordinary functions
Function, reach-column: Private ordinary functions
Function, read-argument: Private ordinary functions
Function, read-call: Private ordinary functions
Function, read-env-val: Private ordinary functions
Function, read-long-name: Private ordinary functions
Function, read-sface-tree: Private ordinary functions
Function, read-value: Private ordinary functions
Function, release-status-number: Private ordinary functions
Function, remainder: Public ordinary functions
Function, remove-keys: Private ordinary functions
Function, replace-key: Private ordinary functions
Function, replace-keys: Private ordinary functions
Function, restart-on-error: Private ordinary functions
Function, restartable-check: Private ordinary functions
Function, restartable-cmdline-convert: Private ordinary functions
Function, restartable-cmdline-junk-error: Private ordinary functions
Function, restartable-convert: Private ordinary functions
Function, restartable-environment-convert: Private ordinary functions
Function, restrict-because: Private ordinary functions
Function, safe-left-margin: Private ordinary functions
Function, safe-right-margin: Private ordinary functions
Function, search-branch: Private ordinary functions
Function, search-face: Private ordinary functions
Function, search-option: Private ordinary functions
Function, search-option-by-abbreviation: Private ordinary functions
Function, search-option-by-name: Private ordinary functions
Function, search-sticky-option: Private ordinary functions
Function, select-keys: Private ordinary functions
Function, setup-termio: Public ordinary functions
Function, split-path: Private ordinary functions
Function, stream-line-width: Private ordinary functions
Function, try-read-sface-tree: Private ordinary functions
Function, try-read-theme: Private ordinary functions
Function, version: Public ordinary functions
Function, ~-reader: Private ordinary functions

G
Generic Function, (setf argument-styles): Private generic functions
Generic Function, (setf cmdline-options): Private generic functions
Generic Function, (setf column): Private generic functions
Generic Function, (setf error-string): Private generic functions
Generic Function, (setf frames): Private generic functions
Generic Function, (setf no-values): Private generic functions
Generic Function, (setf traversedp): Private generic functions
Generic Function, (setf yes-values): Private generic functions
Generic Function, argument: Private generic functions
Generic Function, argument-name: Private generic functions
Generic Function, argument-required-p: Private generic functions
Generic Function, argument-style: Private generic functions
Generic Function, argument-styles: Private generic functions
Generic Function, background: Private generic functions
Generic Function, blink: Private generic functions
Generic Function, bottom-padding: Private generic functions
Generic Function, check: Private generic functions
Generic Function, check-name-clash: Private generic functions
Generic Function, clon-options-group: Private generic functions
Generic Function, close-frame: Private generic functions
Generic Function, cmdline-options: Private generic functions
Generic Function, column: Private generic functions
Generic Function, comment: Private generic functions
Generic Function, concealedp: Private generic functions
Generic Function, contents: Private generic functions
Generic Function, convert: Private generic functions
Generic Function, copy-instance: Private generic functions
Generic Function, crossed-out-p: Private generic functions
Generic Function, default-value: Private generic functions
Generic Function, description: Private generic functions
Generic Function, enum: Private generic functions
Generic Function, env-val: Private generic functions
Generic Function, env-var: Private generic functions
Generic Function, error-handler: Private generic functions
Generic Function, error-string: Private generic functions
Generic Function, fallback-value: Private generic functions
Generic Function, foreground: Private generic functions
Generic Function, framedp: Private generic functions
Generic Function, frames: Private generic functions
Generic Function, get-bottom-padding: Private generic functions
Generic Function, header: Private generic functions
Generic Function, help-spec: Private generic functions
Generic Function, help-spec-will-print: Private generic functions
Generic Function, hiddenp: Private generic functions
Generic Function, highlight: Private generic functions
Generic Function, highlightp: Private generic functions
Generic Function, intensity: Private generic functions
Generic Function, inversep: Private generic functions
Generic Function, italicp: Private generic functions
Generic Function, item: Private generic functions
Generic Function, item-separator: Private generic functions
Generic Function, items: Private generic functions
Generic Function, junk: Private generic functions
Generic Function, left-padding: Private generic functions
Generic Function, line-width: Private generic functions
Generic Function, long-name: Private generic functions
Generic Function, make-face-tree: Private generic functions
Generic Function, mapoptions: Private generic functions
Generic Function, name: Private generic functions
Generic Function, negated-call: Private generic functions
Generic Function, negated-pack: Private generic functions
Generic Function, negated-pack-char: Private generic functions
Generic Function, no-values: Private generic functions
Generic Function, open-frame: Private generic functions
Generic Function, option: Private generic functions
Generic Function, option-sticky-distance: Private generic functions
Generic Function, output-stream: Private generic functions
Generic Function, parent: Private generic functions
Generic Function, path-type: Private generic functions
Generic Function, postfix: Private generic functions
Generic Function, potential-pack: Private generic functions
Generic Function, potential-pack-p: Private generic functions
Generic Function, print-help-spec: Private generic functions
Generic Function, retrieve-from-environment: Private generic functions
Generic Function, retrieve-from-long-call: Private generic functions
Generic Function, retrieve-from-negated-call: Private generic functions
Generic Function, retrieve-from-short-call: Private generic functions
Generic Function, right-padding: Private generic functions
Generic Function, search-path: Private generic functions
Generic Function, sface-tree: Private generic functions
Generic Function, short-call: Private generic functions
Generic Function, short-name: Private generic functions
Generic Function, short-pack: Private generic functions
Generic Function, short-pack-char: Private generic functions
Generic Function, short-syntax-help-spec-prefix: Private generic functions
Generic Function, sibling: Private generic functions
Generic Function, stream-ioctl-output-handle: Private generic functions
Generic Function, stringify: Private generic functions
Generic Function, subface: Private generic functions
Generic Function, subfaces: Private generic functions
Generic Function, synopsis: Private generic functions
Generic Function, theme: Private generic functions
Generic Function, top-padding: Private generic functions
Generic Function, traversedp: Private generic functions
Generic Function, typespec: Private generic functions
Generic Function, underline: Private generic functions
Generic Function, untraverse: Private generic functions
Generic Function, value: Private generic functions
Generic Function, visiblep: Private generic functions
Generic Function, yes-values: Private generic functions
get-bottom-padding: Private generic functions
get-bottom-padding: Private generic functions
get-bottom-padding: Private generic functions
get-top-padding: Private ordinary functions
getenv: Private ordinary functions
getopt: Public ordinary functions
getopt-cmdline: Public ordinary functions

H
header: Private generic functions
header: Private generic functions
help: Public ordinary functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec: Private generic functions
help-spec-items-will-print: Private ordinary functions
help-spec-will-print: Private generic functions
help-spec-will-print: Private generic functions
help-spec-will-print: Private generic functions
help-spec-will-print: Private generic functions
hiddenp: Private generic functions
hiddenp: Private generic functions
highlight: Private generic functions
highlight: Private generic functions
highlight-frame-highlight-property-instances: Private ordinary functions
highlight-frame-left-margin: Private ordinary functions
highlight-frame-p: Private ordinary functions
highlight-frame-right-margin: Private ordinary functions
highlight-frame-sface: Private ordinary functions
highlight-property-ecase: Private macros
highlight-property-instance-escape-sequence: Private ordinary functions
highlight-property-instance-name: Private ordinary functions
highlight-property-instance-p: Private ordinary functions
highlight-property-instance-value: Private ordinary functions
highlightp: Private generic functions
highlightp: Private generic functions
home-directory: Private ordinary functions

I
i-reader: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
intensity: Private generic functions
intensity: Private generic functions
inversep: Private generic functions
inversep: Private generic functions
italicp: Private generic functions
italicp: Private generic functions
item: Private generic functions
item: Private generic functions
item-separator: Private generic functions
item-separator: Private generic functions
items: Private generic functions
items: Private generic functions

J
junk: Private generic functions
junk: Private generic functions

L
left-padding: Private generic functions
left-padding: Private generic functions
line-width: Private generic functions
line-width: Private generic functions
line-width: Private generic functions
list-to-string: Private ordinary functions
long-name: Private generic functions
long-name: Private generic functions

M
macosp: Private ordinary functions
Macro, %defgroup: Private macros
Macro, accumulate: Private macros
Macro, declare-valid-superclass: Private macros
Macro, defabstract: Private macros
Macro, defgroup: Public macros
Macro, defindent: Private macros
Macro, defoption: Private macros
Macro, defsynopsis: Public macros
Macro, do-cmdline-options: Public macros
Macro, do-options: Private macros
Macro, dump: Public macros
Macro, econd: Private macros
Macro, endpush: Private macros
Macro, highlight-property-ecase: Private macros
Macro, map-frames: Private macros
Macro, maybe-pop-argument: Private macros
Macro, maybe-push: Private macros
Macro, multiple-value-getopt-cmdline: Public macros
Macro, replace-in-keys: Private macros
Macro, restartable-invalid-negated-syntax-error: Private macros
Macro, restartable-spurious-cmdline-argument-error: Private macros
Macro, with-context: Public macros
Macro, with-context-error-handler: Private macros
make-cmdline-option: Private ordinary functions
make-context: Public ordinary functions
make-enum: Public ordinary functions
make-face-tree: Private generic functions
make-face-tree: Private generic functions
make-face-tree: Private generic functions
make-flag: Public ordinary functions
make-frame: Private ordinary functions
make-group: Public ordinary functions
make-highlight-frame: Private ordinary functions
make-highlight-property-instance: Private ordinary functions
make-instance: Public standalone methods
make-internal-enum: Private ordinary functions
make-internal-flag: Private ordinary functions
make-internal-lispobj: Private ordinary functions
make-internal-path: Private ordinary functions
make-internal-stropt: Private ordinary functions
make-internal-switch: Private ordinary functions
make-internal-text: Private ordinary functions
make-internal-xswitch: Private ordinary functions
make-lispobj: Public ordinary functions
make-path: Public ordinary functions
make-raw-face-tree: Private ordinary functions
make-raw-sface: Private ordinary functions
make-sheet: Private ordinary functions
make-stropt: Public ordinary functions
make-switch: Public ordinary functions
make-synopsis: Public ordinary functions
make-text: Public ordinary functions
make-xswitch: Public ordinary functions
map-frames: Private macros
mapoptions: Private generic functions
mapoptions: Private generic functions
mapoptions: Private generic functions
mapoptions: Private generic functions
mapoptions: Private generic functions
mapoptions: Private generic functions
match-option: Private ordinary functions
maybe-pop-argument: Private macros
maybe-push: Private macros
Method, (setf argument-styles): Private generic functions
Method, (setf cmdline-options): Private generic functions
Method, (setf column): Private generic functions
Method, (setf error-string): Private generic functions
Method, (setf frames): Private generic functions
Method, (setf no-values): Private generic functions
Method, (setf traversedp): Private generic functions
Method, (setf yes-values): Private generic functions
Method, argument: Private generic functions
Method, argument: Private generic functions
Method, argument: Private generic functions
Method, argument-name: Private generic functions
Method, argument-required-p: Private generic functions
Method, argument-style: Private generic functions
Method, argument-styles: Private generic functions
Method, background: Private generic functions
Method, blink: Private generic functions
Method, bottom-padding: Private generic functions
Method, check: Private generic functions
Method, check: Private generic functions
Method, check: Private generic functions
Method, check: Private generic functions
Method, check: Private generic functions
Method, check: Private generic functions
Method, check-name-clash: Private generic functions
Method, check-name-clash: Private generic functions
Method, check-name-clash: Private generic functions
Method, check-name-clash: Private generic functions
Method, check-name-clash: Private generic functions
Method, check-name-clash: Private generic functions
Method, clon-options-group: Private generic functions
Method, clon-options-group: Private generic functions
Method, close-frame: Private generic functions
Method, close-frame: Private generic functions
Method, cmdline-options: Private generic functions
Method, column: Private generic functions
Method, comment: Private generic functions
Method, comment: Private generic functions
Method, concealedp: Private generic functions
Method, contents: Private generic functions
Method, convert: Private generic functions
Method, convert: Private generic functions
Method, convert: Private generic functions
Method, convert: Private generic functions
Method, convert: Private generic functions
Method, convert: Private generic functions
Method, copy-instance: Private generic functions
Method, crossed-out-p: Private generic functions
Method, default-value: Private generic functions
Method, description: Private generic functions
Method, enum: Private generic functions
Method, env-val: Private generic functions
Method, env-var: Private generic functions
Method, env-var: Private generic functions
Method, error-handler: Private generic functions
Method, error-string: Private generic functions
Method, fallback-value: Private generic functions
Method, foreground: Private generic functions
Method, framedp: Private generic functions
Method, frames: Private generic functions
Method, get-bottom-padding: Private generic functions
Method, get-bottom-padding: Private generic functions
Method, header: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec: Private generic functions
Method, help-spec-will-print: Private generic functions
Method, help-spec-will-print: Private generic functions
Method, help-spec-will-print: Private generic functions
Method, hiddenp: Private generic functions
Method, highlight: Private generic functions
Method, highlightp: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, intensity: Private generic functions
Method, inversep: Private generic functions
Method, italicp: Private generic functions
Method, item: Private generic functions
Method, item-separator: Private generic functions
Method, items: Private generic functions
Method, junk: Private generic functions
Method, left-padding: Private generic functions
Method, line-width: Private generic functions
Method, line-width: Private generic functions
Method, long-name: Private generic functions
Method, make-face-tree: Private generic functions
Method, make-face-tree: Private generic functions
Method, make-instance: Public standalone methods
Method, mapoptions: Private generic functions
Method, mapoptions: Private generic functions
Method, mapoptions: Private generic functions
Method, mapoptions: Private generic functions
Method, mapoptions: Private generic functions
Method, name: Private generic functions
Method, name: Private generic functions
Method, name: Private generic functions
Method, negated-call: Private generic functions
Method, negated-pack: Private generic functions
Method, negated-pack: Private generic functions
Method, negated-pack-char: Private generic functions
Method, negated-pack-char: Private generic functions
Method, no-values: Private generic functions
Method, open-frame: Private generic functions
Method, open-frame: Private generic functions
Method, option: Private generic functions
Method, option-sticky-distance: Private generic functions
Method, option-sticky-distance: Private generic functions
Method, output-stream: Private generic functions
Method, parent: Private generic functions
Method, path-type: Private generic functions
Method, postfix: Private generic functions
Method, postfix: Private generic functions
Method, potential-pack: Private generic functions
Method, potential-pack-p: Private generic functions
Method, potential-pack-p: Private generic functions
Method, print-help-spec: Private generic functions
Method, print-help-spec: Private generic functions
Method, print-help-spec: Private generic functions
Method, print-help-spec: Private generic functions
Method, print-help-spec: Private generic functions
Method, retrieve-from-environment: Private generic functions
Method, retrieve-from-environment: Private generic functions
Method, retrieve-from-environment: Private generic functions
Method, retrieve-from-long-call: Private generic functions
Method, retrieve-from-long-call: Private generic functions
Method, retrieve-from-negated-call: Private generic functions
Method, retrieve-from-negated-call: Private generic functions
Method, retrieve-from-negated-call: Private generic functions
Method, retrieve-from-short-call: Private generic functions
Method, retrieve-from-short-call: Private generic functions
Method, right-padding: Private generic functions
Method, search-path: Private generic functions
Method, sface-tree: Private generic functions
Method, short-call: Private generic functions
Method, short-name: Private generic functions
Method, short-pack: Private generic functions
Method, short-pack: Private generic functions
Method, short-pack-char: Private generic functions
Method, short-pack-char: Private generic functions
Method, short-syntax-help-spec-prefix: Private generic functions
Method, short-syntax-help-spec-prefix: Private generic functions
Method, sibling: Private generic functions
Method, slot-unbound: Public standalone methods
Method, stream-ioctl-output-handle: Private generic functions
Method, stream-ioctl-output-handle: Private generic functions
Method, stream-ioctl-output-handle: Private generic functions
Method, stream-ioctl-output-handle: Private generic functions
Method, stringify: Private generic functions
Method, stringify: Private generic functions
Method, stringify: Private generic functions
Method, stringify: Private generic functions
Method, stringify: Private generic functions
Method, stringify: Private generic functions
Method, subface: Private generic functions
Method, subface: Private generic functions
Method, subfaces: Private generic functions
Method, synopsis: Private generic functions
Method, theme: Private generic functions
Method, top-padding: Private generic functions
Method, top-padding: Private generic functions
Method, top-padding: Private generic functions
Method, traversedp: Private generic functions
Method, typespec: Private generic functions
Method, underline: Private generic functions
Method, untraverse: Private generic functions
Method, untraverse: Private generic functions
Method, untraverse: Private generic functions
Method, untraverse: Private generic functions
Method, untraverse: Private generic functions
Method, validate-superclass: Public standalone methods
Method, validate-superclass: Public standalone methods
Method, value: Private generic functions
Method, visiblep: Private generic functions
Method, yes-values: Private generic functions
multiple-value-getopt-cmdline: Public macros

N
name: Private generic functions
name: Private generic functions
name: Private generic functions
name: Private generic functions
negated-call: Private generic functions
negated-call: Private generic functions
negated-pack: Private generic functions
negated-pack: Private generic functions
negated-pack: Private generic functions
negated-pack-char: Private generic functions
negated-pack-char: Private generic functions
negated-pack-char: Private generic functions
nickname-package: Public ordinary functions
no-values: Private generic functions
no-values: Private generic functions

O
open-frame: Private generic functions
open-frame: Private generic functions
open-frame: Private generic functions
open-line: Private ordinary functions
open-next-line: Private ordinary functions
open-sface: Private ordinary functions
option: Private generic functions
option: Private generic functions
option-abbreviation-distance: Private ordinary functions
option-call-p: Private ordinary functions
option-sticky-distance: Private generic functions
option-sticky-distance: Private generic functions
option-sticky-distance: Private generic functions
output-stream: Private generic functions
output-stream: Private generic functions

P
parent: Private generic functions
parent: Private generic functions
parent-generation: Private ordinary functions
path-type: Private generic functions
path-type: Private generic functions
pathname-component-null-p: Private ordinary functions
pop-frame: Private ordinary functions
postfix: Private generic functions
postfix: Private generic functions
postfix: Private generic functions
potential-pack: Private generic functions
potential-pack: Private generic functions
potential-pack-char: Private ordinary functions
potential-pack-p: Private generic functions
potential-pack-p: Private generic functions
potential-pack-p: Private generic functions
princ-char: Private ordinary functions
princ-highlight-property-instances: Private ordinary functions
princ-spaces: Private ordinary functions
princ-string: Private ordinary functions
print-error: Private ordinary functions
print-faced-help-spec: Private ordinary functions
print-help: Private ordinary functions
print-help-spec: Private generic functions
print-help-spec: Private generic functions
print-help-spec: Private generic functions
print-help-spec: Private generic functions
print-help-spec: Private generic functions
print-help-spec: Private generic functions
print-string: Private ordinary functions
progname: Public ordinary functions
push-frame: Private ordinary functions
putenv: Private ordinary functions

R
reach-column: Private ordinary functions
read-argument: Private ordinary functions
read-call: Private ordinary functions
read-env-val: Private ordinary functions
read-long-name: Private ordinary functions
read-sface-tree: Private ordinary functions
read-value: Private ordinary functions
release-status-number: Private ordinary functions
remainder: Public ordinary functions
remove-keys: Private ordinary functions
replace-in-keys: Private macros
replace-key: Private ordinary functions
replace-keys: Private ordinary functions
restart-on-error: Private ordinary functions
restartable-check: Private ordinary functions
restartable-cmdline-convert: Private ordinary functions
restartable-cmdline-junk-error: Private ordinary functions
restartable-convert: Private ordinary functions
restartable-environment-convert: Private ordinary functions
restartable-invalid-negated-syntax-error: Private macros
restartable-spurious-cmdline-argument-error: Private macros
restrict-because: Private ordinary functions
retrieve-from-environment: Private generic functions
retrieve-from-environment: Private generic functions
retrieve-from-environment: Private generic functions
retrieve-from-environment: Private generic functions
retrieve-from-long-call: Private generic functions
retrieve-from-long-call: Private generic functions
retrieve-from-long-call: Private generic functions
retrieve-from-negated-call: Private generic functions
retrieve-from-negated-call: Private generic functions
retrieve-from-negated-call: Private generic functions
retrieve-from-negated-call: Private generic functions
retrieve-from-short-call: Private generic functions
retrieve-from-short-call: Private generic functions
retrieve-from-short-call: Private generic functions
right-padding: Private generic functions
right-padding: Private generic functions

S
safe-left-margin: Private ordinary functions
safe-right-margin: Private ordinary functions
search-branch: Private ordinary functions
search-face: Private ordinary functions
search-option: Private ordinary functions
search-option-by-abbreviation: Private ordinary functions
search-option-by-name: Private ordinary functions
search-path: Private generic functions
search-path: Private generic functions
search-sticky-option: Private ordinary functions
select-keys: Private ordinary functions
setup-termio: Public ordinary functions
sface-tree: Private generic functions
sface-tree: Private generic functions
short-call: Private generic functions
short-call: Private generic functions
short-name: Private generic functions
short-name: Private generic functions
short-pack: Private generic functions
short-pack: Private generic functions
short-pack: Private generic functions
short-pack-char: Private generic functions
short-pack-char: Private generic functions
short-pack-char: Private generic functions
short-syntax-help-spec-prefix: Private generic functions
short-syntax-help-spec-prefix: Private generic functions
short-syntax-help-spec-prefix: Private generic functions
sibling: Private generic functions
sibling: Private generic functions
slot-unbound: Public standalone methods
split-path: Private ordinary functions
stream-ioctl-output-handle: Private generic functions
stream-ioctl-output-handle: Private generic functions
stream-ioctl-output-handle: Private generic functions
stream-ioctl-output-handle: Private generic functions
stream-ioctl-output-handle: Private generic functions
stream-line-width: Private ordinary functions
stringify: Private generic functions
stringify: Private generic functions
stringify: Private generic functions
stringify: Private generic functions
stringify: Private generic functions
stringify: Private generic functions
stringify: Private generic functions
subface: Private generic functions
subface: Private generic functions
subface: Private generic functions
subfaces: Private generic functions
subfaces: Private generic functions
synopsis: Private generic functions
synopsis: Private generic functions

T
theme: Private generic functions
theme: Private generic functions
top-padding: Private generic functions
top-padding: Private generic functions
top-padding: Private generic functions
top-padding: Private generic functions
traversedp: Private generic functions
traversedp: Private generic functions
try-read-sface-tree: Private ordinary functions
try-read-theme: Private ordinary functions
typespec: Private generic functions
typespec: Private generic functions

U
underline: Private generic functions
underline: Private generic functions
untraverse: Private generic functions
untraverse: Private generic functions
untraverse: Private generic functions
untraverse: Private generic functions
untraverse: Private generic functions
untraverse: Private generic functions

V
validate-superclass: Public standalone methods
validate-superclass: Public standalone methods
value: Private generic functions
value: Private generic functions
version: Public ordinary functions
visiblep: Private generic functions
visiblep: Private generic functions

W
with-context: Public macros
with-context-error-handler: Private macros

Y
yes-values: Private generic functions
yes-values: Private generic functions


A.3 Variables

Jump to:   *  
A   B   C   D   E   F   H   I   L   N   O   P   R   S   T   U   V   Y  
Index Entry  Section

*
*configuration*: Private special variables
*context*: Public special variables
*copyright-years*: Public special variables
*executablep*: Public special variables
*highlight-properties*: Private special variables
*item-names*: Private special variables
*release-major-level*: Public special variables
*release-minor-level*: Public special variables
*release-name*: Public special variables
*release-status*: Public special variables
*release-status-level*: Public special variables
*synopsis*: Public special variables

A
argument: Private conditions
argument: Private conditions
argument: Private conditions
argument: Private conditions
argument-name: Private classes
argument-name: Private classes
argument-name: Private classes
argument-name: Private classes
argument-name: Private classes
argument-required-p: Private classes
argument-style: Private classes
argument-styles: Private classes

B
background: Private classes
blink: Private classes
bottom-padding: Private classes

C
clon-options-group: Private classes
cmdline-options: Private classes
column: Private classes
comment: Private conditions
comment: Private conditions
concealedp: Private classes
contents: Private classes
crossed-out-p: Private classes

D
default-value: Private classes
description: Private classes

E
enum: Private classes
enum: Private classes
env-var: Private conditions
env-var: Private classes
error-handler: Private classes
error-string: Private conditions

F
fallback-value: Private classes
foreground: Private classes
framedp: Private classes
frames: Private classes

H
header: Private classes
hiddenp: Private classes
highlight: Private classes
highlight-property-instances: Private structures
highlightp: Private classes

I
intensity: Private classes
inversep: Private classes
italicp: Private classes
item: Private conditions
item: Private conditions
item: Private conditions
item: Private conditions
item: Private conditions
item: Private conditions
item-separator: Private classes
items: Private classes

L
left-margin: Private structures
left-padding: Private classes
line-width: Private classes
line-width: Private classes
long-name: Private classes

N
name: Private structures
name: Private structures
name: Private classes
negated-pack: Private classes
no-values: Private classes

O
option: Private conditions
option: Private structures
output-stream: Private classes

P
parent: Private classes
path-type: Private classes
postfix: Private classes
potential-pack: Private classes
progname: Private classes

R
remainder: Private classes
right-margin: Private structures
right-padding: Private classes

S
search-path: Private classes
sface: Private structures
sface-tree: Private classes
short-name: Private classes
short-pack: Private classes
sibling: Private classes
Slot, argument: Private conditions
Slot, argument: Private conditions
Slot, argument: Private conditions
Slot, argument: Private conditions
Slot, argument-name: Private classes
Slot, argument-name: Private classes
Slot, argument-name: Private classes
Slot, argument-name: Private classes
Slot, argument-name: Private classes
Slot, argument-required-p: Private classes
Slot, argument-style: Private classes
Slot, argument-styles: Private classes
Slot, background: Private classes
Slot, blink: Private classes
Slot, bottom-padding: Private classes
Slot, clon-options-group: Private classes
Slot, cmdline-options: Private classes
Slot, column: Private classes