The net.didierverna.clon Reference Manual

Table of Contents

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

The net.didierverna.clon Reference Manual

This is the net.didierverna.clon Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:01:42 2018 GMT+0.


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

1 Introduction

							     -*- outline -*-

* Copyright (C) 2010, 2011, 2015 Didier Verna

This file is part of Clon.

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.


* Introduction
In the Lisp family of languages, one of the key components is the so-called
REPL, the Read-Eval-Print Loop, which blends the runtime, compilation and
development phases together, allowing for a very high level of interaction
with the program. The importance of this paradigm explains why it is still
rare to find "standalone" applications written in Lisp: most Lisp application
clients are lispers themselves, and they prefer to live in the REPL.

On the other hand, many contemporary Common Lisp compilers provide ways of
creating standalone Common Lisp programs, using either shebang technology or
by directly dumping executables. This process is getting easier to achieve
every day. For instance, with SBCL, all it takes is one function call
(save-lisp-and-die) and one command-line option to the compiler (--script).

The (big) size of a Lisp image has been considered a showstopper in creating
standalone applications for a long time, but nowadays, it doesn't really
matter anymore (if you are not convinced, just figure out the average size of
an application bundle under Mac OS X). This, along with the fact that Common
Lisp compilers can generate very efficient code today, makes the perspective
of standalone Common Lisp applications very tempting again.

When it comes to preserving interaction with the user, one of the key
components in a standalone application is the handling of the command-line.
Clon is a library designed to do just that.


* Overview
Clon provides traditional features one might expect from a command-line
options management library, but what makes it somewhat unique in its
conception is that it has been designed with both the application developer
and the application user in mind: many aspects of the command-line management
usually imposed by the program are in fact under the control of the
application user. The idea is that all Clon-enabled applications behave in a
uniform way, and that it is the user who gets to decide, not the developper.
The most important features of Clon are listed below.

** Command-Line Syntax
Clon imposes a particular yet flexible syntax for the command-line. Options
have short and/or long names, beginning with either one or two dashes. Options
may take an argument. In that case, the argument may be optional or mandatory.
Option names may be abbreviated and one-character options may be grouped
together in a single call. There is an additional call syntax for Boolean or
Boolean-based options. Finally, the command-line may have a "postfix", that
is, a non-option part.

** Option Types
Clon comes with a set of predefined option types, including "flags" (option
without arguments), "switches" (Boolean options), simple Lisp objects, simple
strings, enumerations, pathnames etc. Clon is also extensible: it is possible
to define new option types, either from scratch or by subclassing an existing
one.

** Value Retrieval
The traditional approach to command-line analysis is to process it
sequentially, and Clon lets you do that. However, Clon also provides an
explicit retrieval mechanism by which you can directly request the value of a
specific option, regardless of its position, or even its presence on the
command-line. An option's value can be retrieved from different sources: a
command-line argument, a "fallback" value (for optional arguments), a default
value or an environment variable associated with the option. The retrieval
process is completely automated, hence removing this burden from the
developer's shoulders.

** Error Management
Another cumbersome task already taken care of is error management. Clon
provides two built-in error management schemes, in case something is wrong on
the command-line. The simplest one is to quit the application with an
informative error message. The other one is to enter an interactive dialog
with the user, in which it is possible to fix the problem (correct a typo,
discard an option call, provide a missing argument or value etc.). A unique
feature of Clon is that the application user may choose his or her preferred
error management scheme.

** Help String Contents
The "help string" is typically what you expect from the output of a --help
option. Maintaining an up-to-date help string is a very boring task, so Clon
completely automates this for you (another burden removed from the developer's
shoulders). However, the application programmer still has control over the
help string's contents, notably the order in which options are displayed, and
also by having the possibility of grouping options together and inserting
arbitrary text in the output.

** Help String Format
Clon also completely automates the help string typesetting process. For
instance, it can automatically format the output for 80 columns, but it is
also aware of the tty geometry and will use it when appropriate. Clon also
supports help string "fontification" (or "highlighting") through ISO/IEC 6429
SGR escape sequences on tty's that support it. Another unique feature of Clon
is that the exact format and highlight specification for the help string is
under the control of the application user, via the notion of "theme". Clon
comes with a set of predefined themes (for instance, standard, with heavy
fontification, refcard for quick reference etc.) and application users can
define their own. As a matter of fact, a theme not only controls the format
and highlight of the help string, but also its contents.


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

2 Systems

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


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

2.1 net.didierverna.clon

Maintainer

Didier Verna <didier@didierverna.net>

Author

Didier Verna <didier@didierverna.net>

License

BSD

Description

The Command-Line Options Nuker

Long Description

Clon is a library for command-line option management.
It is intended to ease the creation of standalone Common Lisp applications by providing a powerful and uniform command-line option interface.
The most important features of Clon are the following.
- [from the programmer’s point of view] Centralized command-line options specification and management, including automatic generation of help strings, conversion from command-line / environment strings to application-level option values, global or on-demand option retrieval, and extensibility (the programmer can define his own option types).
- [from the end-user’s point of view] Uniform command-line option syntax across Clon applications, customization of the help strings layout (with optional ISO6429 coloring on terminals that support it),
possibly abbreviated option calls and short/long syntax.

Dependencies
Source

net.didierverna.clon.asd (file)


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

2.2 net.didierverna.clon.termio

Maintainer

Didier Verna <didier@didierverna.net>

Author

Didier Verna <didier@didierverna.net>

License

BSD

Description

The Command-Line Options Nuker, termio feature

Long Description

Clon is a library for command-line option management.
The termio feature provides 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 (file)

Components

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

2.3 net.didierverna.clon.setup/termio

Dependency

net.didierverna.clon.setup (system)

Source

net.didierverna.clon.setup.asd (file)


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

2.4 net.didierverna.clon.core

Maintainer

Didier Verna <didier@didierverna.net>

Author

Didier Verna <didier@didierverna.net>

License

BSD

Description

The Command-Line Options Nuker, core library

Long Description

Clon is a library for command-line option management.
The 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 (file)

Components

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

2.5 net.didierverna.clon.setup

Source

net.didierverna.clon.setup.asd (file)

Component

setup.lisp (file)


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

3 Modules

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


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

3.1 net.didierverna.clon.core/src

Dependency

meta.lisp (file)

Parent

net.didierverna.clon.core (system)

Location

core/src/

Components

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

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

Dependency

text.lisp (file)

Parent

src (module)

Location

core/src/options/

Components

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

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

Dependency

options (module)

Parent

src (module)

Location

core/src/retrieval/

Components

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

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

Dependencies
Parent

src (module)

Location

core/src/output/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 net.didierverna.clon.asd

Location

net.didierverna.clon.asd

Systems

net.didierverna.clon (system)


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

4.1.2 net.didierverna.clon.termio.asd

Location

termio/net.didierverna.clon.termio.asd

Systems

net.didierverna.clon.termio (system)


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

4.1.3 net.didierverna.clon.core.asd

Location

core/net.didierverna.clon.core.asd

Systems

net.didierverna.clon.core (system)


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

4.1.4 net.didierverna.clon.setup.asd

Location

setup/net.didierverna.clon.setup.asd

Systems

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

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

If Feature

sbcl

Parent

net.didierverna.clon.termio (system)

Location

termio/sbcl/constants.lisp


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

4.1.6 net.didierverna.clon.termio/termio.lisp

Dependency

sbcl/constants.lisp (file)

Parent

net.didierverna.clon.termio (system)

Location

termio/termio.lisp


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

4.1.7 net.didierverna.clon.core/meta.lisp

Parent

net.didierverna.clon.core (system)

Location

core/meta.lisp

Packages

net.didierverna.clon

Exported Definitions

nickname-package (function)

Internal Definitions

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

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

Parent

src (module)

Location

core/src/util.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

util.lisp (file)

Parent

src (module)

Location

core/src/item.lisp

Internal Definitions

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

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

Dependency

item.lisp (file)

Parent

src (module)

Location

core/src/text.lisp

Exported Definitions

make-text (function)

Internal Definitions

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

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

Parent

options (module)

Location

core/src/options/option.lisp

Internal Definitions

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

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

Dependency

option.lisp (file)

Parent

options (module)

Location

core/src/options/flag.lisp

Exported Definitions

make-flag (function)

Internal Definitions

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

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

Dependency

option.lisp (file)

Parent

options (module)

Location

core/src/options/valued.lisp

Internal Definitions

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

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

Dependency

valued.lisp (file)

Parent

options (module)

Location

core/src/options/negatable.lisp

Internal Definitions

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

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

Dependency

negatable.lisp (file)

Parent

options (module)

Location

core/src/options/switch-base.lisp

