The filtered-functions Reference Manual

This is the filtered-functions Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:14:20 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 filtered-functions

Filtered functions provide an extension of generic function invocation that add a simple preprocessing step before the actual method dispatch is performed and thus enable the use of arbitrary predicates for selecting and applying methods.

Author

Pascal Costanza

License

MIT-style license

Version

0.2.0

Dependency

closer-mop (system).

Source

filtered-functions.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 filtered-functions/filtered-functions.asd

Source

filtered-functions.asd.

Parent Component

filtered-functions (system).

ASDF Systems

filtered-functions.


3.1.2 filtered-functions/filtered-functions-packages.lisp

Source

filtered-functions.asd.

Parent Component

filtered-functions (system).

Packages

3.1.3 filtered-functions/filtered-functions.lisp

Dependency

filtered-functions-packages.lisp (file).

Source

filtered-functions.asd.

Parent Component

filtered-functions (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 filtered-functions-user

Source

filtered-functions-packages.lisp.

Use List

4.2 filtered-functions

Source

filtered-functions-packages.lisp.

Use List

closer-common-lisp.

Used By List

filtered-functions-user.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: define-filtered-function (name (&rest lambda-list) &body options)
Package

filtered-functions.

Source

filtered-functions.lisp.


5.1.2 Generic functions

Generic Function: generic-function-filter-expression (gf)
Package

filtered-functions.

Source

filtered-functions.lisp.

Methods
Reader Method: generic-function-filter-expression ((simple-filtered-function simple-filtered-function))

automatically generated reader method

Target Slot

filter-expression.

Method: generic-function-filter-expression ((gf generic-function))
Generic Function: generic-function-filters (ff)
Package

filtered-functions.

Source

filtered-functions.lisp.

Methods
Method: generic-function-filters ((ff filtered-function))
Generic Function: (setf generic-function-filters) (ff)
Package

filtered-functions.

Source

filtered-functions.lisp.

Methods
Method: (setf generic-function-filters) ((ff filtered-function))
Generic Function: method-filter (method)
Package

filtered-functions.

Source

filtered-functions.lisp.

Methods
Reader Method: method-filter ((filtered-method filtered-method))

automatically generated reader method

Target Slot

filter.

Method: method-filter ((method method))

5.1.3 Standalone methods

Method: add-method ((ff filtered-function) method)
Source

filtered-functions.lisp.

Method: compute-applicable-methods ((ff simple-filtered-function) required-args)
Source

filtered-functions.lisp.

Method: compute-applicable-methods ((ff filtered-function) args)
Source

filtered-functions.lisp.

Method: compute-applicable-methods-using-classes ((ff simple-filtered-function) classes)
Package

sb-mop.

Source

filtered-functions.lisp.

Method: compute-applicable-methods-using-classes ((ff filtered-function) classes)
Package

sb-mop.

Source

filtered-functions.lisp.

Method: compute-discriminating-function ((ff filtered-function))
Package

sb-mop.

Source

filtered-functions.lisp.

Method: initialize-instance :after ((ff filtered-function) &key filters)
Source

filtered-functions.lisp.

Method: initialize-instance :after ((method filtered-method) &key qualifiers)
Source

filtered-functions.lisp.

Method: reinitialize-instance :after ((ff filtered-function) &rest initargs &key filters)
Source

filtered-functions.lisp.

Method: remove-method ((ff filtered-function) method)
Source

filtered-functions.lisp.


5.1.4 Method combinations

Method Combination: filtered ()
Package

filtered-functions.

Source

filtered-functions.lisp.


5.1.5 Classes

Class: filtered-function
Package

filtered-functions.

Source

filtered-functions.lisp.

Direct superclasses

standard-generic-function.

Direct methods
Direct slots
Slot: filter-groups
Initform

(quote nil)

Readers

%filter-groups.

Writers

This slot is read-only.

Class: filtered-method
Package

filtered-functions.

Source

filtered-functions.lisp.

Direct superclasses

standard-method.

Direct methods
Direct slots
Slot: filter
Readers

method-filter.

Writers

This slot is read-only.

Class: simple-filtered-function
Package

filtered-functions.

Source

filtered-functions.lisp.

Direct superclasses

standard-generic-function.

Direct methods
Direct slots
Slot: filter-expression
Initargs

:filter-expression

Readers

generic-function-filter-expression.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *generic-functions*
Package

filtered-functions.

Source

filtered-functions.lisp.


5.2.2 Ordinary functions

Function: check-filters (ff filters)
Package

filtered-functions.

Source

filtered-functions.lisp.


5.2.3 Generic functions

Generic Reader: %filter-groups (object)
Package

filtered-functions.

Methods
Reader Method: %filter-groups ((filtered-function filtered-function))

automatically generated reader method

Source

filtered-functions.lisp.

Target Slot

filter-groups.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   D   F   G   I   M   R  
Index Entry  Section

%
%filter-groups: Private generic functions
%filter-groups: Private generic functions

(
(setf generic-function-filters): Public generic functions
(setf generic-function-filters): Public generic functions

A
add-method: Public standalone methods

C
check-filters: Private ordinary functions
compute-applicable-methods: Public standalone methods
compute-applicable-methods: Public standalone methods
compute-applicable-methods-using-classes: Public standalone methods
compute-applicable-methods-using-classes: Public standalone methods
compute-discriminating-function: Public standalone methods

D
define-filtered-function: Public macros

F
filtered: Public method combinations
Function, check-filters: Private ordinary functions

G
Generic Function, %filter-groups: Private generic functions
Generic Function, (setf generic-function-filters): Public generic functions
Generic Function, generic-function-filter-expression: Public generic functions
Generic Function, generic-function-filters: Public generic functions
Generic Function, method-filter: Public generic functions
generic-function-filter-expression: Public generic functions
generic-function-filter-expression: Public generic functions
generic-function-filter-expression: Public generic functions
generic-function-filters: Public generic functions
generic-function-filters: Public generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Macro, define-filtered-function: Public macros
Method Combination, filtered: Public method combinations
Method, %filter-groups: Private generic functions
Method, (setf generic-function-filters): Public generic functions
Method, add-method: Public standalone methods
Method, compute-applicable-methods: Public standalone methods
Method, compute-applicable-methods: Public standalone methods
Method, compute-applicable-methods-using-classes: Public standalone methods
Method, compute-applicable-methods-using-classes: Public standalone methods
Method, compute-discriminating-function: Public standalone methods
Method, generic-function-filter-expression: Public generic functions
Method, generic-function-filter-expression: Public generic functions
Method, generic-function-filters: Public generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, method-filter: Public generic functions
Method, method-filter: Public generic functions
Method, reinitialize-instance: Public standalone methods
Method, remove-method: Public standalone methods
method-filter: Public generic functions
method-filter: Public generic functions
method-filter: Public generic functions

R
reinitialize-instance: Public standalone methods
remove-method: Public standalone methods