The weblocks Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The weblocks Reference Manual

This is the weblocks Reference Manual, version 0.13.7, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:15:04 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Weblocks

Build Status

Weblocks is an advanced web framework written in Common Lisp.

Offical Weblocks site

Currently your web application should depend on :weblocks and :weblocks-prototype-js packages to work. Weblocks PrototypeJs backend


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 weblocks

Maintainer

Olexiy Zamkoviy, Scott L. Burson

Author

Slava Akhmechet

License

LLGPL

Description

A Common Lisp web framework.

Version

0.13.7

Dependencies
Source

weblocks.asd (file)

Component

src (module)


Previous: , Up: Systems   [Contents][Index]

2.2 weblocks-util

Maintainer

Olexiy Zamkoviy, Scott L. Burson

Author

Slava Akhmechet

License

LLGPL

Description

Utilities for weblocks

Version

0.1.1

Dependencies
Source

weblocks-util.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 weblocks/src

Parent

weblocks (system)

Location

src/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.2 weblocks/src/utils

Dependency

weblocks.lisp (file)

Parent

src (module)

Location

src/utils/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.3 weblocks/src/linguistic

Dependencies
Parent

src (module)

Location

src/linguistic/

Component

grammar.lisp (file)


Next: , Previous: , Up: Modules   [Contents][Index]

3.4 weblocks/src/views

Dependencies
Parent

src (module)

Location

src/views/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.5 weblocks/src/views/view

Parent

views (module)

Location

src/views/view/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.6 weblocks/src/views/formview

Dependency

view (module)

Parent

views (module)

Location

src/views/formview/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.7 weblocks/src/views/types

Dependencies
Parent

views (module)

Location

src/views/types/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.8 weblocks/src/views/types/presentations

Parent

types (module)

Location

src/views/types/presentations/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.9 weblocks/src/views/types/parsers

Parent

types (module)

Location

src/views/types/parsers/

Component

common.lisp (file)


Next: , Previous: , Up: Modules   [Contents][Index]

3.10 weblocks/src/widgets

Dependencies
Parent

src (module)

Location

src/widgets/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.11 weblocks/src/widgets/widget

Parent

widgets (module)

Location

src/widgets/widget/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.12 weblocks/src/widgets/dataseq

Dependencies
Parent

widgets (module)

Location

src/widgets/dataseq/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.13 weblocks/src/widgets/datagrid

Dependencies
Parent

widgets (module)

Location

src/widgets/datagrid/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.14 weblocks/src/widgets/dataedit

Dependencies
Parent

widgets (module)

Location

src/widgets/dataedit/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.15 weblocks/src/control-flow

Dependencies
Parent

src (module)

Location

src/control-flow/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.16 weblocks-util/src

Parent

weblocks-util (system)

Location

src/

Components

Previous: , Up: Modules   [Contents][Index]

3.17 weblocks-util/src/utils

Dependency

util.lisp (file)

Parent

src (module)

Location

src/utils/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 weblocks.asd

Location

weblocks.asd

Systems

weblocks (system)

Packages

weblocks-asd

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 weblocks-util.asd

Location

weblocks-util.asd

Systems

weblocks-util (system)

Packages

weblocks-util-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 weblocks/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 weblocks/src/weblocks.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/weblocks.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 weblocks/src/utils/misc.lisp

Parent

utils (module)

Location

src/utils/misc.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 weblocks/src/utils/runtime-class.lisp

Parent

utils (module)

Location

src/utils/runtime-class.lisp

Exported Definitions

