The url-rewrite Reference Manual

Table of Contents

The url-rewrite Reference Manual

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.

1 Introduction

URL-REWRITE - Rewrite (X)HTML attributes with Common Lisp

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.

2 Systems

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

2.1 url-rewrite

Version

0.1.1

Source

url-rewrite.asd (file)

Components

• packages.lisp (file)
• specials.lisp (file)
• primitives.lisp (file)
• util.lisp (file)
• url-rewrite.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 url-rewrite.asd

Location

url-rewrite.asd

Systems

url-rewrite (system)

3.1.2 url-rewrite/packages.lisp

Parent

url-rewrite (system)

Location

packages.lisp

Packages

url-rewrite

3.1.3 url-rewrite/specials.lisp

Dependency

packages.lisp (file)

Parent

url-rewrite (system)

Location

specials.lisp

Exported Definitions

• *url-rewrite-fill-tags* (special variable)
• *url-rewrite-tags* (special variable)

Internal Definitions

• *find-string-hash* (special variable)
• *hyperdoc-base-uri* (special variable)
• *url-rewrite-base-directory* (special variable)
• hyperdoc-lookup (function)

3.1.4 url-rewrite/primitives.lisp

Dependency

specials.lisp (file)

Parent

url-rewrite (system)

Location

primitives.lisp

Internal Definitions

• comment-start-p (function)
• letterp (function)
• name-char-p (function)
• peek-char* (function)
• read-until (function)
• read-while (function)
• whitespacep (function)

3.1.5 url-rewrite/util.lisp

Dependency

primitives.lisp (file)

Parent

url-rewrite (system)

Location

util.lisp

Internal Definitions

• read-attribute (function)
• read-delimited-string (function)
• read-name (function)
• skip-comment (function)
• skip-whitespace (function)

3.1.6 url-rewrite/url-rewrite.lisp

Dependency

util.lisp (file)

Parent

url-rewrite (system)

Location

url-rewrite.lisp

Exported Definitions

• add-get-param-to-url (function)
• rewrite-urls (function)
• starts-with-scheme-p (function)
• url-encode (function)

4 Packages

Packages are listed by definition order.

4.1 url-rewrite

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *url-rewrite-fill-tags* (special variable)
• *url-rewrite-tags* (special variable)
• add-get-param-to-url (function)
• rewrite-urls (function)
• starts-with-scheme-p (function)
• url-encode (function)

Internal Definitions

• *find-string-hash* (special variable)
• *hyperdoc-base-uri* (special variable)
• *url-rewrite-base-directory* (special variable)
• comment-start-p (function)
• hyperdoc-lookup (function)
• letterp (function)
• name-char-p (function)
• peek-char* (function)
• read-attribute (function)
• read-delimited-string (function)
• read-name (function)
• read-until (function)
• read-while (function)
• skip-comment (function)
• skip-whitespace (function)
• whitespacep (function)

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: *url-rewrite-fill-tags*

The tag/attribute combinations where URL-rewriting should optionally add an attribute.

Package

url-rewrite

Source

specials.lisp (file)

Special Variable: *url-rewrite-tags*

The tag/attribute combinations where URL-rewriting should happen.

Package

url-rewrite

Source

specials.lisp (file)

5.1.2 Functions

Function: add-get-param-to-url URL NAME VALUE

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.

Package

url-rewrite

Source

url-rewrite.lisp (file)

Function: rewrite-urls REWRITE-FN &optional TEST-FN

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.

Package

url-rewrite

Source

url-rewrite.lisp (file)

Function: starts-with-scheme-p STRING

Checks whether the string STRING represents a URL which starts with a scheme, i.e. something like ’https://’ or ’mailto:’.

Package

url-rewrite

Source

url-rewrite.lisp (file)

Function: url-encode STRING

URL-encode a string.

Package

url-rewrite

Source

url-rewrite.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *find-string-hash*

Hash tables used internally by READ-UNTIL to cache offset arrays.

Package

url-rewrite

Source

specials.lisp (file)

Special Variable: *hyperdoc-base-uri*

Package

url-rewrite

Source

specials.lisp (file)

Special Variable: *url-rewrite-base-directory*

Package

url-rewrite

Source

specials.lisp (file)

5.2.2 Functions

Function: comment-start-p ()

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.

Package

url-rewrite

Source

primitives.lisp (file)

Function: hyperdoc-lookup SYMBOL TYPE

Package

url-rewrite

Source

specials.lisp (file)

Function: letterp C

Checks whether C is a character between A and Z (case-insensitive).

Package

url-rewrite

Source

primitives.lisp (file)

Function: name-char-p C

Checks whether C is a name constituent character in the sense of HTML.

Package

url-rewrite

Source

primitives.lisp (file)

Function: peek-char* ()

PEEK-CHAR with input stream bound to *STANDARD-INPUT* and returning NIL on EOF.

Package

url-rewrite

Source

primitives.lisp (file)

Function: read-attribute &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

util.lisp (file)

Function: read-delimited-string &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

util.lisp (file)

Function: read-name &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

util.lisp (file)

Function: read-until STRING &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

primitives.lisp (file)

Function: read-while PREDICATE &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

primitives.lisp (file)

Function: skip-comment ()

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.

Package

url-rewrite

Source

util.lisp (file)

Function: skip-whitespace &key SKIP WRITE-THROUGH

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.

Package

url-rewrite

Source

util.lisp (file)

Function: whitespacep C

Checks whether C is a whitespace character.

Package

url-rewrite

Source

primitives.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types