The hh-web Reference Manual

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-asd.
• hh-web.

---

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

---

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:

* 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: 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

hh-web.

Methods

Reader Method: body-of ((htmltag htmltag)) ¶

automatically generated reader method

Source

tags.lisp.

Target Slot

_body.

Generic Writer: (setf body-of) (object) ¶

Package

hh-web.

Methods

Writer Method: (setf body-of) ((htmltag htmltag)) ¶

automatically generated writer method

Source

tags.lisp.

Target Slot

_body.

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.

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.

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 :around (tag) ¶

Method: render-as-html ((*current-tag* htmltag)) ¶

Generic Function: run-web-server (server-acceptor &key wait) ¶

Package

hh-web.

Source

server.lisp.

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.

Methods

Method: tag-name ((*current-tag* htmltag)) ¶

Reader Method: tag-name ((tag-definition tag-definition)) ¶

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

Target Slot

name.

Generic Writer: (setf tag-name) (object) ¶

Package

hh-web.

Methods

Writer Method: (setf tag-name) ((tag-definition tag-definition)) ¶

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

Source

tags.lisp.

Target Slot

name.

---

6.1.5 Standalone methods

Method: acceptor-dispatch-request ((*acceptor* ssl-server-acceptor) (*request* request)) ¶

Package

hunchentoot.

Source

server.lisp.

Method: acceptor-dispatch-request ((*acceptor* web-server-acceptor) (*request* request)) ¶

Package

hunchentoot.

Source

server.lisp.

Method: initialize-instance :after ((sender rotating-log-sender) &key) ¶

Source

rotating.lisp.

Method: initialize-instance :after ((library tag-library) &key) ¶

Source

taglibraries.lisp.

Method: print-object ((object htmltag) stream) ¶

Source

tags.lisp.

Method: print-object ((object tag-definition) stream) ¶

Source

tags.lisp.

Method: start-handling ((sender rotating-log-sender)) ¶

Package

log5.

Source

rotating.lisp.

---

6.1.6 Classes

Class: htmltag ¶

Package

hh-web.

Source

tags.lisp.

Direct methods

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

Direct slots

Slot: _definition ¶

Initargs

:definition

Readers

tag-definition.

Writers

(setf tag-definition).

Slot: _attribute-map ¶

Initform

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

Initargs

:attribute-map

Readers

tag-attribute-map.

Writers

(setf tag-attribute-map).

Slot: _body ¶

Initargs

:body

Readers

body-of.

Writers

(setf body-of).

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.

Direct superclasses

stream-sender.

Direct methods

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

Direct slots

Slot: interval ¶

Interval in seconds between log rotations

Initform

(* 24 60 60)

Initargs

:interval

Readers

log-interval.

Writers

(setf log-interval).

Slot: last-write ¶

Initform

(get-universal-time)

Readers

last-write.

Writers

(setf last-write).

Slot: maxlogs ¶

Initform

10

Initargs

:max

Readers

maxlogs.

Writers

(setf maxlogs).

Class: string-localization ¶

Package

hh-web.

Source

i18n.lisp.

Direct methods

• (setf locale).
• locale.
• (setf localization).
• localization.
• (setf name).
• name.
• (setf notes).
• notes.

Direct slots

Slot: name ¶

The string as it appeared in the development locale

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: locale ¶

The locale in which this specific string has been localized

Initargs

:locale

Readers

locale.

Writers

(setf locale).

Slot: localization ¶

The localized representation of a string

Initargs

:translation

Readers

localization.

Writers

(setf localization).

Slot: notes ¶

Notes from / to localizers about a string

Initform

""

Initargs

:notes

Readers

notes.

Writers

(setf notes).

Class: template ¶

Package

hh-web.

Source

templates.lisp.

Direct methods

• (setf definition-of).
• definition-of.
• load-template-from-provider.
• load-template-from-provider.
• (setf modified-time-of).
• modified-time-of.
• (setf tag-libraries-used).
• tag-libraries-used.
• (setf template-args).
• template-args.
• template-expiredp.
• (setf template-keyword-args).
• template-keyword-args.
• (setf template-package).
• template-package.
• template-path.
• (setf template-provider).
• template-provider.
• template-stalep.
• template-tags-expiredp.

Direct slots

Slot: path ¶

Initargs

:path

Readers

template-path.

Writers

This slot is read-only.

Slot: provider ¶

Initargs

:provider

Readers

template-provider.

Writers

(setf template-provider).

