| blob | 4761ac5e6fc0879f59d46b700237f8ae2067a73b |
1 ;;; checkdoc.el --- check documentation strings for style requirements
3 ;; Copyright (C) 1997-1998, 2001-2015 Free Software Foundation, Inc.
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
6 ;; Version: 0.6.2
7 ;; Keywords: docs, maint, lisp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
25 ;;
26 ;; The Emacs Lisp manual has a nice chapter on how to write
27 ;; documentation strings. Many stylistic suggestions are fairly
28 ;; deterministic and easy to check for syntactically, but also easy
29 ;; to forget. The main checkdoc engine will perform the stylistic
30 ;; checks needed to make sure these styles are remembered.
31 ;;
32 ;; There are two ways to use checkdoc:
33 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
34 ;; `checkdoc' is a more interactive version of
35 ;; `checkdoc-current-buffer'
36 ;; 2) Use `checkdoc-minor-mode' to automatically check your
37 ;; documentation whenever you evaluate Lisp code with C-M-x
38 ;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
39 ;; are also provided under C-c ? KEY
40 ;; (require 'checkdoc)
41 ;; (add-hook 'emacs-lisp-mode-hook 'checkdoc-minor-mode)
42 ;;
43 ;; Using `checkdoc':
44 ;;
45 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
46 ;; entry points to all of the different checks that are available. It
47 ;; breaks examination of your Lisp file into four sections (comments,
48 ;; documentation, messages, and spacing) and indicates its current
49 ;; state in a status buffer.
50 ;;
51 ;; The Comments check examines your headers, footers, and
52 ;; various tags (such as "Code:") to make sure that your code is ready
53 ;; for easy integration into existing systems.
54 ;;
55 ;; The Documentation check deals with documentation strings
56 ;; and their elements that help make Emacs easier to use.
57 ;;
58 ;; The Messages check ensures that the strings displayed in the
59 ;; minibuffer by some commands (such as `error' and `y-or-n-p')
60 ;; are consistent with the Emacs environment.
61 ;;
62 ;; The Spacing check cleans up white-space at the end of lines.
63 ;;
64 ;; The interface while working with documentation and messages is
65 ;; slightly different when being run in the interactive mode. The
66 ;; interface offers several options, including the ability to skip to
67 ;; the next error, or back up to previous errors. Auto-fixing is
68 ;; turned off at this stage, but you can use the `f' or `F' key to fix
69 ;; a given error (if the fix is available.)
70 ;;
71 ;; Auto-fixing:
72 ;;
73 ;; There are four classifications of style errors in terms of how
74 ;; easy they are to fix. They are simple, complex, really complex,
75 ;; and impossible. (Impossible really means that checkdoc does not
76 ;; have a fixing routine yet.) Typically white-space errors are
77 ;; classified as simple, and are auto-fixed by default. Typographic
78 ;; changes are considered complex, and the user is asked if they want
79 ;; the problem fixed before checkdoc makes the change. These changes
80 ;; can be done without asking if `checkdoc-autofix-flag' is properly
81 ;; set. Potentially redundant changes are considered really complex,
82 ;; and the user is always asked before a change is inserted. The
83 ;; variable `checkdoc-autofix-flag' controls how these types of errors
84 ;; are fixed.
85 ;;
86 ;; Spell checking text:
87 ;;
88 ;; The variable `checkdoc-spellcheck-documentation-flag' can be set
89 ;; to customize how spell checking is to be done. Since spell
90 ;; checking can be quite slow, you can optimize how best you want your
91 ;; checking done. The default is `defun', which spell checks each time
92 ;; `checkdoc-defun' or `checkdoc-eval-defun' is used. Setting to nil
93 ;; prevents spell checking during normal usage.
94 ;; Setting this variable to nil does not mean you cannot take
95 ;; advantage of the spell checking. You can instead use the
96 ;; interactive functions `checkdoc-ispell-*' to check the spelling of
97 ;; your documentation.
98 ;; There is a list of Lisp-specific words which checkdoc will
99 ;; install into Ispell on the fly, but only if Ispell is not already
100 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
101 ;; these words enabled.
102 ;;
103 ;; Checking parameters:
104 ;;
105 ;; You might not always want a function to have its parameters listed
106 ;; in order. When this is the case, put the following comment just in
107 ;; front of the documentation string: "; checkdoc-order: nil" This
108 ;; overrides the value of `checkdoc-arguments-in-order-flag'.
109 ;;
110 ;; If you specifically wish to avoid mentioning a parameter of a
111 ;; function in the doc string (such as a hidden parameter, or a
112 ;; parameter which is very obvious like events), you can have checkdoc
113 ;; skip looking for it by putting the following comment just in front
114 ;; of the documentation string: "; checkdoc-params: (args go here)"
115 ;;
116 ;; Checking message strings:
117 ;;
118 ;; The text that follows the `error' and `y-or-n-p' commands is
119 ;; also checked. The documentation for `error' clearly states some
120 ;; simple style rules to follow which checkdoc will auto-fix for you.
121 ;; `y-or-n-p' also states that it should end in a space. I added that
122 ;; it should end in "? " since that is almost always used.
123 ;;
124 ;; Adding your own checks:
125 ;;
126 ;; You can experiment with adding your own checks by setting the
127 ;; hooks `checkdoc-style-functions' and `checkdoc-comment-style-functions'.
128 ;; Return a string which is the error you wish to report. The cursor
129 ;; position should be preserved.
130 ;;
131 ;; Error errors:
132 ;;
133 ;; Checkdoc does not always flag errors correctly. There are a
134 ;; couple ways you can coax your file into passing all of checkdoc's
135 ;; tests through buffer local variables.
136 ;;
137 ;; The variable `checkdoc-verb-check-experimental-flag' can be used
138 ;; to turn off the check for verb-voice in case you use words that are
139 ;; not semantically verbs, but are still in the incomplete list.
140 ;;
141 ;; The variable `checkdoc-symbol-words' can be a list of words that
142 ;; happen to also be symbols. This is not a problem for one-word
143 ;; symbols, but if you use a hyphenated word that is also a symbol,
144 ;; then you may need this.
145 ;;
146 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if
147 ;; you have many undocumented functions you don't wish to document.
148 ;;
149 ;; See the above section "Checking Parameters" for details about
150 ;; parameter checking.
151 ;;
152 ;; Dependencies:
153 ;;
154 ;; This file requires lisp-mnt (Lisp maintenance routines) for the
155 ;; comment checkers.
156 ;;
157 ;; Requires custom for Emacs v20.
159 ;;; TO DO:
160 ;; Hook into the byte compiler on a defun/defvar level to generate
161 ;; warnings in the byte-compiler's warning/error buffer.
162 ;; Better ways to override more typical `eval' functions. Advice
163 ;; might be good but hard to turn on/off as a minor mode.
164 ;;
165 ;;; Maybe Do:
166 ;; Code sweep checks for "forbidden functions", proper use of hooks,
167 ;; proper keybindings, and other items from the manual that are
168 ;; not specifically docstring related. Would this even be useful?
170 ;;; Code:
181 "Support for doc string checking in Emacs Lisp."
187 "String to display in mode line when Checkdoc mode is enabled; nil for none."
192 "Non-nil means attempt auto-fixing of doc strings.
193 If this value is the symbol `query', then the user is queried before
194 any change is made. If the value is `automatic', then all changes are
195 made without asking unless the change is very-complex. If the value
196 is `semiautomatic' or any other value, then simple fixes are made
197 without asking, and complex changes are made by asking the user first.
198 The value `never' is the same as nil, never ask or change anything."
206 Setting this to nil will silently make fixes that require no user
207 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
211 "Non-nil means that all checkable definitions should have documentation.
212 Style guide dictates that interactive functions MUST have documentation,
213 and that it's good but not required practice to make non user visible items
214 have doc strings."
216 ;;;###autoload(put 'checkdoc-force-docstrings-flag 'safe-local-variable #'booleanp)
219 "Non-nil means that files should have a History section or ChangeLog file.
220 This helps document the evolution of, and recent changes to, the package."
222 ;;;###autoload(put 'checkdoc-force-history-flag 'safe-local-variable #'booleanp)
225 "Non-nil means the first line of a docstring may end with a comma.
226 Ordinarily, a full sentence is required. This may be misleading when
227 there is a substantial caveat to the one-line description -- the comma
228 should be used when the first part could stand alone as a sentence, but
229 it indicates that a modifying clause follows."
231 ;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable #'booleanp)
234 "Non-nil means run Ispell on text based on value.
235 This is automatically set to nil if Ispell does not exist on your
236 system. Possible values are:
238 nil - Don't spell-check during basic style checks.
239 defun - Spell-check when style checking a single defun
240 buffer - Spell-check when style checking the whole buffer
241 interactive - Spell-check during any interactive check.
242 t - Always spell-check"
248 ;;;###autoload(put 'checkdoc-spellcheck-documentation-flag 'safe-local-variable #'booleanp)
253 ;;;###autoload(put 'checkdoc-ispell-list-words 'safe-local-variable #'checkdoc-list-of-strings-p)
257 Any more than this and a warning is generated suggesting that the construct
262 "Non-nil means warn if arguments appear out of order.
263 Setting this to nil will mean only checking that all the arguments
264 appear in the proper form in the documentation, not that they are in
265 the same order as they appear in the argument list. No mention is
266 made in the style guide relating to order."
268 ;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable #'booleanp)
273 "Hook run after the standard style check is completed.
274 All functions must return nil or a string representing the error found.
275 Useful for adding new user implemented commands.
277 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
278 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
284 "Hook run after the standard comment style check is completed.
285 Must return nil if no errors are found, or a string describing the
294 "Regular expression used to identify a defun.
298 "Non-nil means to attempt to check the voice of the doc string.
299 This check keys off some words which are commonly misused. See the
300 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
302 ;;;###autoload(put 'checkdoc-verb-check-experimental-flag 'safe-local-variable #'booleanp)
305 "Non-nil means generate warnings in a buffer for browsing.
306 Do not set this by hand, use a function like `checkdoc-current-buffer'
310 "A list of symbol names (strings) which also happen to make good words.
311 These words are ignored when unquoted symbols are searched for.
312 This should be set in an Emacs Lisp file's local variables."
314 ;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable #'checkdoc-list-of-strings-p)
316 ;;;###autoload
318 ;; this is a function so it might be shared by checkdoc-proper-noun-list
319 ;; and/or checkdoc-ispell-lisp-words in the future
328 ;; "[.!?]" is for noun at end of a sentence, since those chars
329 ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
330 ;; The \" allows it to be the last sentence in a docstring too.
335 ;;;###autoload(put 'checkdoc-proper-noun-regexp 'safe-local-variable 'stringp)
339 ;;;###autoload(put 'checkdoc-common-verbs-regexp 'safe-local-variable 'stringp)
421 )
422 "Alist of common words in the wrong voice and what should be used instead.
423 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
424 and experimental check. Do not modify this list without setting
425 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
430 ;; When dealing with syntax in doc strings, make sure that - are
431 ;; encompassed in words so we can use cheap \\> to get the end of a symbol,
432 ;; not the end of a word in a conglomerate.
434 st)
437 ;;; Compatibility
438 ;;
454 ;;; User level commands
455 ;;
456 ;;;###autoload
458 "Interactively check the entire buffer for style errors.
459 The current status of the check will be displayed in a buffer which
460 the users will view as each check is completed."
466 ;; if the user set autofix to never, then that breaks the
467 ;; obviously requested asking implied by using this function.
468 ;; Set it to paranoia level.
471 'query
472 checkdoc-autofix-flag))
473 tmp)
475 ;; check the comments
483 ;; Check the documentation
490 ;; Check the message text
496 ;; Rogue spacing
505 "Display and update the status buffer for the current checkdoc mode.
506 CHECK is a list of four strings stating the current status of each
507 test; the nth string describes the status of the nth test."
520 ;;;###autoload
522 "Interactively check the current buffer for doc string errors.
523 Prefix argument START-HERE will start the checking from the current
524 point, otherwise the check starts at the beginning of the current
525 buffer. Allows navigation forward and backwards through document
526 errors. Does not check for comment or space warnings.
527 Optional argument SHOWSTATUS indicates that we should update the
528 checkdoc status window instead of the usual behavior."
534 ;; Due to a design flaw, this will never spell check
535 ;; docstrings.
538 ;; This is a workaround to perform spell checking.
541 ;;;###autoload
543 "Interactively check the current buffer for message string errors.
544 Prefix argument START-HERE will start the checking from the current
545 point, otherwise the check starts at the beginning of the current
546 buffer. Allows navigation forward and backwards through document
547 errors. Does not check for comment or space warnings.
548 Optional argument SHOWSTATUS indicates that we should update the
549 checkdoc status window instead of the usual behavior."
555 ;; Due to a design flaw, this will never spell check messages.
558 ;; This is a workaround to perform spell checking.
562 "Interactively loop over all errors that can be found by a given method.
564 If START-HERE is nil, searching starts at the beginning of the current
565 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
566 expresses the verbosity of the search, and whether ending the search
567 will auto-exit this function.
569 FINDFUNC is a symbol representing a function that will position the
570 cursor, and return error message text to present to the user. It is
571 assumed that the cursor will stop just before a major sexp, which will
572 be highlighted to present the user with feedback as to the offending
573 style."
574 ;; Determine where to start the test
577 ;; Assign a flag to spellcheck flag
581 ;; Fetch the error list
585 c)
588 ;; Include whatever function point is in for good measure.
592 ;; The cursor should be just in front of the offending doc string
603 ;; Make sure the whole doc string is visible if possible.
627 ;; Exit condition
629 ;; Request an auto-fix
634 ;; `automatic-then-never' tells the autofix function
635 ;; to only allow one fix to be automatic. The autofix
636 ;; function will then set the flag to `never', allowing
637 ;; the checker to return a different error.
659 ;; Move to the next error (if available)
665 err-list nil)
671 ;; Go backwards in the list of errors
680 ;; Edit the buffer recursively.
691 err-list nil)
695 ;; Quit checkdoc
698 err-list nil
700 ;; Goofy stuff
711 ""
713 "f, y - auto Fix this warning without asking (if\
716 )
728 returnme))
731 "Interactively spell check doc strings in the current buffer.
732 If START-HERE is nil, searching starts at the beginning of the current
733 buffer, otherwise searching starts at START-HERE."
736 ;; Move point to where we need to start.
738 ;; Include whatever function point is in for good measure.
741 ;; Loop over docstrings.
751 "Interactively spell check messages in the current buffer.
752 If START-HERE is nil, searching starts at the beginning of the current
753 buffer, otherwise searching starts at START-HERE."
756 ;; Move point to where we need to start.
758 ;; Include whatever function point is in for good measure.
761 ;; Loop over message strings.
772 "Find and return the next checkdoc error list, or nil.
773 Only documentation strings are checked.
774 An error list is of the form (WARNING . POSITION) where WARNING is the
775 warning text, and POSITION is the point in the buffer where the error
776 was found. We can use points and not markers because we promise not
777 to edit the buffer before point without re-executing this check.
778 Argument ENABLE-FIX will enable auto-fixing while looking for the next
779 error. This argument assumes that the cursor is already positioned to
780 perform the fix."
791 ;; Quit.. restore position, Other errors, leave alone
793 msg)))
796 "Find and return the next checkdoc message related error list, or nil.
797 Only text for error and `y-or-n-p' strings are checked. See
798 `checkdoc-next-error' for details on the return value.
799 Argument ENABLE-FIX turns on the auto-fix feature. This argument
800 assumes that the cursor is already positioned to perform the fix."
813 ;; Quit.. restore position, Other errors, leave alone
815 msg)))
818 "Enter recursive edit to permit a user to fix some error checkdoc has found.
819 MSG is the error that was found, which is displayed in a help buffer."
834 ;;;###autoload
836 "Evaluate and check documentation for the current buffer.
837 Evaluation is done first because good documentation for something that
838 doesn't work is just not useful. Comments, doc strings, and rogue
839 spacing are all verified."
844 ;;;###autoload
846 "Check current buffer for document, comment, error style, and rogue spaces.
847 With a prefix argument (in Lisp, the argument TAKE-NOTES),
848 store all errors found in a warnings buffer,
849 otherwise stop after the first error."
853 ;; Assign a flag to spellcheck flag
858 checkdoc-autofix-flag))
863 ;; every test is responsible for returning the cursor.
873 ;;;###autoload
875 "Start scanning the current buffer for documentation string style errors.
876 Only documentation strings are checked.
877 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
878 Prefix argument TAKE-NOTES means to collect all the warning messages into
879 a separate buffer."
886 ;; Go back since we can't be here without success above.
888 nil))
890 ;;;###autoload
892 "Find the next doc string in the current buffer which has a style error.
893 Prefix argument TAKE-NOTES means to continue through the whole buffer and
894 save warnings in a separate buffer. Second optional argument START-POINT
895 is the starting location. If this is nil, `point-min' is used instead."
898 ;; Assign a flag to spellcheck flag
903 checkdoc-autofix-flag))
907 ;; If we are taking notes, encompass the whole buffer, otherwise
908 ;; the user is navigating down through the buffer.
910 ;; OK, let's look at the doc string.
923 "Move to the next doc string after point, and return t.
924 Return nil if there are no more doc strings."
926 nil
927 ;; search drops us after the identifier. The next sexp is either
928 ;; the argument list or the value of the variable. skip it.
931 t))
933 ;;;###autoload
935 "Find missing comment sections in the current Emacs Lisp file.
936 Prefix argument TAKE-NOTES non-nil means to save warnings in a
937 separate buffer. Otherwise print a message. This returns the error
938 if there is one."
952 e))
954 ;;;###autoload
956 "Find extra spaces at the end of lines in the current file.
957 Prefix argument TAKE-NOTES non-nil means to save warnings in a
958 separate buffer. Otherwise print a message. This returns the error
959 if there is one.
960 Optional argument INTERACT permits more interactive fixing."
968 e
974 ;;;###autoload
976 "Scan the buffer for occurrences of the error function, and verify text.
977 Optional argument TAKE-NOTES causes all errors to be logged."
986 e
994 ;;;###autoload
996 "Evaluate the current form with `eval-defun' and check its documentation.
997 Evaluation is done first so the form will be read before the
998 documentation is checked. If there is a documentation error, then the display
999 of what was evaluated will be overwritten by the diagnostic message."
1004 ;;;###autoload
1006 "Examine the doc string of the function or variable under point.
1007 Call `error' if the doc string has problems. If NO-ERROR is
1008 non-nil, then do not call error, but call `message' instead.
1009 If the doc string passes the test, then check the function for rogue white
1010 space at the end of each line."
1015 ;; I found this more annoying than useful.
1016 ;;(if (not no-error)
1017 ;; (message "Cannot check this sexp's doc string."))
1018 nil
1019 ;; search drops us after the identifier. The next sexp is either
1020 ;; the argument list or the value of the variable. skip it.
1039 ;;; Ispell interface for forcing a spell check
1040 ;;
1042 ;;;###autoload
1044 "Check the style and spelling of everything interactively.
1045 Calls `checkdoc' with spell-checking turned on.
1046 Prefix argument is the same as for `checkdoc'"
1051 ;;;###autoload
1053 "Check the style and spelling of the current buffer.
1054 Calls `checkdoc-current-buffer' with spell-checking turned on.
1055 Prefix argument is the same as for `checkdoc-current-buffer'"
1060 ;;;###autoload
1062 "Check the style and spelling of the current buffer interactively.
1063 Calls `checkdoc-interactive' with spell-checking turned on.
1064 Prefix argument is the same as for `checkdoc-interactive'"
1069 ;;;###autoload
1071 "Check the style and spelling of message text interactively.
1072 Calls `checkdoc-message-interactive' with spell-checking turned on.
1073 Prefix argument is the same as for `checkdoc-message-interactive'"
1077 nil current-prefix-arg)))
1079 ;;;###autoload
1081 "Check the style and spelling of message text interactively.
1082 Calls `checkdoc-message-text' with spell-checking turned on.
1083 Prefix argument is the same as for `checkdoc-message-text'"
1088 ;;;###autoload
1090 "Check the style and spelling of the current buffer.
1091 Calls `checkdoc-start' with spell-checking turned on.
1092 Prefix argument is the same as for `checkdoc-start'"
1097 ;;;###autoload
1099 "Check the style and spelling of the current buffer after point.
1100 Calls `checkdoc-continue' with spell-checking turned on.
1101 Prefix argument is the same as for `checkdoc-continue'"
1106 ;;;###autoload
1108 "Check the style and spelling of the current buffer's comments.
1109 Calls `checkdoc-comments' with spell-checking turned on.
1110 Prefix argument is the same as for `checkdoc-comments'"
1115 ;;;###autoload
1117 "Check the style and spelling of the current defun with Ispell.
1118 Calls `checkdoc-defun' with spell-checking turned on.
1119 Prefix argument is the same as for `checkdoc-defun'"
1124 ;;; Error Management
1125 ;;
1126 ;; Errors returned from checkdoc functions can have various
1127 ;; features and behaviors, so we need some ways of specifying
1128 ;; them, and making them easier to use in the wacked-out interfaces
1129 ;; people are requesting
1131 "Used to create the return error text returned from all engines.
1132 TEXT is the descriptive text of the error. START and END define the region
1133 it is sensible to highlight when describing the problem.
1134 Optional argument UNFIXABLE means that the error has no auto-fix available.
1136 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1137 generating a buffered list of errors."
1140 nil)
1144 "Return the text specified in the checkdoc ERR."
1145 ;; string-p part is for backwards compatibility
1149 "Return the start point specified in the checkdoc ERR."
1150 ;; string-p part is for backwards compatibility
1154 "Return the end point specified in the checkdoc ERR."
1155 ;; string-p part is for backwards compatibility
1159 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1160 ;; string-p part is for backwards compatibility
1163 ;;; Minor Mode specification
1164 ;;
1169 ;; Override some bindings
1175 ;; Add some new bindings under C-c ?
1193 ;; bind our submap into map
1195 map)
1198 ;; Add in a menubar with easy-menu
1201 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1207 "---"
1216 checkdoc-ispell-message-interactive t]
1221 buffer-file-name]
1223 "---"
1228 ))
1229 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1230 ;; What is it?
1232 ;;;###autoload
1234 "Toggle automatic docstring checking (Checkdoc minor mode).
1235 With a prefix argument ARG, enable Checkdoc minor mode if ARG is
1236 positive, and disable it otherwise. If called from Lisp, enable
1237 the mode if ARG is omitted or nil.
1239 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1240 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1241 checking of documentation strings.
1244 nil checkdoc-minor-mode-string nil
1247 ;;; Subst utils
1248 ;;
1250 "Run hooks in HOOKVAR with ARGS."
1253 ;; This method was similar to above. We ignore the warning
1254 ;; since we will use the above for future Emacs versions
1258 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1266 ;; Profiler says this is not yet faster than just calling assoc
1267 ;;(defun checkdoc-word-in-alist-vector (word vector)
1268 ;; "Check to see if WORD is in the car of an element of VECTOR.
1269 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1270 ;;word list is getting bigger, it is time for a quick bisecting search."
1271 ;; (let ((max (length vector)) (min 0) i
1272 ;; (found nil) (fw nil))
1273 ;; (setq i (/ max 2))
1274 ;; (while (and (not found) (/= min max))
1275 ;; (setq fw (car (aref vector i)))
1276 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1277 ;; ((string< word fw) (setq max i))
1278 ;; (t (setq min i)))
1279 ;; (setq i (/ (+ max min) 2))
1280 ;; )
1281 ;; found))
1283 ;;; Checking engines
1284 ;;
1286 "Return a message string if the current doc string is invalid.
1287 Check for style only, such as the first line always being a complete
1288 sentence, whitespace restrictions, and making sure there are no
1289 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1290 See the style guide in the Emacs Lisp manual for more details."
1292 ;; Jump over comments between the last object and the doc string
1301 err
1302 ;; * Every command, function, or variable intended for users to know
1303 ;; about should have a documentation string.
1304 ;;
1305 ;; * An internal variable or subroutine of a Lisp program might as well
1306 ;; have a documentation string. In earlier Emacs versions, you could
1307 ;; save space by using a comment instead of a documentation string,
1308 ;; but that is no longer the case.
1313 ;; Sometimes old code has comments where the documentation should
1314 ;; be. Let's see if we can find the comment, and offer to turn it
1315 ;; into documentation for them.
1331 ;; Our point is at the beginning of the comment!
1332 ;; Insert a quote, then remove the comment chars.
1351 ;; quote any double-quote characters in the comment.
1357 "You should convert this comment to documentation"
1361 "All interactive functions should have documentation"
1362 "All variables and subroutines might as well have a \
1368 err)))
1371 "Return an error list or string if the current doc string is invalid.
1372 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1373 regexp short cuts work. FP is the function defun information."
1375 ;; Use a marker so if an early check modifies the text,
1376 ;; we won't accidentally lose our place. This could cause
1377 ;; end-of doc string whitespace to also delete the " char.
1383 ;; * *Do not* indent subsequent lines of a documentation string so that
1384 ;; the text is lined up in the source code with the text of the first
1385 ;; line. This looks nice in the source code, but looks bizarre when
1386 ;; users view the documentation. Remember that the indentation
1387 ;; before the starting double-quote is not part of the string!
1395 "Remove this whitespace? "
1397 nil
1399 "Second line should not have indentation"
1402 ;; * Check for '(' in column 0.
1407 "Escape this '('? "
1409 nil
1411 "Open parenthesis in column 0 should be escaped"
1413 ;; * Do not start or end a documentation string with whitespace.
1426 nil
1428 "Documentation strings should not start or end with whitespace"
1429 start end))))
1430 ;; * The first line of the documentation string should consist of one
1431 ;; or two complete sentences that stand on their own as a summary.
1432 ;; `M-x apropos' displays just the first line, and if it doesn't
1433 ;; stand on its own, the result looks bad. In particular, start the
1434 ;; first line with a capital letter and end with a period.
1442 ;; A backslashed double quote at the end of a sentence
1444 ;; We might have to add a period in this case
1447 nil
1452 nil
1454 "First sentence should end with punctuation"
1457 ;; These are ok
1458 nil)
1460 nil)
1462 ;; If it is not a complete sentence, let's see if we can
1463 ;; predict a clever way to make it one.
1468 ;; Here we have found a complete sentence, but no break.
1471 "First line not a complete sentence. Add RET here? "
1482 ;; We can merge these lines! Replace this CR
1483 ;; with a space.
1486 ;; Let's see if there is enough room to draw the next
1487 ;; line's sentence up here. I often get hit w/
1488 ;; auto-fill moving my words around.
1498 "1st line not a complete sentence. Join these lines? "
1501 ;; They said yes. We have more fill work to do...
1510 ;; Continuation of above. Make sure our sentence is capitalized.
1517 t)
1518 nil
1520 "First line should be capitalized"
1522 nil))
1523 ;; * Don't write key sequences directly in documentation strings.
1524 ;; Instead, use the `\\[...]' construct to stand for them.
1529 ;; Find the first key sequence not in a sample
1539 ;; It is not practical to use `\\[...]' very many times, because
1540 ;; display of the documentation string will become slow. So use this
1541 ;; to describe the most important commands in your major mode, and
1542 ;; then use `\\{...}' to display the rest of the mode's keymap.
1550 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1551 ;; and is referred to in documentation, it should be prefixed with
1552 ;; something to disambiguate it. This check must be before the
1553 ;; 80 column check because it will probably break that.
1572 ;; We didn't actually replace anything. Here we find
1573 ;; out what special word form they wish to use as
1574 ;; a prefix.
1577 "Disambiguating Keyword (default variable): "
1589 nil)))
1590 ;; * Format the documentation string so that it fits in an
1591 ;; Emacs window on an 80-column screen. It is a good idea
1592 ;; for most lines to be no wider than 60 characters. The
1593 ;; first line can be wider if necessary to fit the
1594 ;; information that ought to be there.
1603 eol t))
1609 "Some lines are over 80 columns wide"
1611 ;; Here we deviate to tests based on a variable or function.
1612 ;; We must do this before checking for symbols in quotes because there
1613 ;; is a chance that just such a symbol might really be an argument.
1615 ;; This is if we are in a variable
1617 ;; * The documentation string for a variable that is a
1618 ;; yes-or-no flag should start with words such as Non-nil
1619 ;; means..., to make it clear that all non-nil values are
1620 ;; equivalent and indicate explicitly what nil and non-nil
1621 ;; mean.
1622 ;; * If a user option variable records a true-or-false
1623 ;; condition, give it a name that ends in `-flag'.
1625 ;; If the variable has -flag in the name, make sure
1629 "Flag variable doc strings should usually start: Non-nil means"
1631 ;; Don't rename variable to "foo-flag". This is unnecessary
1632 ;; and such names often end up inconvenient when the variable
1633 ;; is later expanded to non-boolean values. --Stef
1634 ;; If the doc string starts with "Non-nil means"
1635 ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
1636 ;; (not (string-match "-flag$" (car fp))))
1637 ;; (let ((newname
1638 ;; (if (string-match "-p$" (car fp))
1639 ;; (concat (substring (car fp) 0 -2) "-flag")
1640 ;; (concat (car fp) "-flag"))))
1641 ;; (if (checkdoc-y-or-n-p
1642 ;; (format
1643 ;; "Rename to %s and Query-Replace all occurrences? "
1644 ;; newname))
1645 ;; (progn
1646 ;; (beginning-of-defun)
1647 ;; (query-replace-regexp
1648 ;; (concat "\\<" (regexp-quote (car fp)) "\\>")
1649 ;; newname))
1650 ;; (checkdoc-create-error
1651 ;; "Flag variable names should normally end in `-flag'" s
1652 ;; (marker-position e)))))
1653 ;; Done with variables
1654 ))
1656 ;; This if we are in a function definition
1658 ;; * When a function's documentation string mentions the value
1659 ;; of an argument of the function, use the argument name in
1660 ;; capital letters as if it were a name for that value. Thus,
1661 ;; the documentation string of the function `/' refers to its
1662 ;; second argument as `DIVISOR', because the actual argument
1663 ;; name is `divisor'.
1665 ;; Addendum: Make sure they appear in the doc in the same
1666 ;; order that they are found in the arg list.
1677 inopts t)
1682 ;; Require whitespace OR
1683 ;; ITEMth<space> OR
1684 ;; ITEMs<space>
1686 e t)))
1689 ;; If the symbol was not found, let's see if we
1690 ;; can find it with a different capitalization
1691 ;; and see if the user wants to capitalize it.
1695 ;; Require whitespace OR
1696 ;; ITEMth<space> OR
1697 ;; ITEMs<space>
1699 e t))
1703 "If this is the argument `%s', it should appear as %s. Fix? "
1709 ;; It wasn't found at all! Offer to attach this new symbol
1710 ;; to the end of the documentation string.
1713 "Add %s documentation to end of doc string? "
1715 ;; Now do some magic and invent a doc string.
1726 nil)
1729 "Argument `%s' should appear (as %s) in the doc string"
1736 "Arguments occur in the doc string out of order"
1738 ;; * For consistency, phrase the verb in the first sentence of a
1739 ;; documentation string for functions as an imperative.
1740 ;; For instance, use `Return the cons of A and
1741 ;; B.' in preference to `Returns the cons of A and B.'
1742 ;; Usually it looks good to do likewise for the rest of the
1743 ;; first paragraph. Subsequent paragraphs usually look better
1744 ;; if they have proper subjects.
1745 ;;
1746 ;; This is the least important of the above tests. Make sure
1747 ;; it occurs last.
1750 ;; Maybe rebuild the monster-regexp
1754 ;; check string-continuation
1761 checkdoc-common-verbs-regexp
1762 lim t))
1766 checkdoc-common-verbs-wrong-voice))
1776 replace t)
1779 ;; there was a match, but no replace
1783 original replace)
1785 ;; Done with functions
1786 )))
1787 ;;* When a documentation string refers to a Lisp symbol, write it as
1788 ;; it would be printed (which usually means in lower case), with
1789 ;; single-quotes around it. For example: ‘lambda’. There are two
1790 ;; exceptions: write t and nil without single-quotes. (For
1791 ;; compatibility with an older Emacs style, quoting with ` and '
1792 ;; also works, e.g., `lambda' is treated like ‘lambda’.)
1797 ;; Ignore manual page references like
1798 ;; git-config(1).
1800 e t))
1802 ;; A . is a \s_ char, so we must remove periods from
1803 ;; sentences more carefully.
1813 ms))
1821 ms))))))
1826 nil)))
1827 ;; t and nil case
1835 nil
1837 "Symbols t and nil should not appear in `...' quotes"
1839 ;; Here is some basic sentence formatting
1841 ;; Here are common proper nouns that should always appear capitalized.
1843 ;; Make sure the doc string has correctly spelled English words
1844 ;; in it. This function is extracted due to its complexity,
1845 ;; and reliance on the Ispell program.
1847 ;; User supplied checks
1849 ;; Done!
1850 )))
1853 "Return a list of details about the current sexp.
1854 It is a list of the form:
1855 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1856 where NAME is the name, VARIABLE is t if this is a `defvar',
1857 INTERACTIVE is nil if this is not an interactive function, otherwise
1858 it is the position of the `interactive' call, and PARAMETERS is a
1859 string which is the name of each variable in the function's argument
1860 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1861 comment for a given defun. If the first element is not a string, then
1862 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1863 from the comment."
1879 ;; The variable spot
1881 ;; Interactive
1886 t)
1887 ret)))
1891 ;; Overload th main obarray so read doesn't intern the
1892 ;; local symbols of the function we are checking.
1893 ;; Without this we end up cluttering the symbol space w/
1894 ;; useless symbols.
1896 ;; Ok, check for checkdoc parameter comment here
1904 t)
1910 t)
1924 sl1)
1925 ret)))
1926 ;; Read the list of parameters, but do not put the symbols in
1927 ;; the standard obarray.
1929 ;; This is because read will intern nil if it doesn't into the
1930 ;; new obarray.
1939 "Return non-nil if the current point is in a code fragment.
1940 A code fragment is identified by an open parenthesis followed by a
1941 symbol which is a valid function or a word in all CAPS, or a parenthesis
1942 that is quoted with the ' character. Only the region from START to LIMIT
1943 is allowed while searching for the bounding parenthesis."
1954 ;; if this string is function bound, we are in
1955 ;; sample code. If it has a - or : character in
1956 ;; the name, then it is probably supposed to be bound
1957 ;; but isn't yet.
1966 The text checked is between START and LIMIT."
1977 "Check all text between BEGIN and END for lower case proper nouns.
1978 These are Emacs centric proper nouns which should be capitalized for
1979 consistency. Return an error list if any are not fixed, but
1980 internally skip over no answers.
1981 If the offending word is in a piece of quoted text, then it is skipped."
1995 ;; surrounded by /, as in a URL or filename: /emacs/
1999 ;; info or url links left alone
2001 help-xref-info-regexp))
2003 help-xref-url-regexp)))
2006 text)
2008 nil
2010 ;; If there is already an error, then generate
2011 ;; the warning output if applicable
2015 "Name %s should appear capitalized as %s"
2017 b e))
2020 "Name %s should appear capitalized as %s"
2022 bb b be e)))))))
2026 "Make sure all sentences have double spaces between BEGIN and END."
2043 ;; piece of an abbreviation
2044 ;; FIXME etc
2049 b e
2050 "There should be two spaces after a period. Fix? "
2052 nil
2054 ;; If there is already an error, then generate
2055 ;; the warning output if applicable
2058 "There should be two spaces after a period"
2059 b e))
2061 "There should be two spaces after a period"
2062 bb b be e)))))))
2065 ;;; Ispell engine
2066 ;;
2071 "Initialize Ispell process (default version) with Lisp words.
2072 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2073 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2074 nil."
2080 ;; This code copied in part from ispell.el Emacs 19.34
2086 "Run the Ispell tools on the doc string between point and END.
2087 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2088 before using the Ispell engine on it."
2090 ;; If the user wants no questions or fixing, then we must
2091 ;; disable spell checking as not useful.
2094 nil
2101 ;; Skip lists describing meta-syntax, or bound variables
2109 ;; This is probably repetitive in most cases, but not always.
2110 nil
2111 ;; Find out how we spell-check this word.
2113 ;; All caps w/ option th, or s tacked on the end
2114 ;; for pluralization or number.
2117 )
2118 nil
2127 ;; Nothing here.
2128 )))))
2130 err))))
2132 ;;; Rogue space checking engine
2133 ;;
2135 "Return a message list if there is a line with white space at the end.
2136 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2137 If optional arguments START and END are non-nil, bound the check to
2138 this region.
2139 Optional argument INTERACT may permit the user to fix problems on the fly."
2143 ;; If end is nil, it means end of buffer to search anyway
2145 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2146 ;; (It's dangerous)
2151 "Don't use `? ' at the end of a line. \
2152 News agents may remove it"
2154 ;; If interactive is passed down, give them a chance to fix things.
2161 ;; Check for, and potentially remove whitespace appearing at the
2162 ;; end of different lines.
2165 ;; There is no documentation in the Emacs Lisp manual about this check,
2166 ;; it is intended to help clean up messy code and reduce the file size.
2168 ;; This is not a complex activity
2172 nil
2175 ;; Return an error and leave the cursor at that spot, or restore
2176 ;; the cursor.
2180 nil)))
2182 ;;; Comment checking engine
2183 ;;
2192 "Return a message list if this file does not match the Emacs standard.
2193 This checks for style only, such as the first line, Commentary:,
2194 Code:, and others referenced in the style guide."
2196 nil
2198 ;; Old XEmacs don't have `lm-commentary-mark'
2207 ;; This file has been set up where ERR is a variable. Each check is
2208 ;; asked, and the function will make sure that if the user does not
2209 ;; auto-fix some error, that we still move on to the next auto-fix,
2210 ;; AND we remember the past errors.
2212 err
2213 ;; Lisp Maintenance checks first
2214 ;; Was: (lm-verify) -> not flexible enough for some people
2215 ;; * Summary at the beginning of the file:
2217 ;; This certifies as very complex so always ask unless
2218 ;; it's set to never
2227 nil))
2229 err
2231 ;; * Commentary Section
2238 nil t)
2251 nil nil t)))
2252 nil)
2253 err))
2255 err
2257 ;; * History section. Say nothing if there is a file ChangeLog
2262 nil
2268 nil t)
2280 err))
2282 err
2284 ;; * Code section
2287 pos)
2289 ;; match ";;;###autoload" cookie to keep it with the form
2296 nil t))
2304 nil)
2308 nil)
2309 err))
2311 err
2313 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2314 ;; The following is partially clipped from lm-verify
2322 nil t))
2329 fn fn fe)
2331 err))
2332 ;; The below checks will not return errors if the user says NO
2334 ;; Let's spellcheck the commentary section. This is the only
2335 ;; section that is easy to pick out, and it is also the most
2336 ;; visible section (with the finder).
2342 ;; Since the comments talk about Lisp, use the
2343 ;; specialized spell-checker we also used for doc
2344 ;; strings.
2349 err
2351 ;; Generic Full-file checks (should be comment related)
2353 err))
2354 ;; Done with full file comment checks
2355 err)))
2358 "Return t if point is outside the bounds of a valid sexp."
2365 ;;; `error' and `message' text verifier.
2366 ;;
2368 "Search between BEG and END for a style error with message text.
2369 Optional arguments BEG and END represent the boundary of the check.
2370 The default boundary is the entire buffer."
2377 e))
2380 "Move cursor to the next checkable message string after point.
2381 Return the message classification.
2382 Argument END is the maximum bounds to search in."
2401 nil
2403 return))
2406 "Return or fix errors found in strings passed to a message display function.
2407 According to the documentation for the function `error', the error list
2408 should not end with a period, and should start with a capital letter.
2409 The function `y-or-n-p' has similar constraints.
2410 Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'."
2411 ;; If type is nil, then attempt to derive it.
2423 ;; From the documentation of the symbol `error':
2424 ;; In Emacs, the convention is that error messages start with a capital
2425 ;; letter but *do not* end with a period. Please follow this convention
2426 ;; for the sake of consistency.
2431 "Capitalize your message text? "
2433 t)))
2435 "Messages should start with a capital letter"
2437 nil)
2438 ;; In general, sentences should have two spaces after the period.
2442 ;; Look for proper nouns in this region too.
2446 ;; Here are message type specific questions.
2453 "Remove period from error? "
2454 ""
2455 t)))
2457 "Error messages should *not* end with a period"
2459 nil)
2460 ;; `y-or-n-p' documentation explicitly says:
2461 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2462 ;; I added the ? requirement. Without it, it is unclear that we
2463 ;; ask a question and it appears to be an undocumented style.
2468 nil
2472 ;; If we see a ?, then replace with "? ".
2477 nil
2488 nil
2500 nil
2504 ;; Now, let's just run the spell checker on this guy.
2507 )))
2509 ;;; Auto-fix helper functions
2510 ;;
2512 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2513 Argument QUESTION is the prompt passed to `y-or-n-p'."
2517 nil
2524 "Highlight between START and END and queries the user with QUESTION.
2525 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2526 the region marked by START and END with REPLACEWITH. If optional flag
2527 COMPLEX is non-nil, then we may ask the user a question. See the
2528 documentation for `checkdoc-autofix-flag' for details.
2530 If a section is auto-replaced without asking the user, this function
2531 will pause near the fixed code so the user will briefly see what
2532 happened.
2534 This function returns non-nil if the text was replaced.
2536 This function will not modify `match-data'."
2553 ;; On the off chance this is automatic, display
2554 ;; the question anyway so the user knows what's
2555 ;; going on.
2567 ret)))
2569 ;;; Warning management
2570 ;;
2584 "Set up the major mode for the buffer containing the list of errors."
2586 checkdoc-output-error-regex-alist)
2588 checkdoc-output-font-lock-keywords))
2591 "The name to use for a checkdoc buffer in the error list."
2597 "Initialize the checkdoc diagnostic buffer for a pass.
2598 Create the header so that the string CHECK-TYPE is displayed as the
2599 function called to create the messages."
2611 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2626 "Display the checkdoc diagnostic buffer in a temporary window."
2638 nil)))
2644 ;;; checkdoc.el ends here