The protest Reference Manual

Table of Contents

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

The protest Reference Manual

This is the protest Reference Manual, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 14:48:41 2019 GMT+0.


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

1 Introduction

Common Lisp PROtocol and TESTcase manager

PROTEST is a tool for defining protocols and test cases written in and for Common Lisp, featuring integration with ~~multiple~~ one testing framework. (More will come.)

tl;dr

(ql:quickload :protest)
(use-package :protest)

;; depending on your choice of test library, load one of the following
(ql:quickload :protest/parachute)
(use-package :protest/parachute)

(ql:quickload :protest/1am)
(use-package :protest/1am)

Modules

The currently implemented modules are:

The modules planned for development (someday) are:

Testing PROTEST

Load the ASDF system PROTEST/TEST and run (PROTEST/TEST:RUN-ALL-TESTS), or perform ASDF's TEST-OP on the PROTEST module.

Please note that this does not invoke tests for the modules integrating PROTEST with testing libraries; see the manual for each such module to find the means of testing it.

License

All of PROTEST is licensed under GNU Lisp Lesser General Public License, except the PROTEST/PARACHUTE system which is an extension to the Parachute library and therefore licensed under the Artistic license.


PROTEST © 2018 Michał "phoe" Herda

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 US


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 protest

Author

Michał "phoe" Herda <phoe@disroot.org>

License

LLGPL

Description

Common Lisp PROtocol and TESTcase Manager

Dependencies
Source

protest.asd (file)

Component

src/package.lisp (file)


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

2.2 protest/protocol

Author

Michał "phoe" Herda <phoe@disroot.org>

License

LLGPL

Description

Protocol defining utilities for PROTEST

Dependencies
Source

protest.asd (file)

Components

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

2.3 protest/ftype

Author

Michał "phoe" Herda <phoe@disroot.org>

License

LLGPL

Description

FTYPE generation for PROTEST

Dependency

alexandria

Source

protest.asd (file)

Components

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

2.4 protest/test-case

Author

Michał "phoe" Herda <phoe@disroot.org>

License

LLGPL

Description

Test case defining utilities for PROTEST

Dependencies
Source

protest.asd (file)

Components

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

2.5 protest/base

Author

Michał "phoe" Herda <phoe@disroot.org>

License

LLGPL

Description

Base macros and utilities for PROTEST

Dependencies
Source

protest.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 protest.asd

Location

protest.asd

Systems

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

3.1.2 protest/src/package.lisp

Parent

protest (system)

Location

src/package.lisp

Packages

protest


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

3.1.3 protest/protocol/src/protocol/package.lisp

Parent

protest/protocol (system)

Location

src/protocol/package.lisp

Packages

protest/protocol


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

3.1.4 protest/protocol/src/protocol/elements.lisp

Dependency

src/protocol/package.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements.lisp

Exported Definitions

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

3.1.5 protest/protocol/src/protocol/elements/function.lisp

Dependency

src/protocol/elements.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/function.lisp

Exported Definitions
Internal Definitions

defgeneric? (macro)


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

3.1.6 protest/protocol/src/protocol/elements/macro.lisp

Dependency

src/protocol/elements/function.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/macro.lisp

Exported Definitions
Internal Definitions

embed-documentation (method)


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

3.1.7 protest/protocol/src/protocol/elements/class.lisp

Dependency

src/protocol/elements/macro.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/class.lisp

Exported Definitions

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

3.1.8 protest/protocol/src/protocol/elements/condition-type.lisp

Dependency

src/protocol/elements/class.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/condition-type.lisp

Exported Definitions

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

3.1.9 protest/protocol/src/protocol/elements/variable.lisp

Dependency

src/protocol/elements/condition-type.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/variable.lisp

Exported Definitions
Internal Definitions

embed-documentation (method)


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

3.1.10 protest/protocol/src/protocol/elements/category.lisp

Dependency

src/protocol/elements/variable.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/category.lisp

Exported Definitions
Internal Definitions

*category-documentation-store* (special variable)


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

3.1.11 protest/protocol/src/protocol/elements/config.lisp

Dependency

src/protocol/elements/category.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/elements/config.lisp

Exported Definitions
Internal Definitions

*config-documentation-store* (special variable)


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

3.1.12 protest/protocol/src/protocol/definition.lisp

Dependency

src/protocol/elements/config.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/definition.lisp

Exported Definitions
Internal Definitions

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

3.1.13 protest/protocol/src/protocol/validation.lisp

Dependency

src/protocol/definition.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/validation.lisp

Internal Definitions

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

3.1.14 protest/protocol/src/protocol/macro.lisp

Dependency

src/protocol/validation.lisp (file)

Parent

protest/protocol (system)

Location

src/protocol/macro.lisp

Exported Definitions
Internal Definitions

ensure-protocol (function)


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

3.1.15 protest/ftype/src/ftype/package.lisp

Parent

protest/ftype (system)

Location

src/ftype/package.lisp

Packages

protest/ftype


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

3.1.16 protest/ftype/src/ftype/ftype.lisp

Dependency

src/ftype/package.lisp (file)

Parent

protest/ftype (system)

Location

src/ftype/ftype.lisp

Exported Definitions

function-ftype-declaration-form (function)

Internal Definitions

lambda-list-argument-types (function)


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

3.1.17 protest/test-case/src/test-case/package.lisp

Parent

protest/test-case (system)

Location

src/test-case/package.lisp

Packages

protest/test-case


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

3.1.18 protest/test-case/src/test-case/test-step.lisp

Dependency

src/test-case/package.lisp (file)

Parent

protest/test-case (system)

Location

src/test-case/test-step.lisp

Exported Definitions

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

3.1.19 protest/test-case/src/test-case/test-case.lisp

Dependency

src/test-case/test-step.lisp (file)

Parent

protest/test-case (system)

Location

src/test-case/test-case.lisp

Exported Definitions
Internal Definitions

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

3.1.20 protest/base/src/base/package.lisp

Parent

protest/base (system)

Location

src/base/package.lisp

Packages

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

3.1.21 protest/base/src/base/base.lisp

Dependency

src/base/package.lisp (file)

Parent

protest/base (system)

Location

src/base/base.lisp

Exported Definitions
Internal Definitions

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

3.1.22 protest/base/src/base/protocol-error.lisp

Dependency

src/base/base.lisp (file)

Parent

protest/base (system)

Location

src/base/protocol-error.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 protest

Source

src/package.lisp (file)

Use List

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

4.2 protest/protocol

Source

src/protocol/package.lisp (file)

Use List
Used By List

protest

Exported Definitions
Internal Definitions

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

4.3 protest/ftype

Source

src/ftype/package.lisp (file)

Use List
Used By List

protest/protocol

Exported Definitions

function-ftype-declaration-form (function)

Internal Definitions

lambda-list-argument-types (function)


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

4.4 protest/test-case

Source

src/test-case/package.lisp (file)

Use List
Used By List

protest

Exported Definitions
Internal Definitions

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

4.5 protest/common

This package exports symbols common across all PROTEST packages to avoid conflicts between individual PROTEST packages.

Source

src/base/package.lisp (file)

Used By List
Exported Definitions

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

4.6 protest/base

Source

src/base/package.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *category-callback*

A function of one argument used as a callback for declaring categories. The only argument is the category name.

Package

protest/protocol

Source

src/protocol/elements/category.lisp (file)

Special Variable: *config-callback*

A function of two arguments used as a callback for declaring configuration values. The first argument is the configuration entry name, the second is the type that the value of the configuration entry is allowed to take, the third is a boolean stating if the configuration entry is mandatory to be set, and the fourth is the initial value that was passed in the protocol. If no optional value was provided, this argument is not passed.

Package

protest/protocol

Source

src/protocol/elements/config.lisp (file)

Special Variable: *protocols*

A hash-table mapping from protocol names to protocol objects.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)


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

5.1.2 Macros

Macro: define-protocol NAME (&rest OPTIONS) &body FORMS

Defines the protocol with the provided NAME and OPTIONS, instantiating all its elements based on FORMS.

Package

protest/protocol

Source

src/protocol/macro.lisp (file)

Macro: define-protocol-class NAME SUPERCLASSES SLOTS &rest OPTIONS

Like DEFCLASS, but the defined class may not be instantiated directly.

Package

protest/base

Source

src/base/base.lisp (file)

Macro: define-protocol-condition-type NAME SUPERTYPES SLOTS &rest OPTIONS

Like DEFINE-CONDITION, but the defined class may not be instantiated directly.

Package

protest/base

Source

src/base/base.lisp (file)

Macro: define-test-case NAME (&rest OPTIONS) &body STEPS
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Macro: execute-protocol NAME

Executes all the side effects of the protocol with the provided NAME.

Package

protest/protocol

Source

src/protocol/macro.lisp (file)


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

5.1.3 Functions

Function: compute-effective-protocol-elements PROTOCOL

Returns a fresh list of all protocol elements that occur inside the provided protocol and all of its dependencies, including transitive ones.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: find-protocol NAME

Returns the protocol with the provided name.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Writer

(setf find-protocol) (function)

Function: (setf find-protocol) NEW-VALUE NAME

Sets the protocol with the provided name.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Reader

find-protocol (function)

Function: find-test-case NAME &optional PACKAGE

