The net.didierverna.declt.setup Reference Manual

This is the net.didierverna.declt.setup Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:57:17 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 net.didierverna.declt.setup

Declt’s preload setup

Long Name

Documentation Extractor from Common Lisp to Texinfo, setup library

Author

Didier Verna

Contact

Home Page

http://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt

Source Control

https://github.com/didierverna/declt

License

BSD

Long Description

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

Dependency

named-readtables (system).

Source

net.didierverna.declt.setup.asd.

Child Components

2 Modules

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


2.1 net.didierverna.declt.setup/src

Dependency

package.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

net.didierverna.declt.setup (system).

Child Components

3 Files

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


3.1 Lisp


3.1.1 net.didierverna.declt.setup/net.didierverna.declt.setup.asd

Source

net.didierverna.declt.setup.asd.

Parent Component

net.didierverna.declt.setup (system).

ASDF Systems

net.didierverna.declt.setup.


3.1.3 net.didierverna.declt.setup/src/configuration.lisp

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface
Internals

*configuration* (special variable).


3.1.4 net.didierverna.declt.setup/src/readtable.lisp

Dependency

configuration.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Internals

3.1.5 net.didierverna.declt.setup/src/version.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.6 net.didierverna.declt.setup/src/util.lisp

Dependency

readtable.lisp (file).

Source

net.didierverna.declt.setup.asd.

Parent Component

src (module).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 net.didierverna.declt.setup

The Declt setup library’s package.

Source

package.lisp.

Use List

common-lisp.

Used By List
  • net.didierverna.declt.
  • net.didierverna.declt.assess.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *copyright-years*

A string denoting the copyright years for the whole project.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-major-level*

The major level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-minor-level*

The minor level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-name*

The name of this release.
The general naming theme for Declt is "Star Trek characters".

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-status*

The status of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.

Special Variable: *release-status-level*

The status level of this release.

Package

net.didierverna.declt.setup.

Source

version.lisp.


5.1.2 Macros

Macro: declare-valid-superclass (class superclass)

Validate SUPERCLASS classes for CLASS classes.

Package

net.didierverna.declt.setup.

Source

util.lisp.

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

Like DEFCLASS, but define an abstract class.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: endpush (object place)

Push OBJECT at the end of PLACE.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: when-let (bindings &body body)

Execute BODY only when all BINDINGS are non-nil.
BINDINGS must be either a single binding of the form (VARIABLE VALUE), or a list of such. VALUEs are computed sequentially in the specified order, and then VARIABLEs are bound to the corresponding VALUEs. If all VALUEs are non-nil, BODY is executed.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: when-let* (bindings &body body)

Execute BODY only when all BINDINGS are non-nil.
BINDINGS must be either a single binding of the form (VARIABLE VALUE),
or a list of such. VARIABLEs are bound to their respective VALUE sequentially, so that each VALUE expression may refer to a previously bound VARIABLE. Execution stops completely as soon as a null VALUE is encountered. Otherwise, BODY is executed as an implicit PROGN.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Macro: while (test &body body)

Execute BODY while TEST.

Package

net.didierverna.declt.setup.

Source

util.lisp.


5.1.3 Ordinary functions

Function: configuration (key)

Return KEY’s value in the current Declt configuration.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.

Function: configure (key value)

Set KEY to VALUE in the current Declt configuration.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.

Function: find* (object list &key test key pre-test)

Return the first finding of OBJECT in LIST, or NIL.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item itself by default, or on the result of applying KEY to it. Optionally, only items satisfying PRE-TEST are considered.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: mapcat (function &rest lists)

Short for "mapconcat": non destructive version of MAPCAN. That is, concatenate the results with APPEND rather than NCONC.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: non-empty-string-p (object)

Return T if OBJECT is a non-empty string.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: retain (object list &key test key pre-test)

Return a copy of LIST from which only OBJECT is retained.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item itself by default, or on the result of applying KEY to it. Optionally, only items satisfying PRE-TEST are considered.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Function: version (&optional type)

Return the current version of Declt.
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 "James T. Kirk". As for the short version, a patchlevel of 0 is ignored in the output.

Package

net.didierverna.declt.setup.

Source

version.lisp.


5.1.4 Standalone methods

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

util.lisp.

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

sb-mop.

Source

util.lisp.

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

sb-mop.

Source

