The clweb Reference Manual

Table of Contents

The clweb Reference Manual

This is the clweb Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:40:29 2021 GMT+0.

1 Introduction

This is CLWEB, a literate programming system for Common Lisp. This file
describes how to get started with CLWEB; it is not a user manual or an
introduction to literate programming in general. A full user manual is
forthcoming; in the meantime, please see the CWEB user manual by Knuth
and Levy, or Knuth's "Literate Programming" (CSLI: 1992).

In the examples that follow, a dollar sign ($) represents a Unix shell
prompt, and a star (*) represents a Lisp prompt.

The first thing to do is to compile and load the CLWEB system:

    $ lisp
    * (compile-file "clweb")
    ; compiling file "/home/alex/src/clweb/clweb.lisp"
    ; [compilation messages elided]
    #P"/home/alex/src/clweb/clweb.fasl"
    NIL
    NIL
    * (load "clweb")
    T
    * (use-package "CLWEB")
    T

Now suppose you wanted to weave the CLWEB program itself. You might say:

    * (weave "clweb")
    ; weaving WEB from #P"clweb.clw"
    ; 0
    ; *1 2 3
    ; *4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
    ; *23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
    ;  42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
    ;  61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    ;  80 81 82 83 84 85 86 87 88
    ; *89 90 91 92 93 94
    ; *95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
    ;  110 111 112 113 114 115 116 117 118 119 120 121 122 123
    ;  124 125 
    #P"/home/alex/src/clweb/clweb.tex"
    * ^Z
    $ tex clweb
    This is TeX, Version 3.141592 (Web2C 7.5.4)
    (./clweb.tex (./clwebmac.tex
    (/usr/pkg/share/texmf-dist/tex/plain/base/cwebmac.tex)) *1 [1] *4 [2] [3]
    [4] [5] [6] [7] *23 [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]
    [19] [20] [21] [22] [23] [24] [25] [26] [27] [28] [29] *89 [30] [31] [32]
    *95 [33] [34] [35] [36] [37] [38] [39] [40] [41] [42] )
    Output written on clweb.dvi (42 pages, 137808 bytes).
    Transcript written on clweb.log.
    $

The numbers that WEAVE prints are the section numbers the weaver sees; the
ones preceded by stars are the `starred', or major, sections. TeX also
prints the starred section numbers along with the page numbers in square
brackets.

To use CLWEB for your own projects, you need to have the file `clwebmac.tex'
somewhere in TeX's search path. One way to do this (on the author's system,
anyway) is to install a copy of or a symlink to the version included in the
distribution in a directory like `~/texmf/tex/plain'; see the documentation
for your TeX distribution for more information, esp. the Kpathsea library.

The CLWEB tangler can be used in two different ways: to produce a compiled
file that can be used with LOAD, or to load the contents of a CLWEB file
directly into a running Lisp image. In the first case, you would use
TANGLE-FILE:

    * (compile-file "clweb")
    ; tangling WEB from #P"clweb.clw"
    ; compiling file "/home/alex/src/clweb/clweb.lisp":
    ; [compilation messages elided]
    #P"/home/alex/src/clweb/clweb.fasl"
    NIL
    NIL
    *

You should now have a fresh copy of `clweb.lisp' and `clweb.fasl'. You
shouldn't ever edit the former directly; it's only an intermediate file.

During development, the other mode of tangling is often more useful:

    * (load-web "clweb")
    T
    * 

