The lisp-critic Reference Manual

This is the lisp-critic Reference Manual, version 1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:29:16 2020 GMT+0.

1 Introduction

* LISP-CRITIC - A Lisp code critiquing package.

see http://cs.northwestern.edu/academics/courses/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.

2.1 `lisp-critic`

Maintainer

CHIBA Masaomi

Author

Chris Riesbeck

License

MIT Licence

Description

LISP-CRITIC - A Lisp code critiquing package.

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 - http://cs.northwestern.edu/academics/courses/325/exercises/critic.html#critic

Version

1.1

Dependency

ckr-tables (system)

Source

lisp-critic.asd (file)

Components

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

2.2 `ckr-tables`

Maintainer: CHIBA Masaomi
Author: Chris Riesbeck
License: MIT License
Description: A utility library to ease the use of hash-tables
Version: 1.0
Source: ckr-tables.asd (file)
Component: tables.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `lisp-critic.asd`

Location: lisp-critic.asd
Systems: lisp-critic (system)

3.1.2 `ckr-tables.asd`

Location: ckr-tables.asd
Systems: ckr-tables (system)

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

Parent

lisp-critic (system)

Location

extend-match.lisp

Packages

extend-match

Exported Definitions

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

Internal Definitions

*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)
pat-function (function)
(setf pat-function) (setf expander)
pat-type (function)
(setf pat-type) (setf expander)
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)

Parent

lisp-critic (system)

Location

write-wrap.lisp

Packages

write-wrap

Exported Definitions

write-wrap (function)

Internal Definitions

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

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

Dependency

write-wrap.lisp (file)

Parent

lisp-critic (system)

Location

lisp-critic.lisp

Packages

lisp-critic

Exported Definitions

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

Internal Definitions

*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)
get-assigned-vars-fn (function)
(setf get-assigned-vars-fn) (setf expander)
get-badness-phrase (function)
get-free-vars (function)
get-length-badness (function)
get-local-vars-fn (function)
(setf get-local-vars-fn) (setf expander)
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)
Parent: lisp-critic (system)
Location: lisp-rules.lisp

3.1.7 `ckr-tables/tables.lisp`

Parent

ckr-tables (system)

Location

tables.lisp

Packages

tables

Exported Definitions

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

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 `extend-match`

Source

extend-match.lisp (file)

Use List

common-lisp

Used By List

lisp-critic

Exported Definitions

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

Internal Definitions

*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)
pat-function (function)
(setf pat-function) (setf expander)
pat-type (function)
(setf pat-type) (setf expander)
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.2 `write-wrap`

Source

write-wrap.lisp (file)

Use List

common-lisp

Used By List

lisp-critic

Exported Definitions

write-wrap (function)

Internal Definitions

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

4.3 `lisp-critic`

Source

lisp-critic.lisp (file)

Use List

write-wrap
extend-match
tables
common-lisp

Exported Definitions

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

Internal Definitions

*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)
get-assigned-vars-fn (function)
(setf get-assigned-vars-fn) (setf expander)
get-badness-phrase (function)
get-free-vars (function)
get-length-badness (function)
get-local-vars-fn (function)
(setf get-local-vars-fn) (setf expander)
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 (file)

Use List

common-lisp

Used By List

lisp-critic

Exported Definitions

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

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: critique FORM

Package: lisp-critic
Source: lisp-critic.lisp (file)

Macro: define-lisp-pattern NAME PATTERN FORMAT-STRING &rest ARGS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Macro: deftable FN

Package: tables
Source: tables.lisp (file)

5.1.2 Functions

Function: add-extension NAME TYPE FUNCTION

Package: extend-match
Source: extend-match.lisp (file)

Function: add-lisp-pattern NAME PAT FORMAT-STRING ARGS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: apply-critique-rule NAME CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: bind-variable NAME INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: clear-critique-db ()

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: clear-table TABLE

Package: tables
Source: tables.lisp (file)

