Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.69 KB

base.md

File metadata and controls

91 lines (62 loc) · 3.69 KB
Raw

PROTEST/BASE

Summary

The package PROTEST/BASE exports the base functionality useful for manual definition of protcols.

Protocol classes and protocol condition types are instances of Common Lisp classes and condition types, respectively, except they must not be instantiated directly by client code. Users of these classes must instead create subclasses of these protocol classes or subtypes of these protocol condition types in order for them to participate in the protocol. PROTEST/BASE achieves this by defining an :AROUND method on INITIALIZE-INSTANCE specialized on that class, therefore client code must not do that itself in order to avoid collisions.

The macros DEFINE-PROTOCOL-CLASS and DEFINE-PROTOCOL-CONDITION-TYPE can be used for defining protocol classes and protocol condition types, while condition type PROTOCOL-OBJECT-INSTANTIATION can be handled specifically to handle errors that arise when users attempt to instantiate these protocol objects.

Additionally, the condition type PROTOCOL-ERROR can be handled to handle all errors that arise regarding protocol and test-case definition. This condition type is later reused in other PROTEST packages.

Protocol classes and protocol condition types may be redefined as normal classes and normal condition types, after which they may be normally instantiated. To achieve this, redefine them using the standard DEFCLASS and DEFINE-CONDITION macros instead of DEFINE-PROTOCOL-CLASS and DEFINE-PROTOCOL-CONDITION-TYPE.

Internal dependencies

None.

Exports

  • Function PROTOCOL-OBJECT-P

    Syntax: (protocol-object-p OBJECT)

    Returns true if the given object has been declared as a protocol object or a protocol condition type.

  • Function REMOVE-PROTOCOL-OBJECT

    Syntax: (remove-protocol-object OBJECT)

    Removes the provided protocol object from the Lisp image.

  • Macro DEFINE-PROTOCOL-CLASS

    Syntax: (define-protocol-class NAME SUPERCLASSES SLOTS &rest OPTIONS)

    Like DEFCLASS, but the defined class will not be directly instantiable.

  • Macro DEFINE-PROTOCOL-CONDITION-TYPE

    Syntax: (define-protocol-condition-type NAME SUPERTYPES SLOTS &rest OPTIONS)

    Like DEFINE-CONDITION, but the defined condition type will not be directly instantiable.

    SBCL Note: This SBCL issue prevents this constraint from being enforceable on SBCL for all condition instances instantiated via MAKE-CONDITION. If you want to avoid this behavior, make sure that you instantiate your conditions via MAKE-INSTANCE instead. While not being compliant with the ANSI CL standard, this method of instantiating conditions works correctly at the time of writing on SBCL, CCL, ECL, ABCL, ACL and LispWorks.

  • Condition Type PROTOCOL-ERROR

    Parent condition type of all errors related to protocols.

  • Condition Type SIMPLE-PROTOCOL-ERROR

    Condition type of supertypes PROTOCOL-ERROR and SIMPLE-CONDITION.

  • Condition Type PROTOCOL-OBJECT-INSTANTIATION

    Error type signaled whenever protocol objects (such as protocol classes and protocol condition types) are attempted to be instantiated.

    Accessors:

    • Reader PROTOCOL-OBJECT-INSTANTIATION-SYMBOL - returns the name of the object that was attempted to be instantiated when PROTOCOL-OBJECT-INSTANTIATION was signaled.
    • Reader PROTOCOL-OBJECT-INSTANTIATION-TYPE - returns the human-readable representation of type of the object that was attempted to be instantiated when PROTOCOL-OBJECT-INSTANTIATION was signaled.