The hh-web Reference Manual

Table of Contents

The hh-web Reference Manual

This is the hh-web Reference Manual, version 0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:56:39 2018 GMT+0.

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.

2.1 hh-web

Version

0.2

Dependencies

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

Source

hh-web.asd (file)

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.

3.1 hh-web/l10n

Dependency

utils.lisp (file)

Parent

hh-web (system)

Location

l10n/

Component

i18n.lisp (file)

3.2 hh-web/logs

Dependency

l10n (module)

Parent

hh-web (system)

Location

logs/

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)

Parent

hh-web (system)

Location

meta/

Components

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

4 Files

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

4.1 Lisp

4.1.1 hh-web.asd

Location

hh-web.asd

Systems

hh-web (system)

4.1.2 hh-web/package.lisp

Parent

hh-web (system)

Location

package.lisp

Packages

• hh-web
• hh-web-asd

4.1.3 hh-web/utils.lisp

Dependency

package.lisp (file)

Parent

hh-web (system)

Location

utils.lisp

Internal Definitions

• 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

Parent

l10n (module)

Location

l10n/i18n.lisp

Exported Definitions

• *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)

Internal Definitions

• *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 (method)
• (setf contexts) (method)
• create-package-locale (function)
• delete-package-locale (function)
• description (method)
• (setf description) (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 (method)
• (setf locale) (method)
• locale (class)
• localizable-string (class)
• localization (method)
• (setf localization) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• notes (method)
• (setf notes) (method)
• notes (method)
• (setf notes) (method)
• save-string-localizations (function)
• strings (method)
• (setf strings) (method)

4.1.5 hh-web/logs/outputs.lisp

Parent

logs (module)

Location

logs/outputs.lisp

4.1.6 hh-web/logs/categories.lisp

Dependency

outputs.lisp (file)

Parent

logs (module)

Location

logs/categories.lisp

4.1.7 hh-web/logs/rotating.lisp

Dependency

categories.lisp (file)

Parent

logs (module)

Location

logs/rotating.lisp

Exported Definitions

rotating-log-sender (class)

Internal Definitions

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

4.1.8 hh-web/logs/misc.lisp

Dependency

rotating.lisp (file)

Parent

logs (module)

Location

logs/misc.lisp

Exported Definitions

use-backtrace-logging (macro)

4.1.9 hh-web/logs/hunchentoot.lisp

Dependency

misc.lisp (file)

Parent

logs (module)

Location

logs/hunchentoot.lisp

Exported Definitions

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

4.1.10 hh-web/useragents.lisp

Dependency

logs (module)

Parent

hh-web (system)

Location

useragents.lisp

Exported Definitions

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

Internal Definitions

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

4.1.11 hh-web/tags.lisp

Dependency

useragents.lisp (file)

Parent

hh-web (system)

Location

tags.lisp

Exported Definitions

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

Internal Definitions

• *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-attributes (method)
• render-tag-body (generic function)
• render-tag-body (method)
• render-tag-content (generic function)
• render-tag-content (method)
• render-tag-end (generic function)
• render-tag-end (method)
• render-tag-ready-scripts (generic function)
• render-tag-ready-scripts (method)
• render-tag-ready-scripts (method)
• render-tag-script-libraries (generic function)
• render-tag-script-libraries (method)
• render-tag-script-libraries (method)
• render-tag-scripts (generic function)
• render-tag-scripts (method)
• render-tag-scripts (method)
• render-tag-start (generic function)
• render-tag-start (method)
• render-tag-style-sheets (generic function)
• render-tag-style-sheets (method)
• render-tag-style-sheets (method)
• render-tag-styles (generic function)
• render-tag-styles (method)
• render-tag-styles (method)
• separate-initializer-and-body (function)
• set-tag-reader (function)
• tag-attribute-map (method)
• (setf tag-attribute-map) (method)
• tag-attribute-value (generic function)
• tag-attribute-value (method)
• (setf tag-attribute-value) (method)
• tag-attribute-value (method)
• (setf tag-attribute-value) (method)
• (setf tag-attribute-value) (generic function)
• tag-attributes (generic function)
• tag-attributes (method)
• tag-attributes (method)
• (setf tag-attributes) (method)
• tag-bases (method)
• (setf tag-bases) (method)
• tag-content (method)
• (setf tag-content) (method)
• tag-definition (method)
• (setf tag-definition) (method)
• tag-definition (class)
• tag-expansion (generic function)
• tag-expansion (method)
• tag-has-body-p (generic function)
• tag-has-body-p (method)
• tag-has-body-p (method)
• (setf tag-has-body-p) (method)
• tag-has-end-tag-p (generic function)
• tag-has-end-tag-p (method)
• tag-has-end-tag-p (method)
• (setf tag-has-end-tag-p) (method)
• tag-indentation-string (function)
• tag-init (method)
• (setf tag-init) (method)
• tag-library-name-for-tag (generic function)
• tag-library-name-for-tag (method)
• tag-ready-scripts (method)
• (setf tag-ready-scripts) (method)
• tag-script-libraries (method)
• (setf tag-script-libraries) (method)
• tag-scripts (method)
• (setf tag-scripts) (method)
• tag-separate-initializer-and-body (generic function)
• tag-separate-initializer-and-body (method)
• tag-style-sheets (method)
• (setf tag-style-sheets) (method)
• tag-styles (method)
• (setf tag-styles) (method)
• tag-symbol (method)
• (setf tag-symbol) (method)
• union-ordered (macro)

4.1.12 hh-web/taglibraries.lisp

Dependency

tags.lisp (file)

Parent

hh-web (system)

Location

taglibraries.lisp

Exported Definitions

• *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)
• use-tag-library (function)

