The focus Reference Manual

Table of Contents

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

The focus Reference Manual

This is the focus Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:54:16 2018 GMT+0.


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

1 Introduction

FoCus is a wrapper around the standard FORMAT utility. It allows you to customize the FORMAT DSL by adding new directive characters or modifying the standard ones. The semantics of these directive characters is specified in a so-called "format table", a concept very close to that of readtables. FoCus ultimately translates into regular FORMAT calls.

FoCus's homepage contains a lot of resources, including online documentation in various formats.


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

Long Name

FORMAT Customizations

Author

Didier Verna

Contact

didier@didierverna.net

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/misc.php#focus

Source Control

https://github.com/didierverna/focus

License

BSD

Description

Customizable format strings and directives

Long Description

FoCus is a wrapper around the standard FORMAT utility. It allows you to customize the FORMAT DSL by adding new directive characters or modifying the standard ones. The semantics of these directive characters is specified in a so-called "format table", a concept very close to that of readtables. FoCus ultimately translates into regular FORMAT calls.

Version

1.0

Dependencies
Source

net.didierverna.focus.asd (file)


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

2.2 net.didierverna.focus.flv

Long Name

FORMAT Customizations, FLV library

Author

Didier Verna

Contact

didier@didierverna.net

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/misc.php#focus

Source Control

https://github.com/didierverna/focus

License

BSD

Description

Focus’s support for file-local variables

Long Description

FoCus’s FLV library provides one additional macro: IN-FORMAT-TABLE. This macro is only available when *FORMAT-TABLE* can be made file-local.

Version

1.0

Dependencies
Source

net.didierverna.focus.flv.asd (file)

Component

flv.lisp (file)


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

2.3 net.didierverna.focus.core

Long Name

FORMAT Customizations, core library

Author

Didier Verna

Contact

didier@didierverna.net

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/misc.php#focus

Source Control

https://github.com/didierverna/focus

License

BSD

Description

Customizable format strings and directives

Long Description

FoCus’s core functionality. For a more complete description of FoCus, see the net.didierverna.focus system.

Version

1.0

Dependency

net.didierverna.focus.setup (system)

Source

net.didierverna.focus.core.asd (file)

Components

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

2.4 net.didierverna.focus.setup

Long Name

FORMAT Customizations, setup library

Author

Didier Verna

Contact

didier@didierverna.net

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/misc.php#focus

Source Control

https://github.com/didierverna/focus

License

BSD

Description

FoCus’s preload setup library

Long Description

FoCus’s setup library provides support for various preload configuration parameters. For a more complete description of FoCus, see the net.didierverna.focus system.

Source

net.didierverna.focus.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.


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

3.1 net.didierverna.focus.core/src

Dependency

meta.lisp (file)

Parent

net.didierverna.focus.core (system)

Location

core/src/

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.focus.asd

Location

net.didierverna.focus.asd

Systems

net.didierverna.focus (system)


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

4.1.2 net.didierverna.focus.flv.asd

Location

flv/net.didierverna.focus.flv.asd

Systems

net.didierverna.focus.flv (system)


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

4.1.3 net.didierverna.focus.core.asd

Location

core/net.didierverna.focus.core.asd

Systems

net.didierverna.focus.core (system)


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

4.1.4 net.didierverna.focus.setup.asd

Location

setup/net.didierverna.focus.setup.asd

Systems

net.didierverna.focus.setup (system)


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

4.1.5 net.didierverna.focus.flv/flv.lisp

Parent

net.didierverna.focus.flv (system)

Location

flv/flv.lisp

Exported Definitions

in-format-table (macro)


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

4.1.6 net.didierverna.focus.core/meta.lisp

Parent

net.didierverna.focus.core (system)

Location

core/meta.lisp

Packages

net.didierverna.focus

Exported Definitions

nickname-package (function)

Internal Definitions

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

4.1.7 net.didierverna.focus.core/src/util.lisp

Parent

src (module)

Location

core/src/util.lisp

Internal Definitions

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

4.1.8 net.didierverna.focus.core/src/directive.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

core/src/directive.lisp

Internal Definitions

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

4.1.9 net.didierverna.focus.core/src/table.lisp

Dependency

directive.lisp (file)

Parent

src (module)

Location

core/src/table.lisp

Packages

net.didierverna.focus.user-functions

Exported Definitions
Internal Definitions

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

4.1.10 net.didierverna.focus.core/src/string.lisp

Dependency

table.lisp (file)

Parent

src (module)

Location

core/src/string.lisp

Internal Definitions

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

4.1.11 net.didierverna.focus.core/src/wrapper.lisp

Dependency