make-class (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 weblocks/src/utils/string.lisp

Parent

utils (module)

Location

src/utils/string.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 weblocks/src/utils/list.lisp

Parent

utils (module)

Location

src/utils/list.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 weblocks/src/utils/uri.lisp

Parent

utils (module)

Location

src/utils/uri.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 weblocks/src/utils/html.lisp

Parent

utils (module)

Location

src/utils/html.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 weblocks/src/utils/menu.lisp

Dependency

html.lisp (file)

Parent

utils (module)

Location

src/utils/menu.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 weblocks/src/utils/suggest.lisp

Parent

utils (module)

Location

src/utils/suggest.lisp

Exported Definitions

render-suggest (function)

Internal Definitions

format-suggest-list (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 weblocks/src/utils/timing.lisp

Parent

utils (module)

Location

src/utils/timing.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 weblocks/src/utils/repl.lisp

Parent

utils (module)

Location

src/utils/repl.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 weblocks/src/versioning.lisp

Dependencies
Parent

src (module)

Location

src/versioning.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 weblocks/src/bundling.lisp

Dependencies
Parent

src (module)

Location

src/bundling.lisp

Exported Definitions

*initial-bundle-id* (special variable)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 weblocks/src/dependencies.lisp

Dependencies
Parent

src (module)

Location

src/dependencies.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 weblocks/src/dom-object.lisp

Dependencies
Parent

src (module)

Location

src/dom-object.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.19 weblocks/src/page-template.lisp

Dependencies
Parent

src (module)

Location

src/page-template.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.20 weblocks/src/actions.lisp

Dependencies
Parent

src (module)

Location

src/actions.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.21 weblocks/src/log-actions.lisp

Dependency

weblocks.lisp (file)

Parent

src (module)

Location

src/log-actions.lisp

Exported Definitions
Internal Definitions

*rendered-actions* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.22 weblocks/src/debug-mode.lisp

Dependencies
Parent

src (module)

Location

src/debug-mode.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.23 weblocks/src/uri-tokens.lisp

Dependency

weblocks.lisp (file)

Parent

src (module)

Location

src/uri-tokens.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.24 weblocks/src/request-hooks.lisp

Dependencies
Parent

src (module)

Location

src/request-hooks.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.25 weblocks/src/error-handler.lisp

Dependencies
Parent

src (module)

Location

src/error-handler.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.26 weblocks/src/request-handler.lisp

Dependencies
Parent

src (module)

Location

src/request-handler.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.27 weblocks/src/linguistic/grammar.lisp

Parent

linguistic (module)

Location

src/linguistic/grammar.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.28 weblocks/src/views/view/view.lisp

Parent

view (module)

Location

src/views/view/view.lisp

Exported Definitions
Internal Definitions

*views* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.29 weblocks/src/views/view/utils.lisp

Dependency

view.lisp (file)

Parent

view (module)

Location

src/views/view/utils.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.30 weblocks/src/views/view/compiler.lisp

Dependency

view.lisp (file)

Parent

view (module)

Location

src/views/view/compiler.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.31 weblocks/src/views/view/scaffold.lisp

Dependencies
Parent

view (module)

Location

src/views/view/scaffold.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.32 weblocks/src/views/view/presentation.lisp

Dependencies
Parent

view (module)

Location

src/views/view/presentation.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.33 weblocks/src/views/dataview.lisp

Dependency

view (module)

Parent

views (module)

Location

src/views/dataview.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.34 weblocks/src/views/formview/formview.lisp

Parent

formview (module)

Location

src/views/formview/formview.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.35 weblocks/src/views/formview/helpers.lisp

Parent

formview (module)

Location

src/views/formview/helpers.lisp

Exported Definitions

make-slot-writer (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.36 weblocks/src/views/formview/parser.lisp

Dependency

formview.lisp (file)

Parent

formview (module)

Location

src/views/formview/parser.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.37 weblocks/src/views/formview/scaffold.lisp

Dependencies
Parent

formview (module)

Location

src/views/formview/scaffold.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.38 weblocks/src/views/formview/validation.lisp

Dependency

formview.lisp (file)

Parent

formview (module)

Location

src/views/formview/validation.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.39 weblocks/src/views/formview/request-deserialization.lisp

Dependencies
Parent

formview (module)

Location

src/views/formview/request-deserialization.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.40 weblocks/src/views/formview/template-form-view.lisp

Dependency

formview.lisp (file)

Parent

formview (module)

Location

src/views/formview/template-form-view.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.41 weblocks/src/views/sequence-view.lisp

Dependency

view (module)

Parent

views (module)

Location

src/views/sequence-view.lisp

Exported Definitions
Internal Definitions

sequence-scaffold (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.42 weblocks/src/views/tableview.lisp

Dependencies
Parent

views (module)

Location

src/views/tableview.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.43 weblocks/src/views/types/file-upload.lisp

Parent

types (module)

Location

src/views/types/file-upload.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.44 weblocks/src/views/types/us-states.lisp

Parent

types (module)

Location

src/views/types/us-states.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.45 weblocks/src/views/types/boolean.lisp

Parent

types (module)

Location

src/views/types/boolean.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.46 weblocks/src/views/types/member.lisp

Dependencies
Parent

types (module)

Location

src/views/types/member.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.47 weblocks/src/views/types/password.lisp

Parent

types (module)

Location

src/views/types/password.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.48 weblocks/src/views/types/presentations/hidden.lisp

Parent

presentations (module)

Location

src/views/types/presentations/hidden.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.49 weblocks/src/views/types/presentations/choices.lisp

Parent

presentations (module)

Location

src/views/types/presentations/choices.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.50 weblocks/src/views/types/presentations/date.lisp

Parent

presentations (module)

Location

src/views/types/presentations/date.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.51 weblocks/src/views/types/presentations/radio.lisp

Dependency

choices.lisp (file)

Parent

presentations (module)

Location

src/views/types/presentations/radio.lisp

Exported Definitions
Internal Definitions

radio-view-field-wt (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.52 weblocks/src/views/types/presentations/dropdown.lisp

Dependency

choices.lisp (file)

Parent

presentations (module)

Location

src/views/types/presentations/dropdown.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.53 weblocks/src/views/types/presentations/textarea.lisp

Parent

presentations (module)

Location

src/views/types/presentations/textarea.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.54 weblocks/src/views/types/presentations/paragraph.lisp

Parent

presentations (module)

Location

src/views/types/presentations/paragraph.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.55 weblocks/src/views/types/presentations/excerpt.lisp

Parent

presentations (module)

Location

src/views/types/presentations/excerpt.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.56 weblocks/src/views/types/presentations/image.lisp

Parent

presentations (module)

Location

src/views/types/presentations/image.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.57 weblocks/src/views/types/presentations/checkboxes.lisp

Parent

presentations (module)

Location

src/views/types/presentations/checkboxes.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.58 weblocks/src/views/types/presentations/url.lisp

Parent

presentations (module)

Location

src/views/types/presentations/url.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.59 weblocks/src/views/types/presentations/html.lisp

Parent

presentations (module)

Location

src/views/types/presentations/html.lisp

Exported Definitions
Internal Definitions

html-presentation-field-value-wt (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.60 weblocks/src/views/types/presentations/widget.lisp

Parent

presentations (module)

Location

src/views/types/presentations/widget.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.61 weblocks/src/views/types/parsers/common.lisp

Parent

parsers (module)

Location

src/views/types/parsers/common.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.62 weblocks/src/widgets/widget/widget-mop.lisp

Parent

widget (module)

Location

src/widgets/widget/widget-mop.lisp

Exported Definitions

widget-class (class)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.63 weblocks/src/widgets/widget/uri-parameters-mixin.lisp

Parent

widget (module)

Location

src/widgets/widget/uri-parameters-mixin.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.64 weblocks/src/widgets/widget/widget.lisp

Dependencies
Parent

widget (module)

Location

src/widgets/widget/widget.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.65 weblocks/src/widgets/widget/string-widget.lisp

Dependency

widget.lisp (file)

Parent

widget (module)

Location

src/widgets/widget/string-widget.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.66 weblocks/src/widgets/widget/funcall-widget.lisp

Dependency

widget.lisp (file)

Parent

widget (module)

Location

src/widgets/widget/funcall-widget.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.67 weblocks/src/widgets/composite.lisp

Dependency

widget (module)

Parent

widgets (module)

Location

src/widgets/composite.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.68 weblocks/src/widgets/flash.lisp

Dependency

widget (module)

Parent

widgets (module)

Location

src/widgets/flash.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.69 weblocks/src/widgets/data-editor.lisp

Dependency

widget (module)

Parent

widgets (module)

Location

src/widgets/data-editor.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.70 weblocks/src/widgets/dataform.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/dataform.lisp

Exported Definitions
Internal Definitions

update-form-intermediate-values-on-form-action (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.71 weblocks/src/widgets/quickform.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/quickform.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.72 weblocks/src/widgets/simpleform.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/simpleform.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.73 weblocks/src/widgets/wizard.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/wizard.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.74 weblocks/src/widgets/template-block.lisp

Dependency

widget (module)

Parent

widgets (module)

Location

src/widgets/template-block.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.75 weblocks/src/widgets/login.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/login.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.76 weblocks/src/widgets/dataseq/dataseq.lisp

Parent

dataseq (module)

Location

src/widgets/dataseq/dataseq.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.77 weblocks/src/widgets/dataseq/operations-action.lisp

Parent

dataseq (module)

Location

src/widgets/dataseq/operations-action.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.78 weblocks/src/widgets/datagrid/datagrid.lisp

Parent

datagrid (module)

Location

src/widgets/datagrid/datagrid.lisp

Exported Definitions
Internal Definitions

dataseq-body-wt (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.79 weblocks/src/widgets/datagrid/sort.lisp

Dependency

datagrid.lisp (file)

Parent

datagrid (module)

Location

src/widgets/datagrid/sort.lisp

Exported Definitions

render-view-field-header (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.80 weblocks/src/widgets/datagrid/select.lisp

Dependency

datagrid.lisp (file)

Parent

datagrid (module)

Location

src/widgets/datagrid/select.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.81 weblocks/src/widgets/datagrid/drilldown.lisp

Dependency

datagrid.lisp (file)

Parent

datagrid (module)

Location

src/widgets/datagrid/drilldown.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.82 weblocks/src/widgets/dataedit/dataedit.lisp

Dependency

delete-action.lisp (file)

Parent

dataedit (module)

Location

src/widgets/dataedit/dataedit.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.83 weblocks/src/widgets/dataedit/delete-action.lisp

Parent

dataedit (module)

Location

src/widgets/dataedit/delete-action.lisp

Exported Definitions

dataedit-delete-item (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.84 weblocks/src/widgets/gridedit.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/gridedit.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.85 weblocks/src/widgets/listedit.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/listedit.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.86 weblocks/src/widgets/datalist.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/datalist.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.87 weblocks/src/widgets/pagination.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/pagination.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.88 weblocks/src/widgets/selector.lisp

Dependency

widget (module)

Parent

widgets (module)

Location

src/widgets/selector.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.89 weblocks/src/widgets/on-demand-selector.lisp

Dependency

selector.lisp (file)

Parent

widgets (module)

Location

src/widgets/on-demand-selector.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.90 weblocks/src/widgets/navigation.lisp

Dependencies
Parent

widgets (module)

Location

src/widgets/navigation.lisp

Exported Definitions
Internal Definitions

navigation-pane-name-for-token (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.91 weblocks/src/widgets/breadcrumbs.lisp

Dependency

navigation.lisp (file)

Parent

widgets (module)

Location

src/widgets/breadcrumbs.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.92 weblocks/src/control-flow/call-answer.lisp

Parent

control-flow (module)

Location

src/control-flow/call-answer.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.93 weblocks/src/control-flow/dialog.lisp

Dependency

call-answer.lisp (file)

Parent

control-flow (module)

Location

src/control-flow/dialog.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.94 weblocks/src/control-flow/workflow.lisp

Dependency

call-answer.lisp (file)

Parent

control-flow (module)

Location

src/control-flow/workflow.lisp

Exported Definitions

with-flow (macro)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.95 weblocks/src/acceptor.lisp

Dependency

weblocks.lisp (file)

Parent

src (module)

Location

src/acceptor.lisp

Exported Definitions
Internal Definitions

ssl-redirect-acceptor-ssl-port (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.96 weblocks/src/server.lisp

Dependencies
Parent

src (module)

Location

src/server.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.97 weblocks/src/request.lisp

Dependencies
Parent

src (module)

Location

src/request.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.98 weblocks/src/application-mop.lisp

Dependencies
Parent

src (module)

Location

src/application-mop.lisp

Exported Definitions

webapp-class (class)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.99 weblocks/src/application.lisp

Dependencies
Parent

src (module)

Location

src/application.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.100 weblocks/src/default-application.lisp

Dependencies
Parent

src (module)

Location

src/default-application.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.101 weblocks/src/widget-translation.lisp

Parent

src (module)

Location

src/widget-translation.lisp

Exported Definitions
Internal Definitions

widget-dynamic-translate-impl (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.102 weblocks-util/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

weblocks-util

Internal Definitions

wexport (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.103 weblocks-util/src/utils/misc.lisp

Parent

utils (module)

Location

src/utils/misc.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.104 weblocks-util/src/utils/clos.lisp

Parent

utils (module)

Location

src/utils/clos.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.105 weblocks-util/src/utils/list.lisp

Parent

utils (module)

Location

src/utils/list.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.106 weblocks-util/src/utils/i18n.lisp

Parent

utils (module)

Location

src/utils/i18n.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.107 weblocks-util/src/utils/templates.lisp

Dependency

html-parts.lisp (file)

Parent

utils (module)

Location

src/utils/templates.lisp

Exported Definitions
Internal Definitions

calculate-template-priority (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.108 weblocks-util/src/utils/html-parts.lisp

Parent

utils (module)

Location

src/utils/html-parts.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 weblocks-asd

Source

weblocks.asd

Nickname

wop

Use List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 weblocks

Weblocks is a Common Lisp framework that eases the pain of web application development. It achieves its goals by standardizing on various libraries, providing flexible and extensible generic views, and exposing a unique widget-based approach to maintaining UI state.

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 weblocks-cont

Operators for continuation-based web development with Weblocks.

Source

package.lisp (file)


Next: , Previous: , Up: Packages   [Contents][Index]

5.4 weblocks-util-asd

Source

weblocks-util.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.5 weblocks-util

General Lisp utilities traditionally exported with Weblocks.

Source

util.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *accumulate-page-keywords*

Whether to accumulate widgets’ keywords for the keywords meta tag or use the most specific keywords only.

Package

weblocks

Source

page-template.lisp (file)

Special Variable: *always-recreate-template-printer*
Package

weblocks

Source

template-block.lisp (file)

Special Variable: *approved-return-codes*
Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *authentication-key*

A key used to store the authentication object in the session.

Package

weblocks

Source

login.lisp (file)

Special Variable: *backtrace-on-session-init-error*
Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *before-ajax-complete-scripts*

A list of client-side scripts to be sent over to the browser at the end of ajax request execution. TODO when executed?

Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *cancel-control-name*

The name of the control responsible for cancellation of form submission.

Package

weblocks

Source

html.lisp (file)

Special Variable: *current-locale*
Package

weblocks

Source

grammar.lisp (file)

Special Variable: *current-page-description*
Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *current-widget*

The widget being rendered right now.

Package

weblocks

Source

widget.lisp (file)

Special Variable: *custom-view-field-argument-compilers*

A hash map of keywords, each mapped to a compilation
function. When a keyword is encountered in a field definition during compilation, the corresponding compilation function is called and the emitted code is used for field initialization. The function must accept slot name symbol and initialization declaration.

Package

weblocks

Source

compiler.lisp (file)

Special Variable: *debug-words-forms*
Package

weblocks

Source

grammar.lisp (file)

Special Variable: *debug-words-genders*
Package

weblocks

Source

grammar.lisp (file)

Special Variable: *default-cascade-delete-mixins-p*

Default value for ’dataedit-cascade-delete-mixins-p’. See its documentation for more details.

Package

weblocks

Source

dataedit.lisp (file)

Special Variable: *default-login-failure-error*

Default message in case of login failure.

Package

weblocks

Source

login.lisp (file)

Special Variable: *default-login-title*

Default title to be used in ’do-login’.

Package

weblocks

Source

login.lisp (file)

Special Variable: *default-public-files-path*
Package

weblocks

Source

application.lisp (file)

Special Variable: *default-required-indicator*

Default string to render after a field’s label if the field is required.

Package

weblocks

Source

formview.lisp (file)

Special Variable: *dropdown-welcome-message*

A welcome message used by dropdowns as the first entry.

Package

weblocks

Source

html.lisp (file)

Special Variable: *enable-timings*
Package

weblocks

Source

timing.lisp (file)

Special Variable: *expired-action-handler*

Must be bound to a designator of a function with a single optional argument - the application. The function gets called when the user tries to invoke an expired action (due to a session timeout). The function should determine the behavior in this
situation (e.g. redirect, signal an error, etc.) Default function redirects to the root of the application.

Package

weblocks

Source

actions.lisp (file)

Special Variable: *force-files-to-serve*

A list of urls which should be recognized as files.
This is useful for avoiding double requests to application. /favicon.ico here fixes Weblocks bug in Google Chrome browser

Package

weblocks

Source

server.lisp (file)

Special Variable: *form-default-error-summary-threshold*

When the number of fields in a form is longer than this threshold, an error summary is rendered at top whenever applicable. This is a default value used to initialize ’error-summary-threshold’ slot of ’form-view’ objects.

Package

weblocks

Source

formview.lisp (file)

Special Variable: *form-submit-dependencies*

Dynamic javascript dependencies – code that form elements need to run before form submission, and that therefore needs to be placed in the onsubmit handler of the entire form.

Package

weblocks

Source

view.lisp (file)

Special Variable: *ignore-missing-actions*
Package

weblocks

Source

actions.lisp (file)

Special Variable: *initial-bundle-id*
Package

weblocks

Source

bundling.lisp (file)

Special Variable: *json-content-type*

A content type sent to the client to identify json data.

Package

weblocks

Source

request.lisp (file)

Special Variable: *last-session*

Bound to a session object associated with the last handled request. Note, this variable is only updated in debug mode.

Package

weblocks

Source

server.lisp (file)

Special Variable: *max-password-length*

Default maximum for the length of the password field

Package

weblocks

Source

password.lisp (file)

Special Variable: *max-raw-input-length*

Default maximum allowed input length for input fields.

Package

weblocks

Source

formview.lisp (file)

Special Variable: *max-textarea-input-length*

Maximum number of characters that can be entered before the server complains.

Package

weblocks

Source

textarea.lisp (file)

Special Variable: *menu-empty-message*

A default message shown by ’render-menu’ if no entries are available.

Package

weblocks

Source

menu.lisp (file)

Special Variable: *on-ajax-complete-scripts*

A list of client-side scripts to be sent over to the browser at the end of ajax request execution.

Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *pagination-items-per-page*

Default number of items visible on a page.

Package

weblocks

Source

pagination.lisp (file)

Special Variable: *parts-md5-context-hash*

A hash with key of html part md5 hash and the value of html part context

Package

weblocks-util

Source

html-parts.lisp (file)

Special Variable: *parts-md5-hash*

A hash with key of html part md5 hash
and the value of list with html part as car and list of children as cdr

Package

weblocks-util

Source

html-parts.lisp (file)

Special Variable: *presentation-dom-id*

DOM id of the currently rendered
presentation object. If bound during rendering (for example, in an :around method for render-object-view, will be used by the various functions that render form elements..

Package

weblocks

Source

dataview.lisp (file)

Special Variable: *process-html-parts-p*
Package

weblocks-util

Source

html-parts.lisp (file)

Special Variable: *registered-webapps*

A list of applications that the system knows about

Package

weblocks

Source

application.lisp (file)

Special Variable: *request-hook*

A request hook object used in the request scope.

Package

weblocks

Source

request-hooks.lisp (file)

Special Variable: *request-timeout*

Seconds until we abort a request because it took too long. This prevents threads from hogging the CPU indefinitely.
You can set this to NIL to disable timeouts (not recommended).

Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *required-field-message*

This message will be passed to ’format’ along with the humanized name of the field to inform users that the field is required.

Package

weblocks

Source

formview.lisp (file)

Special Variable: *style-warn-on-circular-dirtying*

Whether to emit a style-warning when widgets are marked dirty after the rendering phase.

Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *style-warn-on-late-propagation*

Whether to emit a style-warning when widgets are marked dirty in the rendering phase.

Package

weblocks

Source

request-handler.lisp (file)

Special Variable: *submit-control-name*

The name of the control responsible for form submission.

Package

weblocks

Source

html.lisp (file)

Special Variable: *templates*

Hash containing all templates. Hash key is template name, hash value is a cons with template and context arguments

Package

weblocks-util

Source

templates.lisp (file)

Special Variable: *text-data-cutoff-threshold*

In the excerpt mode, the number of characters to be rendered before the text is cut off and an ellipsis is inserted.

Package

weblocks

Source

excerpt.lisp (file)

Special Variable: *text-presentation-mixin-default-format-string*
Package

weblocks

Source

dataview.lisp (file)

Special Variable: *textarea-cols*

Default number of columns rendered in textarea

Package

weblocks

Source

textarea.lisp (file)

Special Variable: *textarea-rows*

Default number of rows rendered in textarea

Package

weblocks

Source

textarea.lisp (file)

Special Variable: *timing-report-fn*
Package

weblocks

Source

timing.lisp (file)

Special Variable: *translation-function*
Package

weblocks-util

Source

i18n.lisp (file)

Special Variable: *uri-tokens*

Bound to an URI-TOKENS object in a request.

Package

weblocks

Source

uri-tokens.lisp (file)

Special Variable: *us-states*

A alist of us state names and their abbreviations.

Package

weblocks

Source

us-states.lisp (file)

Special Variable: *use-suggest-for-us-states*

If true, suggest snippet will be used to render us-state types in forms. A simple dropdown will be used otherwise.

Package

weblocks

Source

us-states.lisp (file)

Special Variable: *weblocks-global-debug*
Package

weblocks

Source

debug-mode.lisp (file)

Special Variable: *weblocks-output-stream*

Output stream for Weblocks framework created for each request and available to code executed within a request as a special variable. All html should be rendered to this stream.

Package

weblocks

Source

weblocks.lisp (file)

Special Variable: *weblocks-server*

If the server is started, bound to hunchentoot server object. Otherwise, nil.

Package

weblocks

Source

server.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: current-dialog ()

Expands to code that signifies a place that contains information about the currently active dialog, if any. The place holds a structure of type ’dialog’.

Package

weblocks

Source

dialog.lisp (file)

Macro: define-permanent-action NAME WEBAPP-CLASS ACTION-PARAMS &body BODY

Adds a permanent action to the class’s set of permanent actions

Package

weblocks

Source

application.lisp (file)

Macro: define-permanent-action/cc NAME WEBAPP-CLASS ACTION-PARAMS &body BODY

Adds a permanent action to the class’s set of permanent actions

Package

weblocks

Source

application.lisp (file)

Macro: defrender WIDGET-TYPE &body BODY
Package

weblocks-util

Source

misc.lisp (file)

Macro: defview NAME (&rest ARGS &key &allow-other-keys) &rest FIELDS

A macro used to easily define user interface views in a declarative manner.

(defview (NAME [:type TYPE] [:inherit-from INHERIT-FROM]
[:satisfies SATISFIES] VIEW-KWARGS...)
[FIELD-NAME
| (FIELD-NAME [:type FIELD-TYPE] [:initform INITFORM]
[:present-as PRESENT-AS] [:parse-as PARSE-AS] FIELD-KWARGS...)]...)

In the above form, these metasyntactic variables have the following values:

NAME
When non-nil, an unevaluated unique symbol identifying the
view to other parts of the system that require a view, resolving it using ‘find-view’.
TYPE
An unevaluated designator for the class of the resulting
view (determined by ‘view-class-name’), and half the
designator for the class of this view’s fields (determined by ‘view-field-class-name’ applied to ‘view-default-field-type’). Defaults to ‘data’.
INHERIT-FROM
A designator for ‘view’ slot ‘inherit-from’. Forms
like (:scaffold DATA-CLASS) will replace :scaffold with TYPE. See ‘find-view’ for further transformation.
SATISFIES
A designator for ‘form-view’ slot ‘satisfies’.
VIEW-KWARGS
Other arguments passed directly to ‘make-instance’ for the resulting view, quoting subject to ‘view-argument-quoting-strategy’.

INHERIT-FROM and SATISFIES are evaluated.

FIELD-NAME
An unevaluated designator for ‘view-field’ slot ‘slot-name’. FIELD-TYPE
A designator for the class of the field, in combination with TYPE, as explained above for TYPE.
FIELD-KWARGS
Other arguments passed directly to ‘make-instance’ for the resulting view field, quoting subject to ‘view-argument-quoting-strategy’.

However, FIELD-KWARGS keywords present in ‘*custom-view-field-argument-compilers*’ are not included in the ‘make-instance’ call; see that variable for how those are transformed. The built-in custom view fields are as follows:

INITFORM
A form for ‘mixin-view-field’ slot ‘initform’ (which is
really an initfunction).
PRESENT-AS
A designator for ‘view-field’ slot ‘presentation’. The symbol or CAR is mapped to a class name through ‘presentation-class-name’, and the CDR, a series of keyword arguments, is passed to ‘make-instance’ on said class, subject to ‘view-argument-quoting-strategy’.
PARSE-AS
A designator for ‘form-view-field’ slot ‘parser’. Otherwise similar to PRESENT-AS, but mapping class names using ‘parser-class-name’.

Package

weblocks

Source

compiler.lisp (file)

Macro: defview-anon (&rest ARGS &key TYPE INHERIT-FROM SATISFIES &allow-other-keys) &rest FIELDS

A macro used to easily define anonymous user interface views in a declarative manner.

Package

weblocks

Source

compiler.lisp (file)

Macro: defwebapp NAME &rest INITARGS &key SUBCLASSES SLOTS AUTOSTART &allow-other-keys

This macro defines the key parameters for a stand alone web application.
It defines both a class with name ’name’ and registers an instance of that class. It also instantiates a defvar with an instance of this class. This is intended
to be the primary way a web application is defined.

:subclasses - if you want to inherit subclass behavior from other webapps, you
can. It’s not likely to be needed much

:slots - webapps are class so slots are a list of definitions just as in defclass, but as slots are likely to be rare on webapps, we make this a keyword argument.

All of the following, when present, are passed through as additional
initargs:

:name - instantiates a username (and the default title for) a webapp. use this name to get and delete this webapp. Multiple instances of a webapp class can co-exist, so long as they have different prefixes

:description - A description of the application for the title page

:ignore-default-dependencies inhibits appending the default dependencies to
the dependencies list. By default ’defwebapp’ adds the following resources:

Stylesheets: layout.css, main.css
Scripts (only for prototype js backend): prototype.js, weblocks.js, scriptaculous.js

:dependencies - is a list of dependencies to append to the default dependencies list of the application.

:public-files-path - a physical path to the directory which contains
public files for the application. The virtual uri for public files
will be mapped to this physical path by a Hunchentoot handler. If the
static files are server by a different web server, this value may be
set to nil.

:public-files-uri-prefix - a prefix for the virtual uri of public
files (default is ’pub’). Final uri prefix for public files is
computed with ’compute-webapp-public-files-uri-prefix’. Note, the uri
computed by ’compute-webapp-public-files-uri-prefix’ is used to
generate dependencies and to set up a Hunchentoot handler to map from
the uri to the path specified by public-files-path.

:public-files-cache-time - make the client cache public files for N
seconds (default 3600). Caching is disabled in debug mode.

:init-user-session - A function object that is used to initialize new
user sessions. If it is not passed, a function named
’init-user-session’ is looked up in the package where the web
application name symbol is defined.

:autostart - Whether this webapp is started automatically when start-weblocks is called (primarily for backward compatibility

Package

weblocks

Source

application.lisp (file)

Macro: defwidget NAME DIRECT-SUPERCLASSES &body BODY

A macro used to define new widget classes. Behaves exactly as defclass, except adds ’widget-class’ metaclass specification and inherits from ’widget’ if no direct superclasses are provided.

Package

weblocks

Source

widget.lisp (file)

Macro: extract-view-property-from-type PROPERTY-NAME PROPERTY-EXTRACTION-FN SCAFFOLD DSD

Helper macro to obtain view properties from typespecs.

Package

weblocks

Source

scaffold.lisp (file)

Macro: insert-at NEWELT LIST INDEX

Destructively inserts ’newelt’ into ’list’ before ’index’.

Package

weblocks-util

Source

list.lisp (file)

Macro: nested-html-part CONTEXT &body BODY

Adds part of html (a string received as a result of &body evaluation) and context associated with it to html parts set.

Package

weblocks-util

Source

html-parts.lisp (file)

Macro: noscript &body BODY

Outputs HTML in a way that it takes effect on the client only if client-side scripting is disabled. This macro behaves identically to :noscript html element, but avoids rendering HTML on AJAX requests in addition.

Package

weblocks

Source

html.lisp (file)

Macro: on-signin-hooks ()

A list of callback functions of no arguments to be called when the user signs out.

Package

weblocks

Source

login.lisp (file)

Macro: on-signout-hooks ()

A list of callback functions of no arguments to be called when the user signs out.

Package

weblocks

Source

login.lisp (file)

Macro: request-hook SCOPE LOCATION

Allows access to a series of hooks exposed by ’handle-client-request’.

scope - the scope of the hook. Can be set to :application, :session, or :request. An :application hook is maintained throughout the lifetime of the entire application. A :session hook is destroyed along with the session. A :request hook is only valid for the request.

location - the location of the hook. Can be set
to :dynamic-action :pre-action, :post-action,
:dynamic-render :pre-render, and :post-render.

The macro returns a place that can be used to push a callback function of no arguments.

Package

weblocks

Source

request-hooks.lisp (file)

Macro: root-composite ()

Expands to code that can be used as a place to access to the root composite.

Package

weblocks

Source

composite.lisp (file)

Macro: root-widget ()

Expands to code that can be used as a place to access to the root composite.

Package

weblocks

Source

weblocks.lisp (file)

Macro: scriptonly &body BODY

Outputs HTML defined in the body in such a way that it takes effect on the client only if client-side scripting is enabled.

Package

weblocks

Source

html.lisp (file)

Macro: timing NAME &body BODY
Package

weblocks

Source

timing.lisp (file)

Macro: widget-dynamic-translate OBJ KEY VALUE
Package

weblocks

Source

widget-translation.lisp (file)

Macro: with-extra-tags &body BODY

A macro used to wrap html into extra tags necessary for hacking CSS formatting. The macro wraps the body with three headers on top and three on the bottom. It uses ’render-extra-tags’ function along with ’extra-top-’ and ’extra-bottom-’ arguments.

Package

weblocks

Source

html.lisp (file)

Macro: with-file-write (STREAM-NAME PATH &key ELEMENT-TYPE) &body BODY
Package

weblocks-util

Source

misc.lisp (file)

Macro: with-flow WIDGET &body BODY

Eases the burden of creating flows. Instead of using ’do-widget’ in the body, one can use ’yield’, which will expand into appropriate ’do-widget’ code.

Package

weblocks

Source

workflow.lisp (file)

Macro: with-html &body BODY

A wrapper around cl-who with-html-output macro.

Package

weblocks

Source

weblocks.lisp (file)

Macro: with-html-form (METHOD-TYPE ACTION &key ID CLASS ENCTYPE USE-AJAX-P EXTRA-SUBMIT-CODE SUBMIT-FN) &body BODY

Transforms to cl-who (:form) with standard form code (AJAX support, actions, etc.)

Package

weblocks

Source

html.lisp (file)

Macro: with-html-to-string &body BODY

A wrapper around cl-who with-html-output-to-string macro.

Package

weblocks

Source

weblocks.lisp (file)

Macro: with-javascript SOURCE &rest ARGS

Places ’source’ between script and CDATA elements. Used to avoid having to worry about special characters in JavaScript code.

Package

weblocks

Source

weblocks.lisp (file)

Macro: with-javascript-to-string SOURCE &rest ARGS

Places ’source’ between script and CDATA elements. Used to avoid having to worry about special characters in JavaScript code.

Package

weblocks

Source

weblocks.lisp (file)

Macro: with-webapp WEBAPP &body FORMS

Bind variables that are both webapp-specific, or applicable to just this app, and webapp-general, or not particular to some request to this app, with regard to WEBAPP.

Package

weblocks

Source

application.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: active-sessions ()

Returns a list of currently active sessions.

Package

weblocks

Source

server.lisp (file)

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

Based on Edi’s code in URL-REWRITE but uses & instead of & which is more appropriate for our uses.

Package

weblocks

Source

uri.lisp (file)

Function: adopt-widget PARENT WIDGET

Like (setf (widget-parent WIDGET) PARENT), but signal an error when WIDGET already has a parent (even if it’s PARENT).

Package

weblocks

Source

call-answer.lisp (file)

Function: ajax-request-p ()

Detects if the current request was initiated via AJAX by looking for ’X-Requested-With’ http header. This function expects to be called in a dynamic hunchentoot environment.

Package

weblocks

Source

request.lisp (file)

Function: alist->plist ALIST

Converts an alist to plist.

Package

weblocks-util

Source

list.lisp (file)

Function: anonymous-user-count ()

Returns the number of anonymous users on the server.

Package

weblocks

Source

login.lisp (file)

Function: answer CONTINUATION &optional RESULT

Returns control to location saved in CONTINUATION, which may be a callee widget or the continuation object explicitly. Continuation is called with RESULT (defaulting to NIL). If the widget doesn’t have a continuation, recursively tries its parents.

Package

weblocks

Source

call-answer.lisp (file)

Function: append-custom-fields CUSTOM-FIELDS ARGS

Appends ’custom-fields’ to the end of custom fields that are already defined in ’args’.

Package

weblocks-util

Source

misc.lisp (file)

Function: articlize WORD

Prepends a word with a proper indefinite article. Returns ’an apple’ for ’apple’ and ’a table’ for ’table’.

Package

weblocks

Source

grammar.lisp (file)

Function: asdf-system-directory ASDF-SYSTEM-NAME

Computes the directory in which the .asdf file for a given ASDF system resides.

Package

weblocks-util

Source

misc.lisp (file)

Function: attributize-presentation PRESENTATION

Attributizes presentation name.

Package

weblocks

Source

utils.lisp (file)

Function: authenticated-server-users ()

Returns authentication information found in each session on the server. Sessions without authentication information are ignored.

Package

weblocks

Source

login.lisp (file)

Function: authenticatedp ()

Returns nil if the current user is not authenticated. If the user is authenticated, authentication information stored in the session is returned.

Package

weblocks

Source

login.lisp (file)

Function: build-dependencies DEP-LIST &optional APP

Utility function: convert a list of either dependency objects or an alist of dependencies into a list of dependency objects. Used mostly when statically specyfing application dependencies, where alists are more convenient.

Package

weblocks

Source

dependencies.lisp (file)

Function: compute-public-files-path ASDF-SYSTEM-NAME &optional SUFFIX

Computes the directory of public files. The function uses the following protocol: it finds the canonical path of the ’.asd’ file of the system specified by ’asdf-system-name’, and goes into ’pub’.

Package

weblocks

Source

application.lisp (file)

Function: compute-webapp-public-files-uri-prefix-util &optional APP

A wrapper around ’compute-webapp-public-files-uri-prefix’ that handles current app.

Package

weblocks

Source

application.lisp (file)

Function: concatenate-keywords &rest SYMBOLS
Package

weblocks-util

Source

misc.lisp (file)

Function: consonantp CHAR

Checks if a character is a consonant.

Package

weblocks

Source

grammar.lisp (file)

Function: copy-widget-tree ROOT

Copy the widget tree at ROOT including all widgets below. Slots will be copied shallowly except for CHILDREN.

Package

weblocks

Source

widget.lisp (file)

Function: count-view-fields VIEW &rest GOVF-ARGS

Counts the number of fields in a given view.

Package

weblocks

Source

utils.lisp (file)

Function: create-folder-dispatcher-and-handler URI-PREFIX BASE-PATH &optional CONTENT-TYPE
Package

weblocks

Source

server.lisp (file)

Function: create-prefix-dispatcher PREFIX HANDLER
Package

weblocks

Source

server.lisp (file)

Function: create-regex-dispatcher REGEX HANDLER
Package

weblocks

Source

server.lisp (file)

Function: create-static-file-dispatcher-and-handler URI PATH &optional CONTENT-TYPE
Package

weblocks

Source

server.lisp (file)

Function: current-locale ()
Package

weblocks

Source

grammar.lisp (file)

Function: current-webapp ()

Returns the currently invoked instance of a web application.

Package

weblocks

Source

application.lisp (file)

Function: dataedit-delete-item WIDGET ITEM-ID

Should be called by dataedit widgets to delete a single
item. Deletes the item, and if ’dataedit-cascade-delete-mixins-p’ is set to true, deletes mixin objects.

obj - the dataedit object.
item-id - the integer id of the object to be deleted.

Package

weblocks

Source

delete-action.lisp (file)

Function: dataedit-delete-items-flow &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: dataseq-clear-selection OBJ

Clears selected items.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-data OBJ

Returns the items in the sequence. If ’dataseq-on-query’ is a function designator, calls the function designated by ’dataseq-on-query’. Otherwise, uses persistent store API.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-data-count OBJ

Returns the number of items in the sequence.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-field-sortable-p OBJ FIELD

Determines if a field is sortable.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-item-selected-p OBJ ITEM-ID

Checks if an item in the dataseq is marked as selected.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-operations-action &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: dataseq-persistent-query-function ON-QUERY-LIST

Returns a function suitable for slot ‘on-query’ on ‘dataseq’ that will call the persistent store API with the given on-query-list.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-select-item OBJ ITEM-ID

Marks an item in the dataseq as selected.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-selection-empty-p SELECTION-OR-DATASEQ

Returns true if no items are selected, nil otherwise. ’selection-or-dataseq’ should either be a dataseq widget or its selection slot (both are accepted for convinience).

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-sort-direction OBJ

The current sort direction in a given dataseq.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-sort-path OBJ

The current sort path in a given dataseq.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-sort-slot OBJ

The current sort slot in a given dataseq.

Package

weblocks

Source

dataseq.lisp (file)

Function: dataseq-update-sort-column OBJ

This function is called to ensure that a dataseq is sorted on sortable column (if one is available). If the dataseq is not sorted, this function finds the first sortable column and sorts the dataseq on that column.

Package

weblocks

Source

dataseq.lisp (file)

Function: default-translation-function STRING &key PLURAL-P GENITIVE-FORM-P ITEMS-COUNT ACCUSATIVE-FORM-P &allow-other-keys
Package

weblocks-util

Source

grammar.lisp (file)

Function: deftemplate NAME FUNCTION &rest CONTEXT

Associates function with template name. Template name is a keyword.
Context arguments used to calculate effective template.
:application-class, a symbol, this argument gives 10 points for template if its value equal to type of application used. :context-matches argument is a callback which will be called with template context during template calculation and should return points

Package

weblocks-util

Source

templates.lisp (file)

Function: delete-webapp-session-value KEY &optional SESSION WEBAPP

Clear the session value for the currently running webapp. KEY is compared using EQUAL.

Package

weblocks

Source

application.lisp (file)

Function: disable-global-debugging ()

A manual method for resetting global debugging state

Package

weblocks

Source

debug-mode.lisp (file)

Function: do-choice &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-confirmation &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-dialog &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-information &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-login &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-modal &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-page &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: do-widget &rest ARGS
Package

weblocks

Source

/home/quickref/quicklisp/dists/quicklisp/software/cl-cont-20110219-darcs/src/special-transformers.lisp

Function: doc ()