Exceptions for comments
[wolf] / src / main / checker.lisp
1 (in-package #:style-checker)
2
3 ; Rules
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
10 ; * No tabs
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
19 ;
20 ; Exceptions
21 ; * comments
22 ; - multiline strings
23
24 ; Some thoughts
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
28
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)))
32
33 (defvar *state* nil)
34 (defvar *line-no* nil)
35 (defvar *col-no* nil)
36 (defvar *evaluators* nil)
37 (defvar *form-stack* nil)
38 (defvar *form-ended-on-same-line* nil)
39
40 (eval-when (:compile-toplevel :load-toplevel :execute)
41  (defparameter *possible-states*
42   '(:begin ; start of file
43     :normal ; normal processing
44     :beginning-of-line
45     :beginning-of-line-with-separator ; empty space in there
46     :beginning-of-symbols
47     :beginning-of-symbols-with-separator
48     :comment-with-separator ; weird edge case for pre-function comments
49     :beginning-of-line-with-comment-and-separator ; weird edge case part 2
50     :first-symbol ; first symbol of form/line
51     :all ; matches everything
52    )))
53
54 (defun set-state (state)
55  (when (not (find state *possible-states*))
56   (error "Can't set state to ~A" state))
57  (setf *state* state)
58  nil)
59
60 (defmacro defevaluator (state match func)
61  (when (not (find state *possible-states*)) (error "~A is an invalid state" state))
62  (let
63   ((scanner (gensym)))
64  `(let
65    ((,scanner (when (stringp ,match) (cl-ppcre:create-scanner ,match))))
66    (pushnew
67     (list
68      (lambda (state text)
69       (and
70        (or (eql :all ,state) (eql ,state state))
71        (or
72         (and (symbolp text) (eql text ,match))
73         (and ,scanner
74              (stringp text)
75              (multiple-value-bind (start end) (cl-ppcre:scan ,scanner text)
76               (and start end (= 0 start)))))))
77      (lambda (text) (second (multiple-value-list (cl-ppcre:scan ,scanner text))))
78      ,func)
79     *evaluators*))))
80
81 (defun evaluate (text)
82  (if (string= "" text)
83      (let*
84       ((evaluator (find-if (lambda (f) (funcall f *state* :eof)) *evaluators* :from-end t :key #'car))
85        (problem (when evaluator (funcall (third evaluator)))))
86       (when problem (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*))))
87      (let
88       ((evaluator (find-if (lambda (f) (funcall f *state* text)) *evaluators* :from-end t :key #'car)))
89       (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*)))
90       (let
91        ((problem (funcall (third evaluator))))
92        (when problem
93         (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*)))
94        (let
95         ((length-of-match (funcall (cadr evaluator) text)))
96         (incf *col-no* length-of-match)
97         (when (< 120 *col-no*) (error (make-condition 'check-failure :msg "Line longer than 120 characters" :line-no *line-no* :col-no 0)))
98         (evaluate (subseq text length-of-match)))))))
99
100 (defun slurp-file (filename &key (element-type 'character) (sequence-type 'string))
101  (with-open-file (str filename :element-type element-type)
102   (let ((seq (make-sequence sequence-type (file-length str)))) (read-sequence seq str) seq)))
103
104 (defun check-file (file)
105  (set-state :begin)
106  (setf *line-no* 0)
107  (setf *col-no* 0)
108  (setf *form-stack* nil)
109  (setf *form-ended-on-same-line* nil)
110  (format t "~%File: ~A~%" file)
111  (handler-case
112   (progn (evaluate (slurp-file file)) t)
113   (check-failure (cf)
114    (format t " - Had an error: ~S at ~A:~A~%" (check-failure-msg cf) (check-failure-line-no cf) (check-failure-col-no cf))
115    nil)))
116
117 (defun check-directory (dir)
118  (every #'identity (mapcar #'check-file (directory (format nil "~A/**/*.lisp" dir)))))
119
120 ; These are in reverse order
121 (progn
122  (setf *evaluators* nil)
123  (defevaluator :beginning-of-symbols " *;[^\\n]*"
124   (lambda () (set-state :normal)))
125  (defevaluator :beginning-of-symbols-with-separator " *;[^\\n]*"
126   (lambda () (set-state :comment-with-separator)))
127  (defevaluator :normal " *;[^\\n]*"
128   (lambda () (set-state :normal)))
129  (defevaluator :normal "\\("
130   (lambda ()
131    (push (list *line-no* *col-no*) *form-stack*)
132    (set-state :first-symbol)))
133  (defevaluator :first-symbol "\\("
134   (lambda ()
135    (cond
136     ((and (not *form-stack*) (not (zerop *col-no*))) "Top level forms must begin on first column")
137     ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
138      "All form elements must be indented equally")
139     (t
140      (push (list *line-no* *col-no*) *form-stack*)
141      (set-state :first-symbol)))))
142  (defevaluator :all "\\t" (constantly "Must not use tabs"))
143  (defevaluator :begin "\\(in-package[^\\)]*\\)" (lambda () (set-state :normal)))
144  (defevaluator :beginning-of-line-with-separator :eof (constantly "Must not end with empty line"))
145  (defevaluator :beginning-of-line-with-separator "\\n" (constantly "Must not have two empty lines in a row"))
146  (defevaluator :begin ".*" (constantly "Must begin with in-package form"))
147  (defevaluator :all "\\( *in-package " (constantly "Only one in-package per file"))
148  (defevaluator :normal "\\n"
149   (lambda ()
150    (incf *line-no*)
151    (setf *col-no* -1)
152    (set-state :beginning-of-line)))
153  (defevaluator :comment-with-separator "\\n"
154   (lambda ()
155    (incf *line-no*)
156    (setf *col-no* -1)
157    (set-state :beginning-of-line-with-comment-and-separator)
158    nil))
159  (defevaluator :normal " +\\n" (constantly "No whitespace at end of line"))
160  (defevaluator :beginning-of-line " *" (lambda () (set-state :beginning-of-symbols)))
161  (defevaluator :beginning-of-line-with-separator " *" (lambda () (set-state :beginning-of-symbols-with-separator)))
162  (defevaluator :beginning-of-line-with-comment-and-separator "\\n"
163   (lambda ()
164    (progn
165     (incf *line-no*)
166     (setf *col-no* -1)
167     (set-state :beginning-of-line-with-separator))))
168  (defevaluator :beginning-of-line-with-comment-and-separator " *" (lambda () (set-state :beginning-of-symbols-with-separator)))
169  (defevaluator :beginning-of-symbols "\\n"
170   (lambda ()
171    (if
172     (< 0 *col-no*)
173     "No whitespace only lines"
174     (progn
175      (incf *line-no*)
176      (setf *col-no* -1)
177      (set-state :beginning-of-line-with-separator)))))
178  (defevaluator :beginning-of-symbols "\\)" (constantly "No hanging close parens"))
179  (defevaluator :beginning-of-symbols-with-separator "\\)" (constantly "No hanging close parens"))
180  (defevaluator :beginning-of-symbols ""
181   (lambda ()
182    (if
183     (and (not *form-stack*) (not *form-ended-on-same-line*))
184     "Multiline top level forms must be separated by a space"
185     (set-state :first-symbol))))
186  (defevaluator :beginning-of-symbols-with-separator ""
187   (lambda ()
188    (set-state :first-symbol)))
189  (defevaluator :normal "\\)"
190   (lambda ()
191    (let
192     ((form (pop *form-stack*)))
193     (cond
194      ((not form) "Unmatched ending paren")
195      ((< 50 (- *line-no* (car form))) "Forms can't be over 50 lines long")
196      (t (setf *form-ended-on-same-line* (= *line-no* (car form))) nil)))))
197  (defevaluator :normal "::" (constantly "No internal symbols from other packages"))
198  (defevaluator :first-symbol "\\n" (constantly "No new line after opening form"))
199  (defevaluator :first-symbol " " (constantly "No space after opening parens"))
200  (defevaluator :first-symbol ""
201   (lambda ()
202    ;(format t "HMMM: ~A ~A ~A~%" *form-stack* *line-no* *col-no*)
203    (cond
204     ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
205      "All form elements must be indented equally")
206     (t (set-state :normal)))))
207  (defevaluator :normal "  " (constantly "Only one space between items of a form"))
208  (defevaluator :normal "." (constantly nil)))