The adp Reference Manual

4.1.1 adp/adp.asd

Source

adp.asd.

Parent Component

adp (system).

ASDF Systems

adp.

---

4.1.2 adp/package.lisp

Source

adp.asd.

Parent Component

adp (system).

Packages

• adp-private.
• adp.
• adp-style-maker.

---

4.1.3 adp/src/error.lisp

Source

adp.asd.

Parent Component

src (module).

Internals

• already-defined-tag-error (condition).
• file-not-selected-error (condition).
• itemize-first-element-not-item-error (condition).
• itemize-subelement-error (condition).
• null-itemize-error (condition).
• table-subelement-error (condition).
• tag-not-defined-error (condition).
• text-subelement-error (condition).
• uninterned-tag-error (condition).

---

4.1.4 adp/src/element.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• bold (class).
• cell (class).
• code (class).
• code-block (class).
• code-comment (class).
• code-example (class).
• code-hide (class).
• code-ref (class).
• defclass-definition (class).
• defconstant-definition (class).
• defgeneric-definition (class).
• define-compiler-macro-definition (class).
• define-condition-definition (class).
• define-method-combination-definition (class).
• define-modify-macro-definition (class).
• define-setf-expander-definition (class).
• define-symbol-macro-definition (class).
• defmacro-definition (class).
• defmethod-definition (class).
• defpackage-definition (class).
• defparameter-definition (class).
• defsetf-definition (class).
• defstruct-definition (class).
• deftype-definition (class).
• defun-definition (class).
• defvar-definition (class).
• emphasis (class).
• enumerate (class).
• function-ref (class).
• header (class).
• header-ref (class).
• image (class).
• inline-code (class).
• italic (class).
• item (class).
• itemize (class).
• mini-table-of-contents (class).
• print-object (method).
• print-object (method).
• subheader (class).
• subsubheader (class).
• symbol-ref (class).
• table (class).
• table-of-contents (class).
• table-of-functions (class).
• table-of-symbols (class).
• table-of-types (class).
• tagged-code (class).
• text (class).
• type-ref (class).
• verbatim-code-block (class).
• web-link (class).

Internals

• code-block-type (class).
• define-definition-class (macro).
• definition (class).
• element (class).
• file-table-of-contents (class).
• function-definition (class).
• header-type (class).
• itemize-type (class).
• symbol-definition (class).
• tagged-definition (class).
• tagged-element (class).
• text-element (class).
• text-reference (class).
• text-subelement (class).
• text-subelement-type (class).
• text-type (class).
• type-definition (class).

---

4.1.5 adp/src/file.lisp

Source

adp.asd.

Parent Component

src (module).

Internals

file (class).

---

4.1.6 adp/src/project.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

project (class).

---

4.1.7 adp/src/tag-table.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

with-tag-tables (macro).

Internals

• *code-tags* (special variable).
• *function-tags* (special variable).
• *header-tags* (special variable).
• *symbol-tags* (special variable).
• *type-tags* (special variable).
• copy-table-element (function).
• define-tag-tables (macro).
• define-with-tag-tables (macro).
• make-table-element (function).
• table-element (structure).
• table-element-elements (reader).
• (setf table-element-elements) (writer).
• table-element-p (function).
• table-element-used (reader).
• (setf table-element-used) (writer).
• tag-table (class).
• tag-table-find-elements (function).
• tag-table-find-elements-using-tag (function).
• tag-table-push-element (function).
• tag-table-set-element (function).
• tag-table-tag-p (function).
• tag-table-tags (function).
• tag-table-unused-elements (function).

---

4.1.8 adp/src/pprint-dispatch.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

*adp-pprint-dispatch* (special variable).

Internals

• convert-string-case (function).
• custom-symbol-pprint-function (function).
• make-custom-pprint-dispatch (function).
• shortest-string (function).

---