The tangled contents of `clweb.clw' have now been loaded directly into the
Lisp environment.

Currently, CLWEB runs under SBCL, Allegro Common Lisp, and Clozure Common
Lisp. Reports of the experience of attempting to run the system under other
Common Lisp implementations would be welcome, along with any other
questions, bug-reports, patches, comments, or suggestions; please email
them to Alex Plotnick .

The author gratefully acknowledges the encouragement and support of Ross
Shaull, who made him believe that at least one other person in the world
thought this might be a good idea, and of Richard Kreuter, for his many
suggestions for improving both the commentary and code of the system, as
well as for his work on SBCL.

2 Systems

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

2.1 clweb

Author

Alex Plotnick

License

MIT

Description

A literate programming system for Common Lisp

Version

1.0

Dependencies

• asdf (at least version 3.1.2)
• sb-cltl2 (for feature sbcl)

Source

clweb.asd (file)

Components

• license (file)
• readme (file)
• clweb.lisp (file)
• asdf-operations.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 clweb.asd

Location

clweb.asd

Systems

clweb (system)

3.1.2 clweb/clweb.lisp

Parent

clweb (system)

Location

clweb.lisp

Packages

clweb

Exported Definitions

• *compile-tests-file* (special variable)
• *index-lexical-variables* (special variable)
• *index-pathname-defaults* (special variable)
• *lisp-pathname-defaults* (special variable)
• *sections-pathname-defaults* (special variable)
• *tangle-file-pathname* (special variable)
• *tangle-file-truename* (special variable)
• *tests-file-pathname-function* (special variable)
• *tex-pathname-defaults* (special variable)
• *weave-print* (special variable)
• *weave-verbose* (special variable)
• *web-pathname-defaults* (special variable)
• ambiguous-prefix-error (condition)
• fasl-file-pathname (function)
• index-file-pathname (function)
• input-file-pathname (function)
• lisp-file-pathname (function)
• load-sections-from-temp-file (function)
• load-web (function)
• section-name-context-error (condition)
• section-name-definition-error (condition)
• section-name-use-error (condition)
• sections-file-pathname (function)
• tangle-file (function)
• tangle-file-pathnames (function)
• tests-file-pathname (function)
• tex-file-pathname (function)
• unused-named-section-warning (condition)
• weave (function)
• weave-pathnames (function)

Internal Definitions

• *backquote* (special variable)
• *charpos-streams* (special variable)
• *consing-dot* (special variable)
• *current-section* (special variable)
• *empty-list* (special variable)
• *end-control-text* (special variable)
• *eof* (special variable)
• *evaluating* (special variable)
• *index* (special variable)
• *index-packages* (special variable)
• *indexing* (special variable)
• *modes* (special variable)
• *named-sections* (special variable)
• *namespace-classes* (special variable)
• *physical-pathname-host* (special variable)
• *print-escape-list* (special variable)
• *print-symbol-suffixes* (special variable)
• *radix-prefix-alist* (special variable)
• *readtables* (special variable)
• *referring-classes* (special variable)
• *sections* (special variable)
• *tab-width* (special variable)
• *tangle-pprint-dispatch* (special variable)
• *test-sections* (special variable)
• *weave-pathname* (special variable)
• *weave-pprint-dispatch* (special variable)
• *weave-source-locations* (special variable)
• *whitespace* (special variable)
• add-index-entry (function)
• ambiguous-prefix (method)
• ambiguous-prefix-alt-match (method)
• ambiguous-prefix-first-match (method)
• analyze-indentation (function)
• array-marker (class)
• array-marker-initial-contents (method)
• array-marker-rank (method)
• array-reader (function)
• backquote (macro)
• backquote-form (type)
• backquotep (function)
• binary-search-tree (class)
• bit-vector-marker (class)
• block-name (class)
• bq-process (function)
• bracket (function)
• catch-tag (class)
• charpos (method)
• charpos (method)
• charpos-input-stream (class)
• charpos-output-stream (class)
• charpos-proxy-stream (method)
• (setf charpos-proxy-stream) (method)
• charpos-stream (class)
• cited-by (method)
• (setf cited-by) (method)
• class-name% (class)
• class-specializer (type)
• coalesce-locators (function)
• comma (class)
• comma-form (generic function)
• comma-form (method)
• comma-modifier (method)
• comma-modifier (method)
• commap (function)
• comment-marker (class)
• comment-reader (function)
• comment-text (method)
• compiler-macro-name (class)
• complex-components (method)
• complex-marker (class)
• complex-reader (function)
• compound-specializer (type)
• condition-class-name (class)
• consing-dot-marker (class)
• constant-name (class)
• construct-name (generic function)
• construct-name (method)
• construct-name (method)
• construct-name (method)
• construct-name (method)
• copy-source-location (function)
• copy-structure-description (function)
• create-source-location (function)
• custom-heading (class)
• define-special-form-walker (macro)
• defnamespace (macro)
• destructure-name (generic function)
• destructure-name (method)
• destructure-name (method)
• destructure-name (method)
• destructure-name (method)
• dispatch-macro-char-heading (class)
• dont-index (macro)
• empty-list-marker (class)
• enclose (function)
• end-section (method)
• ensure-list (function)
• ensure-portable-walking-environment (function)
• entry-heading (method)
• (setf entry-heading) (method)
• entry-heading-equalp (generic function)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-lessp (generic function)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-locators (method)
• (setf entry-locators) (method)
• eof (symbol macro)
• eof (type)
• eof-p (function)
• evaluated-form-marker (class)
• featurep (function)
• find-index-entries (function)
• find-namespace-class (function)
• (setf find-namespace-class) (function)
• find-or-insert (generic function)
• find-or-insert (method)
• find-or-insert (method)
• find-or-insert (method)
• find-section (function)
• function-marker (class)
• function-name (class)
• generic-function-name (class)
• generic-function-p (function)
• generic-setf-function-name (class)
• get-charpos-stream-buffer (generic function)
• get-charpos-stream-buffer (method)
• get-charpos-stream-buffer (method)
• get-control-code (function)
• heading (class)
• heading-name (generic function)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• indentation (method)
• (setf indentation) (method)
• index (generic function)
• index (method)
• index (method)
• index (method)
• index (method)
• index (method)
• index (method)
• index (class)
• index-entries (method)
• (setf index-entries) (method)
• index-entry (class)
• index-entry-reader (function)
• index-package (function)
• index-package-reader (function)
• index-sections (function)
• indexing-walker (class)
• interesting-symbol-p (generic function)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• join-strings (function)
• lambda-expression (type)
• left-child (method)
• (setf left-child) (method)
• lexical-variable-name (class)
• limbo-section (class)
• lineno (method)
• lineno (method)
• lineno (method)
• list-marker (class)
• list-marker-charpos (method)
• (setf list-marker-charpos) (method)
• list-marker-length (method)
• (setf list-marker-length) (method)
• list-marker-list (method)
• (setf list-marker-list) (method)
• list-marker-p (function)
• list-reader (function)
• load-web-from-stream (function)
• local-binding-p (method)
• location (method)
• (setf location) (method)
• location (method)
• (setf location) (method)
• locator (class)
• locator-definition-p (method)
• (setf locator-definition-p) (method)
• logical-block (class)
• logical-block-list (method)
• macro-char (method)
• macro-char-heading (class)
• macro-definition (class)
• macro-heading (method)
• macro-name (class)
• macro-sub-char (method)
• macroexpand-for-walk (generic function)
• macroexpand-for-walk (method)
• macroexpand-for-walk (method)
• make-charpos-input-stream (function)
• make-charpos-output-stream (function)
• make-comma (function)
• make-context (function)
• make-default-pathname (function)
• make-definition-location-table (function)
• make-heading (function)
• make-index (function)
• make-list-reader (function)
• make-locator (function)
• make-logical-block (function)
• make-macro-char-heading (function)
• make-section-name-index-entry (function)
• make-section-name-reader (function)
• make-structure-description (function)
• map-bst (generic function)
• map-bst (method)
• map-bst (method)
• mapappend (function)
• maptree (function)
• marker (class)
• marker-boundp (generic function)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• markerp (function)
• maybe-push (macro)
• method-combination-name (class)
• method-name (class)
• method-qualifier-names (method)
• mode (type)
• named-lambda-expression (type)
• named-section (method)
• (setf named-section) (method)
• named-section (class)
• named-section-sections (method)
• named-section-sections (method)
• (setf named-section-sections) (method)
• namespace (class)
• namespace-name (method)
• newline-marker (class)
• newlinep (function)
• node-key (method)
• (setf node-key) (method)
• note-generic-function (function)
• operator (class)
• orf (macro)
• output-file-pathname (function)
• par-marker (class)
• parse-body (function)
• pathname-marker (class)
• pathname-marker-namestring (method)
• pathname-reader (function)
• pop-qualifiers (macro)
• pretty-heading (class)
• print-char (function)
• print-entry-heading (generic function)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-escaped (function)
• print-limbo (function)
• print-list (function)
• print-logical-block (function)
• print-section (function)
• print-section-name (function)
• print-source-location (function)
• print-string (function)
• print-symbol (function)
• print-tex (function)
• print-xrefs (function)
• push-section (generic function)
• push-section (method)
• push-section (method)
• push-section (method)
• quote-marker (class)
• quote-marker-quote (method)
• quoted-form (method)
• quoted-symbol (type)
• radix-marker (class)
• radix-marker-base (method)
• radix-reader (function)
• read-control-text (function)
• read-evaluated-form (function)
• read-inner-lisp (function)
• read-maybe-nothing (function)
• read-maybe-nothing-internal (function)
• read-maybe-nothing-preserving-whitespace (function)
• read-sections (function)
• read-tex-from-string (function)
• read-time-conditional (class)
• read-time-conditional-form (method)
• read-time-conditional-marker (class)
• read-time-conditional-plusp (method)
• read-time-conditional-reader (function)
• read-time-conditional-test (method)
• read-time-eval (class)
• read-time-eval-form (method)
• read-time-eval-marker (class)
• read-with-echo (macro)
• readtable-for-mode (function)
• release-charpos-stream (function)
• reorder-env-information (macro)
• right-child (method)
• (setf right-child) (method)
• section (class)
• section-code (method)
• section-code (method)
• section-code (method)
• (setf section-code) (method)
• section-commentary (method)
• (setf section-commentary) (method)
• section-depth (method)
• section-depth (method)
• section-lacks-commentary (condition)
• section-lacks-commentary-stream (method)
• section-locator (class)
• section-name (method)
• section-name (method)
• section-name (method)
• section-name (method)
• (setf section-name) (method)
• (setf section-name) (method)
• section-name-equal (function)
• section-name-index-entry (class)
• section-name-lessp (function)
• section-name-prefix-p (function)
• section-number (method)
• section-number (method)
• (setf section-number) (method)
• section-range (class)
• section-source-location (method)
• see-also-locator (class)
• see-locator (class)
• set-control-code (function)
• set-tangle-dispatch (function)
• set-weave-dispatch (function)
• setf-function (type)
• setf-function-name (class)
• setf-method-name (class)
• sharpsign-dot-reader (function)
• sharpsign-quote-reader (function)
• simple-bit-vector-reader (function)
• simple-reader-error (function)
• simple-reader-error (condition)
• simple-vector-marker (class)
• simple-vector-marker-element-type (method)
• simple-vector-marker-elements (method)
• simple-vector-reader (function)
• single-quote-reader (function)
• slot-name (class)
• snarf-until-control-char (function)
• source-location (structure)
• source-location-file (function)
• (setf source-location-file) (function)
• source-location-for-reader (function)
• source-location-lineno (function)
• (setf source-location-lineno) (function)
• source-location-p (function)
• special-operator (class)
• special-variable-name (class)
• splicing-comma (class)
• squeeze (function)
• starred-section (class)
• starred-section-p (function)
• starred-test-section (class)
• start-code-marker (class)
• start-code-reader (function)
• start-section (method)
• start-section-reader (function)
• start-starred-section-reader (function)
• start-test-section-reader (function)
• stream-charpos (function)
• stream-lineno (function)
• struct-boa-constructor (class)
• struct-conc-name (function)
• (setf struct-conc-name) (function)
• struct-constructor-name (class)
• struct-constructors (function)
• (setf struct-constructors) (function)
• struct-copier-name (function)
• (setf struct-copier-name) (function)
• struct-copier-name (class)
• struct-include (function)
• (setf struct-include) (function)
• struct-name (function)
• struct-name (class)
• struct-predicate-name (function)
• (setf struct-predicate-name) (function)
• struct-predicate-name (class)
• struct-slot-accessor (class)
• struct-slot-reader (class)
• structure-description (structure)
• structure-description-p (function)
• structure-marker (class)
• structure-marker-form (method)
• structure-reader (function)
• sub-heading (method)
• sub-heading (method)
• sub-heading (method)
• substitute-referring-symbols (function)
• symbol-macro-definition (class)
• symbol-macro-name (class)
• symbol-provenance (function)
• symbol-replacement-reader (function)
• symbolicate (function)
• tag-name (class)
• tangle (function)
• tangle-1 (function)
• tangle-code-for-indexing (function)
• tangle-sections (function)
• test-for-section (method)
• (setf test-for-section) (method)
• test-section (class)
• test-section-p (function)
• token-delimiter-p (function)
• tt-heading (class)
• type-name (class)
• undefined-named-section-error (condition)
• unnamed-section-code-parts (function)
• unsubstitute-referring-symbols (function)
• update-charpos-stream-positions (function)
• update-context (generic function)
• update-context (method)
• update-context (method)
• update-context (method)
• update-context (method)
• used-by (method)
• (setf used-by) (method)
• variable-name (class)
• walk-as-special-form-p (generic function)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-atomic-form (generic function)
• walk-atomic-form (method)
• walk-atomic-form (method)
• walk-atomic-form (method)
• walk-binding (function)
• walk-bindings (generic function)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-compound-form (generic function)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-context (class)
• walk-declaration-specifier (generic function)
• walk-declaration-specifier (method)
• walk-declaration-specifiers (function)
• walk-defclass (function)
• walk-defstruct-name-and-options (function)
• walk-defstruct-option (function)
• walk-defstruct-slot-description (function)
• walk-defstruct-slot-name (function)
• walk-defun (function)
• walk-defvar (function)
• walk-form (generic function)
• walk-form (method)
• walk-lambda-expression (function)
• walk-lambda-list (function)
• walk-list (function)
• walk-method-definition (function)
• walk-name (generic function)
• walk-name (method)
• walk-name (method)
• walk-name (method)
• walk-name (method)
• walk-slot-specifier (function)
• walk-specialized-lambda-list (function)
• walk-the (function)
• walker (class)
• walker-index (method)
• (setf walker-index) (method)
• weave-object (function)
• weave-sections (function)
• weave-symbol-replace (function)
• whitespacep (function)
• with-charpos-input-stream (macro)
• with-charpos-output-stream (macro)
• with-mode (macro)
• with-rewind-stream (macro)
• with-unique-names (macro)
• wrap-reader-macro-function (function)
• xref-locator (class)

3.1.3 clweb/asdf-operations.lisp

Dependency

clweb.lisp (file)

Parent

clweb (system)

Location

asdf-operations.lisp

Packages

clweb/asdf

Exported Definitions

• clweb-file (class)
• weave-op (class)

3.2 Static

3.2.1 clweb/LICENSE

Parent

clweb (system)

Location

LICENSE

3.2.2 clweb/README

Parent

clweb (system)

Location

README

4 Packages

Packages are listed by definition order.

4.1 clweb

A literate programming system for Common Lisp.

Source

clweb.lisp (file)

Use List

common-lisp

Used By List

clweb/asdf

Exported Definitions

• *compile-tests-file* (special variable)
• *index-lexical-variables* (special variable)
• *index-pathname-defaults* (special variable)
• *lisp-pathname-defaults* (special variable)
• *sections-pathname-defaults* (special variable)
• *tangle-file-pathname* (special variable)
• *tangle-file-truename* (special variable)
• *tests-file-pathname-function* (special variable)
• *tex-pathname-defaults* (special variable)
• *weave-print* (special variable)
• *weave-verbose* (special variable)
• *web-pathname-defaults* (special variable)
• ambiguous-prefix-error (condition)
• clweb-file (class)
• fasl-file-pathname (function)
• index-file-pathname (function)
• input-file-pathname (function)
• lisp-file-pathname (function)
• load-sections-from-temp-file (function)
• load-web (function)
• section-name-context-error (condition)
• section-name-definition-error (condition)
• section-name-use-error (condition)
• sections-file-pathname (function)
• tangle-file (function)
• tangle-file-pathnames (function)
• tests-file-pathname (function)
• tex-file-pathname (function)
• unused-named-section-warning (condition)
• weave (function)
• weave-op (class)
• weave-pathnames (function)

Internal Definitions

• *backquote* (special variable)
• *charpos-streams* (special variable)
• *consing-dot* (special variable)
• *current-section* (special variable)
• *empty-list* (special variable)
• *end-control-text* (special variable)
• *eof* (special variable)
• *evaluating* (special variable)
• *index* (special variable)
• *index-packages* (special variable)
• *indexing* (special variable)
• *modes* (special variable)
• *named-sections* (special variable)
• *namespace-classes* (special variable)
• *physical-pathname-host* (special variable)
• *print-escape-list* (special variable)
• *print-symbol-suffixes* (special variable)
• *radix-prefix-alist* (special variable)
• *readtables* (special variable)
• *referring-classes* (special variable)
• *sections* (special variable)
• *tab-width* (special variable)
• *tangle-pprint-dispatch* (special variable)
• *test-sections* (special variable)
• *weave-pathname* (special variable)
• *weave-pprint-dispatch* (special variable)
• *weave-source-locations* (special variable)
• *whitespace* (special variable)
• add-index-entry (function)
• ambiguous-prefix (generic function)
• ambiguous-prefix (method)
• ambiguous-prefix-alt-match (generic function)
• ambiguous-prefix-alt-match (method)
• ambiguous-prefix-first-match (generic function)
• ambiguous-prefix-first-match (method)
• analyze-indentation (function)
• array-marker (class)
• array-marker-initial-contents (generic function)
• array-marker-initial-contents (method)
• array-marker-rank (generic function)
• array-marker-rank (method)
• array-reader (function)
• backquote (macro)
• backquote-form (type)
• backquotep (function)
• binary-search-tree (class)
• bit-vector-marker (class)
• block-name (class)
• bq-process (function)
• bracket (function)
• catch-tag (class)
• charpos (generic function)
• charpos (method)
• charpos (method)
• charpos-input-stream (class)
• charpos-output-stream (class)
• charpos-proxy-stream (generic function)
• charpos-proxy-stream (method)
• (setf charpos-proxy-stream) (method)
• (setf charpos-proxy-stream) (generic function)
• charpos-stream (class)
• cited-by (generic function)
• cited-by (method)
• (setf cited-by) (method)
• (setf cited-by) (generic function)
• class-name% (class)
• class-specializer (type)
• coalesce-locators (function)
• comma (class)
• comma-form (generic function)
• comma-form (method)
• comma-modifier (generic function)
• comma-modifier (method)
• comma-modifier (method)
• commap (function)
• comment-marker (class)
• comment-reader (function)
• comment-text (generic function)
• comment-text (method)
• compiler-macro-name (class)
• complex-components (generic function)
• complex-components (method)
• complex-marker (class)
• complex-reader (function)
• compound-specializer (type)
• condition-class-name (class)
• consing-dot-marker (class)
• constant-name (class)
• construct-name (generic function)
• construct-name (method)
• construct-name (method)
• construct-name (method)
• construct-name (method)
• copy-source-location (function)
• copy-structure-description (function)
• create-source-location (function)
• custom-heading (class)
• define-special-form-walker (macro)
• defnamespace (macro)
• destructure-name (generic function)
• destructure-name (method)
• destructure-name (method)
• destructure-name (method)
• destructure-name (method)
• dispatch-macro-char-heading (class)
• dont-index (macro)
• empty-list-marker (class)
• enclose (function)
• end-section (generic function)
• end-section (method)
• ensure-list (function)
• ensure-portable-walking-environment (function)
• entry-heading (generic function)
• entry-heading (method)
• (setf entry-heading) (method)
• (setf entry-heading) (generic function)
• entry-heading-equalp (generic function)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-equalp (method)
• entry-heading-lessp (generic function)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-heading-lessp (method)
• entry-locators (generic function)
• entry-locators (method)
• (setf entry-locators) (method)
• (setf entry-locators) (generic function)
• eof (symbol macro)
• eof (type)
• eof-p (function)
• evaluated-form-marker (class)
• featurep (function)
• find-index-entries (function)
• find-namespace-class (function)
• (setf find-namespace-class) (function)
• find-or-insert (generic function)
• find-or-insert (method)
• find-or-insert (method)
• find-or-insert (method)
• find-section (function)
• function-marker (class)
• function-name (class)
• generic-function-name (class)
• generic-function-p (function)
• generic-setf-function-name (class)
• get-charpos-stream-buffer (generic function)
• get-charpos-stream-buffer (method)
• get-charpos-stream-buffer (method)
• get-control-code (function)
• heading (class)
• heading-name (generic function)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• heading-name (method)
• indentation (generic function)
• indentation (method)
• (setf indentation) (method)
• (setf indentation) (generic function)
• index (generic function)
• index (method)
• index (method)
• index (method)
• index (method)
• index (method)
• index (method)
• index (class)
• index-entries (generic function)
• index-entries (method)
• (setf index-entries) (method)
• (setf index-entries) (generic function)
• index-entry (class)
• index-entry-reader (function)
• index-package (function)
• index-package-reader (function)
• index-sections (function)
• indexing-walker (class)
• interesting-symbol-p (generic function)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• interesting-symbol-p (method)
• join-strings (function)
• lambda-expression (type)
• left-child (generic function)
• left-child (method)
• (setf left-child) (method)
• (setf left-child) (generic function)
• lexical-variable-name (class)
• limbo-section (class)
• lineno (generic function)
• lineno (method)
• lineno (method)
• lineno (method)
• list-marker (class)
• list-marker-charpos (generic function)
• list-marker-charpos (method)
• (setf list-marker-charpos) (method)
• (setf list-marker-charpos) (generic function)
• list-marker-length (generic function)
• list-marker-length (method)
• (setf list-marker-length) (method)
• (setf list-marker-length) (generic function)
• list-marker-list (generic function)
• list-marker-list (method)
• (setf list-marker-list) (method)
• (setf list-marker-list) (generic function)
• list-marker-p (function)
• list-reader (function)
• load-web-from-stream (function)
• local-binding-p (generic function)
• local-binding-p (method)
• location (generic function)
• location (method)
• (setf location) (method)
• location (method)
• (setf location) (method)
• (setf location) (generic function)
• locator (class)
• locator-definition-p (generic function)
• locator-definition-p (method)
• (setf locator-definition-p) (method)
• (setf locator-definition-p) (generic function)
• logical-block (class)
• logical-block-list (generic function)
• logical-block-list (method)
• macro-char (generic function)
• macro-char (method)
• macro-char-heading (class)
• macro-definition (class)
• macro-heading (generic function)
• macro-heading (method)
• macro-name (class)
• macro-sub-char (generic function)
• macro-sub-char (method)
• macroexpand-for-walk (generic function)
• macroexpand-for-walk (method)
• macroexpand-for-walk (method)
• make-charpos-input-stream (function)
• make-charpos-output-stream (function)
• make-comma (function)
• make-context (function)
• make-default-pathname (function)
• make-definition-location-table (function)
• make-heading (function)
• make-index (function)
• make-list-reader (function)
• make-locator (function)
• make-logical-block (function)
• make-macro-char-heading (function)
• make-section-name-index-entry (function)
• make-section-name-reader (function)
• make-structure-description (function)
• map-bst (generic function)
• map-bst (method)
• map-bst (method)
• mapappend (function)
• maptree (function)
• marker (class)
• marker-boundp (generic function)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-boundp (method)
• marker-value (generic function)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• marker-value (method)
• markerp (function)
• maybe-push (macro)
• method-combination-name (class)
• method-name (class)
• method-qualifier-names (generic function)
• method-qualifier-names (method)
• mode (type)
• named-lambda-expression (type)
• named-section (generic function)
• named-section (method)
• (setf named-section) (method)
• (setf named-section) (generic function)
• named-section (class)
• named-section-sections (generic function)
• named-section-sections (method)
• named-section-sections (method)
• (setf named-section-sections) (method)
• (setf named-section-sections) (generic function)
• namespace (class)
• namespace-name (generic function)
• namespace-name (method)
• newline-marker (class)
• newlinep (function)
• node-key (generic function)
• node-key (method)
• (setf node-key) (method)
• (setf node-key) (generic function)
• note-generic-function (function)
• operator (class)
• orf (macro)
• output-file-pathname (function)
• par-marker (class)
• parse-body (function)
• pathname-marker (class)
• pathname-marker-namestring (generic function)
• pathname-marker-namestring (method)
• pathname-reader (function)
• pop-qualifiers (macro)
• pretty-heading (class)
• print-char (function)
• print-entry-heading (generic function)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-entry-heading (method)
• print-escaped (function)
• print-limbo (function)
• print-list (function)
• print-logical-block (function)
• print-section (function)
• print-section-name (function)
• print-source-location (function)
• print-string (function)
• print-symbol (function)
• print-tex (function)
• print-xrefs (function)
• push-section (generic function)
• push-section (method)
• push-section (method)
• push-section (method)
• quote-marker (class)
• quote-marker-quote (generic function)
• quote-marker-quote (method)
• quoted-form (generic function)
• quoted-form (method)
• quoted-symbol (type)
• radix-marker (class)
• radix-marker-base (generic function)
• radix-marker-base (method)
• radix-reader (function)
• read-control-text (function)
• read-evaluated-form (function)
• read-inner-lisp (function)
• read-maybe-nothing (function)
• read-maybe-nothing-internal (function)
• read-maybe-nothing-preserving-whitespace (function)
• read-sections (function)
• read-tex-from-string (function)
• read-time-conditional (class)
• read-time-conditional-form (generic function)
• read-time-conditional-form (method)
• read-time-conditional-marker (class)
• read-time-conditional-plusp (generic function)
• read-time-conditional-plusp (method)
• read-time-conditional-reader (function)
• read-time-conditional-test (generic function)
• read-time-conditional-test (method)
• read-time-eval (class)
• read-time-eval-form (generic function)
• read-time-eval-form (method)
• read-time-eval-marker (class)
• read-with-echo (macro)
• readtable-for-mode (function)
• release-charpos-stream (function)
• reorder-env-information (macro)
• right-child (generic function)
• right-child (method)
• (setf right-child) (method)
• (setf right-child) (generic function)
• section (class)
• section-code (generic function)
• section-code (method)
• section-code (method)
• section-code (method)
• (setf section-code) (method)
• (setf section-code) (generic function)
• section-commentary (generic function)
• section-commentary (method)
• (setf section-commentary) (method)
• (setf section-commentary) (generic function)
• section-depth (generic function)
• section-depth (method)
• section-depth (method)
• section-lacks-commentary (condition)
• section-lacks-commentary-stream (generic function)
• section-lacks-commentary-stream (method)
• section-locator (class)
• section-name (generic function)
• section-name (method)
• section-name (method)
• section-name (method)
• section-name (method)
• (setf section-name) (generic function)
• (setf section-name) (method)
• (setf section-name) (method)
• section-name-equal (function)
• section-name-index-entry (class)
• section-name-lessp (function)
• section-name-prefix-p (function)
• section-number (generic function)
• section-number (method)
• section-number (method)
• (setf section-number) (method)
• (setf section-number) (generic function)
• section-range (class)
• section-source-location (generic function)
• section-source-location (method)
• see-also-locator (class)
• see-locator (class)
• set-control-code (function)
• set-tangle-dispatch (function)
• set-weave-dispatch (function)
• setf-function (type)
• setf-function-name (class)
• setf-method-name (class)
• sharpsign-dot-reader (function)
• sharpsign-quote-reader (function)
• simple-bit-vector-reader (function)
• simple-reader-error (function)
• simple-reader-error (condition)
• simple-vector-marker (class)
• simple-vector-marker-element-type (generic function)
• simple-vector-marker-element-type (method)
• simple-vector-marker-elements (generic function)
• simple-vector-marker-elements (method)
• simple-vector-reader (function)
• single-quote-reader (function)
• slot-name (class)
• snarf-until-control-char (function)
• source-location (structure)
• source-location-file (function)
• (setf source-location-file) (function)
• source-location-for-reader (function)
• source-location-lineno (function)
• (setf source-location-lineno) (function)
• source-location-p (function)
• special-operator (class)
• special-variable-name (class)
• splicing-comma (class)
• squeeze (function)
• starred-section (class)
• starred-section-p (function)
• starred-test-section (class)
• start-code-marker (class)
• start-code-reader (function)
• start-section (generic function)
• start-section (method)
• start-section-reader (function)
• start-starred-section-reader (function)
• start-test-section-reader (function)
• stream-charpos (function)
• stream-lineno (function)
• struct-boa-constructor (class)
• struct-conc-name (function)
• (setf struct-conc-name) (function)
• struct-constructor-name (class)
• struct-constructors (function)
• (setf struct-constructors) (function)
• struct-copier-name (function)
• (setf struct-copier-name) (function)
• struct-copier-name (class)
• struct-include (function)
• (setf struct-include) (function)
• struct-name (function)
• struct-name (class)
• struct-predicate-name (function)
• (setf struct-predicate-name) (function)
• struct-predicate-name (class)
• struct-slot-accessor (class)
• struct-slot-reader (class)
• structure-description (structure)
• structure-description-p (function)
• structure-marker (class)
• structure-marker-form (generic function)
• structure-marker-form (method)
• structure-reader (function)
• sub-heading (generic function)
• sub-heading (method)
• sub-heading (method)
• sub-heading (method)
• substitute-referring-symbols (function)
• symbol-macro-definition (class)
• symbol-macro-name (class)
• symbol-provenance (function)
• symbol-replacement-reader (function)
• symbolicate (function)
• tag-name (class)
• tangle (function)
• tangle-1 (function)
• tangle-code-for-indexing (function)
• tangle-sections (function)
• test-for-section (generic function)
• test-for-section (method)
• (setf test-for-section) (method)
• (setf test-for-section) (generic function)
• test-section (class)
• test-section-p (function)
• token-delimiter-p (function)
• tt-heading (class)
• type-name (class)
• undefined-named-section-error (condition)
• unnamed-section-code-parts (function)
• unsubstitute-referring-symbols (function)
• update-charpos-stream-positions (function)
• update-context (generic function)
• update-context (method)
• update-context (method)
• update-context (method)
• update-context (method)
• used-by (generic function)
• used-by (method)
• (setf used-by) (method)
• (setf used-by) (generic function)
• variable-name (class)
• walk-as-special-form-p (generic function)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-as-special-form-p (method)
• walk-atomic-form (generic function)
• walk-atomic-form (method)
• walk-atomic-form (method)
• walk-atomic-form (method)
• walk-binding (function)
• walk-bindings (generic function)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-bindings (method)
• walk-compound-form (generic function)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-compound-form (method)
• walk-context (class)
• walk-declaration-specifier (generic function)
• walk-declaration-specifier (method)
• walk-declaration-specifiers (function)
• walk-defclass (function)
• walk-defstruct-name-and-options (function)
• walk-defstruct-option (function)
• walk-defstruct-slot-description (function)
• walk-defstruct-slot-name (function)
• walk-defun (function)
• walk-defvar (function)
• walk-form (generic function)
• walk-form (method)
• walk-lambda-expression (function)
• walk-lambda-list (function)
• walk-list (function)
• walk-method-definition (function)
• walk-name (generic function)
• walk-name (method)
• walk-name (method)
• walk-name (method)
• walk-name (method)
• walk-slot-specifier (function)
• walk-specialized-lambda-list (function)
• walk-the (function)
• walker (class)
• walker-index (generic function)
• walker-index (method)
• (setf walker-index) (method)
• (setf walker-index) (generic function)
• weave-object (function)
• weave-sections (function)
• weave-symbol-replace (function)
• whitespacep (function)
• with-charpos-input-stream (macro)
• with-charpos-output-stream (macro)
• with-mode (macro)
• with-rewind-stream (macro)
• with-unique-names (macro)
• wrap-reader-macro-function (function)
• xref-locator (class)

4.2 clweb/asdf

Source

asdf-operations.lisp (file)

Use List

• asdf/interface
• clweb
• common-lisp

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *compile-tests-file*

The default value for the :COMPILE-TESTS-FILE argument to TANGLE-FILE.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *index-lexical-variables*

If this flag is non-nil, the indexer will index lexical variables.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *index-pathname-defaults*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *lisp-pathname-defaults*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *sections-pathname-defaults*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tangle-file-pathname*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tangle-file-truename*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tests-file-pathname-function*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tex-pathname-defaults*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *weave-print*

The default for the :PRINT argument to WEAVE.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *weave-verbose*

The default for the :VERBOSE argument to WEAVE.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *web-pathname-defaults*

Package

clweb

Source

clweb.lisp (file)

5.1.2 Functions

Function: fasl-file-pathname INPUT-FILE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: index-file-pathname OUTPUT-FILE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: input-file-pathname INPUT-FILE

Package

clweb

Source

clweb.lisp (file)

Function: lisp-file-pathname INPUT-FILE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: load-sections-from-temp-file FILE APPEND &aux FILE

Load web sections from FILE, then delete it. If APPEND is true, named section definitions in FILE will be appended to existing definitions; otherwise, they will replace them.

Package

clweb

Source

clweb.lisp (file)

Function: load-web FILESPEC &key VERBOSE PRINT IF-DOES-NOT-EXIST EXTERNAL-FORMAT

Load the web given by FILESPEC into the Lisp environment.

Package

clweb

Source

clweb.lisp (file)

Function: sections-file-pathname INDEX-FILE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: tangle-file INPUT-FILE &rest ARGS &key OUTPUT-FILE TESTS-FILE VERBOSE PRINT IF-EXISTS COMPILE-FILE COMPILE-TESTS-FILE EXTERNAL-FORMAT &allow-other-keys &aux INPUT-FILE READTABLE PACKAGE

Tangle and compile the web in INPUT-FILE, producing OUTPUT-FILE.

Package

clweb

Source

clweb.lisp (file)

Function: tangle-file-pathnames INPUT-FILE &rest ARGS &key OUTPUT-FILE TESTS-FILE &allow-other-keys

Compute and return the defaulted names of the tangler output files.

Package

clweb

Source

clweb.lisp (file)

Function: tests-file-pathname INPUT-FILE &key OUTPUT-FILE TESTS-FILE &allow-other-keys

Package

clweb

Source

clweb.lisp (file)

Function: tex-file-pathname INPUT-FILE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: weave INPUT-FILE &rest ARGS &key OUTPUT-FILE TESTS-FILE INDEX-FILE VERBOSE PRINT (SOURCE-LOCATIONS *WEAVE-SOURCE-LOCATIONS*) EXTERNAL-FORMAT &aux INPUT-FILE READTABLE PACKAGE *WEAVE-PATHNAME*

Weave the web contained in INPUT-FILE, producing the TeX file OUTPUT-FILE.

Package

clweb

Source

clweb.lisp (file)

Function: weave-pathnames INPUT-FILE &key OUTPUT-FILE INDEX-FILE &allow-other-keys

Compute and return the defaulted names of the weaver output files.

Package

clweb

Source

clweb.lisp (file)

5.1.3 Conditions

Condition: ambiguous-prefix-error ()

Package

clweb

Source

clweb.lisp (file)

Direct superclasses

error (condition)

Direct methods

• ambiguous-prefix-alt-match (method)
• ambiguous-prefix-first-match (method)
• ambiguous-prefix (method)

Direct slots

Slot: prefix

Initargs

:prefix

Readers

ambiguous-prefix (generic function)

Slot: first-match

Initargs

:first-match

Readers

ambiguous-prefix-first-match (generic function)

Slot: alt-match

Initargs

:alt-match

Readers

ambiguous-prefix-alt-match (generic function)

Condition: section-name-context-error ()

Package

clweb

Source

clweb.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• section-name-definition-error (condition)
• section-name-use-error (condition)

Direct methods

section-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

section-name (generic function)

Condition: section-name-definition-error ()

Package

clweb

Source

clweb.lisp (file)

Direct superclasses

section-name-context-error (condition)

Condition: section-name-use-error ()

Package

clweb

Source

clweb.lisp (file)

Direct superclasses

section-name-context-error (condition)

Condition: unused-named-section-warning ()

Package

clweb

Source

clweb.lisp (file)

Direct superclasses

simple-warning (condition)

5.1.4 Classes

Class: clweb-file ()

Package

clweb

Source

asdf-operations.lisp (file)

Direct superclasses

source-file (class)

Direct methods

• perform (method)
• output-files (method)
• perform (method)
• perform (method)
• perform (method)
• output-files (method)
• component-pathname (method)

Direct slots

Slot: type

Initform

(pathname-type clweb:*web-pathname-defaults*)

Class: weave-op ()

Package

clweb

Source

asdf-operations.lisp (file)

Direct superclasses

downward-operation (class)

Direct methods

• perform (method)
• output-files (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *backquote*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *charpos-streams*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *consing-dot*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *current-section*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *empty-list*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *end-control-text*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *eof*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *evaluating*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *index*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *index-packages*

The list of packages whose symbols should be indexed.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *indexing*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *modes*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *named-sections*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *namespace-classes*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *physical-pathname-host*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *print-escape-list*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *print-symbol-suffixes*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *radix-prefix-alist*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *readtables*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *referring-classes*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *sections*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tab-width*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *tangle-pprint-dispatch*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *test-sections*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *weave-pathname*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *weave-pprint-dispatch*

Package

clweb

Source

clweb.lisp (file)

Special Variable: *weave-source-locations*

If true, include src: specials in the woven TeX.

Package

clweb

Source

clweb.lisp (file)

Special Variable: *whitespace*

Package

clweb

Source

clweb.lisp (file)

5.2.2 Symbol macros

Symbol Macro: eof

Package

clweb

Source

clweb.lisp (file)

Expansion

(load-time-value clweb::*eof* t)

5.2.3 Macros

Macro: backquote X

Package

clweb

Source

clweb.lisp (file)

Macro: define-special-form-walker OPERATOR (WALKER FORM ENV &rest REST) &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: defnamespace CLASS-NAME (&rest SUPERS) &optional NAMESPACE-NAME OTHER-SLOT-SPECS

Package

clweb

Source

clweb.lisp (file)

Macro: dont-index NAMESPACE

Package

clweb

Source

clweb.lisp (file)

Macro: maybe-push OBJ PLACE

Package

clweb

Source

clweb.lisp (file)

Macro: orf PLACE &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Macro: pop-qualifiers PLACE

Package

clweb

Source

clweb.lisp (file)

Macro: read-with-echo (STREAM OBJECT ECHOED) &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: reorder-env-information FN ORIG

Package

clweb

Source

clweb.lisp (file)

Macro: with-charpos-input-stream (VAR STREAM &key CHARPOS) &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: with-charpos-output-stream (VAR STREAM &key CHARPOS) &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: with-mode MODE &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: with-rewind-stream (VAR STREAM &optional REWIND) &body BODY

Package

clweb

Source

clweb.lisp (file)

Macro: with-unique-names SYMBOLS &body BODY

Package

clweb

Source

clweb.lisp (file)

5.2.4 Functions

Function: add-index-entry INDEX HEADING SECTION &optional DEF

Package

clweb

Source

clweb.lisp (file)

Function: analyze-indentation LIST-MARKER

Package

clweb

Source

clweb.lisp (file)

Function: array-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: backquotep OBJECT

Package

clweb

Source

clweb.lisp (file)

Function: bq-process X &aux X

Package

clweb

Source

clweb.lisp (file)

Function: bracket X

Package

clweb

Source

clweb.lisp (file)

Function: coalesce-locators LOCATORS

Package

clweb

Source

clweb.lisp (file)

Function: commap OBJ

Package

clweb

Source

clweb.lisp (file)

Function: comment-reader STREAM CHAR

Package

clweb

Source

clweb.lisp (file)

Function: complex-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: copy-source-location INSTANCE

Package

clweb

Source

clweb.lisp (file)

Function: copy-structure-description INSTANCE

Package

clweb

Source

clweb.lisp (file)

Function: create-source-location LINENO FILE

Package

clweb

Source

clweb.lisp (file)

Function: enclose LAMBDA-EXPRESSION &optional ENV WALKER

Package

clweb

Source

clweb.lisp (file)

Function: ensure-list OBJECT

Package

clweb

Source

clweb.lisp (file)

Function: ensure-portable-walking-environment ENV

Package

clweb

Source

clweb.lisp (file)

Function: eof-p OBJECT

Package

clweb

Source

clweb.lisp (file)

Function: featurep X

Package

clweb

Source

clweb.lisp (file)

Function: find-index-entries INDEX HEADING

Package

clweb

Source

clweb.lisp (file)

Function: find-namespace-class NAMESPACE-NAME

Function: (setf find-namespace-class) CLASS NAMESPACE-NAME

Package

clweb

Source

clweb.lisp (file)

Function: find-section NAME &aux NAME

Package

clweb

Source

clweb.lisp (file)

Function: generic-function-p FUNCTION-NAME

Package

clweb

Source

clweb.lisp (file)

Function: get-control-code SUB-CHAR MODE

Package

clweb

Source

clweb.lisp (file)

Function: index-entry-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: index-package PACKAGES &aux PACKAGES

Inform the weaver that it should index the symbols in PACKAGES.

Package

clweb

Source

clweb.lisp (file)

Function: index-package-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: index-sections SECTIONS &key INDEX WALKER

Package

clweb

Source

clweb.lisp (file)

Function: join-strings STRINGS &optional DELIMITER &aux STRINGS DELIMITER

Package

clweb

Source

clweb.lisp (file)

Function: list-marker-p OBJ

Package

clweb

Source

clweb.lisp (file)

Function: list-reader STREAM CHAR

Package

clweb

Source

clweb.lisp (file)

Function: load-web-from-stream STREAM PRINT &key APPEND &aux *READTABLE* *PACKAGE* *EVALUATING*

Package

clweb

Source

clweb.lisp (file)

Function: make-charpos-input-stream INPUT-STREAM &key CHARPOS

Package

clweb

Source

clweb.lisp (file)

Function: make-charpos-output-stream OUTPUT-STREAM &key CHARPOS

Package

clweb

Source

clweb.lisp (file)

Function: make-comma MODIFIER FORM

Package

clweb

Source

clweb.lisp (file)

Function: make-context CONTEXT &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: make-default-pathname TYPE

Package

clweb

Source

clweb.lisp (file)

Function: make-definition-location-table &optional SECTIONS &aux INDEX

Package

clweb

Source

clweb.lisp (file)

Function: make-heading NAME &optional SUB-HEADING

Package

clweb

Source

clweb.lisp (file)

Function: make-index ()

Package

clweb

Source

clweb.lisp (file)

Function: make-list-reader NEXT

Package

clweb

Source

clweb.lisp (file)

Function: make-locator &key SECTION DEF SEE SEE-ALSO

Package

clweb

Source

clweb.lisp (file)

Function: make-logical-block LIST

Package

clweb

Source

clweb.lisp (file)

Function: make-macro-char-heading CHAR &optional SUB-CHAR

Package

clweb

Source

clweb.lisp (file)

Function: make-section-name-index-entry SECTION

Package

clweb

Source

clweb.lisp (file)

Function: make-section-name-reader DEFINITION-ALLOWED-P USE

Package

clweb

Source

clweb.lisp (file)

Function: make-structure-description NAME &aux CONC-NAME COPIER-NAME PREDICATE-NAME

Package

clweb

Source

clweb.lisp (file)

Function: mapappend FN &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: maptree FN X

Package

clweb

Source

clweb.lisp (file)

Function: markerp OBJECT

Package

clweb

Source

clweb.lisp (file)

Function: newlinep OBJ

Package

clweb

Source

clweb.lisp (file)

Function: note-generic-function FUNCTION-NAME

Package

clweb

Source

clweb.lisp (file)

Function: output-file-pathname INPUT-FILE &key OUTPUT-FILE DEFAULTS

Package

clweb

Source

clweb.lisp (file)

Function: parse-body BODY &key DOC-STRING-ALLOWED WALKER ENV &aux DOC

Package

clweb

Source

clweb.lisp (file)

Function: pathname-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: print-char STREAM CHAR

Package

clweb

Source

clweb.lisp (file)

Function: print-escaped STREAM STRING &rest ARGS &aux STREAM

Package

clweb

Source

clweb.lisp (file)

Function: print-limbo STREAM SECTION

Package

clweb

Source

clweb.lisp (file)

Function: print-list STREAM LIST-MARKER

Package

clweb

Source

clweb.lisp (file)

Function: print-logical-block STREAM BLOCK

Package

clweb

Source

clweb.lisp (file)

Function: print-section STREAM SECTION

Package

clweb

Source

clweb.lisp (file)

Function: print-section-name STREAM SECTION &key INDEXING

Package

clweb

Source

clweb.lisp (file)

Function: print-source-location STREAM SOURCE-LOCATION

Package

clweb

Source

clweb.lisp (file)

Function: print-string STREAM STRING

Package

clweb

Source

clweb.lisp (file)

Function: print-symbol STREAM SYMBOL

Package

clweb

Source

clweb.lisp (file)

Function: print-tex STREAM TEX-MODE-MATERIAL &rest ARGS

Package

clweb

Source

clweb.lisp (file)

Function: print-xrefs STREAM KIND XREFS

Package

clweb

Source

clweb.lisp (file)

Function: radix-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: read-control-text STREAM &optional EOF-ERROR-P EOF-VALUE RECURSIVE-P

Package

clweb

Source

clweb.lisp (file)

Function: read-evaluated-form STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)

Function: read-inner-lisp STREAM CHAR

Package

clweb

Source

clweb.lisp (file)

Function: read-maybe-nothing STREAM &optional EOF-ERROR-P EOF-VALUE RECURSIVE-P

Package

clweb

Source

clweb.lisp (file)

Function: read-maybe-nothing-internal READ STREAM EOF-ERROR-P EOF-VALUE RECURSIVE-P

Package

clweb

Source

clweb.lisp (file)

Function: read-maybe-nothing-preserving-whitespace STREAM &optional EOF-ERROR-P EOF-VALUE RECURSIVE-P

Package

clweb

Source

clweb.lisp (file)

Function: read-sections INPUT-STREAM &key APPEND

Package

clweb

Source

clweb.lisp (file)

Function: read-tex-from-string INPUT-STRING

Package

clweb

Source

clweb.lisp (file)

Function: read-time-conditional-reader STREAM SUB-CHAR ARG

Package

clweb

Source

clweb.lisp (file)