The fr.epita.lrde.quickref Reference Manual

4.1.1 fr.epita.lrde.quickref/fr.epita.lrde.quickref.asd

Source

fr.epita.lrde.quickref.asd.

Parent Component

fr.epita.lrde.quickref (system).

ASDF Systems

fr.epita.lrde.quickref.

---

4.1.2 fr.epita.lrde.quickref.core/fr.epita.lrde.quickref.core.asd

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

fr.epita.lrde.quickref.core (system).

ASDF Systems

fr.epita.lrde.quickref.core.

---

4.1.3 fr.epita.lrde.quickref.setup/parallel/fr.epita.lrde.quickref.setup.asd

Source

fr.epita.lrde.quickref.setup.asd.

Parent Component

fr.epita.lrde.quickref.setup/parallel (system).

ASDF Systems

• fr.epita.lrde.quickref.setup/parallel.
• fr.epita.lrde.quickref.setup.

---

4.1.4 fr.epita.lrde.quickref.cmark/fr.epita.lrde.quickref.cmark.asd

Source

fr.epita.lrde.quickref.cmark.asd.

Parent Component

fr.epita.lrde.quickref.cmark (system).

ASDF Systems

fr.epita.lrde.quickref.cmark.

---

4.1.5 fr.epita.lrde.quickref.core/package.lisp

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

fr.epita.lrde.quickref.core (system).

Packages

fr.epita.lrde.quickref.

Public Interface

nickname-package (function).

---

4.1.6 fr.epita.lrde.quickref.core/src/common/util.lisp

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Internals

• *bin-directory* (special variable).
• *css-directory* (special variable).
• *gp-directory* (special variable).
• *share-directory* (special variable).
• *templates-directory* (special variable).
• *top-directory* (special variable).
• file-contents (function).
• library-name (generic function).
• primary-system (function).
• quicklisp-distribution (function).
• trim (generic function).
• while (macro).

---

4.1.7 fr.epita.lrde.quickref.core/src/common/context.lisp

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Public Interface

initialize-instance (method).

Internals

• cache-directory (function).
• cache-policy (reader method).
• cohort (reader method).
• cohort-db-directory (function).
• cohort-directory (function).
• cohort-stats-directory (function).
• context (class).
• cross-reference-validation (reader method).
• db-directory (function).
• declt-logs-directory (function).
• empty-cache (reader method).
• error-behavior (reader method).
• html-cohort-directory (function).
• html-directory (function).
• html-file (function).
• logs-directory (function).
• make-context (function).
• makeinfo-logs-directory (function).
• makeinfo-path (reader method).
• output-directory (reader method).
• texinfo-directory (function).
• texinfo-version (reader method).

---

4.1.8 fr.epita.lrde.quickref.core/src/common/declt.lisp

Dependencies

• util.lisp (file).
• context.lisp (file).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Internals

• *declt-script-name* (special variable).
• declt-log-file (function).
• run-declt (function).

---

4.1.9 fr.epita.lrde.quickref.core/src/common/makeinfo.lisp

Dependencies

• util.lisp (file).
• context.lisp (file).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Internals

• makeinfo-log-file (function).
• run-makeinfo (function).
• texinfo-file (function).

---

4.1.10 fr.epita.lrde.quickref.core/src/common/readme.lisp

Dependency

util.lisp (file).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Internals

• <pre> (function).
• insert-readme-file (function).
• markdown-to-html (function).
• readme-file (function).
• readme-to-html (function).

---

4.1.11 fr.epita.lrde.quickref.core/src/common/build.lisp

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

common (module).

Internals

build-manuals (generic function).

---

4.1.12 fr.epita.lrde.quickref.core/src/sequential.lisp

Dependency

common (module).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

src (module).

Internals

• build-manual (function).
• build-manuals (method).
• with-progression (macro).

---

4.1.13 fr.epita.lrde.quickref.core/src/parallel.lisp

If Feature

(:and :sbcl :sb-thread :fr.epita.lrde.quickref.parallel)

Dependency