4.1.9 adp/src/writer.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• *begin-file-writer* (special variable).
• *begin-project-writer* (special variable).
• *bold-writer* (special variable).
• *code-block-writer* (special variable).
• *code-example-writer* (special variable).
• *defclass-writer* (special variable).
• *defconstant-writer* (special variable).
• *defgeneric-writer* (special variable).
• *define-compiler-macro-writer* (special variable).
• *define-condition-writer* (special variable).
• *define-method-combination-writer* (special variable).
• *define-modify-macro-writer* (special variable).
• *define-setf-expander-writer* (special variable).
• *define-symbol-macro-writer* (special variable).
• *defmacro-writer* (special variable).
• *defmethod-writer* (special variable).
• *defpackage-writer* (special variable).
• *defparameter-writer* (special variable).
• *defsetf-writer* (special variable).
• *defstruct-writer* (special variable).
• *deftype-writer* (special variable).
• *defun-writer* (special variable).
• *defvar-writer* (special variable).
• *emphasis-writer* (special variable).
• *end-file-writer* (special variable).
• *end-project-writer* (special variable).
• *escape-text* (special variable).
• *file-extension* (special variable).
• *function-ref-writer* (special variable).
• *header-ref-writer* (special variable).
• *header-writer* (special variable).
• *image-writer* (special variable).
• *inline-code-writer* (special variable).
• *italic-writer* (special variable).
• *itemize-writer* (special variable).
• *subheader-writer* (special variable).
• *subsubheader-writer* (special variable).
• *symbol-ref-writer* (special variable).
• *table-writer* (special variable).
• *text-writer* (special variable).
• *type-ref-writer* (special variable).
• *web-link-writer* (special variable).
• check-writers (macro).
• with-writers (macro).

Internals

• copy-writer (function).
• define-check-writers (macro).
• define-with-writers (macro).
• define-writers (macro).
• make-writer (function).
• writer (structure).
• writer-optional (reader).
• (setf writer-optional) (writer).
• writer-p (function).
• writer-proc (reader).
• (setf writer-proc) (writer).

---

4.1.10 adp/src/parameter.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• define-style-parameter (macro).
• with-new-style-parameter-list (macro).
• with-style-parameters (macro).

Internals

• *style-parameters* (special variable).
• check-style-parameters (function).
• copy-parameter (function).
• make-parameter (function).
• parameter (structure).
• parameter-keyword (reader).
• (setf parameter-keyword) (writer).
• parameter-optional (reader).
• (setf parameter-optional) (writer).
• parameter-p (function).
• parameter-symbol (reader).
• (setf parameter-symbol) (writer).
• parameter-value (reader).
• (setf parameter-value) (writer).
• set-style-parameter-values (function).
• unset-style-parameter-values (function).

---

4.1.11 adp/src/core.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• add-code-tag (function).
• add-element (generic function).
• project-print (function).
• relative-truename (function).
• select-file (function).

Internals

• check-subelements (generic function).
• code-to-string (function).
• define-definition-element-print (macro).
• define-tagged-definition-element-print (macro).
• element-print (generic function).
• file-headers (function).
• file-print (function).
• file-push-element (function).
• header-deep-level (function).
• make-itemize-table (function).
• make-itemize-toc (function).
• make-itemize-tof (function).
• make-itemize-tos (function).
• make-itemize-tot (function).
• make-toc-deep-levels (function).
• process-itemize (generic function).
• project-add-file (function).
• project-find-file (function).
• project-headers (function).
• split-symbols (function).
• text-type-to-string (generic function).
• warn-unused-code-tags (function).
• warn-unused-header-tags (function).

---

4.1.12 adp/src/adp.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• action-description (method).
• action-description (method).
• bold (macro).
• cell (macro).
• cl-ref (macro).
• code-block (macro).
• code-comment (macro).
• code-example (macro).
• code-hide (macro).
• code-quote (macro).
• code-remove (macro).
• code-tag (macro).
• defclass (macro).
• defconstant (macro).
• defgeneric (macro).
• define-compiler-macro (macro).
• define-condition (macro).
• define-method-combination (macro).
• define-modify-macro (macro).
• define-setf-expander (macro).
• define-symbol-macro (macro).
• defmacro (macro).
• defmethod (macro).
• defpackage (macro).
• defparameter (macro).
• defsetf (macro).
• defstruct (macro).
• deftype (macro).
• defun (macro).
• defvar (macro).
• emphasis (macro).
• enumerate (macro).
• function-ref (macro).
• header (macro).
• header-ref (macro).
• image (macro).
• in-file (macro).
• inline-code (macro).
• italic (macro).
• item (macro).
• itemize (macro).
• load-system (function).
• mini-table-of-contents (macro).
• perform (method).
• perform (method).
• subheader (macro).
• subsubheader (macro).
• symbol-ref (macro).
• table (macro).
• table-of-contents (macro).
• table-of-functions (macro).
• table-of-symbols (macro).
• table-of-types (macro).
• text (macro).
• type-ref (macro).
• verbatim-code-block (macro).
• web-link (macro).

Internals