Internal Definitions

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

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

Dependency

switch-base.lisp (file)

Parent

options (module)

Location

core/src/options/switch.lisp

Exported Definitions

make-switch (function)

Internal Definitions

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

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

Dependency

valued.lisp (file)

Parent

options (module)

Location

core/src/options/stropt.lisp

Exported Definitions

make-stropt (function)

Internal Definitions

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

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

Dependency

valued.lisp (file)

Parent

options (module)

Location

core/src/options/lispobj.lisp

Exported Definitions

make-lispobj (function)

Internal Definitions

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

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

Dependency

valued.lisp (file)

Parent

options (module)

Location

core/src/options/path.lisp

Exported Definitions

make-path (function)

Internal Definitions

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

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

Parent

options (module)

Location

core/src/options/enum-base.lisp

Internal Definitions

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

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

Dependencies
Parent

options (module)

Location

core/src/options/enum.lisp

Exported Definitions

make-enum (function)

Internal Definitions

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

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

Dependencies
Parent

options (module)

Location

core/src/options/xswitch.lisp

Exported Definitions

make-xswitch (function)

Internal Definitions

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

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

Dependency

options (module)

Parent

src (module)

Location

core/src/container.lisp

Internal Definitions

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

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

Dependency

container.lisp (file)

Parent

src (module)

Location

core/src/group.lisp

Exported Definitions
Internal Definitions

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

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

Parent

retrieval (module)

Location

core/src/retrieval/cmdline.lisp

Internal Definitions

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

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

Parent

retrieval (module)

Location

core/src/retrieval/environ.lisp

Internal Definitions

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

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

Dependency

group.lisp (file)

Parent

src (module)

Location

core/src/synopsis.lisp

Exported Definitions
Internal Definitions

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

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

Parent

output (module)

Location

core/src/output/face.lisp

Internal Definitions

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

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

Dependency

face.lisp (file)

Parent

output (module)

Location

core/src/output/sheet.lisp

Internal Definitions

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

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

Dependency

output (module)

Parent

src (module)

Location

core/src/context.lisp

Exported Definitions
Internal Definitions

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

4.1.31 net.didierverna.clon.setup/setup.lisp

Parent

net.didierverna.clon.setup (system)

Location

setup/setup.lisp

Packages

net.didierverna.clon.setup

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 net.didierverna.clon

The Command-Line Options Nuker package.

Source

meta.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.2 net.didierverna.clon.setup

The Command-Line Options Nuker, setup.

Source

setup.lisp (file)

Use List

common-lisp

Used By List

net.didierverna.clon

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *context*

The current context.

Package

net.didierverna.clon

Source

context.lisp (file)

Special Variable: *release-major-level*

The major level of this release.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Special Variable: *release-minor-level*

The minor level of this release.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Special Variable: *release-name*

The name of this release.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Special Variable: *release-status*

The status of this release.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Special Variable: *release-status-level*

The status level of this release.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Special Variable: *synopsis*

The current synopsis.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

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

setup.lisp (file)


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

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 (file)

Macro: defsynopsis (&rest KEYS &key POSTFIX MAKE-DEFAULT) &body FORMS

Define a new synopsis.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

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 (file)

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 (file)

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 (file)

Macro: with-context CONTEXT &body BODY

Execute BODY with *context* bound to CONTEXT.

Package

net.didierverna.clon

Source

context.lisp (file)


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

6.1.3 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 (file)

Function: cmdline-options-p &key CONTEXT

Return T if CONTEXT has any unprocessed options left.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-p &key CONTEXT

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

Package

net.didierverna.clon

Source

context.lisp (file)

Function: configuration KEY

Return KEY’s value in the current Clon configuration.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Function: configure KEY VALUE

Set KEY to VALUE in the current Clon configuration.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Function: exit &optional STATUS

Quit the current application with STATUS.

Package

net.didierverna.clon

Source

util.lisp (file)

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 (file)

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 (file)

Function: help &key CONTEXT ITEM OUTPUT-STREAM SEARCH-PATH THEME LINE-WIDTH HIGHLIGHT

Print CONTEXT’s help.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: make-context &rest KEYS &key SYNOPSIS CMDLINE 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.
- If MAKE-CURRENT, make the new context current.

Package

net.didierverna.clon

Source

context.lisp (file)

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 (file)

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 (file)

Function: make-group &rest KEYS &key HEADER ITEM HIDDEN

Make a new group.

Package

net.didierverna.clon

Source

group.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: nickname-package &optional NICKNAME

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

Package

net.didierverna.clon

Source

meta.lisp (file)

Function: progname &key CONTEXT

Return CONTEXT’s program name.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: remainder &key CONTEXT

Return CONTEXT’s remainder.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: setup-termio ()

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

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

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

setup.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *executablep*

Whether the current Lisp image is a standalone executable dumped by Clon. This information is needed in some implementations that treat their command-line differently in dumped images.

Package

net.didierverna.clon

Source

util.lisp (file)

Special Variable: *highlight-properties*

The highlight face properties.

Package

net.didierverna.clon

Source

face.lisp (file)

Special Variable: *item-names*

The list of defined item names.

Package

net.didierverna.clon

Source

valued.lisp (file)

Special Variable: *readtable*

The Clon readtable.

Package

net.didierverna.clon

Source

meta.lisp (file)


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

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 (file)

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 (file)

Macro: declare-valid-superclass CLASS SUPERCLASS

Validate SUPERCLASS classes for CLASS classes.

Package

net.didierverna.clon

Source

util.lisp (file)

Macro: defabstract CLASS SUPER-CLASSES SLOTS &rest OPTIONS

Like DEFCLASS, but define an abstract class.

Package

net.didierverna.clon

Source

util.lisp (file)

Macro: defindent SYMBOL INDENT

Set SYMBOL’s indentation to INDENT in (X)Emacs. SYMBOL and INDENT need not be quoted.
See CLINDENT for more information.

Package

net.didierverna.clon

Source

meta.lisp (file)

Macro: defoption CLASS SUPERCLASSES SLOTS &rest OPTIONS

Create a new option CLASS and register it with Clon.

Package

net.didierverna.clon

Source

valued.lisp (file)

Macro: do-options (OPT THERE) &body BODY

Execute BODY with OPT bound to every option in THERE.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

Macro: econd &body CLAUSES

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

Package

net.didierverna.clon

Source

util.lisp (file)

Macro: endpush OBJECT PLACE

Like push, but at the end.

Package

net.didierverna.clon

Source

util.lisp (file)

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 (file)

Macro: in-readtable NAME

Set the current readtable to the value of NAME::*READTABLE*.

Package

net.didierverna.clon

Source

meta.lisp (file)

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 (file)

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 (file)

Macro: maybe-push OBJECT PLACE

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

Package

net.didierverna.clon

Source

util.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)


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

6.2.3 Functions

Function: %version TYPE MAJOR MINOR STATUS LEVEL NAME
Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Function: add-subface FACE SUBFACE

Add SUBFACE to FACE’s subfaces and return it.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: argument-popable-p CMDLINE

Return true if the first CMDLINE item is an argument.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Function: attach-face-tree FACE FACE-TREE &aux NEW-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 (file)

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 (file)

Function: beginning-of-string-p BEGINNING STRING &optional IGNORE-CASE &aux LENGTH

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

Package

net.didierverna.clon

Source

util.lisp (file)

Function: clindent SYMBOL INDENT

Set SYMBOL’s indentation to INDENT in (X)Emacs.
This function sets SYMBOL’s 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

Source

meta.lisp (file)

Function: close-line SHEET

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: close-sface SHEET

Close SHEET’s current sface.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: closest-match MATCH LIST &key IGNORE-CASE KEY &aux MATCH-LENGTH SHORTEST-DISTANCE CLOSEST-MATCH

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 (file)

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 (file)

Function: cmdline-option-name INSTANCE
Function: (setf cmdline-option-name) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-option INSTANCE
Function: (setf cmdline-option-option) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-p OBJECT
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-source INSTANCE
Function: (setf cmdline-option-source) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-value INSTANCE
Function: (setf cmdline-option-value) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

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 (file)

Function: copy-cmdline-option INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: copy-frame INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: copy-highlight-frame INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: copy-highlight-property-instance INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-frame SHEET

Return SHEET’s current frame.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-left-margin SHEET

Return SHEET’s current left margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-right-margin SHEET

Return SHEET’s current right margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-sface SHEET

Return SHEET’s current sface or nil.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: directory-pathname-p PATHNAME

Return true if PATHNAME denotes a directory.

Package

net.didierverna.clon

Source

path.lisp (file)

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 (file)

Function: exit-abnormally ERROR

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