common (module).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

src (module).

Internals

• *library-queue* (special variable).
• *post-declt-queue* (special variable).
• *remaining-libraries-count* (special variable).
• *texinfo-queue* (special variable).
• build-html-manuals-//-1 (function).
• build-html-manuals-//-2 (function).
• build-manuals (method).
• build-manuals (method).
• build-manuals (method).
• build-manuals (method).
• build-texinfo-manuals-//-1 (function).
• build-texinfo-manuals-//-2 (function).
• build-texinfo-manuals-//-3 (function).
• build-texinfo-manuals-//-4 (function).
• context-// (class).
• cull-standalone-systems (function).
• declt-threads (reader method).
• dependency-graph-size (function).
• endpush (macro).
• format-// (macro).
• makeinfo-threads (reader method).
• primary-systems-batches (function).
• primary-systems-dependency-graph (function).
• remove-dependencies (function).
• remove-standalone-systems (function).

---

4.1.14 fr.epita.lrde.quickref.core/src/index.lisp

Dependency

common (module).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

src (module).

Internals

• *indexes* (special variable).
• author-index-character (function).
• author-index-entries (function).
• build-index-file (function).
• build-index-files (function).
• column-lengths (function).
• index-file-name (function).
• library-index-character (function).
• library-index-entries (function).
• render-author-index-entry (function).
• render-index-entry (function).
• render-index-header (function).
• render-library-index-entry (function).

---

4.1.15 fr.epita.lrde.quickref.core/src/cohort/stats.lisp

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

cohort (module).

Internals

• generate-cohort-statistics (function).
• generate-definition-statistics (function).
• generate-documentation-statistics (function).
• generate-symbol-statistics (function).
• name (function).
• symbol-definition-p (function).
• unique-p (function).
• unique-symbol-definition-p (function).

---

4.1.16 fr.epita.lrde.quickref.core/src/cohort/plots.lisp

Dependency

stats.lisp (file).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

cohort (module).

Internals

generate-cohort-plots (function).

---

4.1.17 fr.epita.lrde.quickref.core/src/cohort/cohort.lisp

Dependency

plots.lisp (file).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

cohort (module).

Internals

build-cohort (function).

---

4.1.18 fr.epita.lrde.quickref.core/src/quickref.lisp

Dependencies

• common (module).
• sequential.lisp (file).
• parallel.lisp (file)., for feature (:and :sbcl :sb-thread :fr.epita.lrde.quickref.parallel)
• index.lisp (file).
• cohort (module).

Source

fr.epita.lrde.quickref.core.asd.

Parent Component

src (module).

Public Interface

build (function).

Internals

• *foreign-system-names* (special variable).
• copy-style-sheets (function).
• renew-directories (function).

---

4.1.19 fr.epita.lrde.quickref.setup/setup.lisp

Source

fr.epita.lrde.quickref.setup.asd.

Parent Component

fr.epita.lrde.quickref.setup (system).

Packages

fr.epita.lrde.quickref.setup.

Public Interface

• *release-major-level* (special variable).
• *release-minor-level* (special variable).
• *release-name* (special variable).
• *release-status* (special variable).
• *release-status-level* (special variable).
• configuration (function).
• configure (function).
• setup-parallel (function).
• version (function).

Internals

• %version (function).
• *configuration* (special variable).
• release-status-number (function).
• restrict-because (function).

---

4.1.20 fr.epita.lrde.quickref.cmark/cmark.lisp

Source

fr.epita.lrde.quickref.cmark.asd.

Parent Component

fr.epita.lrde.quickref.cmark (system).

Packages

fr.epita.lrde.quickref.cmark.

Public Interface

cmark-markdown-to-html (function).

---

4.2.1 fr.epita.lrde.quickref/bin/declt

Source

fr.epita.lrde.quickref.asd.

Parent Component

bin (module).

---

4.2.2 fr.epita.lrde.quickref/share/css/document.css

Source

fr.epita.lrde.quickref.asd.

Parent Component

css (module).

---

