Table of Contents

System Information

Definition Index

• CLIP

  • ORG.TYMOONNEXT.CLIP

  No documentation provided.

  • EXTERNAL SPECIAL-VARIABLE

    *ATTRIBUTE-PROCESSORS*

    Source

    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.

  • EXTERNAL SPECIAL-VARIABLE

    *CLIPBOARD-STACK*

    Source

    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.

  • EXTERNAL SPECIAL-VARIABLE

    *TAG-PROCESSORS*

    Source

    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.

  • EXTERNAL SPECIAL-VARIABLE

    *TARGET*

    Source

    This variable is bound to whatever node is currently being processed.

  • EXTERNAL CLASS

    CLIPBOARD

    Source

    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.

  • EXTERNAL CONDITION

    ATTRIBUTE-CONDITION

    Source

    Superclass for all conditions related to problems with a node's attribute.
    
    See NODE-CONDITION

  • EXTERNAL CONDITION

    CLIP-CONDITION

    Source

    Superclass for all conditions related to Clip.

  • EXTERNAL CONDITION

    MISSING-ATTRIBUTE

    Source

    Condition signalled when a required attribute is missing.
    
    See ATTRIBUTE-CONDITION

  • EXTERNAL CONDITION

    NODE-CONDITION

    Source

    Superclass for all conditions related to problems with a node.
    
    See CLIP-CONDITION

  • EXTERNAL CONDITION

    UNKNOWN-ATTRIBUTE

    Source

    Condition signalled when an unknown attribute is present.
    
    See ATTRIBUTE-CONDITION

  • EXTERNAL FUNCTION

    ATTRIBUTE-PROCESSOR

    • ATTRIBUTE

    Source

    Returns the processor function for the requested attribute if one is registered.
    Otherwise returns NIL. See *ATTRIBUTE-PROCESSORS*.

  • EXTERNAL FUNCTION

    (SETF ATTRIBUTE-PROCESSOR)

    • FUNC
    • ATTRIBUTE

    Source

    Sets the attribute-processor bound to the given attribute to the specified function.
    See *ATTRIBUTE-PROCESSORS*.

  • EXTERNAL FUNCTION

    CHECK-ATTRIBUTE

    • NODE
    • ATTRIBUTE

    Source

    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

  • EXTERNAL FUNCTION

    CHECK-NO-UNKNOWN-ATTRIBUTES

    • NODE
    • &REST
    • KNOWN-ATTRIBUTES

    Source

    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

  • EXTERNAL FUNCTION

    CHECK-SOLE-ATTRIBUTE

    • NODE
    • ATTRIBUTE

    Source

    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

  • EXTERNAL FUNCTION

    CLIPBOARD

    • FIELD

    Source

    Shorthand for (CLIP (FIRST *CLIPBOARD-STACK*) FIELD)

  • EXTERNAL FUNCTION

    (SETF CLIPBOARD)

    • VALUE
    • FIELD

    Source

    Shorthand for (SETF (CLIP (FIRST *CLIPBOARD-STACK*) FIELD) VALUE)

  • EXTERNAL FUNCTION

    MAKE-CLIPBOARD

    • &REST
    • FIELDS

    Source

    Creates a new clipboard using the specified fields (like a plist).

  • EXTERNAL FUNCTION

    PARSE-AND-RESOLVE

    • VALUE

    Source

    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.

  • EXTERNAL FUNCTION

    PROCESS

    • TARGET
    • &REST
    • FIELDS

    Source

    Processes all clip markup on the target with the given FIELDS used to initialise the clipboard.

  • EXTERNAL FUNCTION

    PROCESS*

    • TARGET
    • CLIPBOARD

    Source

    Processes all clip markup on the target with the given CLIPBOARD.

  • EXTERNAL FUNCTION

    PROCESS-ATTRIBUTE

    • NODE
    • ATTRIBUTE
    • VALUE

    Source

    Processes the specified attribute using the given value.
    If no attribute processor can be found, nothing is done.
    See *ATTRIBUTE-PROCESSORS*.

  • EXTERNAL FUNCTION

    PROCESS-ATTRIBUTES

    • NODE

    Source

    Processes all attributes on the node.
    See PROCESS-ATTRIBUTE.

  • EXTERNAL FUNCTION

    PROCESS-CHILDREN

    • NODE

    Source

    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. 

  • EXTERNAL FUNCTION

    PROCESS-NODE

    • NODE

    Source

    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.

  • EXTERNAL FUNCTION

    PROCESS-TAG

    • TAG
    • NODE

    Source

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

  • EXTERNAL FUNCTION

    PROCESS-TO-STRING

    • TARGET
    • &REST
    • FIELDS

    Source

    Same as PROCESS, but automatically performs PLUMP:SERIALIZE on the result to a string.

  • EXTERNAL FUNCTION

    RESOLVE-ATTRIBUTE

    • NODE
    • ATTR

    Source

    Shorthand to resolve the value of an attibute.
    See RESOLVE-VALUE.

  • EXTERNAL FUNCTION

    TAG-PROCESSOR

    • TAG

    Source

    Returns the processor function for the requested tag if one is registered.
    Otherwise returns NIL. See *TAG-PROCESSORS*.

  • EXTERNAL FUNCTION

    (SETF TAG-PROCESSOR)

    • FUNC
    • TAG

    Source

    Sets the tag-processor bound to the given tag-name to the specified function.
    See *TAG-PROCESSORS*.

  • EXTERNAL GENERIC-FUNCTION

    CLIP

    • OBJECT
    • FIELD

    Source

    Generic object accessor.
    If you want to get special treatment of objects or types, define your own methods on this.

  • EXTERNAL GENERIC-FUNCTION

    (SETF CLIP)

    • VALUE
    • OBJECT
    • FIELD

    Source

    Generic object setter.
    If you want to get special treatment of objects or types, define your own methods on this.

  • EXTERNAL GENERIC-FUNCTION

    RESOLVE-VALUE

    • OBJECT

    Source

    Attempts to resolve the object to a specific value.
    This is usually used in combination with READ-FROM-STRING of an attribute value.

  • EXTERNAL MACRO

    DEFINE-ATTRIBUTE-PROCESSOR

    • ATTRIBUTE
    • NODE
    • VALUE
    • &BODY
    • BODY

    Source

    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*

  • EXTERNAL MACRO

    DEFINE-TAG-PROCESSOR

    • TAG
    • NODE
    • &BODY
    • BODY

    Source

    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*

  • EXTERNAL MACRO

    WITH-CLIPBOARD-BOUND

    • NEW-CLIPBOARD
    • &REST
    • FIELDS
    • &BODY
    • BODY

    Source

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