string.lisp (file)

Parent

src (module)

Location

core/src/wrapper.lisp

Exported Definitions

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

4.1.12 net.didierverna.focus.setup/setup.lisp

Parent

net.didierverna.focus.setup (system)

Location

setup/setup.lisp

Packages

net.didierverna.focus.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.focus

The FoCus package.

Source

meta.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.2 net.didierverna.focus.user-functions

The FoCus user functions package.
This package is used to store anonymous user functions (as provided to SET-FORMAT-DIRECTIVE) under gentemp’ed names.

Source

table.lisp (file)


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

5.3 net.didierverna.focus.setup

Format Customizations, setup.

Source

setup.lisp (file)

Use List

common-lisp

Used By List

net.didierverna.focus

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: *compile*

Whether to compile to standard format calls.
If non-nil, the translation to standard format strings occurs at compile-time (hence, the current format table must also be known at compile-time). Otherwise (the default), the translation occurs at run-time.

Package

net.didierverna.focus

Source

wrapper.lisp (file)

Special Variable: *format-table*

The current format table.

Package

net.didierverna.focus

Source

table.lisp (file)

Special Variable: *release-major-level*

The major level of this release.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Special Variable: *release-minor-level*

The minor level of this release.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Special Variable: *release-name*

The name of this release.
The general naming theme for FoCus is "Aïkido movements".

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Special Variable: *release-status*

The status of this release.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Special Variable: *release-status-level*

The status level of this release.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)


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

6.1.2 Macros

Macro: format DESTINATION FORMAT-CONTROL &rest ARGS

Wrapper around the standard FORMAT function.
When FORMAT-CONTROL is a string, it is interpreted according to the current format table. Such translation may occur at compile or run time, according to the value of *COMPILE*.

Package

net.didierverna.focus

Source

wrapper.lisp (file)

Macro: formatter FORMAT-STRING

Wrapper around the standard FORMATTER macro.
FORMAT-STRING is interpreted according to the current (compile-time) format table.

Package

net.didierverna.focus

Source

wrapper.lisp (file)

Macro: in-format-table TABLE-OR-NAME

Set the current format table to TABLE-OR-NAME in the current file.
This macro behaves like IN-PACKAGE or IN-READTABLE and also sets *COMPILE* to t, so as to enable compile-time behavior in FoCus.

Package

net.didierverna.focus

Source

flv.lisp (file)

Macro: with-format-table TABLE-OR-NAME &body BODY

Execute BODY with the current format table bound to TABLE-OR-NAME.

Package

net.didierverna.focus

Source

table.lisp (file)


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

6.1.3 Functions

Function: configuration KEY

Return KEY’s value in the current FoCus configuration.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Function: configure KEY VALUE

Set KEY to VALUE in the current FoCus configuration.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Function: make-format-table &optional INITIALLY &aux TABLE MAPPINGS

Create and return a new format table.
The table may be INITIALLY :standard (the default), :standard-upcase, :standard-downcase or :blank.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: nickname-package &optional NICKNAME

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

Package

net.didierverna.focus

Source

meta.lisp (file)

Function: register-format-table TABLE NAME &optional FORCE

Register TABLE under NAME (a symbol) and return it.
FORCE means overwrite an already existing registration under that name. Otherwise (the default), throw a TABLE-COLLISION error.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: set-format-directive CHAR &key STANDARD (FUNCTION FUNCTION-OR-NAME) BOTH-CASE FORCE (TABLE TABLE-OR-NAME) &aux TABLE

Set a ~CHAR directive in TABLE.
- TABLE (the current format table by default) may be a table or a table name. - When BOTH-CASE (the default), operate on both case versions of CHAR.
- Attempting to override an existing directive throws a TABLE-DIRECTIVE-COLLISION error, unless FORCE is non-nil.

The operation to perform is as follows:
- If FUNCTION is provided (either a function or a function name), associate CHAR with it.
- If STANDARD is provided, associate CHAR with the standard directive denoted by STANDARD character (case does not matter).
- Otherwise, remove the ~CHAR directive from TABLE.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: setup-flv ()

Autodetect support for file-local variables. Update FoCus configuration and *FEATURES* accordingly.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Function: unregister-format-table NAME

Unregister NAMEd table.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: version &optional TYPE

Return the current version of FoCus.
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 "Kokyu Ho". As for
the short version, a patchlevel of 0 is ignored in the output.

Package

net.didierverna.focus.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: *configuration*

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

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

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Special Variable: *readtable*

The FoCus readtable.

Package

net.didierverna.focus

Source

meta.lisp (file)

Special Variable: *standard-directives*