4.2.3 fr.epita.lrde.quickref/share/css/index.css

Source

fr.epita.lrde.quickref.asd.

Parent Component

css (module).

---

4.2.4 fr.epita.lrde.quickref/share/templates/index-header.html

Source

fr.epita.lrde.quickref.asd.

Parent Component

templates (module).

---

4.2.5 fr.epita.lrde.quickref/share/templates/cohort.html

Source

fr.epita.lrde.quickref.asd.

Parent Component

templates (module).

---

4.2.6 fr.epita.lrde.quickref/share/gp/symbol-lengths.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.7 fr.epita.lrde.quickref/share/gp/symbol-cardinalities.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.8 fr.epita.lrde.quickref/share/gp/symbol-sublengths.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.9 fr.epita.lrde.quickref/share/gp/docstring-lengths.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.10 fr.epita.lrde.quickref/share/gp/docstring-percentages.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.11 fr.epita.lrde.quickref/share/gp/definitions.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

4.2.12 fr.epita.lrde.quickref/share/gp/classoids.gp

Source

fr.epita.lrde.quickref.asd.

Parent Component

gp (module).

---

6.1.1 Special variables

Special Variable: *release-major-level* ¶

The major level of this release.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Special Variable: *release-minor-level* ¶

The minor level of this release.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Special Variable: *release-name* ¶

The name of this release.
The general naming theme for Quickref is "Songs from Iron Maiden".

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Special Variable: *release-status* ¶

The status of this release.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Special Variable: *release-status-level* ¶

The status level of this release.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

---

6.1.2 Ordinary functions

Function: build (&key cohort update libraries output-directory makeinfo-path cross-reference-validation error-behavior cache-policy empty-cache parallel declt-threads makeinfo-threads) ¶

Build the Quickref website.
The following keyword arguments are available.
- COHORT: whether to create a cohort (NIL by default).
- UPDATE: whether to update Quicklisp before processing. Defaults to T.
- LIBRARIES: Quicklisp libraries to process.
Possible values are :all (the default) and :installed. When :all, process (and hence download) all Quicklisp libraries. Otherwise, only process the libraries that are already installed.
- OUTPUT-DIRECTORY: Quickref’s output directory. Defaults to ~/quickref/. - MAKEINFO-PATH: path to the ’makeinfo’ executable. Defaults to "makeinfo". - CROSS-REFERENCE-VALIDATION: whether to validate cross references. Validation helps catch Declt bugs, but also prevents otherwise usable manuals from being generated. Defaults to T.
- ERROR-BEHAVIOR: behavior to adopt when errors are encountered.
Possible values are :log (the default) and :abort. When :log, just log the errors and continue processing. Otherwise, stop at the first error. Note also that when errors are logged (which is meant to be the non-interactive way of running Quickref), normal output from Declt and Makeinfo is discarded completely.
- CACHE-POLICY: compilation cache handling policy.
Possible values are :global (the default) and :local.
When :global, the usual ASDF cache is used, meaning that compilation caches are shared across Declt calls. Otherwise, every call to Declt uses a different compilation cache. Note that the caching policy will automatically be set to :local if a version 2 parallel build is requested, as this particular algorithm is incompatible with the global ASDF cache.
- EMPTY-CACHE: whether to empty the compilation cache before proceeding. This parameter is only considered for a local cache policy. The global ASDF cache is never emptied. Defaults to T.
- PARALLEL: whether to parallelize the build process.
Possible values are NIL (the default), 1, 2, 3, and 4 (or T). Numerical values correspond to different parallel build algorithms (see the file parallel.lisp for details). The most general one is #4, which is also selected by T.
- DECLT-THREADS: number of threads to use for Declt (Texinfo generation) when using a parallel build algorithm. Defaults to 2.
- MAKEINFO-THREADS: number of threads to use for Makeinfo (HTML generation) when using a parallel build algorithm. Defaults to 2.

Package

fr.epita.lrde.quickref.

Source

quickref.lisp.

Function: cmark-markdown-to-html (md size options) ¶

Package