Internal Definitions

• *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 (method)
• (setf folder-of) (method)
• folder-tag-library-provider (class)
• import-tag-library (function)
• library-name (method)
• load-tag-library (generic function)
• load-tag-library (method)
• load-tag-library-from-provider (generic function)
• load-tag-library-from-provider (method)
• modified-time-of (method)
• (setf modified-time-of) (method)
• provider-tag-library-expiredp (generic function)
• provider-tag-library-expiredp (method)
• provider-tag-library-expiredp (method)
• putendnew (macro)
• read-tag-library (generic function)
• read-tag-library (method)
• read-tag-library (method)
• tag-libraries-used (method)
• (setf tag-libraries-used) (method)
• tag-library (generic function)
• tag-library (method)
• tag-library (class)
• tag-library-expiredp (generic function)
• tag-library-expiredp (method)
• tag-library-file-modified-time (generic function)
• tag-library-file-modified-time (method)
• tag-library-full-path (generic function)
• tag-library-full-path (method)
• tag-library-name (method)
• tag-library-not-found-error (condition)
• tag-library-package (method)
• (setf tag-library-package) (method)
• tag-library-provider (method)
• (setf tag-library-provider) (method)
• tag-library-provider (class)
• tag-library-stalep (generic function)
• tag-library-stalep (method)
• tag-library-tag-expansions (generic function)
• tag-library-tag-expansions (method)
• tag-library-tag-expansions (method)
• tag-library-tag-expansions (method)
• tag-library-tag-expansions (method)
• tag-library-tags (method)
• (setf tag-library-tags) (method)

4.1.13 hh-web/templates.lisp

Dependency

taglibraries.lisp (file)

Parent

hh-web (system)

Location

templates.lisp

Exported Definitions

• *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)

Internal Definitions

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

4.1.14 hh-web/images.lisp

Dependency

templates.lisp (file)

Parent

hh-web (system)

Location

images.lisp

Exported Definitions

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

4.1.15 hh-web/cookies.lisp

Dependency

images.lisp (file)

Parent

hh-web (system)

Location

cookies.lisp

Exported Definitions

• defcookie (macro)
• with-cookies (macro)

Internal Definitions

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