The list of standard format directives.

Package

net.didierverna.focus

Source

directive.lisp (file)


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

6.2.2 Macros

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

Source

meta.lisp (file)

Macro: in-readtable NAME

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

Package

net.didierverna.focus

Source

meta.lisp (file)


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

6.2.3 Functions

Function: %make-format-table &key (MAPPINGS MAPPINGS)
Package

net.didierverna.focus

Source

table.lisp (file)

Function: %version TYPE MAJOR MINOR STATUS LEVEL NAME
Package

net.didierverna.focus.setup

Source

setup.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.focus

Source

meta.lisp (file)

Function: copy-format-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: copy-format-table INSTANCE
Package

net.didierverna.focus

Source

table.lisp (file)

Function: copy-function-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: copy-standard-closing-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: copy-standard-delimiting-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: copy-standard-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: copy-standard-opening-directive INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: directive-body-position STRING START

Return a STRING’s directive body position from START.
START is the position of the tilde character, so this function essentially parses the directive arguments in order to skip them.

Package

net.didierverna.focus

Source

string.lisp (file)

Function: directive-character INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: directive-closing-character INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: directive-function-name INSTANCE
Function: (setf directive-function-name) VALUE INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: directive-opening-character INSTANCE
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: find-standard-directive CHARACTER &aux CHARACTER DIRECTIVE

Return the standard directive corresponding to CHARACTER. Throw a NONSTANDARD-DIRECTIVE-CHARACTER error otherwise.

Package

net.didierverna.focus

Source

directive.lisp (file)

Function: find-table TABLE-OR-NAME

Return its table argument directly, or look it up by name.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: format-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: format-table-p OBJECT
Package

net.didierverna.focus

Source

table.lisp (file)

Function: function-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: i-reader STREAM SUBCHAR ARG

Read an argument list for the DEFINDENT macro.

Package

net.didierverna.focus

Source

meta.lisp (file)

Function: lookup-table NAME &optional ERRORP &aux TABLE

Look for a format table registered under NAME.
ERRORP (the default) means to throw a TABLE-NOT-REGISTERED error if no such table is found. Otherwise, just return nil.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: make-format-directive &key
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: make-function-directive &key (FUNCTION-NAME FUNCTION-NAME)
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: make-standard-closing-directive &key (CHARACTER CHARACTER) (OPENING-CHARACTER OPENING-CHARACTER)
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: make-standard-delimiting-directive &key (CHARACTER CHARACTER)
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: make-standard-directive &key (CHARACTER CHARACTER)
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: make-standard-opening-directive &key (CHARACTER CHARACTER) (CLOSING-CHARACTER CLOSING-CHARACTER)
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: next-directive-position STRING START

Return the next directive position in STRING from START, or nil.

Package

net.didierverna.focus

Source

string.lisp (file)

Function: other-case CHAR

Return the other case version of CHAR if it exists.

Package

net.didierverna.focus

Source

util.lisp (file)

Function: release-status-number RELEASE-STATUS
Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Function: restrict-because REASON

Put FoCus in restricted mode because of REASON.

Package

net.didierverna.focus.setup

Source

setup.lisp (file)

Function: standard-closing-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: standard-delimiting-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: standard-directive STRING POSITION TABLE &aux BODY-POSITION DIRECTIVE

Translate a STRING directive into a standard one.
- POSITION is the position of the ~ character.
- The translation is done according to format TABLE.

Return two values:
- the translated directive as a string,
- the STRING’s remainder index.

Note that the directive arguments are copied as-is. Only the directive’s body actually involves a translation.

Package

net.didierverna.focus

Source

string.lisp (file)

Function: standard-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: standard-format-string FORMAT-CONTROL &optional TABLE

Return the translation of FORMAT-CONTROL into a standard one.
When FORMAT-CONTROL is a string, the translation is done according to format TABLE (the current table by default). Otherwise, FORMAT-CONTROL is returned as-is.

Package

net.didierverna.focus

Source

string.lisp (file)

Function: standard-opening-directive-p OBJECT
Package

net.didierverna.focus

Source

directive.lisp (file)

Function: table-mappings INSTANCE
Function: (setf table-mappings) VALUE INSTANCE
Package

net.didierverna.focus

Source

table.lisp (file)

Function: table-name TABLE

Find TABLE’s name if registered, return nil otherwise.

Package

net.didierverna.focus

Source

table.lisp (file)

Function: tilde-reader STREAM CHAR

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

Package

net.didierverna.focus

Source

meta.lisp (file)


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

6.2.4 Generic functions

Generic Function: delimiter CONDITION
Package

net.didierverna.focus

