Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the url-rewrite Reference Manual, version 0.1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 15:13:32 2021 GMT+0.
• Introduction | What url-rewrite 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 |
URL-REWRITE is a small package which can be used to programmatically rewrite (X)HTML documents such that certain attributes values are replaced by others. It was written to rewrite URLs (as in <a href="..."> or <img src="...">) for cookie-less session handling but maybe you'll find other uses for it.
Complete documentation for URL-REWRITE can be found in the docs
directory or at the project site.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The url-rewrite system |
0.1.1
url-rewrite.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
Next: The url-rewrite/packages․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
url-rewrite.asd
url-rewrite (system)
Next: The url-rewrite/specials․lisp file, Previous: The url-rewrite․asd file, Up: Lisp files [Contents][Index]
url-rewrite (system)
packages.lisp
Next: The url-rewrite/primitives․lisp file, Previous: The url-rewrite/packages․lisp file, Up: Lisp files [Contents][Index]
packages.lisp (file)
url-rewrite (system)
specials.lisp
Next: The url-rewrite/util․lisp file, Previous: The url-rewrite/specials․lisp file, Up: Lisp files [Contents][Index]
specials.lisp (file)
url-rewrite (system)
primitives.lisp
Next: The url-rewrite/url-rewrite․lisp file, Previous: The url-rewrite/primitives․lisp file, Up: Lisp files [Contents][Index]
primitives.lisp (file)
url-rewrite (system)
util.lisp
Previous: The url-rewrite/util․lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
url-rewrite (system)
url-rewrite.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The url-rewrite package |
packages.lisp (file)
common-lisp
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 functions |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The tag/attribute combinations where URL-rewriting should optionally add an attribute.
specials.lisp (file)
The tag/attribute combinations where URL-rewriting should happen.
specials.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
URL is assumed to be a http URL. The pair of NAME and VALUE will be added as a GET parameter to this URL. Assumes that there’s no other parameter of the same name. Only checks if #? is part of the string to decide how to attach the new parameter to the end of the string.
url-rewrite.lisp (file)
Reads an (X)HTML document from *STANDARD-INPUT* and writes it back
to *STANDARD-OUTPUT*. Any attribute value which is in one of the
positions denoted by *URL-REWRITE-TAGS* is rewritten by REWRITE-FN if
it passes the test denoted by the optional function TEST-FN which
defaults to the complement of STARTS-WITH-SCHEME-P.
This function aims to yield correct results for correct (X)HTML input and it also tries hard to never signal an error although it may warn if it encounters syntax errors. It will NOT detect any possible error nor is there any warranty that it will work correctly with faulty input.
url-rewrite.lisp (file)
Checks whether the string STRING represents a URL which starts with a scheme, i.e. something like ’https://’ or ’mailto:’.
url-rewrite.lisp (file)
URL-encode a string.
url-rewrite.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Hash tables used internally by READ-UNTIL to cache offset arrays.
specials.lisp (file)
specials.lisp (file)
specials.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Checks whether *STANDARD-OUTPUT* currently ’looks at’ the string "–". Will move the position within the stream by one unless the first characters it sees is not a hyphen.
primitives.lisp (file)
specials.lisp (file)
Checks whether C is a character between A and Z (case-insensitive).
primitives.lisp (file)
Checks whether C is a name constituent character in the sense of HTML.
primitives.lisp (file)
PEEK-CHAR with input stream bound to *STANDARD-INPUT* and returning NIL on EOF.
primitives.lisp (file)
Read characters from *STANDARD-INPUT* assuming that they constitue a SGML-style attribute/value pair. Returns three values - the name of the attribute, its value, and the whole string which was read. On EOF the string(s) read so far is/are returned. If SKIP is true NIL is returned. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true.
util.lisp (file)
Reads and returns as its first value a string from *STANDARD-INPUT*. The string is either delimited by ’ or " in which case the delimiters aren’t part of the string but the second return value is the delimiter character or it is assumed to extend to the next character which is not a name constituent (see NAME-CHAR-P). On EOF the string read so far is returned. If SKIP is true NIL is returned. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true.
util.lisp (file)
Read characters from *STANDARD-INPUT* as long as they are name constituents. Returns the string which was read unless SKIP is true. On EOF the string read so far is returned. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true.
util.lisp (file)
Reads characters from *STANDARD-INPUT* up to and including STRING. Return the string which was read (excluding STRING) unless SKIP is true. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true. On EOF the string read so far is returned.
primitives.lisp (file)
Reads characters from *STANDARD-INPUT* while PREDICATE returns a true value for each character. Returns the string which was read unless SKIP is true. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true. On EOF the string read so far is returned.
primitives.lisp (file)
Skip SGML comment from *STANDARD-INPUT*, i.e. a string enclosed in ’–’ on both sides. Returns no values. Writes all characters read to *STANDARD-OUTPUT*. This function assumes (without checking) that the current position of *STANDARD-INPUT* is at the beginning of a comment, after the first hyphen - see COMMENT-START-P.
util.lisp (file)
Read characters from *STANDARD-INPUT* as long as they are whitespace. Returns the string which was read unless SKIP is true. On EOF the string read so far is returned. Writes all characters read to *STANDARD-OUTPUT* if WRITE-THROUGH is true.
util.lisp (file)
Checks whether C is a whitespace character.
primitives.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 U |
---|
Jump to: | F L U |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | A C F H L N P R S U W |
---|
Jump to: | A C F H L N P R S U W |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | P S U |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
P | |||
Package, url-rewrite : | The url-rewrite package | ||
| |||
S | |||
System, url-rewrite : | The url-rewrite system | ||
| |||
U | |||
url-rewrite : | The url-rewrite system | ||
url-rewrite : | The url-rewrite package | ||
|
Jump to: | P S U |
---|