This is the cl-why Reference Manual, version 1.1.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:52:43 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-why(X)HTML generation macros
JP Cimalando
BSD
1.1.4
packages.lisp (file).
specials.lisp (file).
util.lisp (file).
why.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-why/specials.lisppackages.lisp (file).
cl-why (system).
*attribute-quote-char* (special variable).
*downcase-tokens-p* (special variable).
*escape-char-p* (special variable).
*html-empty-tag-aware-p* (special variable).
*html-empty-tags* (special variable).
*html-no-indent-tags* (special variable).
*prologue* (special variable).
print-object (method).
print-object (method).
*empty-tag-end* (special variable).
*html-mode* (special variable).
*indent* (special variable).
+newline+ (constant).
+spaces+ (constant).
-esc- (function).
-raw- (function).
<esc> (structure).
<esc>-data (reader).
<esc>-p (function).
<raw> (structure).
<raw>-data (reader).
<raw>-p (function).
copy-<esc> (function).
copy-<raw> (function).
defconstant (macro).
make-<esc> (function).
make-<raw> (function).
wrapper-p (function).
cl-why/util.lispspecials.lisp (file).
cl-why (system).
escape-char (function).
escape-char-all (function).
escape-char-iso-8859-1 (function).
escape-char-minimal (function).
escape-char-minimal-plus-quotes (function).
escape-string (function).
escape-string-all (function).
escape-string-iso-8859-1 (function).
escape-string-minimal (function).
escape-string-minimal-plus-quotes (function).
extract-declarations (function).
iso-8859-1-escape-char-p (function).
minimal-escape-char-p (function).
minimal-plus-quotes-escape-char-p (function).
n-spaces (macro).
non-7bit-ascii-escape-char-p (function).
with-rebinding (macro).
with-unique-names (macro).
cl-why/why.lisputil.lisp (file).
cl-why (system).
conc (function).
convert-attributes (function).
convert-tag-to-string-list (generic function).
html-mode (function).
(setf html-mode) (function).
with-html-output (macro).
with-html-output-to-string (macro).
list-to-string (function).
process-tag (function).
tree-to-commands (function).
tree-to-template (function).
Packages are listed by definition order.
cl-whywhy
common-lisp.
*attribute-quote-char* (special variable).
*downcase-tokens-p* (special variable).
*escape-char-p* (special variable).
*html-empty-tag-aware-p* (special variable).
*html-empty-tags* (special variable).
*html-no-indent-tags* (special variable).
*prologue* (special variable).
conc (function).
convert-attributes (function).
convert-tag-to-string-list (generic function).
escape-char (function).
escape-char-all (function).
escape-char-iso-8859-1 (function).
escape-char-minimal (function).
escape-char-minimal-plus-quotes (function).
escape-string (function).
escape-string-all (function).
escape-string-iso-8859-1 (function).
escape-string-minimal (function).
escape-string-minimal-plus-quotes (function).
html-mode (function).
(setf html-mode) (function).
with-html-output (macro).
with-html-output-to-string (macro).
*empty-tag-end* (special variable).
*html-mode* (special variable).
*indent* (special variable).
+newline+ (constant).
+spaces+ (constant).
-esc- (function).
-raw- (function).
<esc> (structure).
<esc>-data (reader).
<esc>-p (function).
<raw> (structure).
<raw>-data (reader).
<raw>-p (function).
copy-<esc> (function).
copy-<raw> (function).
defconstant (macro).
extract-declarations (function).
iso-8859-1-escape-char-p (function).
list-to-string (function).
make-<esc> (function).
make-<raw> (function).
minimal-escape-char-p (function).
minimal-plus-quotes-escape-char-p (function).
n-spaces (macro).
non-7bit-ascii-escape-char-p (function).
process-tag (function).
tree-to-commands (function).
tree-to-template (function).
with-rebinding (macro).
with-unique-names (macro).
wrapper-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Quote character for attributes.
If NIL, a keyword symbol representing a tag or attribute name will not be automatically converted to lowercase. This is useful when one needs to output case sensitive XML.
Used by ESCAPE-STRING to test whether a character should be escaped.
Set this to NIL to if you want to use CL-WHY as a strict XML generator. Otherwise, CL-WHY will only write empty tags listed in *HTML-EMPTY-TAGS* as <tag/> (XHTML mode) or <tag> (SGML mode and HTML5 mode). For all other tags, it will always generate <tag></tag>.
The list of HTML tags that should be output as empty tags. See *HTML-EMPTY-TAG-AWARE-P*.
The list of HTML tags that should disable indentation inside them. The initial value is a list containing only :PRE and :TEXTAREA.
This is the first line that’ll be printed if the :PROLOGUE keyword argument is T
Transform the enclosed BODY consisting of HTML as s-expressions into Lisp code to write the corresponding HTML as strings to VAR - which should either hold a stream or which’ll be bound to STREAM if supplied.
Transform the enclosed BODY consisting of HTML as s-expressions into Lisp code which creates the corresponding HTML as a string.
Concatenates all arguments into one string.
Helper function for CONVERT-TAG-TO-STRING-LIST which converts the alist ATTR-LIST of attributes into a list of strings and/or Lisp forms.
Returns an escaped version of the character CHAR if CHAR satisfies the predicate TEST. Always returns a string.
Escapes characters which aren’t in the 7-bit ASCII character set.
Escapes characters that aren’t defined in ISO-8859-9.
Escapes only #<, #>, and #& characters.
Like ESCAPE-CHAR-MINIMAL but also escapes quotes.
Escape all characters in STRING which pass TEST. This function is not guaranteed to return a fresh string. Note that you can pass NIL for STRING which’ll just be returned.
Escapes all characters in STRING which aren’t in the 7-bit ASCII character set.
Escapes all characters in STRING which aren’t defined in ISO-8859-1.
Escapes only #<, #>, and #& in STRING.
Like ESCAPE-STRING-MINIMAL but also escapes quotes.
Returns the current HTML mode. :SGML for (SGML-)HTML, :XML for XHTML and :HTML5 for HTML5 (HTML syntax).
Sets the output mode to XHTML or (SGML-)HTML. MODE can be :SGML for HTML, :XML for XHTML or :HTML5 for HTML5 (HTML syntax).
Used by PROCESS-TAG to convert ‘HTML’ into a list
of strings. TAG is a keyword symbol naming the outer tag, ATTR-LIST
is an alist of its attributes (the car is the attribute’s name as a
keyword, the cdr is its value), BODY is the tag’s body, and BODY-FN is
a function which should be applied to BODY. The function must return
a list of strings or Lisp forms.
Used for indentation.
Used for indentation.
End of an empty tag. Default is XML style.
:SGML for (SGML-)HTML, :XML (default) for XHTML, :HTML5 for HTML5.
Whether to insert line breaks and indent. Also controls amount of indentation dynamically.
Make sure VALUE is evaluated only once (to appease SBCL).
A string with N spaces - used by indentation.
WITH-REBINDING ( { var | (var prefix) }* ) form*
Evaluates a series of forms in the lexical environment that is formed by adding the binding of each VAR to a fresh, uninterned symbol, and the binding of that fresh, uninterned symbol to VAR’s original value, i.e., its value in the current lexical environment.
The uninterned symbol is created as if by a call to GENSYM with the
string denoted by PREFIX - or, if PREFIX is not supplied, the string
denoted by VAR - as argument.
The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).
Syntax: WITH-UNIQUE-NAMES ( { var | (var x) }* ) declaration* form*
Executes a series of forms with each VAR bound to a fresh,
uninterned symbol. The uninterned symbol is as if returned by a call
to GENSYM with the string denoted by X - or, if X is not supplied, the
string denoted by VAR - as argument.
The variable bindings created are lexical unless special declarations
are specified. The scopes of the name bindings and declarations do not
include the Xs.
The forms are evaluated in order, and the values of all but the last are discarded (that is, the body is an implicit PROGN).
Create a wrapper of type <ESC> for DATA if it is non-null, otherwise return NIL.
Create a wrapper of type <RAW> for DATA if it is non-null, otherwise return NIL.
Given a FORM, the declarations - if any - will be extracted
from the head of the FORM, and will return two values the declarations,
and the remaining of FORM
Helper function for the ESCAPE-FOO-ISO-8859-1 functions to determine whether CHAR must be escaped.
Concatenates a list of objects into one string.
Helper function for the ESCAPE-FOO-MINIMAL functions to determine whether CHAR must be escaped.
Helper function for the ESCAPE-FOO-MINIMAL-PLUS-QUOTES functions to determine whether CHAR must be escaped.
Helper function for the ESCAPE-FOO-ISO-8859-1 functions to determine whether CHAR must be escaped.
Returns a string list corresponding to the ‘HTML’ (in CL-WHY syntax) in SEXP. Uses the generic function CONVERT-TO-STRING-LIST internally. Utility function used by TREE-TO-TEMPLATE.
Transforms an HTML tree into an intermediate format - mainly a flattened list of strings. Utility function used by TREE-TO-COMMANDS-AUX.
Returns whether object is a wrapper of either type <RAW> or <ESC>.
A wrapper for objects to print with HTML escapes.
structure-object.
This slot is read-only.
A wrapper for objects to print without HTML escapes.
structure-object.
This slot is read-only.
| Jump to: | (
-
<
C D E F G H I L M N P T W |
|---|
| Jump to: | (
-
<
C D E F G H I L M N P T W |
|---|
| Jump to: | *
+
C D S |
|---|
| Jump to: | *
+
C D S |
|---|
| Jump to: | <
C F P S U W |
|---|
| Jump to: | <
C F P S U W |
|---|