Methods
Method: delimiter (CONDITION missing-delimiter)
Source

string.lisp (file)

Generic Function: format-string CONDITION
Package

net.didierverna.focus

Methods
Method: format-string (CONDITION format-string-error)
Source

string.lisp (file)

Generic Function: modifier CONDITION
Package

net.didierverna.focus

Methods
Method: modifier (CONDITION spurious-modifier)
Source

string.lisp (file)

Generic Function: name CONDITION
Package

net.didierverna.focus

Methods
Method: name (CONDITION table-lookup-error)
Source

table.lisp (file)

Generic Function: nonstandard-directive-character CONDITION
Package

net.didierverna.focus

Methods
Method: nonstandard-directive-character (CONDITION nonstandard-directive-character)
Source

directive.lisp (file)

Generic Function: standard-directive-body STRING POSITION DIRECTIVE

Translate a STRING directive’s body into a standard one.
- POSITION is the position of the directive’s body (i.e., past the ~ character and the potential arguments).
- The translation is done according to DIRECTIVE.

Return two values:
- the translated directive’s body as a string,
- the STRING’s remainder index.

Package

net.didierverna.focus

Source

string.lisp (file)

Methods
Method: standard-directive-body STRING POSITION (DIRECTIVE standard-directive)

Method for one-character and grouping standard directives.

Method: standard-directive-body STRING POSITION (DIRECTIVE standard-delimiting-directive)

Method for the / standard directive.

Method: standard-directive-body STRING POSITION (DIRECTIVE function-directive)

Method for function directives.

Generic Function: string-position CONDITION
Package

net.didierverna.focus

Methods
Method: string-position (CONDITION format-string-error)
Source

string.lisp (file)

Generic Function: table CONDITION
Package

net.didierverna.focus

Methods
Method: table (CONDITION missing-table-directive)
Source

string.lisp (file)

Method: table (CONDITION format-table-error)
Source

table.lisp (file)

Generic Function: table-character CONDITION
Package

net.didierverna.focus

Methods
Method: table-character (CONDITION table-directive-error)
Source

table.lisp (file)


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

6.2.5 Conditions

Condition: focus-error ()

A FoCus error.

Package

net.didierverna.focus

Source

util.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Condition: format-string-error ()

A format string error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

focus-error (condition)

Direct subclasses
Direct methods
Direct slots
Slot: string

The format string.

Initargs

:string

Readers

format-string (generic function)

Slot: position

The position at which the error occurs.

Initargs

:position

Initform

(quote nil)

Readers

string-position (generic function)

Condition: format-table-error ()

A format table error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

focus-error (condition)

Direct subclasses

table-directive-error (condition)

Direct methods

table (method)

Direct slots
Slot: table

The format table.

Initargs

:table

Readers

table (generic function)

Condition: missing-delimiter ()

A missing delimiter error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

format-string-error (condition)

Direct methods

delimiter (method)

Direct slots
Slot: delimiter

The delimiter character.

Initargs

:delimiter

Readers

delimiter (generic function)

Condition: missing-string-directive ()

A missing directive error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

format-string-error (condition)

Condition: missing-table ()

A missing format table error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

table-lookup-error (condition)

Condition: missing-table-directive ()

A missing table directive error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

format-string-error (condition)

Direct methods

table (method)

Direct slots
Slot: table

The format table.

Initargs

:table

Readers

table (generic function)

Condition: nonstandard-directive-character ()

A nonstandard directive character error.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

standard-directive-lookup-error (condition)

Direct methods

nonstandard-directive-character (method)

Direct slots
Slot: character

The character.

Initargs

:character

Readers

nonstandard-directive-character (generic function)

Condition: spurious-modifier ()

A spurious modifier error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

format-string-error (condition)

Direct methods

modifier (method)

Direct slots
Slot: modifier

The modifier character.

Initargs

:modifier

Readers

modifier (generic function)

Condition: spurious-parameter ()

A spurious parameter error.

Package

net.didierverna.focus

Source

string.lisp (file)

Direct superclasses

format-string-error (condition)

Condition: standard-directive-lookup-error ()

A standard directive lookup error.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

focus-error (condition)

Direct subclasses

nonstandard-directive-character (condition)

Condition: table-collision ()

A table collision error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

table-lookup-error (condition)

Condition: table-directive-collision ()

A table directive collision error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

table-directive-error (condition)

Condition: table-directive-error ()

A table directive error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

format-table-error (condition)

Direct subclasses

table-directive-collision (condition)

Direct methods

table-character (method)

Direct slots
Slot: character

The directive character.

Initargs

:character

Readers

table-character (generic function)