Returns the test case with the provided name from the provided package.

Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Writer

(setf find-test-case) (function)

Function: (setf find-test-case) NEW-VALUE NAME &optional PACKAGE

Sets the test case with the provided name with the provided package.

Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Reader

find-test-case (function)

Function: function-ftype-declaration-form TYPED-LAMBDA-LIST &optional RESULT-TYPE KEYWORD-TYPES

Given a lambda list annotated with types and a function result type, produces a form suitable for usage inside FTYPE declarations.

Package

protest/ftype

Source

src/ftype/ftype.lisp (file)

Function: generate-element TYPE DETAILS &optional DECLAIM-TYPE-P

Given the keyword representing the element type and the rest of that element’s list representation, attempts to generate and return a matching protocol element. Signals PROTOCOL-ERROR if the generation fails. The argument DECLAIM-TYPE-P states if the types of functions and variables should be declaimed; it may be ignored by the method.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Function: protocol-error FORMAT-CONTROL &rest ARGS
Package

protest/base

Source

src/base/protocol-error.lisp (file)

Function: protocol-object-p OBJECT

Returns true if CLASS is a protocol class or a protocol condition type, and false otherwise.

Package

protest/base

Source

src/base/base.lisp (file)


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

5.1.4 Generic functions

Generic Function: attachments OBJECT
Generic Function: (setf attachments) NEW-VALUE OBJECT
Package

protest/common

Methods
Method: attachments (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Method: (setf attachments) NEW-VALUE (TEST-CASE test-case)

automatically generated writer method

Source

src/test-case/test-case.lisp (file)

Method: attachments (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf attachments) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)

Generic Function: bindings OBJECT
Generic Function: (setf bindings) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: bindings (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf bindings) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)

Generic Function: canonical-name PROTOCOL-ELEMENT

Returns the canonical name of the protocol element.

If a protocol element has a name that is a list, a canonical name of that element is a copy of that element’s name, in which non-keyword symbols have been replaced by NIL. Otherwise, the canonical name is the name of the element.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: canonical-name (CONFIG protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: canonical-name (CATEGORY protocol-category)
Source

src/protocol/elements/category.lisp (file)

Method: canonical-name (PROTOCOL-ELEMENT protocol-element)
Generic Function: declaim-type-p OBJECT
Generic Function: (setf declaim-type-p) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: declaim-type-p (PROTOCOL-VARIABLE protocol-variable)

automatically generated reader method

Source

src/protocol/elements/variable.lisp (file)

Method: (setf declaim-type-p) NEW-VALUE (PROTOCOL-VARIABLE protocol-variable)

automatically generated writer method

Source

src/protocol/elements/variable.lisp (file)

Method: declaim-type-p (PROTOCOL-FUNCTION protocol-function)

automatically generated reader method

Source

src/protocol/elements/function.lisp (file)

Method: (setf declaim-type-p) NEW-VALUE (PROTOCOL-FUNCTION protocol-function)

automatically generated writer method

Source

src/protocol/elements/function.lisp (file)

Generic Function: dependencies OBJECT
Package

protest/protocol

Methods
Method: dependencies (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Generic Function: description OBJECT
Package

protest/test-case

Methods
Method: description (TEST-STEP test-step)

automatically generated reader method

Source

src/test-case/test-step.lisp (file)

Generic Function: docstring OBJECT
Generic Function: (setf docstring) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: docstring (PROTOCOL-ELEMENT protocol-element)

automatically generated reader method

Source

src/protocol/elements.lisp (file)

Method: (setf docstring) NEW-VALUE (PROTOCOL-ELEMENT protocol-element)

automatically generated writer method

Source

src/protocol/elements.lisp (file)

Generic Function: elements OBJECT
Generic Function: (setf elements) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: elements (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf elements) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)

Generic Function: exports OBJECT
Generic Function: (setf exports) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: exports (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf exports) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)

Generic Function: generate-code OBJECT

Generates a fresh list of forms that is suitable to be NCONCed with other forms to generate the Lisp code that is meant to come into effect when the protocol is defined.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: generate-code (PROTOCOL protocol)
Source

src/protocol/definition.lisp (file)