• *adp* (special variable).
• *header-tag-counter* (special variable).
• *project* (special variable).
• adp-reader-macro-dispatch (function).
• adv-defmacro (macro).
• adv-defun (macro).
• adv-header (macro).
• adv-in-file (macro).
• adv-subheader (macro).
• check-code-comment (function).
• check-code-hide (function).
• check-code-remove (function).
• define-definition-macro (macro).
• define-header-macro (macro).
• define-reference-macro (macro).
• define-text-enrichment-macro (macro).
• eval-when-adp (macro).
• load-doc-source-op (class).
• load-project (function).
• load-style (function).
• make-unique-tag (function).
• perform-lisp-load-source (function).
• plistp (function).
• process-code-tag (function).
• process-itemize (function).
• remove-code-tag (function).
• valid-tag-p (function).

---

4.1.13 adp/src/style-maker.lisp

Source

adp.asd.

Parent Component

src (module).

Public Interface

• *adp-pprint-dispatch* (special variable).
• define-bold-writer (macro).
• define-code-block-writer (macro).
• define-code-example-writer (macro).
• define-defclass-writer (macro).
• define-defconstant-writer (macro).
• define-defgeneric-writer (macro).
• define-define-compiler-macro-writer (macro).
• define-define-condition-writer (macro).
• define-define-method-combination-writer (macro).
• define-define-modify-macro-writer (macro).
• define-define-setf-expander-writer (macro).
• define-define-symbol-macro-writer (macro).
• define-defmacro-writer (macro).
• define-defmethod-writer (macro).
• define-defpackage-writer (macro).
• define-defparameter-writer (macro).
• define-defsetf-writer (macro).
• define-defstruct-writer (macro).
• define-deftype-writer (macro).
• define-defun-writer (macro).
• define-defvar-writer (macro).
• define-emphasis-writer (macro).
• define-escape-text (macro).
• define-file-extension (macro).
• define-function-ref-writer (macro).
• define-header-ref-writer (macro).
• define-header-writer (macro).
• define-image-writer (macro).
• define-inline-code-writer (macro).
• define-italic-writer (macro).
• define-itemize-writer (macro).
• define-style-parameter (macro).
• define-subheader-writer (macro).
• define-subsubheader-writer (macro).
• define-symbol-ref-writer (macro).
• define-table-writer (macro).
• define-text-writer (macro).
• define-type-ref-writer (macro).
• define-web-link-writer (macro).
• with-defclass-components (macro).
• with-defconstant-components (macro).
• with-defgeneric-components (macro).
• with-define-compiler-macro-components (macro).
• with-define-condition-components (macro).
• with-define-method-combination-components (macro).
• with-define-modify-macro-components (macro).
• with-define-setf-expander-components (macro).
• with-define-symbol-macro-components (macro).
• with-defmacro-components (macro).
• with-defmethod-components (macro).
• with-defpackage-components (macro).
• with-defparameter-components (macro).
• with-defsetf-components (macro).
• with-defstruct-components (macro).
• with-deftype-components (macro).
• with-defun-components (macro).
• with-defvar-components (macro).

Internals

