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