The hh-web Reference Manual

This is the hh-web Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:59:00 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 hh-web
3 Modules
4 Files
- 4.1 Lisp
5 Packages
- 5.1 hh-web
- 5.2 hh-web-asd
6 Definitions
- 6.1 Public Interface
- 6.2 Internals
Appendix A Indexes

1 Introduction

#About HH-Web#

HH-Web is the beginnings of a web application framework written in Lisp designed to streamline development of modern web applications.

See the LICENSE file for the license covering all code within the HH-Web directory and any subdirectories.
Basically, it's the MIT license, so you are free to do what you want, provided you reproduce the original copyright.

##Platforms##

The primary platform for HH-Web development is SBCL x64 on Mac OS X Lion (latest SBCL rev tested is 1.0.57); other Common Lisp implementations that appear to work correctly are CCL 1.8 x86, LispWorks 6.01, and ABCL 1.0.1. HH-Web has also been tested with SBCL 1.0.57 x64 on Ubuntu 11.04.

Platforms with known issues include CCL x64 (problem with threads) and CMUCL (which does not like named-readtables).

##Features##

In its present form (as of June 2012), there are 4 principal features in HH-Web:

Composable widgets: HH-Web let's the developer write a web page using conventional Lisp s-expression syntax, complete with properly generated CSS & Javascript. More importantly, commonly used fragments of HTML/CSS/Javascript can be bundled as a tag (just like HTML tags such as p, div, h1, etc.), and the corresponding HTML/CSS/Javascript for the expected fragment will be generated instead. Using custom tags means that most of the development of a new site involves identifying the common elements that make up the site's pages, creating custom tags (with parameters or "attributes", when necessary) as needed, and then authoring the pages as templates using both HTML tags and the site-specific custom tags.
Regex-based URL dispatching: Inspired by Django's (and Rails') use of regex dispatching, HH-Web implements a similar technique, but in Lisp. Most importantly, if the regex contains "variables" (e.g., named registers, in regex parlance), then symbols will be interned for those variables and exposed as parameters to the URL's handler. Thus, components of an URL's path will automatically be extracted and made available as arguments to the handling code.
Dynamic code reloading: HH-Web automatically monitors specific files for new URL dispatching rules, page template changes, and all taglibraries. Changes in the underlying code is by default automatically reflected the next time the page is refreshed in the browser. The intent is to provide the equivalent usability of other web authoring environments such as PHP or ASP: change the code for a page, and reflect that immediately in the browser.
Integrated caching: HH-Web's support for caching is evolving, but in its current form it permits marking caching guidelines for specific URLs. Specifically, caching causes HH-Web to preseve any generated content (from templates and tags, typically) in an in-memory cache for later use. If a request for a page in its map appear again, then HH-Web will serve the content from the cache, rather than invoking code to regenerate the content fresh.

##Getting Started##

As an aide to starting new projects that use HH-Web to structure web application development, you can load the HH-Web system into the REPL using Quicklisp (included as of 7/3/2012--thanks Zach!):

(ql:quickload :hh-web)

then execute the following expression:

