(in-package #:style-checker)
; Rules
-; - Elements in each form must be indented the same amount
+; * Elements on new line in each form must be indented the same amount
+; * No space/newline after open parens
; * No form longer than 50 lines
-; - Top level multiline forms must be separated by exactly one space
+; * Top level multiline forms must be separated by exactly one space
; * No line longer than 120 characters
-; - No use of unexported symbols in other packages
+; * No use of unexported symbols in other packages
; * No tabs
-; - Only one space between elements in a form on a single line
+; * Only one space between elements in a form on a single line
; * in-package must be first line in file unless file is package.lisp
; * No whitespace at end of line
; * No lines that are only whitespace
-; - No empty lines at end of file
+; * No empty lines at end of file
+; * Never have two empty lines in a row
; * Only one in-package per file
+; * No hanging close parens
;
+; Exceptions
+; * comments
+; * multiline strings
+
; Some thoughts
; - form starting reader macros will have to be hand added to this code
; - exceptions will eventually arise, and the rule file will have to be changed
(defvar *col-no* nil)
(defvar *evaluators* nil)
(defvar *form-stack* nil)
+(defvar *form-ended-on-same-line* nil)
(eval-when (:compile-toplevel :load-toplevel :execute)
(defparameter *possible-states*
'(:begin ; start of file
:normal ; normal processing
:beginning-of-line
+ :beginning-of-line-with-separator ; empty space in there
:beginning-of-symbols
+ :beginning-of-symbols-with-separator
+ :comment-with-separator ; weird edge case for pre-function comments
+ :beginning-of-line-with-comment-and-separator ; weird edge case part 2
+ :first-symbol ; first symbol of form/line
:all ; matches everything
+ :in-string
)))
-
(defun set-state (state)
(when (not (find state *possible-states*))
(error "Can't set state to ~A" state))
(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*)))
(let
((problem (funcall (third evaluator))))
- (when problem (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*)))
+ (when problem
+ (error (make-condition 'check-failure :msg problem :line-no *line-no* :col-no *col-no*)))
(let
((length-of-match (funcall (cadr evaluator) text)))
(incf *col-no* length-of-match)
(set-state :begin)
(setf *line-no* 0)
(setf *col-no* 0)
+ (setf *form-stack* nil)
+ (setf *form-ended-on-same-line* nil)
(format t "~%File: ~A~%" file)
(handler-case
(progn (evaluate (slurp-file file)) t)
; These are in reverse order
(progn
(setf *evaluators* nil)
- (defevaluator :all "\\t"
- (constantly "Must not use tabs"))
- (defevaluator :begin "\\(in-package[^\\)]*\\)"
+ (defevaluator :beginning-of-symbols " *;[^\\n]*"
+ (lambda () (set-state :normal)))
+ (defevaluator :beginning-of-symbols-with-separator " *;[^\\n]*"
+ (lambda () (set-state :comment-with-separator)))
+ (defevaluator :normal " *;[^\\n]*"
+ (lambda () (set-state :normal)))
+ (defevaluator :normal "\\("
(lambda ()
- (set-state :normal) nil))
- (defevaluator :begin ".*"
- (constantly "Must begin with in-package form"))
- (defevaluator :normal "\\( *in-package "
- (constantly "Only one in-package per file"))
+ (push (list *line-no* *col-no*) *form-stack*)
+ (set-state :first-symbol)))
+ (defevaluator :first-symbol "\\("
+ (lambda ()
+ (cond
+ ((and (not *form-stack*) (not (zerop *col-no*))) "Top level forms must begin on first column")
+ ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
+ "All form elements must be indented equally")
+ (t
+ (push (list *line-no* *col-no*) *form-stack*)
+ (set-state :first-symbol)))))
+ (defevaluator :all "\\t" (constantly "Must not use tabs"))
+ (defevaluator :begin "\\(in-package[^\\)]*\\)" (lambda () (set-state :normal)))
+ (defevaluator :beginning-of-line-with-separator :eof (constantly "Must not end with empty line"))
+ (defevaluator :beginning-of-line-with-separator "\\n" (constantly "Must not have two empty lines in a row"))
+ (defevaluator :begin ".*" (constantly "Must begin with in-package form"))
+ (defevaluator :all "\\( *in-package " (constantly "Only one in-package per file"))
(defevaluator :normal "\\n"
(lambda ()
- (set-state :beginning-of-line)
(incf *line-no*)
(setf *col-no* -1)
- nil))
- (defevaluator :normal " +\\n"
+ (set-state :beginning-of-line)))
+ (defevaluator :comment-with-separator "\\n"
(lambda ()
- "No whitespace at end of line"))
- (defevaluator :beginning-of-line " *"
- (lambda ()
- (set-state :beginning-of-symbols)
+ (incf *line-no*)
+ (setf *col-no* -1)
+ (set-state :beginning-of-line-with-comment-and-separator)
nil))
+ (defevaluator :normal " +\\n" (constantly "No whitespace at end of line"))
+ (defevaluator :beginning-of-line " *" (lambda () (set-state :beginning-of-symbols)))
+ (defevaluator :beginning-of-line-with-separator " *" (lambda () (set-state :beginning-of-symbols-with-separator)))
+ (defevaluator :beginning-of-line-with-comment-and-separator "\\n"
+ (lambda ()
+ (progn
+ (incf *line-no*)
+ (setf *col-no* -1)
+ (set-state :beginning-of-line-with-separator))))
+ (defevaluator :beginning-of-line-with-comment-and-separator " *" (lambda () (set-state :beginning-of-symbols-with-separator)))
(defevaluator :beginning-of-symbols "\\n"
- (lambda () (when (< 0 *col-no*) "No whitespace only lines")))
+ (lambda ()
+ (if
+ (< 0 *col-no*)
+ "No whitespace only lines"
+ (progn
+ (incf *line-no*)
+ (setf *col-no* -1)
+ (set-state :beginning-of-line-with-separator)))))
+ (defevaluator :beginning-of-symbols "\\)" (constantly "No hanging close parens"))
+ (defevaluator :beginning-of-symbols-with-separator "\\)" (constantly "No hanging close parens"))
(defevaluator :beginning-of-symbols ""
(lambda ()
- (set-state :normal)
- nil))
- (defevaluator :normal "\\("
+ (if
+ (and (not *form-stack*) (not *form-ended-on-same-line*))
+ "Multiline top level forms must be separated by a space"
+ (set-state :first-symbol))))
+ (defevaluator :beginning-of-symbols-with-separator ""
(lambda ()
- (push
- (list *line-no* *col-no*)
- *form-stack*)
- nil))
+ (set-state :first-symbol)))
(defevaluator :normal "\\)"
(lambda ()
(let
((form (pop *form-stack*)))
(cond
((not form) "Unmatched ending paren")
- ((< 50 (- *line-no* (car form))) "Forms can't be over 50 lines long")))))
-
-(cl-ppcre:scan (cl-ppcre:create-scanner " *") "
-asdf asdf")
-
- (defevaluator :normal "." (constantly nil))
- )
+ ((< 50 (- *line-no* (car form))) "Forms can't be over 50 lines long")
+ (t (setf *form-ended-on-same-line* (= *line-no* (car form))) nil)))))
+ (defevaluator :normal "::" (constantly "No internal symbols from other packages"))
+ (defevaluator :in-string "\\\\\"" (constantly nil))
+ (defevaluator :normal "\"" (lambda () (set-state :in-string)))
+ (defevaluator :in-string "\"" (lambda () (set-state :normal)))
+ (defevaluator :in-string "\\n"
+ (lambda ()
+ (incf *line-no*)
+ (setf *col-no* -1)
+ nil))
+ (defevaluator :in-string "." (constantly nil))
+ (defevaluator :first-symbol "\\n" (constantly "No new line after opening form"))
+ (defevaluator :first-symbol " " (constantly "No space after opening parens"))
+ (defevaluator :first-symbol ""
+ (lambda ()
+ ;(format t "HMMM: ~A ~A ~A~%" *form-stack* *line-no* *col-no*)
+ (cond
+ ((and *form-stack* (/= (1+ (cadr (car *form-stack*))) *col-no*))
+ "All form elements must be indented equally")
+ (t (set-state :normal)))))
+ (defevaluator :normal " " (constantly "Only one space between items of a form"))
+ (defevaluator :normal "." (constantly nil)))
projects / wolf / blobdiff