4.1.16 hh-web/services.lisp

Dependency

cookies.lisp (file)

Parent

hh-web (system)

Location

services.lisp

Exported Definitions

• 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)

Internal Definitions

• +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)
• handle-service-meta-request (method)
• handle-service-meta-request (method)
• handle-service-meta-request (method)
• 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)

Parent

hh-web (system)

Location

cache.lisp

Exported Definitions

• 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)
• get-cached-item (method)
• make-fs-cache (function)
• make-package-fs-cache (function)

Internal Definitions

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

4.1.18 hh-web/urls.lisp

Dependency

cache.lisp (file)

Parent

hh-web (system)

Location

urls.lisp

Exported Definitions

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

Internal Definitions

• *minimum-url-cache-stale-time* (special variable)
• *url-cache* (special variable)
• cache-key (method)
• (setf cache-key) (method)
• cacheable-request-p (function)
• cached-item-expiredp (method)
• cached-item-invalidp (method)
• categories (method)
• (setf categories) (method)
• content (method)
• (setf content) (method)
• content-for-user-agent (function)
• expiry (method)
• (setf expiry) (method)
• generator (method)
• (setf generator) (method)
• handle-cached-item (function)
• handler (method)
• (setf handler) (method)
• load-cache-item-from-provider (method)
• load-urls (function)
• make-url-pattern (function)
• make-url-pattern-function-form (function)
• modified-time-of (method)
• modified-time-of (method)
• (setf modified-time-of) (method)
• (setf modified-time-of) (method)
• package-of (method)
• (setf package-of) (method)
• parameter-name-p (macro)
• patterns (method)
• (setf patterns) (method)
• test (method)
• (setf test) (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)

Parent

hh-web (system)

Location

documentation.lisp

Internal Definitions

• *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)

Parent

hh-web (system)

Location

server.lisp

Exported Definitions

• create-ssl-server (macro)
• create-web-server (macro)
• run-web-server (generic function)
• run-web-server (method)
• run-web-server (method)

Internal Definitions

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

4.1.21 hh-web/meta/localeservices.lisp

Parent

meta (module)

Location

meta/localeservices.lisp

Internal Definitions

• 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)

Parent

meta (module)

Location

meta/localehandlers.lisp

Exported Definitions

locale-service (function)

4.1.23 hh-web/skeleton.lisp

Dependency

meta (module)

Parent

hh-web (system)

Location

skeleton.lisp

Exported Definitions

make-skeleton (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 hh-web

Source

package.lisp (file)

Use List

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

Exported Definitions

• *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 function)
• body-of (method)
• (setf body-of) (method)
• (setf body-of) (generic function)
• 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-cached-item (method)
• 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)
• render-as-html (method)
• render-as-html (method)
• render-as-html (method)
• render-as-html (method)
• render-as-html (method)
• reset-urls (macro)
• rotating-log-sender (class)
• run-web-server (generic function)
• run-web-server (method)
• run-web-server (method)
• service-client (macro)
• set-locale (function)
• string-localization (class)
• tag-name (generic function)
• tag-name (method)
• tag-name (method)
• (setf tag-name) (generic function)
• (setf tag-name) (method)
• tags (macro)
• template (class)
• use-backtrace-logging (macro)
• use-tag-library (function)
• with-cookies (macro)
• with-http-parameters (macro)
• with-tag-reader (macro)

Internal Definitions

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

Use List

• asdf/interface
• common-lisp

6 Definitions

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

6.1 Exported definitions

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 (file)

Special Variable: *enabled-user-agents*

Package

hh-web

Source

useragents.lisp (file)

Special Variable: *locale-package*

Default package containing localization information (locales)

Package

hh-web

Source

i18n.lisp (file)

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 (file)

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

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

Package

hh-web

Source

taglibraries.lisp (file)

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 (file)

Special Variable: *tag-library*

Current tag library to which new tag defintions will belong

Package

hh-web

Source

tags.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Special Variable: *user-agent*

Package

hh-web

