12 The LISPWORKS Package

define-action-list

Macro

Summary

Defines a registered action list.

Package

lispworks

Signature

define-action-list uid &key documentation sort-time dummy-actions default-order execution-function =>

Arguments

uid: A general lisp object.
documentation: A string.
sort-time: One of:execute or:define-action.
dummy-actions: A list.
default-order: A list.
execution-function: A function.

Description

Thedefine-action-list macro defines an action list.

uid is a unique identifier, and must be a general lisp object, to be compared byequalp. It names the list in the global registry of lists. Seemake-unregistered-action-list to create unnamed, "unregistered" action-lists. The uid may be quoted, but is not required to be. It is possible, but not recommended, to define an action-list with unique identifiernil. If a registered action-list with the uid already exists (that is, one which returnst when compared withequalp), then notification and subsequent handling is controlled by the value of the *handle-existing-action-list* variable.

The documentation string allows you to provide documentation for the action list.

sort-time is a keyword specifying when added actions are sorted for the given list -- either:execute or:define-action (see *default-action-list-sort-time*).

dummy-actions is a list of action-names that specify placeholding actions; they cannot be executed and are constrained to the order specified in this list, for example

'(:beginning :middle :end)

: default-order specifies default ordering constraints for subsequently defined action-items where no explicit ordering constraints are specified. An example is

'(:after beginning :before :end)

: execution-function specifies a user-defined function accepting arguments of the form:

(the-action-list other-args-list &rest keyword-value-pairs)

: where the two required arguments are the action-list and a list of additional arguments passed toexecute-actions, respectively. The remaining arguments are any number of keyword-value pairs that may be specified in the call toexecute-actions. If no execution function is specified, then the default execution function will be used to execute the action-list.
See also
: *default-action-list-sort-time*
*handle-existing-action-list*
undefine-action-list