Condition: table-lookup-error ()

A format table lookup error.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

focus-error (condition)

Direct subclasses
Direct methods

name (method)

Direct slots
Slot: name

The looked up name.

Initargs

:name

Readers

name (generic function)


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

6.2.6 Structures

Structure: format-directive ()

Base structure for format directives.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses
Structure: format-table ()

Structure for format tables.
This structure holds the MAPPINGS from characters to directives.

Package

net.didierverna.focus

Source

table.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: mappings
Type

hash-table

Initform

(make-hash-table)

Readers

table-mappings (function)

Writers

(setf table-mappings) (function)

Structure: function-directive ()

Structure for user-defined function directives. This structure holds the associated function name.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

format-directive (structure)

Direct methods

standard-directive-body (method)

Direct slots
Slot: function-name
Type

symbol

Readers

directive-function-name (function)

Writers

(setf directive-function-name) (function)

Structure: standard-closing-directive ()

Structure for standard closing directives.
This structure holds the corresponding (upcase) opening character.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

standard-directive (structure)

Direct slots
Slot: opening-character
Type

character

Readers

directive-opening-character (function)

Writers

(setf directive-opening-character) (function)

Structure: standard-delimiting-directive ()

Structure for standard delimiting directives.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

standard-directive (structure)

Direct methods

standard-directive-body (method)

Structure: standard-directive ()

Base structure for standard directives.
This structure holds the (upcase) directive character.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

format-directive (structure)

Direct subclasses
Direct methods

standard-directive-body (method)

Direct slots
Slot: character
Type

character

Readers

directive-character (function)

Writers

(setf directive-character) (function)

Structure: standard-opening-directive ()

Structure for standard opening directives.
This structure holds the corresponding (upcase) closing character.

Package

net.didierverna.focus

Source

directive.lisp (file)

Direct superclasses

standard-directive (structure)

Direct slots
Slot: closing-character
Type

character

Readers

directive-closing-character (function)

Writers

(setf directive-closing-character) (function)


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.focus.asd: The net<dot>didierverna<dot>focus<dot>asd file
File, Lisp, net.didierverna.focus.core.asd: The net<dot>didierverna<dot>focus<dot>core<dot>asd file
File, Lisp, net.didierverna.focus.core/meta.lisp: The net<dot>didierverna<dot>focus<dot>core/meta<dot>lisp file
File, Lisp, net.didierverna.focus.core/src/directive.lisp: The net<dot>didierverna<dot>focus<dot>core/src/directive<dot>lisp file
File, Lisp, net.didierverna.focus.core/src/string.lisp: The net<dot>didierverna<dot>focus<dot>core/src/string<dot>lisp file
File, Lisp, net.didierverna.focus.core/src/table.lisp: The net<dot>didierverna<dot>focus<dot>core/src/table<dot>lisp file
File, Lisp, net.didierverna.focus.core/src/util.lisp: The net<dot>didierverna<dot>focus<dot>core/src/util<dot>lisp file
File, Lisp, net.didierverna.focus.core/src/wrapper.lisp: The net<dot>didierverna<dot>focus<dot>core/src/wrapper<dot>lisp file
File, Lisp, net.didierverna.focus.flv.asd: The net<dot>didierverna<dot>focus<dot>flv<dot>asd file
File, Lisp, net.didierverna.focus.flv/flv.lisp: The net<dot>didierverna<dot>focus<dot>flv/flv<dot>lisp file
File, Lisp, net.didierverna.focus.setup.asd: The net<dot>didierverna<dot>focus<dot>setup<dot>asd file
File, Lisp, net.didierverna.focus.setup/setup.lisp: The net<dot>didierverna<dot>focus<dot>setup/setup<dot>lisp file

L
Lisp File, net.didierverna.focus.asd: The net<dot>didierverna<dot>focus<dot>asd file
Lisp File, net.didierverna.focus.core.asd: The net<dot>didierverna<dot>focus<dot>core<dot>asd file
Lisp File, net.didierverna.focus.core/meta.lisp: The net<dot>didierverna<dot>focus<dot>core/meta<dot>lisp file
Lisp File, net.didierverna.focus.core/src/directive.lisp: The net<dot>didierverna<dot>focus<dot>core/src/directive<dot>lisp file
Lisp File, net.didierverna.focus.core/src/string.lisp: The net<dot>didierverna<dot>focus<dot>core/src/string<dot>lisp file
Lisp File, net.didierverna.focus.core/src/table.lisp: The net<dot>didierverna<dot>focus<dot>core/src/table<dot>lisp file
Lisp File, net.didierverna.focus.core/src/util.lisp: The net<dot>didierverna<dot>focus<dot>core/src/util<dot>lisp file
Lisp File, net.didierverna.focus.core/src/wrapper.lisp: The net<dot>didierverna<dot>focus<dot>core/src/wrapper<dot>lisp file
Lisp File, net.didierverna.focus.flv.asd: The net<dot>didierverna<dot>focus<dot>flv<dot>asd file
Lisp File, net.didierverna.focus.flv/flv.lisp: The net<dot>didierverna<dot>focus<dot>flv/flv<dot>lisp file
Lisp File, net.didierverna.focus.setup.asd: The net<dot>didierverna<dot>focus<dot>setup<dot>asd file
Lisp File, net.didierverna.focus.setup/setup.lisp: The net<dot>didierverna<dot>focus<dot>setup/setup<dot>lisp file