Source

useragents.lisp (file)

Special Variable: *user-agent-strings*

Package

hh-web

Source

useragents.lisp (file)

6.1.2 Macros

Macro: +charset EXPR

Package

hh-web

Source

tags.lisp (file)

Macro: +doctype EXPR

Package

hh-web

Source

tags.lisp (file)

Macro: +language EXPR

Package

hh-web

Source

tags.lisp (file)

Macro: +link &key (REL REL) (TYPE TYPE) (HREF HREF)

Package

hh-web

Source

tags.lisp (file)

Macro: +title EXPR

Package

hh-web

Source

tags.lisp (file)

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 (file)

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 (file)

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:

* 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 (file)

Macro: defcookie NAME KEY VAR EXPIRY-PERIOD &optional EXPORT

Package

hh-web

Source

cookies.lisp (file)

Macro: defentity NAME TEXT &optional DOCUMENTATION

Defines an entity usable in HTML

Package

hh-web

Source

tags.lisp (file)

Macro: defhtmltag NAME &key (TAG TAG) (BASES BASES) (ATTRIBUTES ATTRIBUTES) (INIT INIT) (HASBODY HASBODY) (NOENDTAG NOENDTAG) (CONTENT CONTENT) (SCRIPT SCRIPT) (READY READY) (STYLE STYLE) (STYLE-SHEETS STYLE-SHEETS) (SCRIPT-LIBRARIES SCRIPT-LIBRARIES)

Define a new tag renderable as HTML.

Package

hh-web

Source

tags.lisp (file)

Macro: deflocale (LOCALE) &rest RESOURCES

Package

hh-web

Source

i18n.lisp (file)