• check-component-symbols (function).
• declarationp (function).
• def-with-components (macro).
• defclass-accessor-function-names (function).
• defclass-allocation-types (function).
• defclass-class-name (function).
• defclass-class-options (function).
• defclass-default-initargs (function).
• defclass-documentation (function).
• defclass-initarg-names (function).
• defclass-initforms (function).
• defclass-metaclass (function).
• defclass-reader-function-names (function).
• defclass-slot-documentations (function).
• defclass-slot-names (function).
• defclass-slot-options (function).
• defclass-slot-specifiers (function).
• defclass-superclass-names (function).
• defclass-type-specifiers (function).
• defclass-writer-function-names (function).
• defconstant-documentation (function).
• defconstant-initial-value (function).
• defconstant-name (function).
• defgeneric-argument-precedence-order (function).
• defgeneric-documentation (function).
• defgeneric-function-name (function).
• defgeneric-generic-function-class (function).
• defgeneric-gf-declarations (function).
• defgeneric-gf-lambda-list (function).
• defgeneric-method-class (function).
• defgeneric-method-combination (function).
• defgeneric-method-descriptions (function).
• defgeneric-options (function).
• define-begin-file-writer (macro).
• define-begin-project-writer (macro).
• define-compiler-macro-declarations (function).
• define-compiler-macro-documentation (function).
• define-compiler-macro-forms (function).
• define-compiler-macro-lambda-list (function).
• define-compiler-macro-name (function).
• define-condition-default-initargs (function).
• define-condition-documentation (function).
• define-condition-name (function).
• define-condition-options (function).
• define-condition-parent-types (function).
• define-condition-report-name (function).
• define-condition-slot-accessors (function).
• define-condition-slot-allocations (function).
• define-condition-slot-initargs (function).
• define-condition-slot-initforms (function).
• define-condition-slot-names (function).
• define-condition-slot-options (function).
• define-condition-slot-readers (function).
• define-condition-slot-specs (function).
• define-condition-slot-types (function).
• define-condition-slot-writers (function).
• define-end-file-writer (macro).
• define-end-project-writer (macro).
• define-method-combination-arguments (function).
• define-method-combination-declarations (function).
• define-method-combination-descriptions (function).
• define-method-combination-documentation (function).
• define-method-combination-forms (function).
• define-method-combination-generic-function (function).
• define-method-combination-identity-with-one-argument (function).
• define-method-combination-lambda-list (function).
• define-method-combination-long-form-options (function).
• define-method-combination-method-group-specifier-names (function).
• define-method-combination-method-group-specifiers (function).
• define-method-combination-name (function).
• define-method-combination-operator (function).
• define-method-combination-orders (function).
• define-method-combination-predicates (function).
• define-method-combination-qualifier-patterns (function).
• define-method-combination-requireds (function).
• define-method-combination-short-form-options (function).
• define-modify-macro-documentation (function).
• define-modify-macro-function (function).
• define-modify-macro-lambda-list (function).
• define-modify-macro-name (function).
• define-setf-expander-access-fn (function).
• define-setf-expander-declarations (function).
• define-setf-expander-documentation (function).
• define-setf-expander-forms (function).
• define-setf-expander-lambda-list (function).
• define-symbol-macro-expansion (function).
• define-symbol-macro-symbol (function).
• define-writer-definer (macro).
• defmacro-declarations (function).
• defmacro-documentation (function).
• defmacro-forms (function).
• defmacro-lambda-list (function).
• defmacro-name (function).
• defmethod-declarations (function).
• defmethod-documentation (function).
• defmethod-forms (function).
• defmethod-function-name (function).
• defmethod-method-qualifiers (function).
• defmethod-specialized-lambda-list (function).
• defpackage-defined-package-name (function).
• defpackage-documentation (function).
• defpackage-export-symbol-names (function).
• defpackage-import-from-package-names (function).
• defpackage-import-from-symbol-names (function).
• defpackage-import-symbol-names (function).
• defpackage-nicknames (function).
• defpackage-options (function).
• defpackage-shadow-symbol-names (function).
• defpackage-shadowing-import-from-package-names (function).
• defpackage-shadowing-import-from-symbol-names (function).
• defpackage-size (function).
• defpackage-use-package-names (function).
• defparameter-documentation (function).
• defparameter-initial-value (function).
• defparameter-name (function).
• defsetf-access-fn (function).
• defsetf-documentation (function).
• defsetf-update-fn (function).
• defstruct-conc-name (function).
• defstruct-conc-name-option (function).
• defstruct-constructor-arglists (function).
• defstruct-constructor-names (function).
• defstruct-constructor-options (function).
• defstruct-copier-name (function).
• defstruct-copier-option (function).
• defstruct-documentation (function).
• defstruct-include-option (function).
• defstruct-include-option-slot-descriptors (function).
• defstruct-included-structure-name (function).
• defstruct-initial-offset (function).
• defstruct-initial-offset-option (function).
• defstruct-name-and-options (function).
• defstruct-named-option (function).
• defstruct-options (function).
• defstruct-predicate-name (function).
• defstruct-predicate-option (function).
• defstruct-print-function-option (function).
• defstruct-print-object-option (function).
• defstruct-printer-name (function).
• defstruct-printer-option (function).
• defstruct-slot-descriptions (function).
• defstruct-slot-initforms (function).
• defstruct-slot-names (function).
• defstruct-slot-options (function).
• defstruct-slot-read-only-ps (function).
• defstruct-slot-types (function).
• defstruct-structure-name (function).
• defstruct-type (function).
• defstruct-type-option (function).
• deftype-declarations (function).
• deftype-documentation (function).
• deftype-forms (function).
• deftype-lambda-list (function).
• deftype-name (function).
• defun-declarations (function).
• defun-documentation (function).
• defun-forms (function).
• defun-function-name (function).
• defun-lambda-list (function).
• defvar-documentation (function).
• defvar-initial-value (function).
• defvar-name (function).
• documentationp (function).

---

6.1.1 Special variables

Special Variable: *adp-pprint-dispatch* ¶

Package

adp-private.

Source

pprint-dispatch.lisp.

Special Variable: *adp-pprint-dispatch* ¶

ADP custom pprint dispatch table to make the code printing look better. The main difference is when the package extension of a symbol is printed. It will only print the extension package when a symbol is exported.

