This is the clip Reference Manual, version 0.7.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:40:20 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
clipAn HTML templating engine using Plump.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/clip.git)
zlib
0.7.0
array-utils (system).
lquery (system).
package.lisp (file).
toolkit.lisp (file).
conditions.lisp (file).
clipboard.lisp (file).
attr-processors.lisp (file).
tag-processors.lisp (file).
processor.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clip/clip.asdclip/package.lispclip/toolkit.lispclip/conditions.lispclip/clipboard.lispclip/attr-processors.lispclip/tag-processors.lispclip/processor.lispclip/toolkit.lisppackage.lisp (file).
clip (system).
concat (function).
make-keyword (function).
clip/conditions.lisptoolkit.lisp (file).
clip (system).
attribute-condition (condition).
check-attribute (function).
check-no-unknown-attributes (function).
check-sole-attribute (function).
clip-condition (condition).
missing-attribute (condition).
node-condition (condition).
unknown-attribute (condition).
clip/clipboard.lispconditions.lisp (file).
clip (system).
*clipboard-stack* (special variable).
clip (generic function).
(setf clip) (generic function).
clipboard (function).
(setf clipboard) (function).
clipboard (class).
make-clipboard (function).
parse-and-resolve (function).
resolve-attribute (function).
resolve-value (generic function).
with-clipboard-bound (macro).
clipboard-env (reader method).
(setf clipboard-env) (writer method).
clip/attr-processors.lispclipboard.lisp (file).
clip (system).
*attribute-processors* (special variable).
*target* (special variable).
attribute-processor (function).
(setf attribute-processor) (function).
define-attribute-processor (macro).
process-attribute (function).
process-attributes (function).
*target-counter* (special variable).
replace-region (function).
clip/tag-processors.lispattr-processors.lisp (file).
clip (system).
*tag-processors* (special variable).
define-tag-processor (macro).
process-children (function).
process-node (function).
process-tag (function).
tag-processor (function).
(setf tag-processor) (function).
splice-into (function).
clip/processor.lisptag-processors.lisp (file).
clip (system).
process (function).
process-to-string (function).
Packages are listed by definition order.
cliporg.tymoonnext.clip
common-lisp.
lquery.
*attribute-processors* (special variable).
*clipboard-stack* (special variable).
*tag-processors* (special variable).
*target* (special variable).
attribute-condition (condition).
attribute-processor (function).
(setf attribute-processor) (function).
check-attribute (function).
check-no-unknown-attributes (function).
check-sole-attribute (function).
clip (generic function).
(setf clip) (generic function).
clip-condition (condition).
clipboard (function).
(setf clipboard) (function).
clipboard (class).
define-attribute-processor (macro).
define-tag-processor (macro).
make-clipboard (function).
missing-attribute (condition).
node-condition (condition).
parse-and-resolve (function).
process (function).
process-attribute (function).
process-attributes (function).
process-children (function).
process-node (function).
process-tag (function).
process-to-string (function).
resolve-attribute (function).
resolve-value (generic function).
tag-processor (function).
(setf tag-processor) (function).
unknown-attribute (condition).
with-clipboard-bound (macro).
*target-counter* (special variable).
clipboard-env (generic reader).
(setf clipboard-env) (generic writer).
concat (function).
make-keyword (function).
replace-region (function).
splice-into (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Global registry of attribute processors.
This has to be an EQUALP hash-table with the attribute name as keys and functions that accept two arguments (node attribute-value) as values. Binding this variable can be useful to establish local attributes.
clip.
Template storage stack. When new clipboards are bound, they are pushed onto the stack. Once the binding is left, they are popped off the stack again.
clip.
Global registry of tag processors.
This has to be an EQUALP hash-table with the tag name as keys and functions that accept one argument (the node) as values. Binding this variable can be useful to establish local tags.
clip.
This variable is bound to whatever node is currently being processed.
clip.
Defines a new attribute processor.
ATTRIBTUE — A symbol or string that matches the attribute to process (case-insensitive)
NODE — The current node is bound to this symbol.
VALUE — The value of the attribute is bound to this symbol.
BODY ::= form*
clip.
Defines a new attribute processor.
TAG — A symbol or string that matches the tag name to process (case-insensitive)
NODE — The node to process is bound to this symbol
BODY ::= form*
clip.
Executes the body with the new clipboard on the *CLIPBOARD-STACK*.
If fields are provided, they are set on the NEW-CLIPBOARD in plist fashion as per consecutive SETF. This means that side-effects of an early field set affect later fields. The fields are evaluated before the NEW-CLIPBOARD is pushed onto the *CLIPBOARD-STACK*.
clip.
Returns the processor function for the requested attribute if one is registered. Otherwise returns NIL. See *ATTRIBUTE-PROCESSORS*.
clip.
Sets the attribute-processor bound to the given attribute to the specified function. See *ATTRIBUTE-PROCESSORS*.
clip.
Checks whether the given attribute is present on the node.
If it is, the attribute’s value is returned.
Otherwise, an error of type MISSING-ATTRIBUTE is signalled.
See MISSING-ATTRIBUTE
clip.
Checks whether there are any unknown attributes present on the node.
If an unknown attribute is present, a warning of type
UNKNOWN-ATTRIBUTE is signalled. Otherwise, NIL is returned.
See UNKNOWN-ATTRIBUTE
clip.
Checks whether the given attribute is the only attribute on the node.
If it is not present, or not the only one, an error is signalled.
Otherwise, the attribute’s value is returned.
See CHECK-NO-UNKNOWN-ATTRIBUTES
See CHECK-ATTRIBUTE
clip.
Shorthand for (CLIP (FIRST *CLIPBOARD-STACK*) FIELD)
clip.
Shorthand for (SETF (CLIP (FIRST *CLIPBOARD-STACK*) FIELD) VALUE)
clip.
Creates a new clipboard using the specified fields (like a plist).
clip.
If the passed value is a STRING it is parsed using READ-FROM-STRING and subsequently passed to RESOLVE-VALUE. If it is not a string, the value itself is returned.
clip.
Processes all clip markup on the target with the given FIELDS used to initialise the clipboard.
clip.
Processes the specified attribute using the given value. If no attribute processor can be found, nothing is done. See *ATTRIBUTE-PROCESSORS*.
clip.
Processes all attributes on the node. See PROCESS-ATTRIBUTE.
clip.
Calls PROCESS-NODE on all childrens of the passed node.
This takes some care to make sure that splicing into the childrens array of the node is possible. However, note that inserting children before the node that is currently being processed will most likely lead to horrors. If such functionality is indeed ever needed (I hope not), this system needs to be rewritten to somehow be able to cope with such scenarios.
clip.
Processes the passed node.
Depending on type the following is done:
PLUMP:ELEMENT PROCESS-TAG is called.
PLUMP:NESTING-NODE PROCESS-CHILDREN is called.
PLUMP:NODE Nothing is done.
T An error is signalled.
Any call to this also increases the *TARGET-COUNTER* regardless of what
is done.
clip.
Processes the specified node as the given tag.
If no tag processor can be found, PROCESS-ATTRIBUTES and PROCESS-CHILDREN is called.
See *TAG-PROCESSORS*.
clip.
Same as PROCESS, but automatically performs PLUMP:SERIALIZE on the result to a string.
clip.
Shorthand to resolve the value of an attibute. See RESOLVE-VALUE.
clip.
Returns the processor function for the requested tag if one is registered. Otherwise returns NIL. See *TAG-PROCESSORS*.
clip.
Sets the tag-processor bound to the given tag-name to the specified function. See *TAG-PROCESSORS*.
clip.
Generic object accessor.
If you want to get special treatment of objects or types, define your own methods on this.
clip.
structure-object) field) ¶Generic slot accessor.
standard-object) field) ¶Generic slot accessor.
list) field) ¶Generic alist or plist accessor.
hash-table) field) ¶Generic hash-table accessor.
Generic object setter.
If you want to get special treatment of objects or types, define your own methods on this.
Attempts to resolve the object to a specific value.
This is usually used in combination with READ-FROM-STRING of an attribute value.
clip.
list)) ¶Handler for lists, aka function calls.
The function call is decided upon the CAR of the list.
The following cases are handled:
QUOTE Returns the first argument
FUNCTION Returns the symbol-function of the first argument
OR Simulated version of the OR macro.
AND Simulated version of the AND macro.
Otherwise the symbol is looked for in the :CLIP package and then the current *PACKAGE*. If found, the function is applied with all arguments of the list (which are first all individually passed to RESOLVE-VALUE too).
symbol)) ¶Handler for symbols.
If the symbol is EQL to ’* the *CLIPBOARD* is returned,
If the symbol is a keyword the symbol itself is returned,
otherwise the value of (CLIPBOARD SYMBOL) is returned.
Default fallback for unrecognized objects; simply returns it.
Superclass for all conditions related to problems with a node’s attribute.
See NODE-CONDITION
Superclass for all conditions related to Clip.
clip.
condition.
Condition signalled when a required attribute is missing.
See ATTRIBUTE-CONDITION
clip.
attribute-condition.
error.
Superclass for all conditions related to problems with a node.
See CLIP-CONDITION
Condition signalled when an unknown attribute is present.
See ATTRIBUTE-CONDITION
clip.
attribute-condition.
warning.
Special class for clipboard environments. Use CLIPBOARD or CLIP to access and set values within. Field names are automatically transformed into strings as per STRING. Access is case-insensitive.
This counter is upped whenever process-node is called.
clip.
Returns a space concatenated string of the passed list.
clip.
| Jump to: | (
A C D F G M P R S T W |
|---|
| Jump to: | (
A C D F G M P R S T W |
|---|
| Jump to: | %
*
A N S |
|---|
| Jump to: | %
*
A N S |
|---|
| Jump to: | A C F M N P S T U |
|---|
| Jump to: | A C F M N P S T U |
|---|