util.lisp.


5.1.5 Classes

Class: abstract-class

The Abstract Class meta-class.

Package

net.didierverna.declt.setup.

Source

util.lisp.

Direct superclasses

standard-class.

Direct methods

5.1.6 Types

Type: non-empty-string ()
Package

net.didierverna.declt.setup.

Source

util.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *configuration*

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

See Section 4.1 of the user manual for more information.

Package

net.didierverna.declt.setup.

Source

configuration.lisp.


5.2.2 Macros

Macro: defindent (symbol indent)

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

Package

net.didierverna.declt.setup.

Source

readtable.lisp.


5.2.3 Ordinary functions

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

net.didierverna.declt.setup.

Source

version.lisp.

Function: clindent (symbol indent)

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

Package

net.didierverna.declt.setup.

Source

readtable.lisp.

Function: i-reader (stream subchar arg)

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

Package

net.didierverna.declt.setup.

Source

readtable.lisp.

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

net.didierverna.declt.setup.

Source

version.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   D   E   F   I   M   N   R   V   W  
Index Entry  Section

%
%version: Private ordinary functions

C
clindent: Private ordinary functions
configuration: Public ordinary functions
configure: Public ordinary functions

D
declare-valid-superclass: Public macros
defabstract: Public macros
defindent: Private macros

E
endpush: Public macros

F
find*: Public ordinary functions
Function, %version: Private ordinary functions
Function, clindent: Private ordinary functions
Function, configuration: Public ordinary functions
Function, configure: Public ordinary functions
Function, find*: Public ordinary functions
Function, i-reader: Private ordinary functions
Function, mapcat: Public ordinary functions
Function, non-empty-string-p: Public ordinary functions
Function, release-status-number: Private ordinary functions
Function, retain: Public ordinary functions
Function, version: Public ordinary functions

I
i-reader: Private ordinary functions

M
Macro, declare-valid-superclass: Public macros
Macro, defabstract: Public macros
Macro, defindent: Private macros
Macro, endpush: Public macros
Macro, when-let: Public macros
Macro, when-let*: Public macros
Macro, while: Public macros
make-instance: Public standalone methods
mapcat: Public ordinary functions
Method, make-instance: Public standalone methods
Method, validate-superclass: Public standalone methods
Method, validate-superclass: Public standalone methods

N
non-empty-string-p: Public ordinary functions

R
release-status-number: Private ordinary functions
retain: Public ordinary functions

V
validate-superclass: Public standalone methods
validate-superclass: Public standalone methods
version: Public ordinary functions

W
when-let: Public macros
when-let*: Public macros
while: Public macros


A.4 Data types

Jump to:   A   C   F   M   N   P   R   S   T   U   V  
Index Entry  Section

A
abstract-class: Public classes

C
Class, abstract-class: Public classes
configuration.lisp: The net․didierverna․declt․setup/src/configuration․lisp file

F
File, configuration.lisp: The net․didierverna․declt․setup/src/configuration․lisp file
File, net.didierverna.declt.setup.asd: The net․didierverna․declt․setup/net․didierverna․declt․setup․asd file
File, package.lisp: The net․didierverna․declt․setup/package․lisp file
File, readtable.lisp: The net․didierverna․declt․setup/src/readtable․lisp file
File, util.lisp: The net․didierverna․declt․setup/src/util․lisp file
File, version.lisp: The net․didierverna․declt․setup/src/version․lisp file

M
Module, src: The net․didierverna․declt․setup/src module

N
net.didierverna.declt.setup: The net․didierverna․declt․setup system
net.didierverna.declt.setup: The net․didierverna․declt․setup package
net.didierverna.declt.setup.asd: The net․didierverna․declt․setup/net․didierverna․declt․setup․asd file
non-empty-string: Public types

P
Package, net.didierverna.declt.setup: The net․didierverna․declt․setup package
package.lisp: The net․didierverna․declt․setup/package․lisp file

R
readtable.lisp: The net․didierverna․declt․setup/src/readtable․lisp file

S
src: The net․didierverna․declt․setup/src module
System, net.didierverna.declt.setup: The net․didierverna․declt․setup system

T
Type, non-empty-string: Public types

U
util.lisp: The net․didierverna․declt․setup/src/util․lisp file

V
version.lisp: The net․didierverna․declt․setup/src/version․lisp file