Package

net.didierverna.clon

Source

context.lisp (file)

Function: face-highlight-property-set-p FACE PROPERTY

Return t if PROPERTY is set explicitely in FACE.

Package

net.didierverna.clon

Source

face.lisp (file)

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 (file)

Function: find-sface SFACE NAME &aux SIBLING SUB-SFACE

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 (file)

Function: flush-sheet SHEET

Flush SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-left-margin INSTANCE
Function: (setf frame-left-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-right-margin INSTANCE
Function: (setf frame-right-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-sface INSTANCE
Function: (setf frame-sface) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

Function: getenv VARIABLE

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

Package

net.didierverna.clon

Source

util.lisp (file)

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 (file)

Function: highlight-frame-highlight-property-instances INSTANCE
Function: (setf highlight-frame-highlight-property-instances) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-left-margin INSTANCE
Function: (setf highlight-frame-left-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-right-margin INSTANCE
Function: (setf highlight-frame-right-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-sface INSTANCE
Function: (setf highlight-frame-sface) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-escape-sequence INSTANCE

Return highlight property INSTANCE’s escape sequence.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-name INSTANCE
Function: (setf highlight-property-instance-name) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-value INSTANCE
Function: (setf highlight-property-instance-value) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

Function: i-reader STREAM SUBCHAR ARG

Read an argument list for the DEFINDENT macro.

Package

net.didierverna.clon

Source

meta.lisp (file)

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 (file)

Function: macosp ()

Return t if running on Mac OS.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: make-cmdline-option &key (NAME NAME) (OPTION OPTION) (VALUE VALUE) (SOURCE SOURCE)
Package

net.didierverna.clon

Source

context.lisp (file)

Function: make-frame &key (SFACE SFACE) (LEFT-MARGIN LEFT-MARGIN) (RIGHT-MARGIN RIGHT-MARGIN)
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-highlight-frame &key (SFACE SFACE) (LEFT-MARGIN LEFT-MARGIN) (RIGHT-MARGIN RIGHT-MARGIN) (HIGHLIGHT-PROPERTY-INSTANCES HIGHLIGHT-PROPERTY-INSTANCES)
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-highlight-property-instance &key (NAME NAME) (VALUE VALUE)
Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: make-internal-text &rest KEYS &key CONTENTS HIDDEN
Package

net.didierverna.clon

Source

text.lisp (file)

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 (file)

Function: make-raw-face-tree &optional FACE-CLASS

Make a raw (boring yet functional) face tree.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: make-raw-sface SIBLING &aux SFACE

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 (file)

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 (file)

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 (file)

Function: open-line SHEET

Open all frames on SHEET’s current line.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: open-next-line SHEET

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: open-sface SHEET SFACE

Create a frame for SFACE and open it.

Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

Function: option-call-p STR

Return true if STR looks like an option call.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

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 (file)

Function: pathname-component-null-p COMPONENT

Return true if COMPONENT is either null or :unspecific.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: pop-frame SHEET

Pop SHEET’s current frame.

Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

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 (file)

Function: princ-highlight-property-instances SHEET INSTANCES

Princ highlight proeprty INSTANCES on SHEET’s stream.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: princ-spaces SHEET NUMBER

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

Function: print-error ERROR &optional INTERACTIVEP &aux STREAM *PRINT-ESCAPE*

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

Package

net.didierverna.clon

Source

context.lisp (file)

Function: print-faced-help-spec SHEET SFACE ITEMS

Print all help specification ITEMS on SHEET with SFACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: print-help SHEET HELP

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

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 (file)

Function: push-frame SHEET FRAME

Push a new frame to SHEET’s frames.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: putenv VARIABLE VALUE

Set environment VARIABLE to VALUE.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: reach-column SHEET COLUMN

Reach COLUMN on SHEET by princ’ing spaces.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: read-argument ()

Read an option argument from standard input.

Package

net.didierverna.clon

Source

valued.lisp (file)

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 (file)

Function: read-env-val ENV-VAR

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

Package

net.didierverna.clon

Source

environ.lisp (file)

Function: read-long-name ()

Read an option’s long name from standard input.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: read-sface-tree PATHNAME

Read an sface tree from PATHNAME.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: read-value ()

Read an option value from standard input.

Package

net.didierverna.clon

Source

valued.lisp (file)

Function: release-status-number RELEASE-STATUS
Package

net.didierverna.clon.setup

Source

setup.lisp (file)

Function: remove-keys KEYS &rest REMOVED

Return a new property list from KEYS without REMOVED ones.

Package

net.didierverna.clon

Source

util.lisp (file)

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 (file)

Function: replace-keys KEYS &rest REPLACEMENTS &aux NEW-KEYS

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 (file)

Function: restart-on-error ERROR

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

Package

net.didierverna.clon

Source

context.lisp (file)

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 (file)

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 (file)

Function: restartable-cmdline-junk-error JUNK
Package

net.didierverna.clon

Source

context.lisp (file)

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 (file)

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 (file)

Function: restrict-because REASON

Put Clon in restricted mode because of REASON.

Package

net.didierverna.clon.setup

Source

setup.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: select-keys KEYS &rest SELECTED

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

Package

net.didierverna.clon

Source

util.lisp (file)

Function: split-path PATH

Split PATH into a list of directories.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: tilde-reader STREAM CHAR

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

Package

net.didierverna.clon

Source

meta.lisp (file)

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 (file)

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 (file)


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

6.2.4 Generic functions

Generic Function: argument CONDITION
Package

net.didierverna.clon

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

context.lisp (file)

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

cmdline.lisp (file)

Method: argument (CONDITION invalid-argument)
Source

valued.lisp (file)

Generic Function: argument-name OBJECT
Package

net.didierverna.clon

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

The option’s argument display name.

Source

valued.lisp (file)

Generic Function: argument-required-p OBJECT
Package

net.didierverna.clon

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

Whether the option’s argument is required.

Source

valued.lisp (file)

Generic Function: argument-style OBJECT
Package

net.didierverna.clon

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

The selected argument style.

Source

switch-base.lisp (file)

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

net.didierverna.clon

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

The possible argument styles.
The position of every argument style in the list must correspond to the position of the associated strings in the yes-values and no-values slots.

Source

switch-base.lisp (file)

Generic Function: background OBJECT
Package

net.didierverna.clon

Methods
Method: background (FACE face)

The face background.

Source

face.lisp (file)

Generic Function: blink OBJECT
Package

net.didierverna.clon

Methods
Method: blink (FACE face)

The face’s blink speed.

Source

face.lisp (file)

Generic Function: bottom-padding OBJECT
Package

net.didierverna.clon

Methods
Method: bottom-padding (FACE face)

The face bottom padding.
This property can take the following forms:
- nil: the next output can start right at the end of this face’s, - 0: the next output should start on the next line,
- N>0: there should be N empty lines before the next output.

Source

face.lisp (file)

Generic Function: check VALUED-OPTION VALUE

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

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods
Method: check (XSWITCH xswitch) VALUE

Check that VALUE is valid for XSWITCH.

Source

xswitch.lisp (file)

Method: check (ENUM enum) VALUE

Check that VALUE is valid for ENUM.

Source

enum.lisp (file)

Method: check (PATH path) VALUE

Check that VALUE is valid for PATH.

Source

path.lisp (file)

Method: check (LISPOBJ lispobj) VALUE

Check that VALUE is valid for LISPOBJ.

Source

lispobj.lisp (file)

Method: check (STROPT stropt) VALUE

Check that VALUE is valid for STROPT.

Source

stropt.lisp (file)

Method: check (SWITCH switch) VALUE

Check that VALUE is valid for SWITCH.

Source

switch.lisp (file)

Generic Function: check-name-clash ITEM1 ITEM2

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

Package

net.didierverna.clon

Source

option.lisp (file)

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

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

Source

container.lisp (file)

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

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

Source

container.lisp (file)

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

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

Source

container.lisp (file)

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

Do nothing (no name clash with a text object.

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

Do nothing (no name clash with a text object.

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

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

Generic Function: clon-options-group OBJECT
Package

net.didierverna.clon

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

Return the Clon options group of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: clon-options-group (SYNOPSIS synopsis)

The Clon options group.

Source

synopsis.lisp (file)

Generic Function: close-frame SHEET FRAME

Close FRAME on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

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

Reach FRAME’s right margin if it has one.

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

Restore the upper frame’s highlight properties.

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

net.didierverna.clon

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

The options from the command-line.

Source

context.lisp (file)

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

net.didierverna.clon

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

The sheet’s current column.

Source

sheet.lisp (file)

Generic Function: comment CONDITION
Package

net.didierverna.clon

Methods
Method: comment (CONDITION invalid-argument)
Source

valued.lisp (file)

Method: comment (CONDITION invalid-value)
Source

valued.lisp (file)

Generic Function: concealedp OBJECT
Package

net.didierverna.clon

Methods
Method: concealedp (FACE face)

The face’s concealed status.

Source

face.lisp (file)

Generic Function: contents OBJECT
Package

net.didierverna.clon

Methods
Method: contents (TEXT text)

The actual text string.

Source

text.lisp (file)

Generic Function: convert VALUED-OPTION ARGUMENT

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

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods
Method: convert (XSWITCH xswitch) ARGUMENT

Convert ARGUMENT to an XSWITCH value.

Source

xswitch.lisp (file)

Method: convert (ENUM enum) ARGUMENT

Convert ARGUMENT to an ENUM value.

Source

enum.lisp (file)

Method: convert (PATH path) ARGUMENT

Convert ARGUMENT to a PATH value.

Source

path.lisp (file)

Method: convert (LISPOBJ lispobj) ARGUMENT

Convert ARGUMENT to a LISPOBJ value.

Source

lispobj.lisp (file)

Method: convert (STROPT stropt) ARGUMENT

Convert ARGUMENT to an STROPT value.

Source

stropt.lisp (file)

Method: convert (SWITCH switch) ARGUMENT

Convert ARGUMENT to a SWITCH value.

Source

switch.lisp (file)

Generic Function: copy-instance INSTANCE &optional SUBCLASS

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

Package

net.didierverna.clon

Source

util.lisp (file)

Methods
Method: copy-instance INSTANCE &optional SUBCLASS

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

Generic Function: crossed-out-p OBJECT
Package

net.didierverna.clon

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

The face’s crossed out status.

Source

face.lisp (file)

Generic Function: default-value OBJECT
Package

net.didierverna.clon

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

The option’s default value.

Source

valued.lisp (file)

Generic Function: description OBJECT
Package

net.didierverna.clon

Methods
Method: description (OPTION option)

The option’s description.

Source

option.lisp (file)

Generic Function: enum OBJECT
Package

net.didierverna.clon

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

The set of possible values.

Source

enum-base.lisp (file)

Generic Function: env-val CONDITION
Package

net.didierverna.clon

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

environ.lisp (file)

Generic Function: env-var OBJECT
Package

net.didierverna.clon

Methods
Method: env-var (CONDITION environment-error)
Source

environ.lisp (file)

Method: env-var (OPTION option)

The option’s associated environment variable.

Source

option.lisp (file)

Generic Function: error-handler OBJECT
Package

net.didierverna.clon

Methods
Method: error-handler (CONTEXT context)

The behavior to adopt on option retrieval errors.

Source

context.lisp (file)

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

net.didierverna.clon

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

util.lisp (file)

Generic Function: fallback-value OBJECT
Package

net.didierverna.clon

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

The option’s fallback value.

Source

valued.lisp (file)

Generic Function: foreground OBJECT
Package

net.didierverna.clon

Methods
Method: foreground (FACE face)

The face foreground.

Source

face.lisp (file)

Generic Function: framedp OBJECT
Package

net.didierverna.clon

Methods
Method: framedp (FACE face)

The face’s framed status.

Source

face.lisp (file)

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

net.didierverna.clon

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

The stack of currently open frames.

Source

sheet.lisp (file)

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

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

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

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

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

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

Generic Function: header OBJECT
Package

net.didierverna.clon

Methods
Method: header (GROUP group)

The group’s header.

Source

group.lisp (file)

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

Return ITEM’s help specification.

Package

net.didierverna.clon

Source

item.lisp (file)

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

Return SYNOPSIS’s help specification.

Source

synopsis.lisp (file)

Method: help-spec (GROUP group) &key

Return GROUP’s help specification.

Source

group.lisp (file)

Method: help-spec (CONTAINER container) &key

Return CONTAINER’s help specification.

Source

container.lisp (file)

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

Return OPTION’s help specification.

Source

valued.lisp (file)

Method: help-spec (OPTION option) &key

Return OPTION’s help specification.

Source

option.lisp (file)

Method: help-spec (TEXT text) &key

Return TEXT’s help specification.

Source

text.lisp (file)

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

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

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

Return t if HELP-SPEC will print under FACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

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

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

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

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

Generic Function: hiddenp OBJECT
Package

net.didierverna.clon

Methods
Method: hiddenp (ITEM item)

Whether the item is hidden in help strings.

Source

item.lisp (file)

Generic Function: highlight OBJECT
Package

net.didierverna.clon

Methods
Method: highlight (CONTEXT context)

Clon’s output highlight mode.

Source

context.lisp (file)

Generic Function: highlightp OBJECT
Package

net.didierverna.clon

Methods
Method: highlightp (SHEET sheet)

Whether to highlight SHEET’s output.

Source

sheet.lisp (file)

Generic Function: intensity OBJECT
Package

net.didierverna.clon

Methods
Method: intensity (FACE face)

The face intensity.

Source

face.lisp (file)

Generic Function: inversep OBJECT
Package

net.didierverna.clon

Methods
Method: inversep (FACE face)

The face’s inverse video status.

Source

face.lisp (file)

Generic Function: italicp OBJECT
Package

net.didierverna.clon

Methods
Method: italicp (FACE face)

The face’s italic status.

Source

face.lisp (file)

Generic Function: item CONDITION
Package

net.didierverna.clon

Methods
Method: item (CONDITION cmdline-error)
Source

cmdline.lisp (file)

Generic Function: item-separator OBJECT
Package

net.didierverna.clon

Methods
Method: item-separator (FACE face)

The face item separator.

Source

face.lisp (file)

Generic Function: items OBJECT
Package

net.didierverna.clon

Methods
Method: items (CONTAINER container)

The items in the container.

Source

container.lisp (file)

Generic Function: junk CONDITION
Package

net.didierverna.clon

Methods
Method: junk (CONDITION cmdline-junk-error)
Source

context.lisp (file)

Generic Function: left-padding OBJECT
Package

net.didierverna.clon

Methods
Method: left-padding (FACE face)

The face left padding.
This property can take the following forms:
- <NUMBER>: the padding is relative to the enclosing face,
- SELF: the padding is set to wherever the face happens to be opened, - (<NUMBER> ABSOLUTE): the padding is set in absolute value,
- (<NUMBER> :RELATIVE-TO <FACE-NAME>): the padding is set relatively to a parent face named FACE-NAME.

Source

face.lisp (file)

Generic Function: line-width OBJECT
Package

net.didierverna.clon

Methods
Method: line-width (CONTEXT context)

The line width for help display.

Source

context.lisp (file)

Method: line-width (SHEET sheet)

The sheet’s line width.

Source

sheet.lisp (file)

Generic Function: long-name OBJECT
Package

net.didierverna.clon

Methods
Method: long-name (OPTION option)

The option’s long name.

Source

option.lisp (file)

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

Make a FACE-CLASS face tree from DEFINITION.

Package

net.didierverna.clon

Source

face.lisp (file)

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

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

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

Create a face named NAME.

Generic Function: mapoptions FUNC THERE

Map FUNC over all options in THERE.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

Methods
Method: mapoptions FUNC (CONTEXT context)

Map FUNC over all options in CONTEXT synopsis.

Source

context.lisp (file)

Method: mapoptions FUNC ELSEWHERE

Do nothing by default.

Method: mapoptions FUNC (ITEM item) after

Mark TRAVERSABLE as traversed.

Method: mapoptions FUNC (CONTAINER container)

Map FUNC over all containers or options in CONTAINER.

Method: mapoptions FUNC (OPTION option)

Call FUNC on OPTION.

Generic Function: name CONDITION
Package

net.didierverna.clon

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

context.lisp (file)

Method: name (FACE face)

The face name.

Source

face.lisp (file)

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

cmdline.lisp (file)

Generic Function: negated-call CONDITION
Package

net.didierverna.clon

Methods
Method: negated-call (CONDITION unrecognized-negated-call-error)
Source

context.lisp (file)

Generic Function: negated-pack OBJECT
Package

net.didierverna.clon

Methods
Method: negated-pack (CONTEXT context)

Return the negated pack of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: negated-pack (SYNOPSIS synopsis)

The negated pack string.

Source

synopsis.lisp (file)

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

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

Package

net.didierverna.clon

Source

option.lisp (file)

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

Return NEGATABLE’s negated pack character, if any.

Source

negatable.lisp (file)

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

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

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

net.didierverna.clon

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

The possible ’no’ values.

Source

switch-base.lisp (file)

Generic Function: open-frame SHEET FRAME

Open FRAME on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

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

Reach the frame’s left margin.

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

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

Generic Function: option CONDITION
Package

net.didierverna.clon

Methods
Method: option (CONDITION option-error)
Source

option.lisp (file)

Generic Function: option-sticky-distance OPTION NAMEARG

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

Package

net.didierverna.clon

Source

option.lisp (file)

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

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

Source

valued.lisp (file)

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

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

Generic Function: output-stream OBJECT
Package

net.didierverna.clon

Methods
Method: output-stream (SHEET sheet)

The sheet’s output stream.

Source

sheet.lisp (file)

Generic Function: parent OBJECT
Package

net.didierverna.clon

Methods
Method: parent (FACE face)

The face parent.

Source

face.lisp (file)

Generic Function: path-type OBJECT
Package

net.didierverna.clon

Methods
Method: path-type (PATH path)

The path type.

Source

path.lisp (file)

Generic Function: postfix OBJECT
Package

net.didierverna.clon

Methods
Method: postfix (CONTEXT context)

Return the postfix of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: postfix (SYNOPSIS synopsis)

A postfix to the program synopsis.

Source

synopsis.lisp (file)

Generic Function: potential-pack OBJECT
Package

net.didierverna.clon

Methods
Method: potential-pack (SYNOPSIS synopsis)

The potential pack string.

Source

synopsis.lisp (file)

Generic Function: potential-pack-p PACK THERE

Return t if PACK is a potential pack in THERE.

Package

net.didierverna.clon

Source

synopsis.lisp (file)

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

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

Source

context.lisp (file)

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

Return t if PACK is a potential pack for SYNOPSIS.

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

Print HELP-SPEC on SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Methods
Method: print-help-spec SHEET HELP-SPEC before
Method: print-help-spec SHEET (CHAR character)

Print CHAR on SHEET with the current face.

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

Print CHAR-VECTOR on SHEET with the current face.

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

Print STRING on SHEET with the current face.

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

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

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

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

Package

net.didierverna.clon

Source

environ.lisp (file)

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

Assert that ENV-VAL is not null.

Method: retrieve-from-environment (FLAG flag) ENV-VAL
Method: retrieve-from-environment (OPTION valued-option) ENV-VAL
Generic Function: retrieve-from-long-call OPTION CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE

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

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods
Method: retrieve-from-long-call (OPTION option) CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE
Method: retrieve-from-long-call (OPTION valued-option) CMDLINE-NAME &optional CMDLINE-ARGUMENT CMDLINE
Generic Function: retrieve-from-negated-call OPTION

Retrieve OPTION’s value from a negated call.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods
Method: retrieve-from-negated-call (OPTION option)
Method: retrieve-from-negated-call (OPTION valued-option)
Method: retrieve-from-negated-call (NEGATABLE negatable)
Generic Function: retrieve-from-short-call OPTION &optional CMDLINE-ARGUMENT CMDLINE

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

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Methods
Method: retrieve-from-short-call (OPTION option) &optional CMDLINE-ARGUMENT CMDLINE
Method: retrieve-from-short-call (OPTION valued-option) &optional CMDLINE-ARGUMENT CMDLINE
Generic Function: right-padding OBJECT
Package

net.didierverna.clon

Methods
Method: right-padding (FACE face)

The face right padding.
This property can take the following forms:
- <NUMBER>: the padding is relative to the enclosing face,
- SELF: the padding is set to wherever the face happens to be closed, - (<NUMBER> ABSOLUTE): the padding is set in absolute value,
- (<NUMBER> :RELATIVE-TO <FACE-NAME>): the padding is set relatively to a parent face named FACE-NAME.

Source

face.lisp (file)

Generic Function: search-path OBJECT
Package

net.didierverna.clon

Methods
Method: search-path (CONTEXT context)

The search path for Clon files.

Source

context.lisp (file)

Generic Function: sface-tree OBJECT
Package

net.didierverna.clon

Methods
Method: sface-tree (SHEET sheet)

The sheet’s sface tree.

Source

sheet.lisp (file)

Generic Function: short-call CONDITION
Package

net.didierverna.clon

Methods
Method: short-call (CONDITION unrecognized-short-call-error)
Source

context.lisp (file)

Generic Function: short-name OBJECT
Package

net.didierverna.clon

Methods
Method: short-name (OPTION option)

The option’s short name.

Source

option.lisp (file)

Generic Function: short-pack OBJECT
Package

net.didierverna.clon

Methods
Method: short-pack (CONTEXT context)

Return the short pack of CONTEXT’s synopsis.

Source

context.lisp (file)

Method: short-pack (SYNOPSIS synopsis)

The short pack string.

Source

synopsis.lisp (file)

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

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

Package

net.didierverna.clon

Source

option.lisp (file)

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

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

Source

valued.lisp (file)

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

Return OPTION’s potential pack character.

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

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

Package

net.didierverna.clon

Source

valued.lisp (file)

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

negatable.lisp (file)

Method: short-syntax-help-spec-prefix (OPTION valued-option)
Generic Function: sibling OBJECT
Package

net.didierverna.clon

Methods
Method: sibling (SFACE sface)

The SFace’s raw sibling.

Source

sheet.lisp (file)

Generic Function: stringify VALUED-OPTION VALUE

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

Package

net.didierverna.clon

Source

valued.lisp (file)

Methods
Method: stringify (XSWITCH xswitch) VALUE

Transform XSWITCH’s VALUE into an argument.

Source

xswitch.lisp (file)

Method: stringify (ENUM enum) VALUE

Transform ENUM’s VALUE into an argument.

Source

enum.lisp (file)

Method: stringify (PATH path) VALUE

Transform PATH’s VALUE into an argument.

Source

path.lisp (file)

Method: stringify (LISPOBJ lispobj) VALUE

Transform LISPOBJ’s VALUE into an argument.

Source

lispobj.lisp (file)

Method: stringify (STROPT stropt) VALUE

Transform STROPT’s VALUE into an argument.

Source

stropt.lisp (file)

Method: stringify (SWITCH switch) VALUE

Transform SWITCH’s VALUE into an argument.

Source

switch.lisp (file)

Generic Function: subface FACE name(s)

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

Package

net.didierverna.clon

Source

face.lisp (file)

Methods
Method: subface FACE (NAME symbol)

Return FACE’subface named NAME, or nil.

Method: subface FACE (NAMES list) &aux BRANCH

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

Generic Function: subfaces OBJECT
Package

net.didierverna.clon

Methods
Method: subfaces (FACE face)

The face children.

Source

face.lisp (file)

Generic Function: synopsis OBJECT
Package

net.didierverna.clon

Methods
Method: synopsis (CONTEXT context)

The program synopsis.

Source

context.lisp (file)

Generic Function: theme OBJECT
Package

net.didierverna.clon

Methods
Method: theme (CONTEXT context)

The theme filename.

Source

context.lisp (file)

Generic Function: top-padding OBJECT
Package

net.didierverna.clon

Methods
Method: top-padding (HELP-SPEC list)
Source

sheet.lisp (file)

Method: top-padding OTHER
Source

sheet.lisp (file)

Method: top-padding (FACE face)

The face top padding.
This property can take the following forms:
- nil: the output can start right away,
- 0: the output should start on the next line,
- N>0: there should be N empty lines before the output.

Source

face.lisp (file)

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

net.didierverna.clon

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

The item’s traversal state.

Source

item.lisp (file)

Generic Function: typespec OBJECT
Package

net.didierverna.clon

Methods
Method: typespec (LISPOBJ lispobj)

A type specifier the option’s value should satisfy.

Source

lispobj.lisp (file)

Generic Function: underline OBJECT
Package

net.didierverna.clon

Methods
Method: underline (FACE face)

The face’s underline level.

Source

face.lisp (file)

Generic Function: untraverse ITEM

Reset ITEM’s traversal state, and return ITEM.

Package

net.didierverna.clon

Source

item.lisp (file)

Methods
Method: untraverse (CONTEXT context)

Untraverse CONTEXT synopsis.

Source

context.lisp (file)

Method: untraverse (CONTAINER container)

Untraverse all CONTAINER items.

Source

container.lisp (file)

Method: untraverse (OPTION option)

OPTION is a terminal object: just return it.

Source

option.lisp (file)

Method: untraverse (TEXT text)

TEXT is a terminal object: just return it.

Source

text.lisp (file)

Method: untraverse (ITEM item) after

Mark ITEM as untraversed.

Generic Function: value CONDITION
Package

net.didierverna.clon

Methods
Method: value (CONDITION invalid-value)
Source

valued.lisp (file)

Generic Function: visiblep OBJECT
Package

net.didierverna.clon

Methods
Method: visiblep (FACE face)

Whether the face is visible.

Source

face.lisp (file)

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

net.didierverna.clon

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

The possible ’yes’ values.

Source

switch-base.lisp (file)


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

6.2.5 Conditions

Condition: cmdline-error ()

An error related to a command-line item.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

item (method)

Direct slots
Slot: item

The concerned command-line item.

Initargs

:item

Readers

item (generic function)

Condition: cmdline-junk-error ()

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

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Direct methods

junk (method)

Direct slots
Slot: item

The piece of junk appearing on the command-line.

Initargs

:junk, :item

Readers

junk (generic function)

Condition: cmdline-option-error ()

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

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses
Direct subclasses
Direct methods

name (method)

Direct slots
Slot: item

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

Initargs

:name, :item

Readers

name (generic function)

Condition: environment-error ()

An error related to an environment variable.

Package

net.didierverna.clon

Source

environ.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

environmental-option-error (condition)

Direct methods

env-var (method)

Direct slots
Slot: env-var

The concerned environment variable.

Initargs

:env-var

Readers

env-var (generic function)

Condition: environmental-option-error ()

An error related to an option’s environment variable.

Package

net.didierverna.clon

Source

environ.lisp (file)

Direct superclasses
Direct subclasses

invalid-environment-value (condition)

Condition: home-directory ()
Package

net.didierverna.clon

Source

util.lisp (file)

Direct superclasses

warning (condition)

Direct methods
Direct slots
Slot: error-string
Initargs

:error-string

Readers

error-string (generic function)

Writers

(setf error-string) (generic function)

Condition: invalid-argument ()

An invalid argument error.

Package

net.didierverna.clon

Source

valued.lisp (file)

Direct superclasses

option-error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: argument

The invalid argument.

Initargs

:argument

Readers

argument (generic function)

Slot: comment

An additional comment about the error.

Initargs

:comment

Readers

comment (generic function)

Condition: invalid-cmdline-argument ()

An invalid command-line argument error.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses
Condition: invalid-environment-value ()

An invalid environment variable’s value error.

Package

net.didierverna.clon

Source

environ.lisp (file)

Direct superclasses
Direct methods

env-val (method)

Direct slots
Slot: argument

The invalid environment variable value.

Initargs

:env-val, :argument

Readers

env-val (generic function)

Condition: invalid-negated-equal-syntax ()

An error related to a negated-equal syntax.

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Condition: invalid-negated-syntax ()

An invalid negated syntax error.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses

cmdline-option-error (condition)

Condition: invalid-short-equal-syntax ()

An error related to a short-equal syntax.

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Condition: invalid-value ()

An invalid value error.

Package

net.didierverna.clon

Source

valued.lisp (file)

Direct superclasses

option-error (condition)

Direct methods
Direct slots
Slot: value

The invalid value.

Initargs

:value

Readers

value (generic function)

Slot: comment

An additional comment about the error.

Initargs

:comment

Readers

comment (generic function)

Condition: missing-cmdline-argument ()

A missing command-line argument error.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses

cmdline-option-error (condition)

Condition: option-error ()

An error related to an option.

Package

net.didierverna.clon

Source

option.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

option (method)

Direct slots
Slot: option

The concerned option.

Initargs

:option

Readers

option (generic function)

Condition: spurious-cmdline-argument ()

A spurious command-line argument error.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Direct superclasses

cmdline-option-error (condition)

Direct methods

argument (method)

Direct slots
Slot: argument

The spurious argument.

Initargs

:argument

Readers

argument (generic function)

Condition: unknown-cmdline-option-error ()

An error related to an unknown command-line option.

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Direct methods
Direct slots
Slot: item

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

Initargs

:name, :item

Readers

name (generic function)

Slot: argument

The option’s command-line argument.

Initargs

:argument

Readers

argument (generic function)

Condition: unrecognized-negated-call-error ()

An error related to an unrecognized negated call.

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Direct methods

negated-call (method)

Direct slots
Slot: item

The unrecognized negated call on the command-line.

Initargs

:negated-call, :item

Readers

negated-call (generic function)

Condition: unrecognized-short-call-error ()

An error related to an unrecognized short call.

Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

cmdline-error (condition)

Direct methods

short-call (method)

Direct slots
Slot: item

The unrecognized short call on the command-line.

Initargs

:short-call, :item

Readers

short-call (generic function)


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

6.2.6 Structures

Structure: cmdline-option ()
Package

net.didierverna.clon

Source

context.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

cmdline-option-name (function)

Writers

(setf cmdline-option-name) (function)

Slot: option
Readers

cmdline-option-option (function)

Writers

(setf cmdline-option-option) (function)

Slot: value
Readers

cmdline-option-value (function)

Writers

(setf cmdline-option-value) (function)

Slot: source
Readers

cmdline-option-source (function)

Writers

(setf cmdline-option-source) (function)

Structure: frame ()

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

highlight-frame (structure)

Direct methods
Direct slots
Slot: sface
Readers

frame-sface (function)

Writers

(setf frame-sface) (function)

Slot: left-margin
Readers

frame-left-margin (function)

Writers

(setf frame-left-margin) (function)

Slot: right-margin
Readers

frame-right-margin (function)

Writers

(setf frame-right-margin) (function)

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 (file)

Direct superclasses

frame (structure)

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

highlight-frame-highlight-property-instances (function)

Writers

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

Structure: highlight-property-instance ()

The HIGHLIGHT-PROPERTY-INSTANCE structure.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

highlight-property-instance-name (function)

Writers

(setf highlight-property-instance-name) (function)

Slot: value
Readers

highlight-property-instance-value (function)

Writers

(setf highlight-property-instance-value) (function)


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

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 (file)

Direct superclasses

standard-class (class)

Direct methods
  • validate-superclass (method)
  • validate-superclass (method)
  • make-instance (method)
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 (file)

Direct superclasses

item (class)

Direct subclasses
Direct methods
Direct slots
Slot: items

The items in the container.

Type

list

Initargs

:items

Readers

items (generic function)

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 (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: synopsis

The program synopsis.

Type

net.didierverna.clon::synopsis

Initargs

:synopsis

Initform

net.didierverna.clon:*synopsis*

Readers

synopsis (generic function)

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 (generic function)

Writers

(setf cmdline-options) (generic function)

Slot: remainder

The non-Clon part of the command-line.

Type

list

Slot: search-path

The search path for Clon files.

Readers

search-path (generic function)

Slot: theme

The theme filename.

Readers

theme (generic function)

Slot: line-width

The line width for help display.

Readers

line-width (generic function)

Slot: highlight

Clon’s output highlight mode.

Readers

highlight (generic function)

Slot: error-handler

The behavior to adopt on option retrieval errors.

Type

symbol

Initform

:quit

Readers

error-handler (generic function)

Direct Default Initargs
InitargValue
:cmdline(net.didierverna.clon:cmdline)
Class: enum ()

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

Package

net.didierverna.clon

Source

enum.lisp (file)

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 (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
  • initialize-instance (method)
  • enum (method)
Direct slots
Slot: enum

The set of possible values.

Initargs

:enum

Readers

enum (generic function)

Class: face ()

The FACE class.

Package

net.didierverna.clon

Source

face.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

sface (class)

Direct methods
Direct slots
Slot: name

The face name.

Initargs

:name

Readers

name (generic function)

Slot: visiblep

Whether the face is visible.

Initargs

:visible

Initform

t

Readers

visiblep (generic function)

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.

Initargs

:padding-left

Initform

0

Readers

left-padding (generic function)

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.

Initargs

:padding-right

Initform

(quote net.didierverna.clon::self)

Readers

right-padding (generic function)

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 (generic function)

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 (generic function)

Slot: item-separator

The face item separator.

Initargs

:item-separator

Initform

#\space

Readers

item-separator (generic function)

Slot: intensity

The face intensity.

Initargs

:intensity

Readers

intensity (generic function)

Slot: italicp

The face’s italic status.

Initargs

:italic

Readers

italicp (generic function)

Slot: underline

The face’s underline level.

Initargs

:underline

Readers

underline (generic function)

Slot: blink

The face’s blink speed.

Initargs

:blink

Readers

blink (generic function)

Slot: inversep

The face’s inverse video status.

Initargs

:inverse

Readers

inversep (generic function)

Slot: concealedp

The face’s concealed status.

Initargs

:concealed

Readers

concealedp (generic function)

Slot: crossed-out-p

The face’s crossed out status.

Initargs

:crossed-out

Readers

crossed-out-p (generic function)

Slot: framedp

The face’s framed status.

Initargs

:framed

Readers

framedp (generic function)

Slot: foreground

The face foreground.

Initargs

:foreground

Readers

foreground (generic function)

Slot: background

The face background.

Initargs

:background

Readers

background (generic function)

Slot: subfaces

The face children.

Initargs

:subfaces

Readers

subfaces (generic function)

Slot: parent

The face parent.

Readers

parent (generic function)

Class: flag ()

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

Package

net.didierverna.clon

Source

flag.lisp (file)

Direct superclasses

option (class)

Direct methods

retrieve-from-environment (method)

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 (file)

Direct superclasses

container (class)

Direct methods
Direct slots
Slot: header

The group’s header.

Initargs

:header

Readers

header (generic function)

Class: item ()

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

Package

net.didierverna.clon

Source

item.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: traversedp

The item’s traversal state.

Readers

traversedp (generic function)

Writers

(setf traversedp) (generic function)

Slot: hiddenp

Whether the item is hidden in help strings.

Initargs

:hidden

Readers

hiddenp (generic function)

Class: lispobj ()

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

Package

net.didierverna.clon

Source

lispobj.lisp (file)

Direct superclasses

valued-option (class)

Direct methods
Direct slots
Slot: argument-name
Initform

"obj"

Slot: typespec

A type specifier the option’s value should satisfy.

Initargs

:typespec

Initform

t

Readers

typespec (generic function)

Class: negatable ()

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

Package

net.didierverna.clon

Source

negatable.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

switch-base (class)

Direct methods
Class: option ()

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

Package

net.didierverna.clon

Source

option.lisp (file)

Direct superclasses

item (class)

Direct subclasses
Direct methods
Direct slots
Slot: short-name

The option’s short name.

Type

(or null string)

Initargs

:short-name

Readers

short-name (generic function)

Slot: long-name

The option’s long name.

Type

(or null string)

Initargs

:long-name

Readers

long-name (generic function)

Slot: description

The option’s description.

Type

(or null string)

Initargs

:description

Readers

description (generic function)

Slot: env-var

The option’s associated environment variable.

Type

(or null string)

Initargs

:env-var

Readers

env-var (generic function)

Direct Default Initargs
InitargValue
:internalnil
Class: path ()

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

Package

net.didierverna.clon

Source

path.lisp (file)

Direct superclasses

valued-option (class)

Direct methods
Direct slots
Slot: argument-name
Initform

"path"

Slot: path-type

The path type.

Initargs

:type

Readers

path-type (generic function)

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 (file)

Direct superclasses

face (class)

Direct methods

sibling (method)

Direct slots
Slot: sibling

The SFace’s raw sibling.

Readers

sibling (generic function)

Class: sheet ()

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

Package

net.didierverna.clon

Source

sheet.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: output-stream

The sheet’s output stream.

Type

stream

Initargs

:output-stream

Readers

output-stream (generic function)

Slot: line-width

The sheet’s line width.

Type

(integer 1)

Initargs

:line-width

Readers

line-width (generic function)

Slot: highlightp

Whether to highlight SHEET’s output.

Initargs

:highlightp

Readers

highlightp (generic function)

Slot: sface-tree

The sheet’s sface tree.

Readers

sface-tree (generic function)

Slot: column

The sheet’s current column.

Type

(integer 0)

Initform

0

Readers

column (generic function)

Writers

(setf column) (generic function)

Slot: frames

The stack of currently open frames.

Type

list

Readers

frames (generic function)

Writers

(setf frames) (generic function)

Class: stropt ()

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

Package

net.didierverna.clon

Source

stropt.lisp (file)

Direct superclasses

valued-option (class)

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 (file)

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 (file)

Direct superclasses

negatable (class)

Direct subclasses
Direct methods
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 (generic function)

Writers

(setf argument-styles) (generic function)

Slot: yes-values

The possible ’yes’ values.

Type

list

Initargs

:yes-values

Readers

yes-values (generic function)

Writers

(setf yes-values) (generic function)

Slot: no-values

The possible ’no’ values.

Type

list

Initargs

:no-values

Readers

no-values (generic function)

Writers

(setf no-values) (generic function)

Slot: argument-style

The selected argument style.

Type

keyword

Initargs

:argument-style

Initform

:yes/no

Readers

argument-style (generic function)

Direct Default Initargs
InitargValue
:argument-type:optional
:argument-styles(quote (:yes/no :on/off :true/false :yup/nope :yeah/nah))
:yes-values(quote ("yes" "on" "true" "yup" "yeah"))
:no-values(quote ("no" "off" "false" "nope" "nah"))
Class: synopsis ()

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

Package

net.didierverna.clon

Source

synopsis.lisp (file)

Direct superclasses

container (class)

Direct methods
Direct slots
Slot: postfix

A postfix to the program synopsis.

Type

(or null string)

Initargs

:postfix

Readers

postfix (generic function)

Slot: short-pack

The short pack string.

Type

(or null string)

Readers

short-pack (generic function)

Slot: negated-pack

The negated pack string.

Type

(or null string)

Readers

negated-pack (generic function)

Slot: potential-pack

The potential pack string.

Type

(or null string)

Readers

potential-pack (generic function)

Slot: clon-options-group

The Clon options group.

Type

net.didierverna.clon::group

Initargs

:clon-options-group

Readers

clon-options-group (generic function)

Class: text ()

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

Package

net.didierverna.clon

Source

text.lisp (file)

Direct superclasses

item (class)

Direct methods
Direct slots
Slot: contents

The actual text string.

Type

string

Initargs

:contents

Readers

contents (generic function)

Class: valued-option ()

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

Package

net.didierverna.clon

Source

valued.lisp (file)

Direct superclasses

option (class)

Direct subclasses
Direct methods
Direct slots
Slot: argument-name

The option’s argument display name.

Initargs

:argument-name

Initform

"arg"

Readers

argument-name (generic function)

Slot: argument-required-p

Whether the option’s argument is required.

Readers

argument-required-p (generic function)

Slot: fallback-value

The option’s fallback value.

Initargs

:fallback-value

Readers

fallback-value (generic function)

Slot: default-value

The option’s default value.

Initargs

:default-value

Readers

default-value (generic function)

Direct Default Initargs
InitargValue
:argument-type:required
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 (file)

Direct superclasses
Direct methods
Direct slots
Slot: enum

The set of possible non-boolean values.


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   N  
Index Entry  Section

F
File, Lisp, net.didierverna.clon.asd: The net<dot>didierverna<dot>clon<dot>asd file
File, Lisp, net.didierverna.clon.core.asd: The net<dot>didierverna<dot>clon<dot>core<dot>asd file
File, Lisp, net.didierverna.clon.core/meta.lisp: The net<dot>didierverna<dot>clon<dot>core/meta<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/container.lisp: The net<dot>didierverna<dot>clon<dot>core/src/container<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/context.lisp: The net<dot>didierverna<dot>clon<dot>core/src/context<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/group.lisp: The net<dot>didierverna<dot>clon<dot>core/src/group<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/item.lisp: The net<dot>didierverna<dot>clon<dot>core/src/item<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/enum-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum-base<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/enum.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/flag.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/flag<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/lispobj.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/lispobj<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/negatable.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/negatable<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/option.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/option<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/path.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/path<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/stropt.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/stropt<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/switch-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch-base<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/switch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/valued.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/valued<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/options/xswitch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/xswitch<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/output/face.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/face<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/output/sheet.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/sheet<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/retrieval/cmdline.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/cmdline<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/retrieval/environ.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/environ<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/synopsis.lisp: The net<dot>didierverna<dot>clon<dot>core/src/synopsis<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/text.lisp: The net<dot>didierverna<dot>clon<dot>core/src/text<dot>lisp file
File, Lisp, net.didierverna.clon.core/src/util.lisp: The net<dot>didierverna<dot>clon<dot>core/src/util<dot>lisp file
File, Lisp, net.didierverna.clon.setup.asd: The net<dot>didierverna<dot>clon<dot>setup<dot>asd file
File, Lisp, net.didierverna.clon.setup/setup.lisp: The net<dot>didierverna<dot>clon<dot>setup/setup<dot>lisp file
File, Lisp, net.didierverna.clon.termio.asd: The net<dot>didierverna<dot>clon<dot>termio<dot>asd file
File, Lisp, net.didierverna.clon.termio/sbcl/constants.lisp: The net<dot>didierverna<dot>clon<dot>termio/sbcl/constants<dot>lisp file
File, Lisp, net.didierverna.clon.termio/termio.lisp: The net<dot>didierverna<dot>clon<dot>termio/termio<dot>lisp file

L
Lisp File, net.didierverna.clon.asd: The net<dot>didierverna<dot>clon<dot>asd file
Lisp File, net.didierverna.clon.core.asd: The net<dot>didierverna<dot>clon<dot>core<dot>asd file
Lisp File, net.didierverna.clon.core/meta.lisp: The net<dot>didierverna<dot>clon<dot>core/meta<dot>lisp file
Lisp File, net.didierverna.clon.core/src/container.lisp: The net<dot>didierverna<dot>clon<dot>core/src/container<dot>lisp file
Lisp File, net.didierverna.clon.core/src/context.lisp: The net<dot>didierverna<dot>clon<dot>core/src/context<dot>lisp file
Lisp File, net.didierverna.clon.core/src/group.lisp: The net<dot>didierverna<dot>clon<dot>core/src/group<dot>lisp file
Lisp File, net.didierverna.clon.core/src/item.lisp: The net<dot>didierverna<dot>clon<dot>core/src/item<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/enum-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum-base<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/enum.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/flag.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/flag<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/lispobj.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/lispobj<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/negatable.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/negatable<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/option.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/option<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/path.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/path<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/stropt.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/stropt<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/switch-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch-base<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/switch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/valued.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/valued<dot>lisp file
Lisp File, net.didierverna.clon.core/src/options/xswitch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/xswitch<dot>lisp file
Lisp File, net.didierverna.clon.core/src/output/face.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/face<dot>lisp file
Lisp File, net.didierverna.clon.core/src/output/sheet.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/sheet<dot>lisp file
Lisp File, net.didierverna.clon.core/src/retrieval/cmdline.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/cmdline<dot>lisp file
Lisp File, net.didierverna.clon.core/src/retrieval/environ.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/environ<dot>lisp file
Lisp File, net.didierverna.clon.core/src/synopsis.lisp: The net<dot>didierverna<dot>clon<dot>core/src/synopsis<dot>lisp file
Lisp File, net.didierverna.clon.core/src/text.lisp: The net<dot>didierverna<dot>clon<dot>core/src/text<dot>lisp file
Lisp File, net.didierverna.clon.core/src/util.lisp: The net<dot>didierverna<dot>clon<dot>core/src/util<dot>lisp file
Lisp File, net.didierverna.clon.setup.asd: The net<dot>didierverna<dot>clon<dot>setup<dot>asd file
Lisp File, net.didierverna.clon.setup/setup.lisp: The net<dot>didierverna<dot>clon<dot>setup/setup<dot>lisp file
Lisp File, net.didierverna.clon.termio.asd: The net<dot>didierverna<dot>clon<dot>termio<dot>asd file
Lisp File, net.didierverna.clon.termio/sbcl/constants.lisp: The net<dot>didierverna<dot>clon<dot>termio/sbcl/constants<dot>lisp file
Lisp File, net.didierverna.clon.termio/termio.lisp: The net<dot>didierverna<dot>clon<dot>termio/termio<dot>lisp file

M
Module, net.didierverna.clon.core/src: The net<dot>didierverna<dot>clon<dot>core/src module
Module, net.didierverna.clon.core/src/options: The net<dot>didierverna<dot>clon<dot>core/src/options module
Module, net.didierverna.clon.core/src/output: The net<dot>didierverna<dot>clon<dot>core/src/output module
Module, net.didierverna.clon.core/src/retrieval: The net<dot>didierverna<dot>clon<dot>core/src/retrieval module

N
net.didierverna.clon.asd: The net<dot>didierverna<dot>clon<dot>asd file
net.didierverna.clon.core.asd: The net<dot>didierverna<dot>clon<dot>core<dot>asd file
net.didierverna.clon.core/meta.lisp: The net<dot>didierverna<dot>clon<dot>core/meta<dot>lisp file
net.didierverna.clon.core/src: The net<dot>didierverna<dot>clon<dot>core/src module
net.didierverna.clon.core/src/container.lisp: The net<dot>didierverna<dot>clon<dot>core/src/container<dot>lisp file
net.didierverna.clon.core/src/context.lisp: The net<dot>didierverna<dot>clon<dot>core/src/context<dot>lisp file
net.didierverna.clon.core/src/group.lisp: The net<dot>didierverna<dot>clon<dot>core/src/group<dot>lisp file
net.didierverna.clon.core/src/item.lisp: The net<dot>didierverna<dot>clon<dot>core/src/item<dot>lisp file
net.didierverna.clon.core/src/options: The net<dot>didierverna<dot>clon<dot>core/src/options module
net.didierverna.clon.core/src/options/enum-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum-base<dot>lisp file
net.didierverna.clon.core/src/options/enum.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/enum<dot>lisp file
net.didierverna.clon.core/src/options/flag.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/flag<dot>lisp file
net.didierverna.clon.core/src/options/lispobj.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/lispobj<dot>lisp file
net.didierverna.clon.core/src/options/negatable.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/negatable<dot>lisp file
net.didierverna.clon.core/src/options/option.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/option<dot>lisp file
net.didierverna.clon.core/src/options/path.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/path<dot>lisp file
net.didierverna.clon.core/src/options/stropt.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/stropt<dot>lisp file
net.didierverna.clon.core/src/options/switch-base.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch-base<dot>lisp file
net.didierverna.clon.core/src/options/switch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/switch<dot>lisp file
net.didierverna.clon.core/src/options/valued.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/valued<dot>lisp file
net.didierverna.clon.core/src/options/xswitch.lisp: The net<dot>didierverna<dot>clon<dot>core/src/options/xswitch<dot>lisp file
net.didierverna.clon.core/src/output: The net<dot>didierverna<dot>clon<dot>core/src/output module
net.didierverna.clon.core/src/output/face.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/face<dot>lisp file
net.didierverna.clon.core/src/output/sheet.lisp: The net<dot>didierverna<dot>clon<dot>core/src/output/sheet<dot>lisp file
net.didierverna.clon.core/src/retrieval: The net<dot>didierverna<dot>clon<dot>core/src/retrieval module
net.didierverna.clon.core/src/retrieval/cmdline.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/cmdline<dot>lisp file
net.didierverna.clon.core/src/retrieval/environ.lisp: The net<dot>didierverna<dot>clon<dot>core/src/retrieval/environ<dot>lisp file
net.didierverna.clon.core/src/synopsis.lisp: The net<dot>didierverna<dot>clon<dot>core/src/synopsis<dot>lisp file
net.didierverna.clon.core/src/text.lisp: The net<dot>didierverna<dot>clon<dot>core/src/text<dot>lisp file
net.didierverna.clon.core/src/util.lisp: The net<dot>didierverna<dot>clon<dot>core/src/util<dot>lisp file
net.didierverna.clon.setup.asd: The net<dot>didierverna<dot>clon<dot>setup<dot>asd file
net.didierverna.clon.setup/setup.lisp: The net<dot>didierverna<dot>clon<dot>setup/setup<dot>lisp file
net.didierverna.clon.termio.asd: The net<dot>didierverna<dot>clon<dot>termio<dot>asd file
net.didierverna.clon.termio/sbcl/constants.lisp: The net<dot>didierverna<dot>clon<dot>termio/sbcl/constants<dot>lisp file
net.didierverna.clon.termio/termio.lisp: The net<dot>didierverna<dot>clon<dot>termio/termio<dot>lisp file

Jump to:   F   L   M   N  

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

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: Internal macros
%version: Internal functions

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

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

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

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

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

E
econd: Internal macros
endpush: Internal macros
enum: Internal generic functions
enum: Internal generic functions
env-val: Internal generic functions
env-val: Internal generic functions
env-var: Internal generic functions
env-var: Internal generic functions
env-var: Internal generic functions
environment-convert: Internal functions
error-handler: Internal generic functions
error-handler: Internal generic functions
error-string: Internal generic functions
error-string: Internal generic functions
exit: Exported functions
exit-abnormally: Internal functions

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

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

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

I
i-reader: Internal functions
in-readtable: Internal macros
intensity: Internal generic functions
intensity: Internal generic functions
inversep: Internal generic functions
inversep: Internal generic functions
italicp: Internal generic functions
italicp: Internal generic functions
item: Internal generic functions
item: Internal generic functions
item-separator: Internal generic functions
item-separator: Internal generic functions
items: Internal generic functions
items: Internal generic functions

J
junk: Internal generic functions
junk: Internal generic functions

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

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

N
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions
negated-call: Internal generic functions
negated-call: Internal generic functions
negated-pack: Internal generic functions
negated-pack: Internal generic functions
negated-pack: Internal generic functions
negated-pack-char: Internal generic functions
negated-pack-char: Internal generic functions
negated-pack-char: Internal generic functions
nickname-package: Exported functions
no-values: Internal generic functions
no-values: Internal generic functions

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

P
parent: Internal generic functions
parent: Internal generic functions
parent-generation: Internal functions