M
Module, net.didierverna.focus.core/src: The net<dot>didierverna<dot>focus<dot>core/src module

N
net.didierverna.focus.asd: The net<dot>didierverna<dot>focus<dot>asd file
net.didierverna.focus.core.asd: The net<dot>didierverna<dot>focus<dot>core<dot>asd file
net.didierverna.focus.core/meta.lisp: The net<dot>didierverna<dot>focus<dot>core/meta<dot>lisp file
net.didierverna.focus.core/src: The net<dot>didierverna<dot>focus<dot>core/src module
net.didierverna.focus.core/src/directive.lisp: The net<dot>didierverna<dot>focus<dot>core/src/directive<dot>lisp file
net.didierverna.focus.core/src/string.lisp: The net<dot>didierverna<dot>focus<dot>core/src/string<dot>lisp file
net.didierverna.focus.core/src/table.lisp: The net<dot>didierverna<dot>focus<dot>core/src/table<dot>lisp file
net.didierverna.focus.core/src/util.lisp: The net<dot>didierverna<dot>focus<dot>core/src/util<dot>lisp file
net.didierverna.focus.core/src/wrapper.lisp: The net<dot>didierverna<dot>focus<dot>core/src/wrapper<dot>lisp file
net.didierverna.focus.flv.asd: The net<dot>didierverna<dot>focus<dot>flv<dot>asd file
net.didierverna.focus.flv/flv.lisp: The net<dot>didierverna<dot>focus<dot>flv/flv<dot>lisp file
net.didierverna.focus.setup.asd: The net<dot>didierverna<dot>focus<dot>setup<dot>asd file
net.didierverna.focus.setup/setup.lisp: The net<dot>didierverna<dot>focus<dot>setup/setup<dot>lisp file

Jump to:   F   L   M   N  

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

A.2 Functions

