| blob | e7455b3fbb71836523b74e9bb28e0aa85b7d27cb |
1 ;;; checkdoc.el --- check documentation strings for style requirements
3 ;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
7 ;; Version: 0.6.2
8 ;; Keywords: docs, maint, lisp
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
26 ;;
27 ;; The Emacs Lisp manual has a nice chapter on how to write
28 ;; documentation strings. Many stylistic suggestions are fairly
29 ;; deterministic and easy to check for syntactically, but also easy
30 ;; to forget. The main checkdoc engine will perform the stylistic
31 ;; checks needed to make sure these styles are remembered.
32 ;;
33 ;; There are two ways to use checkdoc:
34 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
35 ;; `checkdoc' is a more interactive version of
36 ;; `checkdoc-current-buffer'
37 ;; 2) Use `checkdoc-minor-mode' to automatically check your
38 ;; documentation whenever you evaluate Lisp code with C-M-x
39 ;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
40 ;; are also provided under C-c ? KEY
41 ;; (require 'checkdoc)
42 ;; (add-hook 'emacs-lisp-mode-hook
43 ;; '(lambda () (checkdoc-minor-mode 1)))
44 ;;
45 ;; Using `checkdoc':
46 ;;
47 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
48 ;; entry points to all of the different checks that are available. It
49 ;; breaks examination of your Lisp file into four sections (comments,
50 ;; documentation, messages, and spacing) and indicates its current
51 ;; state in a status buffer.
52 ;;
53 ;; The Comments check examines your headers, footers, and
54 ;; various tags (such as "Code:") to make sure that your code is ready
55 ;; for easy integration into existing systems.
56 ;;
57 ;; The Documentation check deals with documentation strings
58 ;; and their elements that help make Emacs easier to use.
59 ;;
60 ;; The Messages check ensures that the strings displayed in the
61 ;; minibuffer by some commands (such as `error' and `y-or-n-p')
62 ;; are consistent with the Emacs environment.
63 ;;
64 ;; The Spacing check cleans up white-space at the end of lines.
65 ;;
66 ;; The interface while working with documentation and messages is
67 ;; slightly different when being run in the interactive mode. The
68 ;; interface offers several options, including the ability to skip to
69 ;; the next error, or back up to previous errors. Auto-fixing is
70 ;; turned off at this stage, but you can use the `f' or `F' key to fix
71 ;; a given error (if the fix is available.)
72 ;;
73 ;; Auto-fixing:
74 ;;
75 ;; There are four classifications of style errors in terms of how
76 ;; easy they are to fix. They are simple, complex, really complex,
77 ;; and impossible. (Impossible really means that checkdoc does not
78 ;; have a fixing routine yet.) Typically white-space errors are
79 ;; classified as simple, and are auto-fixed by default. Typographic
80 ;; changes are considered complex, and the user is asked if they want
81 ;; the problem fixed before checkdoc makes the change. These changes
82 ;; can be done without asking if `checkdoc-autofix-flag' is properly
83 ;; set. Potentially redundant changes are considered really complex,
84 ;; and the user is always asked before a change is inserted. The
85 ;; variable `checkdoc-autofix-flag' controls how these types of errors
86 ;; are fixed.
87 ;;
88 ;; Spell checking text:
89 ;;
90 ;; The variable `checkdoc-spellcheck-documentation-flag' can be set
91 ;; to customize how spell checking is to be done. Since spell
92 ;; checking can be quite slow, you can optimize how best you want your
93 ;; checking done. The default is `defun', which spell checks each time
94 ;; `checkdoc-defun' or `checkdoc-eval-defun' is used. Setting to nil
95 ;; prevents spell checking during normal usage.
96 ;; Setting this variable to nil does not mean you cannot take
97 ;; advantage of the spell checking. You can instead use the
98 ;; interactive functions `checkdoc-ispell-*' to check the spelling of
99 ;; your documentation.
100 ;; There is a list of Lisp-specific words which checkdoc will
101 ;; install into Ispell on the fly, but only if Ispell is not already
102 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
103 ;; these words enabled.
104 ;;
105 ;; Checking parameters:
106 ;;
107 ;; You might not always want a function to have its parameters listed
108 ;; in order. When this is the case, put the following comment just in
109 ;; front of the documentation string: "; checkdoc-order: nil" This
110 ;; overrides the value of `checkdoc-arguments-in-order-flag'.
111 ;;
112 ;; If you specifically wish to avoid mentioning a parameter of a
113 ;; function in the doc string (such as a hidden parameter, or a
114 ;; parameter which is very obvious like events), you can have checkdoc
115 ;; skip looking for it by putting the following comment just in front
116 ;; of the documentation string: "; checkdoc-params: (args go here)"
117 ;;
118 ;; Checking message strings:
119 ;;
120 ;; The text that follows the `error' and `y-or-n-p' commands is
121 ;; also checked. The documentation for `error' clearly states some
122 ;; simple style rules to follow which checkdoc will auto-fix for you.
123 ;; `y-or-n-p' also states that it should end in a space. I added that
124 ;; it should end in "? " since that is almost always used.
125 ;;
126 ;; Adding your own checks:
127 ;;
128 ;; You can experiment with adding your own checks by setting the
129 ;; hooks `checkdoc-style-hooks' and `checkdoc-comment-style-hooks'.
130 ;; Return a string which is the error you wish to report. The cursor
131 ;; position should be preserved.
132 ;;
133 ;; Error errors:
134 ;;
135 ;; Checkdoc does not always flag errors correctly. There are a
136 ;; couple ways you can coax your file into passing all of checkdoc's
137 ;; tests through buffer local variables.
138 ;;
139 ;; The variable `checkdoc-verb-check-experimental-flag' can be used
140 ;; to turn off the check for verb-voice in case you use words that are
141 ;; not semantically verbs, but are still in the incomplete list.
142 ;;
143 ;; The variable `checkdoc-symbol-words' can be a list of words that
144 ;; happen to also be symbols. This is not a problem for one-word
145 ;; symbols, but if you use a hyphenated word that is also a symbol,
146 ;; then you may need this.
147 ;;
148 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if
149 ;; you have many undocumented functions you don't wish to document.
150 ;;
151 ;; See the above section "Checking Parameters" for details about
152 ;; parameter checking.
153 ;;
154 ;; Dependencies:
155 ;;
156 ;; This file requires lisp-mnt (Lisp maintenance routines) for the
157 ;; comment checkers.
158 ;;
159 ;; Requires custom for Emacs v20.
161 ;;; TO DO:
162 ;; Hook into the byte compiler on a defun/defvar level to generate
163 ;; warnings in the byte-compiler's warning/error buffer.
164 ;; Better ways to override more typical `eval' functions. Advice
165 ;; might be good but hard to turn on/off as a minor mode.
166 ;;
167 ;;; Maybe Do:
168 ;; Code sweep checks for "forbidden functions", proper use of hooks,
169 ;; proper keybindings, and other items from the manual that are
170 ;; not specifically docstring related. Would this even be useful?
172 ;;; Code:
183 "Support for doc string checking in Emacs Lisp."
189 "String to display in mode line when Checkdoc mode is enabled; nil for none."
195 "Non-nil means attempt auto-fixing of doc strings.
196 If this value is the symbol `query', then the user is queried before
197 any change is made. If the value is `automatic', then all changes are
198 made without asking unless the change is very-complex. If the value
199 is `semiautomatic' or any other value, then simple fixes are made
200 without asking, and complex changes are made by asking the user first.
201 The value `never' is the same as nil, never ask or change anything."
210 Setting this to nil will silently make fixes that require no user
211 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
216 "Non-nil means that all checkable definitions should have documentation.
217 Style guide dictates that interactive functions MUST have documentation,
218 and that it's good but not required practice to make non user visible items
219 have doc strings."
222 ;;;###autoload(put 'checkdoc-force-docstrings-flag 'safe-local-variable 'booleanp)
225 "Non-nil means that files should have a History section or ChangeLog file.
226 This helps document the evolution of, and recent changes to, the package."
229 ;;;###autoload(put 'checkdoc-force-history-flag 'safe-local-variable 'booleanp)
232 "Non-nil means the first line of a docstring may end with a comma.
233 Ordinarily, a full sentence is required. This may be misleading when
234 there is a substantial caveat to the one-line description -- the comma
235 should be used when the first part could stand alone as a sentence, but
236 it indicates that a modifying clause follows."
239 ;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable 'booleanp)
242 "Non-nil means run Ispell on text based on value.
243 This is automatically set to nil if Ispell does not exist on your
244 system. Possible values are:
246 nil - Don't spell-check during basic style checks.
247 defun - Spell-check when style checking a single defun
248 buffer - Spell-check when style checking the whole buffer
249 interactive - Spell-check during any interactive check.
250 t - Always spell-check"
264 Any more than this and a warning is generated suggesting that the construct
270 "Non-nil means warn if arguments appear out of order.
271 Setting this to nil will mean only checking that all the arguments
272 appear in the proper form in the documentation, not that they are in
273 the same order as they appear in the argument list. No mention is
274 made in the style guide relating to order."
277 ;;;###autoload(put 'checkdoc-arguments-in-order-flag 'safe-local-variable 'booleanp)
280 "Hooks called after the standard style check is completed.
281 All hooks must return nil or a string representing the error found.
282 Useful for adding new user implemented commands.
284 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
285 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
289 "Hooks called after the standard comment style check is completed.
290 Must return nil if no errors are found, or a string describing the
299 "Regular expression used to identify a defun.
303 "Non-nil means to attempt to check the voice of the doc string.
304 This check keys off some words which are commonly misused. See the
305 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
310 "Non-nil means generate warnings in a buffer for browsing.
311 Do not set this by hand, use a function like `checkdoc-current-buffer'
315 "A list of symbol names (strings) which also happen to make good words.
316 These words are ignored when unquoted symbols are searched for.
317 This should be set in an Emacs Lisp file's local variables."
320 ;;;###autoload(put 'checkdoc-symbol-words 'safe-local-variable 'checkdoc-list-of-strings-p)
322 ;;;###autoload
324 ;; this is a function so it might be shared by checkdoc-proper-noun-list
325 ;; and/or checkdoc-ispell-lisp-words in the future
334 ;; "[.!?]" is for noun at end of a sentence, since those chars
335 ;; are symbol syntax in emacs-lisp-mode and so don't match \\_>.
336 ;; The \" allows it to be the last sentence in a docstring too.
425 )
426 "Alist of common words in the wrong voice and what should be used instead.
427 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
428 and experimental check. Do not modify this list without setting
429 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
436 nil
438 ;; When dealing with syntax in doc strings, make sure that - are encompassed
439 ;; in words so we can use cheap \\> to get the end of a symbol, not the
440 ;; end of a word in a conglomerate.
442 )
445 ;;; Compatibility
446 ;;
462 ;;; User level commands
463 ;;
464 ;;;###autoload
466 "Interactively check the entire buffer for style errors.
467 The current status of the check will be displayed in a buffer which
468 the users will view as each check is completed."
474 ;; if the user set autofix to never, then that breaks the
475 ;; obviously requested asking implied by using this function.
476 ;; Set it to paranoia level.
479 'query
480 checkdoc-autofix-flag))
481 tmp)
483 ;; check the comments
491 ;; Check the documentation
498 ;; Check the message text
504 ;; Rogue spacing
513 "Display and update the status buffer for the current checkdoc mode.
514 CHECK is a list of four strings stating the current status of each
515 test; the nth string describes the status of the nth test."
523 )))
529 ;;;###autoload
531 "Interactively check the current buffer for doc string errors.
532 Prefix argument START-HERE will start the checking from the current
533 point, otherwise the check starts at the beginning of the current
534 buffer. Allows navigation forward and backwards through document
535 errors. Does not check for comment or space warnings.
536 Optional argument SHOWSTATUS indicates that we should update the
537 checkdoc status window instead of the usual behavior."
543 ;; Due to a design flaw, this will never spell check
544 ;; docstrings.
547 ;; This is a workaround to perform spell checking.
550 ;;;###autoload
552 "Interactively check the current buffer for message string errors.
553 Prefix argument START-HERE will start the checking from the current
554 point, otherwise the check starts at the beginning of the current
555 buffer. Allows navigation forward and backwards through document
556 errors. Does not check for comment or space warnings.
557 Optional argument SHOWSTATUS indicates that we should update the
558 checkdoc status window instead of the usual behavior."
564 ;; Due to a design flaw, this will never spell check messages.
567 ;; This is a workaround to perform spell checking.
571 "Interactively loop over all errors that can be found by a given method.
573 If START-HERE is nil, searching starts at the beginning of the current
574 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
575 expresses the verbosity of the search, and whether ending the search
576 will auto-exit this function.
578 FINDFUNC is a symbol representing a function that will position the
579 cursor, and return error message text to present to the user. It is
580 assumed that the cursor will stop just before a major sexp, which will
581 be highlighted to present the user with feedback as to the offending
582 style."
583 ;; Determine where to start the test
586 ;; Assign a flag to spellcheck flag
590 ;; Fetch the error list
594 c)
597 ;; Include whatever function point is in for good measure.
601 ;; The cursor should be just in front of the offending doc string
612 ;; Make sure the whole doc string is visible if possible.
636 ;; Exit condition
638 ;; Request an auto-fix
643 ;; `automatic-then-never' tells the autofix function
644 ;; to only allow one fix to be automatic. The autofix
645 ;; function will then set the flag to 'never, allowing
646 ;; the checker to return a different error.
668 ;; Move to the next error (if available)
674 err-list nil)
680 ;; Go backwards in the list of errors
689 ;; Edit the buffer recursively.
700 err-list nil)
704 ;; Quit checkdoc
707 err-list nil
709 ;; Goofy stuff
719 ""
721 "f, y - auto Fix this warning without asking (if\
724 )
736 returnme))
739 "Interactively spell check doc strings in the current buffer.
740 If START-HERE is nil, searching starts at the beginning of the current
741 buffer, otherwise searching starts at START-HERE."
744 ;; Move point to where we need to start.
746 ;; Include whatever function point is in for good measure.
749 ;; Loop over docstrings.
759 "Interactively spell check messages in the current buffer.
760 If START-HERE is nil, searching starts at the beginning of the current
761 buffer, otherwise searching starts at START-HERE."
764 ;; Move point to where we need to start.
766 ;; Include whatever function point is in for good measure.
769 ;; Loop over message strings.
780 "Find and return the next checkdoc error list, or nil.
781 Only documentation strings are checked.
782 An error list is of the form (WARNING . POSITION) where WARNING is the
783 warning text, and POSITION is the point in the buffer where the error
784 was found. We can use points and not markers because we promise not
785 to edit the buffer before point without re-executing this check.
786 Argument ENABLE-FIX will enable auto-fixing while looking for the next
787 error. This argument assumes that the cursor is already positioned to
788 perform the fix."
799 ;; Quit.. restore position, Other errors, leave alone
801 msg)))
804 "Find and return the next checkdoc message related error list, or nil.
805 Only text for error and `y-or-n-p' strings are checked. See
806 `checkdoc-next-error' for details on the return value.
807 Argument ENABLE-FIX turns on the auto-fix feature. This argument
808 assumes that the cursor is already positioned to perform the fix."
821 ;; Quit.. restore position, Other errors, leave alone
823 msg)))
826 "Enter recursive edit to permit a user to fix some error checkdoc has found.
827 MSG is the error that was found, which is displayed in a help buffer."
842 ;;;###autoload
844 "Evaluate and check documentation for the current buffer.
845 Evaluation is done first because good documentation for something that
846 doesn't work is just not useful. Comments, doc strings, and rogue
847 spacing are all verified."
852 ;;;###autoload
854 "Check current buffer for document, comment, error style, and rogue spaces.
855 With a prefix argument (in Lisp, the argument TAKE-NOTES),
856 store all errors found in a warnings buffer,
857 otherwise stop after the first error."
861 ;; Assign a flag to spellcheck flag
866 checkdoc-autofix-flag))
871 ;; every test is responsible for returning the cursor.
881 ;;;###autoload
883 "Start scanning the current buffer for documentation string style errors.
884 Only documentation strings are checked.
885 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
886 Prefix argument TAKE-NOTES means to collect all the warning messages into
887 a separate buffer."
894 ;; Go back since we can't be here without success above.
896 nil))
898 ;;;###autoload
900 "Find the next doc string in the current buffer which has a style error.
901 Prefix argument TAKE-NOTES means to continue through the whole buffer and
902 save warnings in a separate buffer. Second optional argument START-POINT
903 is the starting location. If this is nil, `point-min' is used instead."
906 ;; Assign a flag to spellcheck flag
911 checkdoc-autofix-flag))
915 ;; If we are taking notes, encompass the whole buffer, otherwise
916 ;; the user is navigating down through the buffer.
918 ;; OK, let's look at the doc string.
931 "Move to the next doc string after point, and return t.
932 Return nil if there are no more doc strings."
934 nil
935 ;; search drops us after the identifier. The next sexp is either
936 ;; the argument list or the value of the variable. skip it.
939 t))
941 ;;;###autoload
943 "Find missing comment sections in the current Emacs Lisp file.
944 Prefix argument TAKE-NOTES non-nil means to save warnings in a
945 separate buffer. Otherwise print a message. This returns the error
946 if there is one."
960 e))
962 ;;;###autoload
964 "Find extra spaces at the end of lines in the current file.
965 Prefix argument TAKE-NOTES non-nil means to save warnings in a
966 separate buffer. Otherwise print a message. This returns the error
967 if there is one.
968 Optional argument INTERACT permits more interactive fixing."
976 e
982 ;;;###autoload
984 "Scan the buffer for occurrences of the error function, and verify text.
985 Optional argument TAKE-NOTES causes all errors to be logged."
994 e
1002 ;;;###autoload
1004 "Evaluate the current form with `eval-defun' and check its documentation.
1005 Evaluation is done first so the form will be read before the
1006 documentation is checked. If there is a documentation error, then the display
1007 of what was evaluated will be overwritten by the diagnostic message."
1012 ;;;###autoload
1014 "Examine the doc string of the function or variable under point.
1015 Call `error' if the doc string has problems. If NO-ERROR is
1016 non-nil, then do not call error, but call `message' instead.
1017 If the doc string passes the test, then check the function for rogue white
1018 space at the end of each line."
1023 ;; I found this more annoying than useful.
1024 ;;(if (not no-error)
1025 ;; (message "Cannot check this sexp's doc string."))
1026 nil
1027 ;; search drops us after the identifier. The next sexp is either
1028 ;; the argument list or the value of the variable. skip it.
1052 ;;; Ispell interface for forcing a spell check
1053 ;;
1055 ;;;###autoload
1057 "Check the style and spelling of everything interactively.
1058 Calls `checkdoc' with spell-checking turned on.
1059 Prefix argument TAKE-NOTES is the same as for `checkdoc'"
1064 ;;;###autoload
1066 "Check the style and spelling of the current buffer.
1067 Calls `checkdoc-current-buffer' with spell-checking turned on.
1068 Prefix argument TAKE-NOTES is the same as for `checkdoc-current-buffer'"
1073 ;;;###autoload
1075 "Check the style and spelling of the current buffer interactively.
1076 Calls `checkdoc-interactive' with spell-checking turned on.
1077 Prefix argument TAKE-NOTES is the same as for `checkdoc-interactive'"
1082 ;;;###autoload
1084 "Check the style and spelling of message text interactively.
1085 Calls `checkdoc-message-interactive' with spell-checking turned on.
1086 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-interactive'"
1091 ;;;###autoload
1093 "Check the style and spelling of message text interactively.
1094 Calls `checkdoc-message-text' with spell-checking turned on.
1095 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-text'"
1100 ;;;###autoload
1102 "Check the style and spelling of the current buffer.
1103 Calls `checkdoc-start' with spell-checking turned on.
1104 Prefix argument TAKE-NOTES is the same as for `checkdoc-start'"
1109 ;;;###autoload
1111 "Check the style and spelling of the current buffer after point.
1112 Calls `checkdoc-continue' with spell-checking turned on.
1113 Prefix argument TAKE-NOTES is the same as for `checkdoc-continue'"
1118 ;;;###autoload
1120 "Check the style and spelling of the current buffer's comments.
1121 Calls `checkdoc-comments' with spell-checking turned on.
1122 Prefix argument TAKE-NOTES is the same as for `checkdoc-comments'"
1127 ;;;###autoload
1129 "Check the style and spelling of the current defun with Ispell.
1130 Calls `checkdoc-defun' with spell-checking turned on.
1131 Prefix argument TAKE-NOTES is the same as for `checkdoc-defun'"
1136 ;;; Error Management
1137 ;;
1138 ;; Errors returned from checkdoc functions can have various
1139 ;; features and behaviors, so we need some ways of specifying
1140 ;; them, and making them easier to use in the wacked-out interfaces
1141 ;; people are requesting
1143 "Used to create the return error text returned from all engines.
1144 TEXT is the descriptive text of the error. START and END define the region
1145 it is sensible to highlight when describing the problem.
1146 Optional argument UNFIXABLE means that the error has no auto-fix available.
1148 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1149 generating a buffered list of errors."
1152 nil)
1156 "Return the text specified in the checkdoc ERR."
1157 ;; string-p part is for backwards compatibility
1161 "Return the start point specified in the checkdoc ERR."
1162 ;; string-p part is for backwards compatibility
1166 "Return the end point specified in the checkdoc ERR."
1167 ;; string-p part is for backwards compatibility
1171 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1172 ;; string-p part is for backwards compatibility
1175 ;;; Minor Mode specification
1176 ;;
1181 ;; Override some bindings
1187 ;; Add some new bindings under C-c ?
1205 ;; bind our submap into map
1207 map)
1213 ;; Add in a menubar with easy-menu
1216 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1222 "---"
1231 checkdoc-ispell-message-interactive t]
1236 buffer-file-name]
1238 "---"
1243 ))
1244 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1245 ;; What is it?
1247 ;;;###autoload
1249 "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings.
1250 With prefix ARG, turn Checkdoc minor mode on if ARG is positive, otherwise
1251 turn it off.
1253 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1254 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1255 checking of documentation strings.
1258 nil checkdoc-minor-mode-string nil
1261 ;;; Subst utils
1262 ;;
1264 "Run hooks in HOOKVAR with ARGS."
1267 ;; This method was similar to above. We ignore the warning
1268 ;; since we will use the above for future Emacs versions
1272 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1280 ;; Profiler says this is not yet faster than just calling assoc
1281 ;;(defun checkdoc-word-in-alist-vector (word vector)
1282 ;; "Check to see if WORD is in the car of an element of VECTOR.
1283 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1284 ;;word list is getting bigger, it is time for a quick bisecting search."
1285 ;; (let ((max (length vector)) (min 0) i
1286 ;; (found nil) (fw nil))
1287 ;; (setq i (/ max 2))
1288 ;; (while (and (not found) (/= min max))
1289 ;; (setq fw (car (aref vector i)))
1290 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1291 ;; ((string< word fw) (setq max i))
1292 ;; (t (setq min i)))
1293 ;; (setq i (/ (+ max min) 2))
1294 ;; )
1295 ;; found))
1297 ;;; Checking engines
1298 ;;
1300 "Return a message string if the current doc string is invalid.
1301 Check for style only, such as the first line always being a complete
1302 sentence, whitespace restrictions, and making sure there are no
1303 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1304 See the style guide in the Emacs Lisp manual for more details."
1306 ;; Jump over comments between the last object and the doc string
1315 err
1316 ;; * Every command, function, or variable intended for users to know
1317 ;; about should have a documentation string.
1318 ;;
1319 ;; * An internal variable or subroutine of a Lisp program might as well
1320 ;; have a documentation string. In earlier Emacs versions, you could
1321 ;; save space by using a comment instead of a documentation string,
1322 ;; but that is no longer the case.
1327 ;; Sometimes old code has comments where the documentation should
1328 ;; be. Let's see if we can find the comment, and offer to turn it
1329 ;; into documentation for them.
1345 ;; Our point is at the beginning of the comment!
1346 ;; Insert a quote, then remove the comment chars.
1365 ;; quote any double-quote characters in the comment.
1371 "You should convert this comment to documentation"
1375 "All interactive functions should have documentation"
1376 "All variables and subroutines might as well have a \
1386 err)))
1389 "Return an error list or string if the current doc string is invalid.
1390 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1391 regexp short cuts work. FP is the function defun information."
1393 ;; Use a marker so if an early check modifies the text,
1394 ;; we won't accidentally loose our place. This could cause
1395 ;; end-of doc string whitespace to also delete the " char.
1401 ;; * *Do not* indent subsequent lines of a documentation string so that
1402 ;; the text is lined up in the source code with the text of the first
1403 ;; line. This looks nice in the source code, but looks bizarre when
1404 ;; users view the documentation. Remember that the indentation
1405 ;; before the starting double-quote is not part of the string!
1413 "Remove this whitespace? "
1415 nil
1417 "Second line should not have indentation"
1420 ;; * Check for '(' in column 0.
1425 "Escape this '('? "
1427 nil
1429 "Open parenthesis in column 0 should be escaped"
1431 ;; * Do not start or end a documentation string with whitespace.
1444 nil
1446 "Documentation strings should not start or end with whitespace"
1447 start end))))
1448 ;; * The first line of the documentation string should consist of one
1449 ;; or two complete sentences that stand on their own as a summary.
1450 ;; `M-x apropos' displays just the first line, and if it doesn't
1451 ;; stand on its own, the result looks bad. In particular, start the
1452 ;; first line with a capital letter and end with a period.
1460 ;; A backslashed double quote at the end of a sentence
1462 ;; We might have to add a period in this case
1465 nil
1470 nil
1472 "First sentence should end with punctuation"
1475 ;; These are ok
1476 nil)
1478 nil)
1480 ;; If it is not a complete sentence, let's see if we can
1481 ;; predict a clever way to make it one.
1486 ;; Here we have found a complete sentence, but no break.
1489 "First line not a complete sentence. Add RET here? "
1502 ;; We can merge these lines! Replace this CR
1503 ;; with a space.
1506 ;; Let's see if there is enough room to draw the next
1507 ;; line's sentence up here. I often get hit w/
1508 ;; auto-fill moving my words around.
1517 t)
1521 "1st line not a complete sentence. Join these lines? "
1524 ;; They said yes. We have more fill work to do...
1534 nil) ))))
1535 ;; Continuation of above. Make sure our sentence is capitalized.
1542 t)
1543 nil
1545 "First line should be capitalized"
1547 nil))
1548 ;; * Don't write key sequences directly in documentation strings.
1549 ;; Instead, use the `\\[...]' construct to stand for them.
1554 ;; Find the first key sequence not in a sample
1564 ;; It is not practical to use `\\[...]' very many times, because
1565 ;; display of the documentation string will become slow. So use this
1566 ;; to describe the most important commands in your major mode, and
1567 ;; then use `\\{...}' to display the rest of the mode's keymap.
1575 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1576 ;; and is referred to in documentation, it should be prefixed with
1577 ;; something to disambiguate it. This check must be before the
1578 ;; 80 column check because it will probably break that.
1596 ;; We didn't actually replace anything. Here we find
1597 ;; out what special word form they wish to use as
1598 ;; a prefix.
1601 "Disambiguating Keyword (default variable): "
1613 nil)))
1614 ;; * Format the documentation string so that it fits in an
1615 ;; Emacs window on an 80-column screen. It is a good idea
1616 ;; for most lines to be no wider than 60 characters. The
1617 ;; first line can be wider if necessary to fit the
1618 ;; information that ought to be there.
1627 eol t))
1633 "Some lines are over 80 columns wide"
1635 ;; Here we deviate to tests based on a variable or function.
1636 ;; We must do this before checking for symbols in quotes because there
1637 ;; is a chance that just such a symbol might really be an argument.
1639 ;; This is if we are in a variable
1641 ;; * The documentation string for a variable that is a
1642 ;; yes-or-no flag should start with words such as Non-nil
1643 ;; means..., to make it clear that all non-`nil' values are
1644 ;; equivalent and indicate explicitly what `nil' and non-`nil'
1645 ;; mean.
1646 ;; * If a user option variable records a true-or-false
1647 ;; condition, give it a name that ends in `-flag'.
1649 ;; If the variable has -flag in the name, make sure
1653 "Flag variable doc strings should usually start: Non-nil means"
1655 ;; Don't rename variable to "foo-flag". This is unnecessary
1656 ;; and such names often end up inconvenient when the variable
1657 ;; is later expanded to non-boolean values. --Stef
1658 ;; If the doc string starts with "Non-nil means"
1659 ;; (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+")
1660 ;; (not (string-match "-flag$" (car fp))))
1661 ;; (let ((newname
1662 ;; (if (string-match "-p$" (car fp))
1663 ;; (concat (substring (car fp) 0 -2) "-flag")
1664 ;; (concat (car fp) "-flag"))))
1665 ;; (if (checkdoc-y-or-n-p
1666 ;; (format
1667 ;; "Rename to %s and Query-Replace all occurrences? "
1668 ;; newname))
1669 ;; (progn
1670 ;; (beginning-of-defun)
1671 ;; (query-replace-regexp
1672 ;; (concat "\\<" (regexp-quote (car fp)) "\\>")
1673 ;; newname))
1674 ;; (checkdoc-create-error
1675 ;; "Flag variable names should normally end in `-flag'" s
1676 ;; (marker-position e)))))
1677 ;; Done with variables
1678 ))
1680 ;; This if we are in a function definition
1682 ;; * When a function's documentation string mentions the value
1683 ;; of an argument of the function, use the argument name in
1684 ;; capital letters as if it were a name for that value. Thus,
1685 ;; the documentation string of the function `/' refers to its
1686 ;; second argument as `DIVISOR', because the actual argument
1687 ;; name is `divisor'.
1689 ;; Addendum: Make sure they appear in the doc in the same
1690 ;; order that they are found in the arg list.
1700 inopts t)
1705 ;; Require whitespace OR
1706 ;; ITEMth<space> OR
1707 ;; ITEMs<space>
1709 e t)))
1712 ;; If the symbol was not found, let's see if we
1713 ;; can find it with a different capitalization
1714 ;; and see if the user wants to capitalize it.
1718 ;; Require whitespace OR
1719 ;; ITEMth<space> OR
1720 ;; ITEMs<space>
1722 e t))
1726 "If this is the argument `%s', it should appear as %s. Fix? "
1732 ;; It wasn't found at all! Offer to attach this new symbol
1733 ;; to the end of the documentation string.
1736 "Add %s documentation to end of doc string? "
1738 ;; Now do some magic and invent a doc string.
1749 nil)
1752 "Argument `%s' should appear (as %s) in the doc string"
1759 "Arguments occur in the doc string out of order"
1761 ;; * For consistency, phrase the verb in the first sentence of a
1762 ;; documentation string for functions as an imperative.
1763 ;; For instance, use `Return the cons of A and
1764 ;; B.' in preference to `Returns the cons of A and B.'
1765 ;; Usually it looks good to do likewise for the rest of the
1766 ;; first paragraph. Subsequent paragraphs usually look better
1767 ;; if they have proper subjects.
1768 ;;
1769 ;; This is the least important of the above tests. Make sure
1770 ;; it occurs last.
1773 ;; Maybe rebuild the monster-regexp
1777 ;; check string-continuation
1785 checkdoc-common-verbs-regexp
1786 lim t))
1790 checkdoc-common-verbs-wrong-voice))
1800 replace t)
1803 ;; there was a match, but no replace
1807 original replace)
1809 ;; Done with functions
1810 )))
1811 ;;* When a documentation string refers to a Lisp symbol, write it as
1812 ;; it would be printed (which usually means in lower case), with
1813 ;; single-quotes around it. For example: `lambda'. There are two
1814 ;; exceptions: write t and nil without single-quotes. (In this
1815 ;; manual, we normally do use single-quotes for those symbols.)
1821 e t))
1823 ;; A . is a \s_ char, so we must remove periods from
1824 ;; sentences more carefully.
1834 ms))
1842 ms))))))
1847 nil)))
1848 ;; t and nil case
1856 nil
1858 "Symbols t and nil should not appear in `...' quotes"
1860 ;; Here is some basic sentence formatting
1862 ;; Here are common proper nouns that should always appear capitalized.
1864 ;; Make sure the doc string has correctly spelled English words
1865 ;; in it. This function is extracted due to its complexity,
1866 ;; and reliance on the Ispell program.
1868 ;; User supplied checks
1870 ;; Done!
1871 )))
1874 "Return a list of details about the current sexp.
1875 It is a list of the form:
1876 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1877 where NAME is the name, VARIABLE is t if this is a `defvar',
1878 INTERACTIVE is nil if this is not an interactive function, otherwise
1879 it is the position of the `interactive' call, and PARAMETERS is a
1880 string which is the name of each variable in the function's argument
1881 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1882 comment for a given defun. If the first element is not a string, then
1883 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1884 from the comment."
1900 ;; The variable spot
1902 ;; Interactive
1907 t)
1908 ret)))
1912 ;; Overload th main obarray so read doesn't intern the
1913 ;; local symbols of the function we are checking.
1914 ;; Without this we end up cluttering the symbol space w/
1915 ;; useless symbols.
1917 ;; Ok, check for checkdoc parameter comment here
1925 t)
1931 t)
1945 sl1)
1946 ret)))
1947 ;; Read the list of parameters, but do not put the symbols in
1948 ;; the standard obarray.
1950 ;; This is because read will intern nil if it doesn't into the
1951 ;; new obarray.
1960 "Return non-nil if the current point is in a code fragment.
1961 A code fragment is identified by an open parenthesis followed by a
1962 symbol which is a valid function or a word in all CAPS, or a parenthesis
1963 that is quoted with the ' character. Only the region from START to LIMIT
1964 is is allowed while searching for the bounding parenthesis."
1975 ;; if this string is function bound, we are in
1976 ;; sample code. If it has a - or : character in
1977 ;; the name, then it is probably supposed to be bound
1978 ;; but isn't yet.
1987 The text checked is between START and LIMIT."
1998 "Check all text between BEGIN and END for lower case proper nouns.
1999 These are Emacs centric proper nouns which should be capitalized for
2000 consistency. Return an error list if any are not fixed, but
2001 internally skip over no answers.
2002 If the offending word is in a piece of quoted text, then it is skipped."
2019 ;; surrounded by /, as in a URL or filename: /emacs/
2023 ;; info or url links left alone
2025 help-xref-info-regexp))
2027 help-xref-url-regexp)))
2030 text)
2032 nil
2034 ;; If there is already an error, then generate
2035 ;; the warning output if applicable
2039 "Name %s should appear capitalized as %s"
2041 b e))
2044 "Name %s should appear capitalized as %s"
2046 bb b be e)))))))
2051 "Make sure all sentences have double spaces between BEGIN and END."
2071 ;; piece of an abbreviation
2072 ;; FIXME etc
2077 b e
2078 "There should be two spaces after a period. Fix? "
2080 nil
2082 ;; If there is already an error, then generate
2083 ;; the warning output if applicable
2086 "There should be two spaces after a period"
2087 b e))
2089 "There should be two spaces after a period"
2090 bb b be e)))))))
2094 ;;; Ispell engine
2095 ;;
2099 "Initialize Ispell process (default version) with Lisp words.
2100 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2101 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2102 nil."
2108 ;; This code copied in part from ispell.el Emacs 19.34
2112 ;; Silence byte compiler
2119 "Run the Ispell tools on the doc string between point and END.
2120 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2121 before using the Ispell engine on it."
2123 ;; If the user wants no questions or fixing, then we must
2124 ;; disable spell checking as not useful.
2127 nil
2134 ;; Skip lists describing meta-syntax, or bound variables
2142 ;; This is probably repetitive in most cases, but not always.
2143 nil
2144 ;; Find out how we spell-check this word.
2146 ;; All caps w/ option th, or s tacked on the end
2147 ;; for pluralization or numberthness.
2150 )
2151 nil
2160 ;; Nothing here.
2161 )))))
2163 err))))
2165 ;;; Rogue space checking engine
2166 ;;
2168 "Return a message list if there is a line with white space at the end.
2169 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2170 If optional arguments START and END are non-nil, bound the check to
2171 this region.
2172 Optional argument INTERACT may permit the user to fix problems on the fly."
2176 ;; If end is nil, it means end of buffer to search anyway
2178 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2179 ;; (It's dangerous)
2184 "Don't use `? ' at the end of a line. \
2185 News agents may remove it"
2187 ;; If interactive is passed down, give them a chance to fix things.
2194 ;; Check for, and potentially remove whitespace appearing at the
2195 ;; end of different lines.
2198 ;; There is no documentation in the Emacs Lisp manual about this check,
2199 ;; it is intended to help clean up messy code and reduce the file size.
2201 ;; This is not a complex activity
2205 nil
2208 ;; Return an error and leave the cursor at that spot, or restore
2209 ;; the cursor.
2213 nil)))
2215 ;;; Comment checking engine
2216 ;;
2218 ;; We must load this to:
2219 ;; a) get symbols for compile and
2220 ;; b) determine if we have lm-history symbol which doesn't always exist
2226 "Return a message list if this file does not match the Emacs standard.
2227 This checks for style only, such as the first line, Commentary:,
2228 Code:, and others referenced in the style guide."
2230 nil
2232 ;; Old XEmacs don't have `lm-commentary-mark'
2241 ;; This file has been set up where ERR is a variable. Each check is
2242 ;; asked, and the function will make sure that if the user does not
2243 ;; auto-fix some error, that we still move on to the next auto-fix,
2244 ;; AND we remember the past errors.
2246 err
2247 ;; Lisp Maintenance checks first
2248 ;; Was: (lm-verify) -> not flexible enough for some people
2249 ;; * Summary at the beginning of the file:
2251 ;; This certifies as very complex so always ask unless
2252 ;; it's set to never
2261 nil))
2263 err
2265 ;; * Commentary Section
2272 nil t)
2285 nil nil t)))
2286 nil)
2287 err))
2289 err
2291 ;; * History section. Say nothing if there is a file ChangeLog
2297 nil
2303 nil t)
2315 err))
2317 err
2319 ;; * Code section
2322 pos)
2324 ;; match ";;;###autoload" cookie to keep it with the form
2331 nil t))
2339 nil)
2343 nil)
2344 err))
2346 err
2348 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2349 ;; The following is partially clipped from lm-verify
2357 nil t))
2364 fn fn fe)
2366 err))
2367 ;; The below checks will not return errors if the user says NO
2369 ;; Let's spellcheck the commentary section. This is the only
2370 ;; section that is easy to pick out, and it is also the most
2371 ;; visible section (with the finder).
2377 ;; Since the comments talk about Lisp, use the
2378 ;; specialized spell-checker we also used for doc
2379 ;; strings.
2384 err
2386 ;; Generic Full-file checks (should be comment related)
2388 err))
2389 ;; Done with full file comment checks
2390 err)))
2393 "Return t if point is outside the bounds of a valid sexp."
2400 ;;; `error' and `message' text verifier.
2401 ;;
2403 "Search between BEG and END for a style error with message text.
2404 Optional arguments BEG and END represent the boundary of the check.
2405 The default boundary is the entire buffer."
2412 e))
2415 "Move cursor to the next checkable message string after point.
2416 Return the message classification.
2417 Argument END is the maximum bounds to search in."
2436 nil
2438 return))
2441 "Return or fix errors found in strings passed to a message display function.
2442 According to the documentation for the function `error', the error list
2443 should not end with a period, and should start with a capital letter.
2444 The function `y-or-n-p' has similar constraints.
2445 Argument TYPE specifies the type of question, such as `error or `y-or-n-p."
2446 ;; If type is nil, then attempt to derive it.
2458 ;; From the documentation of the symbol `error':
2459 ;; In Emacs, the convention is that error messages start with a capital
2460 ;; letter but *do not* end with a period. Please follow this convention
2461 ;; for the sake of consistency.
2466 "Capitalize your message text? "
2468 t)))
2470 "Messages should start with a capital letter"
2472 nil)
2473 ;; In general, sentences should have two spaces after the period.
2477 ;; Look for proper nouns in this region too.
2481 ;; Here are message type specific questions.
2488 "Remove period from error? "
2489 ""
2490 t)))
2492 "Error messages should *not* end with a period"
2494 nil)
2495 ;; `y-or-n-p' documentation explicitly says:
2496 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2497 ;; I added the ? requirement. Without it, it is unclear that we
2498 ;; ask a question and it appears to be an undocumented style.
2503 nil
2507 ;; If we see a ?, then replace with "? ".
2512 nil
2523 nil
2535 nil
2539 ;; Now, let's just run the spell checker on this guy.
2542 )))
2544 ;;; Auto-fix helper functions
2545 ;;
2547 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2548 Argument QUESTION is the prompt passed to `y-or-n-p'."
2552 nil
2559 "Highlight between START and END and queries the user with QUESTION.
2560 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2561 the region marked by START and END with REPLACEWITH. If optional flag
2562 COMPLEX is non-nil, then we may ask the user a question. See the
2563 documentation for `checkdoc-autofix-flag' for details.
2565 If a section is auto-replaced without asking the user, this function
2566 will pause near the fixed code so the user will briefly see what
2567 happened.
2569 This function returns non-nil if the text was replaced.
2571 This function will not modify `match-data'."
2588 ;; On the off chance this is automatic, display
2589 ;; the question anyway so the user knows what's
2590 ;; going on.
2602 ret)))
2604 ;;; Warning management
2605 ;;
2619 "Set up the major mode for the buffer containing the list of errors."
2621 checkdoc-output-error-regex-alist)
2623 checkdoc-output-font-lock-keywords))
2626 "The name to use for a checkdoc buffer in the error list."
2632 "Initialize the checkdoc diagnostic buffer for a pass.
2633 Create the header so that the string CHECK-TYPE is displayed as the
2634 function called to create the messages."
2646 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2658 "Display the checkdoc diagnostic buffer in a temporary window."
2669 nil)))
2682 ;; arch-tag: c49a7ec8-3bb7-46f2-bfbc-d5f26e033b26
2683 ;;; checkdoc.el ends here