Slot: libraries ¶

Readers

tag-libraries-used.

Writers

(setf tag-libraries-used).

Slot: modified-time ¶

Initform

(local-time:now)

Readers

modified-time-of.

Writers

(setf modified-time-of).

Slot: package ¶

Package

common-lisp.

Initform

(make-package (gensym))

Initargs

:package

Readers

template-package.

Writers

(setf template-package).

Slot: args ¶

Initargs

:args

Readers

template-args.

Writers

(setf template-args).

Slot: kwargs ¶

Initargs

:kwargs

Readers

template-keyword-args.

Writers

(setf template-keyword-args).

Slot: definition ¶

Initargs

:definition

Readers

definition-of.

Writers

(setf definition-of).

---

6.2.1 Special variables

Special Variable: *available-tag-libraries* ¶

All tag libraries

Package

hh-web.

Source

tags.lisp.

Special Variable: *default-tag-definition* ¶

Provides default implementation for tag methods

Package

hh-web.

Source

tags.lisp.

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

The default folder for tag libraries

Package

hh-web.

Source

taglibraries.lisp.

Special Variable: *default-template-folder* ¶

The default folder for templates

Package

hh-web.

Source

templates.lisp.

Special Variable: *development-locale-name* ¶

Locale in which development occurs, and in which strings in code first appear before translation into other locales

Package

hh-web.

Source

i18n.lisp.

Special Variable: *html-out* ¶

Output stream for rendering html

Package

hh-web.

Source

tags.lisp.

Special Variable: *locale* ¶

Current locale

Package

hh-web.

Source

i18n.lisp.

Special Variable: *locales* ¶

List of loaded or known locales

Package

hh-web.

Source

i18n.lisp.

Special Variable: *localizable-strings* ¶

Package

hh-web.

Source

i18n.lisp.

Special Variable: *localization-context* ¶

Typically set to the URL in which the string occurs, but not always (and not always set implying no relevant context

Package

hh-web.

Source

i18n.lisp.

Special Variable: *minimum-cached-item-stale-time* ¶

Minimum time in seconds for which a cache entry is not stale (and thus can’t expire), but after which the item is stale and possible expired

Package

hh-web.

Source

cache.lisp.

Special Variable: *minimum-tag-library-stale-time* ¶

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

Package

hh-web.

Source

taglibraries.lisp.

Special Variable: *minimum-url-cache-stale-time* ¶

Minimum time in seconds between checks for changes to URLs; lower times mean check for updates to defurls more often, higher times mean check more rarely

Package

hh-web.

Source

urls.lisp.

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

Package

hh-web.

Source

documentation.lisp.

Special Variable: *package-template-provider-registry* ¶

Package

hh-web.

Source

documentation.lisp.

Special Variable: *page-charset* ¶

The charset of the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-doctype* ¶

The doctype of the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-language* ¶

The default language of the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-links* ¶

A list of link tags that should appear in the head of the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-ready-scripts* ¶

A list of strings, each representing script to be run when the document is ready (after load)

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-script-libraries* ¶

A list of strings, each pointing to a script library that the page referneces

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-scripts* ¶

A list of strings, each representing a script added to the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-style-sheets* ¶

A list of strings, each pointing to a styleseheet that the page references

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-styles* ¶

A list of strings, each representing CSS added to the page

Package

hh-web.

Source

tags.lisp.

Special Variable: *page-title* ¶

The title of the page as it should be presented to the user in the browser

Package

hh-web.

Source

tags.lisp.

Special Variable: *tag-printing-level* ¶

Used for pretty printing HTML, with proper indentation for nested tags

Package

hh-web.

Source

tags.lisp.

Special Variable: *template-cache* ¶

Cache of template names to template objects

Package

hh-web.

Source

templates.lisp.

Special Variable: *url-cache* ¶

Package

hh-web.

Source

urls.lisp.

Special Variable: +client-meta-service-request+ ¶

Package

hh-web.

Source

services.lisp.

Special Variable: +meta-service-request-parameter+ ¶

When this parameter appears for a service, the service will perform other ’meta’ activities for the service. See handle-service-meta-request.

Package

hh-web.

Source

services.lisp.

Special Variable: +method-parameter+ ¶

Special parameter used in POST requests to indicate the actual desired
method (should be either ’DELETE’ or ’PUT’). Used by some browser-side code as a substitute for situations where the browser will not allow Javascript to send a native DELETE or PUT request.

Package

hh-web.

Source

services.lisp.

---