Method: generate-code (ELEMENT protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: generate-code (ELEMENT protocol-category)
Source

src/protocol/elements/category.lisp (file)

Method: generate-code (ELEMENT protocol-variable)
Source

src/protocol/elements/variable.lisp (file)

Method: generate-code (ELEMENT protocol-condition-type)
Source

src/protocol/elements/condition-type.lisp (file)

Method: generate-code (ELEMENT protocol-class)
Source

src/protocol/elements/class.lisp (file)

Method: generate-code (ELEMENT protocol-macro)
Source

src/protocol/elements/macro.lisp (file)

Method: generate-code (ELEMENT protocol-function)
Source

src/protocol/elements/function.lisp (file)

Generic Function: generate-element-using-class CLASS DETAILS &optional DECLAIM-TYPE-P

Given the concrete class of the element type and the list representing that element’s list representation, attempts to generate and return a matching protocol element. Signals PROTOCOL-ERROR if the generation fails. The argument DECLAIM-TYPE-P states if the types of functions and variables should be declaimed; it may be ignored by the method.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-config>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/config.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-category>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/category.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-variable>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/variable.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-condition-type>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/condition-type.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-class>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/class.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-macro>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/macro.lisp (file)

Method: generate-element-using-class (CLASS (eql #<standard-class protest/protocol:protocol-function>)) DETAILS &optional DECLAIM-TYPE-P
Source

src/protocol/elements/function.lisp (file)

Generic Function: generate-forms ELEMENT

Generates a fresh list of forms that is suitable to be NCONCed with other forms to generate a protocol body.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: generate-forms (ELEMENT protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: generate-forms (ELEMENT protocol-category)
Source

src/protocol/elements/category.lisp (file)

Method: generate-forms (ELEMENT protocol-variable)
Source

src/protocol/elements/variable.lisp (file)

Method: generate-forms (ELEMENT protocol-condition-type)
Source

src/protocol/elements/condition-type.lisp (file)

Method: generate-forms (ELEMENT protocol-class)
Source

src/protocol/elements/class.lisp (file)

Method: generate-forms (ELEMENT protocol-macro)
Source

src/protocol/elements/macro.lisp (file)

Method: generate-forms (ELEMENT protocol-function)
Source

src/protocol/elements/function.lisp (file)

Generic Function: id OBJECT
Package

protest/test-case

Methods
Method: id (TEST-STEP test-step)

automatically generated reader method

Source

src/test-case/test-step.lisp (file)

Generic Function: initial-value OBJECT
Generic Function: (setf initial-value) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: initial-value (PROTOCOL-CONFIG protocol-config)

automatically generated reader method

Source

src/protocol/elements/config.lisp (file)

Method: (setf initial-value) NEW-VALUE (PROTOCOL-CONFIG protocol-config)

automatically generated writer method

Source

src/protocol/elements/config.lisp (file)

Method: initial-value (PROTOCOL-VARIABLE protocol-variable)

automatically generated reader method

Source

src/protocol/elements/variable.lisp (file)

Method: (setf initial-value) NEW-VALUE (PROTOCOL-VARIABLE protocol-variable)

automatically generated writer method

Source

src/protocol/elements/variable.lisp (file)

Generic Function: keyword-element-class KEYWORD

Given the keyword representing the element type, returns the class object representing the concrete element type.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: keyword-element-class (KEYWORD (eql config))
Source

src/protocol/elements/config.lisp (file)

Method: keyword-element-class (KEYWORD (eql category))
Source

src/protocol/elements/category.lisp (file)

Method: keyword-element-class (KEYWORD (eql variable))
Source

src/protocol/elements/variable.lisp (file)

Method: keyword-element-class (KEYWORD (eql condition-type))
Source

src/protocol/elements/condition-type.lisp (file)

Method: keyword-element-class (KEYWORD (eql class))
Source

src/protocol/elements/class.lisp (file)

Method: keyword-element-class (KEYWORD (eql macro))
Source

src/protocol/elements/macro.lisp (file)

Method: keyword-element-class (KEYWORD (eql function))
Source

src/protocol/elements/function.lisp (file)

Generic Function: keyword-types OBJECT
Generic Function: (setf keyword-types) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: keyword-types (PROTOCOL-FUNCTION protocol-function)

automatically generated reader method

Source

src/protocol/elements/function.lisp (file)

Method: (setf keyword-types) NEW-VALUE (PROTOCOL-FUNCTION protocol-function)

automatically generated writer method

Source

src/protocol/elements/function.lisp (file)

Generic Function: lambda-list OBJECT
Package

protest/protocol

Methods
Method: lambda-list (PROTOCOL-MACRO protocol-macro)

automatically generated reader method

Source

src/protocol/elements/macro.lisp (file)

Method: lambda-list (PROTOCOL-FUNCTION protocol-function)

automatically generated reader method

Source

src/protocol/elements/function.lisp (file)

Generic Function: mandatoryp OBJECT
Generic Function: (setf mandatoryp) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: mandatoryp (PROTOCOL-CONFIG protocol-config)

automatically generated reader method

Source

src/protocol/elements/config.lisp (file)

Method: (setf mandatoryp) NEW-VALUE (PROTOCOL-CONFIG protocol-config)

automatically generated writer method

Source

src/protocol/elements/config.lisp (file)

Generic Function: name PROTOCOL-ELEMENT

Returns the name of the protocol element. The name might be a symbol or a list of symbols.

Package

protest/common

Source

src/protocol/elements.lisp (file)

Writer

(setf name) (generic function)

Methods
Method: name (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Method: name (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: name (PROTOCOL-CONFIG protocol-config)

automatically generated reader method

Source

src/protocol/elements/config.lisp (file)

Method: name (PROTOCOL-CATEGORY protocol-category)

automatically generated reader method

Source

src/protocol/elements/category.lisp (file)

Method: name (PROTOCOL-VARIABLE protocol-variable)

automatically generated reader method

Source

src/protocol/elements/variable.lisp (file)

Method: name (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated reader method

Source

src/protocol/elements/condition-type.lisp (file)

Method: name (PROTOCOL-CLASS protocol-class)

automatically generated reader method

Source

src/protocol/elements/class.lisp (file)

Method: name (PROTOCOL-MACRO protocol-macro)

automatically generated reader method

Source

src/protocol/elements/macro.lisp (file)

Method: name (PROTOCOL-FUNCTION protocol-function)

automatically generated reader method

Source

src/protocol/elements/function.lisp (file)

Generic Function: (setf name) NEW-VALUE OBJECT
Package

protest/common

Reader

name (generic function)

Methods
Method: (setf name) NEW-VALUE (PROTOCOL-CONFIG protocol-config)

automatically generated writer method

Source

src/protocol/elements/config.lisp (file)

Method: (setf name) NEW-VALUE (PROTOCOL-CATEGORY protocol-category)

automatically generated writer method

Source

src/protocol/elements/category.lisp (file)

Method: (setf name) NEW-VALUE (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated writer method

Source

src/protocol/elements/condition-type.lisp (file)

Generic Function: options OBJECT
Generic Function: (setf options) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: options (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated reader method

Source

src/protocol/elements/condition-type.lisp (file)

Method: (setf options) NEW-VALUE (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated writer method

Source

src/protocol/elements/condition-type.lisp (file)

Method: options (PROTOCOL-CLASS protocol-class)

automatically generated reader method

Source

src/protocol/elements/class.lisp (file)

Method: (setf options) NEW-VALUE (PROTOCOL-CLASS protocol-class)

automatically generated writer method

Source

src/protocol/elements/class.lisp (file)

Generic Function: package-of OBJECT
Package

protest/test-case

Methods
Method: package-of (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Generic Function: protocol-element-boundp PROTOCOL-ELEMENT

Checks if the initial value of the protocol element is bound.

If the protocol element contains an initial value and that value is bound, this function returns (VALUES T T).
If the protocol element contains an initial value and that value is unbound, this function returns (VALUES NIL T).
If the protocol element does not contain an initial value, this function returns (VALUES NIL NIL).

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: protocol-element-boundp (ELEMENT protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: protocol-element-boundp (ELEMENT protocol-variable)
Source

src/protocol/elements/variable.lisp (file)

Method: protocol-element-boundp (PROTOCOL-ELEMENT protocol-element)
Generic Function: protocol-element-makunbound PROTOCOL-ELEMENT

Attempts to unbind the initial value of the protocol element.

If the protocol element contains an initial value and that value is bound, this function unbinds that value. Otherwise, it does nothing.
In any case, the protocol element is returned.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: protocol-element-makunbound (ELEMENT protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: protocol-element-makunbound (ELEMENT protocol-variable)
Source

src/protocol/elements/variable.lisp (file)

Method: protocol-element-makunbound (PROTOCOL-ELEMENT protocol-element)
Generic Function: protocol-object-instantiation-symbol CONDITION
Package

protest/base

Methods
Method: protocol-object-instantiation-symbol (CONDITION protocol-object-instantiation)
Source

src/base/protocol-error.lisp (file)

Generic Function: protocol-object-instantiation-type CONDITION
Package

protest/base

Methods
Method: protocol-object-instantiation-type (CONDITION protocol-object-instantiation)
Source

src/base/protocol-error.lisp (file)

Generic Function: remove-protocol PROTOCOL

Removes the provided protocol and all the effects of its elements from the Lisp image.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Methods
Method: remove-protocol (PROTOCOL symbol)
Method: remove-protocol (PROTOCOL protocol)
Generic Function: remove-protocol-element PROTOCOL-ELEMENT

Removes the effects of the provided protocol element from the
Lisp image.

This function does nothing unless the protocol associated with this element has been executed.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Methods
Method: remove-protocol-element (ELEMENT protocol-macro)
Source

src/protocol/macro.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-config)
Source

src/protocol/elements/config.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-category)
Source

src/protocol/elements/category.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-variable)
Source

src/protocol/elements/variable.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-condition-type)
Source

src/protocol/elements/condition-type.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-class)
Source

src/protocol/elements/class.lisp (file)

Method: remove-protocol-element (ELEMENT protocol-function)
Source

src/protocol/elements/function.lisp (file)

Method: remove-protocol-element (PROTOCOL-ELEMENT protocol-element)
Generic Function: remove-protocol-object OBJECT

Removes the provided protocol object from the Lisp image.

Package

protest/base

Source

src/base/base.lisp (file)

Methods
Method: remove-protocol-object (CLASS symbol)
Method: remove-protocol-object (CLASS class)
Generic Function: return-type OBJECT
Generic Function: (setf return-type) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: return-type (PROTOCOL-FUNCTION protocol-function)

automatically generated reader method

Source

src/protocol/elements/function.lisp (file)

Method: (setf return-type) NEW-VALUE (PROTOCOL-FUNCTION protocol-function)

automatically generated writer method

Source

src/protocol/elements/function.lisp (file)

Generic Function: slots OBJECT
Generic Function: (setf slots) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: slots (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated reader method

Source

src/protocol/elements/condition-type.lisp (file)

Method: (setf slots) NEW-VALUE (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated writer method

Source

src/protocol/elements/condition-type.lisp (file)

Method: slots (PROTOCOL-CLASS protocol-class)

automatically generated reader method

Source

src/protocol/elements/class.lisp (file)

Method: (setf slots) NEW-VALUE (PROTOCOL-CLASS protocol-class)

automatically generated writer method

Source

src/protocol/elements/class.lisp (file)

Generic Function: steps OBJECT
Generic Function: (setf steps) NEW-VALUE OBJECT
Package

protest/test-case

Methods
Method: steps (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Method: (setf steps) NEW-VALUE (TEST-CASE test-case)

automatically generated writer method

Source

src/test-case/test-case.lisp (file)

Generic Function: steps-list TEST-CASE
Package

protest/test-case

Methods
Method: steps-list (TEST-CASE test-case)
Source

src/test-case/test-case.lisp (file)

Generic Function: superclasses OBJECT
Generic Function: (setf superclasses) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: superclasses (PROTOCOL-CLASS protocol-class)

automatically generated reader method

Source

src/protocol/elements/class.lisp (file)

Method: (setf superclasses) NEW-VALUE (PROTOCOL-CLASS protocol-class)

automatically generated writer method

Source

src/protocol/elements/class.lisp (file)

Generic Function: supertypes OBJECT
Generic Function: (setf supertypes) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: supertypes (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated reader method

Source

src/protocol/elements/condition-type.lisp (file)

Method: (setf supertypes) NEW-VALUE (PROTOCOL-CONDITION-TYPE protocol-condition-type)

automatically generated writer method

Source

src/protocol/elements/condition-type.lisp (file)

Generic Function: tags OBJECT
Generic Function: (setf tags) NEW-VALUE OBJECT
Package

protest/common

Methods
Method: tags (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Method: (setf tags) NEW-VALUE (TEST-CASE test-case)

automatically generated writer method

Source

src/test-case/test-case.lisp (file)

Method: tags (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf tags) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)

Generic Function: test-phase OBJECT
Package

protest/test-case

Methods
Method: test-phase (TEST-STEP test-step)

automatically generated reader method

Source

src/test-case/test-step.lisp (file)

Generic Function: validate-implementations PROTOCOL &key ERRORP SUCCESSP

Checks if all subclasses of protocol classes defined
in the protocol have appropriate methods defined on protocol functions defined in the protocol. Returns a list of validation errors if the check fails or if any protocol function is undefined. Each entry in the list follows the pattern: * (:missing-method FUNCTION POSITION PROTOCOL-CLASS CONCRETE-CLASS): There is no method defined on the protocol function that accepts the concrete class as its POSITIONth argument on the given position, but that class is a subtype of protocol class that is the declared protocol specializer of that argument. If ERRORP is true, a condition of type PROTOCOL-VALIDATION-ERROR is instead signaled.
* (:undefined-function FUNCTION-NAME): The protocol function with this name is undefined. The protocol might not have been executed. If ERRORP is true, a condition of type UNDEFINED-PROTOCOL-FUNCTION is instead signaled.
* (:success FUNCTION POSITION PROTOCOL-CLASS CONCRETE-CLASS SPECIALIZER): Denotes that the function has a method specialized on the specializer on POSITIONth position and that specializer is a proper subtype of the concrete class. (In other words, there is a method defined on that class.)
This entry is only collected if the SUCCESSP argument is true.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Methods
Method: validate-implementations (PROTOCOL null) &rest REST
Method: validate-implementations (PROTOCOL-NAME symbol) &rest REST
Method: validate-implementations (PROTOCOL protocol) &key ERRORP SUCCESSP
Generic Function: value-type OBJECT
Generic Function: (setf value-type) NEW-VALUE OBJECT
Package

protest/protocol

Methods
Method: value-type (PROTOCOL-CONFIG protocol-config)

automatically generated reader method

Source

src/protocol/elements/config.lisp (file)

Method: (setf value-type) NEW-VALUE (PROTOCOL-CONFIG protocol-config)

automatically generated writer method

Source

src/protocol/elements/config.lisp (file)

Method: value-type (PROTOCOL-VARIABLE protocol-variable)

automatically generated reader method

Source

src/protocol/elements/variable.lisp (file)

Method: (setf value-type) NEW-VALUE (PROTOCOL-VARIABLE protocol-variable)

automatically generated writer method

Source

src/protocol/elements/variable.lisp (file)

Generic Function: whole OBJECT
Generic Function: (setf whole) NEW-VALUE OBJECT
Package

protest/common

Methods
Method: whole (TEST-CASE test-case)

automatically generated reader method

Source

src/test-case/test-case.lisp (file)

Method: (setf whole) NEW-VALUE (TEST-CASE test-case)

automatically generated writer method

Source

src/test-case/test-case.lisp (file)

Method: whole (PROTOCOL protocol)

automatically generated reader method

Source

src/protocol/definition.lisp (file)

Method: (setf whole) NEW-VALUE (PROTOCOL protocol)

automatically generated writer method

Source

src/protocol/definition.lisp (file)


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

5.1.5 Conditions

Condition: protocol-error ()

The parent condition type for all protocol errors.

This condition type is a protocol condition type and must not be instantiated directly.

Package

protest/base

Source

src/base/protocol-error.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

initialize-instance (method)

Condition: protocol-object-instantiation ()
Package

protest/base

Source

src/base/protocol-error.lisp (file)

Direct superclasses

protocol-error (condition)

Direct methods
Direct slots
Slot: symbol
Initargs

:symbol

Readers

protocol-object-instantiation-symbol (generic function)

Slot: type
Initargs

:type

Readers

protocol-object-instantiation-type (generic function)

Condition: simple-protocol-error ()
Package

protest/base

Source

src/base/protocol-error.lisp (file)

Direct superclasses

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

5.1.6 Classes

Class: protocol ()

Describes a protocol understood as a relation between data types and operations on these types.

Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %whole
Initargs

:whole

Readers

whole (generic function)

Writers

(setf whole) (generic function)

Slot: %tags
Initargs

:tags

Initform

(quote nil)

Readers

tags (generic function)

Writers

(setf tags) (generic function)

Slot: %attachments
Initargs

:attachments

Initform

(quote nil)

Readers

attachments (generic function)

Writers

(setf attachments) (generic function)

Slot: %dependencies
Initform

(quote nil)

Readers

dependencies (generic function)

Slot: %exports
Initargs

:exports

Initform

(quote nil)

Readers

exports (generic function)

Writers

(setf exports) (generic function)

Slot: %bindings
Initargs

:bindings

Initform

(quote nil)

Readers

bindings (generic function)

Writers

(setf bindings) (generic function)

Slot: %elements
Initargs

:elements

Initform

(quote nil)

Readers

elements (generic function)

Writers

(setf elements) (generic function)

Class: protocol-category ()

Describes a protocol configuration category that is a part of a protocol.

The form for a protocol configuration category consits of the following subforms:
* NAME - mandatory, must be a list of keywords and symbols. Denotes the name of the configuration category. The canonical names (with non-keyword symbols replaced by NIL) of configuration entries and configuration categories must not collide with each other.

Package

protest/protocol

Source

src/protocol/elements/category.lisp (file)

Direct superclasses

protocol-data-type (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Writers

(setf name) (generic function)

Class: protocol-class ()

Describes a protocol class that is a part of a protocol.

The form for a protocol class consists of the following subforms:
* NAME - mandatory, must be a symbol. Denotes the name of the class.
* SUPERCLASSES - mandatory, must be a list of symbols. Denotes the superclasses of the class.
* SLOTS - mandatory, must be a list of slot definitions. Denotes the slots of the class. It is discouraged to create slots in protocol classes; client code should instead create slots in concrete classes which subclass the protocol classes.
* OPTIONS - optional, is the tail of the list. Denotes the options that will be passed to DEFCLASS.

Package

protest/protocol

Source

src/protocol/elements/class.lisp (file)

Direct superclasses

protocol-data-type (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %superclasses
Initargs

:superclasses

Initform

(quote nil)

Readers

superclasses (generic function)

Writers

(setf superclasses) (generic function)

Slot: %slots
Initargs

:slots

Initform

(quote nil)

Readers

slots (generic function)

Writers

(setf slots) (generic function)

Slot: %options
Initargs

:options

Initform

(quote nil)

Readers

options (generic function)

Writers

(setf options) (generic function)

Class: protocol-condition-type ()

Describes a protocol condition type that is a part of a protocol.

The form for a protocol condition type consists of the following subforms: * NAME - mandatory, must be a symbol. Denotes the name of the condition type. * SUPERTYPES - mandatory, must be a list of symbols. Denotes the supertypes of the condition type.
* SLOTS - mandatory, must be a list of slot definitions. Denotes the slots of the condition type. It is discouraged to create slots in protocol condition types; client code should instead create slots in concrete types which subtype the protocol condition types.
* OPTIONS - optional, is the tail of the list. Denotes the options that will be passed to DEFINE-CONDITION.

Package

protest/protocol

Source

src/protocol/elements/condition-type.lisp (file)

Direct superclasses

protocol-data-type (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: %supertypes
Initargs

:supertypes

Initform

(quote nil)

Readers

supertypes (generic function)

Writers

(setf supertypes) (generic function)

Slot: %slots
Initargs

:slots

Initform

(quote nil)

Readers

slots (generic function)

Writers

(setf slots) (generic function)

Slot: %options
Initargs

:options

Initform

(quote nil)

Readers

options (generic function)

Writers

(setf options) (generic function)

Class: protocol-config ()

Describes a protocol configuration entry that is a part of a protocol.

The form for a protocol configuration entry consists of the following subforms: * NAME - mandatory, must be a list of keywords and symbols. Denotes the name of the configuration entry. The canonical names (with non-keyword symbols replaced by NIL) of configuration entries and configuration categories must not collide with each other.
* VALUE-TYPE - optional, must be a valid type specifier. Denotes the type of the value bound to the configuration entry. If not specified, the configuration type will default to T.
* MANDATORYP - optional, must be of type (MEMBER :MANDATORY :OPTIONAL). States if the configuration entry must have a value set in the configuration before any client code may be executed. If not provided, defaults to :OPTIONAL.
* INITIAL-VALUE - optional. Denotes the default value that the configuration entry will be bound to at the moment of executing the protocol. If not passed, the value will not be bound.

Package

protest/protocol

Source

src/protocol/elements/config.lisp (file)

Direct superclasses

protocol-data-type (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: %value-type
Initargs

:type

Initform

t

Readers

value-type (generic function)

Writers

(setf value-type) (generic function)

Slot: %mandatoryp
Initargs

:mandatoryp

Readers

mandatoryp (generic function)

Writers

(setf mandatoryp) (generic function)

Slot: %initial-value
Initargs

:initial-value

Readers

initial-value (generic function)

Writers

(setf initial-value) (generic function)

Class: protocol-data-type ()

An data type belgonging to a protocol.

This class is a protocol class and must not be instantiated directly.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Direct superclasses

protocol-element (class)

Direct subclasses
Direct methods

initialize-instance (method)

Class: protocol-element ()

An element of a protocol.

This class is a protocol class and must not be instantiated directly.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: %docstring
Initargs

:docstring

Readers

docstring (generic function)

Writers

(setf docstring) (generic function)

Class: protocol-function ()

Describes a generic function that is a part of a protocol.

The form for a protocol function consists of the following subforms:
* NAME - mandatory, must be a symbol or a (SETF symbol) form. Denotes the name of the function.
* LAMBDA-LIST - mandatory, must be a valid lambda list.
* RETURN-TYPE - optional, must be a valid return type for a function. If not specified, defaults to the symbol CL:*.
* KEYWORD-TYPES - optional, must be a valid plist containing some or all of the &KEY arguments used in LAMBDA-LIST along with their respective types.

Package

protest/protocol

Source

src/protocol/elements/function.lisp (file)

Direct superclasses

protocol-operation (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %lambda-list
Initargs

:lambda-list

Initform

(error "must provide lambda-list.")

Readers

lambda-list (generic function)

Slot: %return-type
Initargs

:return-type

Initform

(quote *)

Readers

return-type (generic function)

Writers

(setf return-type) (generic function)

Slot: %keyword-types
Initargs

:keyword-types

Initform

(quote nil)

Readers

keyword-types (generic function)

Writers

(setf keyword-types) (generic function)

Slot: %declaim-type-p
Initform

t

Readers

declaim-type-p (generic function)

Writers

(setf declaim-type-p) (generic function)

Class: protocol-macro ()

Describes a protocol macro that is a part of a protocol.

The form of a protocol macro consists of the following subforms: * NAME - mandatory, must be a symbol. Denotes the name of the macro. * LAMBDA-LIST - mandatory, must be a valid macro lambda list.

Package

protest/protocol

Source

src/protocol/elements/macro.lisp (file)

Direct superclasses

protocol-operation (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %lambda-list
Initargs

:lambda-list

Initform

(error "must provide lambda-list.")

Readers

lambda-list (generic function)

Class: protocol-operation ()

An operation belgonging to a protocol.

This class is a protocol class and must not be instantiated directly.

Package

protest/protocol

Source

src/protocol/elements.lisp (file)

Direct superclasses

protocol-element (class)

Direct subclasses
Direct methods

initialize-instance (method)

Class: protocol-variable ()

Describes a protocol variable that is a part of a protocol.

The form for a protocol variable consists of the following subforms:
* NAME - mandatory, must be a symbol. Denotes the name of the variable.
* VALUE-TYPE - optional, must be a valid type specifier. Denotes the type of the value bound to the variable. If not passed, the variable type will not be declaimed.
* INITIAL-VALUE - optional. Denotes the default value that the variable will be bound to at the moment of executing the protocol. If not passed, the variable will be unbound.

Package

protest/protocol

Source

src/protocol/elements/variable.lisp (file)

Direct superclasses

protocol-data-type (class)

Direct methods
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %value-type
Initargs

:value-type

Initform

t

Readers

value-type (generic function)

Writers

(setf value-type) (generic function)

Slot: %initial-value
Initargs

:initial-value

Readers

initial-value (generic function)

Writers

(setf initial-value) (generic function)

Slot: %declaim-type-p
Initform

t

Readers

declaim-type-p (generic function)

Writers

(setf declaim-type-p) (generic function)

Class: test-case ()

Describes a test case understood as a series of test phases and test steps describing each part of the test.

Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • documentation (method)
  • documentation (method)
  • initialize-instance (method)
  • make-load-form (method)
  • print-object (method)
  • steps-list (method)
  • steps (method)
  • steps (method)
  • attachments (method)
  • attachments (method)
  • tags (method)
  • tags (method)
  • whole (method)
  • whole (method)
  • package-of (method)
  • name (method)
Direct slots
Slot: %name
Initargs

:name

Initform

(error "must provide name.")

Readers

name (generic function)

Slot: %package
Initargs

:package

Initform

*package*

Readers

package-of (generic function)

Slot: %whole
Initargs

:whole

Readers

whole (generic function)

Writers

(setf whole) (generic function)

Slot: %tags
Initargs

:tags

Initform

(quote nil)

Readers

tags (generic function)

Writers

(setf tags) (generic function)

Slot: %attachments
Initargs

:attachments

Initform

(quote nil)

Readers

attachments (generic function)

Writers

(setf attachments) (generic function)

Slot: %steps
Initargs

:steps

Initform

(make-hash-table)

Readers

steps (generic function)

Writers

(setf steps) (generic function)

Class: test-step ()
Package

protest/test-case

Source

src/test-case/test-step.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • initialize-instance (method)
  • make-load-form (method)
  • print-object (method)
  • test-phase (method)
  • description (method)
  • id (method)
Direct slots
Slot: %id
Initargs

:id

Initform

0

Readers

id (generic function)

Slot: %description
Initargs

:description

Readers

description (generic function)

Slot: %test-phase
Initargs

:test-phase

Readers

test-phase (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *category-documentation-store*
Package

protest/protocol

Source

src/protocol/elements/category.lisp (file)

Special Variable: *config-documentation-store*
Package

protest/protocol

Source

src/protocol/elements/config.lisp (file)

Special Variable: *protocol-documentation-store*
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Special Variable: *protocol-objects*
Package

protest/base

Source

src/base/base.lisp (file)

Special Variable: *protocol-validation-error-report*
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Special Variable: *test-case-documentation-store*
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Special Variable: *test-cases*

A mapping from test case names to test cases.

Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Special Variable: *undefined-protocol-function-report*
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Special Variable: *warn-on-test-case-redefinition-p*

If true, then test case redefinitions will signal warnings.

Package

protest/test-case

Source

src/test-case/test-case.lisp (file)


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

5.2.2 Macros

Macro: defgeneric? NAME LAMBDA-LIST &body OPTIONS
Package

protest/protocol

Source

src/protocol/elements/function.lisp (file)

Macro: define-protocol-object SYMBOL STRING NAME SUPERS SLOTS OPTIONS
Package

protest/base

Source

src/base/base.lisp (file)


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

5.2.3 Functions

Function: canonicalize-name NAME
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-dependencies-not-circular PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-dependencies-valid PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-duplicate-effective-elements PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-duplicate-element-forms PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-duplicate-ids TEST-CASE
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Function: check-duplicate-test-phases TEST-CASE
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Function: check-exports PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: check-id-order TEST-CASE
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Function: compute-exports PROTOCOL
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: concrete-subclasses CLASS
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: ensure-protocol NAME OPTIONS WHOLE
Package

protest/protocol

Source

src/protocol/macro.lisp (file)

Function: ensure-test-case NAME OPTIONS WHOLE &optional PACKAGE
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Function: find-valid-method FUNCTION SPECIALIZERS
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: generate-elements ELEMENTS DECLAIM-TYPES-P
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: generate-steps FORMS
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)

Function: lambda-list-argument-types LAMBDA-LIST KEYWORD-TYPES
Package

protest/ftype

Source

src/ftype/ftype.lisp (file)

Function: protocol-effective-dependencies PROTOCOL
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: protocol-function-specializers PROTOCOL-FUNCTION
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: protocol-superclasses CLASS
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: protocol-validation-error-report CONDITION STREAM
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: replace-one ELEMENT POSITION SEQUENCE
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: retain-duplicates LIST
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: undefined-protocol-function-report CONDITION STREAM
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: validate-all-protocols ()
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: validate-function PROTOCOL-FUNCTION &optional ERRORP SUCCESSP
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Function: validate-protocol PROTOCOL
Package

protest/protocol

Source

src/protocol/validation.lisp (file)

Function: validate-test-case TEST-CASE
Package

protest/test-case

Source

src/test-case/test-case.lisp (file)


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

5.2.4 Generic functions

Generic Function: embed-documentation ELEMENT STRING
Package

protest/protocol

Methods
Method: embed-documentation (ELEMENT protocol-variable) (STRING string)
Source

src/protocol/elements/variable.lisp (file)

Method: embed-documentation (ELEMENT protocol-macro) (STRING string)
Source

src/protocol/elements/macro.lisp (file)

Generic Function: protocol-validation-error-class CONDITION
Package

protest/protocol

Methods
Method: protocol-validation-error-class (CONDITION protocol-validation-error)
Source

src/protocol/definition.lisp (file)

Generic Function: protocol-validation-error-function CONDITION
Package

protest/protocol

Methods
Method: protocol-validation-error-function (CONDITION protocol-validation-error)
Source

src/protocol/definition.lisp (file)

Generic Function: protocol-validation-error-position CONDITION
Package

protest/protocol

Methods
Method: protocol-validation-error-position (CONDITION protocol-validation-error)
Source

src/protocol/definition.lisp (file)

Generic Function: protocol-validation-error-subclass CONDITION
Package

protest/protocol

Methods
Method: protocol-validation-error-subclass (CONDITION protocol-validation-error)
Source

src/protocol/definition.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: protocol-validation-error ()
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Direct superclasses

protocol-error (condition)

Direct methods
Direct slots
Slot: function
Initargs

:function

Initform

(quote (alexandria.0.dev:required-argument :function))

Readers

protocol-validation-error-function (generic function)

Slot: subclass
Initargs

:subclass

Initform

(quote (alexandria.0.dev:required-argument :subclass))

Readers

protocol-validation-error-subclass (generic function)

Slot: class
Initargs

:class

Initform

(quote (alexandria.0.dev:required-argument :class))

Readers

protocol-validation-error-class (generic function)

Slot: position
Initargs

:position

Initform

(quote (alexandria.0.dev:required-argument :position))

Readers

protocol-validation-error-position (generic function)

Condition: undefined-protocol-function ()
Package

protest/protocol

Source

src/protocol/definition.lisp (file)

Direct superclasses

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, protest.asd: The protest<dot>asd file
File, Lisp, protest/base/src/base/base.lisp: The protest/base/src/base/base<dot>lisp file
File, Lisp, protest/base/src/base/package.lisp: The protest/base/src/base/package<dot>lisp file
File, Lisp, protest/base/src/base/protocol-error.lisp: The protest/base/src/base/protocol-error<dot>lisp file
File, Lisp, protest/ftype/src/ftype/ftype.lisp: The protest/ftype/src/ftype/ftype<dot>lisp file
File, Lisp, protest/ftype/src/ftype/package.lisp: The protest/ftype/src/ftype/package<dot>lisp file
File, Lisp, protest/protocol/src/protocol/definition.lisp: The protest/protocol/src/protocol/definition<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements.lisp: The protest/protocol/src/protocol/elements<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/category.lisp: The protest/protocol/src/protocol/elements/category<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/class.lisp: The protest/protocol/src/protocol/elements/class<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/condition-type.lisp: The protest/protocol/src/protocol/elements/condition-type<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/config.lisp: The protest/protocol/src/protocol/elements/config<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/function.lisp: The protest/protocol/src/protocol/elements/function<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/macro.lisp: The protest/protocol/src/protocol/elements/macro<dot>lisp file
File, Lisp, protest/protocol/src/protocol/elements/variable.lisp: The protest/protocol/src/protocol/elements/variable<dot>lisp file
File, Lisp, protest/protocol/src/protocol/macro.lisp: The protest/protocol/src/protocol/macro<dot>lisp file
File, Lisp, protest/protocol/src/protocol/package.lisp: The protest/protocol/src/protocol/package<dot>lisp file
File, Lisp, protest/protocol/src/protocol/validation.lisp: The protest/protocol/src/protocol/validation<dot>lisp file
File, Lisp, protest/src/package.lisp: The protest/src/package<dot>lisp file
File, Lisp, protest/test-case/src/test-case/package.lisp: The protest/test-case/src/test-case/package<dot>lisp file
File, Lisp, protest/test-case/src/test-case/test-case.lisp: The protest/test-case/src/test-case/test-case<dot>lisp file
File, Lisp, protest/test-case/src/test-case/test-step.lisp: The protest/test-case/src/test-case/test-step<dot>lisp file

L
Lisp File, protest.asd: The protest<dot>asd file
Lisp File, protest/base/src/base/base.lisp: The protest/base/src/base/base<dot>lisp file
Lisp File, protest/base/src/base/package.lisp: The protest/base/src/base/package<dot>lisp file
Lisp File, protest/base/src/base/protocol-error.lisp: The protest/base/src/base/protocol-error<dot>lisp file
Lisp File, protest/ftype/src/ftype/ftype.lisp: The protest/ftype/src/ftype/ftype<dot>lisp file
Lisp File, protest/ftype/src/ftype/package.lisp: The protest/ftype/src/ftype/package<dot>lisp file
Lisp File, protest/protocol/src/protocol/definition.lisp: The protest/protocol/src/protocol/definition<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements.lisp: The protest/protocol/src/protocol/elements<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/category.lisp: The protest/protocol/src/protocol/elements/category<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/class.lisp: The protest/protocol/src/protocol/elements/class<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/condition-type.lisp: The protest/protocol/src/protocol/elements/condition-type<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/config.lisp: The protest/protocol/src/protocol/elements/config<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/function.lisp: The protest/protocol/src/protocol/elements/function<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/macro.lisp: The protest/protocol/src/protocol/elements/macro<dot>lisp file
Lisp File, protest/protocol/src/protocol/elements/variable.lisp: The protest/protocol/src/protocol/elements/variable<dot>lisp file
Lisp File, protest/protocol/src/protocol/macro.lisp: The protest/protocol/src/protocol/macro<dot>lisp file
Lisp File, protest/protocol/src/protocol/package.lisp: The protest/protocol/src/protocol/package<dot>lisp file
Lisp File, protest/protocol/src/protocol/validation.lisp: The protest/protocol/src/protocol/validation<dot>lisp file
Lisp File, protest/src/package.lisp: The protest/src/package<dot>lisp file
Lisp File, protest/test-case/src/test-case/package.lisp: The protest/test-case/src/test-case/package<dot>lisp file
Lisp File, protest/test-case/src/test-case/test-case.lisp: The protest/test-case/src/test-case/test-case<dot>lisp file
Lisp File, protest/test-case/src/test-case/test-step.lisp: The protest/test-case/src/test-case/test-step<dot>lisp file

P
protest.asd: The protest<dot>asd file
protest/base/src/base/base.lisp: The protest/base/src/base/base<dot>lisp file
protest/base/src/base/package.lisp: The protest/base/src/base/package<dot>lisp file
protest/base/src/base/protocol-error.lisp: The protest/base/src/base/protocol-error<dot>lisp file
protest/ftype/src/ftype/ftype.lisp: The protest/ftype/src/ftype/ftype<dot>lisp file
protest/ftype/src/ftype/package.lisp: The protest/ftype/src/ftype/package<dot>lisp file
protest/protocol/src/protocol/definition.lisp: The protest/protocol/src/protocol/definition<dot>lisp file
protest/protocol/src/protocol/elements.lisp: The protest/protocol/src/protocol/elements<dot>lisp file
protest/protocol/src/protocol/elements/category.lisp: The protest/protocol/src/protocol/elements/category<dot>lisp file
protest/protocol/src/protocol/elements/class.lisp: The protest/protocol/src/protocol/elements/class<dot>lisp file
protest/protocol/src/protocol/elements/condition-type.lisp: The protest/protocol/src/protocol/elements/condition-type<dot>lisp file
protest/protocol/src/protocol/elements/config.lisp: The protest/protocol/src/protocol/elements/config<dot>lisp file
protest/protocol/src/protocol/elements/function.lisp: The protest/protocol/src/protocol/elements/function<dot>lisp file
protest/protocol/src/protocol/elements/macro.lisp: The protest/protocol/src/protocol/elements/macro<dot>lisp file
protest/protocol/src/protocol/elements/variable.lisp: The protest/protocol/src/protocol/elements/variable<dot>lisp file
protest/protocol/src/protocol/macro.lisp: The protest/protocol/src/protocol/macro<dot>lisp file
protest/protocol/src/protocol/package.lisp: The protest/protocol/src/protocol/package<dot>lisp file
protest/protocol/src/protocol/validation.lisp: The protest/protocol/src/protocol/validation<dot>lisp file
protest/src/package.lisp: The protest/src/package<dot>lisp file
protest/test-case/src/test-case/package.lisp: The protest/test-case/src/test-case/package<dot>lisp file
protest/test-case/src/test-case/test-case.lisp: The protest/test-case/src/test-case/test-case<dot>lisp file
protest/test-case/src/test-case/test-step.lisp: The protest/test-case/src/test-case/test-step<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   K   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf attachments): Exported generic functions
(setf attachments): Exported generic functions
(setf attachments): Exported generic functions
(setf bindings): Exported generic functions
(setf bindings): Exported generic functions
(setf declaim-type-p): Exported generic functions
(setf declaim-type-p): Exported generic functions
(setf declaim-type-p): Exported generic functions
(setf docstring): Exported generic functions
(setf docstring): Exported generic functions
(setf elements): Exported generic functions
(setf elements): Exported generic functions
(setf exports): Exported generic functions
(setf exports): Exported generic functions
(setf find-protocol): Exported functions
(setf find-test-case): Exported functions
(setf initial-value): Exported generic functions
(setf initial-value): Exported generic functions
(setf initial-value): Exported generic functions
(setf keyword-types): Exported generic functions
(setf keyword-types): Exported generic functions
(setf mandatoryp): Exported generic functions
(setf mandatoryp): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf name): Exported generic functions
(setf options): Exported generic functions
(setf options): Exported generic functions
(setf options): Exported generic functions
(setf return-type): Exported generic functions
(setf return-type): Exported generic functions
(setf slots): Exported generic functions
(setf slots): Exported generic functions
(setf slots): Exported generic functions
(setf steps): Exported generic functions
(setf steps): Exported generic functions
(setf superclasses): Exported generic functions
(setf superclasses): Exported generic functions
(setf supertypes): Exported generic functions
(setf supertypes): Exported generic functions
(setf tags): Exported generic functions
(setf tags): Exported generic functions
(setf tags): Exported generic functions
(setf value-type): Exported generic functions
(setf value-type): Exported generic functions
(setf value-type): Exported generic functions
(setf whole): Exported generic functions
(setf whole): Exported generic functions
(setf whole): Exported generic functions

A
attachments: Exported generic functions
attachments: Exported generic functions
attachments: Exported generic functions

B
bindings: Exported generic functions
bindings: Exported generic functions

C
canonical-name: Exported generic functions
canonical-name: Exported generic functions
canonical-name: Exported generic functions
canonical-name: Exported generic functions
canonicalize-name: Internal functions
check-dependencies-not-circular: Internal functions
check-dependencies-valid: Internal functions
check-duplicate-effective-elements: Internal functions
check-duplicate-element-forms: Internal functions
check-duplicate-ids: Internal functions
check-duplicate-test-phases: Internal functions
check-exports: Internal functions
check-id-order: Internal functions
compute-effective-protocol-elements: Exported functions
compute-exports: Internal functions
concrete-subclasses: Internal functions

D
declaim-type-p: Exported generic functions
declaim-type-p: Exported generic functions
declaim-type-p: Exported generic functions
defgeneric?: Internal macros
define-protocol: Exported macros
define-protocol-class: Exported macros
define-protocol-condition-type: Exported macros
define-protocol-object: Internal macros
define-test-case: Exported macros
dependencies: Exported generic functions
dependencies: Exported generic functions
description: Exported generic functions
description: Exported generic functions
docstring: Exported generic functions
docstring: Exported generic functions

E
elements: Exported generic functions
elements: Exported generic functions
embed-documentation: Internal generic functions
embed-documentation: Internal generic functions
embed-documentation: Internal generic functions
ensure-protocol: Internal functions
ensure-test-case: Internal functions
execute-protocol: Exported macros
exports: Exported generic functions
exports: Exported generic functions

F
find-protocol: Exported functions
find-test-case: Exported functions
find-valid-method: Internal functions
Function, (setf find-protocol): Exported functions
Function, (setf find-test-case): Exported functions
Function, canonicalize-name: Internal functions
Function, check-dependencies-not-circular: Internal functions
Function, check-dependencies-valid: Internal functions
Function, check-duplicate-effective-elements: Internal functions
Function, check-duplicate-element-forms: Internal functions
Function, check-duplicate-ids: Internal functions
Function, check-duplicate-test-phases: Internal functions
Function, check-exports: Internal functions
Function, check-id-order: Internal functions
Function, compute-effective-protocol-elements: Exported functions
Function, compute-exports: Internal functions
Function, concrete-subclasses: Internal functions
Function, ensure-protocol: Internal functions
Function, ensure-test-case: Internal functions
Function, find-protocol: Exported functions
Function, find-test-case: Exported functions
Function, find-valid-method: Internal functions
Function, function-ftype-declaration-form: Exported functions
Function, generate-element: Exported functions
Function, generate-elements: Internal functions
Function, generate-steps: Internal functions
Function, lambda-list-argument-types: Internal functions
Function, protocol-effective-dependencies: Internal functions
Function, protocol-error: Exported functions
Function, protocol-function-specializers: Internal functions
Function, protocol-object-p: Exported functions
Function, protocol-superclasses: Internal functions
Function, protocol-validation-error-report: Internal functions
Function, replace-one: Internal functions
Function, retain-duplicates: Internal functions
Function, undefined-protocol-function-report: Internal functions
Function, validate-all-protocols: Internal functions
Function, validate-function: Internal functions
Function, validate-protocol: Internal functions
Function, validate-test-case: Internal functions
function-ftype-declaration-form: Exported functions

G
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-code: Exported generic functions
generate-element: Exported functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-element-using-class: Exported generic functions
generate-elements: Internal functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-forms: Exported generic functions
generate-steps: Internal functions
Generic Function, (setf attachments): Exported generic functions
Generic Function, (setf bindings): Exported generic functions
Generic Function, (setf declaim-type-p): Exported generic functions
Generic Function, (setf docstring): Exported generic functions
Generic Function, (setf elements): Exported generic functions
Generic Function, (setf exports): Exported generic functions
Generic Function, (setf initial-value): Exported generic functions
Generic Function, (setf keyword-types): Exported generic functions
Generic Function, (setf mandatoryp): Exported generic functions
Generic Function, (setf name): Exported generic functions
Generic Function, (setf options): Exported generic functions
Generic Function, (setf return-type): Exported generic functions
Generic Function, (setf slots): Exported generic functions
Generic Function, (setf steps): Exported generic functions
Generic Function, (setf superclasses): Exported generic functions
Generic Function, (setf supertypes): Exported generic functions
Generic Function, (setf tags): Exported generic functions
Generic Function, (setf value-type): Exported generic functions
Generic Function, (setf whole): Exported generic functions
Generic Function, attachments: Exported generic functions
Generic Function, bindings: Exported generic functions
Generic Function, canonical-name: Exported generic functions
Generic Function, declaim-type-p: Exported generic functions
Generic Function, dependencies: Exported generic functions
Generic Function, description: Exported generic functions
Generic Function, docstring: Exported generic functions
Generic Function, elements: Exported generic functions
Generic Function, embed-documentation: Internal generic functions
Generic Function, exports: Exported generic functions
Generic Function, generate-code: Exported generic functions
Generic Function, generate-element-using-class: Exported generic functions
Generic Function, generate-forms: Exported generic functions
Generic Function, id: Exported generic functions
Generic Function, initial-value: Exported generic functions
Generic Function, keyword-element-class: Exported generic functions
Generic Function, keyword-types: Exported generic functions
Generic Function, lambda-list: Exported generic functions
Generic Function, mandatoryp: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, options: Exported generic functions
Generic Function, package-of: Exported generic functions
Generic Function, protocol-element-boundp: Exported generic functions
Generic Function, protocol-element-makunbound: Exported generic functions
Generic Function, protocol-object-instantiation-symbol: Exported generic functions
Generic Function, protocol-object-instantiation-type: Exported generic functions
Generic Function, protocol-validation-error-class: Internal generic functions
Generic Function, protocol-validation-error-function: Internal generic functions
Generic Function, protocol-validation-error-position: Internal generic functions
Generic Function, protocol-validation-error-subclass: Internal generic functions
Generic Function, remove-protocol: Exported generic functions
Generic Function, remove-protocol-element: Exported generic functions
Generic Function, remove-protocol-object: Exported generic functions
Generic Function, return-type: Exported generic functions
Generic Function, slots: Exported generic functions
Generic Function, steps: Exported generic functions
Generic Function, steps-list: Exported generic functions
Generic Function, superclasses: Exported generic functions
Generic Function, supertypes: Exported generic functions
Generic Function, tags: Exported generic functions
Generic Function, test-phase: Exported generic functions
Generic Function, validate-implementations: Exported generic functions
Generic Function, value-type: Exported generic functions
Generic Function, whole: Exported generic functions

I
id: Exported generic functions
id: Exported generic functions
initial-value: Exported generic functions
initial-value: Exported generic functions
initial-value: Exported generic functions

K
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-element-class: Exported generic functions
keyword-types: Exported generic functions
keyword-types: Exported generic functions

L
lambda-list: Exported generic functions
lambda-list: Exported generic functions
lambda-list: Exported generic functions
lambda-list-argument-types: Internal functions

M
Macro, defgeneric?: Internal macros
Macro, define-protocol: Exported macros
Macro, define-protocol-class: Exported macros
Macro, define-protocol-condition-type: Exported macros
Macro, define-protocol-object: Internal macros
Macro, define-test-case: Exported macros
Macro, execute-protocol: Exported macros
mandatoryp: Exported generic functions
mandatoryp: Exported generic functions
Method, (setf attachments): Exported generic functions
Method, (setf attachments): Exported generic functions
Method, (setf bindings): Exported generic functions
Method, (setf declaim-type-p): Exported generic functions
Method, (setf declaim-type-p): Exported generic functions
Method, (setf docstring): Exported generic functions
Method, (setf elements): Exported generic functions
Method, (setf exports): Exported generic functions
Method, (setf initial-value): Exported generic functions
Method, (setf initial-value): Exported generic functions
Method, (setf keyword-types): Exported generic functions
Method, (setf mandatoryp): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf name): Exported generic functions
Method, (setf options): Exported generic functions
Method, (setf options): Exported generic functions
Method, (setf return-type): Exported generic functions
Method, (setf slots): Exported generic functions
Method, (setf slots): Exported generic functions
Method, (setf steps): Exported generic functions
Method, (setf superclasses): Exported generic functions
Method, (setf supertypes): Exported generic functions
Method, (setf tags): Exported generic functions
Method, (setf tags): Exported generic functions
Method, (setf value-type): Exported generic functions
Method, (setf value-type): Exported generic functions
Method, (setf whole): Exported generic functions
Method, (setf whole): Exported generic functions
Method, attachments: Exported generic functions
Method, attachments: Exported generic functions
Method, bindings: Exported generic functions
Method, canonical-name: Exported generic functions
Method, canonical-name: Exported generic functions
Method, canonical-name: Exported generic functions
Method, declaim-type-p: Exported generic functions
Method, declaim-type-p: Exported generic functions
Method, dependencies: Exported generic functions
Method, description: Exported generic functions
Method, docstring: Exported generic functions
Method, elements: Exported generic functions
Method, embed-documentation: Internal generic functions
Method, embed-documentation: Internal generic functions
Method, exports: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-code: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-element-using-class: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, generate-forms: Exported generic functions
Method, id: Exported generic functions
Method, initial-value: Exported generic functions
Method, initial-value: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-element-class: Exported generic functions
Method, keyword-types: Exported generic functions
Method, lambda-list: Exported generic functions
Method, lambda-list: Exported generic functions
Method, mandatoryp: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, options: Exported generic functions
Method, options: Exported generic functions
Method, package-of: Exported generic functions
Method, protocol-element-boundp: Exported generic functions
Method, protocol-element-boundp: Exported generic functions
Method, protocol-element-boundp: Exported generic functions
Method, protocol-element-makunbound: Exported generic functions
Method, protocol-element-makunbound: Exported generic functions
Method, protocol-element-makunbound: Exported generic functions
Method, protocol-object-instantiation-symbol: Exported generic functions
Method, protocol-object-instantiation-type: Exported generic functions
Method, protocol-validation-error-class: Internal generic functions
Method, protocol-validation-error-function: Internal generic functions
Method, protocol-validation-error-position: Internal generic functions
Method, protocol-validation-error-subclass: Internal generic functions
Method, remove-protocol: Exported generic functions
Method, remove-protocol: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-element: Exported generic functions
Method, remove-protocol-object: Exported generic functions
Method, remove-protocol-object: Exported generic functions
Method, return-type: Exported generic functions
Method, slots: Exported generic functions
Method, slots: Exported generic functions
Method, steps: Exported generic functions
Method, steps-list: Exported generic functions
Method, superclasses: Exported generic functions
Method, supertypes: Exported generic functions
Method, tags: Exported generic functions
Method, tags: Exported generic functions
Method, test-phase: Exported generic functions
Method, validate-implementations: Exported generic functions
Method, validate-implementations: Exported generic functions
Method, validate-implementations: Exported generic functions
Method, value-type: Exported generic functions
Method, value-type: Exported generic functions
Method, whole: Exported generic functions
Method, whole: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions

O
options: Exported generic functions
options: Exported generic functions
options: Exported generic functions

P
package-of: Exported generic functions
package-of: Exported generic functions
protocol-effective-dependencies: Internal functions
protocol-element-boundp: Exported generic functions
protocol-element-boundp: Exported generic functions
protocol-element-boundp: Exported generic functions
protocol-element-boundp: Exported generic functions
protocol-element-makunbound: Exported generic functions
protocol-element-makunbound: Exported generic functions
protocol-element-makunbound: Exported generic functions
protocol-element-makunbound: Exported generic functions
protocol-error: Exported functions
protocol-function-specializers: Internal functions
protocol-object-instantiation-symbol: Exported generic functions
protocol-object-instantiation-symbol: Exported generic functions
protocol-object-instantiation-type: Exported generic functions
protocol-object-instantiation-type: Exported generic functions
protocol-object-p: Exported functions
protocol-superclasses: Internal functions
protocol-validation-error-class: Internal generic functions
protocol-validation-error-class: Internal generic functions
protocol-validation-error-function: Internal generic functions
protocol-validation-error-function: Internal generic functions
protocol-validation-error-position: Internal generic functions
protocol-validation-error-position: Internal generic functions
protocol-validation-error-report: Internal functions
protocol-validation-error-subclass: Internal generic functions
protocol-validation-error-subclass: Internal generic functions

R
remove-protocol: Exported generic functions
remove-protocol: Exported generic functions
remove-protocol: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-element: Exported generic functions
remove-protocol-object: Exported generic functions
remove-protocol-object: Exported generic functions
remove-protocol-object: Exported generic functions
replace-one: Internal functions
retain-duplicates: Internal functions
return-type: Exported generic functions
return-type: Exported generic functions

S
slots: Exported generic functions
slots: Exported generic functions
slots: Exported generic functions
steps: Exported generic functions
steps: Exported generic functions
steps-list: Exported generic functions
steps-list: Exported generic functions
superclasses: Exported generic functions
superclasses: Exported generic functions
supertypes: Exported generic functions
supertypes: Exported generic functions

T
tags: Exported generic functions
tags: Exported generic functions
tags: Exported generic functions
test-phase: Exported generic functions
test-phase: Exported generic functions

U
undefined-protocol-function-report: Internal functions

V
validate-all-protocols: Internal functions
validate-function: Internal functions
validate-implementations: Exported generic functions
validate-implementations: Exported generic functions
validate-implementations: Exported generic functions
validate-implementations: Exported generic functions
validate-protocol: Internal functions
validate-test-case: Internal functions
value-type: Exported generic functions
value-type: Exported generic functions
value-type: Exported generic functions

W
whole: Exported generic functions
whole: Exported generic functions
whole: Exported generic functions

Jump to:   (  
A   B   C   D   E   F   G   I   K   L   M   N   O   P   R   S   T   U   V   W  

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

A.3 Variables

Jump to:   %   *  
C   F   P   S   T  
Index Entry  Section

%
%attachments: Exported classes
%attachments: Exported classes
%bindings: Exported classes
%declaim-type-p: Exported classes
%declaim-type-p: Exported classes
%dependencies: Exported classes
%description: Exported classes
%docstring: Exported classes
%elements: Exported classes
%exports: Exported classes
%id: Exported classes
%initial-value: Exported classes
%initial-value: Exported classes
%keyword-types: Exported classes
%lambda-list: Exported classes
%lambda-list: Exported classes
%mandatoryp: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%name: Exported classes
%options: Exported classes
%options: Exported classes
%package: Exported classes
%return-type: Exported classes
%slots: Exported classes
%slots: Exported classes
%steps: Exported classes
%superclasses: Exported classes
%supertypes: Exported classes
%tags: Exported classes
%tags: Exported classes
%test-phase: Exported classes
%value-type: Exported classes
%value-type: Exported classes
%whole: Exported classes
%whole: Exported classes

*
*category-callback*: Exported special variables
*category-documentation-store*: Internal special variables
*config-callback*: Exported special variables
*config-documentation-store*: Internal special variables
*protocol-documentation-store*: Internal special variables
*protocol-objects*: Internal special variables
*protocol-validation-error-report*: Internal special variables
*protocols*: Exported special variables
*test-case-documentation-store*: Internal special variables
*test-cases*: Internal special variables
*undefined-protocol-function-report*: Internal special variables
*warn-on-test-case-redefinition-p*: Internal special variables

C
class: Internal conditions

F
function: Internal conditions

P
position: Internal conditions

S
Slot, %attachments: Exported classes
Slot, %attachments: Exported classes
Slot, %bindings: Exported classes
Slot, %declaim-type-p: Exported classes
Slot, %declaim-type-p: Exported classes
Slot, %dependencies: Exported classes
Slot, %description: Exported classes
Slot, %docstring: Exported classes
Slot, %elements: Exported classes
Slot, %exports: Exported classes
Slot, %id: Exported classes
Slot, %initial-value: Exported classes
Slot, %initial-value: Exported classes
Slot, %keyword-types: Exported classes
Slot, %lambda-list: Exported classes
Slot, %lambda-list: Exported classes
Slot, %mandatoryp: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %name: Exported classes
Slot, %options: Exported classes
Slot, %options: Exported classes
Slot, %package: Exported classes
Slot, %return-type: Exported classes
Slot, %slots: Exported classes
Slot, %slots: Exported classes
Slot, %steps: Exported classes
Slot, %superclasses: Exported classes
Slot, %supertypes: Exported classes
Slot, %tags: Exported classes
Slot, %tags: Exported classes
Slot, %test-phase: Exported classes
Slot, %value-type: Exported classes
Slot, %value-type: Exported classes
Slot, %whole: Exported classes
Slot, %whole: Exported classes
Slot, class: Internal conditions
Slot, function: Internal conditions
Slot, position: Internal conditions
Slot, subclass: Internal conditions
Slot, symbol: Exported conditions
Slot, type: Exported conditions
Special Variable, *category-callback*: Exported special variables
Special Variable, *category-documentation-store*: Internal special variables
Special Variable, *config-callback*: Exported special variables
Special Variable, *config-documentation-store*: Internal special variables
Special Variable, *protocol-documentation-store*: Internal special variables
Special Variable, *protocol-objects*: Internal special variables
Special Variable, *protocol-validation-error-report*: Internal special variables
Special Variable, *protocols*: Exported special variables
Special Variable, *test-case-documentation-store*: Internal special variables
Special Variable, *test-cases*: Internal special variables
Special Variable, *undefined-protocol-function-report*: Internal special variables
Special Variable, *warn-on-test-case-redefinition-p*: Internal special variables
subclass: Internal conditions
symbol: Exported conditions

T
type: Exported conditions

Jump to:   %   *  
C   F   P   S   T  

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

A.4 Data types

Jump to:   C   P   S   T   U  
Index Entry  Section

C
Class, protocol: Exported classes
Class, protocol-category: Exported classes
Class, protocol-class: Exported classes
Class, protocol-condition-type: Exported classes
Class, protocol-config: Exported classes
Class, protocol-data-type: Exported classes
Class, protocol-element: Exported classes
Class, protocol-function: Exported classes
Class, protocol-macro: Exported classes
Class, protocol-operation: Exported classes
Class, protocol-variable: Exported classes
Class, test-case: Exported classes
Class, test-step: Exported classes
Condition, protocol-error: Exported conditions
Condition, protocol-object-instantiation: Exported conditions
Condition, protocol-validation-error: Internal conditions
Condition, simple-protocol-error: Exported conditions
Condition, undefined-protocol-function: Internal conditions

P
Package, protest: The protest package
Package, protest/base: The protest/base package
Package, protest/common: The protest/common package
Package, protest/ftype: The protest/ftype package
Package, protest/protocol: The protest/protocol package
Package, protest/test-case: The protest/test-case package
protest: The protest system
protest: The protest package
protest/base: The protest/base system
protest/base: The protest/base package
protest/common: The protest/common package
protest/ftype: The protest/ftype system
protest/ftype: The protest/ftype package
protest/protocol: The protest/protocol system
protest/protocol: The protest/protocol package
protest/test-case: The protest/test-case system
protest/test-case: The protest/test-case package
protocol: Exported classes
protocol-category: Exported classes
protocol-class: Exported classes
protocol-condition-type: Exported classes
protocol-config: Exported classes
protocol-data-type: Exported classes
protocol-element: Exported classes
protocol-error: Exported conditions
protocol-function: Exported classes
protocol-macro: Exported classes
protocol-object-instantiation: Exported conditions
protocol-operation: Exported classes
protocol-validation-error: Internal conditions
protocol-variable: Exported classes

S
simple-protocol-error: Exported conditions
System, protest: The protest system
System, protest/base: The protest/base system
System, protest/ftype: The protest/ftype system
System, protest/protocol: The protest/protocol system
System, protest/test-case: The protest/test-case system

T
test-case: Exported classes
test-step: Exported classes

U
undefined-protocol-function: Internal conditions

Jump to:   C   P   S   T   U