Package

adp-style-maker.

Source

style-maker.lisp.

Special Variable: *begin-file-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *begin-project-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *bold-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *code-block-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *code-example-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defclass-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defconstant-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defgeneric-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-compiler-macro-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-condition-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-method-combination-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-modify-macro-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-setf-expander-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *define-symbol-macro-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defmacro-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defmethod-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defpackage-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defparameter-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defsetf-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defstruct-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *deftype-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defun-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *defvar-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *emphasis-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *end-file-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *end-project-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *escape-text* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *file-extension* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *function-ref-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *header-ref-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *header-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *image-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *inline-code-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *italic-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *itemize-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *subheader-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *subsubheader-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *symbol-ref-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *table-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *text-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *type-ref-writer* ¶

Package

adp-private.

Source

writer.lisp.

Special Variable: *web-link-writer* ¶

Package

adp-private.

Source

writer.lisp.

---

6.1.2 Macros

Macro: bold (&rest args) ¶

Add bold style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: cell (&rest objects) ¶

Create a cell to place into a table. The arguments in objects can be any lisp object. They will be princ-ed and concatenated into a single string.
You can use the following macros to enrich your cell text: bold, italic, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: check-writers () ¶

Package

adp-private.

Source

writer.lisp.

Macro: cl-ref (sym) ¶

Add a reference to a Common Lisp symbol when using the macros text, cell or item.

Package

adp.

Source

adp.lisp.

Macro: code-block ((&rest tags) &body code) ¶

Add a block of code. Each element of code will be prin1-ed but not evaluated. If a symbol is used and that symbol appears as a tag in tags, then the code assigned to that tag is printed instead of the symbol.

Package

adp.

Source

adp.lisp.

Macro: code-comment (comment &body body) ¶

Form recognized by code-tag that prints a comment before the body expressions when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-example (&body code) ¶

Same as code-block, but tags cannot be used and the code is evaluated. The standard output and the last-form’s results are also printed.

Package

adp.

Source

adp.lisp.

Macro: code-hide ((&rest tags) &body body) ¶

Form recognized by code-tag that will hide the code printing ’...’. The printing will be done when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-quote (&body body) ¶

Form recognized by code-tag that prevents the expressions from being evaluated.

Package

adp.

Source

adp.lisp.

Macro: code-remove ((&rest tags) &body body) ¶

Form recognized by code-tag that will remove the code printing. This will be done when using the tag defined by code-tag inside a code-block.

Package

adp.

Source

adp.lisp.

Macro: code-tag (tags &body exprs) ¶

Assign several tags to several forms. The forms are placed into a progn form. The argument tags must be a list
of symbols. If no tags are provided, an error is raised. Each symbol in tags will be a code-tag assigned to code.
The same tag can be used several times in different calls to code-tag. Inside the code-tag form it is correct to use
the next forms: code-hide, code-remove, code-show and code-comment.
- code-hide: It has the syntax (code-hide (&rest tags) &rest forms). code-hide receives a list of tags. If a tag
used in code-tag also appears in code-hide, the rest of forms will be hidden when using the macro code-block. If the list of tags in code-hide is empty, the forms will be hidden for every tag used in code-tag. Hidding the code means printing "..." instead of the forms.
- code-remove: Same as code-hide, but removes the code instead of printing "..."
- code-quote: Every expression placed inside code-quote will have its evaluation disabled.
- code-comment: Receive a string and the forms to be commented. This string will be printed as a comment (printing ’;;’).

Package

adp.

Source

adp.lisp.

Macro: defclass (&body body) ¶

Add a defclass declaration. The macro expands to cl:defclass. Also, the class name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: defconstant (&body body) ¶

Add a defconstant declaration. The macro expands to cl:defconstant. Also, the constant name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: defgeneric (&body body) ¶

Add a defgeneric declaration. The macro expands to cl:defgeneric. Also, the generic function name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: define-bold-writer ((stream text) &body body) ¶

Define a function to print a bold text element. It receives the stream to be written in, and a string with the text.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-code-block-writer ((stream lang text) &body body) ¶

Define a function to print a code block element. It receives the stream, a string with the used programming language, and another string with the text to be placed in the block of code.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-code-example-writer ((stream text output results) &body body) ¶

Define a function to print an example block. It receives the stream, a string with the code to be placed in a block of code, a string with the standard output of the code, and a list of elements returned by the code.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-compiler-macro (&body body) ¶

Add a define-compiler-macro declaration. The macro expands to cl:define-compiler-macro.

Package

adp.