Macro: defservice NAME (&key (DOCUMENTATION DOCUMENTATION) (ARGS SERVICE-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 (file)

Macro: defservice-client SERVICE-NAME

Package

hh-web

Source

services.lisp (file)

Macro: defservice-handler SERVICE-NAME &rest METHOD-HANDLERS

Package

hh-web

Source

services.lisp (file)

Macro: deftemplate NAME PATH &key (ARGS TEMPLATE-ARGS)

Package

hh-web

Source

templates.lisp (file)

Macro: deftemplates &key (TAG-LIBRARY-PACKAGES TAG-LIBRARY-PACKAGES) (TEMPLATE-PACKAGES TEMPLATE-PACKAGES) (TEMPLATES TEMPLATES) (TEMPLATE-FOLDER DEFAULT-TEMPLATE-FOLDER) (TAG-LIBRARY-FOLDER DEFAULT-TAG-LIBRARY-FOLDER)

Package

hh-web

Source

templates.lisp (file)

Macro: defurl PATTERN &key (IF DISPATCH-TEST) (HANDLER HANDLER) (CATEGORIES CATEGORIES) (UNTIL CACHE-UNTIL) (WHILE CACHE-WHILE)

Package

hh-web

Source

urls.lisp (file)

Macro: defurls &rest URLDEFS

Package

hh-web

Source

urls.lisp (file)

Macro: enabled-user-agents &rest USER-AGENTS

Package

hh-web

Source

useragents.lisp (file)

Macro: expansion EXPR

Package

hh-web

Source

tags.lisp (file)

Macro: hout FORMAT-STRING &rest ARGS

Macro to simplify writing out html to correct stream

Package

hh-web

Source

tags.lisp (file)

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 (file)

Macro: image (&key WIDTH HEIGHT) &rest BODY

Captures calls to vecto to generate an image

Package

hh-web

Source

images.lisp (file)

Macro: in-tag-library LIBRARY-NAME

All following tag definitions will go into this named library

Package

hh-web

Source

taglibraries.lisp (file)

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 (file)

Macro: reset-urls ()

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

Package

hh-web

Source

urls.lisp (file)

Macro: service-client SERVICE-NAME

Package

hh-web

Source

services.lisp (file)

Macro: tags EXPR

Package

hh-web

Source

tags.lisp (file)

Macro: use-backtrace-logging &rest BODY

Package

hh-web

Source

misc.lisp (file)

Macro: with-cookies &optional COOKIES &rest BODY

Package

hh-web

Source

cookies.lisp (file)

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 (file)

Macro: with-tag-reader () &rest BODY

Package

hh-web

Source

tags.lisp (file)

6.1.3 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 (file)

Function: create-asdf-system-tag-library-provider SYSTEM &key (FOLDER *PACKAGE-TAG-LIBRARY-FOLDER*)

Package

hh-web

Source

taglibraries.lisp (file)

Function: create-asdf-system-template-provider SYSTEM &key (FOLDER FOLDER)

Package

hh-web

Source

templates.lisp (file)

Function: create-file-cache-dispatcher-and-handler CACHE &optional URI

Package

hh-web

Source

cache.lisp (file)

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 (file)

Function: create-folder-tag-library-provider FOLDER

Package

hh-web

Source

taglibraries.lisp (file)

Function: create-folder-template-provider FOLDER

Package

hh-web

Source

templates.lisp (file)

Function: create-package-file-cache-dispatcher-and-handler PACKAGE &key URI POPULATE STATIC

Package

hh-web

Source

cache.lisp (file)

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 (file)

Function: dispatch-url-cache *REQUEST*

Package

hh-web

Source

urls.lisp (file)

Function: flush-url-category CATEGORY

Package

hh-web

Source

urls.lisp (file)

Function: get-available-locales &optional *LOCALES*

Package

hh-web

Source

i18n.lisp (file)

Function: get-localizable-string-notes STRING

Package

hh-web

Source

i18n.lisp (file)

Function: get-localizable-strings &optional *LOCALE*

Package

hh-web

Source

i18n.lisp (file)

Function: get-localization-contexts LITERAL-STRING

Package

hh-web

Source

i18n.lisp (file)

Function: get-package-font PACKAGE FONT

Package

hh-web

Source

images.lisp (file)

Function: get-string-localization STRING LOCALE-NAME

Package

hh-web

Source

i18n.lisp (file)

Function: get-string-localization-notes STRING LOCALE-NAME

Package

hh-web

Source

i18n.lisp (file)

Function: gettext LITERAL-STRING &optional *LOCALE*

Package

hh-web

Source

i18n.lisp (file)

Function: http-delete-p &optional *REQUEST*

Package

hh-web

Source

services.lisp (file)

Function: http-get-p &optional *REQUEST*

Package

hh-web

Source

services.lisp (file)

Function: http-post-p &optional *REQUEST*

Package

hh-web

Source

services.lisp (file)

Function: http-put-p &optional *REQUEST*

Package

hh-web

Source

services.lisp (file)

Function: init-localization LOCALE-PACKAGE DEVELOPMENT-LOCALE-NAME

Package

hh-web

Source

i18n.lisp (file)

Function: load-templates &optional *TEMPLATE-PROVIDER-REGISTRY*

Refresh the list of templates, if necessary

Package

hh-web

Source

templates.lisp (file)

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 (file)

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 (file)

Function: locale-service &optional *REQUEST*

Service for editing locales usable by the application

Package

hh-web

Source

localehandlers.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: make-skeleton &key FOR IN

Generate a skeleton for a package in the indicated location;

Package

hh-web

Source

skeleton.lisp (file)

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 (file)

Function: set-locale LOCALE-NAME

Package

hh-web

Source

i18n.lisp (file)

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 (file)

6.1.4 Generic functions

Generic Function: body-of OBJECT

Generic Function: (setf body-of) NEW-VALUE OBJECT

Package

hh-web

Methods

Method: body-of (HTMLTAG htmltag)

automatically generated reader method

Source

tags.lisp (file)

Method: (setf body-of) NEW-VALUE (HTMLTAG htmltag)

automatically generated writer method

Source

tags.lisp (file)

Generic Function: get-cached-item CACHE REQUEST

Obtain a cached item, regardless of whether the item is in the cache or must be loaded from the provider

Package

hh-web

Source

cache.lisp (file)

Methods

Method: get-cached-item (CACHE cache) REQUEST

Generic Function: render-as-html SOME-EXPR

Return some expression as an HTML string

Package

hh-web

Source

tags.lisp (file)

Methods

Method: render-as-html (SOME-LIST list)

Method: render-as-html SOME-EXPR

Method: render-as-html (SOME-EXPR string)

Method: render-as-html TAG around

Method: render-as-html (*CURRENT-TAG* htmltag)

Generic Function: run-web-server SERVER-ACCEPTOR &key WAIT

Package

hh-web

Source

server.lisp (file)

Methods

Method: run-web-server (SERVER-ACCEPTOR ssl-server-acceptor) &key WAIT

Method: run-web-server (SERVER-ACCEPTOR web-server-acceptor) &key WAIT

Generic Function: tag-name *CURRENT-TAG*

Return the name of the tag as a string used for rendering in html

Package

hh-web

Source

tags.lisp (file)

Writer

(setf tag-name) (generic function)

Methods

Method: tag-name (*CURRENT-TAG* htmltag)

Method: tag-name (TAG-DEFINITION tag-definition)

The tag name is the string used in the start tag when rendering to HTML

Generic Function: (setf tag-name) NEW-VALUE OBJECT

Package

hh-web

Reader

tag-name (generic function)

Methods

Method: (setf tag-name) NEW-VALUE (TAG-DEFINITION tag-definition)

The tag name is the string used in the start tag when rendering to HTML

Source

tags.lisp (file)

6.1.5 Classes

Class: htmltag ()

Package

hh-web

Source

tags.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• render-tag-content (method)
• render-tag-end (method)
• render-tag-body (method)
• render-tag-attributes (method)
• render-tag-start (method)
• render-as-html (method)
• tag-has-end-tag-p (method)
• render-tag-style-sheets (method)
• render-tag-styles (method)
• render-tag-script-libraries (method)
• render-tag-ready-scripts (method)
• render-tag-scripts (method)
• tag-attribute-value (method)
• tag-attribute-value (method)
• tag-attribute-value (method)
• tag-attribute-value (method)
• tag-attributes (method)
• tag-library-name-for-tag (method)
• tag-name (method)
• body-of (method)
• body-of (method)
• tag-attribute-map (method)
• tag-attribute-map (method)
• tag-definition (method)
• tag-definition (method)

Direct slots

Slot: _definition

Initargs

:definition

Readers

tag-definition (generic function)

Writers

(setf tag-definition) (generic function)

Slot: _attribute-map

Initargs

:attribute-map

Initform

(make-hash-table :test (function equal))

Readers

tag-attribute-map (generic function)

Writers

(setf tag-attribute-map) (generic function)

Slot: _body

Initargs

:body

Readers

body-of (generic function)

Writers

(setf body-of) (generic function)

Class: rotating-log-sender ()

A variation of stream sender that rotates logs based on a configurable interval. Log rotation happens just before a message is logged.

Package

hh-web

Source

rotating.lisp (file)

Direct superclasses

stream-sender (class)

Direct methods

• start-handling (method)
• initialize-instance (method)
• rotate-logs (method)
• rename-existing-logs (method)
• delete-old-logs (method)
• log-interval-expired-p (method)
• maxlogs (method)
• maxlogs (method)
• last-write (method)
• last-write (method)
• log-interval (method)
• log-interval (method)

Direct slots

Slot: interval

Interval in seconds between log rotations

Initargs

:interval

Initform

(* 24 60 60)

Readers

log-interval (generic function)

Writers

(setf log-interval) (generic function)

Slot: last-write

Initform

(get-universal-time)

Readers

last-write (generic function)

Writers

(setf last-write) (generic function)

Slot: maxlogs

Initargs

:max

Initform

10

Readers

maxlogs (generic function)

Writers

(setf maxlogs) (generic function)