Function: critique-definition DEFN &optional OUT NAMES

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: critique-file FILE &optional OUT NAMES

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-pattern &optional KEY

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-pattern) (setf expander)

Setf Expander: (setf get-pattern) ARG1 &optional ARG2

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

Function: get-pattern-names ()

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-response &optional KEY

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-response) (setf expander)

Setf Expander: (setf get-response) ARG1 &optional ARG2

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

Function: in-table-p KEY TABLE

Package: tables
Source: tables.lisp (file)

Function: instantiate-pattern FORM BLIST

Package: extend-match
Source: extend-match.lisp (file)

Function: lisp-critic-version &optional N

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: map-table FN TABLE

Package: tables
Source: tables.lisp (file)

Function: pat-match PAT FORM &optional BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: remove-key KEY TABLE

Package: tables
Source: tables.lisp (file)

Function: remove-lisp-pattern NAME

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: response-args STRUCTURE

Function: (setf response-args) VALUE STRUCTURE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: response-format-string STRUCTURE

Function: (setf response-format-string) VALUE STRUCTURE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: write-wrap STREAM STRNG WIDTH &optional INDENT FIRST-INDENT

Package: write-wrap
Source: write-wrap.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: var-prefix

Package: extend-match
Source: extend-match.lisp (file)

5.2.2 Special variables

Special Variable: *critic-version*

Package: lisp-critic
Source: lisp-critic.lisp (file)

Special Variable: *known-pattern-types*

Package: extend-match
Source: extend-match.lisp (file)

Special Variable: *length-threshold*

Package: lisp-critic
Source: lisp-critic.lisp (file)

Special Variable: *output-width*

Package: lisp-critic
Source: lisp-critic.lisp (file)

Special Variable: *pattern-functions*

Package: extend-match
Source: extend-match.lisp (file)

Special Variable: *pattern-types*

Package: extend-match
Source: extend-match.lisp (file)

Special Variable: *tables*

Table of DEFTABLE functions.

Package: tables
Source: tables.lisp (file)

Special Variable: *top-level*

Package: lisp-critic
Source: lisp-critic.lisp (file)

5.2.3 Functions

Function: add-binding NAME INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: binding-value BINDING

Package: extend-match
Source: extend-match.lisp (file)

Function: binding-variable BINDING

Package: extend-match
Source: extend-match.lisp (file)

Function: break-pos STRNG START END WIDTH

Package: write-wrap
Source: write-wrap.lisp (file)

Function: code-assigned-free-vars CODE &optional ENV-STACK

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: code-assigned-vars CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: code-vars CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: copy-critique SEQUENCE

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

Package: lisp-critic
Source: SYS:SRC;CODE;SEQ.LISP (not found)

Function: copy-response SEQUENCE

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

Package: lisp-critic
Source: SYS:SRC;CODE;SEQ.LISP (not found)

Function: critique-blist STRUCTURE

Function: (setf critique-blist) VALUE STRUCTURE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: critique-code STRUCTURE

Function: (setf critique-code) VALUE STRUCTURE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: critique-match PAT CODE BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: critique-name STRUCTURE

Function: (setf critique-name) VALUE STRUCTURE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: extend-bindings NAME INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: find-assigned-free-vars CODE &optional ENV-STACK

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: find-critiques NAME PAT CODE &optional BLISTS *TOP-LEVEL*

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: find-match PAT INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: generate-critiques CODE NAMES

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-assigned-vars-fn &optional KEY

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-assigned-vars-fn) (setf expander)

Setf Expander: (setf get-assigned-vars-fn) ARG1 &optional ARG2

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

Function: get-badness-phrase BADNESS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-binding NAME BINDINGS

Package: extend-match
Source: extend-match.lisp (file)

Function: get-free-vars VARS ENV-STACK

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-length-badness CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-local-vars-fn &optional KEY

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-local-vars-fn) (setf expander)

Setf Expander: (setf get-local-vars-fn) ARG1 &optional ARG2

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

