The filter-maker Reference Manual

This is the filter-maker Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:27:08 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 filter-maker

CLIM program for letting users make filters out of predicates and keys.

Author

John Lorentzson (Duuqnd)

License

BSD 2-Clause

Version

1.0.0

Dependency

mcclim (system).

Source

filter-maker.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 filter-maker/filter-maker.asd

Source

filter-maker.asd.

Parent Component

filter-maker (system).

ASDF Systems

filter-maker.


3.1.2 filter-maker/package.lisp

Source

filter-maker.asd.

Parent Component

filter-maker (system).

Packages

filter-maker.


3.1.3 filter-maker/filter-maker.lisp

Dependency

package.lisp (file).

Source

filter-maker.asd.

Parent Component

filter-maker (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 filter-maker

Source

package.lisp.

Use List
  • clim.
  • clim-lisp.
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 Ordinary functions

Function: filter (predicates keys items)

Display a GUI filter maker with PREDICATES and KEYS that will filter ITEMS.

Package

filter-maker.

Source

filter-maker.lisp.

Function: run-filter-maker (items predicates keys)
Package

filter-maker.

Source

filter-maker.lisp.


5.1.2 Generic functions

Generic Reader: arguments (object)
Package

filter-maker.

Methods
Reader Method: arguments ((predicate predicate))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%arguments.

Generic Reader: key (object)
Package

filter-maker.

Methods
Reader Method: key ((rule rule))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%key.

Generic Writer: (setf key) (object)
Package

filter-maker.

Methods
Writer Method: (setf key) ((rule rule))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%key.

Generic Reader: key-function (object)
Package

filter-maker.

Methods
Reader Method: key-function ((key key))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%function.

Generic Writer: (setf key-function) (object)
Package

filter-maker.

Methods
Writer Method: (setf key-function) ((key key))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%function.

Generic Reader: predicate (object)
Package

filter-maker.

Methods
Reader Method: predicate ((rule rule))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%predicate.

Generic Writer: (setf predicate) (object)
Package

filter-maker.

Methods
Writer Method: (setf predicate) ((rule rule))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%predicate.

Generic Reader: predicate-function (object)
Package

filter-maker.

Methods
Reader Method: predicate-function ((predicate predicate))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%function.

Generic Reader: pretty-name (object)
Package

filter-maker.

Methods
Reader Method: pretty-name ((key key))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%pretty-name.

Reader Method: pretty-name ((predicate predicate))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%pretty-name.

Generic Writer: (setf pretty-name) (object)
Package

filter-maker.

Methods
Writer Method: (setf pretty-name) ((key key))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%pretty-name.

Generic Reader: value (object)
Package

filter-maker.

Methods
Reader Method: value ((rule rule))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%value.

Generic Writer: (setf value) (object)
Package

filter-maker.

Methods
Writer Method: (setf value) ((rule rule))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%value.


5.1.3 Standalone methods

Method: update-instance-for-redefined-class :after ((instance filter-maker) as ds pl &rest initargs)
Source

filter-maker.lisp.


5.1.4 Classes

Class: key
Package

filter-maker.

Source

filter-maker.lisp.

Direct methods
Direct slots
Slot: %function
Initargs

:function

Readers

key-function.

Writers

(setf key-function).

Slot: %pretty-name
Initargs

:pretty-name

Readers

pretty-name.

Writers

(setf pretty-name).

Class: predicate
Package

filter-maker.

Source

filter-maker.lisp.

Direct methods
Direct slots
Slot: %function
Initargs

:function

Readers

predicate-function.

Writers

This slot is read-only.

Slot: %pretty-name
Initargs

:pretty-name

Readers

pretty-name.

Writers

This slot is read-only.

Slot: %arguments
Initargs

:arguments

Readers

arguments.

Writers

This slot is read-only.

Class: rule
Package

filter-maker.

Source

filter-maker.lisp.

Direct methods
Direct slots
Slot: %predicate
Initform

(first (filter-maker::predicates clim:*application-frame*))

Initargs

:predicate

Readers

predicate.

Writers

(setf predicate).

Slot: %key
Initform

(first (filter-maker::keys clim:*application-frame*))

Initargs

:key

Readers

key.

Writers

(setf key).

Slot: %value
Initform

""

Readers

value.

Writers

(setf value).


5.2 Internals


5.2.1 Macros

Macro: define-filter-maker-command (name-and-options arguments &rest body)
Package

filter-maker.

Source

filter-maker.lisp.


5.2.2 Ordinary functions

Function: display-items (frame pane)
Package

filter-maker.

Source

filter-maker.lisp.

Function: display-rule (frame pane rule)
Package

filter-maker.

Source

filter-maker.lisp.

Function: display-rule-list (frame pane)
Package

filter-maker.

Source

filter-maker.lisp.


5.2.3 Generic functions

Generic Function: apply-filter (frame)
Package

filter-maker.

Methods
Method: apply-filter ((frame filter-maker))
Source

filter-maker.lisp.

Generic Function: apply-rule (rule item)
Package

filter-maker.

Methods
Method: apply-rule ((rule rule) item)
Source

filter-maker.lisp.

Generic Reader: combining-type (object)
Package

filter-maker.

Methods
Reader Method: combining-type ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%combining-type.

Generic Writer: (setf combining-type) (object)
Package

filter-maker.

Methods
Writer Method: (setf combining-type) ((filter-maker filter-maker))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%combining-type.

Generic Reader: items (object)
Package

filter-maker.

Methods
Reader Method: items ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%items.

Generic Reader: keys (object)
Package

filter-maker.

Methods
Reader Method: keys ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%keys.

Generic Writer: (setf keys) (object)
Package

filter-maker.

Methods
Writer Method: (setf keys) ((filter-maker filter-maker))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%keys.

Generic Reader: predicates (object)
Package

filter-maker.

Methods
Reader Method: predicates ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%predicates.

Generic Writer: (setf predicates) (object)
Package

filter-maker.

Methods
Writer Method: (setf predicates) ((filter-maker filter-maker))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%predicates.

Generic Reader: return-value (object)
Package

filter-maker.

Methods
Reader Method: return-value ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%return-value.

Generic Writer: (setf return-value) (object)
Package

filter-maker.

Methods
Writer Method: (setf return-value) ((filter-maker filter-maker))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%return-value.

Generic Reader: rules (object)
Package

filter-maker.

Methods
Reader Method: rules ((filter-maker filter-maker))

automatically generated reader method

Source

filter-maker.lisp.

Target Slot

%rules.

Generic Writer: (setf rules) (object)
Package

filter-maker.

Methods
Writer Method: (setf rules) ((filter-maker filter-maker))

automatically generated writer method

Source

filter-maker.lisp.

Target Slot

%rules.


5.2.4 Standalone methods

Method: reinitialize-panes-and-layouts ((frame filter-maker))
Package

clim-internals.

Source

filter-maker.lisp.


5.2.5 Classes

Class: filter-maker
Package

filter-maker.

Source

filter-maker.lisp.

Direct superclasses

standard-application-frame.

Direct methods
Direct Default Initargs
InitargValue
:name(quote filter-maker)
:pretty-namefilter-maker
:command-table(find-command-table (quote filter-maker))
:disabled-commands(quote nil)
:menu-bar(quote nil)
:pointer-documentation(quote nil)
:current-layout(quote default)
:layouts(quote ((default (vertically nil rule-list (horizontally nil combining-type-list show-items-button +fill+ add-rule ok cancel))) (item-display-layout (vertically nil (horizontally nil rule-list item-display) (horizontally nil combining-type-list show-items-button +fill+ add-rule ok cancel)))))
:resize-frame(quote nil)
:top-level-lambda(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote rule-list) (make-clim-application-pane name (quote rule-list) display-time command-loop display-function (quote display-rule-list))) (cons (quote add-rule) (make-pane (quote push-button) name (quote add-rule) label add new rule activate-callback (lambda (gadget) (declare (ignore gadget)) (let ((rule (make-instance (quote rule)))) (setf (rules *application-frame*) (append (rules *application-frame*) (list rule))) (redisplay-frame-panes *application-frame*))))) (cons (quote ok) (make-pane (quote push-button) name (quote ok) label ok activate-callback (lambda (gadget) (declare (ignore gadget)) (setf (return-value *application-frame*) (apply-filter *application-frame*)) (frame-exit *application-frame*)))) (cons (quote cancel) (make-pane (quote push-button) name (quote cancel) label cancel activate-callback (lambda (gadget) (declare (ignore gadget)) (setf (return-value *application-frame*) cancelled) (frame-exit *application-frame*)))) (cons (quote combining-type-list) (make-pane (quote option-pane) name (quote combining-type-list) items (quote ((or match any rule) (and match all rules))) name-key (function second) value-key (function first) value or value-changed-callback (lambda (gadget value) (declare (ignore gadget)) (setf (combining-type *application-frame*) value)))) (cons (quote show-items-button) (make-pane (quote push-button) name (quote show-items-button) label toggle filter preview activate-callback (lambda (gadget) (declare (ignore gadget)) (if (eq (frame-current-layout *application-frame*) (quote item-display-layout)) (setf (frame-current-layout *application-frame*) (quote default)) (setf (frame-current-layout *application-frame*) (quote item-display-layout)))))) (cons (quote item-display) (make-clim-application-pane name (quote item-display) display-function (quote display-items))))))))
:layout-constructor(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (let ((rule-list (assoc-value named-panes (quote rule-list) test (function eq))) (add-rule (assoc-value named-panes (quote add-rule) test (function eq))) (ok (assoc-value named-panes (quote ok) test (function eq))) (cancel (assoc-value named-panes (quote cancel) test (function eq))) (combining-type-list (assoc-value named-panes (quote combining-type-list) test (function eq))) (show-items-button (assoc-value named-panes (quote show-items-button) test (function eq))) (item-display (assoc-value named-panes (quote item-display) test (function eq)))) (setf (frame-panes frame) (ecase (frame-current-layout frame) (default (vertically nil rule-list (horizontally nil combining-type-list show-items-button +fill+ add-rule ok cancel))) (item-display-layout (vertically nil (horizontally nil rule-list item-display) (horizontally nil combining-type-list show-items-button +fill+ add-rule ok cancel))))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))
Direct slots
Slot: %predicates
Initform

(quote nil)

Initargs

:predicates

Readers

predicates.

Writers

(setf predicates).

Slot: %keys
Initargs

:keys

Readers

keys.

Writers

(setf keys).

Slot: %combining-type
Initform

:or

Initargs

:combining-type

Readers

combining-type.

Writers

(setf combining-type).

Slot: %rules
Initform

(quote nil)

Readers

rules.

Writers

(setf rules).

Slot: %items
Initargs

:items

Readers

items.

Writers

This slot is read-only.

Slot: %return-value
Initform

:cancelled

Readers

return-value.

Writers

(setf return-value).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   F   G   I   K   M   P   R   U   V  
Index Entry  Section

(
(setf combining-type): Private generic functions
(setf combining-type): Private generic functions
(setf key): Public generic functions
(setf key): Public generic functions
(setf key-function): Public generic functions
(setf key-function): Public generic functions
(setf keys): Private generic functions
(setf keys): Private generic functions
(setf predicate): Public generic functions
(setf predicate): Public generic functions
(setf predicates): Private generic functions
(setf predicates): Private generic functions
(setf pretty-name): Public generic functions
(setf pretty-name): Public generic functions
(setf return-value): Private generic functions
(setf return-value): Private generic functions
(setf rules): Private generic functions
(setf rules): Private generic functions
(setf value): Public generic functions
(setf value): Public generic functions

A
apply-filter: Private generic functions
apply-filter: Private generic functions
apply-rule: Private generic functions
apply-rule: Private generic functions
arguments: Public generic functions
arguments: Public generic functions

C
combining-type: Private generic functions
combining-type: Private generic functions

D
define-filter-maker-command: Private macros
display-items: Private ordinary functions
display-rule: Private ordinary functions
display-rule-list: Private ordinary functions

F
filter: Public ordinary functions
Function, display-items: Private ordinary functions
Function, display-rule: Private ordinary functions
Function, display-rule-list: Private ordinary functions
Function, filter: Public ordinary functions
Function, run-filter-maker: Public ordinary functions

G
Generic Function, (setf combining-type): Private generic functions
Generic Function, (setf key): Public generic functions
Generic Function, (setf key-function): Public generic functions
Generic Function, (setf keys): Private generic functions
Generic Function, (setf predicate): Public generic functions
Generic Function, (setf predicates): Private generic functions
Generic Function, (setf pretty-name): Public generic functions
Generic Function, (setf return-value): Private generic functions
Generic Function, (setf rules): Private generic functions
Generic Function, (setf value): Public generic functions
Generic Function, apply-filter: Private generic functions
Generic Function, apply-rule: Private generic functions
Generic Function, arguments: Public generic functions
Generic Function, combining-type: Private generic functions
Generic Function, items: Private generic functions
Generic Function, key: Public generic functions
Generic Function, key-function: Public generic functions
Generic Function, keys: Private generic functions
Generic Function, predicate: Public generic functions
Generic Function, predicate-function: Public generic functions
Generic Function, predicates: Private generic functions
Generic Function, pretty-name: Public generic functions
Generic Function, return-value: Private generic functions
Generic Function, rules: Private generic functions
Generic Function, value: Public generic functions

I
items: Private generic functions
items: Private generic functions

K
key: Public generic functions
key: Public generic functions
key-function: Public generic functions
key-function: Public generic functions
keys: Private generic functions
keys: Private generic functions

M
Macro, define-filter-maker-command: Private macros
Method, (setf combining-type): Private generic functions
Method, (setf key): Public generic functions
Method, (setf key-function): Public generic functions
Method, (setf keys): Private generic functions
Method, (setf predicate): Public generic functions
Method, (setf predicates): Private generic functions
Method, (setf pretty-name): Public generic functions
Method, (setf return-value): Private generic functions
Method, (setf rules): Private generic functions
Method, (setf value): Public generic functions
Method, apply-filter: Private generic functions
Method, apply-rule: Private generic functions
Method, arguments: Public generic functions
Method, combining-type: Private generic functions
Method, items: Private generic functions
Method, key: Public generic functions
Method, key-function: Public generic functions
Method, keys: Private generic functions
Method, predicate: Public generic functions
Method, predicate-function: Public generic functions
Method, predicates: Private generic functions
Method, pretty-name: Public generic functions
Method, pretty-name: Public generic functions
Method, reinitialize-panes-and-layouts: Private standalone methods
Method, return-value: Private generic functions
Method, rules: Private generic functions
Method, update-instance-for-redefined-class: Public standalone methods
Method, value: Public generic functions

P
predicate: Public generic functions
predicate: Public generic functions
predicate-function: Public generic functions
predicate-function: Public generic functions
predicates: Private generic functions
predicates: Private generic functions
pretty-name: Public generic functions
pretty-name: Public generic functions
pretty-name: Public generic functions

R
reinitialize-panes-and-layouts: Private standalone methods
return-value: Private generic functions
return-value: Private generic functions
rules: Private generic functions
rules: Private generic functions
run-filter-maker: Public ordinary functions

U
update-instance-for-redefined-class: Public standalone methods

V
value: Public generic functions
value: Public generic functions