fr.epita.lrde.quickref.cmark.

Source

cmark.lisp.

Function: configuration (key) ¶

Return KEY’s value in the current Quickref configuration.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: configure (key value) ¶

Set KEY to VALUE in the current Quickref configuration.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: nickname-package (&optional nickname) ¶

Add NICKNAME (:QUICKREF by default) to the :FR.EPITA.LRDE.QUICKREF package.

Package

fr.epita.lrde.quickref.

Source

package.lisp.

Function: setup-parallel () ¶

Autodetect parallel support.
Update Quickref configuration and *FEATURES* accordingly.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: version (&optional type) ¶

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

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

---

6.1.3 Standalone methods

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

Initialize CONTEXT’s Texinfo version.

Source

context.lisp.

---

6.2.1 Special variables

Special Variable: *bin-directory* ¶

Quickref’s bin directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Special Variable: *configuration* ¶

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

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

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Special Variable: *css-directory* ¶

Quickref’s CSS directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Special Variable: *declt-script-name* ¶

Quickref’s Declt script.

Package

fr.epita.lrde.quickref.

Source

declt.lisp.

Special Variable: *foreign-system-names* ¶

Non-Quicklisp systems that need to be documented.

Package

fr.epita.lrde.quickref.

Source

quickref.lisp.

Special Variable: *gp-directory* ¶

Quickref’s Gnuplot directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Special Variable: *indexes* ¶

The list of HTML indexes.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Special Variable: *library-queue* ¶

The list of libraries ready to be processed.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Special Variable: *post-declt-queue* ¶

The list of libraries that passed the Declt stage.
These are the same ones that are fed to the Texinfo queue, but this queue is used to dynamically update the dependency graph by looking for potentially new leaves and adding them to the library queue.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Special Variable: *remaining-libraries-count* ¶

The number of libraries still in processing by a Texinfo thread.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Special Variable: *share-directory* ¶

Quickref’s share directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Special Variable: *templates-directory* ¶

Quickref’s templates directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Special Variable: *texinfo-queue* ¶

The list of libraries for which Texinfo files are ready to be processed.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Special Variable: *top-directory* ¶

Quickref’s top directory.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

---

6.2.2 Macros

Macro: endpush (object place) ¶

Like PUSH, but at the end.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Macro: format-// (stream &rest args) ¶

Like FORMAT, but block until all output is flushed.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Macro: while (test &rest body) ¶

The WHILE loop.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Macro: with-progression ((context message &rest arguments) &body body) ¶

Execute BODY with a progression indicator in CONTEXT. Return BODY’s value. MESSAGE and ARGUMENTS are passed to FORMAT to print the progression. If CONTEXT logs errors, the indicator is then followed by an elision, eventually terminated by either ok or ko upon completion.

Package

fr.epita.lrde.quickref.

Source

sequential.lisp.

---

6.2.3 Ordinary functions

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

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: <pre> (string) ¶

Return STRING as HTML <pre>.

Package

fr.epita.lrde.quickref.

Source

readme.lisp.

Function: author-index-character (entries) ¶

Return the next author index character for ENTRIES.
ENTRIES should be a list of lists of the form (AUTHOR-NAME SYSTEM-NAME...). The next index character is the first (upcased) letter of the first author name if it’s alphabetic, or # otherwise.
This function is used as the INDEX-CHARACTER-GETTER argument to BUILD-INDEX-FILE.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: author-index-entries (db) ¶

Return a sorted list of library authors from DB.
DB is a list of elements of the form (SYSTEM-NAME ... :CONTACTS C ...), where C is a Declt report contacts list (which see).

Each element in the returned list of the form (AUTHOR-NAME SYSTEM-NAME...). The list is sorted by lexicographic order of AUTHOR-NAMES, and for each author, SYSTEM-NAMEs are sorted by lexicographic order of trimmed names.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: build-cohort (context) ¶

Build the Quickref cohort in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

cohort.lisp.

Function: build-html-manuals-//-1 (context total texinfo-queue new-texinfo) ¶

