The lisp-critic Reference Manual

This is the lisp-critic Reference Manual, version 1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:00:00 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 lisp-critic
- 2.2 ckr-tables
3 Files
- 3.1 Lisp
4 Packages
5 Definitions
- 5.1 Public Interface
- 5.2 Internals
Appendix A Indexes

1 Introduction

* LISP-CRITIC - A Lisp code critiquing package.

see https://courses.cs.northwestern.edu/325/exercises/critic.php#critic

- Author: Chris Riesbeck
- Licence: MIT Licence
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Load:
#+BEGIN_SRC lisp
(asdf:load-system :lisp-critic)
#+END_SRC
Example call:
#+BEGIN_SRC lisp
 (critique
    (defun count-a (lst)
      (setq n 0)
      (dolist (x lst)
        (if (equal x 'a)
          (setq n (+ n 1))))
      n))
#+END_SRC

Example output:
#+BEGIN_EXAMPLE
----------------------------------------------------------------------

SETS-GLOBALS: GLOBALS!! Don't use global variables, i.e., N N
----------------------------------------------------------------------

DOLIST-SETF: Don't use SETQ inside DOLIST to accumulate values for N.
Use DO. Make N a DO variable and don't use SETQ etc at all.
----------------------------------------------------------------------

USE-EQL: Unless something special is going on, use EQL, not EQUAL.
----------------------------------------------------------------------

X-PLUS-1: Don't use (+ N 1), use (1+ N) for its value or (INCF N) to
change N, whichever is appropriate here.
----------------------------------------------------------------------
#+END_EXAMPLE

See the lisp-critic.lisp file for more information.
To load LISP-CRITIC to the REPL, Type (USE-PACKAGE :LISP-CRITIC).

To run the Lisp Critic on an entire file of code:
#+BEGIN_SRC lisp
(critique-file pathname)
#+END_SRC lisp

For example,
#+BEGIN_SRC lisp
(critique-file "~/riesbeck/cs325/chap9-exs.lisp")
#+END_SRC lisp

2 Systems

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

lisp-critic
ckr-tables

2.1 `lisp-critic`

LISP-CRITIC - A Lisp code critiquing package.

Maintainer

CHIBA Masaomi

Author

Chris Riesbeck

License

MIT Licence

Long Description

The Lisp Critic scans your code for instances of bad Lisp programming practice. The Lisp Critic works for all Lisp code, even if there are no test cases. Use the Critic with all your code, whether it’s an exercise, an assignment, or something you invented on your own. see more - https://courses.cs.northwestern.edu/325/exercises/critic.php#critic

Version

1.1

Dependency

ckr-tables (system).

Source

lisp-critic.asd.

Child Components

extend-match.lisp (file).
write-wrap.lisp (file).
lisp-critic.lisp (file).
lisp-rules.lisp (file).

2.2 `ckr-tables`

A utility library to ease the use of hash-tables

Maintainer: CHIBA Masaomi
Author: Chris Riesbeck
License: MIT License
Version: 1.0
Source: ckr-tables.asd.
Child Component: tables.lisp (file).

3 Files

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

Lisp

3.1.1 `lisp-critic/lisp-critic.asd`

Source: lisp-critic.asd.
Parent Component: lisp-critic (system).
ASDF Systems: lisp-critic.

3.1.2 `ckr-tables/ckr-tables.asd`

Source: ckr-tables.asd.
Parent Component: ckr-tables (system).
ASDF Systems: ckr-tables.

3.1.3 `lisp-critic/extend-match.lisp`

Source

lisp-critic.asd.

Parent Component

lisp-critic (system).

Packages

extend-match.

Public Interface

add-extension (function).
bind-variable (function).
instantiate-pattern (function).
pat-match (function).

Internals

*known-pattern-types* (special variable).
*pattern-functions* (special variable).
*pattern-types* (special variable).
add-binding (function).
binding-value (function).
binding-variable (function).
extend-bindings (function).
get-binding (function).
instantiate-cons (function).
instantiate-var (function).
match-and (function).
match-extension (function).
match-match (function).
match-not (function).
match-or (function).
match-predicate (function).
match-segment-extension (function).
match-segment-variable (function).
match-tail (function).
match-variable (function).
pat-extension-p (function).
(setf pat-function) (setf expander).
pat-function (function).
(setf pat-type) (setf expander).
pat-type (function).
pat-var-name (function).
pat-var-p (function).
prefix-p (function).
segment-pat-extension-p (function).
segment-pat-var-p (function).
single-pat-var-p (function).
var-prefix (constant).
var-type-name-p (function).

3.1.4 `lisp-critic/write-wrap.lisp`

Dependency

extend-match.lisp (file).

Source

lisp-critic.asd.

Parent Component

lisp-critic (system).

Packages

write-wrap.

Public Interface

write-wrap (function).

Internals

break-pos (function).
whitespace-p (function).

3.1.5 `lisp-critic/lisp-critic.lisp`

Dependency

write-wrap.lisp (file).

Source

lisp-critic.asd.

Parent Component

lisp-critic (system).

Packages

lisp-critic.

Public Interface

add-lisp-pattern (function).
apply-critique-rule (function).
clear-critique-db (function).
critique (macro).
critique-definition (function).
critique-file (function).
define-lisp-pattern (macro).
(setf get-pattern) (setf expander).
get-pattern (function).
get-pattern-names (function).
(setf get-response) (setf expander).
get-response (function).
lisp-critic-version (function).
remove-lisp-pattern (function).
response-args (function).
(setf response-args) (function).
response-format-string (function).
(setf response-format-string) (function).

Internals

*critic-version* (special variable).
*length-threshold* (special variable).
*output-width* (special variable).
*top-level* (special variable).
code-assigned-free-vars (function).
code-assigned-vars (function).
code-vars (function).
critique-blist (function).
(setf critique-blist) (function).
critique-code (function).
(setf critique-code) (function).
critique-match (function).
critique-name (function).
(setf critique-name) (function).
find-assigned-free-vars (function).
find-critiques (function).
find-match (function).
generate-critiques (function).
(setf get-assigned-vars-fn) (setf expander).
get-assigned-vars-fn (function).
get-badness-phrase (function).
get-free-vars (function).
get-length-badness (function).
(setf get-local-vars-fn) (setf expander).
get-local-vars-fn (function).
get-loop-vars (function).
get-var (function).
get-vars (function).
list-count (function).
loop-binder-p (function).
make-critiques (function).
make-response-string (function).
match-contains (function).
match-eql-pred (function).
match-name-contains (function).
match-name-ends-with (function).
match-optional (function).
match-repeat (function).
match-repeat-pat (function).
match-sets-free-vars (function).
match-too-long (function).
match-top-level (function).
new-critique (function).
new-response (function).
print-critique-response (function).
print-critique-responses (function).
print-separator (function).
remove-local-vars (function).
string-ends-with (function).
t1 (function).
t2 (function).
t3 (function).
t4 (function).

3.1.6 `lisp-critic/lisp-rules.lisp`

Dependency: lisp-critic.lisp (file).
Source: lisp-critic.asd.
Parent Component: lisp-critic (system).

3.1.7 `ckr-tables/tables.lisp`

Source

ckr-tables.asd.

Parent Component

ckr-tables (system).

Packages

tables.

Public Interface

clear-table (function).
deftable (macro).
in-table-p (function).
map-table (function).
remove-key (function).

Internals

*tables* (special variable).
get-table (function).
set-table (function).

4 Packages

Packages are listed by definition order.

write-wrap
extend-match
lisp-critic
tables

4.1 `write-wrap`

Source

write-wrap.lisp.

Use List

common-lisp.

Used By List

lisp-critic.

Public Interface

write-wrap (function).

Internals

break-pos (function).
whitespace-p (function).

4.2 `extend-match`

Source

extend-match.lisp.

Use List

common-lisp.

Used By List

lisp-critic.

Public Interface

add-extension (function).
bind-variable (function).
instantiate-pattern (function).
pat-match (function).

Internals

*known-pattern-types* (special variable).
*pattern-functions* (special variable).
*pattern-types* (special variable).
add-binding (function).
binding-value (function).
binding-variable (function).
extend-bindings (function).
get-binding (function).
instantiate-cons (function).
instantiate-var (function).
match-and (function).
match-extension (function).
match-match (function).
match-not (function).
match-or (function).
match-predicate (function).
match-segment-extension (function).
match-segment-variable (function).
match-tail (function).
match-variable (function).
pat-extension-p (function).
(setf pat-function) (setf expander).
pat-function (function).
(setf pat-type) (setf expander).
pat-type (function).
pat-var-name (function).
pat-var-p (function).
prefix-p (function).
segment-pat-extension-p (function).
segment-pat-var-p (function).
single-pat-var-p (function).
var-prefix (constant).
var-type-name-p (function).

4.3 `lisp-critic`

Source

lisp-critic.lisp.

Use List

common-lisp.
extend-match.
tables.
write-wrap.

Public Interface

add-lisp-pattern (function).
apply-critique-rule (function).
clear-critique-db (function).
critique (macro).
critique-definition (function).
critique-file (function).
define-lisp-pattern (macro).
(setf get-pattern) (setf expander).
get-pattern (function).
get-pattern-names (function).
(setf get-response) (setf expander).
get-response (function).
lisp-critic-version (function).
remove-lisp-pattern (function).
response-args (function).
(setf response-args) (function).
response-format-string (function).
(setf response-format-string) (function).

Internals

*critic-version* (special variable).
*length-threshold* (special variable).
*output-width* (special variable).
*top-level* (special variable).
code-assigned-free-vars (function).
code-assigned-vars (function).
code-vars (function).
copy-critique (function).
copy-response (function).
critique-blist (function).
(setf critique-blist) (function).
critique-code (function).
(setf critique-code) (function).
critique-match (function).
critique-name (function).
(setf critique-name) (function).
find-assigned-free-vars (function).
find-critiques (function).
find-match (function).
generate-critiques (function).
(setf get-assigned-vars-fn) (setf expander).
get-assigned-vars-fn (function).
get-badness-phrase (function).
get-free-vars (function).
get-length-badness (function).
(setf get-local-vars-fn) (setf expander).
get-local-vars-fn (function).
get-loop-vars (function).
get-var (function).
get-vars (function).
list-count (function).
loop-binder-p (function).
make-critiques (function).
make-response-string (function).
match-contains (function).
match-eql-pred (function).
match-name-contains (function).
match-name-ends-with (function).
match-optional (function).
match-repeat (function).
match-repeat-pat (function).
match-sets-free-vars (function).
match-too-long (function).
match-top-level (function).
new-critique (function).
new-response (function).
print-critique-response (function).
print-critique-responses (function).
print-separator (function).
remove-local-vars (function).
string-ends-with (function).
t1 (function).
t2 (function).
t3 (function).
t4 (function).

4.4 `tables`

Source

tables.lisp.

Use List

common-lisp.

Used By List

lisp-critic.

Public Interface

clear-table (function).
deftable (macro).
in-table-p (function).
map-table (function).
remove-key (function).

Internals

*tables* (special variable).
get-table (function).
set-table (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros
Setf expanders
Ordinary functions

5.1.1 Macros

Macro: critique (form) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Macro: define-lisp-pattern (name pattern format-string &rest args) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Macro: deftable (fn) ¶

Package: tables.
Source: tables.lisp.

5.1.2 Setf expanders

Setf Expander: (setf get-pattern) (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Reader: get-pattern (function).
Writer: t1 (function).

Setf Expander: (setf get-response) (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Reader: get-response (function).
Writer: t2 (function).

5.1.3 Ordinary functions

Function: add-extension (name type function) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: add-lisp-pattern (name pat format-string args) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: apply-critique-rule (name code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: bind-variable (name input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: clear-critique-db () ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: clear-table (table) ¶

Package: tables.
Source: tables.lisp.

Function: critique-definition (defn &optional out names) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: critique-file (file &optional out names) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-pattern (&optional key) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expander for this function: (setf get-pattern).

Function: get-pattern-names () ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-response (&optional key) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expander for this function: (setf get-response).

Function: in-table-p (key table) ¶

Package: tables.
Source: tables.lisp.

Function: instantiate-pattern (form blist) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: lisp-critic-version (&optional n) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: map-table (fn table) ¶

Package: tables.
Source: tables.lisp.

Function: pat-match (pat form &optional blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: remove-key (key table) ¶

Package: tables.
Source: tables.lisp.

Function: remove-lisp-pattern (name) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: response-args (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: (setf response-args) (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: response-format-string (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: (setf response-format-string) (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: write-wrap (stream strng width &optional indent first-indent) ¶

Package: write-wrap.
Source: write-wrap.lisp.

5.2 Internals

Constants
Special variables
Setf expanders
Ordinary functions

5.2.1 Constants

Constant: var-prefix ¶

Package: extend-match.
Source: extend-match.lisp.

5.2.2 Special variables

Special Variable: *critic-version* ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Special Variable: *known-pattern-types* ¶

Package: extend-match.
Source: extend-match.lisp.

Special Variable: *length-threshold* ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Special Variable: *output-width* ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Special Variable: *pattern-functions* ¶

Package: extend-match.
Source: extend-match.lisp.

Special Variable: *pattern-types* ¶

Package: extend-match.
Source: extend-match.lisp.

Special Variable: *tables* ¶

Table of DEFTABLE functions.

Package: tables.
Source: tables.lisp.

Special Variable: *top-level* ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

5.2.3 Setf expanders

Setf Expander: (setf get-assigned-vars-fn) (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Reader: get-assigned-vars-fn (function).
Writer: t4 (function).

Setf Expander: (setf get-local-vars-fn) (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Reader: get-local-vars-fn (function).
Writer: t3 (function).

5.2.4 Ordinary functions

Function: add-binding (name input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: binding-value (binding) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: binding-variable (binding) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: break-pos (strng start end width) ¶

Package: write-wrap.
Source: write-wrap.lisp.

Function: code-assigned-free-vars (code &optional env-stack) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: code-assigned-vars (code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: code-vars (code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: copy-critique (sequence) ¶

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package: lisp-critic.
Alias for: copy-seq.

Function: copy-response (sequence) ¶

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package: lisp-critic.
Alias for: copy-seq.

Function: critique-blist (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: (setf critique-blist) (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: critique-code (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: (setf critique-code) (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: critique-match (pat code blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: critique-name (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: (setf critique-name) (structure) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: extend-bindings (name input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: find-assigned-free-vars (code &optional env-stack) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: find-critiques (name pat code &optional blists *top-level*) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: find-match (pat input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: generate-critiques (code names) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-assigned-vars-fn (&optional key) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expander for this function: (setf get-assigned-vars-fn).

Function: get-badness-phrase (badness) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-binding (name bindings) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: get-free-vars (vars env-stack) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-length-badness (code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-local-vars-fn (&optional key) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expander for this function: (setf get-local-vars-fn).

Function: get-loop-vars (code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-table (name) ¶

Package: tables.
Source: tables.lisp.

Function: get-var (var-form) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: get-vars (vars-list) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: instantiate-cons (form blist) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: instantiate-var (form blist) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: list-count (form) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: loop-binder-p (x) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: make-critiques (name blists code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: make-response-string (name response blist) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-and (args input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-contains (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-eql-pred (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-extension (pat form blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-match (args blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-name-contains (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-name-ends-with (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-not (args input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-optional (args pats input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-or (args input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-predicate (args input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-repeat (args pats input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-repeat-pat (n pat pats input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-segment-extension (pats form blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-segment-variable (args pats input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-sets-free-vars (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-tail (tail name pats input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: match-too-long (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-top-level (args input blists) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: match-variable (args input blists) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: new-critique (name blist code) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: new-response (format-string args) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: pat-extension-p (pat) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: pat-function (name) ¶

Setf Expander: (setf pat-function) (name) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: pat-type (name) ¶

Setf Expander: (setf pat-type) (name) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: pat-var-name (pat) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: pat-var-p (form) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: prefix-p (seq1 seq2 &key test) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: print-critique-response (critique &optional stream) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: print-critique-responses (critiques &optional stream) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: print-separator (&optional stream ch) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: remove-local-vars (vars code-env) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: segment-pat-extension-p (pat) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: segment-pat-var-p (form) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: set-table (name table) ¶

Package: tables.
Source: tables.lisp.

Function: single-pat-var-p (form) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: string-ends-with (str substr) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.

Function: t1 (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expanders to this function: (setf get-pattern).

Function: t2 (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expanders to this function: (setf get-response).

Function: t3 (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expanders to this function: (setf get-local-vars-fn).

Function: t4 (arg1 &optional arg2) ¶

Package: lisp-critic.
Source: lisp-critic.lisp.
Setf expanders to this function: (setf get-assigned-vars-fn).

Function: var-type-name-p (pat) ¶

Package: extend-match.
Source: extend-match.lisp.

Function: whitespace-p (ch) ¶

Package: write-wrap.
Source: write-wrap.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

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

	Index Entry	Section

(
	`(setf critique-blist)`:	Private ordinary functions
	`(setf critique-code)`:	Private ordinary functions
	`(setf critique-name)`:	Private ordinary functions
	`(setf get-assigned-vars-fn)`:	Private setf expanders
	`(setf get-local-vars-fn)`:	Private setf expanders
	`(setf get-pattern)`:	Public setf expanders
	`(setf get-response)`:	Public setf expanders
	`(setf pat-function)`:	Private ordinary functions
	`(setf pat-type)`:	Private ordinary functions
	`(setf response-args)`:	Public ordinary functions
	`(setf response-format-string)`:	Public ordinary functions

A
	`add-binding`:	Private ordinary functions
	`add-extension`:	Public ordinary functions
	`add-lisp-pattern`:	Public ordinary functions
	`apply-critique-rule`:	Public ordinary functions

B
	`bind-variable`:	Public ordinary functions
	`binding-value`:	Private ordinary functions
	`binding-variable`:	Private ordinary functions
	`break-pos`:	Private ordinary functions

C
	`clear-critique-db`:	Public ordinary functions
	`clear-table`:	Public ordinary functions
	`code-assigned-free-vars`:	Private ordinary functions
	`code-assigned-vars`:	Private ordinary functions
	`code-vars`:	Private ordinary functions
	`copy-critique`:	Private ordinary functions
	`copy-response`:	Private ordinary functions
	`critique`:	Public macros
	`critique-blist`:	Private ordinary functions
	`critique-code`:	Private ordinary functions
	`critique-definition`:	Public ordinary functions
	`critique-file`:	Public ordinary functions
	`critique-match`:	Private ordinary functions
	`critique-name`:	Private ordinary functions

D
	`define-lisp-pattern`:	Public macros
	`deftable`:	Public macros

E
	`extend-bindings`:	Private ordinary functions

F
	`find-assigned-free-vars`:	Private ordinary functions
	`find-critiques`:	Private ordinary functions
	`find-match`:	Private ordinary functions
	`Function, (setf critique-blist)`:	Private ordinary functions
	`Function, (setf critique-code)`:	Private ordinary functions
	`Function, (setf critique-name)`:	Private ordinary functions
	`Function, (setf response-args)`:	Public ordinary functions
	`Function, (setf response-format-string)`:	Public ordinary functions
	`Function, add-binding`:	Private ordinary functions
	`Function, add-extension`:	Public ordinary functions
	`Function, add-lisp-pattern`:	Public ordinary functions
	`Function, apply-critique-rule`:	Public ordinary functions
	`Function, bind-variable`:	Public ordinary functions
	`Function, binding-value`:	Private ordinary functions
	`Function, binding-variable`:	Private ordinary functions
	`Function, break-pos`:	Private ordinary functions
	`Function, clear-critique-db`:	Public ordinary functions
	`Function, clear-table`:	Public ordinary functions
	`Function, code-assigned-free-vars`:	Private ordinary functions
	`Function, code-assigned-vars`:	Private ordinary functions
	`Function, code-vars`:	Private ordinary functions
	`Function, copy-critique`:	Private ordinary functions
	`Function, copy-response`:	Private ordinary functions
	`Function, critique-blist`:	Private ordinary functions
	`Function, critique-code`:	Private ordinary functions
	`Function, critique-definition`:	Public ordinary functions
	`Function, critique-file`:	Public ordinary functions
	`Function, critique-match`:	Private ordinary functions
	`Function, critique-name`:	Private ordinary functions
	`Function, extend-bindings`:	Private ordinary functions
	`Function, find-assigned-free-vars`:	Private ordinary functions
	`Function, find-critiques`:	Private ordinary functions
	`Function, find-match`:	Private ordinary functions
	`Function, generate-critiques`:	Private ordinary functions
	`Function, get-assigned-vars-fn`:	Private ordinary functions
	`Function, get-badness-phrase`:	Private ordinary functions
	`Function, get-binding`:	Private ordinary functions
	`Function, get-free-vars`:	Private ordinary functions
	`Function, get-length-badness`:	Private ordinary functions
	`Function, get-local-vars-fn`:	Private ordinary functions
	`Function, get-loop-vars`:	Private ordinary functions
	`Function, get-pattern`:	Public ordinary functions
	`Function, get-pattern-names`:	Public ordinary functions
	`Function, get-response`:	Public ordinary functions
	`Function, get-table`:	Private ordinary functions
	`Function, get-var`:	Private ordinary functions
	`Function, get-vars`:	Private ordinary functions
	`Function, in-table-p`:	Public ordinary functions
	`Function, instantiate-cons`:	Private ordinary functions
	`Function, instantiate-pattern`:	Public ordinary functions
	`Function, instantiate-var`:	Private ordinary functions
	`Function, lisp-critic-version`:	Public ordinary functions
	`Function, list-count`:	Private ordinary functions
	`Function, loop-binder-p`:	Private ordinary functions
	`Function, make-critiques`:	Private ordinary functions
	`Function, make-response-string`:	Private ordinary functions
	`Function, map-table`:	Public ordinary functions
	`Function, match-and`:	Private ordinary functions
	`Function, match-contains`:	Private ordinary functions
	`Function, match-eql-pred`:	Private ordinary functions
	`Function, match-extension`:	Private ordinary functions
	`Function, match-match`:	Private ordinary functions
	`Function, match-name-contains`:	Private ordinary functions
	`Function, match-name-ends-with`:	Private ordinary functions
	`Function, match-not`:	Private ordinary functions
	`Function, match-optional`:	Private ordinary functions
	`Function, match-or`:	Private ordinary functions
	`Function, match-predicate`:	Private ordinary functions
	`Function, match-repeat`:	Private ordinary functions
	`Function, match-repeat-pat`:	Private ordinary functions
	`Function, match-segment-extension`:	Private ordinary functions
	`Function, match-segment-variable`:	Private ordinary functions
	`Function, match-sets-free-vars`:	Private ordinary functions
	`Function, match-tail`:	Private ordinary functions
	`Function, match-too-long`:	Private ordinary functions
	`Function, match-top-level`:	Private ordinary functions
	`Function, match-variable`:	Private ordinary functions
	`Function, new-critique`:	Private ordinary functions
	`Function, new-response`:	Private ordinary functions
	`Function, pat-extension-p`:	Private ordinary functions
	`Function, pat-function`:	Private ordinary functions
	`Function, pat-match`:	Public ordinary functions
	`Function, pat-type`:	Private ordinary functions
	`Function, pat-var-name`:	Private ordinary functions
	`Function, pat-var-p`:	Private ordinary functions
	`Function, prefix-p`:	Private ordinary functions
	`Function, print-critique-response`:	Private ordinary functions
	`Function, print-critique-responses`:	Private ordinary functions
	`Function, print-separator`:	Private ordinary functions
	`Function, remove-key`:	Public ordinary functions
	`Function, remove-lisp-pattern`:	Public ordinary functions
	`Function, remove-local-vars`:	Private ordinary functions
	`Function, response-args`:	Public ordinary functions
	`Function, response-format-string`:	Public ordinary functions
	`Function, segment-pat-extension-p`:	Private ordinary functions
	`Function, segment-pat-var-p`:	Private ordinary functions
	`Function, set-table`:	Private ordinary functions
	`Function, single-pat-var-p`:	Private ordinary functions
	`Function, string-ends-with`:	Private ordinary functions
	`Function, t1`:	Private ordinary functions
	`Function, t2`:	Private ordinary functions
	`Function, t3`:	Private ordinary functions
	`Function, t4`:	Private ordinary functions
	`Function, var-type-name-p`:	Private ordinary functions
	`Function, whitespace-p`:	Private ordinary functions
	`Function, write-wrap`:	Public ordinary functions

G
	`generate-critiques`:	Private ordinary functions
	`get-assigned-vars-fn`:	Private ordinary functions
	`get-badness-phrase`:	Private ordinary functions
	`get-binding`:	Private ordinary functions
	`get-free-vars`:	Private ordinary functions
	`get-length-badness`:	Private ordinary functions
	`get-local-vars-fn`:	Private ordinary functions
	`get-loop-vars`:	Private ordinary functions
	`get-pattern`:	Public ordinary functions
	`get-pattern-names`:	Public ordinary functions
	`get-response`:	Public ordinary functions
	`get-table`:	Private ordinary functions
	`get-var`:	Private ordinary functions
	`get-vars`:	Private ordinary functions

I
	`in-table-p`:	Public ordinary functions
	`instantiate-cons`:	Private ordinary functions
	`instantiate-pattern`:	Public ordinary functions
	`instantiate-var`:	Private ordinary functions

L
	`lisp-critic-version`:	Public ordinary functions
	`list-count`:	Private ordinary functions
	`loop-binder-p`:	Private ordinary functions

M
	`Macro, critique`:	Public macros
	`Macro, define-lisp-pattern`:	Public macros
	`Macro, deftable`:	Public macros
	`make-critiques`:	Private ordinary functions
	`make-response-string`:	Private ordinary functions
	`map-table`:	Public ordinary functions
	`match-and`:	Private ordinary functions
	`match-contains`:	Private ordinary functions
	`match-eql-pred`:	Private ordinary functions
	`match-extension`:	Private ordinary functions
	`match-match`:	Private ordinary functions
	`match-name-contains`:	Private ordinary functions
	`match-name-ends-with`:	Private ordinary functions
	`match-not`:	Private ordinary functions
	`match-optional`:	Private ordinary functions
	`match-or`:	Private ordinary functions
	`match-predicate`:	Private ordinary functions
	`match-repeat`:	Private ordinary functions
	`match-repeat-pat`:	Private ordinary functions
	`match-segment-extension`:	Private ordinary functions
	`match-segment-variable`:	Private ordinary functions
	`match-sets-free-vars`:	Private ordinary functions
	`match-tail`:	Private ordinary functions
	`match-too-long`:	Private ordinary functions
	`match-top-level`:	Private ordinary functions
	`match-variable`:	Private ordinary functions

N
	`new-critique`:	Private ordinary functions
	`new-response`:	Private ordinary functions

P
	`pat-extension-p`:	Private ordinary functions
	`pat-function`:	Private ordinary functions
	`pat-match`:	Public ordinary functions
	`pat-type`:	Private ordinary functions
	`pat-var-name`:	Private ordinary functions
	`pat-var-p`:	Private ordinary functions
	`prefix-p`:	Private ordinary functions
	`print-critique-response`:	Private ordinary functions
	`print-critique-responses`:	Private ordinary functions
	`print-separator`:	Private ordinary functions

R
	`remove-key`:	Public ordinary functions
	`remove-lisp-pattern`:	Public ordinary functions
	`remove-local-vars`:	Private ordinary functions
	`response-args`:	Public ordinary functions
	`response-format-string`:	Public ordinary functions

S
	`segment-pat-extension-p`:	Private ordinary functions
	`segment-pat-var-p`:	Private ordinary functions
	`set-table`:	Private ordinary functions
	`Setf Expander, (setf get-assigned-vars-fn)`:	Private setf expanders
	`Setf Expander, (setf get-local-vars-fn)`:	Private setf expanders
	`Setf Expander, (setf get-pattern)`:	Public setf expanders
	`Setf Expander, (setf get-response)`:	Public setf expanders
	`Setf Expander, (setf pat-function)`:	Private ordinary functions
	`Setf Expander, (setf pat-type)`:	Private ordinary functions
	`single-pat-var-p`:	Private ordinary functions
	`string-ends-with`:	Private ordinary functions

T
	`t1`:	Private ordinary functions
	`t2`:	Private ordinary functions
	`t3`:	Private ordinary functions
	`t4`:	Private ordinary functions

V
	`var-type-name-p`:	Private ordinary functions

W
	`whitespace-p`:	Private ordinary functions
	`write-wrap`:	Public ordinary functions

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

A.3 Variables

Jump to:	* C S V

	Index Entry	Section

*
	`critic-version`:	Private special variables
	`known-pattern-types`:	Private special variables
	`length-threshold`:	Private special variables
	`output-width`:	Private special variables
	`pattern-functions`:	Private special variables
	`pattern-types`:	Private special variables
	`tables`:	Private special variables
	`top-level`:	Private special variables

C
	`Constant, var-prefix`:	Private constants

S
	`Special Variable, critic-version`:	Private special variables
	`Special Variable, known-pattern-types`:	Private special variables
	`Special Variable, length-threshold`:	Private special variables
	`Special Variable, output-width`:	Private special variables
	`Special Variable, pattern-functions`:	Private special variables
	`Special Variable, pattern-types`:	Private special variables
	`Special Variable, tables`:	Private special variables
	`Special Variable, top-level`:	Private special variables

V
	`var-prefix`:	Private constants

Jump to:	* C S V

A.4 Data types

Jump to:	C E F L P S T W

	Index Entry	Section

C
	`ckr-tables`:	The ckr-tables system
	`ckr-tables.asd`:	The ckr-tables/ckr-tables․asd file

E
	`extend-match`:	The extend-match package
	`extend-match.lisp`:	The lisp-critic/extend-match․lisp file

F
	`File, ckr-tables.asd`:	The ckr-tables/ckr-tables․asd file
	`File, extend-match.lisp`:	The lisp-critic/extend-match․lisp file
	`File, lisp-critic.asd`:	The lisp-critic/lisp-critic․asd file
	`File, lisp-critic.lisp`:	The lisp-critic/lisp-critic․lisp file
	`File, lisp-rules.lisp`:	The lisp-critic/lisp-rules․lisp file
	`File, tables.lisp`:	The ckr-tables/tables․lisp file
	`File, write-wrap.lisp`:	The lisp-critic/write-wrap․lisp file

L
	`lisp-critic`:	The lisp-critic system
	`lisp-critic`:	The lisp-critic package
	`lisp-critic.asd`:	The lisp-critic/lisp-critic․asd file
	`lisp-critic.lisp`:	The lisp-critic/lisp-critic․lisp file
	`lisp-rules.lisp`:	The lisp-critic/lisp-rules․lisp file

P
	`Package, extend-match`:	The extend-match package
	`Package, lisp-critic`:	The lisp-critic package
	`Package, tables`:	The tables package
	`Package, write-wrap`:	The write-wrap package

S
	`System, ckr-tables`:	The ckr-tables system
	`System, lisp-critic`:	The lisp-critic system

T
	`tables`:	The tables package
	`tables.lisp`:	The ckr-tables/tables․lisp file

W
	`write-wrap`:	The write-wrap package
	`write-wrap.lisp`:	The lisp-critic/write-wrap․lisp file

Jump to:	C E F L P S T W

The lisp-critic Reference Manual

The lisp-critic Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 lisp-critic

2.2 ckr-tables

3 Files

3.1 Lisp

3.1.1 lisp-critic/lisp-critic.asd

3.1.2 ckr-tables/ckr-tables.asd

3.1.3 lisp-critic/extend-match.lisp

3.1.4 lisp-critic/write-wrap.lisp

3.1.5 lisp-critic/lisp-critic.lisp

3.1.6 lisp-critic/lisp-rules.lisp

3.1.7 ckr-tables/tables.lisp

4 Packages

4.1 write-wrap

4.2 extend-match

4.3 lisp-critic

4.4 tables

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Setf expanders

5.1.3 Ordinary functions

5.2 Internals

5.2.1 Constants

5.2.2 Special variables

5.2.3 Setf expanders

5.2.4 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `lisp-critic`

2.2 `ckr-tables`

3.1.1 `lisp-critic/lisp-critic.asd`

3.1.2 `ckr-tables/ckr-tables.asd`

3.1.3 `lisp-critic/extend-match.lisp`

3.1.4 `lisp-critic/write-wrap.lisp`

3.1.5 `lisp-critic/lisp-critic.lisp`

3.1.6 `lisp-critic/lisp-rules.lisp`

3.1.7 `ckr-tables/tables.lisp`

4.1 `write-wrap`

4.2 `extend-match`

4.3 `lisp-critic`

4.4 `tables`