Jump to:   %   (  
C   D   F   G   I   L   M   N   O   R   S   T   U   V   W  
Index Entry  Section

%
%make-format-table: Internal functions
%version: Internal functions

(
(setf directive-function-name): Internal functions
(setf table-mappings): Internal functions

C
clindent: Internal functions
configuration: Exported functions
configure: Exported functions
copy-format-directive: Internal functions
copy-format-table: Internal functions
copy-function-directive: Internal functions
copy-standard-closing-directive: Internal functions
copy-standard-delimiting-directive: Internal functions
copy-standard-directive: Internal functions
copy-standard-opening-directive: Internal functions

D
defindent: Internal macros
delimiter: Internal generic functions
delimiter: Internal generic functions
directive-body-position: Internal functions
directive-character: Internal functions
directive-closing-character: Internal functions
directive-function-name: Internal functions
directive-opening-character: Internal functions

F
find-standard-directive: Internal functions
find-table: Internal functions
format: Exported macros
format-directive-p: Internal functions
format-string: Internal generic functions
format-string: Internal generic functions
format-table-p: Internal functions
formatter: Exported macros
Function, %make-format-table: Internal functions
Function, %version: Internal functions
Function, (setf directive-function-name): Internal functions
Function, (setf table-mappings): Internal functions
Function, clindent: Internal functions
Function, configuration: Exported functions
Function, configure: Exported functions
Function, copy-format-directive: Internal functions
Function, copy-format-table: Internal functions
Function, copy-function-directive: Internal functions
Function, copy-standard-closing-directive: Internal functions
Function, copy-standard-delimiting-directive: Internal functions
Function, copy-standard-directive: Internal functions
Function, copy-standard-opening-directive: Internal functions
Function, directive-body-position: Internal functions
Function, directive-character: Internal functions
Function, directive-closing-character: Internal functions
Function, directive-function-name: Internal functions
Function, directive-opening-character: Internal functions
Function, find-standard-directive: Internal functions
Function, find-table: Internal functions
Function, format-directive-p: Internal functions
Function, format-table-p: Internal functions
Function, function-directive-p: Internal functions
Function, i-reader: Internal functions
Function, lookup-table: Internal functions
Function, make-format-directive: Internal functions
Function, make-format-table: Exported functions
Function, make-function-directive: Internal functions
Function, make-standard-closing-directive: Internal functions
Function, make-standard-delimiting-directive: Internal functions
Function, make-standard-directive: Internal functions
Function, make-standard-opening-directive: Internal functions
Function, next-directive-position: Internal functions
Function, nickname-package: Exported functions
Function, other-case: Internal functions
Function, register-format-table: Exported functions
Function, release-status-number: Internal functions
Function, restrict-because: Internal functions
Function, set-format-directive: Exported functions
Function, setup-flv: Exported functions
Function, standard-closing-directive-p: Internal functions
Function, standard-delimiting-directive-p: Internal functions
Function, standard-directive: Internal functions
Function, standard-directive-p: Internal functions
Function, standard-format-string: Internal functions
Function, standard-opening-directive-p: Internal functions
Function, table-mappings: Internal functions
Function, table-name: Internal functions
Function, tilde-reader: Internal functions
Function, unregister-format-table: Exported functions
Function, version: Exported functions
function-directive-p: Internal functions

G
Generic Function, delimiter: Internal generic functions
Generic Function, format-string: Internal generic functions
Generic Function, modifier: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, nonstandard-directive-character: Internal generic functions
Generic Function, standard-directive-body: Internal generic functions
Generic Function, string-position: Internal generic functions
Generic Function, table: Internal generic functions
Generic Function, table-character: Internal generic functions

I
i-reader: Internal functions
in-format-table: Exported macros
in-readtable: Internal macros

L
lookup-table: Internal functions

M
Macro, defindent: Internal macros
Macro, format: Exported macros
Macro, formatter: Exported macros
Macro, in-format-table: Exported macros
Macro, in-readtable: Internal macros
Macro, with-format-table: Exported macros
make-format-directive: Internal functions
make-format-table: Exported functions
make-function-directive: Internal functions
make-standard-closing-directive: Internal functions
make-standard-delimiting-directive: Internal functions
make-standard-directive: Internal functions
make-standard-opening-directive: Internal functions
Method, delimiter: Internal generic functions
Method, format-string: Internal generic functions
Method, modifier: Internal generic functions
Method, name: Internal generic functions
Method, nonstandard-directive-character: Internal generic functions
Method, standard-directive-body: Internal generic functions
Method, standard-directive-body: Internal generic functions
Method, standard-directive-body: Internal generic functions
Method, string-position: Internal generic functions
Method, table: Internal generic functions
Method, table: Internal generic functions
Method, table-character: Internal generic functions
modifier: Internal generic functions
modifier: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions
next-directive-position: Internal functions
nickname-package: Exported functions
nonstandard-directive-character: Internal generic functions
nonstandard-directive-character: Internal generic functions

O
other-case: Internal functions

R
register-format-table: Exported functions
release-status-number: Internal functions
restrict-because: Internal functions

S
set-format-directive: Exported functions
setup-flv: Exported functions
standard-closing-directive-p: Internal functions
standard-delimiting-directive-p: Internal functions
standard-directive: Internal functions
standard-directive-body: Internal generic functions
standard-directive-body: Internal generic functions
standard-directive-body: Internal generic functions
standard-directive-body: Internal generic functions
standard-directive-p: Internal functions
standard-format-string: Internal functions
standard-opening-directive-p: Internal functions
string-position: Internal generic functions
string-position: Internal generic functions

T
table: Internal generic functions
table: Internal generic functions
table: Internal generic functions
table-character: Internal generic functions
table-character: Internal generic functions
table-mappings: Internal functions
table-name: Internal functions
tilde-reader: Internal functions

U
unregister-format-table: Exported functions

V
version: Exported functions

W
with-format-table: Exported macros

Jump to:   %   (  
C   D   F   G   I   L   M   N   O   R   S   T   U   V   W  

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

A.3 Variables

Jump to:   *  
C   D   F   M   N   O   P   S   T  
Index Entry  Section

*
*compile*: Exported special variables
*configuration*: Internal special variables
*format-table*: Exported special variables
*readtable*: Internal special variables
*release-major-level*: Exported special variables
*release-minor-level*: Exported special variables
*release-name*: Exported special variables
*release-status*: Exported special variables
*release-status-level*: Exported special variables
*standard-directives*: Internal special variables

C
character: Internal conditions
character: Internal conditions
character: Internal structures
closing-character: Internal structures

D
delimiter: Internal conditions

F
function-name: Internal structures

M
mappings: Internal structures
modifier: Internal conditions

N
name: Internal conditions

O
opening-character: Internal structures

P
position: Internal conditions

S
Slot, character: Internal conditions
Slot, character: Internal conditions
Slot, character: Internal structures
Slot, closing-character: Internal structures
Slot, delimiter: Internal conditions
Slot, function-name: Internal structures
Slot, mappings: Internal structures
Slot, modifier: Internal conditions
Slot, name: Internal conditions
Slot, opening-character: Internal structures
Slot, position: Internal conditions
Slot, string: Internal conditions
Slot, table: Internal conditions
Slot, table: Internal conditions
Special Variable, *compile*: Exported special variables
Special Variable, *configuration*: Internal special variables
Special Variable, *format-table*: Exported special variables
Special Variable, *readtable*: Internal special variables
Special Variable, *release-major-level*: Exported special variables
Special Variable, *release-minor-level*: Exported special variables
Special Variable, *release-name*: Exported special variables
Special Variable, *release-status*: Exported special variables
Special Variable, *release-status-level*: Exported special variables
Special Variable, *standard-directives*: Internal special variables
string: Internal conditions

T
table: Internal conditions
table: Internal conditions

Jump to:   *  
C   D   F   M   N   O   P   S   T  

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

A.4 Data types

Jump to:   C   F   M   N   P   S   T  
Index Entry  Section

C
Condition, focus-error: Internal conditions
Condition, format-string-error: Internal conditions
Condition, format-table-error: Internal conditions
Condition, missing-delimiter: Internal conditions
Condition, missing-string-directive: Internal conditions
Condition, missing-table: Internal conditions
Condition, missing-table-directive: Internal conditions
Condition, nonstandard-directive-character: Internal conditions
Condition, spurious-modifier: Internal conditions
Condition, spurious-parameter: Internal conditions
Condition, standard-directive-lookup-error: Internal conditions
Condition, table-collision: Internal conditions
Condition, table-directive-collision: Internal conditions
Condition, table-directive-error: Internal conditions
Condition, table-lookup-error: Internal conditions

F
focus-error: Internal conditions
format-directive: Internal structures
format-string-error: Internal conditions
format-table: Internal structures
format-table-error: Internal conditions
function-directive: Internal structures

M
missing-delimiter: Internal conditions
missing-string-directive: Internal conditions
missing-table: Internal conditions
missing-table-directive: Internal conditions

N
net.didierverna.focus: The net<dot>didierverna<dot>focus system
net.didierverna.focus: The net<dot>didierverna<dot>focus package
net.didierverna.focus.core: The net<dot>didierverna<dot>focus<dot>core system
net.didierverna.focus.flv: The net<dot>didierverna<dot>focus<dot>flv system
net.didierverna.focus.setup: The net<dot>didierverna<dot>focus<dot>setup system
net.didierverna.focus.setup: The net<dot>didierverna<dot>focus<dot>setup package
net.didierverna.focus.user-functions: The net<dot>didierverna<dot>focus<dot>user-functions package
nonstandard-directive-character: Internal conditions

P
Package, net.didierverna.focus: The net<dot>didierverna<dot>focus package
Package, net.didierverna.focus.setup: The net<dot>didierverna<dot>focus<dot>setup package
Package, net.didierverna.focus.user-functions: The net<dot>didierverna<dot>focus<dot>user-functions package

S
spurious-modifier: Internal conditions
spurious-parameter: Internal conditions
standard-closing-directive: Internal structures
standard-delimiting-directive: Internal structures
standard-directive: Internal structures
standard-directive-lookup-error: Internal conditions
standard-opening-directive: Internal structures
Structure, format-directive: Internal structures
Structure, format-table: Internal structures
Structure, function-directive: Internal structures
Structure, standard-closing-directive: Internal structures
Structure, standard-delimiting-directive: Internal structures
Structure, standard-directive: Internal structures
Structure, standard-opening-directive: Internal structures
System, net.didierverna.focus: The net<dot>didierverna<dot>focus system
System, net.didierverna.focus.core: The net<dot>didierverna<dot>focus<dot>core system
System, net.didierverna.focus.flv: The net<dot>didierverna<dot>focus<dot>flv system
System, net.didierverna.focus.setup: The net<dot>didierverna<dot>focus<dot>setup system

T
table-collision: Internal conditions
table-directive-collision: Internal conditions
table-directive-error: Internal conditions
table-lookup-error: Internal conditions

Jump to:   C   F   M   N   P   S   T