Build *TEXINFO-QUEUE* HTML manuals in CONTEXT, parallel version #1. Return the number of HTML files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: build-html-manuals-//-2 (context thread-number texinfo-queue new-texinfo) ¶

Build *TEXINFO-QUEUE* HTML manuals in CONTEXT, parallel version #2. Return the number of HTML files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: build-index-file (kind time db context) ¶

Build Quickref’s KIND index file for DB generated on TIME in CONTEXT. The index file is called "index-per-KIND.html".

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: build-index-files (context) ¶

Build CONTEXT’s index files.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: build-manual (library context) ¶

Build LIBRARY’s reference manual in CONTEXT.
Return :html, :texi or NIL, indicating how far the process went.

Package

fr.epita.lrde.quickref.

Source

sequential.lisp.

Function: build-texinfo-manuals-//-1 (libraries context texinfo-queue new-texinfo) ¶

Build LIBRARIES Texinfo manuals in CONTEXT, parallel version #1. Return the number of Texinfo files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: build-texinfo-manuals-//-2 (context thread-number library-queue texinfo-queue new-texinfo) ¶

Build *LIBRARY-QUEUE* Texinfo manuals in CONTEXT, parallel version #2. Return the number of Texinfo files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: build-texinfo-manuals-//-3 (context thread-number library-queue new-batch empty-batch texinfo-queue new-texinfo) ¶

Build *LIBRARY-QUEUE* Texinfo manuals in CONTEXT, parallel version #3. Return the number of Texinfo files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: build-texinfo-manuals-//-4 (context thread-number library-queue new-batch post-declt-queue collect-new-leaves texinfo-queue new-texinfo) ¶

Build *LIBRARY-QUEUE* Texinfo manuals in CONTEXT, parallel version #4. Return the number of Texinfo files successfully built.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: cache-directory (context) ¶

Return CONTEXT’s compilation cache root directory.
This is the location used when the cache policy is local. ASDF and Declt get their own subdirectory, every documented system also has its own one, leading to duplicate compilation of every shared dependency.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: cohort-db-directory (context) ¶

Return CONTEXT’s cohort database files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: cohort-directory (context) ¶

Return CONTEXT’s cohort files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: cohort-stats-directory (context) ¶

Return CONTEXT’s cohort statistics files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: column-lengths (number) ¶

Spread NUMBER of entries in 3 different columns as uniformly as possible. Return the column lengths as 3 values.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: copy-style-sheets (context) ¶

Copy Quickref’s style sheets to the HTML output directory in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

quickref.lisp.

Function: cull-standalone-systems (graph) ¶

Cull standalone systems from dependency GRAPH. Return them.
Standalone systems are systems with no depdendencies.
This function removes standalone systems from depdendency GRAPH and updates all remaining systems’ dependencies accordingly.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: db-directory (context) ¶

Return CONTEXT’s database files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: declt-log-file (system-name context) ¶

Return pathname for ASDF SYSTEM-NAME’s Declt log file in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

declt.lisp.

Function: declt-logs-directory (context) ¶

Return CONTEXT’s Declt logs directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: dependency-graph-size (graph) ¶

Return the number of systems in dependency GRAPH.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: file-contents (file) ¶

Attempt to safely read FILE into a string and return it. Safely means try to detect a proper encoding.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Function: generate-cohort-plots (context) ¶

Generate the Quickref cohort plots in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

plots.lisp.

Function: generate-cohort-statistics (context db) ¶

Generate Quickref cohort statistics in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: generate-definition-statistics (db directory) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: generate-documentation-statistics (db directory) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: generate-symbol-statistics (db directory) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: html-cohort-directory (context) ¶

Return CONTEXT’s generated HTML cohort files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: html-directory (context) ¶

Return CONTEXT’s generated HTML files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: html-file (name context) ¶

Return pathname for NAME.html file in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: index-file-name (kind) ¶

Return "index-per-KIND".

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: insert-readme-file (html-file readme-file) ¶

