This is the static-dispatch Reference Manual, version 0.9, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:46:47 2024 GMT+0.
static-dispatch/static-dispatch.asdstatic-dispatch/src/package.lispstatic-dispatch/src/util.lispstatic-dispatch/src/warnings.lispstatic-dispatch/src/combin.lispstatic-dispatch/src/combinations.lispstatic-dispatch/src/common.lispstatic-dispatch/src/method-functions.lispstatic-dispatch/src/default.lispstatic-dispatch/src/sbcl.lispThe main system appears first, followed by any subsystem dependency.
static-dispatchStatic generic function dispatch for Common Lisp.
Alexander Gutev
MIT
0.9
alexandria (system).
anaphora (system).
arrows (system).
iterate (system).
optima (system).
closer-mop (system).
agutil (system).
cl-environments (system).
cl-form-types (system).
src (module).
Modules are listed depth-first from the system components tree.
static-dispatch/srcstatic-dispatch (system).
package.lisp (file).
util.lisp (file).
warnings.lisp (file).
combin.lisp (file).
combinations.lisp (file).
common.lisp (file).
method-functions.lisp (file).
default.lisp (file).
sbcl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
static-dispatch/static-dispatch.asdstatic-dispatch/src/package.lispstatic-dispatch/src/util.lispstatic-dispatch/src/warnings.lispstatic-dispatch/src/combin.lispstatic-dispatch/src/combinations.lispstatic-dispatch/src/common.lispstatic-dispatch/src/method-functions.lispstatic-dispatch/src/default.lispstatic-dispatch/src/sbcl.lispstatic-dispatch/static-dispatch.asdstatic-dispatch (system).
static-dispatch/src/util.lisppackage.lisp (file).
src (module).
ematch* (macro).
lambda-match (macro).
match* (macro).
static-dispatch/src/warnings.lisputil.lisp (file).
src (module).
dispatch-warn (function).
should-warn? (function).
static-dispatch/src/combin.lispwarnings.lisp (file).
src (module).
call-method (macro).
define-method-combination (macro).
invalid-method-error (function).
make-method (macro).
method-combination-error (function).
*current-method-combination* (special variable).
*full-arg-list-form* (special variable).
*gf-method-combination-options* (special variable).
*method-combination-functions* (special variable).
combin-destructure-args-error (condition).
combin-missing-required (condition).
combination (reader method).
combination (reader method).
combination (reader method).
combination-function (function).
(setf combination-function) (function).
combination-options (function).
(setf combination-options) (function).
compute-effective-method% (function).
compute-effective-method%% (function).
define-method-combination% (macro).
destructure-combin-lambda-list (function).
gf-name (reader method).
group-combin-methods (function).
group-spec (reader method).
message (reader method).
method-combination-function (macro).
method-combination-function-short (macro).
the-method (reader method).
unknown-method-combination (condition).
user-invalid-method-error (condition).
user-method-combination-error (condition).
static-dispatch/src/combinations.lispcombin.lisp (file).
src (module).
static-dispatch/src/common.lispcombinations.lisp (file).
src (module).
defgeneric (macro).
defmethod (macro).
enable-static-dispatch (macro).
*argument-map* (special variable).
*call-args* (special variable).
*current-gf* (special variable).
*env* (special variable).
*generic-function-table* (special variable).
*method-function-package* (special variable).
add-allow-other-keys (function).
add-compiler-macro (function).
applicable-methods (function).
block-name (function).
body (reader method).
(setf body) (writer method).
compute-applicable-methods% (function).
copy-temp-method (function).
destructure-args (function).
destructure-list (function).
enclose-in-type-declarations (function).
ensure-gf-methods (function).
ensure-method-info (function).
find-method% (function).
function-name (reader method).
(setf function-name) (writer method).
gf-method (function).
(setf gf-method) (function).
gf-methods (function).
info-for-method (function).
inline-call (function).
inline-method-form (function).
lambda-list (reader method).
(setf lambda-list) (writer method).
make-add-method-info (function).
make-argument-bindings (function).
make-ignorable-declarations (function).
make-inline-method-body (function).
make-method-function-call (function).
make-temp-method (function).
make-type-checks (function).
make-type-declarations (function).
method-info (class).
method-spec (function).
next-method-default-args (function).
order-by-precedence (function).
order-method-specializers (function).
parse-method (function).
parse-method-lambda-list (function).
precedence-order (function).
qualifiers (reader method).
(setf qualifiers) (writer method).
remove-defined-methods (function).
remove-on-redefine-p (reader method).
(setf remove-on-redefine-p) (writer method).
should-call-fn? (function).
should-check-types? (function).
sort-methods (function).
specializer->cl (function).
specializer< (function).
specializers (reader method).
(setf specializers) (writer method).
static-dispatch-test-hook (macro).
static-dispatch? (function).
static-method-function-test-hook (macro).
temp-method (structure).
temp-method-body (reader).
(setf temp-method-body) (writer).
temp-method-p (function).
unparse-lambda-list (function).
wrap-in-macros (function).
static-dispatch/src/method-functions.lispcommon.lisp (file).
src (module).
static-dispatch-type (function).
make-method-function (function).
static-dispatch/src/default.lisp(:not :sbcl)
method-functions.lisp (file).
src (module).
static-dispatch/src/sbcl.lisp:sbcl
default.lisp (file).
method-functions.lisp (file).
src (module).
static-dispatch (function).
+static-dispatch-policy+ (constant).
gensym-lambda-list (function).
lambda-list->type-list (function).
make-dispatch-type-list (function).
make-reconstruct-arg-list (function).
make-reconstruct-static-arg-list (function).
make-static-dispatch (function).
positions (function).
should-apply? (function).
static-overload (function).
Packages are listed by definition order.
static-dispatchagutil.
alexandria.
anaphora.
arrows.
cl-form-types.
closer-environments.
iterate.
optima.
call-method (macro).
defgeneric (macro).
define-method-combination (macro).
defmethod (macro).
enable-static-dispatch (macro).
invalid-method-error (function).
make-method (macro).
method-combination-error (function).
static-dispatch (function).
static-dispatch-type (function).
*argument-map* (special variable).
*call-args* (special variable).
*current-gf* (special variable).
*current-method-combination* (special variable).
*env* (special variable).
*full-arg-list-form* (special variable).
*generic-function-table* (special variable).
*gf-method-combination-options* (special variable).
*method-combination-functions* (special variable).
*method-function-package* (special variable).
+static-dispatch-policy+ (constant).
add-allow-other-keys (function).
add-compiler-macro (function).
applicable-methods (function).
block-name (function).
body (generic reader).
(setf body) (generic writer).
combin-destructure-args-error (condition).
combin-missing-required (condition).
combination (generic reader).
combination-function (function).
(setf combination-function) (function).
combination-options (function).
(setf combination-options) (function).
compute-applicable-methods% (function).
compute-effective-method% (function).
compute-effective-method%% (function).
copy-temp-method (function).
define-method-combination% (macro).
destructure-args (function).
destructure-combin-lambda-list (function).
destructure-list (function).
dispatch-warn (function).
ematch* (macro).
enclose-in-type-declarations (function).
ensure-gf-methods (function).
ensure-method-info (function).
find-method% (function).
function-name (generic reader).
(setf function-name) (generic writer).
gensym-lambda-list (function).
gf-method (function).
(setf gf-method) (function).
gf-methods (function).
gf-name (generic reader).
group-combin-methods (function).
group-spec (generic reader).
info-for-method (function).
inline-call (function).
inline-method-form (function).
lambda-list (generic reader).
(setf lambda-list) (generic writer).
lambda-list->type-list (function).
lambda-match (macro).
make-add-method-info (function).
make-argument-bindings (function).
make-dispatch-type-list (function).
make-ignorable-declarations (function).
make-inline-method-body (function).
make-method-function (function).
make-method-function-call (function).
make-reconstruct-arg-list (function).
make-reconstruct-static-arg-list (function).
make-static-dispatch (function).
make-temp-method (function).
make-type-checks (function).
make-type-declarations (function).
match* (macro).
message (generic reader).
method-combination-function (macro).
method-combination-function-short (macro).
method-info (class).
method-spec (function).
next-method-default-args (function).
order-by-precedence (function).
order-method-specializers (function).
parse-method (function).
parse-method-lambda-list (function).
positions (function).
precedence-order (function).
qualifiers (generic reader).
(setf qualifiers) (generic writer).
remove-defined-methods (function).
remove-on-redefine-p (generic reader).
(setf remove-on-redefine-p) (generic writer).
should-apply? (function).
should-call-fn? (function).
should-check-types? (function).
should-warn? (function).
sort-methods (function).
specializer->cl (function).
specializer< (function).
specializers (generic reader).
(setf specializers) (generic writer).
static-dispatch-test-hook (macro).
static-dispatch? (function).
static-method-function-test-hook (macro).
static-overload (function).
temp-method (structure).
temp-method-body (reader).
(setf temp-method-body) (writer).
temp-method-p (function).
the-method (generic reader).
unknown-method-combination (condition).
unparse-lambda-list (function).
user-invalid-method-error (condition).
user-method-combination-error (condition).
wrap-in-macros (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A no-op on SBCL since static dispatching is handled by the compiler transforms, rather than compiler macros.
Return the declared STATIC-DISPATCH-TYPE of the function FN, in environment ENV.
Optimization policy at which static dispatching is performed.
List of bindings (as if to LET) binding the lambda-list variables to the names of the actual variables storing the arguments passed to the function.
Bound to the argument list of the current generic function call.
The name of the generic function currently being inlined/statically dispatched.
When inside the dynamic extent of a method combination function, set to a CONS of the form (GF . COMBINATION) where name is the name of the generic function and COMBINATION is the name of the method combination.
Environment in which the current generic function is being statically dispatched.
Bound to a from which constructs the full argument list for use as the default argument list in CALL-NEXT-METHOD.
Hash table mapping generic functions to a list of methods.
Hash-table mapping generic function names to the list (COMBINATION OPTIONS) where COMBINATION is the name of the generic-function’s method-combination and OPTIONS is the list of options given to the method-combination.
Hash-table mapping method-combination names to the functions which
implement them for the static-dispatch system.
This is necessary since the built in COMPUTE-EFFECTIVE-METHOD does not have a standardized output and varies considerably between implementations, hence the functionality has to be reimplemented for static-dispatch.
Package into which statically dispatched method function names are interned.
Define a method-combination for the static-dispatch system only.
Arguments are of the same form as to CL:DEFINE-METHOD-COMBINATION.
Generate a method-combination function for the long-form of CL:DEFINE-METHOD-COMBINATION.
Generate a method-combination function for the short-form of CL:DEFINE-METHOD-COMBINATION.
A form of this macro is inserted in the output of the STATIC-DISPATCH compiler macro, in order to allow certain test code to be inserted, by shadowing this macro using MACROLET. The global expands to NIL.
A form of this macro is inserted in method functions, in order to allow test code to be inserted.
Add &ALLOW-OTHER-KEYS to a LAMBDA-LIST.
Add compiler-macro to generic-function.
Returns a list of all methods in METHODS which are applicable to
the types TYPES.
If REMOVE-T is true, applicable methods with a T specializer which match a T argument type are not considered unless all other methods have a T specializer for that argument. If NIL they are considered for applicability.
Returns the name of the implicit block, surrounding a method of the generic function GF-NAME.
Retrieve the function implementing the method-combination COMBINATION.
Set the combination function implementing a method-combination.
Retrieve the method combination name and options of the generic function with name GF-NAME.
Set the method combination name and options for a given generic function.
Determine the applicable methods for given argument types.
NAME is the name of the generic-function.
TYPES is the list of types of the generic-function required
arguments.
Returns the sorted list of applicable methods. Returns NIL if there are no applicable methods, or if the generic-function contains a method for which there is no ‘METHOD-INFO’ object.
Static dispatch version of CLOSER-MOP:COMPUTE-EFFECTIVE-METHOD.
Compute the effective method of a generic-function for a given list
of methods.
Calls the function implementing the generic function’s
method-combination for the static-dispatch system. For this to
happen, the generic function must be known (declared with
STATIC-DISPATCH:DEFGENERIC) as well as its
method-combination (defined with
STATIC-DISPATCH:DEFINE-METHOD-COMBINATION).
GF is the generic-function object.
METHODS is the list of method objects for the applicable methods,
ordered with the most specific method first.
ARGS is the specifier for the arguments to the generic function call.
Compute the effective method given a method-combination function.
GF is the generic-function object.
COMBIN-FN is the method-combination function.
METHODS is the list of method objects for the applicable methods,
ordered with the most specific method first.
ARGS is the specifier for the arguments to the generic function call.
Destructure the argument list, based on the lambda-list, if possible.
Generates a binding form for the variables in a lambda-list which
are bound to the argument forms of the arguments to the generic
function call.
ARGS is the list of argument forms passed to the generic function.
LAMBDA-LIST is the method lambda list.
BODY is the list of forms comprising the method body which are
inserted in the body of the binding form. The first element of BODY
may be a declare expression.
Returns a binding form, binding all variables in LAMBDA-LIST and containing BODY.
Emit a form which destructures the argument list in a method-combination.
GF is the generic-function object.
LAMBDA-LIST is the :ARGUMENTS lambda-list of the
method-combination.
GENSYMS is an association list mapping variable names to the
gensymed variable names which should be inserted in the resulting
form.
ARGS is the arguments specifier of the generic function call.
BODY is a list of forms which make use of the variables in the
lambda-list.
Returns a list of forms which wrap BODY in code that destructures the arguments according to LAMBDA-LIST.
Destructure a list.
LAMBDA-LIST is the lambda-list specifying how LIST is destructured.
LIST is the list of forms which are destructured.
Returns a list of LET* bindings which bind the variables in LAMBDA-LIST to the corresponding forms in LIST. If destructuring fails an error condition is signalled.
Emit a static dispatch failure warning.
Checks whether the warning should actually be emitted, according to
the declared static-dispatch warning level in the environment.
ENV is the lexical environment of the generic function call.
E is the error condition object, of the static-dispatch failure, which is printed in the warning.
Encloses FORMS in a LOCALLY form which declares the types of VARS to be TYPES.
Ensures that a method table for the generic function GF-NAME exists, in *GENERIC-FUNCTION-TABLE*.
Ensures that the method table, within *GENERIC-FUNCTION-TABLE*, of the generic function GF-NAME contains a method with qualifiers QUALIFIERS, specializers SPECIALIZERS, lambda-list LAMBDA-LIST, static method function-name FUNCTION-NAME, and body BODY. If the table does not contain a method for those specializers, a new ‘METHOD-INFO’ object is created.
Same as FIND-METHOD but allows SPECIALIZERS to be a list of symbolic specializers rather than classes.
Replace the variables in a lambda-list with gensyms.
LAMBDA-LIST: The lambda-list.
Returns two values:
1. The new lambda-list with the variables replaced by gensyms.
2. The list of bindings, as if to LET, binding the original variables to the corresponding gensym’d variables.
Returns the ‘METHOD-INFO’, of the method with specifier (qualifier and specializer list) SPEC of the generic function GF-NAME.
Sets the method info, to VALUE, for the method with
specifier (qualifier and specializer list) SPEC of the generic
function GF-NAME.
Returns the method information for the generic function GF-NAME. A hash-table mapping lists of specializers to ‘METHOD-INFO’ objects is returned.
Group the methods according to the method-combination group specifier
METHODS is the list of generic-function methods.
GROUPS is the list of patterns of each method group specifier
ORDERS is a list specifying the order, by which the methods should be ordered, of each group specifier.
Return the ‘METHOD-INFO’ object for a method.
GF-NAME is the name of the generic function.
METHOD is the method object.
Returns the corresponding ‘METHOD-INFO’ object or NIL if there is no information about the method.
Inline a call to a generic-function with a given list of methods.
GF is the generic-function object, of the generic-function call to
inline.
METHODS is the sorted list of applicable method objects.
TYPES is the list of the types of the arguments.
CHECK-TYPES is a flag for whether, if true, type checks should be
inserted in the CALL-NEXT-METHOD local function definitions.
CALL-FN is a flag for whether, if true, ordinary method function calls should be emitted rather than inlining the method body.
Inline a method with the definitions of the CALL-NEXT-METHOD and NEXT-METHOD-P functions.
NAME is the name of the generic-function.
METHOD is the method object, of the method to inline.
ARGS is the specifier for the arguments to the generic-function call.
NEXT-METHODS is the list of the next method objects.
CALL-FN is a flag for whether, if true, ordinary method function
calls should be emitted rather than inlining the method body.
TYPES is the argument type list.
CHECK-TYPES if a flag for whether type checks should be inserted in
the CALL-NEXT-METHOD definition.
Returns a form containing the inlined method with the lexical
CALL-NEXT-METHOD and NEXT-METHOD-P function definitions.
Convert a lambda-list to a type specifier list.
LAMBDA-LIST is the lambda-list.
SPECIALIZERS is the list of type specializers of the required arguments of the lambda-list.
Create a form which adds the method information to the method table.
NAME is the name of the generic function.
METHOD is a variable storing the method object.
FN-NAME is the name of the ordinary function which implements the
method.
BODY is the method body.
REMOVE-ON-REDEFINE-P is a flag for whether the method should be removed when the generic function is redefined.
Generating LET bindings which bind the arguments to variables.
ARGS is the list of argument forms passed to the generic function
call. If it’s a symbol it represents the name of a variable which
stores the argument list.
TYPES is the list of type specifiers of the arguments, as
determined from the environment.
Returns three values:
1. A list of LET bindings.
2. The new argument list.
3. A list of declarations relating to the variables.
Generate a form which generates the argument type list.
ARGS are the transform arguments to include in the type list.
NODE is the compilation node argument.
Creates a DECLARE IGNORABLE expression for the variables in VARS.
Returns the inline method body (without the CALL-NEXT-METHOD and NEXT-METHOD-P functions), of a METHOD, when applied on arguments ARGS with types TYPES.
Generate a DEFUN form implementing a generic function method.
GF-NAME is the name of the generic function.
NAME is the name of the function to generate.
LAMBDA-LIST is the ordinary function’s lambda-list.
BODY is the body implementing the method.
Returns a DEFUN form for the method function.
Generate call to the function which implements a method.
FUNCTION is the name of the function which implements the method.
ARGS is the argument specifier of the method. Either a list
containing the argument forms, or a symbol naming the variable in
which the argument list is stored.
EXTRA is a list of extra arguments to pass before ARGS.
Returns the function call form.
Generate a form which generates a form that reconstructs an argument list.
The generated form is expected to be used inside a DEFTRANSFORM
where each lambda-list variable is bound to the compilation entity
or NIL if not provided.
LAMBDA-LIST is the lambda-list from which to reconstruct the
argument list.
Returns a form that when evaluated produces another form that reconstructs the argument list.
Generate a form that reconstructs an argument list.
The generated form is expected to be used inside a DEFTRANSFORM
where each lambda-list variable is bound to the compilation entity
or NIL if not provided.
LAMBDA-LIST is the lambda-list from which to reconstruct the
argument list.
Returns a form that when evaluated returns the static argument list.
Returns a list of CHECK-TYPE forms for each variable in VARS and corresponding type in TYPES.
Returns a DECLARE expression which declares each variable in VARS to be of the type stored in the corresponding element of TYPES
Return the method specifier, i.e. the key used within the method table.
METHOD-INFO is the ‘METHOD-INFO’ object of the method.
Generate the default CALL-NEXT-METHOD argument list form.
ARGS is the argument list specifier of the arguments passed to the
current method. This may either be a list of forms or a symbol
which names a variable in which the full list is stored.
Returns a form that creates the default CALL-NEXT-METHOD argument list.
Orders the list ARGS by the order specified in PRECEDENCE.
Orders the specializers of METHODS by the argument precedence order PRECEDENCE.
Return a list containing the positions of the elements of sequence SEQ which are EQL to ITEM.
Returns a list of the generic function arguments in argument precedence order (PRECEDENCE). Each element in the list is the index of the argument within LAMBDA-LIST.
Remove the methods of a generic-function for which REMOVE-ON-REDEFINE-P is true.
NAME is the name of the generic function.
Check whether the current transform should be applied.
A transform is generated for each method, therefore each transform
should only be applied if the most specific method is the
transform’s method. This is done by comparing the type-list for the
most specific method to the transform’s type-list and if they
match, the transform is applied.
METHODS is the sorted list of applicable methods.
TYPE-LIST is the type list for the current transform.
Return true if the transform should be applied.
Returns true if a call to the ordinary function, implementing the
method for generic-function NAME, should be emitted rather than
inlining the method body.
Function calls are emitted when there is a SPACE optimize quality equal to 3 in the environment ENV.
Returns true if CHECK-TYPE forms should be added in the body of CALL-NEXT-METHOD. CHECK-TYPE forms are added if the priority of the SAFETY optimize quality is greater than or equal to the SPEED optimize quality in the environment ENV.
Returns true if warnings should be emitted for static-dispatching errors in the environment ENV.
Sorts METHODS by specificity.
Returns the CL representation of a specializer as used in a DEFMETHOD lambda-list. ‘CLASS’ specializers are replaced with their CLASS-NAME and EQL specializers are replaced with ‘(EQL ,EQL-SPECIALIZER-OBJECT). The EQL-SPECIALIZER-OBJECT is the value to which the EQL object form was evaluated not the form itself.
Returns true if the specializer list S1 is more specific than specializer list S2.
Checks whether the generic function named NAME should be statically dispatched. This is the case if it is declared inline in the environment ENV.
body.
Construct a lambda-list out of its components.
REQUIRED is the list of required arguments.
OPTIONAL is the list of optional argument specifiers.
REST is the rest argument, or NIL if there is no rest argument.
ALLOW-OTHER-KEYS is a flag for whether &ALLOW-OTHER-KEYS should be
present.
AUX is the list of auxiliary variable specifiers.
KEYP is a flag for whether &key should be present.
Returns the lambda list.
Wrap a form in the lexical CALL-METHOD and MAKE-METHOD macros.
NAME is the name of the generic-function being statically
dispatched.
ARGS is the specifier for the arguments of the generic-function
call.
FORM is the form which should be inserted in the body of the
MACROLET.
CALL-FN is a flag for whether, if true, ordinary method function
calls should be emitted rather than inlining the method body.
TYPES is the argument type list.
CHECK-TYPES is a flag for whether type checks should be inserted in
the CALL-NEXT-METHOD definitions.
Returns a MACROLET form.
method-info)) ¶method-info)) ¶The method function body.
body.
user-method-combination-error)) ¶combin-missing-required)) ¶unknown-method-combination)) ¶method-info)) ¶method-info)) ¶The name of the ordinary function implementing the method.
user-method-combination-error)) ¶combin-missing-required)) ¶method-info)) ¶method-info)) ¶The lambda-list of the method.
user-method-combination-error)) ¶method-info)) ¶method-info)) ¶List of method qualifiers.
method-info)) ¶method-info)) ¶True if the method should be removed when the DEFGENERIC form is re-evaluated.
method-info)) ¶method-info)) ¶The method’s specializers
user-invalid-method-error)) ¶Represents an error in destructuring the (rest/keyword) section of the generic function lambda-list.
error.
Error condition representing the error of no methods being matched to a required group specifier in a method combination.
Error condition representing a method-combination which has not been defined through STATIC-DISPATCH-CL:DEFINE-METHOD-COMBINATION, and hence static-dispatch doesn’t know about it.
error.
The method combination
:combination
This slot is read-only.
Error condition representing a method whose qualifiers do not match any group specifier. Signalled with the INVALID-METHOD-ERROR function.
The invalid method
:the-method
This slot is read-only.
User method combination error condition signalled with METHOD-COMBINATION-ERROR function.
error.
Name of the generic function
:gf-name
This slot is read-only.
Name of the method combination
:combination
This slot is read-only.
Represents a ’temporary’ method created with MAKE-METHOD.
structure-object.
Stores the body of a method and the name of a non-generic function which contains the method’s body.
List of method qualifiers.
:qualifiers
The lambda-list of the method.
:lambda-list
The method’s specializers
:specializers
The name of the ordinary function implementing the method.
:function-name
True if the method should be removed when the DEFGENERIC form is re-evaluated.
:remove-on-redefine-p
| Jump to: | (
A B C D E F G I L M N O P Q R S T U W |
|---|
| Jump to: | (
A B C D E F G I L M N O P Q R S T U W |
|---|
| Jump to: | *
+
B C F G L M Q R S T |
|---|
| Jump to: | *
+
B C F G L M Q R S T |
|---|
| Jump to: | C D F M P S T U W |
|---|
| Jump to: | C D F M P S T U W |
|---|