elint.el 26.4 KB
Newer Older
1
;;; elint.el --- Lint Emacs Lisp
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3 4
;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
;;   2009  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6 7 8 9 10 11

;; Author: Peter Liljenberg <petli@lysator.liu.se>
;; Created: May 1997
;; Keywords: lisp

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24 25 26

;;; Commentary:

27 28
;; This is a linter for Emacs Lisp.  Currently, it mainly catches
;; misspellings and undefined variables, although it can also catch
Richard M. Stallman's avatar
Richard M. Stallman committed
29 30
;; function calls with the wrong number of arguments.

31 32 33
;; To use, call elint-current-buffer or elint-defun to lint a buffer
;; or defun.  The first call runs `elint-initialize' to set up some
;; argument data, which may take a while.
Richard M. Stallman's avatar
Richard M. Stallman committed
34 35

;; The linter will try to "include" any require'd libraries to find
36
;; the variables defined in those.  There is a fair amount of voodoo
Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39 40
;; involved in this, but it seems to work in normal situations.

;;; To do:

41
;; * List of variables and functions defined in dumped lisp files.
Richard M. Stallman's avatar
Richard M. Stallman committed
42
;; * Adding type checking. (Stop that sniggering!)
43 44 45
;; * Handle eval-when-compile (eg for requires, being sensitive to the
;;   difference between funcs and macros).
;; * Requires within function bodies.
Richard M. Stallman's avatar
Richard M. Stallman committed
46 47 48 49 50 51

;;; Code:

(defvar elint-log-buffer "*Elint*"
  "*The buffer to insert lint messages in.")

52 53 54 55
;;;
;;; Data
;;;

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

;; FIXME does this serve any useful purpose now elint-builtin-variables exists?
(defconst elint-standard-variables '(local-write-file-hooks vc-mode)
  "Standard buffer local variables, excluding `elint-builtin-variables'.")

(defvar elint-builtin-variables nil
  "List of built-in variables.  Set by `elint-initialize'.")

(defvar elint-autoloaded-variables nil
  "List of `loaddefs.el' variables.  Set by `elint-initialize'.")

;; FIXME dumped variables and functions.

(defconst elint-unknown-builtin-args nil
  "Those built-ins for which we can't find arguments, if any.")

(defconst elint-extra-errors '(file-locked file-supersession ftp-error)
  "Errors without error-message or error-confitions properties.")
74

Richard M. Stallman's avatar
Richard M. Stallman committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
;;;
;;; ADT: top-form
;;;

(defsubst elint-make-top-form (form pos)
  "Create a top form.
FORM is the form, and POS is the point where it starts in the buffer."
  (cons form pos))

(defsubst elint-top-form-form (top-form)
  "Extract the form from a TOP-FORM."
  (car top-form))

(defsubst elint-top-form-pos (top-form)
  "Extract the position from a TOP-FORM."
  (cdr top-form))

;;;
;;; ADT: env
;;;

(defsubst elint-make-env ()
  "Create an empty environment."
  (list (list nil) nil nil))

(defsubst elint-env-add-env (env newenv)
  "Augment ENV with NEWENV.
None of them is modified, and the new env is returned."
  (list (append (car env) (car newenv))
104
	(append (cadr env) (cadr newenv))
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
	(append (car (cdr (cdr env))) (car (cdr (cdr newenv))))))

(defsubst elint-env-add-var (env var)
  "Augment ENV with the variable VAR.
The new environment is returned, the old is unmodified."
  (cons (cons (list var) (car env)) (cdr env)))

(defsubst elint-env-add-global-var (env var)
  "Augment ENV with the variable VAR.
ENV is modified so VAR is seen everywhere.
ENV is returned."
  (nconc (car env) (list (list var)))
  env)

(defsubst elint-env-find-var (env var)
  "Non-nil if ENV contains the variable VAR.
Actually, a list with VAR as a single element is returned."
  (assq var (car env)))

(defsubst elint-env-add-func (env func args)
  "Augment ENV with the function FUNC, which has the arguments ARGS.
The new environment is returned, the old is unmodified."
  (list (car env)
128
	(cons (list func args) (cadr env))
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132 133
	(car (cdr (cdr env)))))

(defsubst elint-env-find-func (env func)
  "Non-nil if ENV contains the function FUNC.
Actually, a list of (FUNC ARGS) is returned."
134
  (assq func (cadr env)))
Richard M. Stallman's avatar
Richard M. Stallman committed
135 136 137 138 139 140