Insert the contents of README-FILE into HTML-FILE.
README-FILE contents is rendered in HTML and inserted as introduction.

Package

fr.epita.lrde.quickref.

Source

readme.lisp.

Function: library-index-character (entries) ¶

Return the next library index character for ENTRIES.
ENTRIES should be a list of system names.
The next index character is the first (upcased) letter of the first system name in ENTRIES trimmed if it’s alphabetic, or # otherwise.
This function is used as the INDEX-CHARACTER-GETTER argument to BUILD-INDEX-FILE.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: library-index-entries (db) ¶

Return a sorted list of library names from DB.
DB is a list of elements of the form (SYSTEM-NAME ...). Sorting is done on trimmed names.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: logs-directory (context) ¶

Return CONTEXT’s logs directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: make-context (cohort output-directory makeinfo-path cross-reference-validation error-behavior cache-policy empty-cache) ¶

Create and return a new context.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: makeinfo-log-file (system-name context) ¶

Return pathname for ASDF SYSTEM-NAME’s Makeinfo log file in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

makeinfo.lisp.

Function: makeinfo-logs-directory (context) ¶

Return CONTEXT’s Makeinfo logs directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: markdown-to-html (string) ¶

Return Markdown STRING formatted as HTML.
Try our CommonMark FFI first, fall back to 3BMD otherwise.

Package

fr.epita.lrde.quickref.

Source

readme.lisp.

Function: name (item) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: primary-system (release) ¶

Return RELEASE’s primary system.
The primary system is determined heuristically as follows:
- it’s the only system,
- it has the same name as the release,
- it has the same name as the release, with "cl-" prefixed removed, - it has the shortest name.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Function: primary-systems-batches (releases) ¶

Return a list of primary systems batches (also lists) from RELEASES. The list is ordered by dependencies: each batch contains only systems depending on those from the previous ones (thus, the first batfch contains systems having no dependency).

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: primary-systems-dependency-graph (releases) ¶

Return RELEASES’ primary systems dependency graph.
This is a hash table mapping system names to their list of dependencies (also system names). Only internal dependencies (that is, across RELEASES’s primary systems) are preserved.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: quicklisp-distribution () ¶

Return a Quicklisp distribution object for the "quicklisp" distribution.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Function: readme-file (system-name) ¶

Return the pathname of a README(.*) file for ASDF SYSTEM-NAME, if any. Try the system’s directory first. If that fails and the system is part of a Quicklisp RELEASE, also try the release’s directory (which may be different).

Package

fr.epita.lrde.quickref.

Source

readme.lisp.

Function: readme-to-html (readme-file) ¶

Return contents of README-FILE formatted as HTML.

Package

fr.epita.lrde.quickref.

Source

readme.lisp.

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

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: remove-dependencies (graph dependencies) ¶

Remove DEPENDENCIES from all GRAPH’s dependency lists. Return DEPENDENCIES.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: remove-standalone-systems (graph) ¶

Remove standalone systems (systems with no dependencies) from GRAPH. Return the list of removed systems names.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Function: render-author-index-entry (entry) ¶

Render an author index ENTRY.
ENTRY should be a list of the form (AUTHOR-NAME SYSTEM-NAME...). Rendering is done on *STANDARD-OUTPUT*.
This function is used as the RENDERER argument to RENDER-INDEX-ENTRY.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: render-index-entry (character entries number renderer) ¶

Render index file’s first NUMBER ENTRIES under CHARACTER.
This function arranges ENTRIES to be rendered in 3 columns, vertically from left to right, but taking care of vertical justification as much as possible: the heights of the 3 columns may only differ by one, meaning that only the last row may have less than 3 entries.

RENDERER is the function used to render the entries.
Rendering is done on *STANDARD-OUTPUT*.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: render-index-header (cohort manuals-number time texinfo-version index-name) ¶

Render index file’s header to standard output.
The header also advertise MANUALS-NUMBER and INDEX-NAME.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: render-library-index-entry (entry) ¶