Function: get-loop-vars CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-table NAME

Package: tables
Source: tables.lisp (file)

Function: get-var VAR-FORM

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: get-vars VARS-LIST

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: instantiate-cons FORM BLIST

Package: extend-match
Source: extend-match.lisp (file)

Function: instantiate-var FORM BLIST

Package: extend-match
Source: extend-match.lisp (file)

Function: list-count FORM

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: loop-binder-p X

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: make-critiques NAME BLISTS CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: make-response-string NAME RESPONSE BLIST

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-and ARGS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-contains ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-eql-pred ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-extension PAT FORM BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-match ARGS BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-name-contains ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-name-ends-with ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-not ARGS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-optional ARGS PATS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-or ARGS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-predicate ARGS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-repeat ARGS PATS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-repeat-pat N PAT PATS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-segment-extension PATS FORM BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-segment-variable ARGS PATS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-sets-free-vars ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-tail TAIL NAME PATS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: match-too-long ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-top-level ARGS INPUT BLISTS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: match-variable ARGS INPUT BLISTS

Package: extend-match
Source: extend-match.lisp (file)

Function: new-critique NAME BLIST CODE

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: new-response FORMAT-STRING ARGS

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: pat-extension-p PAT

Package: extend-match
Source: extend-match.lisp (file)

Function: pat-function NAME

Package: extend-match
Source: extend-match.lisp (file)
Setf Expander: (setf pat-function) (setf expander)

Setf Expander: (setf pat-function) NAME

Package: extend-match
Source: extend-match.lisp (file)
Reader: pat-function (function)

Function: pat-type NAME

Package: extend-match
Source: extend-match.lisp (file)
Setf Expander: (setf pat-type) (setf expander)

Setf Expander: (setf pat-type) NAME

Package: extend-match
Source: extend-match.lisp (file)
Reader: pat-type (function)

Function: pat-var-name PAT

Package: extend-match
Source: extend-match.lisp (file)

Function: pat-var-p FORM

Package: extend-match
Source: extend-match.lisp (file)

Function: prefix-p SEQ1 SEQ2 &key TEST

Package: extend-match
Source: extend-match.lisp (file)

Function: print-critique-response CRITIQUE &optional STREAM

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: print-critique-responses CRITIQUES &optional STREAM

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: print-separator &optional STREAM CH

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: remove-local-vars VARS CODE-ENV

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: segment-pat-extension-p PAT

Package: extend-match
Source: extend-match.lisp (file)

Function: segment-pat-var-p FORM

Package: extend-match
Source: extend-match.lisp (file)

Function: set-table NAME TABLE

Package: tables
Source: tables.lisp (file)

Function: single-pat-var-p FORM

Package: extend-match
Source: extend-match.lisp (file)

Function: string-ends-with STR SUBSTR

Package: lisp-critic
Source: lisp-critic.lisp (file)

Function: t1 ARG1 &optional ARG2

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-pattern) (setf expander)

Function: t2 ARG1 &optional ARG2

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-response) (setf expander)

Function: t3 ARG1 &optional ARG2

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-local-vars-fn) (setf expander)

Function: t4 ARG1 &optional ARG2

Package: lisp-critic
Source: lisp-critic.lisp (file)
Setf Expander: (setf get-assigned-vars-fn) (setf expander)

Function: var-type-name-p PAT

Package: extend-match
Source: extend-match.lisp (file)

Function: whitespace-p CH

Package: write-wrap
Source: write-wrap.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L

	Index Entry	Section

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

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

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

