| blob | 731f1ca06dfcd060d3605cda98e24447f65dbc98 |
1 ;;; checkdoc.el --- check documentation strings for style requirements
3 ;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 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, or (at your option)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
28 ;;
29 ;; The Emacs Lisp manual has a nice chapter on how to write
30 ;; documentation strings. Many stylistic suggestions are fairly
31 ;; deterministic and easy to check for syntactically, but also easy
32 ;; to forget. The main checkdoc engine will perform the stylistic
33 ;; checks needed to make sure these styles are remembered.
34 ;;
35 ;; There are two ways to use checkdoc:
36 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
37 ;; `checkdoc' is a more interactive version of
38 ;; `checkdoc-current-buffer'
39 ;; 2) Use `checkdoc-minor-mode' to automatically check your
40 ;; documentation whenever you evaluate Lisp code with C-M-x
41 ;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
42 ;; are also provided under C-c ? KEY
43 ;; (require 'checkdoc)
44 ;; (add-hook 'emacs-lisp-mode-hook
45 ;; '(lambda () (checkdoc-minor-mode 1)))
46 ;;
47 ;; Using `checkdoc':
48 ;;
49 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
50 ;; entry points to all of the different checks that are available. It
51 ;; breaks examination of your Lisp file into four sections (comments,
52 ;; documentation, messages, and spacing) and indicates its current
53 ;; state in a status buffer.
54 ;;
55 ;; The Comments check examines your headers, footers, and
56 ;; various tags (such as "Code:") to make sure that your code is ready
57 ;; for easy integration into existing systems.
58 ;;
59 ;; The Documentation check deals with documentation strings
60 ;; and their elements that help make Emacs easier to use.
61 ;;
62 ;; The Messages check ensures that the strings displayed in the
63 ;; minibuffer by some commands (such as `error' and `y-or-n-p')
64 ;; are consistent with the Emacs environment.
65 ;;
66 ;; The Spacing check cleans up white-space at the end of lines.
67 ;;
68 ;; The interface while working with documentation and messages is
69 ;; slightly different when being run in the interactive mode. The
70 ;; interface offers several options, including the ability to skip to
71 ;; the next error, or back up to previous errors. Auto-fixing is
72 ;; turned off at this stage, but you can use the `f' or `F' key to fix
73 ;; a given error (if the fix is available.)
74 ;;
75 ;; Auto-fixing:
76 ;;
77 ;; There are four classifications of style errors in terms of how
78 ;; easy they are to fix. They are simple, complex, really complex,
79 ;; and impossible. (Impossible really means that checkdoc does not
80 ;; have a fixing routine yet.) Typically white-space errors are
81 ;; classified as simple, and are auto-fixed by default. Typographic
82 ;; changes are considered complex, and the user is asked if they want
83 ;; the problem fixed before checkdoc makes the change. These changes
84 ;; can be done without asking if `checkdoc-autofix-flag' is properly
85 ;; set. Potentially redundant changes are considered really complex,
86 ;; and the user is always asked before a change is inserted. The
87 ;; variable `checkdoc-autofix-flag' controls how these types of errors
88 ;; are fixed.
89 ;;
90 ;; Spell checking text:
91 ;;
92 ;; The variable `checkdoc-spellcheck-documentation-flag' can be set
93 ;; to customize how spell checking is to be done. Since spell
94 ;; checking can be quite slow, you can optimize how best you want your
95 ;; checking done. The default is `defun', which spell checks each time
96 ;; `checkdoc-defun' or `checkdoc-eval-defun' is used. Setting to nil
97 ;; prevents spell checking during normal usage.
98 ;; Setting this variable to nil does not mean you cannot take
99 ;; advantage of the spell checking. You can instead use the
100 ;; interactive functions `checkdoc-ispell-*' to check the spelling of
101 ;; your documentation.
102 ;; There is a list of Lisp-specific words which checkdoc will
103 ;; install into Ispell on the fly, but only if Ispell is not already
104 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
105 ;; these words enabled.
106 ;;
107 ;; Checking parameters:
108 ;;
109 ;; You might not always want a function to have its parameters listed
110 ;; in order. When this is the case, put the following comment just in
111 ;; front of the documentation string: "; checkdoc-order: nil" This
112 ;; overrides the value of `checkdoc-arguments-in-order-flag'.
113 ;;
114 ;; If you specifically wish to avoid mentioning a parameter of a
115 ;; function in the doc string (such as a hidden parameter, or a
116 ;; parameter which is very obvious like events), you can have checkdoc
117 ;; skip looking for it by putting the following comment just in front
118 ;; of the documentation string: "; checkdoc-params: (args go here)"
119 ;;
120 ;; Checking message strings:
121 ;;
122 ;; The text that follows the `error' and `y-or-n-p' commands is
123 ;; also checked. The documentation for `error' clearly states some
124 ;; simple style rules to follow which checkdoc will auto-fix for you.
125 ;; `y-or-n-p' also states that it should end in a space. I added that
126 ;; it should end in "? " since that is almost always used.
127 ;;
128 ;; Adding your own checks:
129 ;;
130 ;; You can experiment with adding your own checks by setting the
131 ;; hooks `checkdoc-style-hooks' and `checkdoc-comment-style-hooks'.
132 ;; Return a string which is the error you wish to report. The cursor
133 ;; position should be preserved.
134 ;;
135 ;; Error errors:
136 ;;
137 ;; Checkdoc does not always flag errors correctly. There are a
138 ;; couple ways you can coax your file into passing all of checkdoc's
139 ;; tests through buffer local variables.
140 ;;
141 ;; The variable `checkdoc-verb-check-experimental-flag' can be used
142 ;; to turn off the check for verb-voice in case you use words that are
143 ;; not semantically verbs, but are still in the incomplete list.
144 ;;
145 ;; The variable `checkdoc-symbol-words' can be a list of words that
146 ;; happen to also be symbols. This is not a problem for one-word
147 ;; symbols, but if you use a hyphenated word that is also a symbol,
148 ;; then you may need this.
149 ;;
150 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if
151 ;; you have many undocumented functions you don't wish to document.
152 ;;
153 ;; See the above section "Checking Parameters" for details about
154 ;; parameter checking.
155 ;;
156 ;; Dependencies:
157 ;;
158 ;; This file requires lisp-mnt (Lisp maintenance routines) for the
159 ;; comment checkers.
160 ;;
161 ;; Requires custom for Emacs v20.
163 ;;; TO DO:
164 ;; Hook into the byte compiler on a defun/defvar level to generate
165 ;; warnings in the byte-compiler's warning/error buffer.
166 ;; Better ways to override more typical `eval' functions. Advice
167 ;; might be good but hard to turn on/off as a minor mode.
168 ;;
169 ;;; Maybe Do:
170 ;; Code sweep checks for "forbidden functions", proper use of hooks,
171 ;; proper keybindings, and other items from the manual that are
172 ;; not specifically docstring related. Would this even be useful?
174 ;;; Code:
182 "Support for doc string checking in Emacs Lisp."
188 "*String to display in mode line when Checkdoc mode is enabled; nil for none."
194 "Non-nil means attempt auto-fixing of doc strings.
195 If this value is the symbol `query', then the user is queried before
196 any change is made. If the value is `automatic', then all changes are
197 made without asking unless the change is very-complex. If the value
198 is `semiautomatic' or any other value, then simple fixes are made
199 without asking, and complex changes are made by asking the user first.
200 The value `never' is the same as nil, never ask or change anything."
209 Setting this to nil will silently make fixes that require no user
210 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
215 "Non-nil means that all checkable definitions should have documentation.
216 Style guide dictates that interactive functions MUST have documentation,
217 and that it's good but not required practice to make non user visible items
218 have doc strings."
221 ;;;###autoload(put 'checkdoc-force-docstrings-flag 'safe-local-variable 'booleanp)
224 "Non-nil means that files should have a History section or ChangeLog file.
225 This helps document the evolution of, and recent changes to, the package."
230 "Non-nil means the first line of a docstring may end with a comma.
231 Ordinarily, a full sentence is required. This may be misleading when
232 there is a substantial caveat to the one-line description -- the comma
233 should be used when the first part could stand alone as a sentence, but
234 it indicates that a modifying clause follows."
237 ;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable 'booleanp)
240 "Non-nil means run Ispell on text based on value.
241 This is automatically set to nil if Ispell does not exist on your
242 system. Possible values are:
244 nil - Don't spell-check during basic style checks.
245 defun - Spell-check when style checking a single defun
246 buffer - Spell-check when style checking the whole buffer
247 interactive - Spell-check during any interactive check.
248 t - Always spell-check"
262 Any more than this and a warning is generated suggesting that the construct
268 "Non-nil means warn if arguments appear out of order.
269 Setting this to nil will mean only checking that all the arguments
270 appear in the proper form in the documentation, not that they are in
271 the same order as they appear in the argument list. No mention is
272 made in the style guide relating to order."
277 "Hooks called after the standard style check is completed.
278 All hooks must return nil or a string representing the error found.
279 Useful for adding new user implemented commands.
281 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
282 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
286 "Hooks called after the standard comment style check is completed.
287 Must return nil if no errors are found, or a string describing the
296 "Regular expression used to identify a defun.
300 "Non-nil means to attempt to check the voice of the doc string.
301 This check keys off some words which are commonly misused. See the
302 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
307 "Non-nil means generate warnings in a buffer for browsing.
308 Do not set this by hand, use a function like `checkdoc-current-buffer'
312 "A list of symbols which also happen to make good words.
313 These symbol-words are ignored when unquoted symbols are searched for.
314 This should be set in an Emacs Lisp file's local variables."
414 )
415 "Alist of common words in the wrong voice and what should be used instead.
416 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
417 and experimental check. Do not modify this list without setting
418 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
425 nil
427 ;; When dealing with syntax in doc strings, make sure that - are encompassed
428 ;; in words so we can use cheap \\> to get the end of a symbol, not the
429 ;; end of a word in a conglomerate.
431 )
434 ;;; Compatibility
435 ;;
451 ;;; User level commands
452 ;;
453 ;;;###autoload
455 "Interactively check the entire buffer for style errors.
456 The current status of the check will be displayed in a buffer which
457 the users will view as each check is completed."
463 ;; if the user set autofix to never, then that breaks the
464 ;; obviously requested asking implied by using this function.
465 ;; Set it to paranoia level.
468 'query
469 checkdoc-autofix-flag))
470 tmp)
472 ;; check the comments
480 ;; Check the documentation
487 ;; Check the message text
493 ;; Rogue spacing
502 "Display and update the status buffer for the current checkdoc mode.
503 CHECK is a list of four strings stating the current status of each
504 test; the nth string describes the status of the nth test."
512 )))
518 ;;;###autoload
520 "Interactively check the current buffer for doc string errors.
521 Prefix argument START-HERE will start the checking from the current
522 point, otherwise the check starts at the beginning of the current
523 buffer. Allows navigation forward and backwards through document
524 errors. Does not check for comment or space warnings.
525 Optional argument SHOWSTATUS indicates that we should update the
526 checkdoc status window instead of the usual behavior."
532 ;; Due to a design flaw, this will never spell check
533 ;; docstrings.
536 ;; This is a workaround to perform spell checking.
539 ;;;###autoload
541 "Interactively check the current buffer for message string errors.
542 Prefix argument START-HERE will start the checking from the current
543 point, otherwise the check starts at the beginning of the current
544 buffer. Allows navigation forward and backwards through document
545 errors. Does not check for comment or space warnings.
546 Optional argument SHOWSTATUS indicates that we should update the
547 checkdoc status window instead of the usual behavior."
553 ;; Due to a design flaw, this will never spell check messages.
556 ;; This is a workaround to perform spell checking.
560 "Interactively loop over all errors that can be found by a given method.
562 If START-HERE is nil, searching starts at the beginning of the current
563 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
564 expresses the verbosity of the search, and whether ending the search
565 will auto-exit this function.
567 FINDFUNC is a symbol representing a function that will position the
568 cursor, and return error message text to present to the user. It is
569 assumed that the cursor will stop just before a major sexp, which will
570 be highlighted to present the user with feedback as to the offending
571 style."
572 ;; Determine where to start the test
575 ;; Assign a flag to spellcheck flag
579 ;; Fetch the error list
583 c)
586 ;; Include whatever function point is in for good measure.
590 ;; The cursor should be just in front of the offending doc string
601 ;; Make sure the whole doc string is visible if possible.
625 ;; Exit condition
627 ;; Request an auto-fix
632 ;; `automatic-then-never' tells the autofix function
633 ;; to only allow one fix to be automatic. The autofix
634 ;; function will then set the flag to 'never, allowing
635 ;; the checker to return a different error.
657 ;; Move to the next error (if available)
663 err-list nil)
669 ;; Go backwards in the list of errors
678 ;; Edit the buffer recursively.
689 err-list nil)
693 ;; Quit checkdoc
696 err-list nil
698 ;; Goofy stuff
708 ""
710 "f, y - auto Fix this warning without asking (if\
713 )
725 returnme))
728 "Interactively spell check doc strings in the current buffer.
729 If START-HERE is nil, searching starts at the beginning of the current
730 buffer, otherwise searching starts at START-HERE."
733 ;; Move point to where we need to start.
735 ;; Include whatever function point is in for good measure.
738 ;; Loop over docstrings.
748 "Interactively spell check messages in the current buffer.
749 If START-HERE is nil, searching starts at the beginning of the current
750 buffer, otherwise searching starts at START-HERE."
753 ;; Move point to where we need to start.
755 ;; Include whatever function point is in for good measure.
758 ;; Loop over message strings.
769 "Find and return the next checkdoc error list, or nil.
770 Only documentation strings are checked.
771 An error list is of the form (WARNING . POSITION) where WARNING is the
772 warning text, and POSITION is the point in the buffer where the error
773 was found. We can use points and not markers because we promise not
774 to edit the buffer before point without re-executing this check.
775 Argument ENABLE-FIX will enable auto-fixing while looking for the next
776 error. This argument assumes that the cursor is already positioned to
777 perform the fix."
788 ;; Quit.. restore position, Other errors, leave alone
790 msg)))
793 "Find and return the next checkdoc message related error list, or nil.
794 Only text for error and `y-or-n-p' strings are checked. See
795 `checkdoc-next-error' for details on the return value.
796 Argument ENABLE-FIX turns on the auto-fix feature. This argument
797 assumes that the cursor is already positioned to perform the fix."
810 ;; Quit.. restore position, Other errors, leave alone
812 msg)))
815 "Enter recursive edit to permit a user to fix some error checkdoc has found.
816 MSG is the error that was found, which is displayed in a help buffer."
831 ;;;###autoload
833 "Evaluate and check documentation for the current buffer.
834 Evaluation is done first because good documentation for something that
835 doesn't work is just not useful. Comments, doc strings, and rogue
836 spacing are all verified."
841 ;;;###autoload
843 "Check current buffer for document, comment, error style, and rogue spaces.
844 With a prefix argument (in Lisp, the argument TAKE-NOTES),
845 store all errors found in a warnings buffer,
846 otherwise stop after the first error."
849 ;; Assign a flag to spellcheck flag
854 checkdoc-autofix-flag))
859 ;; every test is responsible for returning the cursor.
869 ;;;###autoload
871 "Start scanning the current buffer for documentation string style errors.
872 Only documentation strings are checked.
873 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
874 Prefix argument TAKE-NOTES means to collect all the warning messages into
875 a separate buffer."
882 ;; Go back since we can't be here without success above.
884 nil))
886 ;;;###autoload
888 "Find the next doc string in the current buffer which has a style error.
889 Prefix argument TAKE-NOTES means to continue through the whole buffer and
890 save warnings in a separate buffer. Second optional argument START-POINT
891 is the starting location. If this is nil, `point-min' is used instead."
894 ;; Assign a flag to spellcheck flag
899 checkdoc-autofix-flag))
903 ;; If we are taking notes, encompass the whole buffer, otherwise
904 ;; the user is navigating down through the buffer.
906 ;; OK, let's look at the doc string.
919 "Move to the next doc string after point, and return t.
920 Return nil if there are no more doc strings."
922 nil
923 ;; search drops us after the identifier. The next sexp is either
924 ;; the argument list or the value of the variable. skip it.
927 t))
929 ;;;###autoload
931 "Find missing comment sections in the current Emacs Lisp file.
932 Prefix argument TAKE-NOTES non-nil means to save warnings in a
933 separate buffer. Otherwise print a message. This returns the error
934 if there is one."
948 e))
950 ;;;###autoload
952 "Find extra spaces at the end of lines in the current file.
953 Prefix argument TAKE-NOTES non-nil means to save warnings in a
954 separate buffer. Otherwise print a message. This returns the error
955 if there is one.
956 Optional argument INTERACT permits more interactive fixing."
964 e
970 ;;;###autoload
972 "Scan the buffer for occurrences of the error function, and verify text.
973 Optional argument TAKE-NOTES causes all errors to be logged."
982 e
989 ;;;###autoload
991 "Evaluate the current form with `eval-defun' and check its documentation.
992 Evaluation is done first so the form will be read before the
993 documentation is checked. If there is a documentation error, then the display
994 of what was evaluated will be overwritten by the diagnostic message."
999 ;;;###autoload
1001 "Examine the doc string of the function or variable under point.
1002 Call `error' if the doc string has problems. If NO-ERROR is
1003 non-nil, then do not call error, but call `message' instead.
1004 If the doc string passes the test, then check the function for rogue white
1005 space at the end of each line."
1010 ;; I found this more annoying than useful.
1011 ;;(if (not no-error)
1012 ;; (message "Cannot check this sexp's doc string."))
1013 nil
1014 ;; search drops us after the identifier. The next sexp is either
1015 ;; the argument list or the value of the variable. skip it.
1038 ;;; Ispell interface for forcing a spell check
1039 ;;
1041 ;;;###autoload
1043 "Check the style and spelling of everything interactively.
1044 Calls `checkdoc' with spell-checking turned on.
1045 Prefix argument TAKE-NOTES is the same as for `checkdoc'"
1050 ;;;###autoload
1052 "Check the style and spelling of the current buffer.
1053 Calls `checkdoc-current-buffer' with spell-checking turned on.
1054 Prefix argument TAKE-NOTES is the same as for `checkdoc-current-buffer'"
1059 ;;;###autoload
1061 "Check the style and spelling of the current buffer interactively.
1062 Calls `checkdoc-interactive' with spell-checking turned on.
1063 Prefix argument TAKE-NOTES is the same as for `checkdoc-interactive'"
1068 ;;;###autoload
1070 "Check the style and spelling of message text interactively.
1071 Calls `checkdoc-message-interactive' with spell-checking turned on.
1072 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-interactive'"
1077 ;;;###autoload
1079 "Check the style and spelling of message text interactively.
1080 Calls `checkdoc-message-text' with spell-checking turned on.
1081 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-text'"
1086 ;;;###autoload
1088 "Check the style and spelling of the current buffer.
1089 Calls `checkdoc-start' with spell-checking turned on.
1090 Prefix argument TAKE-NOTES is the same as for `checkdoc-start'"
1095 ;;;###autoload
1097 "Check the style and spelling of the current buffer after point.
1098 Calls `checkdoc-continue' with spell-checking turned on.
1099 Prefix argument TAKE-NOTES is the same as for `checkdoc-continue'"
1104 ;;;###autoload
1106 "Check the style and spelling of the current buffer's comments.
1107 Calls `checkdoc-comments' with spell-checking turned on.
1108 Prefix argument TAKE-NOTES is the same as for `checkdoc-comments'"
1113 ;;;###autoload
1115 "Check the style and spelling of the current defun with Ispell.
1116 Calls `checkdoc-defun' with spell-checking turned on.
1117 Prefix argument TAKE-NOTES is the same as for `checkdoc-defun'"
1122 ;;; Error Management
1123 ;;
1124 ;; Errors returned from checkdoc functions can have various
1125 ;; features and behaviors, so we need some ways of specifying
1126 ;; them, and making them easier to use in the wacked-out interfaces
1127 ;; people are requesting
1129 "Used to create the return error text returned from all engines.
1130 TEXT is the descriptive text of the error. START and END define the region
1131 it is sensible to highlight when describing the problem.
1132 Optional argument UNFIXABLE means that the error has no auto-fix available.
1134 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1135 generating a buffered list of errors."
1138 nil)
1142 "Return the text specified in the checkdoc ERR."
1143 ;; string-p part is for backwards compatibility
1147 "Return the start point specified in the checkdoc ERR."
1148 ;; string-p part is for backwards compatibility
1152 "Return the end point specified in the checkdoc ERR."
1153 ;; string-p part is for backwards compatibility
1157 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1158 ;; string-p part is for backwards compatibility
1161 ;;; Minor Mode specification
1162 ;;
1167 ;; Override some bindings
1173 ;; Add some new bindings under C-c ?
1191 ;; bind our submap into map
1193 map)
1199 ;; Add in a menubar with easy-menu
1202 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1208 "---"
1217 checkdoc-ispell-message-interactive t]
1222 buffer-file-name]
1224 "---"
1229 ))
1230 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1231 ;; What is it?
1233 ;;;###autoload
1235 "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings.
1236 With prefix ARG, turn Checkdoc minor mode on if ARG is positive, otherwise
1237 turn it off.
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 \
1372 err)))
1375 "Return an error list or string if the current doc string is invalid.
1376 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1377 regexp short cuts work. FP is the function defun information."
1379 ;; Use a marker so if an early check modifies the text,
1380 ;; we won't accidentally loose our place. This could cause
1381 ;; end-of doc string whitespace to also delete the " char.
1387 ;; * *Do not* indent subsequent lines of a documentation string so that
1388 ;; the text is lined up in the source code with the text of the first
1389 ;; line. This looks nice in the source code, but looks bizarre when
1390 ;; users view the documentation. Remember that the indentation
1391 ;; before the starting double-quote is not part of the string!
1399 "Remove this whitespace? "
1401 nil
1403 "Second line should not have indentation"
1406 ;; * Check for '(' in column 0.
1411 "Escape this '('? "
1413 nil
1415 "Open parenthesis in column 0 should be escaped"
1417 ;; * Do not start or end a documentation string with whitespace.
1430 nil
1432 "Documentation strings should not start or end with whitespace"
1433 start end))))
1434 ;; * The first line of the documentation string should consist of one
1435 ;; or two complete sentences that stand on their own as a summary.
1436 ;; `M-x apropos' displays just the first line, and if it doesn't
1437 ;; stand on its own, the result looks bad. In particular, start the
1438 ;; first line with a capital letter and end with a period.
1446 ;; A backslashed double quote at the end of a sentence
1448 ;; We might have to add a period in this case
1451 nil
1456 nil
1458 "First sentence should end with punctuation"
1461 ;; These are ok
1462 nil)
1464 nil)
1466 ;; If it is not a complete sentence, let's see if we can
1467 ;; predict a clever way to make it one.
1472 ;; Here we have found a complete sentence, but no break.
1475 "First line not a complete sentence. Add RET here? "
1488 ;; We can merge these lines! Replace this CR
1489 ;; with a space.
1492 ;; Let's see if there is enough room to draw the next
1493 ;; line's sentence up here. I often get hit w/
1494 ;; auto-fill moving my words around.
1503 t)
1507 "1st line not a complete sentence. Join these lines? "
1510 ;; They said yes. We have more fill work to do...
1520 nil) ))))
1521 ;; Continuation of above. Make sure our sentence is capitalized.
1528 t)
1529 nil
1531 "First line should be capitalized"
1533 nil))
1534 ;; * Don't write key sequences directly in documentation strings.
1535 ;; Instead, use the `\\[...]' construct to stand for them.
1540 ;; Find the first key sequence not in a sample
1550 ;; It is not practical to use `\\[...]' very many times, because
1551 ;; display of the documentation string will become slow. So use this
1552 ;; to describe the most important commands in your major mode, and
1553 ;; then use `\\{...}' to display the rest of the mode's keymap.
1561 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1562 ;; and is referred to in documentation, it should be prefixed with
1563 ;; something to disambiguate it. This check must be before the
1564 ;; 80 column check because it will probably break that.
1582 ;; We didn't actually replace anything. Here we find
1583 ;; out what special word form they wish to use as
1584 ;; a prefix.
1587 "Disambiguating Keyword (default variable): "
1599 nil)))
1600 ;; * Format the documentation string so that it fits in an
1601 ;; Emacs window on an 80-column screen. It is a good idea
1602 ;; for most lines to be no wider than 60 characters. The
1603 ;; first line can be wider if necessary to fit the
1604 ;; information that ought to be there.
1613 eol t))
1619 "Some lines are over 80 columns wide"
1621 ;; Here we deviate to tests based on a variable or function.
1622 ;; We must do this before checking for symbols in quotes because there
1623 ;; is a chance that just such a symbol might really be an argument.
1625 ;; This is if we are in a variable
1627 ;; * The documentation string for a variable that is a
1628 ;; yes-or-no flag should start with words such as Non-nil
1629 ;; means..., to make it clear that all non-`nil' values are
1630 ;; equivalent and indicate explicitly what `nil' and non-`nil'
1631 ;; mean.
1632 ;; * If a user option variable records a true-or-false
1633 ;; condition, give it a name that ends in `-flag'.
1635 ;; If the variable has -flag in the name, make sure
1639 "Flag variable doc strings should usually start: Non-nil means"
1641 ;; If the doc string starts with "Non-nil means"
1650 "Rename to %s and Query-Replace all occurrences? "
1651 newname))
1656 newname))
1658 "Flag variable names should normally end in `-flag'" s
1660 ;; Done with variables
1661 ))
1663 ;; This if we are in a function definition
1665 ;; * When a function's documentation string mentions the value
1666 ;; of an argument of the function, use the argument name in
1667 ;; capital letters as if it were a name for that value. Thus,
1668 ;; the documentation string of the function `/' refers to its
1669 ;; second argument as `DIVISOR', because the actual argument
1670 ;; name is `divisor'.
1672 ;; Addendum: Make sure they appear in the doc in the same
1673 ;; order that they are found in the arg list.
1683 inopts t)
1688 ;; Require whitespace OR
1689 ;; ITEMth<space> OR
1690 ;; ITEMs<space>
1692 e t)))
1695 ;; If the symbol was not found, let's see if we
1696 ;; can find it with a different capitalization
1697 ;; and see if the user wants to capitalize it.
1701 ;; Require whitespace OR
1702 ;; ITEMth<space> OR
1703 ;; ITEMs<space>
1705 e t))
1709 "If this is the argument `%s', it should appear as %s. Fix? "
1715 ;; It wasn't found at all! Offer to attach this new symbol
1716 ;; to the end of the documentation string.
1719 "Add %s documentation to end of doc string? "
1721 ;; Now do some magic and invent a doc string.
1732 nil)
1735 "Argument `%s' should appear (as %s) in the doc string"
1742 "Arguments occur in the doc string out of order"
1744 ;; * For consistency, phrase the verb in the first sentence of a
1745 ;; documentation string for functions as an imperative.
1746 ;; For instance, use `Return the cons of A and
1747 ;; B.' in preference to `Returns the cons of A and B.'
1748 ;; Usually it looks good to do likewise for the rest of the
1749 ;; first paragraph. Subsequent paragraphs usually look better
1750 ;; if they have proper subjects.
1751 ;;
1752 ;; This is the least important of the above tests. Make sure
1753 ;; it occurs last.
1756 ;; Maybe rebuild the monster-regexp
1760 ;; check string-continuation
1768 checkdoc-common-verbs-regexp
1769 lim t))
1773 checkdoc-common-verbs-wrong-voice))
1783 replace t)
1786 ;; there was a match, but no replace
1790 original replace)
1792 ;; Done with functions
1793 )))
1794 ;;* When a documentation string refers to a Lisp symbol, write it as
1795 ;; it would be printed (which usually means in lower case), with
1796 ;; single-quotes around it. For example: `lambda'. There are two
1797 ;; exceptions: write t and nil without single-quotes. (In this
1798 ;; manual, we normally do use single-quotes for those symbols.)
1804 e t))
1806 ;; A . is a \s_ char, so we must remove periods from
1807 ;; sentences more carefully.
1817 ms))
1825 ms))))))
1830 nil)))
1831 ;; t and nil case
1839 nil
1841 "Symbols t and nil should not appear in `...' quotes"
1843 ;; Here is some basic sentence formatting
1845 ;; Here are common proper nouns that should always appear capitalized.
1847 ;; Make sure the doc string has correctly spelled English words
1848 ;; in it. This function is extracted due to its complexity,
1849 ;; and reliance on the Ispell program.
1851 ;; User supplied checks
1853 ;; Done!
1854 )))
1857 "Return a list of details about the current sexp.
1858 It is a list of the form:
1859 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1860 where NAME is the name, VARIABLE is t if this is a `defvar',
1861 INTERACTIVE is nil if this is not an interactive function, otherwise
1862 it is the position of the `interactive' call, and PARAMETERS is a
1863 string which is the name of each variable in the function's argument
1864 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1865 comment for a given defun. If the first element is not a string, then
1866 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1867 from the comment."
1883 ;; The variable spot
1885 ;; Interactive
1890 t)
1891 ret)))
1895 ;; Overload th main obarray so read doesn't intern the
1896 ;; local symbols of the function we are checking.
1897 ;; Without this we end up cluttering the symbol space w/
1898 ;; useless symbols.
1900 ;; Ok, check for checkdoc parameter comment here
1908 t)
1914 t)
1928 sl1)
1929 ret)))
1930 ;; Read the list of parameters, but do not put the symbols in
1931 ;; the standard obarray.
1933 ;; This is because read will intern nil if it doesn't into the
1934 ;; new obarray.
1943 "Return non-nil if the current point is in a code fragment.
1944 A code fragment is identified by an open parenthesis followed by a
1945 symbol which is a valid function or a word in all CAPS, or a parenthesis
1946 that is quoted with the ' character. Only the region from START to LIMIT
1947 is is allowed while searching for the bounding parenthesis."
1958 ;; if this string is function bound, we are in
1959 ;; sample code. If it has a - or : character in
1960 ;; the name, then it is probably supposed to be bound
1961 ;; but isn't yet.
1970 The text checked is between START and LIMIT."
1981 "Check all text between BEGIN and END for lower case proper nouns.
1982 These are Emacs centric proper nouns which should be capitalized for
1983 consistency. Return an error list if any are not fixed, but
1984 internally skip over no answers.
1985 If the offending word is in a piece of quoted text, then it is skipped."
2002 ;; surrounded by /, as in a URL or filename: /emacs/
2008 text)
2010 nil
2012 ;; If there is already an error, then generate
2013 ;; the warning output if applicable
2017 "Name %s should appear capitalized as %s"
2019 b e))
2022 "Name %s should appear capitalized as %s"
2024 bb b be e)))))))
2029 "Make sure all sentences have double spaces between BEGIN and END."
2049 ;; piece of an abbreviation
2054 b e
2055 "There should be two spaces after a period. Fix? "
2057 nil
2059 ;; If there is already an error, then generate
2060 ;; the warning output if applicable
2063 "There should be two spaces after a period"
2064 b e))
2066 "There should be two spaces after a period"
2067 bb b be e)))))))
2071 ;;; Ispell engine
2072 ;;
2076 "Initialize Ispell process (default version) with Lisp words.
2077 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2078 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2079 nil."
2085 ;; This code copied in part from ispell.el Emacs 19.34
2089 ;; Silence byte compiler
2096 "Run the Ispell tools on the doc string between point and END.
2097 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2098 before using the Ispell engine on it."
2100 ;; If the user wants no questions or fixing, then we must
2101 ;; disable spell checking as not useful.
2104 nil
2111 ;; Skip lists describing meta-syntax, or bound variables
2119 ;; This is probably repetitive in most cases, but not always.
2120 nil
2121 ;; Find out how we spell-check this word.
2123 ;; All caps w/ option th, or s tacked on the end
2124 ;; for pluralization or numberthness.
2127 )
2128 nil
2137 ;; Nothing here.
2138 )))))
2140 err))))
2142 ;;; Rogue space checking engine
2143 ;;
2145 "Return a message list if there is a line with white space at the end.
2146 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2147 If optional arguments START and END are non-nil, bound the check to
2148 this region.
2149 Optional argument INTERACT may permit the user to fix problems on the fly."
2153 ;; If end is nil, it means end of buffer to search anyway
2155 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2156 ;; (It's dangerous)
2161 "Don't use `? ' at the end of a line. \
2162 News agents may remove it"
2164 ;; If interactive is passed down, give them a chance to fix things.
2171 ;; Check for, and potentially remove whitespace appearing at the
2172 ;; end of different lines.
2175 ;; There is no documentation in the Emacs Lisp manual about this check,
2176 ;; it is intended to help clean up messy code and reduce the file size.
2178 ;; This is not a complex activity
2182 nil
2185 ;; Return an error and leave the cursor at that spot, or restore
2186 ;; the cursor.
2190 nil)))
2192 ;;; Comment checking engine
2193 ;;
2195 ;; We must load this to:
2196 ;; a) get symbols for compile and
2197 ;; b) determine if we have lm-history symbol which doesn't always exist
2201 "Return a message list if this file does not match the Emacs standard.
2202 This checks for style only, such as the first line, Commentary:,
2203 Code:, and others referenced in the style guide."
2205 nil
2207 ;; Old XEmacs don't have `lm-commentary-mark'
2216 ;; This file has been set up where ERR is a variable. Each check is
2217 ;; asked, and the function will make sure that if the user does not
2218 ;; auto-fix some error, that we still move on to the next auto-fix,
2219 ;; AND we remember the past errors.
2221 err
2222 ;; Lisp Maintenance checks first
2223 ;; Was: (lm-verify) -> not flexible enough for some people
2224 ;; * Summary at the beginning of the file:
2226 ;; This certifies as very complex so always ask unless
2227 ;; it's set to never
2236 nil))
2238 err
2240 ;; * Commentary Section
2247 nil t)
2260 nil nil t)))
2261 nil)
2262 err))
2264 err
2266 ;; * History section. Say nothing if there is a file ChangeLog
2272 nil
2278 nil t)
2290 err))
2292 err
2294 ;; * Code section
2305 nil)
2309 nil)
2310 err))
2312 err
2314 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2315 ;; The following is partially clipped from lm-verify
2323 nil t))
2330 fn fn fe)
2332 err))
2333 ;; The below checks will not return errors if the user says NO
2335 ;; Let's spellcheck the commentary section. This is the only
2336 ;; section that is easy to pick out, and it is also the most
2337 ;; visible section (with the finder).
2343 ;; Since the comments talk about Lisp, use the
2344 ;; specialized spell-checker we also used for doc
2345 ;; strings.
2350 err
2352 ;; Generic Full-file checks (should be comment related)
2354 err))
2355 ;; Done with full file comment checks
2356 err)))
2359 "Return t if point is outside the bounds of a valid sexp."
2366 ;;; `error' and `message' text verifier.
2367 ;;
2369 "Search between BEG and END for a style error with message text.
2370 Optional arguments BEG and END represent the boundary of the check.
2371 The default boundary is the entire buffer."
2378 e))
2381 "Move cursor to the next checkable message string after point.
2382 Return the message classification.
2383 Argument END is the maximum bounds to search in."
2402 nil
2404 return))
2407 "Return or fix errors found in strings passed to a message display function.
2408 According to the documentation for the function `error', the error list
2409 should not end with a period, and should start with a capital letter.
2410 The function `y-or-n-p' has similar constraints.
2411 Argument TYPE specifies the type of question, such as `error or `y-or-n-p."
2412 ;; If type is nil, then attempt to derive it.
2424 ;; From the documentation of the symbol `error':
2425 ;; In Emacs, the convention is that error messages start with a capital
2426 ;; letter but *do not* end with a period. Please follow this convention
2427 ;; for the sake of consistency.
2432 "Capitalize your message text? "
2434 t)))
2436 "Messages should start with a capital letter"
2438 nil)
2439 ;; In general, sentences should have two spaces after the period.
2443 ;; Look for proper nouns in this region too.
2447 ;; Here are message type specific questions.
2454 "Remove period from error? "
2455 ""
2456 t)))
2458 "Error messages should *not* end with a period"
2460 nil)
2461 ;; `y-or-n-p' documentation explicitly says:
2462 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2463 ;; I added the ? requirement. Without it, it is unclear that we
2464 ;; ask a question and it appears to be an undocumented style.
2469 nil
2473 ;; If we see a ?, then replace with "? ".
2478 nil
2489 nil
2501 nil
2505 ;; Now, let's just run the spell checker on this guy.
2508 )))
2510 ;;; Auto-fix helper functions
2511 ;;
2513 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2514 Argument QUESTION is the prompt passed to `y-or-n-p'."
2518 nil
2525 "Highlight between START and END and queries the user with QUESTION.
2526 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2527 the region marked by START and END with REPLACEWITH. If optional flag
2528 COMPLEX is non-nil, then we may ask the user a question. See the
2529 documentation for `checkdoc-autofix-flag' for details.
2531 If a section is auto-replaced without asking the user, this function
2532 will pause near the fixed code so the user will briefly see what
2533 happened.
2535 This function returns non-nil if the text was replaced.
2537 This function will not modify `match-data'."
2554 ;; On the off chance this is automatic, display
2555 ;; the question anyway so the user knows what's
2556 ;; going on.
2568 ret)))
2570 ;;; Warning management
2571 ;;
2585 "Set up the major mode for the buffer containing the list of errors."
2587 checkdoc-output-error-regex-alist)
2589 checkdoc-output-font-lock-keywords))
2592 "The name to use for a checkdoc buffer in the error list."
2598 "Initialize the checkdoc diagnostic buffer for a pass.
2599 Create the header so that the string CHECK-TYPE is displayed as the
2600 function called to create the messages."
2610 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2621 "Display the checkdoc diagnostic buffer in a temporary window."
2632 nil)))
2645 ;; arch-tag: c49a7ec8-3bb7-46f2-bfbc-d5f26e033b26
2646 ;;; checkdoc.el ends here