Render a library index ENTRY.
ENTRY should be a manual name. Rendering is done on *STANDARD-OUTPUT*. This function is used as the RENDERER argument to RENDER-INDEX-ENTRY.

Package

fr.epita.lrde.quickref.

Source

index.lisp.

Function: renew-directories (&rest directories) ¶

Ensure DIRECTORIES exist and empty them.

Package

fr.epita.lrde.quickref.

Source

quickref.lisp.

Function: restrict-because (reason) ¶

Put Quickref in restricted mode because of REASON.

Package

fr.epita.lrde.quickref.setup.

Source

setup.lisp.

Function: run-declt (system-name context) ¶

Run Declt on ASDF SYSTEM-NAME in CONTEXT. Return T on success.

Package

fr.epita.lrde.quickref.

Source

declt.lisp.

Function: run-makeinfo (system-name context) ¶

Run Makeinfo on ASDF SYSTEM-NAME in CONTEXT. Return T on success.

Package

fr.epita.lrde.quickref.

Source

makeinfo.lisp.

Function: symbol-definition-p (item) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: texinfo-directory (context) ¶

Return CONTEXT’s Texinfo files directory.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Function: texinfo-file (system-name context) ¶

Return pathname for ASDF SYSTEM-NAME’s Texinfo file in CONTEXT.

Package

fr.epita.lrde.quickref.

Source

makeinfo.lisp.

Function: unique-p (item) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

Function: unique-symbol-definition-p (item) ¶

Package

fr.epita.lrde.quickref.

Source

stats.lisp.

---

6.2.4 Generic functions

Generic Function: build-manuals (libraries context parallel) ¶

Build LIBRARIES reference manuals in CONTEXT, possibly in PARALLEL.

Package

fr.epita.lrde.quickref.

Source

build.lisp.

Methods

Method: build-manuals (libraries context (parallel (eql 4))) ¶

Parallel version #4.

Source

parallel.lisp.

Method: build-manuals (libraries context (parallel (eql 3))) ¶

Parallel version #3.

Source

parallel.lisp.

Method: build-manuals (libraries context (parallel (eql 2))) ¶

Parallel version #2.

Source

parallel.lisp.

Method: build-manuals (libraries context (parallel (eql 1))) ¶

Parallel version #1.

Source

parallel.lisp.

Method: build-manuals (libraries context (parallel (eql nil))) ¶

Sequential version.

Source

sequential.lisp.