Source

adp.lisp.

Macro: define-condition (&body body) ¶

Add a define-condition declaration. The macro expands to cl:define-condition. Also, the condition name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: define-defclass-writer ((stream expr tag) &body body) ¶

Define a function to print a defclass definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defconstant-writer ((stream expr tag) &body body) ¶

Define a function to print a defconstant definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defgeneric-writer ((stream expr tag) &body body) ¶

Define a function to print a defgeneric definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-compiler-macro-writer ((stream expr) &body body) ¶

Define a function to print a define-compiler-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-condition-writer ((stream expr tag) &body body) ¶

Define a function to print a define-condition definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-method-combination-writer ((stream expr) &body body) ¶

Define a function to print a define-method-combination definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-modify-macro-writer ((stream expr tag) &body body) ¶

Define a function to print a define-modify-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-setf-expander-writer ((stream expr) &body body) ¶

Define a function to print a define-setf-expander definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-define-symbol-macro-writer ((stream expr tag) &body body) ¶

Define a function to print a define-symbol-macro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defmacro-writer ((stream expr tag) &body body) ¶

Define a function to print a defmacro definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defmethod-writer ((stream expr) &body body) ¶

Define a function to print a defmethod definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defpackage-writer ((stream expr) &body body) ¶

Define a function to print a defpackage definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defparameter-writer ((stream expr tag) &body body) ¶

Define a function to print a defparameter definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defsetf-writer ((stream expr) &body body) ¶

Define a function to print a defsetf definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defstruct-writer ((stream expr tag) &body body) ¶

Define a function to print a defstruct definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-deftype-writer ((stream expr tag) &body body) ¶

Define a function to print a deftype definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defun-writer ((stream expr tag) &body body) ¶

Define a function to print a defun definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-defvar-writer ((stream expr tag) &body body) ¶

Define a function to print a defvar definition. It receives the stream, and the definition expression.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-emphasis-writer ((stream text) &body body) ¶

Same as define-bold-writer, but with both bold and italic style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-escape-text ((text) &body body) ¶

Define a function that receives a string of text and must return another string. You want this to escape special characters that will be used with bold, italic, header-ref, web-link, etc.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-file-extension (() &body body) ¶

Define a function that must return a string indicating the extension of the files that ADP will create.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-function-ref-writer ((stream tag source-relative-path) &body body) ¶

Same as define-symbol-ref-writer, but it prints a function reference.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-header-ref-writer ((stream tag title source-relative-path) &body body) ¶

Define a function to print a header reference element. It receives the stream to be written in, the tag associated to a header element, the text of said header element, and the relative path to the place where the header element is in.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-header-writer ((stream title tag) &body body) ¶

Define a function that must print a header element. The function receives the stream to be written in, the header name and the tag associated to it.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-image-writer ((stream alt-text image-relative-path) &body body) ¶

Define a function to print an image element. It receives the stream, the alternative text as a string, and a relative pathname to the image.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-inline-code-writer ((stream text) &body body) ¶

Same as define-bold-writer, but with a code-inline style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-italic-writer ((stream text) &body body) ¶

Same as define-bold-writer, but with an italic style.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-itemize-writer ((stream itemize) &body body) ¶

Define a function to print an itemize element. It receives the stream and a list. The first element of the
list can be :iterate or :enumerate indicating if you should use numbers. Each element of the rest of the list can be an item or a nested list element. The item has the form (:item string). A nested list element is a list starting with :itemize or :enumerate and the rest of elements are again items or nested list elements. For example, you could receive something like:
(:itemize (:item "Animals")
(:enumerate (:item "Dog")
(:item "Cat")))

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-method-combination (&body body) ¶

Add a define-method-combination declaration. The macro expands to cl:define-method-combination.

Package

adp.

Source

adp.lisp.

Macro: define-modify-macro (&body body) ¶

Add a define-modify-macro declaration. The macro expands to cl:define-modify-macro. Also, the macro name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: define-setf-expander (&body body) ¶

Add a define-setf-expander declaration. The macro expands to cl:define-setf-expander.

Package

adp.

Source

adp.lisp.

Macro: define-style-parameter (name &key value key required) ¶

Package

adp-private.

Source

parameter.lisp.

Macro: define-style-parameter (name &key value key required) ¶

Define a style parameter. A new parameter is defined (using defparameter) and also a style parameter is added. A style parameter is a keyword parameter added to ADP:LOAD-SYSTEM. NAME is the name of the parameter. VALUE is the default value. KEY is the keyword of the style parameter. If KEY is not specified, the keyword is obtained using the symbol name of NAME. If REQUIRED is non-NIL, the user must use this parameter when using ADP:LOAD-SYSTEM.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-subheader-writer ((stream title tag) &body body) ¶