(defsubst elint-env-add-macro (env macro def)
  "Augment ENV with the macro named MACRO.
DEF is the macro definition (a lambda expression or similar).
The new environment is returned, the old is unmodified."
  (list (car env)
141
	(cadr env)
Richard M. Stallman's avatar
Richard M. Stallman committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
	(cons (cons macro def) (car (cdr (cdr env))))))

(defsubst elint-env-macro-env (env)
  "Return the macro environment of ENV.
This environment can be passed to `macroexpand'."
  (car (cdr (cdr env))))

(defsubst elint-env-macrop (env macro)
  "Non-nil if ENV contains MACRO."
  (assq macro (elint-env-macro-env env)))

;;;
;;; User interface
;;;

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
;;;###autoload
(defun elint-file (file)
  "Lint the file FILE."
  (interactive "fElint file: ")
  (setq file (expand-file-name file))
  (or elint-builtin-variables
      (elint-initialize))
  (let ((dir (file-name-directory file)))
    (let ((default-directory dir))
      (elint-display-log))
    (elint-set-mode-line t)
    (with-current-buffer elint-log-buffer
      (unless (string-equal default-directory dir)
	(elint-log-message (format "\nLeaving directory `%s'"
				   default-directory) t)
	(elint-log-message (format "Entering directory `%s'" dir) t)
	(setq default-directory dir))))
  (let ((str (format "Linting file %s" file)))
    (message "%s..." str)
    (or noninteractive
	(elint-log-message (format "\n%s at %s" str (current-time-string)) t))
    ;; elint-current-buffer clears log.
    (with-temp-buffer
      (insert-file-contents file)
181 182
      (let ((buffer-file-name file)
	    (max-lisp-eval-depth (max 1000 max-lisp-eval-depth)))
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
	(with-syntax-table emacs-lisp-mode-syntax-table
	  (mapc 'elint-top-form (elint-update-env)))))
    (elint-set-mode-line)
    (message "%s...done" str)))

;; cf byte-recompile-directory.
;;;###autoload
(defun elint-directory (directory)
  "Lint all the .el files in DIRECTORY."
  (interactive "DElint directory: ")
  (let ((elint-running t))
    (dolist (file (directory-files directory t))
      ;; Bytecomp has emacs-lisp-file-regexp.
      (when (and (string-match "\\.el\\'" file)
		 (file-readable-p file)
		 (not (auto-save-file-name-p file)))
	(elint-file file))))
  (elint-set-mode-line))

202
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
203
(defun elint-current-buffer ()
204 205
  "Lint the current buffer.
If necessary, this first calls `elint-initalize'."
Richard M. Stallman's avatar
Richard M. Stallman committed
206
  (interactive)
207 208
  (or elint-builtin-variables
      (elint-initialize))
209 210
  (elint-clear-log (format "Linting %s" (or (buffer-file-name)
					    (buffer-name))))
Richard M. Stallman's avatar
Richard M. Stallman committed
211
  (elint-display-log)
212
  (elint-set-mode-line t)
213
  (mapc 'elint-top-form (elint-update-env))
214
  ;; Tell the user we're finished.  This is terribly klugy: we set
215 216 217 218 219
    ;; elint-top-form-logged so elint-log-message doesn't print the
    ;; ** top form ** header...
  (elint-set-mode-line)
  (elint-log-message "\nLinting finished.\n" t))

220

221
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
222
(defun elint-defun ()
223 224
  "Lint the function at point.
If necessary, this first calls `elint-initalize'."
Richard M. Stallman's avatar
Richard M. Stallman committed
225
  (interactive)
226 227
  (or elint-builtin-variables
      (elint-initialize))
Richard M. Stallman's avatar
Richard M. Stallman committed
228
  (save-excursion
229
    (or (beginning-of-defun) (error "Lint what?"))
Richard M. Stallman's avatar
Richard M. Stallman committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    (let ((pos (point))
	  (def (read (current-buffer))))
      (elint-display-log)
      (elint-update-env)
      (elint-top-form (elint-make-top-form def pos)))))

;;;
;;; Top form functions
;;;

(defvar elint-buffer-env nil
  "The environment of a elisp buffer.
Will be local in linted buffers.")

(defvar elint-buffer-forms nil
  "The top forms in a buffer.
Will be local in linted buffers.")

(defvar elint-last-env-time nil
  "The last time the buffers env was updated.
Is measured in buffer-modified-ticks and is local in linted buffers.")

(defun elint-update-env ()
  "Update the elint environment in the current buffer.
Don't do anything if the buffer hasn't been changed since this
function was called the last time.
Returns the forms."
  (if (and (local-variable-p 'elint-buffer-env (current-buffer))
	   (local-variable-p 'elint-buffer-forms (current-buffer))
	   (local-variable-p 'elint-last-env-time (current-buffer))
	   (= (buffer-modified-tick) elint-last-env-time))
      ;; Env is up to date
      elint-buffer-forms
    ;; Remake env
    (set (make-local-variable 'elint-buffer-forms) (elint-get-top-forms))
    (set (make-local-variable 'elint-buffer-env)
	 (elint-init-env elint-buffer-forms))
    (set (make-local-variable 'elint-last-env-time) (buffer-modified-tick))
    elint-buffer-forms))
269

Richard M. Stallman's avatar
Richard M. Stallman committed
270 271 272 273 274 275 276 277 278 279 280 281 282
(defun elint-get-top-forms ()
  "Collect all the top forms in the current buffer."
  (save-excursion
    (let ((tops nil))
      (goto-char (point-min))
      (while (elint-find-next-top-form)
	(let ((pos (point)))
	  (condition-case nil
	      (setq tops (cons
			  (elint-make-top-form (read (current-buffer)) pos)
			  tops))
	    (end-of-file
	     (goto-char pos)
283 284
	     (error "Missing ')' in top form: %s"
		    (buffer-substring pos (line-end-position)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
285 286 287 288
      (nreverse tops))))

(defun elint-find-next-top-form ()
  "Find the next top form from point.
Pavel Janík's avatar
Pavel Janík committed
289
Return nil if there are no more forms, t otherwise."
Richard M. Stallman's avatar
Richard M. Stallman committed
290 291 292 293
  (parse-partial-sexp (point) (point-max) nil t)
  (not (eobp)))

(defun elint-init-env (forms)
294
  "Initialize the environment from FORMS."
Richard M. Stallman's avatar
Richard M. Stallman committed
295 296 297 298 299 300 301 302
  (let ((env (elint-make-env))
	form)
    (while forms
      (setq form (elint-top-form-form (car forms))
	    forms (cdr forms))
      (cond
       ;; Add defined variable
       ((memq (car form) '(defvar defconst defcustom))
303
	(setq env (elint-env-add-var env (cadr form))))
Richard M. Stallman's avatar
Richard M. Stallman committed
304 305
       ;; Add function
       ((memq (car form) '(defun defsubst))
306
	(setq env (elint-env-add-func env (cadr form) (nth 2 form))))
307 308 309
       ((eq (car form) 'define-derived-mode)
	(setq env (elint-env-add-func env (cadr form) ())
	      env (elint-env-add-var env (cadr form))))
310 311 312 313 314
       ;; FIXME it would be nice to check the autoloads are correct.
       ((eq (car form) 'autoload)
	(setq env (elint-env-add-func env (cadr (cadr form)) 'unknown)))
       ((eq (car form) 'declare-function)
	(setq env (elint-env-add-func env (cadr form)
315 316 317 318 319
				      (if (or (< (length form) 4)
					      (eq (nth 3 form) t))
					'unknown
					(nth 3 form)))))
       ((and (eq (car form) 'defalias) (listp (nth 2 form)))
320 321 322 323 324 325
	;; If the alias points to something already in the environment,
	;; add the alias to the environment with the same arguments.
	(let ((def (elint-env-find-func env (cadr (nth 2 form)))))
	  ;; FIXME warn if the alias target is unknown.
	  (setq env (elint-env-add-func env (cadr (cadr form))
					(if def (cadr def) 'unknown)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
326 327
       ;; Add macro, both as a macro and as a function
       ((eq (car form) 'defmacro)
328 329 330
	(setq env (elint-env-add-macro env (cadr form)
				       (cons 'lambda (cddr form)))
	      env (elint-env-add-func env (cadr form) (nth 2 form))))
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332
       ;; Import variable definitions
       ((eq (car form) 'require)
333 334 335
	(let ((name (eval (cadr form)))
	      (file (eval (nth 2 form))))
	  (setq env (elint-add-required-env env name file))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
336 337 338
    env))

(defun elint-add-required-env (env name file)
339
  "Augment ENV with the variables defined by feature NAME in FILE."
Richard M. Stallman's avatar
Richard M. Stallman committed
340 341 342 343 344 345 346
  (condition-case nil
      (let* ((libname (if (stringp file)
			  file
			(symbol-name name)))

	     ;; First try to find .el files, then the raw name
	     (lib1 (locate-library (concat libname ".el") t))
347
	     (lib (or lib1 (locate-library libname t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
348 349 350 351
	;; Clear the messages :-/
	(message nil)
	(if lib
	    (save-excursion
352 353 354 355 356 357 358 359 360 361
 	      ;;; (set-buffer (find-file-noselect lib))
 	      ;;; (elint-update-env)
 	      ;;; (setq env (elint-env-add-env env elint-buffer-env)))
	      (with-temp-buffer
		(insert-file-contents lib)
		(with-syntax-table emacs-lisp-mode-syntax-table
		  (elint-update-env))
		(setq env (elint-env-add-env env elint-buffer-env))))
	      ;;(message "Elint processed (require '%s)" name))
	  (error "Unable to find require'd library %s" name)))
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364
    (error
     (message "Can't get variables from require'd library %s" name)))
  env)
365

Richard M. Stallman's avatar
Richard M. Stallman committed
366 367 368 369 370 371 372 373 374
(defvar elint-top-form nil
  "The currently linted top form, or nil.")

(defvar elint-top-form-logged nil
  "T if the currently linted top form has been mentioned in the log buffer.")

(defun elint-top-form (form)
  "Lint a top FORM."
  (let ((elint-top-form form)
375 376
	(elint-top-form-logged nil)
	(elint-current-pos (elint-top-form-pos form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
    (elint-form (elint-top-form-form form) elint-buffer-env)))

;;;
;;; General form linting functions
;;;

(defconst elint-special-forms
  '((let . elint-check-let-form)
    (let* . elint-check-let-form)
    (setq . elint-check-setq-form)
    (quote . elint-check-quote-form)
    (cond . elint-check-cond-form)
    (lambda . elint-check-defun-form)
    (function . elint-check-function-form)
    (setq-default . elint-check-setq-form)
    (defun . elint-check-defun-form)
    (defsubst . elint-check-defun-form)
    (defmacro . elint-check-defun-form)
    (defvar . elint-check-defvar-form)
    (defconst . elint-check-defvar-form)
397
    (defcustom . elint-check-defcustom-form)
Richard M. Stallman's avatar
Richard M. Stallman committed
398 399 400
    (macro . elint-check-macro-form)
    (condition-case . elint-check-condition-case-form))
  "Functions to call when some special form should be linted.")
401

Richard M. Stallman's avatar
Richard M. Stallman committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
(defun elint-form (form env)
  "Lint FORM in the environment ENV.
The environment created by the form is returned."
  (cond
   ((consp form)
    (let ((func (cdr (assq (car form) elint-special-forms))))
      (if func
	  ;; Special form
	  (funcall func form env)

	(let* ((func (car form))
	       (args (elint-get-args func env))
	       (argsok t))
	  (cond
	   ((eq args 'undefined)
	    (setq argsok nil)
418
	    (elint-error "Call to undefined function: %s" func))
419

Richard M. Stallman's avatar
Richard M. Stallman committed
420
	   ((eq args 'unknown) nil)
421

Richard M. Stallman's avatar
Richard M. Stallman committed
422 423 424 425 426 427
	   (t (setq argsok (elint-match-args form args))))

	  ;; Is this a macro?
	  (if (elint-env-macrop env func)
	      ;; Macro defined in buffer, expand it
	      (if argsok
428 429 430 431 432
		  ;; FIXME error if macro uses macro, eg bytecomp.el.
		  (condition-case nil
		      (elint-form
		       (macroexpand form (elint-env-macro-env env)) env)
		    (error
433 434
		     (elint-error "Elint failed to expand macro: %s" func)
		     env))
Richard M. Stallman's avatar
Richard M. Stallman committed
435 436 437 438
		env)

	    (let ((fcode (if (symbolp func)
			     (if (fboundp func)
439
				 (indirect-function func))
Richard M. Stallman's avatar
Richard M. Stallman committed
440 441 442 443 444 445 446
			   func)))
	      (if (and (listp fcode) (eq (car fcode) 'macro))
		  ;; Macro defined outside buffer
		  (if argsok
		      (elint-form (macroexpand form) env)
		    env)
		;; Function, lint its parameters
447
		(elint-forms (cdr form) env))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
448 449 450 451 452 453 454
   ((symbolp form)
    ;; :foo variables are quoted
    (if (and (/= (aref (symbol-name form) 0) ?:)
	     (elint-unbound-variable form env))
	(elint-warning "Reference to unbound symbol: %s" form))
    env)

455
   (t env)))
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458 459

(defun elint-forms (forms env)
  "Lint the FORMS, accumulating an environment, starting with ENV."
  ;; grumblegrumbletailrecursiongrumblegrumble
460 461 462 463
  (if (listp forms)
      (dolist (f forms env)
	(setq env (elint-form f env)))
    ;; Loop macro?
464 465
    (elint-error "Elint failed to parse form: %s" forms)
    env))
Richard M. Stallman's avatar
Richard M. Stallman committed
466 467 468

(defun elint-unbound-variable (var env)
  "T if VAR is unbound in ENV."
469
  (not (or (memq var '(nil t))
Richard M. Stallman's avatar
Richard M. Stallman committed
470
	   (elint-env-find-var env var)
471 472
	   (memq var elint-builtin-variables)
	   (memq var elint-autoloaded-variables)
Richard M. Stallman's avatar
Richard M. Stallman committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
	   (memq var elint-standard-variables))))

;;;
;;; Function argument checking
;;;

(defun elint-match-args (arglist argpattern)
  "Match ARGLIST against ARGPATTERN."
  (let ((state 'all)
	(al (cdr arglist))
	(ap argpattern)
	(ok t))
    (while
	(cond
	 ((and (null al) (null ap)) nil)
	 ((eq (car ap) '&optional)
	  (setq state 'optional)
	  (setq ap (cdr ap))
	  t)
	 ((eq (car ap) '&rest)
	  nil)
	 ((or (and (eq state 'all) (or (null al) (null ap)))
	      (and (eq state 'optional) (and al (null ap))))
	  (elint-error "Wrong number of args: %s, %s" arglist argpattern)
	  (setq ok nil)
	  nil)
	 ((and (eq state 'optional) (null al))
	  nil)
	 (t (setq al (cdr al)
		  ap (cdr ap))
	    t)))
    ok))

(defun elint-get-args (func env)
  "Find the args of FUNC in ENV.
Returns `unknown' if we couldn't find arguments."
  (let ((f (elint-env-find-func env func)))
    (if f
511
	(cadr f)
Richard M. Stallman's avatar
Richard M. Stallman committed
512 513 514 515
      (if (symbolp func)
	  (if (fboundp func)
	      (let ((fcode (indirect-function func)))
		(if (subrp fcode)
516 517
		    ;; FIXME builtins with no args have args = nil.
		    (or (get func 'elint-args) 'unknown)
Richard M. Stallman's avatar
Richard M. Stallman committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
		  (elint-find-args-in-code fcode)))
	    'undefined)
	(elint-find-args-in-code func)))))

(defun elint-find-args-in-code (code)
  "Extract the arguments from CODE.
CODE can be a lambda expression, a macro, or byte-compiled code."
  (cond
   ((byte-code-function-p code)
    (aref code 0))
   ((and (listp code) (eq (car code) 'lambda))
    (car (cdr code)))
   ((and (listp code) (eq (car code) 'macro))
    (elint-find-args-in-code (cdr code)))
   (t 'unknown)))

;;;
;;; Functions to check some special forms
;;;

(defun elint-check-cond-form (form env)
  "Lint a cond FORM in ENV."
540 541 542 543
  (dolist (f (cdr form) env)
    (if (consp f)
	(elint-forms f env)
      (elint-error "cond clause should be a list: %s" f))))
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545 546

(defun elint-check-defun-form (form env)
  "Lint a defun/defmacro/lambda FORM in ENV."
547 548 549 550
  (setq form (if (eq (car form) 'lambda) (cdr form) (cddr form)))
  (mapc (lambda (p)
	  (or (memq p '(&optional &rest))
	      (setq env (elint-env-add-var env p))))
551
	(car form))
Richard M. Stallman's avatar
Richard M. Stallman committed
552 553 554 555
  (elint-forms (cdr form) env))

(defun elint-check-let-form (form env)
  "Lint the let/let* FORM in ENV."
556
  (let ((varlist (cadr form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
557 558 559 560 561 562 563 564 565 566 567 568
    (if (not varlist)
	(progn
	  (elint-error "Missing varlist in let: %s" form)
	  env)
      ;; Check for (let (a (car b)) ...) type of error
      (if (and (= (length varlist) 2)
	       (symbolp (car varlist))
	       (listp (car (cdr varlist)))
	       (fboundp (car (car (cdr varlist)))))
	  (elint-warning "Suspect varlist: %s" form))
      ;; Add variables to environment, and check the init values
      (let ((newenv env))
569 570 571 572 573 574 575 576 577 578 579 580 581
	(mapc (lambda (s)
		(cond
		 ((symbolp s)
		  (setq newenv (elint-env-add-var newenv s)))
		 ((and (consp s) (<= (length s) 2))
		  (elint-form (cadr s)
			      (if (eq (car form) 'let)
				  env
				newenv))
		  (setq newenv
			(elint-env-add-var newenv (car s))))
		 (t (elint-error
		     "Malformed `let' declaration: %s" s))))
582
	      varlist)
Richard M. Stallman's avatar
Richard M. Stallman committed
583 584

	;; Lint the body forms
585
	(elint-forms (cddr form) newenv)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

(defun elint-check-setq-form (form env)
  "Lint the setq FORM in ENV."
  (or (= (mod (length form) 2) 1)
      (elint-error "Missing value in setq: %s" form))
  (let ((newenv env)
	sym val)
    (setq form (cdr form))
    (while form
      (setq sym (car form)
	    val (car (cdr form))
	    form (cdr (cdr form)))
      (if (symbolp sym)
	  (if (elint-unbound-variable sym newenv)
	      (elint-warning "Setting previously unbound symbol: %s" sym))
	(elint-error "Setting non-symbol in setq: %s" sym))
      (elint-form val newenv)
      (if (symbolp sym)
	  (setq newenv (elint-env-add-var newenv sym))))
    newenv))
606

Richard M. Stallman's avatar
Richard M. Stallman committed
607 608 609 610 611 612 613 614 615
(defun elint-check-defvar-form (form env)
  "Lint the defvar/defconst FORM in ENV."
  (if (or (= (length form) 2)
	  (= (length form) 3)
	  (and (= (length form) 4) (stringp (nth 3 form))))
          (elint-env-add-global-var (elint-form (nth 2 form) env)
			     (car (cdr form)))
    (elint-error "Malformed variable declaration: %s" form)
    env))
616 617 618 619

(defun elint-check-defcustom-form (form env)
  "Lint the defcustom FORM in ENV."
  (if (and (> (length form) 3)
620 621
	   ;; even no. of keyword/value args ?
	   (zerop (logand (length form) 1)))
622 623 624 625 626
      (elint-env-add-global-var (elint-form (nth 2 form) env)
				(car (cdr form)))
    (elint-error "Malformed variable declaration: %s" form)
    env))

Richard M. Stallman's avatar
Richard M. Stallman committed
627 628 629 630 631 632 633 634 635 636 637 638 639
(defun elint-check-function-form (form env)
  "Lint the function FORM in ENV."
  (let ((func (car (cdr-safe form))))
    (cond
     ((symbolp func)
      (or (elint-env-find-func env func)
	  (fboundp func)
	  (elint-warning "Reference to undefined function: %s" form))
      env)
     ((and (consp func) (memq (car func) '(lambda macro)))
      (elint-form func env))
     ((stringp func) env)
     (t (elint-error "Not a function object: %s" form)
640
	env))))
Richard M. Stallman's avatar
Richard M. Stallman committed
641 642 643 644 645 646 647 648 649 650

(defun elint-check-quote-form (form env)
  "Lint the quote FORM in ENV."
  env)

(defun elint-check-macro-form (form env)
  "Check the macro FORM in ENV."
  (elint-check-function-form (list (car form) (cdr form)) env))

(defun elint-check-condition-case-form (form env)
651
  "Check the `condition-case' FORM in ENV."
Richard M. Stallman's avatar
Richard M. Stallman committed
652 653 654
  (let ((resenv env))
    (if (< (length form) 3)
	(elint-error "Malformed condition-case: %s" form)
655
      (or (symbolp (cadr form))
Richard M. Stallman's avatar
Richard M. Stallman committed
656 657
	  (elint-warning "First parameter should be a symbol: %s" form))
      (setq resenv (elint-form (nth 2 form) env))
658
      (let ((newenv (elint-env-add-var env (cadr form)))
Richard M. Stallman's avatar
Richard M. Stallman committed
659
	    errlist)
660 661 662 663 664 665 666 667
	(dolist (err (nthcdr 3 form))
	  (setq errlist (car err))
	  (mapc (lambda (s)
		  (or (get s 'error-conditions)
		      (get s 'error-message)
		      (memq s elint-extra-errors)
		      (elint-warning
		       "Not an error symbol in error handler: %s" s)))
668
		(cond
669 670 671 672 673 674
		 ((symbolp errlist) (list errlist))
		 ((listp errlist) errlist)
		 (t (elint-error "Bad error list in error handler: %s"
				 errlist)
		    nil)))
	  (elint-forms (cdr err) newenv))))
Richard M. Stallman's avatar
Richard M. Stallman committed
675
    resenv))
676

Richard M. Stallman's avatar
Richard M. Stallman committed
677 678 679 680
;;;
;;; Message functions
;;;

681 682 683 684
(defvar elint-current-pos)	 ; dynamically bound in elint-top-form

(defun elint-log (type string args)
  (elint-log-message (format "%s:%d:%s: %s"
685 686 687 688
			     (let ((f (buffer-file-name)))
			       (if f
				   (file-name-nondirectory f)
				 (buffer-name)))
689 690 691 692 693 694
			     (save-excursion
			       (goto-char elint-current-pos)
			       (1+ (count-lines (point-min)
						(line-beginning-position))))
			     type
			     (apply 'format string args))))
Richard M. Stallman's avatar
Richard M. Stallman committed
695 696

(defun elint-error (string &rest args)
697
  "Report a linting error.
Richard M. Stallman's avatar
Richard M. Stallman committed
698
STRING and ARGS are thrown on `format' to get the message."
699
  (elint-log "Error" string args))
700

Richard M. Stallman's avatar
Richard M. Stallman committed
701
(defun elint-warning (string &rest args)
702
  "Report a linting warning.
703 704
See `elint-error'."
  (elint-log "Warning" string args))
Richard M. Stallman's avatar
Richard M. Stallman committed
705

706 707 708 709 710 711 712 713 714
(defun elint-output (string)
  "Print or insert STRING, depending on value of `noninteractive'."
  (if noninteractive
      (message "%s" string)
    (insert string "\n")))

(defun elint-log-message (errstr &optional top)
  "Insert ERRSTR last in the lint log buffer.
Optional argument TOP non-nil means pretend `elint-top-form-logged' is non-nil."
715
  (with-current-buffer (elint-get-log-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
716
    (goto-char (point-max))
717 718 719
    (let ((inhibit-read-only t))
      (or (bolp) (newline))
      ;; Do we have to say where we are?
720 721 722 723 724 725 726 727 728 729 730
      (unless (or elint-top-form-logged top)
	(let* ((form (elint-top-form-form elint-top-form))
	       (top (car form)))
	  (elint-output (cond
			 ((memq top '(defun defsubst))
			  (format "\nIn function %s:" (cadr form)))
			 ((eq top 'defmacro)
			  (format "\nIn macro %s:" (cadr form)))
			 ((memq top '(defvar defconst))
			  (format "\nIn variable %s:" (cadr form)))
			 (t "\nIn top level expression:"))))
731
	(setq elint-top-form-logged t))
732
      (elint-output errstr))))
Richard M. Stallman's avatar
Richard M. Stallman committed
733 734 735 736

(defun elint-clear-log (&optional header)
  "Clear the lint log buffer.
Insert HEADER followed by a blank line if non-nil."
737 738 739 740 741 742
  (let ((dir default-directory))
    (with-current-buffer (elint-get-log-buffer)
      (setq default-directory dir)
      (let ((inhibit-read-only t))
	(erase-buffer)
	(if header (insert header "\n"))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
743 744 745 746 747 748 749

(defun elint-display-log ()
  "Display the lint log buffer."
  (let ((pop-up-windows t))
    (display-buffer (elint-get-log-buffer))
    (sit-for 0)))

750 751 752 753 754 755 756 757 758 759 760
(defvar elint-running)

(defun elint-set-mode-line (&optional on)
  "Set the mode-line-process of the Elint log buffer."
  (with-current-buffer (elint-get-log-buffer)
    (and (eq major-mode 'compilation-mode)
	 (setq mode-line-process
	       (list (if (or on (bound-and-true-p elint-running))
			 (propertize ":run" 'face 'compilation-warning)
		       (propertize ":finished" 'face 'compilation-info)))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
761 762
(defun elint-get-log-buffer ()
  "Return a log buffer for elint."
763 764 765 766 767 768
  (or (get-buffer elint-log-buffer)
      (with-current-buffer (get-buffer-create elint-log-buffer)
	(or (eq major-mode 'compilation-mode)
	    (compilation-mode))
	(setq buffer-undo-list t)
	(current-buffer))))
769

Richard M. Stallman's avatar
Richard M. Stallman committed
770 771 772
;;;
;;; Initializing code
;;;
773

Richard M. Stallman's avatar
Richard M. Stallman committed
774
;;;###autoload
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
(defun elint-initialize (&optional reinit)
  "Initialize elint.
If elint is already initialized, this does nothing, unless
optional prefix argument REINIT is non-nil."
  (interactive "P")
  (if (and elint-builtin-variables (not reinit))
      (message "Elint is already initialized")
    (message "Initializing elint...")
    (setq elint-builtin-variables (elint-find-builtin-variables)
	  elint-autoloaded-variables (elint-find-autoloaded-variables))
    (mapc (lambda (x) (or (not (symbolp (car x)))
			  (eq (cdr x) 'unknown)
			  (put (car x) 'elint-args (cdr x))))
	  (elint-find-builtin-args))
    (if elint-unknown-builtin-args
	(mapc (lambda (x) (put (car x) 'elint-args (cdr x)))
	      elint-unknown-builtin-args))
    (message "Initializing elint...done")))
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794


795 796 797 798 799
(defun elint-find-builtin-variables ()
  "Return a list of all built-in variables."
  ;; Cribbed from help-fns.el.
  (let ((docbuf " *DOC*")
	vars var)
800 801 802 803 804 805 806 807 808 809 810 811 812 813
    (save-excursion
      (if (get-buffer docbuf)
	  (progn
	    (set-buffer docbuf)
	    (goto-char (point-min)))
	(set-buffer (get-buffer-create docbuf))
	(insert-file-contents-literally
	 (expand-file-name internal-doc-file-name doc-directory)))
      (while (search-forward "V" nil t)
	(and (setq var (intern-soft
			(buffer-substring (point) (line-end-position))))
	     (boundp var)
	     (setq vars (cons var vars))))
      vars)))
814 815 816 817 818 819 820 821 822 823 824 825

(defun elint-find-autoloaded-variables ()
  "Return a list of all autoloaded variables."
  (let (var vars)
    (with-temp-buffer
      (insert-file-contents (locate-library "loaddefs.el"))
      (while (re-search-forward "^(defvar \\([[:alnum:]_-]+\\)" nil t)
	(and (setq var (intern-soft (match-string 1)))
	     (boundp var)
	     (setq vars (cons var vars)))))
    vars))

Richard M. Stallman's avatar
Richard M. Stallman committed
826
(defun elint-find-builtins ()
827 828 829 830 831
  "Return a list of all built-in functions."
  (let (subrs)
    (mapatoms (lambda (s) (and (fboundp s) (subrp (symbol-function s))
			       (setq subrs (cons s subrs)))))
    subrs))
Richard M. Stallman's avatar
Richard M. Stallman committed
832 833

(defun elint-find-builtin-args (&optional list)
834
  "Return a list of the built-in functions and their arguments.
Richard M. Stallman's avatar
Richard M. Stallman committed
835 836 837
If LIST is nil, call `elint-find-builtins' to get a list of all built-in
functions, otherwise use LIST.

838
Each function is represented by a cons cell:
Richard M. Stallman's avatar
Richard M. Stallman committed
839 840
\(function-symbol . args)
If no documentation could be found args will be `unknown'."
841 842 843 844 845
  (mapcar (lambda (f)
	    (let ((doc (documentation f t)))
	      (or (and doc
		       (string-match "\n\n(fn\\(.*)\\)\\'" doc)
		       (ignore-errors
846 847 848 849
			;; "BODY...)" -> "&rest BODY)".
			(read (replace-regexp-in-string
			       "\\([^ ]+\\)\\.\\.\\.)\\'" "&rest \\1)"
			       (format "(%s %s" f (match-string 1 doc)) t))))
850 851
		  (cons f 'unknown))))
	  (or list (elint-find-builtins))))
Richard M. Stallman's avatar
Richard M. Stallman committed
852 853 854

(provide 'elint)

855
;; arch-tag: b2f061e2-af84-4ddc-8e39-f5e969ac228f
Richard M. Stallman's avatar
Richard M. Stallman committed
856
;;; elint.el ends here