1 (in-package #:style-checker)
4 ; * Elements on new line in each form must be indented the same amount
5 ; * No space/newline after open parens
6 ; * No form longer than 50 lines
7 ; * Top level multiline forms must be separated by exactly one space
8 ; * No line longer than 120 characters
9 ; * No use of unexported symbols in other packages
11 ; * Only one space between elements in a form on a single line
12 ; * in-package must be first line in file unless file is package.lisp
13 ; * No whitespace at end of line
14 ; * No lines that are only whitespace
15 ; * No empty lines at end of file
16 ; * Never have two empty lines in a row
17 ; * Only one in-package per file
18 ; * No hanging close parens
25 ; - form starting reader macros will have to be hand added to this code
26 ; - exceptions will eventually arise, and the rule file will have to be changed
27 ; - the proper formatting of "loop" is weird
29 (define-condition check-failure nil ((msg :initarg :msg :reader check-failure-msg)
30 (line-no :initarg :line-no :reader check-failure-line-no)
31 (col-no :initarg :col-no :reader check-failure-col-no)))
34 (defvar *line-no* nil)
36 (defvar *evaluators* nil)
37 (defvar *form-stack* nil)
38 (defvar *form-ended-on-same-line* nil)
40 (eval-when (:compile-toplevel :load-toplevel :execute)
41 (defparameter *possible-states*
42 '(:begin ; start of file
43 :normal ; normal processing
45 :beginning-of-line-with-separator ; empty space in there
47 :beginning-of-symbols-with-separator
48 :first-symbol ; first symbol of form/line
49 :all ; matches everything
52 (defun set-state (state)
53 (when (not (find state *possible-states*))
54 (error "Can't set state to ~A" state))
58 (defmacro defevaluator (state match func)
59 (when (not (find state *possible-states*)) (error "~A is an invalid state" state))
63 ((,scanner (when (stringp ,match) (cl-ppcre:create-scanner ,match))))
68 (or (eql :all ,state) (eql ,state state))
70 (and (symbolp text) (eql text ,match))
73 (multiple-value-bind (start end) (cl-ppcre:scan ,scanner text)
74 (and start end (= 0 start)))))))
75 (lambda (text) (second (multiple-value-list (cl-ppcre:scan ,scanner text))))
79 (defun evaluate (text)
82 ((evaluator (find-if (lambda (f) (funcall f *state* :eof)) *evaluators* :from-end t :key #'car))
83 (problem (when evaluator (funcall (third evaluator)))))
84 (when problem (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*))))
86 ((evaluator (find-if (lambda (f) (funcall f *state* text)) *evaluators* :from-end t :key #'car)))
87 (when (not evaluator) (error (make-condition 'check-failure :msg (format nil "Can't check in state ~S: ~S..." *state* (subseq text 0 (min (length text) 10))) :line-no *line-no* :col-no *col-no*)))
89 ((problem (funcall (third evaluator))))
91 (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*)))
93 ((length-of-match (funcall (cadr evaluator) text)))
94 (incf *col-no* length-of-match)
95 (when (< 120 *col-no*) (error (make-condition 'check-failure :msg "Line longer than 120 characters" :line-no *line-no* :col-no 0)))
96 (evaluate (subseq text length-of-match)))))))
98 (defun slurp-file (filename &key (element-type 'character) (sequence-type 'string))
99 (with-open-file (str filename :element-type element-type)
100 (let ((seq (make-sequence sequence-type (file-length str)))) (read-sequence seq str) seq)))
102 (defun check-file (file)
106 (setf *form-stack* nil)
107 (setf *form-ended-on-same-line* nil)
108 (format t "~%File: ~A~%" file)
110 (progn (evaluate (slurp-file file)) t)
112 (format t " - Had an error: ~S at ~A:~A~%" (check-failure-msg cf) (check-failure-line-no cf) (check-failure-col-no cf))
115 (defun check-directory (dir)
116 (every #'identity (mapcar #'check-file (directory (format nil "~A/**/*.lisp" dir)))))
118 ; These are in reverse order
120 (setf *evaluators* nil)
121 (defevaluator :normal "\\("
123 (push (list *line-no* *col-no*) *form-stack*)
124 (set-state :first-symbol)))
125 (defevaluator :first-symbol "\\("
128 ((and (not *form-stack*) (not (zerop *col-no*))) "Top level forms must begin on first column")
129 ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
130 "All form elements must be indented equally")
132 (push (list *line-no* *col-no*) *form-stack*)
133 (set-state :first-symbol)))))
134 (defevaluator :all "\\t" (constantly "Must not use tabs"))
135 (defevaluator :begin "\\(in-package[^\\)]*\\)" (lambda () (set-state :normal)))
136 (defevaluator :beginning-of-line-with-separator :eof (constantly "Must not end with empty line"))
137 (defevaluator :beginning-of-line-with-separator "\\n" (constantly "Must not have two empty lines in a row"))
138 (defevaluator :begin ".*" (constantly "Must begin with in-package form"))
139 (defevaluator :all "\\( *in-package " (constantly "Only one in-package per file"))
140 (defevaluator :normal "\\n"
144 (set-state :beginning-of-line)))
145 (defevaluator :normal " +\\n" (constantly "No whitespace at end of line"))
146 (defevaluator :beginning-of-line " *" (lambda () (set-state :beginning-of-symbols)))
147 (defevaluator :beginning-of-line-with-separator " *" (lambda () (set-state :beginning-of-symbols-with-separator)))
148 (defevaluator :beginning-of-symbols "\\n"
152 "No whitespace only lines"
156 (set-state :beginning-of-line-with-separator)))))
157 (defevaluator :beginning-of-symbols "\\)" (constantly "No hanging close parens"))
158 (defevaluator :beginning-of-symbols-with-separator "\\)" (constantly "No hanging close parens"))
159 (defevaluator :beginning-of-symbols ""
162 (and (not *form-stack*) (not *form-ended-on-same-line*))
163 "Multiline top level forms must be separated by a space"
164 (set-state :first-symbol))))
165 (defevaluator :beginning-of-symbols-with-separator ""
167 (set-state :first-symbol)))
168 (defevaluator :normal "\\)"
171 ((form (pop *form-stack*)))
173 ((not form) "Unmatched ending paren")
174 ((< 50 (- *line-no* (car form))) "Forms can't be over 50 lines long")
175 (t (setf *form-ended-on-same-line* (= *line-no* (car form))) nil)))))
176 (defevaluator :normal "::" (constantly "No internal symbols from other packages"))
177 (defevaluator :first-symbol "\\n" (constantly "No new line after opening form"))
178 (defevaluator :first-symbol " " (constantly "No space after opening parens"))
179 (defevaluator :first-symbol ""
181 ;(format t "HMMM: ~A ~A ~A~%" *form-stack* *line-no* *col-no*)
183 ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
184 "All form elements must be indented equally")
185 (t (set-state :normal)))))
186 (defevaluator :normal " " (constantly "Only one space between items of a form"))
187 (defevaluator :normal "." (constantly nil)))