Same as define-header-writer but it must print a subheader element.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-subsubheader-writer ((stream title tag) &body body) ¶

Same as define-header-writer but it must print a subsubheader element.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-symbol-macro (&body body) ¶

Add a define-symbol-macro declaration. The macro expands to cl:define-symbol-macro. Also, the symbol name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: define-symbol-ref-writer ((stream tag source-relative-path) &body body) ¶

Same as define-header-ref-writer, but it prints a symbol reference. Also, it receives the stream, the tag associated with the symbol, and the relative path to the place where the symbol definition is in.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-table-writer ((stream rows) &body body) ¶

Define a function to print a table element. It receives the stream, and a list of lists of strings. Each inner list is a row of the table, and each string is an element of the table.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-text-writer ((stream text) &body body) ¶

Define a function that must print a text element. It receives the stream to be written in, and a string with the text.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-type-ref-writer ((stream tag source-relative-path) &body body) ¶

Sama as define-symbol-ref-writer, but it prints a type reference.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: define-web-link-writer ((stream text address) &body body) ¶

Define a function to print a web link element. It receives the stream, the link text as a string, and the link address as a string.

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: defmacro (&body body) ¶

Add a defmacro declaration. The macro expands to cl:defmacro. Also, the macro name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: defmethod (&body body) ¶

Add a defmethod declaration. The macro expands to cl:defmethod.

Package

adp.

Source

adp.lisp.

Macro: defpackage (&body body) ¶

Add a defpackage declaration. The macro expands to cl:defpackage.

Package

adp.

Source

adp.lisp.

Macro: defparameter (&body body) ¶

Add a defparameter declaration. The macro expands to cl:defparameter. Also, the parameter name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: defsetf (&body body) ¶

Add a defsetf declaration. The macro expands to cl:defsetf.

Package

adp.

Source

adp.lisp.

Macro: defstruct (&body body) ¶

Add a defstruct declaration. The macro expands to cl:defstruct. Also, the struct name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: deftype (&body body) ¶

Add a deftype declaration. The macro expands to cl:deftype. Also, the type name is used to create a type-tag.

Package

adp.

Source

adp.lisp.

Macro: defun (&body body) ¶

Add a defun declaration. The macro expands to cl:defun. Also, the function name is used to create a function-tag.

Package

adp.

Source

adp.lisp.

Macro: defvar (&body body) ¶

Add a defvar declaration. The macro expands to cl:defvar. Also, the variable name is used to create a symbol-tag.

Package

adp.

Source

adp.lisp.

Macro: emphasis (&rest args) ¶

Add bold and italic style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: enumerate (&rest items) ¶

Same as itemize, but a number is printed before each element.

Package

adp.

Source

adp.lisp.

Macro: function-ref (tag) ¶

Add a reference to a function symbol when using the macros text, cell or item. The argument is a symbol denoting a function defined with adp:defgeneric, adp:define-modify-macro, adp:defmacro or adp:defun.

Package

adp.

Source

adp.lisp.

Macro: header (str &optional tag) ¶

Add a header with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: header-ref (tag) ¶

Add a reference to a header when using the macros text, cell or item. The argument is a symbol denoting a header-tag. Only the symbols used with the macros header, subheader and subsubheader are valid.

Package

adp.

Source

adp.lisp.

Macro: image (alt-text path) ¶

Add an image with alt-text as the alternative text and path must be the pathname, relative to the system’s root directory, where the image is located.

Package

adp.

Source

adp.lisp.

Macro: in-file (path) ¶

Package

adp.

Source

adp.lisp.

Macro: inline-code (&rest args) ¶

Add inlined style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: italic (&rest args) ¶

Add italic style to text. Each argument is princ-ed and concatenated into a string.

Package

adp.

Source

adp.lisp.

Macro: item (&rest items) ¶

Create an item to be placed into a iterate/enumerate form. The arguments in objects can be any lisp object. They will be princ-ed and concatenated into a single string. You can use the following macros to enrich your cell text: bold, italic, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: itemize (&rest items) ¶

Add a list of items. Each argument must be a list. Each list must start with the symbol item, itemize or enumerate. If
item is used, the rest of the elements in that list will be treated as if using the macro text. If itemize or enumerate is used the rest of elements must be lists that must start with item, itemize or enumerate. In other words, when itemize or enumerate is used
a nested list is added. A certain symbol will be printed before each element of the list.