Jump to:	C F L

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)`:	Internal functions
	`(setf critique-code)`:	Internal functions
	`(setf critique-name)`:	Internal functions
	`(setf get-assigned-vars-fn)`:	Internal functions
	`(setf get-local-vars-fn)`:	Internal functions
	`(setf get-pattern)`:	Exported functions
	`(setf get-response)`:	Exported functions
	`(setf pat-function)`:	Internal functions
	`(setf pat-type)`:	Internal functions
	`(setf response-args)`:	Exported functions
	`(setf response-format-string)`:	Exported functions

A
	`add-binding`:	Internal functions
	`add-extension`:	Exported functions
	`add-lisp-pattern`:	Exported functions
	`apply-critique-rule`:	Exported functions

B
	`bind-variable`:	Exported functions
	`binding-value`:	Internal functions
	`binding-variable`:	Internal functions
	`break-pos`:	Internal functions

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

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

E
	`extend-bindings`:	Internal functions

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

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

I
	`in-table-p`:	Exported functions
	`instantiate-cons`:	Internal functions
	`instantiate-pattern`:	Exported functions
	`instantiate-var`:	Internal functions

L
	`lisp-critic-version`:	Exported functions
	`list-count`:	Internal functions
	`loop-binder-p`:	Internal functions

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

N
	`new-critique`:	Internal functions
	`new-response`:	Internal functions

P
	`pat-extension-p`:	Internal functions
	`pat-function`:	Internal functions
	`pat-match`:	Exported functions
	`pat-type`:	Internal functions
	`pat-var-name`:	Internal functions
	`pat-var-p`:	Internal functions
	`prefix-p`:	Internal functions
	`print-critique-response`:	Internal functions
	`print-critique-responses`:	Internal functions
	`print-separator`:	Internal functions

R
	`remove-key`:	Exported functions
	`remove-lisp-pattern`:	Exported functions
	`remove-local-vars`:	Internal functions
	`response-args`:	Exported functions
	`response-format-string`:	Exported functions

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

T
	`t1`:	Internal functions
	`t2`:	Internal functions
	`t3`:	Internal functions
	`t4`:	Internal functions

V
	`var-type-name-p`:	Internal functions

W
	`whitespace-p`:	Internal functions
	`write-wrap`:	Exported 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`:	Internal special variables
	`known-pattern-types`:	Internal special variables
	`length-threshold`:	Internal special variables
	`output-width`:	Internal special variables
	`pattern-functions`:	Internal special variables
	`pattern-types`:	Internal special variables
	`tables`:	Internal special variables
	`top-level`:	Internal special variables

C
	`Constant, var-prefix`:	Internal constants

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

V
	`var-prefix`:	Internal constants

Jump to:	* C S V

A.4 Data types

Jump to:	C E L P S T W

	Index Entry	Section

C
	`ckr-tables`:	The ckr-tables system

E
	`extend-match`:	The extend-match package

L
	`lisp-critic`:	The lisp-critic system
	`lisp-critic`:	The lisp-critic package

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

W
	`write-wrap`:	The write-wrap package

Jump to:	C E L P S T W

• Introduction		What lisp-critic is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The lisp-critic.asd file
• The ckr-tables.asd file
• The lisp-critic/extend-match.lisp file
• The lisp-critic/write-wrap.lisp file
• The lisp-critic/lisp-critic.lisp file
• The lisp-critic/lisp-rules.lisp file
• The ckr-tables/tables.lisp file

• The extend-match package
• The write-wrap package
• The lisp-critic package
• The tables package

• Concept index
• Function index
• Variable index
• Data type index

• Internal constants
• Internal special variables
• Internal functions

The lisp-critic Reference Manual

Table of Contents

The lisp-critic Reference Manual

1 Introduction

2 Systems

2.1 lisp-critic

2.2 ckr-tables

3 Files

3.1 Lisp

3.1.1 lisp-critic.asd

3.1.2 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 extend-match

4.2 write-wrap

4.3 lisp-critic

4.4 tables

5 Definitions

5.1 Exported definitions

5.1.1 Macros

5.1.2 Functions

5.2 Internal definitions

5.2.1 Constants

5.2.2 Special variables

5.2.3 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.asd`

3.1.2 `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 `extend-match`

4.2 `write-wrap`

4.3 `lisp-critic`

4.4 `tables`