Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the scribble Reference Manual, version 1.0.1.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:33:15 2018 GMT+0.
| • Introduction: | What scribble is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Scribble: SCRibe-like reader extension for Common Lisp
Copyright (c) 2002-2012 by Fare Rideau < fare at tunes dot org >
http://www.cliki.net/Fare%20Rideau
HOME PAGE:
http://www.cliki.net/Scribble
LICENSE:
http://tunes.org/legalese/bugroff.html
You may at your leisure use the LLGPL instead:
http://www.cliki.net/LLGPL
DEPENDENCY:
This package depends on Meta by Jochen Schmidt, version 1.0.0 or later.
http://www.cliki.net/Meta
Now also: meta fare-utils fare-matcher named-readtables
USAGE:
You can enable Racket-like Scribble behavior for the macro-character #\@ with
(scribble:enable-scribble-at-syntax)
and disable it with
(scribble:disable-scribble-at-syntax)
You may also use
(named-readtables:in-readtable :scribble-racket)
Or
(named-readtables:in-readtable :scribble-both)
Or
(named-readtables:in-readtable :scribble)
For details, see:
http://docs.racket-lang.org/scribble/reader.html
If you additionally pass the keyword argument :skribe t
You will also have Skribe-like syntax.
You can enable only Skribe-like syntax for the macro-character #\[ with
(scribble:enable-scribble-syntax)
and disable it with
(scribble:disable-scribble-syntax)
You may also use
(named-readtables:in-readtable :scribble-skribe)
Or
(named-readtables:in-readtable :scribble-both)
Or
(named-readtables:in-readtable :scribble)
Alternatively, you can enable behaviour for the character #\[
under the dispatching macro-character #\# using
(scribble:enable-sub-scribble-syntax)
(scribble:disable-sub-scribble-syntax)
AT SYNTAX:
The syntax of text after @ is just like
Racket's Scribble syntax by Eli Barzilay.
His Scribble "at-syntax" is described thus:
http://barzilay.org/research.html
http://barzilay.org/misc/scribble-reader.pdf
http://docs.racket-lang.org/scribble/reader.html
BASIC SYNTAX:
The syntax of text within brackets is Skribe-like:
* Text between brackets will expand to a string containing said text,
unless there are escape forms in the text,
which are identified by a comma
followed by either an opening parenthesis or an opening bracket.
* If there are escape forms in the text,
then the text will be split into components,
which will be non-empty strings and escape forms.
The result of parsing the text will be a (LIST ...) of these components.
* A comma followed by a parenthesis denotes an escape form,
whereas a SEXP beginning with said parenthesis
is read and used as a component of the surrounding text.
For instance, [foo ,(bar baz) quux] will (on first approximation) be read as
(LIST "foo " (bar baz) " quux")
Mind the spaces being preserved around the internal form.
EXTENSION TO SCRIBE SYNTAX:
Scribble extends the Scribe syntax in a way that I find very convenient.
* As an extension to Scribe syntax,
if the first character of text within bracket is an unescaped colon #\:
then an expression after it is read that is used
as a "head" for the body of the text resulting from parsing as above.
[:emph this] is read as (EMPH "this")
[:(font :size -1) that] is read as (FONT :SIZE -1 "that")
* As another extension to Scribe syntax,
a comma followed by a bracket will also denote an escape form,
whereas the bracketed-text using Scribble syntax
is read and used as a component of the surrounding text.
This extension is only useful in conjunction with the previous extension.
SYNTACTIC CATCHES:
There are a few possible sources of problems with the Scribe syntax,
and solutions provided by Scribe and Scribble to avoid these problems.
* A closing bracket closes the current text.
Standard Scribe syntax doesn't provide a mean
to include a closing bracket in bracketed text.
* Conversely, so as to prevent difficult to track syntax errors
resulting from typos, Standard Scribe syntax forbids
to include an opening bracket in the text.
* As an extension to Scribe syntax,
you can include any character in the text,
without triggering any special or error-raising behaviour,
by preceding it with a backslash character #\\ in the text
(which preceding backslash character won't be included in the result string).
This is useful to include a character among #\\ #\: #\, #\[ #\] #\(.
* While #\\ will always be able to escape all non-alphanumeric characters,
including the special characters listed above,
future extensions may give a special meaning to #\\ followed by a character
in the regexp range [_a-zA-Z0-9].
If you feel the need for such an extension, I will accept patches;
I suppose that the C or Perl syntax is what is needed here.
* In the bracket-colon syntax extension, after reading the "head",
all spacing characters (space, tab, newline, linefeed, return, page)
are skipped until the next non-space character.
To insert a space character immediately after the head,
just escape it using #\\ as above.
* As a restriction from Scribe syntax, Scribble syntax
doesn't recognize the use of semi-colon as denoting discardable comments.
In Scribe, a semi-colon at the beginning of a line or of bracketed text
or of a string component of bracketed text will denote a comment,
whereas Scribe will ignore any text to the next end of line.
Scribble will include any such text in the result string.
You can emulate the original Scribe behaviour in this regard
by using the preprocessing customization feature described below.
CUSTOMIZATION:
Scribble can be customized in many ways,
to accomodate the specificities of your markup language backend.
* As an extension to Scribe semantics, all strings resulting from reading
bracket-delimited text (as opposed to those resulting from "normal"
double-quote delimited strings that may appear inside escape forms)
may be preprocessed. There may be compile-time or run-time preprocessing.
The variable *SCRIBBLE-PREPROCESS* decides what kind of preprocessing is
done. If it is NIL, then no preprocessing is done (i.e. strings from the
[...] notation will be read as such). If it is T, then run-time
preprocessing is done, via the function PP which itself issues a dynamic
call to the function *SCRIBBLE-PREPROCESSOR* if not NIL (or else behaves
as identity). If it is a function or non-boolean symbol, then said value
is funcall'ed at read-time to preprocess the string form by e.g. wrapping
it into some macro evaluation. Note that when using run-time preprocessing,
you may either lexically shadow the function PP or dynamically rebind the
variable *SCRIBBLE-PREPROCESSOR* to locally select a different preprocessor.
A macro SCRIBBLE:WITH-PREPROCESSOR is defined to do the dynamic rebinding,
as in (scribble:with-preprocessor #'string-upcase [foo]) which (assuming
run-time preprocessing is enabled) will evaluate to "FOO".
* Though the default behaviour of Scribble is to return
a (possibly preprocessed) string if there are no subcomponents,
and a form (cl:list ...) if there are multiple components,
you can customize this behaviour by binding the customization variable
scribble:*scribble-list* to a function that will do the job,
taking as many arguments as there were components (zero for empty text).
If you only want to keep the same general behaviour,
but change the head of the resulting list from cl:list to something else,
then don't modify scribble:*scribble-list*
(or bind it back to scribble:default-scribble-list)
and instead bind scribble:*scribble-default-head* to a symbol
that at evaluation time will be bound to a function
that will properly combine the multiple components.
Note that this scribble:*scribble-list* is processed at read-time,
whereas the function named by scribble:*scribble-default-head* (if applicable)
will be processed at evaluation-time.
* You can select a package from which Scribble will read head forms
of bracket-colon syntax [:head ...] or [:(head args) ...]
by changing the symbol-value of scribble:*scribble-package*.
Typical use is
(setq scribbe:*scribble-package* :keyword)
which will do wonders with AllegroServe's net.html.generator.
Note that this feature happens at read-time, and doesn't affect
the current package used to read escape forms.
If the *scribble-package* feature prevents reading
the arguments to structured head form arguments in the right package,
[:(head form arguments) ...]
then you can fall back to normal scribe syntax
,(head form argument [...])
or qualify the symbols in your head form by their package
[:(cl:head my-package:form foo:arguments) ...]
* You can modify the way that scribble combines
the head and body of bracket-colon syntax
by changing the value of variable scribble:*scribble-cons*
from the default value scribble:default-scribble-cons.
The function takes as parameters the head specified by bracket-colon syntax
and the list of components of the bracketed text, and has to return
Typically, you might want to special case the behaviour
according to the type of the head: cons or symbol.
Note that this happens at read-time.
* Example functions to customize scribble for use with various backends
are given at the end of this file. Check functions
scribble:configure-scribble
scribble:configure-scribble-for-araneida
scribble:configure-scribble-for-htmlgen
scribble:configure-scribble-for-lml2
scribble:configure-scribble-for-tml
scribble:configure-scribble-for-who
scribble:configure-scribble-for-yaclml
Please send me updates that include support for your favorite backend.
EXAMPLE USE:
(load "scribble")
(use-package :scribble)
(enable-scribble-syntax)
'[foo ,[:emph bar] ,[:(baz :size 1) quux ,(tata toto [\:titi])] tutu]
==>
(LIST (PP "foo ") (EMPH (PP "bar")) (PP " ")
(BAZ :SIZE 1 (LIST (PP "quux ") (TATA TOTO (PP ":titi")))) (PP " tutu"))
(let ((p "/home/fare/fare/www/liberty/white_black_magic.scr")
(eof '#:eof))
(with-open-file (s p :direction :input :if-does-not-exist :error)
(loop for i = (read s nil eof nil)
until (eq i eof)
collect i)))
(configure-scribble-for-araneida-html)
(html-stream *stdout* '[:html ...])
TODO:
* Make it work with aserve, who, and other backends.
Share and enjoy!
For historical information, see also Daniel Herring's partial implementation:
http://lists.libcl.com/pipermail/libcl-devel-libcl.com/2010-January/000094.html
NAMING NOTE
Eli Barzilay started using the name "Scribble" in 2006;
I started using it in 2003 or earlier for my Scribe-like syntax, now Skribe-like.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The scribble system: |
Francois-Rene Rideau
MIT
Syntax extensions akin to Racket’s Scribble and Bigloo’s Skribe
Scribble offers two syntax extensions allowing you to very nicely
mix text markup data and Lisp code. One syntax is a port to CL of Racket’s Scribble syntax,
and the other is a port to CL of Bigloo’s Skribe syntax.
1.0.1.2
scribble.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
Next: The scribble/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
scribble.asd
scribble (system)
Next: The scribble/utilities<dot>lisp file, Previous: The scribble<dot>asd file, Up: Lisp files [Contents][Index]
Next: The scribble/stream-line-column<dot>lisp file, Previous: The scribble/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
scribble (system)
utilities.lisp
Next: The scribble/racket<dot>lisp file, Previous: The scribble/utilities<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
scribble (system)
stream-line-column.lisp
Next: The scribble/skribe<dot>lisp file, Previous: The scribble/stream-line-column<dot>lisp file, Up: Lisp files [Contents][Index]
utilities.lisp (file)
scribble (system)
racket.lisp
Next: The scribble/readtables<dot>lisp file, Previous: The scribble/racket<dot>lisp file, Up: Lisp files [Contents][Index]
utilities.lisp (file)
scribble (system)
skribe.lisp
Previous: The scribble/skribe<dot>lisp file, Up: Lisp files [Contents][Index]
scribble (system)
readtables.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The scribble package: |
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables: | ||
| • Exported macros: | ||
| • Exported functions: |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Scribble customization parameter: you can change it so as to define what scribble returns from the head and body of text in bracket-colon syntax
skribe.lisp (file)
Scribble customization parameter: assuming default scribble-list behavior, modify the head of the form returned to combine at runtime the multiple components of the bracketed text being parsed
skribe.lisp (file)
Scribble customization parameter: you can change it so as to define what scribble returns from the list of components in parsed bracketed text
skribe.lisp (file)
if not NIL, the package in which Scribble will read the head of text in bracket-colon syntax
skribe.lisp (file)
set this variable to NIL to disable Scribble wrapping of strings
into preprocessing forms, to T to enable run-time preprocessing, or to a symbol or function
to enable compile-time preprocessing
skribe.lisp (file)
run-time preprocessor of strings by Scribble. Used when *SCRIBBLE-PREPROCESS* is T.
skribe.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Form to define local Scribble preprocessor
skribe.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
stream-line-column.lisp (file)
skribe.lisp (file)
This will make Scribble work with the patched version of araneida’s original html.lisp function that I used in CTO and that handles ’list correctly. Hopefully my patch will be integrated into the main upstream darcs repository.
skribe.lisp (file)
This is meant to make Scribble work with AllegroServe’s HTMLGEN from Franz, Inc. – a least if I read the spec correctly.
skribe.lisp (file)
This makes Scribble work with LML2 by kmr, which is based on Franz’s HTMLGEN.
skribe.lisp (file)
tml, previously known as htout, is tfeb’s package. This is a wild guess from reading the docs. Please modify to actually suit the package.
skribe.lisp (file)
WHO is an optimized html generation package by Edi Weitz.
Its keyword semantics is very Scribe-like.
I wrote this reading the docs, but didn’t test it.
skribe.lisp (file)
yaclml is yet another common lisp markup language. The author wrote this support, but didn’t test it.
skribe.lisp (file)
skribe.lisp (file)
Default behavior for returning components of bracketed text
skribe.lisp (file)
racket.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
racket.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
Default preprocessing of Scribble strings: compile-time identity.
Globally, locally or lexically alter the binding of symbol-function scribble:pp
in your macros so as to customize the behavior of preprocessing
skribe.lisp (file)
stream-line-column.lisp (file)
racket.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
stream-line-column.lisp (file)
Return multiple values describing the effect of the string on column position. 1- whether there was a newline found, if no NIL, if yes its position in the string. 2- if no newline, whether there is a leading tab that further aligns the column. 3- the number of characters after newline and/or tab.
stream-line-column.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal macros: | ||
| • Internal functions: | ||
| • Internal generic functions: | ||
| • Internal conditions: | ||
| • Internal classes: | ||
| • Internal types: |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
stream-line-column.lisp (file)
utilities.lisp (file)
skribe.lisp (file)
racket.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
do stuff while binding *package* to package if not NIL at runtime
skribe.lisp (file)
skribe.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
stream-line-column.lisp (file)
utilities.lisp (file)
racket.lisp (file)
skribe.lisp (file)
Combine components of bracketed text at runtime with *scribble-default-head*
skribe.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
racket.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
/home/quickref/quicklisp/dists/quicklisp/software/fare-memoization-20180430-git/memoization.lisp
racket.lisp (file)
racket.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
racket.lisp (file)
utilities.lisp (file)
skribe.lisp (file)
utilities.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
skribe.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
stream-line-column.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
utilities.lisp (file)
automatically generated reader method
utilities.lisp (file)
automatically generated reader method
utilities.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
utilities.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
utilities.lisp (file)
Next: Internal types, Previous: Internal conditions, Up: Internal definitions [Contents][Index]
utilities.lisp (file)
standard-object (class)
stream
:stream
input-stream (generic function)
(make-array (quote (16)) :element-type (quote character) :adjustable t :fill-pointer 0)
input-buffer (generic function)
Previous: Internal classes, Up: Internal definitions [Contents][Index]
spacing character
skribe.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L S |
|---|
| Jump to: | F L S |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | A C D E F G I M N P R S T U W |
|---|
| Jump to: | A C D E F G I M N P R S T U W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | $
*
B S |
|---|
| Jump to: | $
*
B S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | B C P S T |
|---|
| Jump to: | B C P S T |
|---|