2007-11-17 03:47:59 +00:00
|
|
|
;;; check-declare.el --- Check declare-function statements
|
|
|
|
|
|
2019-01-01 00:59:58 +00:00
|
|
|
;; Copyright (C) 2007-2019 Free Software Foundation, Inc.
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
;; Author: Glenn Morris <rgm@gnu.org>
|
|
|
|
|
;; Keywords: lisp, tools, maint
|
|
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
2008-05-06 03:21:21 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2007-11-17 03:47:59 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2008-05-06 03:21:21 +00:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
;; (at your option) any later version.
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
;; 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
|
2017-09-13 15:52:52 -07:00
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
|
|
;; The byte-compiler often warns about undefined functions that you
|
|
|
|
|
;; know will actually be defined when it matters. The `declare-function'
|
|
|
|
|
;; statement allows you to suppress these warnings. This package
|
|
|
|
|
;; checks that all such statements in a file or directory are accurate.
|
|
|
|
|
;; The entry points are `check-declare-file' and `check-declare-directory'.
|
|
|
|
|
|
2012-04-20 20:32:15 -04:00
|
|
|
;; For more information, see Info node `(elisp)Declaring Functions'.
|
2007-11-24 03:11:14 +00:00
|
|
|
|
2007-11-19 00:09:20 +00:00
|
|
|
;;; TODO:
|
|
|
|
|
|
2007-12-11 05:52:07 +00:00
|
|
|
;; 1. Warn about functions marked as obsolete, eg
|
2019-06-09 09:18:46 -07:00
|
|
|
;; password-read-and-add in password-cache.el.
|
2009-09-29 04:12:46 +00:00
|
|
|
;; 2. defmethod, defclass argument checking.
|
|
|
|
|
;; 3. defclass also defines -p and -child-p.
|
2007-12-11 05:52:07 +00:00
|
|
|
|
2007-11-17 03:47:59 +00:00
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
|
|
(defconst check-declare-warning-buffer "*Check Declarations Warnings*"
|
|
|
|
|
"Name of buffer used to display any `check-declare' warnings.")
|
|
|
|
|
|
2007-11-22 20:25:51 +00:00
|
|
|
(defun check-declare-locate (file basefile)
|
2016-05-18 00:48:35 -07:00
|
|
|
"Return the relative name of FILE.
|
2008-07-16 02:25:40 +00:00
|
|
|
Expands files with a \".c\" or \".m\" extension relative to the Emacs
|
2007-11-28 03:53:44 +00:00
|
|
|
\"src/\" directory. Otherwise, `locate-library' searches for FILE.
|
|
|
|
|
If that fails, expands FILE relative to BASEFILE's directory part.
|
2007-11-29 04:23:49 +00:00
|
|
|
The returned file might not exist. If FILE has an \"ext:\" prefix, so does
|
|
|
|
|
the result."
|
|
|
|
|
(let ((ext (string-match "^ext:" file))
|
|
|
|
|
tfile)
|
|
|
|
|
(if ext
|
|
|
|
|
(setq file (substring file 4)))
|
|
|
|
|
(setq file
|
2008-07-16 02:25:40 +00:00
|
|
|
(if (member (file-name-extension file) '("c" "m"))
|
2007-11-29 04:23:49 +00:00
|
|
|
(expand-file-name file (expand-file-name "src" source-directory))
|
2009-09-29 03:37:03 +00:00
|
|
|
(if (setq tfile (locate-library file))
|
2007-11-29 04:23:49 +00:00
|
|
|
(progn
|
|
|
|
|
(setq tfile
|
|
|
|
|
(replace-regexp-in-string "\\.elc\\'" ".el" tfile))
|
|
|
|
|
(if (and (not (file-exists-p tfile))
|
|
|
|
|
(file-exists-p (concat tfile ".gz")))
|
|
|
|
|
(concat tfile ".gz")
|
|
|
|
|
tfile))
|
|
|
|
|
(setq tfile (expand-file-name file
|
|
|
|
|
(file-name-directory basefile)))
|
|
|
|
|
(if (or (file-exists-p tfile)
|
|
|
|
|
(string-match "\\.el\\'" tfile))
|
|
|
|
|
tfile
|
|
|
|
|
(concat tfile ".el")))))
|
2016-05-18 00:48:35 -07:00
|
|
|
(setq file (file-relative-name file))
|
2007-11-29 04:23:49 +00:00
|
|
|
(if ext (concat "ext:" file)
|
|
|
|
|
file)))
|
2007-11-22 20:25:51 +00:00
|
|
|
|
2007-11-17 03:47:59 +00:00
|
|
|
(defun check-declare-scan (file)
|
|
|
|
|
"Scan FILE for `declare-function' calls.
|
2007-11-30 07:47:39 +00:00
|
|
|
Return a list with elements of the form (FNFILE FN ARGLIST FILEONLY),
|
|
|
|
|
where only the first two elements need be present. This claims that FNFILE
|
|
|
|
|
defines FN, with ARGLIST. FILEONLY non-nil means only check that FNFILE
|
|
|
|
|
exists, not that it defines FN. This is for function definitions that we
|
|
|
|
|
don't know how to recognize (e.g. some macros)."
|
2016-05-18 00:48:35 -07:00
|
|
|
(let (alist)
|
2007-11-17 03:47:59 +00:00
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert-file-contents file)
|
2009-10-01 02:02:39 +00:00
|
|
|
;; FIXME we could theoretically be inside a string.
|
|
|
|
|
(while (re-search-forward "^[ \t]*\\((declare-function\\)[ \t\n]" nil t)
|
2016-05-18 00:48:35 -07:00
|
|
|
(let ((pos (match-beginning 1)))
|
|
|
|
|
(goto-char pos)
|
|
|
|
|
(let ((form (ignore-errors (read (current-buffer))))
|
|
|
|
|
len fn formfile fnfile arglist fileonly)
|
|
|
|
|
(if (and
|
2011-05-04 23:27:24 -07:00
|
|
|
;; Exclude element of byte-compile-initial-macro-environment.
|
|
|
|
|
(or (listp (cdr form)) (setq form nil))
|
|
|
|
|
(> (setq len (length form)) 2)
|
|
|
|
|
(< len 6)
|
2016-05-18 00:48:35 -07:00
|
|
|
(setq formfile (nth 2 form))
|
2009-10-01 02:02:39 +00:00
|
|
|
(symbolp (setq fn (cadr form)))
|
|
|
|
|
(setq fn (symbol-name fn)) ; later we use as a search string
|
2016-05-18 00:48:35 -07:00
|
|
|
(stringp formfile)
|
|
|
|
|
(setq fnfile (check-declare-locate formfile file))
|
2015-05-21 10:04:45 -07:00
|
|
|
;; Use t to distinguish unspecified arglist from empty one.
|
2009-10-01 02:02:39 +00:00
|
|
|
(or (eq t (setq arglist (if (> len 3)
|
|
|
|
|
(nth 3 form)
|
|
|
|
|
t)))
|
|
|
|
|
(listp arglist))
|
|
|
|
|
(symbolp (setq fileonly (nth 4 form))))
|
2016-05-18 00:48:35 -07:00
|
|
|
(setq alist (cons (list fnfile fn arglist fileonly) alist))
|
|
|
|
|
(when form
|
|
|
|
|
(check-declare-warn file (or fn "unknown function")
|
|
|
|
|
(if (stringp formfile) formfile
|
|
|
|
|
"unknown file")
|
|
|
|
|
"Malformed declaration"
|
|
|
|
|
(line-number-at-pos pos))))))))
|
2007-11-17 03:47:59 +00:00
|
|
|
alist))
|
|
|
|
|
|
|
|
|
|
(autoload 'byte-compile-arglist-signature "bytecomp")
|
|
|
|
|
|
2015-02-13 14:34:17 +01:00
|
|
|
(defgroup check-declare nil
|
|
|
|
|
"Check declare-function statements."
|
|
|
|
|
:group 'tools)
|
|
|
|
|
|
|
|
|
|
(defcustom check-declare-ext-errors nil
|
2015-03-03 15:10:05 -08:00
|
|
|
"When non-nil, warn about functions not found in :ext."
|
2016-01-12 20:06:49 -05:00
|
|
|
:version "25.1"
|
2015-02-13 14:34:17 +01:00
|
|
|
:type 'boolean)
|
|
|
|
|
|
2007-11-17 03:47:59 +00:00
|
|
|
(defun check-declare-verify (fnfile fnlist)
|
|
|
|
|
"Check that FNFILE contains function definitions matching FNLIST.
|
2007-11-30 07:47:39 +00:00
|
|
|
Each element of FNLIST has the form (FILE FN ARGLIST FILEONLY), where
|
|
|
|
|
only the first two elements need be present. This means FILE claimed FN
|
|
|
|
|
was defined in FNFILE with the specified ARGLIST. FILEONLY non-nil means
|
|
|
|
|
to only check that FNFILE exists, not that it actually defines FN.
|
|
|
|
|
|
|
|
|
|
Returns nil if all claims are found to be true, otherwise a list
|
|
|
|
|
of errors with elements of the form \(FILE FN TYPE), where TYPE
|
|
|
|
|
is a string giving details of the error."
|
2016-05-18 00:48:35 -07:00
|
|
|
(let ((cflag (member (file-name-extension fnfile) '("c" "m")))
|
2007-11-29 04:23:49 +00:00
|
|
|
(ext (string-match "^ext:" fnfile))
|
2007-11-22 06:20:53 +00:00
|
|
|
re fn sig siglist arglist type errlist minargs maxargs)
|
2007-11-29 04:23:49 +00:00
|
|
|
(if ext
|
|
|
|
|
(setq fnfile (substring fnfile 4)))
|
2009-10-01 02:02:39 +00:00
|
|
|
(if (file-regular-p fnfile)
|
2007-11-22 04:19:48 +00:00
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert-file-contents fnfile)
|
|
|
|
|
;; defsubst's don't _have_ to be known at compile time.
|
|
|
|
|
(setq re (format (if cflag
|
|
|
|
|
"^[ \t]*\\(DEFUN\\)[ \t]*([ \t]*\"%s\""
|
2007-12-11 05:52:07 +00:00
|
|
|
"^[ \t]*(\\(fset[ \t]+'\\|\
|
2015-05-04 20:17:35 -04:00
|
|
|
cl-def\\(?:generic\\|method\\)\\|\
|
2009-09-29 04:12:46 +00:00
|
|
|
def\\(?:un\\|subst\\|foo\\|method\\|class\\|\
|
|
|
|
|
ine-\\(?:derived\\|generic\\|\\(?:global\\(?:ized\\)?-\\)?minor\\)-mode\\|\
|
|
|
|
|
\\(?:ine-obsolete-function-\\)?alias[ \t]+'\\|\
|
|
|
|
|
ine-overloadable-function\\)\\)\
|
2015-09-17 16:08:20 -07:00
|
|
|
[ \t]*%s\\([ \t;]+\\|$\\)")
|
2007-11-22 04:19:48 +00:00
|
|
|
(regexp-opt (mapcar 'cadr fnlist) t)))
|
|
|
|
|
(while (re-search-forward re nil t)
|
|
|
|
|
(skip-chars-forward " \t\n")
|
|
|
|
|
(setq fn (match-string 2)
|
2007-11-27 03:54:47 +00:00
|
|
|
type (match-string 1)
|
2007-11-22 04:19:48 +00:00
|
|
|
;; (min . max) for a fixed number of arguments, or
|
|
|
|
|
;; arglists with optional elements.
|
|
|
|
|
;; (min) for arglists with &rest.
|
2007-11-22 06:53:24 +00:00
|
|
|
;; sig = 'err means we could not find an arglist.
|
2007-11-22 06:20:53 +00:00
|
|
|
sig (cond (cflag
|
2007-11-22 06:53:24 +00:00
|
|
|
(or
|
2009-09-29 03:37:03 +00:00
|
|
|
(when (search-forward "," nil t 3)
|
2007-11-22 06:53:24 +00:00
|
|
|
(skip-chars-forward " \t\n")
|
|
|
|
|
;; Assuming minargs and maxargs on same line.
|
|
|
|
|
(when (looking-at "\\([0-9]+\\)[ \t]*,[ \t]*\
|
2007-11-22 06:20:53 +00:00
|
|
|
\\([0-9]+\\|MANY\\|UNEVALLED\\)")
|
2007-11-22 06:53:24 +00:00
|
|
|
(setq minargs (string-to-number
|
|
|
|
|
(match-string 1))
|
|
|
|
|
maxargs (match-string 2))
|
|
|
|
|
(cons minargs (unless (string-match "[^0-9]"
|
|
|
|
|
maxargs)
|
|
|
|
|
(string-to-number
|
|
|
|
|
maxargs)))))
|
|
|
|
|
'err))
|
2007-11-27 03:54:47 +00:00
|
|
|
((string-match
|
|
|
|
|
"\\`define-\\(derived\\|generic\\)-mode\\'"
|
|
|
|
|
type)
|
2007-11-22 04:19:48 +00:00
|
|
|
'(0 . 0))
|
2007-11-27 03:54:47 +00:00
|
|
|
((string-match
|
|
|
|
|
"\\`define\\(-global\\(ized\\)?\\)?-minor-mode\\'"
|
|
|
|
|
type)
|
2007-11-22 04:19:48 +00:00
|
|
|
'(0 . 1))
|
2007-11-27 03:54:47 +00:00
|
|
|
;; Prompt to update.
|
|
|
|
|
((string-match
|
|
|
|
|
"\\`define-obsolete-function-alias\\>"
|
|
|
|
|
type)
|
|
|
|
|
'obsolete)
|
2007-11-28 03:53:44 +00:00
|
|
|
;; Can't easily check arguments in these cases.
|
2015-05-04 20:17:35 -04:00
|
|
|
((string-match "\\`\\(def\\(alias\\|class\\)\\|\
|
|
|
|
|
fset\\|\\(?:cl-\\)?defmethod\\)\\>" type)
|
2007-11-22 04:19:48 +00:00
|
|
|
t)
|
2007-11-22 06:53:24 +00:00
|
|
|
((looking-at "\\((\\|nil\\)")
|
|
|
|
|
(byte-compile-arglist-signature
|
|
|
|
|
(read (current-buffer))))
|
2007-11-22 04:19:48 +00:00
|
|
|
(t
|
2007-11-22 06:53:24 +00:00
|
|
|
'err))
|
2007-11-22 04:19:48 +00:00
|
|
|
;; alist of functions and arglist signatures.
|
|
|
|
|
siglist (cons (cons fn sig) siglist)))))
|
|
|
|
|
(dolist (e fnlist)
|
|
|
|
|
(setq arglist (nth 2 e)
|
|
|
|
|
type
|
2007-11-27 03:54:47 +00:00
|
|
|
(if (not re)
|
2016-05-18 00:48:35 -07:00
|
|
|
(when (or check-declare-ext-errors (not ext))
|
|
|
|
|
"file not found")
|
2007-11-27 03:54:47 +00:00
|
|
|
(if (not (setq sig (assoc (cadr e) siglist)))
|
2007-11-30 07:47:39 +00:00
|
|
|
(unless (nth 3 e) ; fileonly
|
|
|
|
|
"function not found")
|
2007-11-27 03:54:47 +00:00
|
|
|
(setq sig (cdr sig))
|
|
|
|
|
(cond ((eq sig 'obsolete) ; check even when no arglist specified
|
|
|
|
|
"obsolete alias")
|
|
|
|
|
;; arglist t means no arglist specified, as
|
|
|
|
|
;; opposed to an empty arglist.
|
|
|
|
|
((eq arglist t) nil)
|
2007-11-28 03:53:44 +00:00
|
|
|
((eq sig t) nil) ; eg defalias - can't check arguments
|
2007-11-27 03:54:47 +00:00
|
|
|
((eq sig 'err)
|
|
|
|
|
"arglist not found") ; internal error
|
|
|
|
|
((not (equal (byte-compile-arglist-signature
|
|
|
|
|
arglist)
|
|
|
|
|
sig))
|
|
|
|
|
"arglist mismatch")))))
|
2007-11-22 04:19:48 +00:00
|
|
|
(when type
|
|
|
|
|
(setq errlist (cons (list (car e) (cadr e) type) errlist))))
|
|
|
|
|
errlist))
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
(defun check-declare-sort (alist)
|
|
|
|
|
"Sort a list with elements FILE (FNFILE ...).
|
|
|
|
|
Returned list has elements FNFILE (FILE ...)."
|
|
|
|
|
(let (file fnfile rest sort a)
|
|
|
|
|
(dolist (e alist)
|
|
|
|
|
(setq file (car e))
|
|
|
|
|
(dolist (f (cdr e))
|
|
|
|
|
(setq fnfile (car f)
|
|
|
|
|
rest (cdr f))
|
|
|
|
|
(if (setq a (assoc fnfile sort))
|
|
|
|
|
(setcdr a (append (cdr a) (list (cons file rest))))
|
|
|
|
|
(setq sort (cons (list fnfile (cons file rest)) sort)))))
|
|
|
|
|
sort))
|
|
|
|
|
|
2016-05-18 00:48:35 -07:00
|
|
|
(defun check-declare-warn (file fn fnfile type &optional line)
|
2007-11-17 03:47:59 +00:00
|
|
|
"Warn that FILE made a false claim about FN in FNFILE.
|
2016-05-18 00:48:35 -07:00
|
|
|
TYPE is a string giving the nature of the error.
|
|
|
|
|
Optional LINE is the claim's line number; otherwise, search for the claim.
|
|
|
|
|
Display warning in `check-declare-warning-buffer'."
|
2015-02-13 14:59:31 +01:00
|
|
|
(let ((warning-prefix-function
|
|
|
|
|
(lambda (level entry)
|
2016-05-18 00:48:35 -07:00
|
|
|
(insert (format "%s:%d:" (file-relative-name file) (or line 0)))
|
2015-02-13 14:59:31 +01:00
|
|
|
entry))
|
|
|
|
|
(warning-fill-prefix " "))
|
2016-05-18 00:48:35 -07:00
|
|
|
(unless line
|
|
|
|
|
(with-current-buffer (find-file-noselect file)
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(when (and (not line)
|
|
|
|
|
(re-search-forward
|
|
|
|
|
(format "(declare-function[ \t\n]+%s" fn) nil t))
|
|
|
|
|
(goto-char (match-beginning 0))
|
|
|
|
|
(setq line (line-number-at-pos)))))
|
2015-02-13 14:59:31 +01:00
|
|
|
(display-warning 'check-declare
|
Go back to grave quoting in source-code docstrings etc.
This reverts almost all my recent changes to use curved quotes
in docstrings and/or strings used for error diagnostics.
There are a few exceptions, e.g., Bahá’í proper names.
* admin/unidata/unidata-gen.el (unidata-gen-table):
* lisp/abbrev.el (expand-region-abbrevs):
* lisp/align.el (align-region):
* lisp/allout.el (allout-mode, allout-solicit-alternate-bullet)
(outlineify-sticky):
* lisp/apropos.el (apropos-library):
* lisp/bookmark.el (bookmark-default-annotation-text):
* lisp/button.el (button-category-symbol, button-put)
(make-text-button):
* lisp/calc/calc-aent.el (math-read-if, math-read-factor):
* lisp/calc/calc-embed.el (calc-do-embedded):
* lisp/calc/calc-ext.el (calc-user-function-list):
* lisp/calc/calc-graph.el (calc-graph-show-dumb):
* lisp/calc/calc-help.el (calc-describe-key)
(calc-describe-thing, calc-full-help):
* lisp/calc/calc-lang.el (calc-c-language)
(math-parse-fortran-vector-end, math-parse-tex-sum)
(math-parse-eqn-matrix, math-parse-eqn-prime)
(calc-yacas-language, calc-maxima-language, calc-giac-language)
(math-read-giac-subscr, math-read-math-subscr)
(math-read-big-rec, math-read-big-balance):
* lisp/calc/calc-misc.el (calc-help, report-calc-bug):
* lisp/calc/calc-mode.el (calc-auto-why, calc-save-modes)
(calc-auto-recompute):
* lisp/calc/calc-prog.el (calc-fix-token-name)
(calc-read-parse-table-part, calc-user-define-invocation)
(math-do-arg-check):
* lisp/calc/calc-store.el (calc-edit-variable):
* lisp/calc/calc-units.el (math-build-units-table-buffer):
* lisp/calc/calc-vec.el (math-read-brackets):
* lisp/calc/calc-yank.el (calc-edit-mode):
* lisp/calc/calc.el (calc, calc-do, calc-user-invocation):
* lisp/calendar/appt.el (appt-display-message):
* lisp/calendar/diary-lib.el (diary-check-diary-file)
(diary-mail-entries, diary-from-outlook):
* lisp/calendar/icalendar.el (icalendar-export-region)
(icalendar--convert-float-to-ical)
(icalendar--convert-date-to-ical)
(icalendar--convert-ical-to-diary)
(icalendar--convert-recurring-to-diary)
(icalendar--add-diary-entry):
* lisp/calendar/time-date.el (format-seconds):
* lisp/calendar/timeclock.el (timeclock-mode-line-display)
(timeclock-make-hours-explicit, timeclock-log-data):
* lisp/calendar/todo-mode.el (todo-prefix, todo-delete-category)
(todo-item-mark, todo-check-format)
(todo-insert-item--next-param, todo-edit-item--next-key)
(todo-mode):
* lisp/cedet/ede/pmake.el (ede-proj-makefile-insert-dist-rules):
* lisp/cedet/mode-local.el (describe-mode-local-overload)
(mode-local-print-binding, mode-local-describe-bindings-2):
* lisp/cedet/semantic/complete.el (semantic-displayor-show-request):
* lisp/cedet/srecode/srt-mode.el (srecode-macro-help):
* lisp/cus-start.el (standard):
* lisp/cus-theme.el (describe-theme-1):
* lisp/custom.el (custom-add-dependencies, custom-check-theme)
(custom--sort-vars-1, load-theme):
* lisp/descr-text.el (describe-text-properties-1, describe-char):
* lisp/dired-x.el (dired-do-run-mail):
* lisp/dired.el (dired-log):
* lisp/emacs-lisp/advice.el (ad-read-advised-function)
(ad-read-advice-class, ad-read-advice-name, ad-enable-advice)
(ad-disable-advice, ad-remove-advice, ad-set-argument)
(ad-set-arguments, ad--defalias-fset, ad-activate)
(ad-deactivate):
* lisp/emacs-lisp/byte-opt.el (byte-compile-inline-expand)
(byte-compile-unfold-lambda, byte-optimize-form-code-walker)
(byte-optimize-while, byte-optimize-apply):
* lisp/emacs-lisp/byte-run.el (defun, defsubst):
* lisp/emacs-lisp/bytecomp.el (byte-compile-lapcode)
(byte-compile-log-file, byte-compile-format-warn)
(byte-compile-nogroup-warn, byte-compile-arglist-warn)
(byte-compile-cl-warn)
(byte-compile-warn-about-unresolved-functions)
(byte-compile-file, byte-compile--declare-var)
(byte-compile-file-form-defmumble, byte-compile-form)
(byte-compile-normal-call, byte-compile-check-variable)
(byte-compile-variable-ref, byte-compile-variable-set)
(byte-compile-subr-wrong-args, byte-compile-setq-default)
(byte-compile-negation-optimizer)
(byte-compile-condition-case--old)
(byte-compile-condition-case--new, byte-compile-save-excursion)
(byte-compile-defvar, byte-compile-autoload)
(byte-compile-lambda-form)
(byte-compile-make-variable-buffer-local, display-call-tree)
(batch-byte-compile):
* lisp/emacs-lisp/cconv.el (cconv-convert, cconv--analyze-use):
* lisp/emacs-lisp/chart.el (chart-space-usage):
* lisp/emacs-lisp/check-declare.el (check-declare-scan)
(check-declare-warn, check-declare-file)
(check-declare-directory):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine)
(checkdoc-message-text-engine):
* lisp/emacs-lisp/cl-extra.el (cl-parse-integer)
(cl--describe-class):
* lisp/emacs-lisp/cl-generic.el (cl-defgeneric)
(cl--generic-describe, cl-generic-generalizers):
* lisp/emacs-lisp/cl-macs.el (cl--parse-loop-clause, cl-tagbody)
(cl-symbol-macrolet):
* lisp/emacs-lisp/cl.el (cl-unload-function, flet):
* lisp/emacs-lisp/copyright.el (copyright)
(copyright-update-directory):
* lisp/emacs-lisp/edebug.el (edebug-read-list):
* lisp/emacs-lisp/eieio-base.el (eieio-persistent-read):
* lisp/emacs-lisp/eieio-core.el (eieio--slot-override)
(eieio-oref):
* lisp/emacs-lisp/eieio-opt.el (eieio-help-constructor):
* lisp/emacs-lisp/eieio-speedbar.el:
(eieio-speedbar-child-make-tag-lines)
(eieio-speedbar-child-description):
* lisp/emacs-lisp/eieio.el (defclass, change-class):
* lisp/emacs-lisp/elint.el (elint-file, elint-get-top-forms)
(elint-init-form, elint-check-defalias-form)
(elint-check-let-form):
* lisp/emacs-lisp/ert.el (ert-get-test, ert-results-mode-menu)
(ert-results-pop-to-backtrace-for-test-at-point)
(ert-results-pop-to-messages-for-test-at-point)
(ert-results-pop-to-should-forms-for-test-at-point)
(ert-describe-test):
* lisp/emacs-lisp/find-func.el (find-function-search-for-symbol)
(find-function-library):
* lisp/emacs-lisp/generator.el (iter-yield):
* lisp/emacs-lisp/gv.el (gv-define-simple-setter):
* lisp/emacs-lisp/lisp-mnt.el (lm-verify):
* lisp/emacs-lisp/macroexp.el (macroexp--obsolete-warning):
* lisp/emacs-lisp/map-ynp.el (map-y-or-n-p):
* lisp/emacs-lisp/nadvice.el (advice--make-docstring)
(advice--make, define-advice):
* lisp/emacs-lisp/package-x.el (package-upload-file):
* lisp/emacs-lisp/package.el (package-version-join)
(package-disabled-p, package-activate-1, package-activate)
(package--download-one-archive)
(package--download-and-read-archives)
(package-compute-transaction, package-install-from-archive)
(package-install, package-install-selected-packages)
(package-delete, package-autoremove, describe-package-1)
(package-install-button-action, package-delete-button-action)
(package-menu-hide-package, package-menu--list-to-prompt)
(package-menu--perform-transaction)
(package-menu--find-and-notify-upgrades):
* lisp/emacs-lisp/pcase.el (pcase-exhaustive, pcase--u1):
* lisp/emacs-lisp/re-builder.el (reb-enter-subexp-mode):
* lisp/emacs-lisp/ring.el (ring-previous, ring-next):
* lisp/emacs-lisp/rx.el (rx-check, rx-anything)
(rx-check-any-string, rx-check-any, rx-check-not, rx-=)
(rx-repeat, rx-check-backref, rx-syntax, rx-check-category)
(rx-form):
* lisp/emacs-lisp/smie.el (smie-config-save):
* lisp/emacs-lisp/subr-x.el (internal--check-binding):
* lisp/emacs-lisp/tabulated-list.el (tabulated-list-put-tag):
* lisp/emacs-lisp/testcover.el (testcover-1value):
* lisp/emacs-lisp/timer.el (timer-event-handler):
* lisp/emulation/viper-cmd.el (viper-toggle-parse-sexp-ignore-comments)
(viper-toggle-search-style, viper-kill-buffer)
(viper-brac-function):
* lisp/emulation/viper-macs.el (viper-record-kbd-macro):
* lisp/env.el (setenv):
* lisp/erc/erc-button.el (erc-nick-popup):
* lisp/erc/erc.el (erc-cmd-LOAD, erc-handle-login, english):
* lisp/eshell/em-dirs.el (eshell/cd):
* lisp/eshell/em-glob.el (eshell-glob-regexp)
(eshell-glob-entries):
* lisp/eshell/em-pred.el (eshell-parse-modifiers):
* lisp/eshell/esh-opt.el (eshell-show-usage):
* lisp/facemenu.el (facemenu-add-new-face)
(facemenu-add-new-color):
* lisp/faces.el (read-face-name, read-face-font, describe-face)
(x-resolve-font-name):
* lisp/files-x.el (modify-file-local-variable):
* lisp/files.el (locate-user-emacs-file, find-alternate-file)
(set-auto-mode, hack-one-local-variable--obsolete)
(dir-locals-set-directory-class, write-file, basic-save-buffer)
(delete-directory, copy-directory, recover-session)
(recover-session-finish, insert-directory)
(file-modes-char-to-who, file-modes-symbolic-to-number)
(move-file-to-trash):
* lisp/filesets.el (filesets-add-buffer, filesets-remove-buffer):
* lisp/find-cmd.el (find-generic, find-to-string):
* lisp/finder.el (finder-commentary):
* lisp/font-lock.el (font-lock-fontify-buffer):
* lisp/format.el (format-write-file, format-find-file)
(format-insert-file):
* lisp/frame.el (get-device-terminal, select-frame-by-name):
* lisp/fringe.el (fringe--check-style):
* lisp/gnus/nnmairix.el (nnmairix-widget-create-query):
* lisp/help-fns.el (help-fns--key-bindings)
(help-fns--compiler-macro, help-fns--parent-mode)
(help-fns--obsolete, help-fns--interactive-only)
(describe-function-1, describe-variable):
* lisp/help.el (describe-mode)
(describe-minor-mode-from-indicator):
* lisp/image.el (image-type):
* lisp/international/ccl.el (ccl-dump):
* lisp/international/fontset.el (x-must-resolve-font-name):
* lisp/international/mule-cmds.el (prefer-coding-system)
(select-safe-coding-system-interactively)
(select-safe-coding-system, activate-input-method)
(toggle-input-method, describe-current-input-method)
(describe-language-environment):
* lisp/international/mule-conf.el (code-offset):
* lisp/international/mule-diag.el (describe-character-set)
(list-input-methods-1):
* lisp/mail/feedmail.el (feedmail-run-the-queue):
* lisp/mouse.el (minor-mode-menu-from-indicator):
* lisp/mpc.el (mpc-playlist-rename):
* lisp/msb.el (msb--choose-menu):
* lisp/net/ange-ftp.el (ange-ftp-shell-command):
* lisp/net/imap.el (imap-interactive-login):
* lisp/net/mairix.el (mairix-widget-create-query):
* lisp/net/newst-backend.el (newsticker--sentinel-work):
* lisp/net/newst-treeview.el (newsticker--treeview-load):
* lisp/net/rlogin.el (rlogin):
* lisp/obsolete/iswitchb.el (iswitchb-possible-new-buffer):
* lisp/obsolete/otodo-mode.el (todo-more-important-p):
* lisp/obsolete/pgg-gpg.el (pgg-gpg-process-region):
* lisp/obsolete/pgg-pgp.el (pgg-pgp-process-region):
* lisp/obsolete/pgg-pgp5.el (pgg-pgp5-process-region):
* lisp/org/ob-core.el (org-babel-goto-named-src-block)
(org-babel-goto-named-result):
* lisp/org/ob-fortran.el (org-babel-fortran-ensure-main-wrap):
* lisp/org/ob-ref.el (org-babel-ref-resolve):
* lisp/org/org-agenda.el (org-agenda-prepare):
* lisp/org/org-clock.el (org-clock-notify-once-if-expired)
(org-clock-resolve):
* lisp/org/org-ctags.el (org-ctags-ask-rebuild-tags-file-then-find-tag):
* lisp/org/org-feed.el (org-feed-parse-atom-entry):
* lisp/org/org-habit.el (org-habit-parse-todo):
* lisp/org/org-mouse.el (org-mouse-popup-global-menu)
(org-mouse-context-menu):
* lisp/org/org-table.el (org-table-edit-formulas):
* lisp/org/ox.el (org-export-async-start):
* lisp/proced.el (proced-log):
* lisp/progmodes/ada-mode.el (ada-get-indent-case)
(ada-check-matching-start, ada-goto-matching-start):
* lisp/progmodes/ada-prj.el (ada-prj-display-page):
* lisp/progmodes/ada-xref.el (ada-find-executable):
* lisp/progmodes/ebrowse.el (ebrowse-tags-apropos):
* lisp/progmodes/etags.el (etags-tags-apropos-additional):
* lisp/progmodes/flymake.el (flymake-parse-err-lines)
(flymake-start-syntax-check-process):
* lisp/progmodes/python.el (python-shell-get-process-or-error)
(python-define-auxiliary-skeleton):
* lisp/progmodes/sql.el (sql-comint):
* lisp/progmodes/verilog-mode.el (verilog-load-file-at-point):
* lisp/progmodes/vhdl-mode.el (vhdl-widget-directory-validate):
* lisp/recentf.el (recentf-open-files):
* lisp/replace.el (query-replace-read-from)
(occur-after-change-function, occur-1):
* lisp/scroll-bar.el (scroll-bar-columns):
* lisp/server.el (server-get-auth-key):
* lisp/simple.el (execute-extended-command)
(undo-outer-limit-truncate, list-processes--refresh)
(compose-mail, set-variable, choose-completion-string)
(define-alternatives):
* lisp/startup.el (site-run-file, tty-handle-args, command-line)
(command-line-1):
* lisp/subr.el (noreturn, define-error, add-to-list)
(read-char-choice, version-to-list):
* lisp/term/common-win.el (x-handle-xrm-switch)
(x-handle-name-switch, x-handle-args):
* lisp/term/x-win.el (x-handle-parent-id, x-handle-smid):
* lisp/textmodes/reftex-ref.el (reftex-label):
* lisp/textmodes/reftex-toc.el (reftex-toc-rename-label):
* lisp/textmodes/two-column.el (2C-split):
* lisp/tutorial.el (tutorial--describe-nonstandard-key)
(tutorial--find-changed-keys):
* lisp/type-break.el (type-break-noninteractive-query):
* lisp/wdired.el (wdired-do-renames, wdired-do-symlink-changes)
(wdired-do-perm-changes):
* lisp/whitespace.el (whitespace-report-region):
Prefer grave quoting in source-code strings used to generate help
and diagnostics.
* lisp/faces.el (face-documentation):
No need to convert quotes, since the result is a docstring.
* lisp/info.el (Info-virtual-index-find-node)
(Info-virtual-index, info-apropos):
Simplify by generating only curved quotes, since info files are
typically that ways nowadays anyway.
* lisp/international/mule-diag.el (list-input-methods):
Don’t assume text quoting style is curved.
* lisp/org/org-bibtex.el (org-bibtex-fields):
Revert my recent changes, going back to the old quoting style.
2015-09-07 08:41:44 -07:00
|
|
|
(format-message "said `%s' was defined in %s: %s"
|
2016-05-18 00:48:35 -07:00
|
|
|
fn (file-relative-name fnfile) type)
|
2015-02-13 14:59:31 +01:00
|
|
|
nil check-declare-warning-buffer)))
|
2007-11-17 03:47:59 +00:00
|
|
|
|
2015-04-30 20:09:02 -04:00
|
|
|
(declare-function compilation-forget-errors "compile" ())
|
|
|
|
|
|
2007-11-17 03:47:59 +00:00
|
|
|
(defun check-declare-files (&rest files)
|
|
|
|
|
"Check veracity of all `declare-function' statements in FILES.
|
|
|
|
|
Return a list of any errors found."
|
2016-05-18 00:48:35 -07:00
|
|
|
(if (get-buffer check-declare-warning-buffer)
|
|
|
|
|
(kill-buffer check-declare-warning-buffer))
|
|
|
|
|
(let ((buf (get-buffer-create check-declare-warning-buffer))
|
|
|
|
|
alist err errlist)
|
|
|
|
|
(with-current-buffer buf
|
|
|
|
|
(unless (derived-mode-p 'compilation-mode)
|
|
|
|
|
(compilation-mode))
|
|
|
|
|
(setq mode-line-process
|
|
|
|
|
'(:propertize ":run" face compilation-mode-line-run))
|
|
|
|
|
(let ((inhibit-read-only t))
|
|
|
|
|
(insert "\f\n"))
|
|
|
|
|
(compilation-forget-errors))
|
2007-11-17 03:47:59 +00:00
|
|
|
(dolist (file files)
|
|
|
|
|
(setq alist (cons (cons file (check-declare-scan file)) alist)))
|
|
|
|
|
;; Sort so that things are ordered by the files supposed to
|
|
|
|
|
;; contain the defuns.
|
|
|
|
|
(dolist (e (check-declare-sort alist))
|
|
|
|
|
(if (setq err (check-declare-verify (car e) (cdr e)))
|
|
|
|
|
(setq errlist (cons (cons (car e) err) errlist))))
|
2015-02-13 14:59:31 +01:00
|
|
|
(setq errlist (nreverse errlist))
|
2007-11-17 03:47:59 +00:00
|
|
|
;; Sort back again so that errors are ordered by the files
|
|
|
|
|
;; containing the declare-function statements.
|
|
|
|
|
(dolist (e (check-declare-sort errlist))
|
2015-02-13 14:59:31 +01:00
|
|
|
(dolist (f (cdr e))
|
|
|
|
|
(check-declare-warn (car e) (cadr f) (car f) (nth 2 f))))
|
2016-05-18 00:48:35 -07:00
|
|
|
(with-current-buffer buf
|
|
|
|
|
(setq mode-line-process
|
|
|
|
|
'(:propertize ":exit" face compilation-mode-line-run))
|
|
|
|
|
(force-mode-line-update))
|
2007-11-17 03:47:59 +00:00
|
|
|
errlist))
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun check-declare-file (file)
|
|
|
|
|
"Check veracity of all `declare-function' statements in FILE.
|
|
|
|
|
See `check-declare-directory' for more information."
|
|
|
|
|
(interactive "fFile to check: ")
|
|
|
|
|
(or (file-exists-p file)
|
Go back to grave quoting in source-code docstrings etc.
This reverts almost all my recent changes to use curved quotes
in docstrings and/or strings used for error diagnostics.
There are a few exceptions, e.g., Bahá’í proper names.
* admin/unidata/unidata-gen.el (unidata-gen-table):
* lisp/abbrev.el (expand-region-abbrevs):
* lisp/align.el (align-region):
* lisp/allout.el (allout-mode, allout-solicit-alternate-bullet)
(outlineify-sticky):
* lisp/apropos.el (apropos-library):
* lisp/bookmark.el (bookmark-default-annotation-text):
* lisp/button.el (button-category-symbol, button-put)
(make-text-button):
* lisp/calc/calc-aent.el (math-read-if, math-read-factor):
* lisp/calc/calc-embed.el (calc-do-embedded):
* lisp/calc/calc-ext.el (calc-user-function-list):
* lisp/calc/calc-graph.el (calc-graph-show-dumb):
* lisp/calc/calc-help.el (calc-describe-key)
(calc-describe-thing, calc-full-help):
* lisp/calc/calc-lang.el (calc-c-language)
(math-parse-fortran-vector-end, math-parse-tex-sum)
(math-parse-eqn-matrix, math-parse-eqn-prime)
(calc-yacas-language, calc-maxima-language, calc-giac-language)
(math-read-giac-subscr, math-read-math-subscr)
(math-read-big-rec, math-read-big-balance):
* lisp/calc/calc-misc.el (calc-help, report-calc-bug):
* lisp/calc/calc-mode.el (calc-auto-why, calc-save-modes)
(calc-auto-recompute):
* lisp/calc/calc-prog.el (calc-fix-token-name)
(calc-read-parse-table-part, calc-user-define-invocation)
(math-do-arg-check):
* lisp/calc/calc-store.el (calc-edit-variable):
* lisp/calc/calc-units.el (math-build-units-table-buffer):
* lisp/calc/calc-vec.el (math-read-brackets):
* lisp/calc/calc-yank.el (calc-edit-mode):
* lisp/calc/calc.el (calc, calc-do, calc-user-invocation):
* lisp/calendar/appt.el (appt-display-message):
* lisp/calendar/diary-lib.el (diary-check-diary-file)
(diary-mail-entries, diary-from-outlook):
* lisp/calendar/icalendar.el (icalendar-export-region)
(icalendar--convert-float-to-ical)
(icalendar--convert-date-to-ical)
(icalendar--convert-ical-to-diary)
(icalendar--convert-recurring-to-diary)
(icalendar--add-diary-entry):
* lisp/calendar/time-date.el (format-seconds):
* lisp/calendar/timeclock.el (timeclock-mode-line-display)
(timeclock-make-hours-explicit, timeclock-log-data):
* lisp/calendar/todo-mode.el (todo-prefix, todo-delete-category)
(todo-item-mark, todo-check-format)
(todo-insert-item--next-param, todo-edit-item--next-key)
(todo-mode):
* lisp/cedet/ede/pmake.el (ede-proj-makefile-insert-dist-rules):
* lisp/cedet/mode-local.el (describe-mode-local-overload)
(mode-local-print-binding, mode-local-describe-bindings-2):
* lisp/cedet/semantic/complete.el (semantic-displayor-show-request):
* lisp/cedet/srecode/srt-mode.el (srecode-macro-help):
* lisp/cus-start.el (standard):
* lisp/cus-theme.el (describe-theme-1):
* lisp/custom.el (custom-add-dependencies, custom-check-theme)
(custom--sort-vars-1, load-theme):
* lisp/descr-text.el (describe-text-properties-1, describe-char):
* lisp/dired-x.el (dired-do-run-mail):
* lisp/dired.el (dired-log):
* lisp/emacs-lisp/advice.el (ad-read-advised-function)
(ad-read-advice-class, ad-read-advice-name, ad-enable-advice)
(ad-disable-advice, ad-remove-advice, ad-set-argument)
(ad-set-arguments, ad--defalias-fset, ad-activate)
(ad-deactivate):
* lisp/emacs-lisp/byte-opt.el (byte-compile-inline-expand)
(byte-compile-unfold-lambda, byte-optimize-form-code-walker)
(byte-optimize-while, byte-optimize-apply):
* lisp/emacs-lisp/byte-run.el (defun, defsubst):
* lisp/emacs-lisp/bytecomp.el (byte-compile-lapcode)
(byte-compile-log-file, byte-compile-format-warn)
(byte-compile-nogroup-warn, byte-compile-arglist-warn)
(byte-compile-cl-warn)
(byte-compile-warn-about-unresolved-functions)
(byte-compile-file, byte-compile--declare-var)
(byte-compile-file-form-defmumble, byte-compile-form)
(byte-compile-normal-call, byte-compile-check-variable)
(byte-compile-variable-ref, byte-compile-variable-set)
(byte-compile-subr-wrong-args, byte-compile-setq-default)
(byte-compile-negation-optimizer)
(byte-compile-condition-case--old)
(byte-compile-condition-case--new, byte-compile-save-excursion)
(byte-compile-defvar, byte-compile-autoload)
(byte-compile-lambda-form)
(byte-compile-make-variable-buffer-local, display-call-tree)
(batch-byte-compile):
* lisp/emacs-lisp/cconv.el (cconv-convert, cconv--analyze-use):
* lisp/emacs-lisp/chart.el (chart-space-usage):
* lisp/emacs-lisp/check-declare.el (check-declare-scan)
(check-declare-warn, check-declare-file)
(check-declare-directory):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine)
(checkdoc-message-text-engine):
* lisp/emacs-lisp/cl-extra.el (cl-parse-integer)
(cl--describe-class):
* lisp/emacs-lisp/cl-generic.el (cl-defgeneric)
(cl--generic-describe, cl-generic-generalizers):
* lisp/emacs-lisp/cl-macs.el (cl--parse-loop-clause, cl-tagbody)
(cl-symbol-macrolet):
* lisp/emacs-lisp/cl.el (cl-unload-function, flet):
* lisp/emacs-lisp/copyright.el (copyright)
(copyright-update-directory):
* lisp/emacs-lisp/edebug.el (edebug-read-list):
* lisp/emacs-lisp/eieio-base.el (eieio-persistent-read):
* lisp/emacs-lisp/eieio-core.el (eieio--slot-override)
(eieio-oref):
* lisp/emacs-lisp/eieio-opt.el (eieio-help-constructor):
* lisp/emacs-lisp/eieio-speedbar.el:
(eieio-speedbar-child-make-tag-lines)
(eieio-speedbar-child-description):
* lisp/emacs-lisp/eieio.el (defclass, change-class):
* lisp/emacs-lisp/elint.el (elint-file, elint-get-top-forms)
(elint-init-form, elint-check-defalias-form)
(elint-check-let-form):
* lisp/emacs-lisp/ert.el (ert-get-test, ert-results-mode-menu)
(ert-results-pop-to-backtrace-for-test-at-point)
(ert-results-pop-to-messages-for-test-at-point)
(ert-results-pop-to-should-forms-for-test-at-point)
(ert-describe-test):
* lisp/emacs-lisp/find-func.el (find-function-search-for-symbol)
(find-function-library):
* lisp/emacs-lisp/generator.el (iter-yield):
* lisp/emacs-lisp/gv.el (gv-define-simple-setter):
* lisp/emacs-lisp/lisp-mnt.el (lm-verify):
* lisp/emacs-lisp/macroexp.el (macroexp--obsolete-warning):
* lisp/emacs-lisp/map-ynp.el (map-y-or-n-p):
* lisp/emacs-lisp/nadvice.el (advice--make-docstring)
(advice--make, define-advice):
* lisp/emacs-lisp/package-x.el (package-upload-file):
* lisp/emacs-lisp/package.el (package-version-join)
(package-disabled-p, package-activate-1, package-activate)
(package--download-one-archive)
(package--download-and-read-archives)
(package-compute-transaction, package-install-from-archive)
(package-install, package-install-selected-packages)
(package-delete, package-autoremove, describe-package-1)
(package-install-button-action, package-delete-button-action)
(package-menu-hide-package, package-menu--list-to-prompt)
(package-menu--perform-transaction)
(package-menu--find-and-notify-upgrades):
* lisp/emacs-lisp/pcase.el (pcase-exhaustive, pcase--u1):
* lisp/emacs-lisp/re-builder.el (reb-enter-subexp-mode):
* lisp/emacs-lisp/ring.el (ring-previous, ring-next):
* lisp/emacs-lisp/rx.el (rx-check, rx-anything)
(rx-check-any-string, rx-check-any, rx-check-not, rx-=)
(rx-repeat, rx-check-backref, rx-syntax, rx-check-category)
(rx-form):
* lisp/emacs-lisp/smie.el (smie-config-save):
* lisp/emacs-lisp/subr-x.el (internal--check-binding):
* lisp/emacs-lisp/tabulated-list.el (tabulated-list-put-tag):
* lisp/emacs-lisp/testcover.el (testcover-1value):
* lisp/emacs-lisp/timer.el (timer-event-handler):
* lisp/emulation/viper-cmd.el (viper-toggle-parse-sexp-ignore-comments)
(viper-toggle-search-style, viper-kill-buffer)
(viper-brac-function):
* lisp/emulation/viper-macs.el (viper-record-kbd-macro):
* lisp/env.el (setenv):
* lisp/erc/erc-button.el (erc-nick-popup):
* lisp/erc/erc.el (erc-cmd-LOAD, erc-handle-login, english):
* lisp/eshell/em-dirs.el (eshell/cd):
* lisp/eshell/em-glob.el (eshell-glob-regexp)
(eshell-glob-entries):
* lisp/eshell/em-pred.el (eshell-parse-modifiers):
* lisp/eshell/esh-opt.el (eshell-show-usage):
* lisp/facemenu.el (facemenu-add-new-face)
(facemenu-add-new-color):
* lisp/faces.el (read-face-name, read-face-font, describe-face)
(x-resolve-font-name):
* lisp/files-x.el (modify-file-local-variable):
* lisp/files.el (locate-user-emacs-file, find-alternate-file)
(set-auto-mode, hack-one-local-variable--obsolete)
(dir-locals-set-directory-class, write-file, basic-save-buffer)
(delete-directory, copy-directory, recover-session)
(recover-session-finish, insert-directory)
(file-modes-char-to-who, file-modes-symbolic-to-number)
(move-file-to-trash):
* lisp/filesets.el (filesets-add-buffer, filesets-remove-buffer):
* lisp/find-cmd.el (find-generic, find-to-string):
* lisp/finder.el (finder-commentary):
* lisp/font-lock.el (font-lock-fontify-buffer):
* lisp/format.el (format-write-file, format-find-file)
(format-insert-file):
* lisp/frame.el (get-device-terminal, select-frame-by-name):
* lisp/fringe.el (fringe--check-style):
* lisp/gnus/nnmairix.el (nnmairix-widget-create-query):
* lisp/help-fns.el (help-fns--key-bindings)
(help-fns--compiler-macro, help-fns--parent-mode)
(help-fns--obsolete, help-fns--interactive-only)
(describe-function-1, describe-variable):
* lisp/help.el (describe-mode)
(describe-minor-mode-from-indicator):
* lisp/image.el (image-type):
* lisp/international/ccl.el (ccl-dump):
* lisp/international/fontset.el (x-must-resolve-font-name):
* lisp/international/mule-cmds.el (prefer-coding-system)
(select-safe-coding-system-interactively)
(select-safe-coding-system, activate-input-method)
(toggle-input-method, describe-current-input-method)
(describe-language-environment):
* lisp/international/mule-conf.el (code-offset):
* lisp/international/mule-diag.el (describe-character-set)
(list-input-methods-1):
* lisp/mail/feedmail.el (feedmail-run-the-queue):
* lisp/mouse.el (minor-mode-menu-from-indicator):
* lisp/mpc.el (mpc-playlist-rename):
* lisp/msb.el (msb--choose-menu):
* lisp/net/ange-ftp.el (ange-ftp-shell-command):
* lisp/net/imap.el (imap-interactive-login):
* lisp/net/mairix.el (mairix-widget-create-query):
* lisp/net/newst-backend.el (newsticker--sentinel-work):
* lisp/net/newst-treeview.el (newsticker--treeview-load):
* lisp/net/rlogin.el (rlogin):
* lisp/obsolete/iswitchb.el (iswitchb-possible-new-buffer):
* lisp/obsolete/otodo-mode.el (todo-more-important-p):
* lisp/obsolete/pgg-gpg.el (pgg-gpg-process-region):
* lisp/obsolete/pgg-pgp.el (pgg-pgp-process-region):
* lisp/obsolete/pgg-pgp5.el (pgg-pgp5-process-region):
* lisp/org/ob-core.el (org-babel-goto-named-src-block)
(org-babel-goto-named-result):
* lisp/org/ob-fortran.el (org-babel-fortran-ensure-main-wrap):
* lisp/org/ob-ref.el (org-babel-ref-resolve):
* lisp/org/org-agenda.el (org-agenda-prepare):
* lisp/org/org-clock.el (org-clock-notify-once-if-expired)
(org-clock-resolve):
* lisp/org/org-ctags.el (org-ctags-ask-rebuild-tags-file-then-find-tag):
* lisp/org/org-feed.el (org-feed-parse-atom-entry):
* lisp/org/org-habit.el (org-habit-parse-todo):
* lisp/org/org-mouse.el (org-mouse-popup-global-menu)
(org-mouse-context-menu):
* lisp/org/org-table.el (org-table-edit-formulas):
* lisp/org/ox.el (org-export-async-start):
* lisp/proced.el (proced-log):
* lisp/progmodes/ada-mode.el (ada-get-indent-case)
(ada-check-matching-start, ada-goto-matching-start):
* lisp/progmodes/ada-prj.el (ada-prj-display-page):
* lisp/progmodes/ada-xref.el (ada-find-executable):
* lisp/progmodes/ebrowse.el (ebrowse-tags-apropos):
* lisp/progmodes/etags.el (etags-tags-apropos-additional):
* lisp/progmodes/flymake.el (flymake-parse-err-lines)
(flymake-start-syntax-check-process):
* lisp/progmodes/python.el (python-shell-get-process-or-error)
(python-define-auxiliary-skeleton):
* lisp/progmodes/sql.el (sql-comint):
* lisp/progmodes/verilog-mode.el (verilog-load-file-at-point):
* lisp/progmodes/vhdl-mode.el (vhdl-widget-directory-validate):
* lisp/recentf.el (recentf-open-files):
* lisp/replace.el (query-replace-read-from)
(occur-after-change-function, occur-1):
* lisp/scroll-bar.el (scroll-bar-columns):
* lisp/server.el (server-get-auth-key):
* lisp/simple.el (execute-extended-command)
(undo-outer-limit-truncate, list-processes--refresh)
(compose-mail, set-variable, choose-completion-string)
(define-alternatives):
* lisp/startup.el (site-run-file, tty-handle-args, command-line)
(command-line-1):
* lisp/subr.el (noreturn, define-error, add-to-list)
(read-char-choice, version-to-list):
* lisp/term/common-win.el (x-handle-xrm-switch)
(x-handle-name-switch, x-handle-args):
* lisp/term/x-win.el (x-handle-parent-id, x-handle-smid):
* lisp/textmodes/reftex-ref.el (reftex-label):
* lisp/textmodes/reftex-toc.el (reftex-toc-rename-label):
* lisp/textmodes/two-column.el (2C-split):
* lisp/tutorial.el (tutorial--describe-nonstandard-key)
(tutorial--find-changed-keys):
* lisp/type-break.el (type-break-noninteractive-query):
* lisp/wdired.el (wdired-do-renames, wdired-do-symlink-changes)
(wdired-do-perm-changes):
* lisp/whitespace.el (whitespace-report-region):
Prefer grave quoting in source-code strings used to generate help
and diagnostics.
* lisp/faces.el (face-documentation):
No need to convert quotes, since the result is a docstring.
* lisp/info.el (Info-virtual-index-find-node)
(Info-virtual-index, info-apropos):
Simplify by generating only curved quotes, since info files are
typically that ways nowadays anyway.
* lisp/international/mule-diag.el (list-input-methods):
Don’t assume text quoting style is curved.
* lisp/org/org-bibtex.el (org-bibtex-fields):
Revert my recent changes, going back to the old quoting style.
2015-09-07 08:41:44 -07:00
|
|
|
(error "File `%s' not found" file))
|
2016-05-18 00:48:35 -07:00
|
|
|
(check-declare-files file))
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun check-declare-directory (root)
|
|
|
|
|
"Check veracity of all `declare-function' statements under directory ROOT.
|
2009-10-01 02:02:39 +00:00
|
|
|
Returns non-nil if any false statements are found."
|
2007-11-17 03:47:59 +00:00
|
|
|
(interactive "DDirectory to check: ")
|
2016-05-18 00:48:35 -07:00
|
|
|
(setq root (directory-file-name (file-relative-name root)))
|
|
|
|
|
(or (file-directory-p root)
|
Go back to grave quoting in source-code docstrings etc.
This reverts almost all my recent changes to use curved quotes
in docstrings and/or strings used for error diagnostics.
There are a few exceptions, e.g., Bahá’í proper names.
* admin/unidata/unidata-gen.el (unidata-gen-table):
* lisp/abbrev.el (expand-region-abbrevs):
* lisp/align.el (align-region):
* lisp/allout.el (allout-mode, allout-solicit-alternate-bullet)
(outlineify-sticky):
* lisp/apropos.el (apropos-library):
* lisp/bookmark.el (bookmark-default-annotation-text):
* lisp/button.el (button-category-symbol, button-put)
(make-text-button):
* lisp/calc/calc-aent.el (math-read-if, math-read-factor):
* lisp/calc/calc-embed.el (calc-do-embedded):
* lisp/calc/calc-ext.el (calc-user-function-list):
* lisp/calc/calc-graph.el (calc-graph-show-dumb):
* lisp/calc/calc-help.el (calc-describe-key)
(calc-describe-thing, calc-full-help):
* lisp/calc/calc-lang.el (calc-c-language)
(math-parse-fortran-vector-end, math-parse-tex-sum)
(math-parse-eqn-matrix, math-parse-eqn-prime)
(calc-yacas-language, calc-maxima-language, calc-giac-language)
(math-read-giac-subscr, math-read-math-subscr)
(math-read-big-rec, math-read-big-balance):
* lisp/calc/calc-misc.el (calc-help, report-calc-bug):
* lisp/calc/calc-mode.el (calc-auto-why, calc-save-modes)
(calc-auto-recompute):
* lisp/calc/calc-prog.el (calc-fix-token-name)
(calc-read-parse-table-part, calc-user-define-invocation)
(math-do-arg-check):
* lisp/calc/calc-store.el (calc-edit-variable):
* lisp/calc/calc-units.el (math-build-units-table-buffer):
* lisp/calc/calc-vec.el (math-read-brackets):
* lisp/calc/calc-yank.el (calc-edit-mode):
* lisp/calc/calc.el (calc, calc-do, calc-user-invocation):
* lisp/calendar/appt.el (appt-display-message):
* lisp/calendar/diary-lib.el (diary-check-diary-file)
(diary-mail-entries, diary-from-outlook):
* lisp/calendar/icalendar.el (icalendar-export-region)
(icalendar--convert-float-to-ical)
(icalendar--convert-date-to-ical)
(icalendar--convert-ical-to-diary)
(icalendar--convert-recurring-to-diary)
(icalendar--add-diary-entry):
* lisp/calendar/time-date.el (format-seconds):
* lisp/calendar/timeclock.el (timeclock-mode-line-display)
(timeclock-make-hours-explicit, timeclock-log-data):
* lisp/calendar/todo-mode.el (todo-prefix, todo-delete-category)
(todo-item-mark, todo-check-format)
(todo-insert-item--next-param, todo-edit-item--next-key)
(todo-mode):
* lisp/cedet/ede/pmake.el (ede-proj-makefile-insert-dist-rules):
* lisp/cedet/mode-local.el (describe-mode-local-overload)
(mode-local-print-binding, mode-local-describe-bindings-2):
* lisp/cedet/semantic/complete.el (semantic-displayor-show-request):
* lisp/cedet/srecode/srt-mode.el (srecode-macro-help):
* lisp/cus-start.el (standard):
* lisp/cus-theme.el (describe-theme-1):
* lisp/custom.el (custom-add-dependencies, custom-check-theme)
(custom--sort-vars-1, load-theme):
* lisp/descr-text.el (describe-text-properties-1, describe-char):
* lisp/dired-x.el (dired-do-run-mail):
* lisp/dired.el (dired-log):
* lisp/emacs-lisp/advice.el (ad-read-advised-function)
(ad-read-advice-class, ad-read-advice-name, ad-enable-advice)
(ad-disable-advice, ad-remove-advice, ad-set-argument)
(ad-set-arguments, ad--defalias-fset, ad-activate)
(ad-deactivate):
* lisp/emacs-lisp/byte-opt.el (byte-compile-inline-expand)
(byte-compile-unfold-lambda, byte-optimize-form-code-walker)
(byte-optimize-while, byte-optimize-apply):
* lisp/emacs-lisp/byte-run.el (defun, defsubst):
* lisp/emacs-lisp/bytecomp.el (byte-compile-lapcode)
(byte-compile-log-file, byte-compile-format-warn)
(byte-compile-nogroup-warn, byte-compile-arglist-warn)
(byte-compile-cl-warn)
(byte-compile-warn-about-unresolved-functions)
(byte-compile-file, byte-compile--declare-var)
(byte-compile-file-form-defmumble, byte-compile-form)
(byte-compile-normal-call, byte-compile-check-variable)
(byte-compile-variable-ref, byte-compile-variable-set)
(byte-compile-subr-wrong-args, byte-compile-setq-default)
(byte-compile-negation-optimizer)
(byte-compile-condition-case--old)
(byte-compile-condition-case--new, byte-compile-save-excursion)
(byte-compile-defvar, byte-compile-autoload)
(byte-compile-lambda-form)
(byte-compile-make-variable-buffer-local, display-call-tree)
(batch-byte-compile):
* lisp/emacs-lisp/cconv.el (cconv-convert, cconv--analyze-use):
* lisp/emacs-lisp/chart.el (chart-space-usage):
* lisp/emacs-lisp/check-declare.el (check-declare-scan)
(check-declare-warn, check-declare-file)
(check-declare-directory):
* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine)
(checkdoc-message-text-engine):
* lisp/emacs-lisp/cl-extra.el (cl-parse-integer)
(cl--describe-class):
* lisp/emacs-lisp/cl-generic.el (cl-defgeneric)
(cl--generic-describe, cl-generic-generalizers):
* lisp/emacs-lisp/cl-macs.el (cl--parse-loop-clause, cl-tagbody)
(cl-symbol-macrolet):
* lisp/emacs-lisp/cl.el (cl-unload-function, flet):
* lisp/emacs-lisp/copyright.el (copyright)
(copyright-update-directory):
* lisp/emacs-lisp/edebug.el (edebug-read-list):
* lisp/emacs-lisp/eieio-base.el (eieio-persistent-read):
* lisp/emacs-lisp/eieio-core.el (eieio--slot-override)
(eieio-oref):
* lisp/emacs-lisp/eieio-opt.el (eieio-help-constructor):
* lisp/emacs-lisp/eieio-speedbar.el:
(eieio-speedbar-child-make-tag-lines)
(eieio-speedbar-child-description):
* lisp/emacs-lisp/eieio.el (defclass, change-class):
* lisp/emacs-lisp/elint.el (elint-file, elint-get-top-forms)
(elint-init-form, elint-check-defalias-form)
(elint-check-let-form):
* lisp/emacs-lisp/ert.el (ert-get-test, ert-results-mode-menu)
(ert-results-pop-to-backtrace-for-test-at-point)
(ert-results-pop-to-messages-for-test-at-point)
(ert-results-pop-to-should-forms-for-test-at-point)
(ert-describe-test):
* lisp/emacs-lisp/find-func.el (find-function-search-for-symbol)
(find-function-library):
* lisp/emacs-lisp/generator.el (iter-yield):
* lisp/emacs-lisp/gv.el (gv-define-simple-setter):
* lisp/emacs-lisp/lisp-mnt.el (lm-verify):
* lisp/emacs-lisp/macroexp.el (macroexp--obsolete-warning):
* lisp/emacs-lisp/map-ynp.el (map-y-or-n-p):
* lisp/emacs-lisp/nadvice.el (advice--make-docstring)
(advice--make, define-advice):
* lisp/emacs-lisp/package-x.el (package-upload-file):
* lisp/emacs-lisp/package.el (package-version-join)
(package-disabled-p, package-activate-1, package-activate)
(package--download-one-archive)
(package--download-and-read-archives)
(package-compute-transaction, package-install-from-archive)
(package-install, package-install-selected-packages)
(package-delete, package-autoremove, describe-package-1)
(package-install-button-action, package-delete-button-action)
(package-menu-hide-package, package-menu--list-to-prompt)
(package-menu--perform-transaction)
(package-menu--find-and-notify-upgrades):
* lisp/emacs-lisp/pcase.el (pcase-exhaustive, pcase--u1):
* lisp/emacs-lisp/re-builder.el (reb-enter-subexp-mode):
* lisp/emacs-lisp/ring.el (ring-previous, ring-next):
* lisp/emacs-lisp/rx.el (rx-check, rx-anything)
(rx-check-any-string, rx-check-any, rx-check-not, rx-=)
(rx-repeat, rx-check-backref, rx-syntax, rx-check-category)
(rx-form):
* lisp/emacs-lisp/smie.el (smie-config-save):
* lisp/emacs-lisp/subr-x.el (internal--check-binding):
* lisp/emacs-lisp/tabulated-list.el (tabulated-list-put-tag):
* lisp/emacs-lisp/testcover.el (testcover-1value):
* lisp/emacs-lisp/timer.el (timer-event-handler):
* lisp/emulation/viper-cmd.el (viper-toggle-parse-sexp-ignore-comments)
(viper-toggle-search-style, viper-kill-buffer)
(viper-brac-function):
* lisp/emulation/viper-macs.el (viper-record-kbd-macro):
* lisp/env.el (setenv):
* lisp/erc/erc-button.el (erc-nick-popup):
* lisp/erc/erc.el (erc-cmd-LOAD, erc-handle-login, english):
* lisp/eshell/em-dirs.el (eshell/cd):
* lisp/eshell/em-glob.el (eshell-glob-regexp)
(eshell-glob-entries):
* lisp/eshell/em-pred.el (eshell-parse-modifiers):
* lisp/eshell/esh-opt.el (eshell-show-usage):
* lisp/facemenu.el (facemenu-add-new-face)
(facemenu-add-new-color):
* lisp/faces.el (read-face-name, read-face-font, describe-face)
(x-resolve-font-name):
* lisp/files-x.el (modify-file-local-variable):
* lisp/files.el (locate-user-emacs-file, find-alternate-file)
(set-auto-mode, hack-one-local-variable--obsolete)
(dir-locals-set-directory-class, write-file, basic-save-buffer)
(delete-directory, copy-directory, recover-session)
(recover-session-finish, insert-directory)
(file-modes-char-to-who, file-modes-symbolic-to-number)
(move-file-to-trash):
* lisp/filesets.el (filesets-add-buffer, filesets-remove-buffer):
* lisp/find-cmd.el (find-generic, find-to-string):
* lisp/finder.el (finder-commentary):
* lisp/font-lock.el (font-lock-fontify-buffer):
* lisp/format.el (format-write-file, format-find-file)
(format-insert-file):
* lisp/frame.el (get-device-terminal, select-frame-by-name):
* lisp/fringe.el (fringe--check-style):
* lisp/gnus/nnmairix.el (nnmairix-widget-create-query):
* lisp/help-fns.el (help-fns--key-bindings)
(help-fns--compiler-macro, help-fns--parent-mode)
(help-fns--obsolete, help-fns--interactive-only)
(describe-function-1, describe-variable):
* lisp/help.el (describe-mode)
(describe-minor-mode-from-indicator):
* lisp/image.el (image-type):
* lisp/international/ccl.el (ccl-dump):
* lisp/international/fontset.el (x-must-resolve-font-name):
* lisp/international/mule-cmds.el (prefer-coding-system)
(select-safe-coding-system-interactively)
(select-safe-coding-system, activate-input-method)
(toggle-input-method, describe-current-input-method)
(describe-language-environment):
* lisp/international/mule-conf.el (code-offset):
* lisp/international/mule-diag.el (describe-character-set)
(list-input-methods-1):
* lisp/mail/feedmail.el (feedmail-run-the-queue):
* lisp/mouse.el (minor-mode-menu-from-indicator):
* lisp/mpc.el (mpc-playlist-rename):
* lisp/msb.el (msb--choose-menu):
* lisp/net/ange-ftp.el (ange-ftp-shell-command):
* lisp/net/imap.el (imap-interactive-login):
* lisp/net/mairix.el (mairix-widget-create-query):
* lisp/net/newst-backend.el (newsticker--sentinel-work):
* lisp/net/newst-treeview.el (newsticker--treeview-load):
* lisp/net/rlogin.el (rlogin):
* lisp/obsolete/iswitchb.el (iswitchb-possible-new-buffer):
* lisp/obsolete/otodo-mode.el (todo-more-important-p):
* lisp/obsolete/pgg-gpg.el (pgg-gpg-process-region):
* lisp/obsolete/pgg-pgp.el (pgg-pgp-process-region):
* lisp/obsolete/pgg-pgp5.el (pgg-pgp5-process-region):
* lisp/org/ob-core.el (org-babel-goto-named-src-block)
(org-babel-goto-named-result):
* lisp/org/ob-fortran.el (org-babel-fortran-ensure-main-wrap):
* lisp/org/ob-ref.el (org-babel-ref-resolve):
* lisp/org/org-agenda.el (org-agenda-prepare):
* lisp/org/org-clock.el (org-clock-notify-once-if-expired)
(org-clock-resolve):
* lisp/org/org-ctags.el (org-ctags-ask-rebuild-tags-file-then-find-tag):
* lisp/org/org-feed.el (org-feed-parse-atom-entry):
* lisp/org/org-habit.el (org-habit-parse-todo):
* lisp/org/org-mouse.el (org-mouse-popup-global-menu)
(org-mouse-context-menu):
* lisp/org/org-table.el (org-table-edit-formulas):
* lisp/org/ox.el (org-export-async-start):
* lisp/proced.el (proced-log):
* lisp/progmodes/ada-mode.el (ada-get-indent-case)
(ada-check-matching-start, ada-goto-matching-start):
* lisp/progmodes/ada-prj.el (ada-prj-display-page):
* lisp/progmodes/ada-xref.el (ada-find-executable):
* lisp/progmodes/ebrowse.el (ebrowse-tags-apropos):
* lisp/progmodes/etags.el (etags-tags-apropos-additional):
* lisp/progmodes/flymake.el (flymake-parse-err-lines)
(flymake-start-syntax-check-process):
* lisp/progmodes/python.el (python-shell-get-process-or-error)
(python-define-auxiliary-skeleton):
* lisp/progmodes/sql.el (sql-comint):
* lisp/progmodes/verilog-mode.el (verilog-load-file-at-point):
* lisp/progmodes/vhdl-mode.el (vhdl-widget-directory-validate):
* lisp/recentf.el (recentf-open-files):
* lisp/replace.el (query-replace-read-from)
(occur-after-change-function, occur-1):
* lisp/scroll-bar.el (scroll-bar-columns):
* lisp/server.el (server-get-auth-key):
* lisp/simple.el (execute-extended-command)
(undo-outer-limit-truncate, list-processes--refresh)
(compose-mail, set-variable, choose-completion-string)
(define-alternatives):
* lisp/startup.el (site-run-file, tty-handle-args, command-line)
(command-line-1):
* lisp/subr.el (noreturn, define-error, add-to-list)
(read-char-choice, version-to-list):
* lisp/term/common-win.el (x-handle-xrm-switch)
(x-handle-name-switch, x-handle-args):
* lisp/term/x-win.el (x-handle-parent-id, x-handle-smid):
* lisp/textmodes/reftex-ref.el (reftex-label):
* lisp/textmodes/reftex-toc.el (reftex-toc-rename-label):
* lisp/textmodes/two-column.el (2C-split):
* lisp/tutorial.el (tutorial--describe-nonstandard-key)
(tutorial--find-changed-keys):
* lisp/type-break.el (type-break-noninteractive-query):
* lisp/wdired.el (wdired-do-renames, wdired-do-symlink-changes)
(wdired-do-perm-changes):
* lisp/whitespace.el (whitespace-report-region):
Prefer grave quoting in source-code strings used to generate help
and diagnostics.
* lisp/faces.el (face-documentation):
No need to convert quotes, since the result is a docstring.
* lisp/info.el (Info-virtual-index-find-node)
(Info-virtual-index, info-apropos):
Simplify by generating only curved quotes, since info files are
typically that ways nowadays anyway.
* lisp/international/mule-diag.el (list-input-methods):
Don’t assume text quoting style is curved.
* lisp/org/org-bibtex.el (org-bibtex-fields):
Revert my recent changes, going back to the old quoting style.
2015-09-07 08:41:44 -07:00
|
|
|
(error "Directory `%s' not found" root))
|
2016-05-18 00:48:35 -07:00
|
|
|
(let ((files (process-lines find-program root
|
|
|
|
|
"-name" "*.el"
|
|
|
|
|
"-exec" grep-program
|
|
|
|
|
"-l" "^[ \t]*(declare-function" "{}" "+")))
|
2007-11-17 03:47:59 +00:00
|
|
|
(when files
|
2016-05-18 00:48:35 -07:00
|
|
|
(apply #'check-declare-files files))))
|
2007-11-17 03:47:59 +00:00
|
|
|
|
|
|
|
|
(provide 'check-declare)
|
|
|
|
|
|
|
|
|
|
;;; check-declare.el ends here.
|