Generic Reader: cache-policy (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: cache-policy ((context context)) ¶

Compilation cache handling policy.
If :global, the usual ASDF cache is used, meaning that compilation caches are shared across Declt calls. Otherwise, every Declt call uses a different compilation cache.

Source

context.lisp.

Target Slot

cache-policy.

Generic Reader: cohort (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: cohort ((context context)) ¶

Whether to create a cohort.

Source

context.lisp.

Target Slot

cohort.

Generic Reader: cross-reference-validation (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: cross-reference-validation ((context context)) ¶

Whether to validate cross references.

Source

context.lisp.

Target Slot

cross-reference-validation.

Generic Reader: declt-threads (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: declt-threads ((context-// context-//)) ¶

The number of Declt threads.

Source

parallel.lisp.

Target Slot

declt-threads.

Generic Reader: empty-cache (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: empty-cache ((context context)) ¶

Whether to empty the compilation cache before proceeding.
This parameter is only considered for a local cache policy. The global ASDF cache is never emptied.

Source

context.lisp.

Target Slot

empty-cache.

Generic Reader: error-behavior (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: error-behavior ((context context)) ¶

Behavior to adopt when errors are encountered.
If :log, just log the errors and continue processing. Otherwise, stop at the first error. Note also that when errors are logged (which is meant to be the non-interactive way of running Quickref), normal output from Declt and Makeinfo is discarded completely.

Source

context.lisp.

Target Slot

error-behavior.

Generic Function: library-name (library) ¶

Return LIBRARY’s name.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Methods

Method: library-name ((system-name string)) ¶

Return ASDF SYSTEM-NAME.

Method: library-name ((system system)) ¶

Return Quicklisp SYSTEM’s name.

Method: library-name ((release release)) ¶

Return Quicklisp RELEASE’s primary system’s name.

Generic Reader: makeinfo-path (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: makeinfo-path ((context context)) ¶

Path to the ’makeinfo’ executable.

Source

context.lisp.

Target Slot

makeinfo-path.

Generic Reader: makeinfo-threads (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: makeinfo-threads ((context-// context-//)) ¶

The number of Makeinfo threads.

Source

parallel.lisp.

Target Slot

makeinfo-threads.

Generic Reader: output-directory (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: output-directory ((context context)) ¶

Quickref’s output directory.

Source

context.lisp.

Target Slot

output-directory.

Generic Reader: texinfo-version (object) ¶

Package

fr.epita.lrde.quickref.

Methods

Reader Method: texinfo-version ((context context)) ¶

Texinfo version.

Source

context.lisp.

Target Slot

texinfo-version.

Generic Function: trim (object) ¶

Remove potential CL- prefix from OBJECT’s name.

Package

fr.epita.lrde.quickref.

Source

util.lisp.

Methods

Method: trim ((string string)) ¶

Remove potential CL- prefix from STRING.

Method: trim ((system system)) ¶

Remove potential CL- prefix from SYSTEM’s name.

Method: trim ((release release)) ¶

Remove potential CL- prefix from RELEASE’s name.

---

6.2.5 Classes

Class: context ¶

The Context class.

Package

fr.epita.lrde.quickref.

Source

context.lisp.

Direct subclasses

context-//.

Direct methods

• cache-policy.
• cohort.
• cross-reference-validation.
• empty-cache.
• error-behavior.
• initialize-instance.
• makeinfo-path.
• output-directory.
• texinfo-version.

Direct slots

Slot: cohort ¶

Whether to create a cohort.

Initargs

:cohort

Readers

cohort.

Writers

This slot is read-only.

Slot: output-directory ¶

Quickref’s output directory.

Initargs

:output-directory

Readers

output-directory.

Writers

This slot is read-only.

Slot: makeinfo-path ¶

Path to the ’makeinfo’ executable.

Initargs

:makeinfo-path

Readers

makeinfo-path.

Writers

This slot is read-only.

Slot: texinfo-version ¶

Texinfo version.

Readers

texinfo-version.

Writers

This slot is read-only.

Slot: cross-reference-validation ¶

Whether to validate cross references.

Initargs

:cross-reference-validation

Readers

cross-reference-validation.

Writers

This slot is read-only.

Slot: error-behavior ¶

Behavior to adopt when errors are encountered.
If :log, just log the errors and continue processing. Otherwise, stop at the first error. Note also that when errors are logged (which is meant to be the non-interactive way of running Quickref), normal output from Declt and Makeinfo is discarded completely.

Initargs

:error-behavior

Readers

error-behavior.

Writers

This slot is read-only.

Slot: cache-policy ¶

Compilation cache handling policy.
If :global, the usual ASDF cache is used, meaning that compilation caches are shared across Declt calls. Otherwise, every Declt call uses a different compilation cache.

Initargs

:cache-policy

Readers

cache-policy.

Writers

This slot is read-only.

Slot: empty-cache ¶

Whether to empty the compilation cache before proceeding.
This parameter is only considered for a local cache policy. The global ASDF cache is never emptied.

Initargs

:empty-cache

Readers

empty-cache.

Writers

This slot is read-only.

Class: context-// ¶

The context-// class.

Package

fr.epita.lrde.quickref.

Source

parallel.lisp.

Direct superclasses

context.

Direct methods

• declt-threads.
• makeinfo-threads.

Direct slots

Slot: declt-threads ¶

The number of Declt threads.

Initargs

:declt-threads

Readers

declt-threads.

Writers

This slot is read-only.

Slot: makeinfo-threads ¶

The number of Makeinfo threads.

Initargs

:makeinfo-threads

Readers

makeinfo-threads.

Writers

This slot is read-only.

---