Package

adp.

Source

adp.lisp.

Macro: mini-table-of-contents () ¶

Add a list of all headers, subheaders and subsubheaders used in the current documentation file.

Package

adp.

Source

adp.lisp.

Macro: subheader (str &optional tag) ¶

Add a subheader with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: subsubheader (str &optional tag) ¶

Add a subsubheader with name str. Also, if tag is not nil but an interned symbol, a new header-tag is created.

Package

adp.

Source

adp.lisp.

Macro: symbol-ref (tag) ¶

Add a reference to a variable when using the macros text, cell or item. The argument is a symbol denoting a variable defined with adp:defconstant, adp:define-symbol-macro, adp:defparameter or adp:defvar.

Package

adp.

Source

adp.lisp.

Macro: table (&rest rows) ¶

Add a table. Each argument must be a list of cell macro calls.

Package

adp.

Source

adp.lisp.

Macro: table-of-contents () ¶

Add a list of all headers and subheaders used in the system. The headers from different files are shown in the same order the files are loaded.

Package

adp.

Source

adp.lisp.

Macro: table-of-functions () ¶

Add an ordered list of all functions and macros defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: table-of-symbols () ¶

Add an ordered list of all variables defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: table-of-types () ¶

Add an ordered list of all types defined using ADP.

Package

adp.

Source

adp.lisp.

Macro: text (&rest objects) ¶

Add plain text. The arguments in objects can be any lisp object. They will be princ-ed and concatenated into a single string.
You can use the following macros to enrich your text: bold, italic, emphasis, inline-code, web-link, header-ref, symbol-ref, function-ref and type-ref.

Package

adp.

Source

adp.lisp.

Macro: type-ref (tag) ¶

Add a reference to a type symbol when using the macros text, cell or item. The argument is a symbol denoting a type defined with adp:defclass, adp:define-condition, adp:defstruct or adp:deftype.

Package

adp.

Source

adp.lisp.

Macro: verbatim-code-block (lang text) ¶

Add a block of text. It receives two arguments. The first argument must be a string or NIL and it should denote the programming language that will be used. The second argument must be a string with the text that will be printed.

Package

adp.

Source

adp.lisp.

Macro: web-link (name link) ¶

Add a hyperlink. The text showed is name and link must be a valid web URL. Both arguments must be strings.

Package

adp.

Source

adp.lisp.

Macro: with-defclass-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defconstant-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defgeneric-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-compiler-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-condition-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-method-combination-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-modify-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-setf-expander-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-define-symbol-macro-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defmacro-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defmethod-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defpackage-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defparameter-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defsetf-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defstruct-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-deftype-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defun-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-defvar-components (((&rest component-rest-args) function-body-arg) &body body-arg) ¶

Package

adp-style-maker.

Source

style-maker.lisp.

Macro: with-new-style-parameter-list (&body body) ¶

Package

adp-private.

Source

parameter.lisp.

Macro: with-style-parameters (args &body body) ¶

Package

adp-private.

Source

parameter.lisp.

Macro: with-tag-tables (&body body0) ¶

Package

adp-private.

Source

tag-table.lisp.

Macro: with-writers (&body body0) ¶

Package

adp-private.

Source

writer.lisp.

---

6.1.3 Ordinary functions

Function: add-code-tag (tag code) ¶

Associate a tag with a piece of code.

Package

adp-private.

Source

core.lisp.

Function: load-system (system style &rest style-args) ¶

Load a system with documentation generation activated. The style must be a keyword denoting a valid style.
Each style will create different files. The style-args are style-dependent. In other words, each style can have its own arguments to let the user customize briefly how documentation is printed.

Package

adp.

Source

adp.lisp.

Function: project-print (project) ¶

Generate a project documentation.

Package

adp-private.

Source

core.lisp.

Function: relative-truename (project &optional path) ¶

Return the *load-truename* path relative to the project root directory.

Package

adp-private.

Source

core.lisp.

Function: select-file (project path) ¶

Package

adp-private.

Source

core.lisp.

---

6.1.4 Generic functions

Generic Function: add-element (project element) ¶

Add an element into a project.

Package

adp-private.

Source

core.lisp.

Methods

Method: add-element :after (project (element type-definition)) ¶

Method: add-element :after (project (element function-definition)) ¶

Method: add-element :after (project (element symbol-definition)) ¶

Method: add-element :after (project (element file-table-of-contents)) ¶

Method: add-element :after (project (element table-of-contents)) ¶

Method: add-element :after (project (element header-type)) ¶

Method: add-element (project (element element)) ¶

---