(hh-web:make-skeleton :for :acme :in #p"~/lisp/")

Substitute your own project name for acme in the above expression. Note that the argument to the :for keyword must be a symbol or string, and the argument to the :in keyword must be a directory path (e.g., it must end in "/"), although that directory should not exist, make-skeleton will not overwrite any files or directories that already present--it will raise an error instead. In the above example, the package for your new application will appear as a subdirectory of the one you provided, thus it will appear in ~/lisp/acme/.

If you use Quicklisp and the "~/lisp/" directory is registered with ASDF as a source directory, then you can then run the following at your REPL to start your newly-created web application:

(ql:quickload :acme)
(acme:start-httpd-server)

Now just point your browser at http://localhost:8000, and you should see a boilerplate homepage.

You can stop your application at any time by running the following:

(acme:stop-httpd-server)

Additionally, the generated skeleton of a project also creates a single script called quickrun.lisp that lets you load and run your site in one step. For example, with SBCL:

sbcl --load ~/lisp/acme/quickrun.lisp

Here's the directory structure created for your project:

/acme
  |
  +-- acme.asd			# system declaration
  +-- locales				# directory containing files to support i18n and l10n
  +-- logs.lisp			# helpers for logging using log5
  +-- package.lisp		# package declaration
  +-- quickrun.lisp	# script for loading and running the site
  +-- server.lisp		# runs your site with hunchentoot
  +-- taglibraries		# directory for your tag libraries
  +-- templates			# directory for your templates
  +-- templates.lisp	# file for declaring which templates to use
  +-- urls.lisp			# file containing the regex rules for dispatching requests

To develop your site, edit the following files as needed, and refresh your browser to see changes take effect immediately:

urls.lisp for your request dispatch rules
templates.lisp for the declaring what templates you wish to use
any file in the taglibraries folder for designing your tag or widget libraries
any file in the templates folder for creating your own page templates

The generated skeleton also demonstrates one mechanism for integrating Bootstrap and jQuery into a site, so that the resources of both libraries are always available. Note that the chosen method here may or may not be suitable for your scenario: the skeleton generates links to CDNs that host these libraries to ease other web sites.

Learning More

For more information on how HH-Web works and how to make use of it for your application, see the documentation on the wiki.

2 Systems

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

hh-web

2.1 `hh-web`

Version

0.2

Dependencies

trivial-backtrace (system).
log5 (system).
bordeaux-threads (system).
hunchentoot (system)., at least version "1.2"
drakma (system).
cl-fad (system).
parenscript (system).
cl-ppcre (system).
local-time (system).
vecto (system).
cl-base64 (system).
ironclad (system).
uuid (system).

Source

hh-web.asd.

Child Components

package.lisp (file).
utils.lisp (file).
l10n (module).
logs (module).
useragents.lisp (file).
tags.lisp (file).
taglibraries.lisp (file).
templates.lisp (file).
images.lisp (file).
cookies.lisp (file).
services.lisp (file).
cache.lisp (file).
urls.lisp (file).
documentation.lisp (file).
server.lisp (file).
meta (module).
skeleton.lisp (file).

3 Modules

Modules are listed depth-first from the system components tree.

hh-web/l10n
hh-web/logs
hh-web/meta

3.1 `hh-web/l10n`

Dependency: utils.lisp (file).
Source: hh-web.asd.
Parent Component: hh-web (system).
Child Component: i18n.lisp (file).

3.2 `hh-web/logs`

Dependency

l10n (module).

Source

hh-web.asd.

Parent Component

hh-web (system).

Child Components

outputs.lisp (file).
categories.lisp (file).
rotating.lisp (file).
misc.lisp (file).
hunchentoot.lisp (file).

3.3 `hh-web/meta`

Dependency

server.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Child Components

localeservices.lisp (file).
localehandlers.lisp (file).

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

4.1 Lisp

4.1.1 `hh-web/hh-web.asd`

Source: hh-web.asd.
Parent Component: hh-web (system).
ASDF Systems: hh-web.

4.1.2 `hh-web/package.lisp`

Source

hh-web.asd.

Parent Component

hh-web (system).

Packages

hh-web.
hh-web-asd.

4.1.3 `hh-web/utils.lisp`

Dependency

package.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Internals

bytes-to-string (function).
detokenize (function).
format-string (macro).
generate-base32-uuid-string (function).
generate-long-uuid-string (function).
hash-contents (function).
select (function).
string-starts-with (function).
string-to-bytes (function).
tokenize (function).
uuid-string (function).

4.1.4 `hh-web/l10n/i18n.lisp`

Source

hh-web.asd.

Parent Component

l10n (module).

Public Interface

*locale-package* (special variable).
_ (macro).
deflocale (macro).
get-available-locales (function).
get-localizable-string-notes (function).
get-localizable-strings (function).
get-localization-contexts (function).
get-string-localization (function).
get-string-localization-notes (function).
gettext (function).
init-localization (function).
set-locale (function).
string-localization (class).

Internals

*development-locale-name* (special variable).
*locale* (special variable).
*locales* (special variable).
*localizable-strings* (special variable).
*localization-context* (special variable).
add-localizable-string (function).
add-localization-context (function).
add-string-localization (function).
contexts (reader method).
(setf contexts) (writer method).
create-package-locale (function).
delete-package-locale (function).
description (reader method).
(setf description) (writer method).
get-package-locale-directory (function).
get-package-locales-directory (function).
get-package-string-localization-file (function).
load-available-package-locales (function).
load-string-localizations (function).
locale (reader method).
(setf locale) (writer method).
locale (class).
localizable-string (class).
localization (reader method).
(setf localization) (writer method).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
notes (reader method).
notes (reader method).
(setf notes) (writer method).
(setf notes) (writer method).
save-string-localizations (function).
strings (reader method).
(setf strings) (writer method).

4.1.5 `hh-web/logs/outputs.lisp`

Source: hh-web.asd.
Parent Component: logs (module).

4.1.6 `hh-web/logs/categories.lisp`

Dependency: outputs.lisp (file).
Source: hh-web.asd.
Parent Component: logs (module).

4.1.7 `hh-web/logs/rotating.lisp`

Dependency

categories.lisp (file).

Source

hh-web.asd.

Parent Component

logs (module).

Public Interface

initialize-instance (method).
rotating-log-sender (class).
start-handling (method).

Internals

delete-old-logs (generic function).
last-write (reader method).
(setf last-write) (writer method).
log-interval (reader method).
(setf log-interval) (writer method).
log-interval-expired-p (generic function).
maxlogs (reader method).
(setf maxlogs) (writer method).
next-log-file-name (function).
numbered-file-name (function).
rename-existing-logs (generic function).
rotate-logs (generic function).

4.1.8 `hh-web/logs/misc.lisp`

Dependency: rotating.lisp (file).
Source: hh-web.asd.
Parent Component: logs (module).
Public Interface: use-backtrace-logging (macro).

4.1.9 `hh-web/logs/hunchentoot.lisp`

Dependency

misc.lisp (file).

Source

hh-web.asd.

Parent Component

logs (module).

Public Interface

log-http-access (function).
log-http-message (function).

4.1.10 `hh-web/useragents.lisp`

Dependency

logs (module).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

*enabled-user-agents* (special variable).
*user-agent* (special variable).
*user-agent-strings* (special variable).
enabled-user-agents (macro).

Internals

detect-user-agents (function).
html-for-user-agent (macro).
request-user-agent (function).

4.1.11 `hh-web/tags.lisp`

Dependency

useragents.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

*current-tag* (special variable).
*tag-library* (special variable).
*this-tag* (special variable).
+charset (macro).
+doctype (macro).
+language (macro).
+link (macro).
+title (macro).
body-of (reader method).
(setf body-of) (writer method).
defentity (macro).
defhtmltag (macro).
expansion (macro).
hout (macro).
html (macro).
htmltag (class).
page (macro).
print-object (method).
print-object (method).
render-as-html (generic function).
tag-name (generic function).
(setf tag-name) (writer method).
tags (macro).
with-tag-reader (macro).

Internals

*available-tag-libraries* (special variable).
*default-tag-definition* (special variable).
*html-out* (special variable).
*page-charset* (special variable).
*page-doctype* (special variable).
*page-language* (special variable).
*page-links* (special variable).
*page-ready-scripts* (special variable).
*page-script-libraries* (special variable).
*page-scripts* (special variable).
*page-style-sheets* (special variable).
*page-styles* (special variable).
*page-title* (special variable).
*tag-printing-level* (special variable).
add-tag-to-library (generic function).
default-tag-attributes (function).
expand-expression-with-libraries (generic function).
find-all-tag-attributes (function).
find-next-tag-method (function).
find-tag-attributes (function).
find-tag-definition (function).
find-tag-method (function).
initialize-tag (macro).
putend (macro).
render-tag-attributes (generic function).
render-tag-body (generic function).
render-tag-content (generic function).
render-tag-end (generic function).
render-tag-ready-scripts (generic function).
render-tag-script-libraries (generic function).
render-tag-scripts (generic function).
render-tag-start (generic function).
render-tag-style-sheets (generic function).
render-tag-styles (generic function).
separate-initializer-and-body (function).
set-tag-reader (function).
tag-attribute-map (reader method).
(setf tag-attribute-map) (writer method).
tag-attribute-value (generic function).
(setf tag-attribute-value) (generic function).
tag-attributes (generic function).
(setf tag-attributes) (writer method).
tag-bases (reader method).
(setf tag-bases) (writer method).
tag-content (reader method).
(setf tag-content) (writer method).
tag-definition (reader method).
(setf tag-definition) (writer method).
tag-definition (class).
tag-expansion (generic function).
tag-has-body-p (generic function).
(setf tag-has-body-p) (writer method).
tag-has-end-tag-p (generic function).
(setf tag-has-end-tag-p) (writer method).
tag-indentation-string (function).
tag-init (reader method).
(setf tag-init) (writer method).
tag-library-name-for-tag (generic function).
tag-ready-scripts (reader method).
(setf tag-ready-scripts) (writer method).
tag-script-libraries (reader method).
(setf tag-script-libraries) (writer method).
tag-scripts (reader method).
(setf tag-scripts) (writer method).
tag-separate-initializer-and-body (generic function).
tag-style-sheets (reader method).
(setf tag-style-sheets) (writer method).
tag-styles (reader method).
(setf tag-styles) (writer method).
tag-symbol (reader method).
(setf tag-symbol) (writer method).
union-ordered (macro).

4.1.12 `hh-web/taglibraries.lisp`

Dependency

tags.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

*package-tag-library-folder* (special variable).
*tag-library-provider-registry* (special variable).
create-asdf-system-tag-library-provider (function).
create-folder-tag-library-provider (function).
in-tag-library (macro).
initialize-instance (method).
use-tag-library (function).

Internals

*default-tag-library-folder* (special variable).
*minimum-tag-library-stale-time* (special variable).
add-tag-to-library (method).
expand-expression-with-libraries (method).
find-cached-tag-library (function).
flush-tag-library (function).
folder-of (reader method).
(setf folder-of) (writer method).
folder-tag-library-provider (class).
import-tag-library (function).
library-name (reader method).
load-tag-library (generic function).
load-tag-library-from-provider (generic function).
modified-time-of (reader method).
(setf modified-time-of) (writer method).
provider-tag-library-expiredp (generic function).
putendnew (macro).
read-tag-library (generic function).
tag-libraries-used (reader method).
(setf tag-libraries-used) (writer method).
tag-library (generic function).
tag-library (class).
tag-library-expiredp (generic function).
tag-library-file-modified-time (generic function).
tag-library-full-path (generic function).
tag-library-name (reader method).
tag-library-not-found-error (condition).
tag-library-package (reader method).
(setf tag-library-package) (writer method).
tag-library-provider (reader method).
(setf tag-library-provider) (writer method).
tag-library-provider (class).
tag-library-stalep (generic function).
tag-library-tag-expansions (generic function).
tag-library-tags (reader method).
(setf tag-library-tags) (writer method).

4.1.13 `hh-web/templates.lisp`

Dependency

taglibraries.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

*minimum-template-stale-time* (special variable).
*package-template-folder* (special variable).
*template* (special variable).
*template-provider-registry* (special variable).
+tag-library (function).
create-asdf-system-template-provider (function).
create-folder-template-provider (function).
deftemplate (macro).
deftemplates (macro).
load-templates (function).
local-tag-library-provider-registry-symbol (function).
local-template-provider-registry-symbol (function).
template (class).

Internals

*default-template-folder* (special variable).
*template-cache* (special variable).
asdf-system-provider (class).
definition-of (reader method).
(setf definition-of) (writer method).
file-based-template-provider (class).
find-cached-template (function).
flush-template (function).
folder-of (reader method).
(setf folder-of) (writer method).
folder-template-provider (class).
load-template (generic function).
load-template-definition (function).
load-template-from-provider (generic function).
modified-time-of (reader method).
modified-time-of (reader method).
modified-time-of (reader method).
(setf modified-time-of) (writer method).
(setf modified-time-of) (writer method).
(setf modified-time-of) (writer method).
process-directive (function).
provider-template-expiredp (generic function).
read-template-definition (generic function).
system-of (reader method).
(setf system-of) (writer method).
tag-libraries-used (reader method).
(setf tag-libraries-used) (writer method).
template-args (reader method).
(setf template-args) (writer method).
template-expiredp (generic function).
template-file-modified-time (generic function).
template-full-path (generic function).
template-keyword-args (reader method).
(setf template-keyword-args) (writer method).
template-not-found-error (condition).
template-package (reader method).
(setf template-package) (writer method).
template-path (reader method).
template-path (reader method).
template-provider (reader method).
(setf template-provider) (writer method).
template-provider (class).
template-provider-base-directory (generic function).
template-provider-registry (class).
template-providers-of (reader method).
(setf template-providers-of) (writer method).
template-stalep (generic function).
template-tags-expiredp (generic function).

4.1.14 `hh-web/images.lisp`

Dependency

templates.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

get-package-font (function).
image (macro).

4.1.15 `hh-web/cookies.lisp`

Dependency

images.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

defcookie (macro).
with-cookies (macro).

Internals

cookie-expiry-date (generic function).
cookie-key (generic function).
cookie-variable (generic function).
get-cookie-value (generic function).
set-cookie-value (generic function).

4.1.16 `hh-web/services.lisp`

Dependency

cookies.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

defservice (macro).
defservice-client (macro).
defservice-handler (macro).
http-delete-p (function).
http-get-p (function).
http-post-p (function).
http-put-p (function).
meta-service-request-p (function).
service-client (macro).
with-http-parameters (macro).

Internals

+client-meta-service-request+ (special variable).
+meta-service-request-parameter+ (special variable).
+method-parameter+ (special variable).
generate-service-client-script (generic function).
handle-service-meta-request (generic function).
map-service-method-defs (macro).
map-service-method-handlers (macro).
ps-service-method-client-script (function).
ps-service-method-parameter-list (function).
service-args (generic function).
service-documentation-string (generic function).
service-method-args (generic function).
service-method-cookies (generic function).
service-method-documentation-string (generic function).
service-method-http-method (generic function).
service-method-parameters (generic function).
service-method-test (generic function).
service-methods (generic function).

4.1.17 `hh-web/cache.lisp`

Dependency

services.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

create-file-cache-dispatcher-and-handler (function).
create-file-cache-dispatcher-and-handler-for-root (function).
create-package-file-cache-dispatcher-and-handler (function).
get-cached-item (generic function).
make-fs-cache (function).
make-package-fs-cache (function).

Internals

*minimum-cached-item-stale-time* (special variable).
cache (class).
cache-item (generic function).
cache-key (generic function).
(setf cache-key) (writer method).
cache-loading-enabled (reader method).
(setf cache-loading-enabled) (writer method).
cache-provider (reader method).
(setf cache-provider) (writer method).
cache-provider (class).
cache-provider-key (generic function).
cached-item-expiredp (generic function).
cached-item-invalidp (generic function).
cached-item-stalep (generic function).
content (reader method).
(setf content) (writer method).
content-type (reader method).
(setf content-type) (writer method).
disable-cache-loading (generic function).
enable-cache-loading (generic function).
entries (reader method).
(setf entries) (writer method).
find-cached-item (generic function).
fs-cache-file-full-path (generic function).
fs-cache-file-modified-time (generic function).
fs-cache-item (class).
fs-cache-provider (class).
fs-root (reader method).
(setf fs-root) (writer method).
handle-cached-file (function).
load-and-cache-item (generic function).
load-cache-item-from-provider (generic function).
modified-time-of (generic reader).
(setf modified-time-of) (writer method).

4.1.18 `hh-web/urls.lisp`

Dependency

cache.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

create-package-folder-dispatcher-and-handler (function).
defurl (macro).
defurls (macro).
dispatch-url-cache (function).
flush-url-category (function).
reset-urls (macro).

Internals

*minimum-url-cache-stale-time* (special variable).
*url-cache* (special variable).
cache-key (reader method).
(setf cache-key) (writer method).
cacheable-request-p (function).
cached-item-expiredp (method).
cached-item-invalidp (method).
categories (reader method).
(setf categories) (writer method).
content (reader method).
(setf content) (writer method).
content-for-user-agent (function).
expiry (reader method).
(setf expiry) (writer method).
generator (reader method).
(setf generator) (writer method).
handle-cached-item (function).
handler (reader method).
(setf handler) (writer method).
load-cache-item-from-provider (method).
load-urls (function).
make-url-pattern (function).
make-url-pattern-function-form (function).
modified-time-of (reader method).
modified-time-of (reader method).
(setf modified-time-of) (writer method).
(setf modified-time-of) (writer method).
package-of (reader method).
(setf package-of) (writer method).
parameter-name-p (macro).
patterns (reader method).
(setf patterns) (writer method).
test (reader method).
(setf test) (writer method).
url-cache-item (class).
url-cache-provider (class).
url-pattern-parameter-names (function).
url-pattern-parameter-values (function).
url-pattern-parameters (function).

4.1.19 `hh-web/documentation.lisp`

Dependency

urls.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Internals

*package-tag-library-provider-registry* (special variable).
*package-template-provider-registry* (special variable).
doc-index (function).
generate-package-documentation (function).

4.1.20 `hh-web/server.lisp`

Dependency

documentation.lisp (file).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

acceptor-dispatch-request (method).
acceptor-dispatch-request (method).
create-ssl-server (macro).
create-web-server (macro).
run-web-server (generic function).

Internals

dispatch-table-of (reader method).
dispatch-table-of (reader method).
(setf dispatch-table-of) (writer method).
(setf dispatch-table-of) (writer method).
ssl-server-acceptor (class).
tag-library-provider-registry-of (reader method).
tag-library-provider-registry-of (reader method).
(setf tag-library-provider-registry-of) (writer method).
(setf tag-library-provider-registry-of) (writer method).
template-provider-registry-of (reader method).
template-provider-registry-of (reader method).
(setf template-provider-registry-of) (writer method).
(setf template-provider-registry-of) (writer method).
url-cache-of (reader method).
url-cache-of (reader method).
(setf url-cache-of) (writer method).
(setf url-cache-of) (writer method).
web-server-acceptor (class).

4.1.21 `hh-web/meta/localeservices.lisp`

Source

hh-web.asd.

Parent Component

meta (module).

Internals

generate-service-client-script (method).
service-args (method).
service-documentation-string (method).
service-method-cookies (method).
service-method-cookies (method).
service-method-cookies (method).
service-method-documentation-string (method).
service-method-documentation-string (method).
service-method-documentation-string (method).
service-method-http-method (method).
service-method-http-method (method).
service-method-http-method (method).
service-method-parameters (method).
service-method-parameters (method).
service-method-parameters (method).
service-method-test (method).
service-method-test (method).
service-method-test (method).
service-methods (method).

4.1.22 `hh-web/meta/localehandlers.lisp`

Dependency: localeservices.lisp (file).
Source: hh-web.asd.
Parent Component: meta (module).
Public Interface: locale-service (function).

4.1.23 `hh-web/skeleton.lisp`

Dependency

meta (module).

Source

hh-web.asd.

Parent Component

hh-web (system).

Public Interface

make-skeleton (function).

Internals

for-package (reader method).
(setf for-package) (writer method).
generate-skeleton (generic function).
generate-skeleton-component (generic function).
generate-skeleton-file (function).
in-location (reader method).
(setf in-location) (writer method).
location-pathname (generic function).
skeleton (class).
skeleton-components (generic function).
skeleton-location (generic function).
with-skeleton-file (macro).

5 Packages

Packages are listed by definition order.

hh-web
hh-web-asd

5.1 `hh-web`

Source

package.lisp.

Use List

cl-fad.
cl-ppcre.
common-lisp.
local-time.
trivial-backtrace.
vecto.

Public Interface

*current-tag* (special variable).
*enabled-user-agents* (special variable).
*locale-package* (special variable).
*minimum-template-stale-time* (special variable).
*package-tag-library-folder* (special variable).
*package-template-folder* (special variable).
*tag-library* (special variable).
*tag-library-provider-registry* (special variable).
*template* (special variable).
*template-provider-registry* (special variable).
*this-tag* (special variable).
*user-agent* (special variable).
*user-agent-strings* (special variable).
+charset (macro).
+doctype (macro).
+language (macro).
+link (macro).
+tag-library (function).
+title (macro).
_ (macro).
body-of (generic reader).
(setf body-of) (generic writer).
create-asdf-system-tag-library-provider (function).
create-asdf-system-template-provider (function).
create-file-cache-dispatcher-and-handler (function).
create-file-cache-dispatcher-and-handler-for-root (function).
create-folder-tag-library-provider (function).
create-folder-template-provider (function).
create-package-file-cache-dispatcher-and-handler (function).
create-package-folder-dispatcher-and-handler (function).
create-ssl-server (macro).
create-web-server (macro).
defcookie (macro).
defentity (macro).
defhtmltag (macro).
deflocale (macro).
defservice (macro).
defservice-client (macro).
defservice-handler (macro).
deftemplate (macro).
deftemplates (macro).
defurl (macro).
defurls (macro).
dispatch-url-cache (function).
enabled-user-agents (macro).
expansion (macro).
flush-url-category (function).
get-available-locales (function).
get-cached-item (generic function).
get-localizable-string-notes (function).
get-localizable-strings (function).
get-localization-contexts (function).
get-package-font (function).
get-string-localization (function).
get-string-localization-notes (function).
gettext (function).
hout (macro).
html (macro).
htmltag (class).
http-delete-p (function).
http-get-p (function).
http-post-p (function).
http-put-p (function).
image (macro).
in-tag-library (macro).
init-localization (function).
load-templates (function).
local-tag-library-provider-registry-symbol (function).
local-template-provider-registry-symbol (function).
locale-service (function).
log-http-access (function).
log-http-message (function).
make-fs-cache (function).
make-package-fs-cache (function).
make-skeleton (function).
meta-service-request-p (function).
page (macro).
render-as-html (generic function).
reset-urls (macro).
rotating-log-sender (class).
run-web-server (generic function).
service-client (macro).
set-locale (function).
string-localization (class).
tag-name (generic function).
(setf tag-name) (generic writer).
tags (macro).
template (class).
use-backtrace-logging (macro).
use-tag-library (function).
with-cookies (macro).
with-http-parameters (macro).
with-tag-reader (macro).

Internals

*available-tag-libraries* (special variable).
*default-tag-definition* (special variable).
*default-tag-library-folder* (special variable).
*default-template-folder* (special variable).
*development-locale-name* (special variable).
*html-out* (special variable).
*locale* (special variable).
*locales* (special variable).
*localizable-strings* (special variable).
*localization-context* (special variable).
*minimum-cached-item-stale-time* (special variable).
*minimum-tag-library-stale-time* (special variable).
*minimum-url-cache-stale-time* (special variable).
*package-tag-library-provider-registry* (special variable).
*package-template-provider-registry* (special variable).
*page-charset* (special variable).
*page-doctype* (special variable).
*page-language* (special variable).
*page-links* (special variable).
*page-ready-scripts* (special variable).
*page-script-libraries* (special variable).
*page-scripts* (special variable).
*page-style-sheets* (special variable).
*page-styles* (special variable).
*page-title* (special variable).
*tag-printing-level* (special variable).
*template-cache* (special variable).
*url-cache* (special variable).
+client-meta-service-request+ (special variable).
+meta-service-request-parameter+ (special variable).
+method-parameter+ (special variable).
add-localizable-string (function).
add-localization-context (function).
add-string-localization (function).
add-tag-to-library (generic function).
asdf-system-provider (class).
bytes-to-string (function).
cache (class).
cache-item (generic function).
cache-key (generic function).
(setf cache-key) (generic writer).
cache-loading-enabled (generic reader).
(setf cache-loading-enabled) (generic writer).
cache-provider (generic reader).
(setf cache-provider) (generic writer).
cache-provider (class).
cache-provider-key (generic function).
cacheable-request-p (function).
cached-item-expiredp (generic function).
cached-item-invalidp (generic function).
cached-item-stalep (generic function).
categories (generic reader).
(setf categories) (generic writer).
content (generic reader).
(setf content) (generic writer).
content-for-user-agent (function).
content-type (generic reader).
(setf content-type) (generic writer).
contexts (generic reader).
(setf contexts) (generic writer).
cookie-expiry-date (generic function).
cookie-key (generic function).
cookie-variable (generic function).
create-package-locale (function).
default-tag-attributes (function).
definition-of (generic reader).
(setf definition-of) (generic writer).
delete-old-logs (generic function).
delete-package-locale (function).
description (generic reader).
(setf description) (generic writer).
detect-user-agents (function).
detokenize (function).
disable-cache-loading (generic function).
dispatch-table-of (generic reader).
(setf dispatch-table-of) (generic writer).
doc-index (function).
enable-cache-loading (generic function).
entries (generic reader).
(setf entries) (generic writer).
expand-expression-with-libraries (generic function).
expiry (generic reader).
(setf expiry) (generic writer).
file-based-template-provider (class).
find-all-tag-attributes (function).
find-cached-item (generic function).
find-cached-tag-library (function).
find-cached-template (function).
find-next-tag-method (function).
find-tag-attributes (function).
find-tag-definition (function).
find-tag-method (function).
flush-tag-library (function).
flush-template (function).
folder-of (generic reader).
(setf folder-of) (generic writer).
folder-tag-library-provider (class).
folder-template-provider (class).
for-package (generic reader).
(setf for-package) (generic writer).
format-string (macro).
fs-cache-file-full-path (generic function).
fs-cache-file-modified-time (generic function).
fs-cache-item (class).
fs-cache-provider (class).
fs-root (generic reader).
(setf fs-root) (generic writer).
generate-base32-uuid-string (function).
generate-long-uuid-string (function).
generate-package-documentation (function).
generate-service-client-script (generic function).
generate-skeleton (generic function).
generate-skeleton-component (generic function).
generate-skeleton-file (function).
generator (generic reader).
(setf generator) (generic writer).
get-cookie-value (generic function).
get-package-locale-directory (function).
get-package-locales-directory (function).
get-package-string-localization-file (function).
handle-cached-file (function).
handle-cached-item (function).
handle-service-meta-request (generic function).
handler (generic reader).
(setf handler) (generic writer).
hash-contents (function).
html-for-user-agent (macro).
import-tag-library (function).
in-location (generic reader).
(setf in-location) (generic writer).
initialize-tag (macro).
last-write (generic reader).
(setf last-write) (generic writer).
library-name (generic reader).
load-and-cache-item (generic function).
load-available-package-locales (function).
load-cache-item-from-provider (generic function).
load-string-localizations (function).
load-tag-library (generic function).
load-tag-library-from-provider (generic function).
load-template (generic function).
load-template-definition (function).
load-template-from-provider (generic function).
load-urls (function).
locale (generic reader).
(setf locale) (generic writer).
locale (class).
localizable-string (class).
localization (generic reader).
(setf localization) (generic writer).
location-pathname (generic function).
log-interval (generic reader).
(setf log-interval) (generic writer).
log-interval-expired-p (generic function).
make-url-pattern (function).
make-url-pattern-function-form (function).
map-service-method-defs (macro).
map-service-method-handlers (macro).
maxlogs (generic reader).
(setf maxlogs) (generic writer).
modified-time-of (generic reader).
(setf modified-time-of) (generic writer).
name (generic reader).
(setf name) (generic writer).
next-log-file-name (function).
notes (generic reader).
(setf notes) (generic writer).
numbered-file-name (function).
package-of (generic reader).
(setf package-of) (generic writer).
parameter-name-p (macro).
patterns (generic reader).
(setf patterns) (generic writer).
process-directive (function).
provider-tag-library-expiredp (generic function).
provider-template-expiredp (generic function).
ps-service-method-client-script (function).
ps-service-method-parameter-list (function).
putend (macro).
putendnew (macro).
read-tag-library (generic function).
read-template-definition (generic function).
rename-existing-logs (generic function).
render-tag-attributes (generic function).
render-tag-body (generic function).
render-tag-content (generic function).
render-tag-end (generic function).
render-tag-ready-scripts (generic function).
render-tag-script-libraries (generic function).
render-tag-scripts (generic function).
render-tag-start (generic function).
render-tag-style-sheets (generic function).
render-tag-styles (generic function).
request-user-agent (function).
rotate-logs (generic function).
save-string-localizations (function).
select (function).
separate-initializer-and-body (function).
service-args (generic function).
service-documentation-string (generic function).
service-method-args (generic function).
service-method-cookies (generic function).
service-method-documentation-string (generic function).
service-method-http-method (generic function).
service-method-parameters (generic function).
service-method-test (generic function).
service-methods (generic function).
set-cookie-value (generic function).
set-tag-reader (function).
skeleton (class).
skeleton-components (generic function).
skeleton-location (generic function).
ssl-server-acceptor (class).
string-starts-with (function).
string-to-bytes (function).
strings (generic reader).
(setf strings) (generic writer).
system-of (generic reader).
(setf system-of) (generic writer).
tag-attribute-map (generic reader).
(setf tag-attribute-map) (generic writer).
tag-attribute-value (generic function).
(setf tag-attribute-value) (generic function).
tag-attributes (generic function).
(setf tag-attributes) (generic writer).
tag-bases (generic reader).
(setf tag-bases) (generic writer).
tag-content (generic reader).
(setf tag-content) (generic writer).
tag-definition (generic reader).
(setf tag-definition) (generic writer).
tag-definition (class).
tag-expansion (generic function).
tag-has-body-p (generic function).
(setf tag-has-body-p) (generic writer).
tag-has-end-tag-p (generic function).
(setf tag-has-end-tag-p) (generic writer).
tag-indentation-string (function).
tag-init (generic reader).
(setf tag-init) (generic writer).
tag-libraries-used (generic reader).
(setf tag-libraries-used) (generic writer).
tag-library (generic function).
tag-library (class).
tag-library-expiredp (generic function).
tag-library-file-modified-time (generic function).
tag-library-full-path (generic function).
tag-library-name (generic reader).
tag-library-name-for-tag (generic function).
tag-library-not-found-error (condition).
tag-library-package (generic reader).
(setf tag-library-package) (generic writer).
tag-library-provider (generic reader).
(setf tag-library-provider) (generic writer).
tag-library-provider (class).
tag-library-provider-registry-of (generic reader).
(setf tag-library-provider-registry-of) (generic writer).
tag-library-stalep (generic function).
tag-library-tag-expansions (generic function).
tag-library-tags (generic reader).
(setf tag-library-tags) (generic writer).
tag-ready-scripts (generic reader).
(setf tag-ready-scripts) (generic writer).
tag-script-libraries (generic reader).
(setf tag-script-libraries) (generic writer).
tag-scripts (generic reader).
(setf tag-scripts) (generic writer).
tag-separate-initializer-and-body (generic function).
tag-style-sheets (generic reader).
(setf tag-style-sheets) (generic writer).
tag-styles (generic reader).
(setf tag-styles) (generic writer).
tag-symbol (generic reader).
(setf tag-symbol) (generic writer).
template-args (generic reader).
(setf template-args) (generic writer).
template-expiredp (generic function).
template-file-modified-time (generic function).
template-full-path (generic function).
template-keyword-args (generic reader).
(setf template-keyword-args) (generic writer).
template-not-found-error (condition).
template-package (generic reader).
(setf template-package) (generic writer).
template-path (generic reader).
template-provider (generic reader).
(setf template-provider) (generic writer).
template-provider (class).
template-provider-base-directory (generic function).
template-provider-registry (class).
template-provider-registry-of (generic reader).
(setf template-provider-registry-of) (generic writer).
template-providers-of (generic reader).
(setf template-providers-of) (generic writer).
template-stalep (generic function).
template-tags-expiredp (generic function).
test (generic reader).
(setf test) (generic writer).
tokenize (function).
union-ordered (macro).
url-cache-item (class).
url-cache-of (generic reader).
(setf url-cache-of) (generic writer).
url-cache-provider (class).
url-pattern-parameter-names (function).
url-pattern-parameter-values (function).
url-pattern-parameters (function).
uuid-string (function).
web-server-acceptor (class).
with-skeleton-file (macro).

5.2 `hh-web-asd`

Source

package.lisp.

Use List

asdf/interface.
common-lisp.

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

6.1.1 Special variables

Special Variable: *current-tag* ¶

The current tag under construction (if any), within the scope of a tag’s body

Package: hh-web.
Source: tags.lisp.

Special Variable: *enabled-user-agents* ¶

Package: hh-web.
Source: useragents.lisp.

Special Variable: *locale-package* ¶

Default package containing localization information (locales)

Package: hh-web.
Source: i18n.lisp.

Special Variable: *minimum-template-stale-time* ¶

Minimum time in seconds for which a template must remain stale (e.g. not expire, before reloading from its source

Package: hh-web.
Source: templates.lisp.

Special Variable: *package-tag-library-folder* ¶

Default folder within a package that contains the package’s tag libraries

Package: hh-web.
Source: taglibraries.lisp.

Special Variable: *package-template-folder* ¶

The name of the folder within a package’s folder structure where template files are located

Package: hh-web.
Source: templates.lisp.

Special Variable: *tag-library* ¶

Current tag library to which new tag defintions will belong

Package: hh-web.
Source: tags.lisp.

Special Variable: *tag-library-provider-registry* ¶

A list of functions such that when each is called with 1 argument (a tag name), they return the tag source as a stream or string

Package: hh-web.
Source: taglibraries.lisp.

Special Variable: *template* ¶

While reading a template, this is the current template object for whom a definition is being read

Package: hh-web.
Source: templates.lisp.

Special Variable: *template-provider-registry* ¶

List of template providers, each of which will be called to resolve a template name to locate an appropriate template

Package: hh-web.
Source: templates.lisp.

Special Variable: *this-tag* ¶

The active tag in the scope of a tag method (e.g., while rendering); while rendering a custom tag, *this-tag* will not change within the same method, but *current-tag* changes within the body of each tag in the content

Package: hh-web.
Source: tags.lisp.

Special Variable: *user-agent* ¶

Package: hh-web.
Source: useragents.lisp.

Special Variable: *user-agent-strings* ¶

Package: hh-web.
Source: useragents.lisp.

6.1.2 Macros

Macro: +charset (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: +doctype (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: +language (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: +link (&key rel type href) ¶

Package: hh-web.
Source: tags.lisp.

Macro: +title (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: _ (literal-string) ¶

Should record literal string for reference within the i18n subsystem, and by default return the appropriate string for the current locale

Package: hh-web.
Source: i18n.lisp.

Macro: create-ssl-server ((&rest initialization-args) &key folders packages dispatchers) ¶

Create a ssl server, using the provided initialization arguments for constructing the acceptor.
The acceptor class used internally inherits from hunchentoot’s easy-ssl-acceptor, so initialization arguments
valid for that class are also valid here as well. The initialization arguments need to have the following keyword
arguments with pathnames for values:

* :ssl-certificate-file
* :ssl-privatekey-file

You can also pass the keyword argument with a pathname as a value

* ssl-privatekey-password

In addition to initialization arguments, the following keywords are understood:

* folders : a list of pairs URL -> path mappings, where each points to a filesystem folder for static files
* packages : a list of of pairs of URL -> package mappings, where packages should have a www/ subfolder containing static files * dispatchers: list of additional hunchentoot dispatchers to use, if the server cannot otherwise find a handler for a request after attempting to locate a handler based on provided URL routes

Package: hh-web.
Source: server.lisp.

Macro: create-web-server ((&rest initialization-args) &key folders packages dispatchers) ¶

Create a web server, using the provided initialization arguments for constructing the acceptor.
The acceptor class used internally inherits from hunchentoot’s easy-acceptor, so initialization arguments
valid for that class are also valid here as well.

In addition to initialization arguments, the following keywords are understood:

Package: hh-web.
Source: server.lisp.

Macro: defcookie (name key var expiry-period &optional export) ¶

Package: hh-web.
Source: cookies.lisp.

Macro: defentity (name text &optional documentation) ¶

Defines an entity usable in HTML

Package: hh-web.
Source: tags.lisp.

Macro: defhtmltag (name &key tag bases attributes init hasbody noendtag content script ready style style-sheets script-libraries) ¶

Define a new tag renderable as HTML.

Package: hh-web.
Source: tags.lisp.

Macro: deflocale ((locale) &rest resources) ¶

Package: hh-web.
Source: i18n.lisp.

Macro: defservice (name (&key documentation args) &rest methods) ¶

Defines a service with the specified name, optional documentation, optional args and keyword args (typically extracted from the URL associated with the service), and a set of methods.

If present, args appear as the parameter lists of methods in client script
and are used to construct the path of the request. The intent is
to enable passing of args from the client through the URL
and also to have named registers from the pattern
registered for the service available as well

Package: hh-web.
Source: services.lisp.

Macro: defservice-client (service-name) ¶

Package: hh-web.
Source: services.lisp.

Macro: defservice-handler (service-name &rest method-handlers) ¶

Package: hh-web.
Source: services.lisp.

Macro: deftemplate (name path &key args) ¶

Package: hh-web.
Source: templates.lisp.

Macro: deftemplates (&key tag-library-packages template-packages templates template-folder tag-library-folder) ¶

Package: hh-web.
Source: templates.lisp.

Macro: defurl (pattern &key if handler categories until while) ¶

Package: hh-web.
Source: urls.lisp.

Macro: defurls (&rest urldefs) ¶

Package: hh-web.
Source: urls.lisp.

Macro: enabled-user-agents (&rest user-agents) ¶

Package: hh-web.
Source: useragents.lisp.

Macro: expansion (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: hout (format-string &rest args) ¶

Macro to simplify writing out html to correct stream

Package: hh-web.
Source: tags.lisp.

Macro: html (&rest body) ¶

Interpret the body as html markup, return multiple values, the first of which is an HTML string. The full list of return values is:

$(ul
(li "The intended title of the page containing this HTML fragment")
(li "Link elements that should appear in the head of the page containing this fragment")
(li "Style sheets required by the HTML fragment")
(li "Script libraries required by the HTML fragment")
(li "Sections of Javascript code required by the HTML fragment")
(li "Sections of Javascript code to be run on page initialization that are required by the HTML fragment")
)

Any of these values may be null (including the fragment itself). Care should be taken when nesting calls to this macro, as inline expansion of $$ characters will occur in each invocation of it, and unexpected results may occur.

Package: hh-web.
Source: tags.lisp.

Macro: image ((&key width height) &rest body) ¶

Captures calls to vecto to generate an image

Package: hh-web.
Source: images.lisp.

Macro: in-tag-library (library-name) ¶

All following tag definitions will go into this named library

Package: hh-web.
Source: taglibraries.lisp.

Macro: page (&rest raw-body) ¶

Interpret the raw body as html markup, and return a complete HTML page. In combination with $(a {:href "_macro_html"} "html"), this macro weaves the output of calls to $(em "html") into a complete page, with styles, scripts, references to script libraries, a page title, etc., all arranged in the appropriate order.

Package: hh-web.
Source: tags.lisp.

Macro: reset-urls () ¶

Clear out list of dispatchers; useful to ensures that stale patterns do not survive reload

Package: hh-web.
Source: urls.lisp.

Macro: service-client (service-name) ¶

Package: hh-web.
Source: services.lisp.

Macro: tags (expr) ¶

Package: hh-web.
Source: tags.lisp.

Macro: use-backtrace-logging (&rest body) ¶

Package: hh-web.
Source: misc.lisp.

Macro: with-cookies (&optional cookies &rest body) ¶

Package: hh-web.
Source: cookies.lisp.

Macro: with-http-parameters ((&rest parameter-list) &rest body) ¶

Execute body with the values of provided parameters in indicated variables. The parameter-list should be a list of variable/parameter combinations, where each combination in the list is of the form (variable parameter). The parameter name should be a string, the variable should be a symbol referenced in the body.

Package: hh-web.
Source: services.lisp.

Macro: with-tag-reader (() &rest body) ¶

Package: hh-web.
Source: tags.lisp.

6.1.3 Ordinary functions

Function: +tag-library (library-name) ¶

Find the tag-library (if possible), and import it into the current package (e.g., found by looking at *package* in dynamic environment

Package: hh-web.
Source: templates.lisp.

Function: create-asdf-system-tag-library-provider (system &key folder) ¶

Package: hh-web.
Source: taglibraries.lisp.

Function: create-asdf-system-template-provider (system &key folder) ¶

Package: hh-web.
Source: templates.lisp.

Function: create-file-cache-dispatcher-and-handler (cache &optional uri) ¶

Package: hh-web.
Source: cache.lisp.

Function: create-file-cache-dispatcher-and-handler-for-root (root &key uri populate static) ¶

Return a dispatcher suitable for use with Hunchentoot, dispatching URLs

Package: hh-web.
Source: cache.lisp.

Function: create-folder-tag-library-provider (folder) ¶

Package: hh-web.
Source: taglibraries.lisp.

Function: create-folder-template-provider (folder) ¶

Package: hh-web.
Source: templates.lisp.

Function: create-package-file-cache-dispatcher-and-handler (package &key uri populate static) ¶

Package: hh-web.
Source: cache.lisp.

Function: create-package-folder-dispatcher-and-handler (uri package-name) ¶

Create a dispatcher for all files inside a www subfolder of a package’s directory

Package: hh-web.
Source: urls.lisp.

Function: dispatch-url-cache (*request*) ¶

Package: hh-web.
Source: urls.lisp.

Function: flush-url-category (category) ¶

Package: hh-web.
Source: urls.lisp.

Function: get-available-locales (&optional *locales*) ¶

Package: hh-web.
Source: i18n.lisp.

Function: get-localizable-string-notes (string) ¶

Package: hh-web.
Source: i18n.lisp.

Function: get-localizable-strings (&optional *locale*) ¶

Package: hh-web.
Source: i18n.lisp.

Function: get-localization-contexts (literal-string) ¶

Package: hh-web.
Source: i18n.lisp.

Function: get-package-font (package font) ¶

Package: hh-web.
Source: images.lisp.

Function: get-string-localization (string locale-name) ¶

Package: hh-web.
Source: i18n.lisp.

Function: get-string-localization-notes (string locale-name) ¶

Package: hh-web.
Source: i18n.lisp.

Function: gettext (literal-string &optional *locale*) ¶

Package: hh-web.
Source: i18n.lisp.

Function: http-delete-p (&optional *request*) ¶

Package: hh-web.
Source: services.lisp.

Function: http-get-p (&optional *request*) ¶

Package: hh-web.
Source: services.lisp.

Function: http-post-p (&optional *request*) ¶

Package: hh-web.
Source: services.lisp.

Function: http-put-p (&optional *request*) ¶

Package: hh-web.
Source: services.lisp.

Function: init-localization (locale-package development-locale-name) ¶

Package: hh-web.
Source: i18n.lisp.

Function: load-templates (&optional *template-provider-registry*) ¶

Refresh the list of templates, if necessary

Package: hh-web.
Source: templates.lisp.

Function: local-tag-library-provider-registry-symbol () ¶

Returns a symbol in the current package for storing the tag library provider registry expected by the package

Package: hh-web.
Source: templates.lisp.

Function: local-template-provider-registry-symbol () ¶

Returns a symbol in the current package for storing the template provider registry expected by the package

Package: hh-web.
Source: templates.lisp.

Function: locale-service (&optional *request*) ¶

Service for editing locales usable by the application

Package: hh-web.
Source: localehandlers.lisp.

Function: log-http-access (&key return-code content content-length) ¶

Sends a standardized access log message to the access log with information about the current request and response.

Package: hh-web.
Source: hunchentoot.lisp.

Function: log-http-message (log-level format-string &rest format-arguments) ¶

Sends a formatted message to the file http message log. FORMAT and ARGS are as in FORMAT. LOG-LEVEL is a keyword denoting the log level or NIL in which case it is ignored.

Package: hh-web.
Source: hunchentoot.lisp.

Function: make-fs-cache (root &key populate static) ¶

Create a cache with the indicated root, and if populate is non-nil, preload the cache with all files underneath the root

Package: hh-web.
Source: cache.lisp.

Function: make-package-fs-cache (package &key populate static) ¶

Create a filesystem cache for the www subdirectory of a package

Package: hh-web.
Source: cache.lisp.

Function: make-skeleton (&key for in) ¶

Generate a skeleton for a package in the indicated location;

Package: hh-web.
Source: skeleton.lisp.

Function: meta-service-request-p (&optional *request*) ¶

If there is a _meta parameter present, then regard the request as a ’meta’ request by returning t; otherwise return nil

Package: hh-web.
Source: services.lisp.

Function: set-locale (locale-name) ¶

Package: hh-web.
Source: i18n.lisp.

Function: use-tag-library (library-name) ¶

Add the named tag library to the list of libraries used by the active tag library

Package: hh-web.
Source: taglibraries.lisp.

6.1.4 Generic functions

Generic Reader: body-of (object) ¶

Package

	Index Entry	Section

*
	`available-tag-libraries`:	Private special variables
	`current-tag`:	Public special variables
	`default-tag-definition`:	Private special variables
	`default-tag-library-folder`:	Private special variables
	`default-template-folder`:	Private special variables
	`development-locale-name`:	Private special variables
	`enabled-user-agents`:	Public special variables
	`html-out`:	Private special variables
	`locale`:	Private special variables
	`locale-package`:	Public special variables
	`locales`:	Private special variables
	`localizable-strings`:	Private special variables
	`localization-context`:	Private special variables
	`minimum-cached-item-stale-time`:	Private special variables
	`minimum-tag-library-stale-time`:	Private special variables
	`minimum-template-stale-time`:	Public special variables
	`minimum-url-cache-stale-time`:	Private special variables
	`package-tag-library-folder`:	Public special variables
	`package-tag-library-provider-registry`:	Private special variables
	`package-template-folder`:	Public special variables
	`package-template-provider-registry`:	Private special variables
	`page-charset`:	Private special variables
	`page-doctype`:	Private special variables
	`page-language`:	Private special variables
	`page-links`:	Private special variables
	`page-ready-scripts`:	Private special variables
	`page-script-libraries`:	Private special variables
	`page-scripts`:	Private special variables
	`page-style-sheets`:	Private special variables
	`page-styles`:	Private special variables
	`page-title`:	Private special variables
	`tag-library`:	Public special variables
	`tag-library-provider-registry`:	Public special variables
	`tag-printing-level`:	Private special variables
	`template`:	Public special variables
	`template-cache`:	Private special variables
	`template-provider-registry`:	Public special variables
	`this-tag`:	Public special variables
	`url-cache`:	Private special variables
	`user-agent`:	Public special variables
	`user-agent-strings`:	Public special variables

+
	`+client-meta-service-request+`:	Private special variables
	`+meta-service-request-parameter+`:	Private special variables
	`+method-parameter+`:	Private special variables

_
	`_attribute-map`:	Public classes
	`_body`:	Public classes
	`_definition`:	Public classes

A
	`args`:	Public classes
	`attributes`:	Private classes

B
	`bases`:	Private classes

C
	`categories`:	Private classes
	`content`:	Private classes
	`content`:	Private classes
	`content`:	Private classes
	`content-type`:	Private classes
	`contexts`:	Private classes

D
	`definition`:	Public classes
	`description`:	Private classes
	`dispatch-table`:	Private classes
	`dispatch-table`:	Private classes

E
	`entries`:	Private classes
	`expiry`:	Private classes

F
	`folder`:	Private classes
	`folder`:	Private classes
	`folder`:	Private classes

G
	`generator`:	Private classes

H
	`handler`:	Private classes
	`has-body`:	Private classes
	`has-end-tag`:	Private classes

I
	`init`:	Private classes
	`interval`:	Public classes

K
	`kwargs`:	Public classes

L
	`last-write`:	Public classes
	`libraries`:	Public classes
	`libraries`:	Private classes
	`library-name`:	Private conditions
	`loading-enabled`:	Private classes
	`locale`:	Public classes
	`localization`:	Public classes
	`location`:	Private classes

M
	`maxlogs`:	Public classes
	`modified-time`:	Public classes
	`modified-time`:	Private classes
	`modified-time`:	Private classes
	`modified-time`:	Private classes
	`modified-time`:	Private classes
	`modified-time`:	Private classes
	`modified-time`:	Private classes

N
	`name`:	Public classes
	`name`:	Private classes
	`name`:	Private classes
	`name`:	Private classes
	`name`:	Private classes
	`notes`:	Public classes
	`notes`:	Private classes

P
	`package`:	Public classes
	`package`:	Private classes
	`package`:	Private classes
	`package`:	Private classes
	`path`:	Public classes
	`path`:	Private classes
	`path`:	Private classes
	`patterns`:	Private classes
	`provider`:	Public classes
	`provider`:	Private classes
	`provider`:	Private classes

R
	`ready-scripts`:	Private classes
	`root`:	Private classes

S
	`script-libraries`:	Private classes
	`scripts`:	Private classes
	`Slot, args`:	Public classes
	`Slot, attributes`:	Private classes
	`Slot, bases`:	Private classes
	`Slot, categories`:	Private classes
	`Slot, content`:	Private classes
	`Slot, content`:	Private classes
	`Slot, content`:	Private classes
	`Slot, content-type`:	Private classes
	`Slot, contexts`:	Private classes
	`Slot, definition`:	Public classes
	`Slot, description`:	Private classes
	`Slot, dispatch-table`:	Private classes
	`Slot, dispatch-table`:	Private classes
	`Slot, entries`:	Private classes
	`Slot, expiry`:	Private classes
	`Slot, folder`:	Private classes
	`Slot, folder`:	Private classes
	`Slot, folder`:	Private classes
	`Slot, generator`:	Private classes
	`Slot, handler`:	Private classes
	`Slot, has-body`:	Private classes
	`Slot, has-end-tag`:	Private classes
	`Slot, init`:	Private classes
	`Slot, interval`:	Public classes
	`Slot, kwargs`:	Public classes
	`Slot, last-write`:	Public classes
	`Slot, libraries`:	Public classes
	`Slot, libraries`:	Private classes
	`Slot, library-name`:	Private conditions
	`Slot, loading-enabled`:	Private classes
	`Slot, locale`:	Public classes
	`Slot, localization`:	Public classes
	`Slot, location`:	Private classes
	`Slot, maxlogs`:	Public classes
	`Slot, modified-time`:	Public classes
	`Slot, modified-time`:	Private classes
	`Slot, modified-time`:	Private classes
	`Slot, modified-time`:	Private classes
	`Slot, modified-time`:	Private classes
	`Slot, modified-time`:	Private classes
	`Slot, modified-time`:	Private classes
	`Slot, name`:	Public classes
	`Slot, name`:	Private classes
	`Slot, name`:	Private classes
	`Slot, name`:	Private classes
	`Slot, name`:	Private classes
	`Slot, notes`:	Public classes
	`Slot, notes`:	Private classes
	`Slot, package`:	Public classes
	`Slot, package`:	Private classes
	`Slot, package`:	Private classes
	`Slot, package`:	Private classes
	`Slot, path`:	Public classes
	`Slot, path`:	Private classes
	`Slot, path`:	Private classes
	`Slot, patterns`:	Private classes
	`Slot, provider`:	Public classes
	`Slot, provider`:	Private classes
	`Slot, provider`:	Private classes
	`Slot, ready-scripts`:	Private classes
	`Slot, root`:	Private classes
	`Slot, script-libraries`:	Private classes
	`Slot, scripts`:	Private classes
	`Slot, strings`:	Private classes
	`Slot, style-sheets`:	Private classes
	`Slot, styles`:	Private classes
	`Slot, symbol`:	Private classes
	`Slot, system`:	Private classes
	`Slot, tag-library-provider-registry`:	Private classes
	`Slot, tag-library-provider-registry`:	Private classes
	`Slot, tags`:	Private classes
	`Slot, template-path`:	Private conditions
	`Slot, template-provider-registry`:	Private classes
	`Slot, template-provider-registry`:	Private classes
	`Slot, template-providers`:	Private classes
	`Slot, test`:	Private classes
	`Slot, url-cache`:	Private classes
	`Slot, url-cache`:	Private classes
	`Slot, _attribute-map`:	Public classes
	`Slot, _body`:	Public classes
	`Slot, _definition`:	Public classes
	`Special Variable, available-tag-libraries`:	Private special variables
	`Special Variable, current-tag`:	Public special variables
	`Special Variable, default-tag-definition`:	Private special variables
	`Special Variable, default-tag-library-folder`:	Private special variables
	`Special Variable, default-template-folder`:	Private special variables
	`Special Variable, development-locale-name`:	Private special variables
	`Special Variable, enabled-user-agents`:	Public special variables
	`Special Variable, html-out`:	Private special variables
	`Special Variable, locale`:	Private special variables
	`Special Variable, locale-package`:	Public special variables
	`Special Variable, locales`:	Private special variables
	`Special Variable, localizable-strings`:	Private special variables
	`Special Variable, localization-context`:	Private special variables

The hh-web Reference Manual

The hh-web Reference Manual

Table of Contents

1 Introduction

Learning More

2 Systems

2.1 hh-web

3 Modules

3.1 hh-web/l10n

3.2 hh-web/logs

3.3 hh-web/meta

4 Files

4.1 Lisp

4.1.1 hh-web/hh-web.asd

4.1.2 hh-web/package.lisp

4.1.3 hh-web/utils.lisp

4.1.4 hh-web/l10n/i18n.lisp

4.1.5 hh-web/logs/outputs.lisp

4.1.6 hh-web/logs/categories.lisp

4.1.7 hh-web/logs/rotating.lisp

4.1.8 hh-web/logs/misc.lisp

4.1.9 hh-web/logs/hunchentoot.lisp

4.1.10 hh-web/useragents.lisp

4.1.11 hh-web/tags.lisp

4.1.12 hh-web/taglibraries.lisp

4.1.13 hh-web/templates.lisp

4.1.14 hh-web/images.lisp

4.1.15 hh-web/cookies.lisp

4.1.16 hh-web/services.lisp

4.1.17 hh-web/cache.lisp

4.1.18 hh-web/urls.lisp

4.1.19 hh-web/documentation.lisp

4.1.20 hh-web/server.lisp

4.1.21 hh-web/meta/localeservices.lisp

4.1.22 hh-web/meta/localehandlers.lisp

4.1.23 hh-web/skeleton.lisp

5 Packages

5.1 hh-web

5.2 hh-web-asd

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.1.4 Generic functions

6.1.5 Standalone methods

6.1.6 Classes

6.2 Internals

6.2.1 Special variables

6.2.2 Macros

6.2.3 Ordinary functions

6.2.4 Generic functions

6.2.5 Conditions

6.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

2.1 `hh-web`

3.1 `hh-web/l10n`

3.2 `hh-web/logs`

3.3 `hh-web/meta`

4.1.1 `hh-web/hh-web.asd`

4.1.2 `hh-web/package.lisp`

4.1.3 `hh-web/utils.lisp`

4.1.4 `hh-web/l10n/i18n.lisp`

4.1.5 `hh-web/logs/outputs.lisp`

4.1.6 `hh-web/logs/categories.lisp`

4.1.7 `hh-web/logs/rotating.lisp`

4.1.8 `hh-web/logs/misc.lisp`

4.1.9 `hh-web/logs/hunchentoot.lisp`

4.1.10 `hh-web/useragents.lisp`

4.1.11 `hh-web/tags.lisp`

4.1.12 `hh-web/taglibraries.lisp`

4.1.13 `hh-web/templates.lisp`

4.1.14 `hh-web/images.lisp`

4.1.15 `hh-web/cookies.lisp`

4.1.16 `hh-web/services.lisp`

4.1.17 `hh-web/cache.lisp`

4.1.18 `hh-web/urls.lisp`

4.1.19 `hh-web/documentation.lisp`

4.1.20 `hh-web/server.lisp`

4.1.21 `hh-web/meta/localeservices.lisp`

4.1.22 `hh-web/meta/localehandlers.lisp`

4.1.23 `hh-web/skeleton.lisp`

5.1 `hh-web`

5.2 `hh-web-asd`