| blob | 185df6fbe43cf690210869f1dae0069f17784f85 |
1 ;;; checkdoc.el --- check documentation strings for style requirements
3 ;; Copyright (C) 1997, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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:
178 ;; From custom web page for compatibility between versions of custom:
184 nil ;; We've got what we needed
185 ;; We have the old custom-library, hack around it!
187 nil)
189 nil)
197 "Support for doc string checking in Emacs Lisp."
203 "*String to display in mode line when Checkdoc mode is enabled; nil for none."
209 "Non-nil means attempt auto-fixing of doc strings.
210 If this value is the symbol `query', then the user is queried before
211 any change is made. If the value is `automatic', then all changes are
212 made without asking unless the change is very-complex. If the value
213 is `semiautomatic' or any other value, then simple fixes are made
214 without asking, and complex changes are made by asking the user first.
215 The value `never' is the same as nil, never ask or change anything."
224 Setting this to nil will silently make fixes that require no user
225 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
230 "Non-nil means that all checkable definitions should have documentation.
231 Style guide dictates that interactive functions MUST have documentation,
232 and that it's good but not required practice to make non user visible items
233 have doc strings."
236 ;;;###autoload(put 'checkdoc-force-docstrings-flag 'safe-local-variable 'booleanp)
239 "Non-nil means that files should have a History section or ChangeLog file.
240 This helps document the evolution of, and recent changes to, the package."
245 "Non-nil means the first line of a docstring may end with a comma.
246 Ordinarily, a full sentence is required. This may be misleading when
247 there is a substantial caveat to the one-line description -- the comma
248 should be used when the first part could stand alone as a sentence, but
249 it indicates that a modifying clause follows."
252 ;;;###autoload(put 'checkdoc-permit-comma-termination-flag 'safe-local-variable 'booleanp)
255 "Non-nil means run Ispell on text based on value.
256 This is automatically set to nil if Ispell does not exist on your
257 system. Possible values are:
259 nil - Don't spell-check during basic style checks.
260 defun - Spell-check when style checking a single defun
261 buffer - Spell-check when style checking the whole buffer
262 interactive - Spell-check during any interactive check.
263 t - Always spell-check"
277 Any more than this and a warning is generated suggesting that the construct
283 "Non-nil means warn if arguments appear out of order.
284 Setting this to nil will mean only checking that all the arguments
285 appear in the proper form in the documentation, not that they are in
286 the same order as they appear in the argument list. No mention is
287 made in the style guide relating to order."
292 "Hooks called after the standard style check is completed.
293 All hooks must return nil or a string representing the error found.
294 Useful for adding new user implemented commands.
296 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
297 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
301 "Hooks called after the standard comment style check is completed.
302 Must return nil if no errors are found, or a string describing the
311 "Regular expression used to identify a defun.
315 "Non-nil means to attempt to check the voice of the doc string.
316 This check keys off some words which are commonly misused. See the
317 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
322 "Non-nil means generate warnings in a buffer for browsing.
323 Do not set this by hand, use a function like `checkdoc-current-buffer'
327 "A list of symbols which also happen to make good words.
328 These symbol-words are ignored when unquoted symbols are searched for.
329 This should be set in an Emacs Lisp file's local variables."
429 )
430 "Alist of common words in the wrong voice and what should be used instead.
431 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
432 and experimental check. Do not modify this list without setting
433 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
440 nil
442 ;; When dealing with syntax in doc strings, make sure that - are encompassed
443 ;; in words so we can use cheap \\> to get the end of a symbol, not the
444 ;; end of a word in a conglomerate.
446 )
449 ;;; Compatibility
450 ;;
466 ;;; User level commands
467 ;;
468 ;;;###autoload
470 "Interactively check the entire buffer for style errors.
471 The current status of the check will be displayed in a buffer which
472 the users will view as each check is completed."
478 ;; if the user set autofix to never, then that breaks the
479 ;; obviously requested asking implied by using this function.
480 ;; Set it to paranoia level.
483 'query
484 checkdoc-autofix-flag))
485 tmp)
487 ;; check the comments
495 ;; Check the documentation
502 ;; Check the message text
508 ;; Rogue spacing
517 "Display and update the status buffer for the current checkdoc mode.
518 CHECK is a list of four strings stating the current status of each
519 test; the nth string describes the status of the nth test."
527 )))
533 ;;;###autoload
535 "Interactively check the current buffer for doc string errors.
536 Prefix argument START-HERE will start the checking from the current
537 point, otherwise the check starts at the beginning of the current
538 buffer. Allows navigation forward and backwards through document
539 errors. Does not check for comment or space warnings.
540 Optional argument SHOWSTATUS indicates that we should update the
541 checkdoc status window instead of the usual behavior."
547 ;; Due to a design flaw, this will never spell check
548 ;; docstrings.
551 ;; This is a workaround to perform spell checking.
554 ;;;###autoload
556 "Interactively check the current buffer for message string errors.
557 Prefix argument START-HERE will start the checking from the current
558 point, otherwise the check starts at the beginning of the current
559 buffer. Allows navigation forward and backwards through document
560 errors. Does not check for comment or space warnings.
561 Optional argument SHOWSTATUS indicates that we should update the
562 checkdoc status window instead of the usual behavior."
568 ;; Due to a design flaw, this will never spell check messages.
571 ;; This is a workaround to perform spell checking.
575 "Interactively loop over all errors that can be found by a given method.
577 If START-HERE is nil, searching starts at the beginning of the current
578 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
579 expresses the verbosity of the search, and whether ending the search
580 will auto-exit this function.
582 FINDFUNC is a symbol representing a function that will position the
583 cursor, and return error message text to present to the user. It is
584 assumed that the cursor will stop just before a major sexp, which will
585 be highlighted to present the user with feedback as to the offending
586 style."
587 ;; Determine where to start the test
590 ;; Assign a flag to spellcheck flag
594 ;; Fetch the error list
598 c)
601 ;; Include whatever function point is in for good measure.
605 ;; The cursor should be just in front of the offending doc string
616 ;; Make sure the whole doc string is visible if possible.
640 ;; Exit condition
642 ;; Request an auto-fix
647 ;; `automatic-then-never' tells the autofix function
648 ;; to only allow one fix to be automatic. The autofix
649 ;; function will then set the flag to 'never, allowing
650 ;; the checker to return a different error.
672 ;; Move to the next error (if available)
678 err-list nil)
684 ;; Go backwards in the list of errors
693 ;; Edit the buffer recursively.
704 err-list nil)
708 ;; Quit checkdoc
711 err-list nil
713 ;; Goofy stuff
723 ""
725 "f, y - auto Fix this warning without asking (if\
728 )
740 returnme))
743 "Interactively spell check doc strings in the current buffer.
744 If START-HERE is nil, searching starts at the beginning of the current
745 buffer, otherwise searching starts at START-HERE."
748 ;; Move point to where we need to start.
750 ;; Include whatever function point is in for good measure.
753 ;; Loop over docstrings.
763 "Interactively spell check messages in the current buffer.
764 If START-HERE is nil, searching starts at the beginning of the current
765 buffer, otherwise searching starts at START-HERE."
768 ;; Move point to where we need to start.
770 ;; Include whatever function point is in for good measure.
773 ;; Loop over message strings.
784 "Find and return the next checkdoc error list, or nil.
785 Only documentation strings are checked.
786 An error list is of the form (WARNING . POSITION) where WARNING is the
787 warning text, and POSITION is the point in the buffer where the error
788 was found. We can use points and not markers because we promise not
789 to edit the buffer before point without re-executing this check.
790 Argument ENABLE-FIX will enable auto-fixing while looking for the next
791 error. This argument assumes that the cursor is already positioned to
792 perform the fix."
803 ;; Quit.. restore position, Other errors, leave alone
805 msg)))
808 "Find and return the next checkdoc message related error list, or nil.
809 Only text for error and `y-or-n-p' strings are checked. See
810 `checkdoc-next-error' for details on the return value.
811 Argument ENABLE-FIX turns on the auto-fix feature. This argument
812 assumes that the cursor is already positioned to perform the fix."
825 ;; Quit.. restore position, Other errors, leave alone
827 msg)))
830 "Enter recursive edit to permit a user to fix some error checkdoc has found.
831 MSG is the error that was found, which is displayed in a help buffer."
846 ;;;###autoload
848 "Evaluate and check documentation for the current buffer.
849 Evaluation is done first because good documentation for something that
850 doesn't work is just not useful. Comments, doc strings, and rogue
851 spacing are all verified."
856 ;;;###autoload
858 "Check current buffer for document, comment, error style, and rogue spaces.
859 With a prefix argument (in Lisp, the argument TAKE-NOTES),
860 store all errors found in a warnings buffer,
861 otherwise stop after the first error."
864 ;; Assign a flag to spellcheck flag
869 checkdoc-autofix-flag))
874 ;; every test is responsible for returning the cursor.
884 ;;;###autoload
886 "Start scanning the current buffer for documentation string style errors.
887 Only documentation strings are checked.
888 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
889 Prefix argument TAKE-NOTES means to collect all the warning messages into
890 a separate buffer."
897 ;; Go back since we can't be here without success above.
899 nil))
901 ;;;###autoload
903 "Find the next doc string in the current buffer which has a style error.
904 Prefix argument TAKE-NOTES means to continue through the whole buffer and
905 save warnings in a separate buffer. Second optional argument START-POINT
906 is the starting location. If this is nil, `point-min' is used instead."
909 ;; Assign a flag to spellcheck flag
914 checkdoc-autofix-flag))
918 ;; If we are taking notes, encompass the whole buffer, otherwise
919 ;; the user is navigating down through the buffer.
921 ;; OK, let's look at the doc string.
934 "Move to the next doc string after point, and return t.
935 Return nil if there are no more doc strings."
937 nil
938 ;; search drops us after the identifier. The next sexp is either
939 ;; the argument list or the value of the variable. skip it.
942 t))
944 ;;;###autoload
946 "Find missing comment sections in the current Emacs Lisp file.
947 Prefix argument TAKE-NOTES non-nil means to save warnings in a
948 separate buffer. Otherwise print a message. This returns the error
949 if there is one."
963 e))
965 ;;;###autoload
967 "Find extra spaces at the end of lines in the current file.
968 Prefix argument TAKE-NOTES non-nil means to save warnings in a
969 separate buffer. Otherwise print a message. This returns the error
970 if there is one.
971 Optional argument INTERACT permits more interactive fixing."
979 e
985 ;;;###autoload
987 "Scan the buffer for occurrences of the error function, and verify text.
988 Optional argument TAKE-NOTES causes all errors to be logged."
997 e
1004 ;;;###autoload
1006 "Evaluate the current form with `eval-defun' and check its documentation.
1007 Evaluation is done first so the form will be read before the
1008 documentation is checked. If there is a documentation error, then the display
1009 of what was evaluated will be overwritten by the diagnostic message."
1014 ;;;###autoload
1016 "Examine the doc string of the function or variable under point.
1017 Call `error' if the doc string has problems. If NO-ERROR is
1018 non-nil, then do not call error, but call `message' instead.
1019 If the doc string passes the test, then check the function for rogue white
1020 space at the end of each line."
1025 ;; I found this more annoying than useful.
1026 ;;(if (not no-error)
1027 ;; (message "Cannot check this sexp's doc string."))
1028 nil
1029 ;; search drops us after the identifier. The next sexp is either
1030 ;; the argument list or the value of the variable. skip it.
1053 ;;; Ispell interface for forcing a spell check
1054 ;;
1056 ;;;###autoload
1058 "Check the style and spelling of everything interactively.
1059 Calls `checkdoc' with spell-checking turned on.
1060 Prefix argument TAKE-NOTES is the same as for `checkdoc'"
1065 ;;;###autoload
1067 "Check the style and spelling of the current buffer.
1068 Calls `checkdoc-current-buffer' with spell-checking turned on.
1069 Prefix argument TAKE-NOTES is the same as for `checkdoc-current-buffer'"
1074 ;;;###autoload
1076 "Check the style and spelling of the current buffer interactively.
1077 Calls `checkdoc-interactive' with spell-checking turned on.
1078 Prefix argument TAKE-NOTES is the same as for `checkdoc-interactive'"
1083 ;;;###autoload
1085 "Check the style and spelling of message text interactively.
1086 Calls `checkdoc-message-interactive' with spell-checking turned on.
1087 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-interactive'"
1092 ;;;###autoload
1094 "Check the style and spelling of message text interactively.
1095 Calls `checkdoc-message-text' with spell-checking turned on.
1096 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-text'"
1101 ;;;###autoload
1103 "Check the style and spelling of the current buffer.
1104 Calls `checkdoc-start' with spell-checking turned on.
1105 Prefix argument TAKE-NOTES is the same as for `checkdoc-start'"
1110 ;;;###autoload
1112 "Check the style and spelling of the current buffer after point.
1113 Calls `checkdoc-continue' with spell-checking turned on.
1114 Prefix argument TAKE-NOTES is the same as for `checkdoc-continue'"
1119 ;;;###autoload
1121 "Check the style and spelling of the current buffer's comments.
1122 Calls `checkdoc-comments' with spell-checking turned on.
1123 Prefix argument TAKE-NOTES is the same as for `checkdoc-comments'"
1128 ;;;###autoload
1130 "Check the style and spelling of the current defun with Ispell.
1131 Calls `checkdoc-defun' with spell-checking turned on.
1132 Prefix argument TAKE-NOTES is the same as for `checkdoc-defun'"
1137 ;;; Error Management
1138 ;;
1139 ;; Errors returned from checkdoc functions can have various
1140 ;; features and behaviors, so we need some ways of specifying
1141 ;; them, and making them easier to use in the wacked-out interfaces
1142 ;; people are requesting
1144 "Used to create the return error text returned from all engines.
1145 TEXT is the descriptive text of the error. START and END define the region
1146 it is sensible to highlight when describing the problem.
1147 Optional argument UNFIXABLE means that the error has no auto-fix available.
1149 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1150 generating a buffered list of errors."
1153 nil)
1157 "Return the text specified in the checkdoc ERR."
1158 ;; string-p part is for backwards compatibility
1162 "Return the start point specified in the checkdoc ERR."
1163 ;; string-p part is for backwards compatibility
1167 "Return the end point specified in the checkdoc ERR."
1168 ;; string-p part is for backwards compatibility
1172 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1173 ;; string-p part is for backwards compatibility
1176 ;;; Minor Mode specification
1177 ;;
1182 ;; Override some bindings
1188 ;; Add some new bindings under C-c ?
1206 ;; bind our submap into map
1208 map)
1215 ;; Add in a menubar with easy-menu
1218 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1224 "---"
1233 checkdoc-ispell-message-interactive t]
1238 buffer-file-name]
1240 "---"
1245 ))
1246 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1247 ;; What is it?
1249 ;;;###autoload
1251 "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings.
1252 With prefix ARG, turn Checkdoc minor mode on if ARG is positive, otherwise
1253 turn it off.
1255 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1256 bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1257 checking of documentation strings.
1260 nil checkdoc-minor-mode-string nil
1263 ;;; Subst utils
1264 ;;
1266 "Run hooks in HOOKVAR with ARGS."
1269 ;; This method was similar to above. We ignore the warning
1270 ;; since we will use the above for future Emacs versions
1274 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1282 ;; Profiler says this is not yet faster than just calling assoc
1283 ;;(defun checkdoc-word-in-alist-vector (word vector)
1284 ;; "Check to see if WORD is in the car of an element of VECTOR.
1285 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1286 ;;word list is getting bigger, it is time for a quick bisecting search."
1287 ;; (let ((max (length vector)) (min 0) i
1288 ;; (found nil) (fw nil))
1289 ;; (setq i (/ max 2))
1290 ;; (while (and (not found) (/= min max))
1291 ;; (setq fw (car (aref vector i)))
1292 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1293 ;; ((string< word fw) (setq max i))
1294 ;; (t (setq min i)))
1295 ;; (setq i (/ (+ max min) 2))
1296 ;; )
1297 ;; found))
1299 ;;; Checking engines
1300 ;;
1302 "Return a message string if the current doc string is invalid.
1303 Check for style only, such as the first line always being a complete
1304 sentence, whitespace restrictions, and making sure there are no
1305 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1306 See the style guide in the Emacs Lisp manual for more details."
1308 ;; Jump over comments between the last object and the doc string
1317 err
1318 ;; * Every command, function, or variable intended for users to know
1319 ;; about should have a documentation string.
1320 ;;
1321 ;; * An internal variable or subroutine of a Lisp program might as well
1322 ;; have a documentation string. In earlier Emacs versions, you could
1323 ;; save space by using a comment instead of a documentation string,
1324 ;; but that is no longer the case.
1329 ;; Sometimes old code has comments where the documentation should
1330 ;; be. Let's see if we can find the comment, and offer to turn it
1331 ;; into documentation for them.
1347 ;; Our point is at the beginning of the comment!
1348 ;; Insert a quote, then remove the comment chars.
1367 ;; quote any double-quote characters in the comment.
1373 "You should convert this comment to documentation"
1377 "All interactive functions should have documentation"
1378 "All variables and subroutines might as well have a \
1388 err)))
1391 "Return an error list or string if the current doc string is invalid.
1392 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1393 regexp short cuts work. FP is the function defun information."
1395 ;; Use a marker so if an early check modifies the text,
1396 ;; we won't accidentally loose our place. This could cause
1397 ;; end-of doc string whitespace to also delete the " char.
1403 ;; * *Do not* indent subsequent lines of a documentation string so that
1404 ;; the text is lined up in the source code with the text of the first
1405 ;; line. This looks nice in the source code, but looks bizarre when
1406 ;; users view the documentation. Remember that the indentation
1407 ;; before the starting double-quote is not part of the string!
1415 "Remove this whitespace? "
1417 nil
1419 "Second line should not have indentation"
1422 ;; * Check for '(' in column 0.
1427 "Escape this '('? "
1429 nil
1431 "Open parenthesis in column 0 should be escaped"
1433 ;; * Do not start or end a documentation string with whitespace.
1446 nil
1448 "Documentation strings should not start or end with whitespace"
1449 start end))))
1450 ;; * The first line of the documentation string should consist of one
1451 ;; or two complete sentences that stand on their own as a summary.
1452 ;; `M-x apropos' displays just the first line, and if it doesn't
1453 ;; stand on its own, the result looks bad. In particular, start the
1454 ;; first line with a capital letter and end with a period.
1462 ;; A backslashed double quote at the end of a sentence
1464 ;; We might have to add a period in this case
1467 nil
1472 nil
1474 "First sentence should end with punctuation"
1477 ;; These are ok
1478 nil)
1480 nil)
1482 ;; If it is not a complete sentence, let's see if we can
1483 ;; predict a clever way to make it one.
1488 ;; Here we have found a complete sentence, but no break.
1491 "First line not a complete sentence. Add RET here? "
1504 ;; We can merge these lines! Replace this CR
1505 ;; with a space.
1508 ;; Let's see if there is enough room to draw the next
1509 ;; line's sentence up here. I often get hit w/
1510 ;; auto-fill moving my words around.
1519 t)
1523 "1st line not a complete sentence. Join these lines? "
1526 ;; They said yes. We have more fill work to do...
1536 nil) ))))
1537 ;; Continuation of above. Make sure our sentence is capitalized.
1544 t)
1545 nil
1547 "First line should be capitalized"
1549 nil))
1550 ;; * Don't write key sequences directly in documentation strings.
1551 ;; Instead, use the `\\[...]' construct to stand for them.
1556 ;; Find the first key sequence not in a sample
1566 ;; It is not practical to use `\\[...]' very many times, because
1567 ;; display of the documentation string will become slow. So use this
1568 ;; to describe the most important commands in your major mode, and
1569 ;; then use `\\{...}' to display the rest of the mode's keymap.
1577 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1578 ;; and is referred to in documentation, it should be prefixed with
1579 ;; something to disambiguate it. This check must be before the
1580 ;; 80 column check because it will probably break that.
1598 ;; We didn't actually replace anything. Here we find
1599 ;; out what special word form they wish to use as
1600 ;; a prefix.
1603 "Disambiguating Keyword (default variable): "
1615 nil)))
1616 ;; * Format the documentation string so that it fits in an
1617 ;; Emacs window on an 80-column screen. It is a good idea
1618 ;; for most lines to be no wider than 60 characters. The
1619 ;; first line can be wider if necessary to fit the
1620 ;; information that ought to be there.
1629 eol t))
1635 "Some lines are over 80 columns wide"
1637 ;; Here we deviate to tests based on a variable or function.
1638 ;; We must do this before checking for symbols in quotes because there
1639 ;; is a chance that just such a symbol might really be an argument.
1641 ;; This is if we are in a variable
1643 ;; * The documentation string for a variable that is a
1644 ;; yes-or-no flag should start with words such as Non-nil
1645 ;; means..., to make it clear that all non-`nil' values are
1646 ;; equivalent and indicate explicitly what `nil' and non-`nil'
1647 ;; mean.
1648 ;; * If a user option variable records a true-or-false
1649 ;; condition, give it a name that ends in `-flag'.
1651 ;; If the variable has -flag in the name, make sure
1655 "Flag variable doc strings should usually start: Non-nil means"
1657 ;; If the doc string starts with "Non-nil means"
1666 "Rename to %s and Query-Replace all occurrences? "
1667 newname))
1672 newname))
1674 "Flag variable names should normally end in `-flag'" s
1676 ;; Done with variables
1677 ))
1679 ;; This if we are in a function definition
1681 ;; * When a function's documentation string mentions the value
1682 ;; of an argument of the function, use the argument name in
1683 ;; capital letters as if it were a name for that value. Thus,
1684 ;; the documentation string of the function `/' refers to its
1685 ;; second argument as `DIVISOR', because the actual argument
1686 ;; name is `divisor'.
1688 ;; Addendum: Make sure they appear in the doc in the same
1689 ;; order that they are found in the arg list.
1699 inopts t)
1704 ;; Require whitespace OR
1705 ;; ITEMth<space> OR
1706 ;; ITEMs<space>
1708 e t)))
1711 ;; If the symbol was not found, let's see if we
1712 ;; can find it with a different capitalization
1713 ;; and see if the user wants to capitalize it.
1717 ;; Require whitespace OR
1718 ;; ITEMth<space> OR
1719 ;; ITEMs<space>
1721 e t))
1725 "If this is the argument `%s', it should appear as %s. Fix? "
1731 ;; It wasn't found at all! Offer to attach this new symbol
1732 ;; to the end of the documentation string.
1735 "Add %s documentation to end of doc string? "
1737 ;; Now do some magic and invent a doc string.
1748 nil)
1751 "Argument `%s' should appear (as %s) in the doc string"
1758 "Arguments occur in the doc string out of order"
1760 ;; * For consistency, phrase the verb in the first sentence of a
1761 ;; documentation string for functions as an imperative.
1762 ;; For instance, use `Return the cons of A and
1763 ;; B.' in preference to `Returns the cons of A and B.'
1764 ;; Usually it looks good to do likewise for the rest of the
1765 ;; first paragraph. Subsequent paragraphs usually look better
1766 ;; if they have proper subjects.
1767 ;;
1768 ;; This is the least important of the above tests. Make sure
1769 ;; it occurs last.
1772 ;; Maybe rebuild the monster-regexp
1776 ;; check string-continuation
1784 checkdoc-common-verbs-regexp
1785 lim t))
1789 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))
1824 ;; A . is a \s_ char, so we must remove periods from
1825 ;; sentences more carefully.
1835 ms))
1843 ms))))))
1848 nil)))
1849 ;; t and nil case
1857 nil
1859 "Symbols t and nil should not appear in `...' quotes"
1861 ;; Here is some basic sentence formatting
1863 ;; Here are common proper nouns that should always appear capitalized.
1865 ;; Make sure the doc string has correctly spelled English words
1866 ;; in it. This function is extracted due to its complexity,
1867 ;; and reliance on the Ispell program.
1869 ;; User supplied checks
1871 ;; Done!
1872 )))
1875 "Return a list of details about the current sexp.
1876 It is a list of the form:
1877 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1878 where NAME is the name, VARIABLE is t if this is a `defvar',
1879 INTERACTIVE is nil if this is not an interactive function, otherwise
1880 it is the position of the `interactive' call, and PARAMETERS is a
1881 string which is the name of each variable in the function's argument
1882 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1883 comment for a given defun. If the first element is not a string, then
1884 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1885 from the comment."
1901 ;; The variable spot
1903 ;; Interactive
1908 t)
1909 ret)))
1913 ;; Overload th main obarray so read doesn't intern the
1914 ;; local symbols of the function we are checking.
1915 ;; Without this we end up cluttering the symbol space w/
1916 ;; useless symbols.
1918 ;; Ok, check for checkdoc parameter comment here
1926 t)
1932 t)
1946 sl1)
1947 ret)))
1948 ;; Read the list of parameters, but do not put the symbols in
1949 ;; the standard obarray.
1951 ;; This is because read will intern nil if it doesn't into the
1952 ;; new obarray.
1961 "Return non-nil if the current point is in a code fragment.
1962 A code fragment is identified by an open parenthesis followed by a
1963 symbol which is a valid function or a word in all CAPS, or a parenthesis
1964 that is quoted with the ' character. Only the region from START to LIMIT
1965 is is allowed while searching for the bounding parenthesis."
1976 ;; if this string is function bound, we are in
1977 ;; sample code. If it has a - or : character in
1978 ;; the name, then it is probably supposed to be bound
1979 ;; but isn't yet.
1988 The text checked is between START and LIMIT."
1999 "Check all text between BEGIN and END for lower case proper nouns.
2000 These are Emacs centric proper nouns which should be capitalized for
2001 consistency. Return an error list if any are not fixed, but
2002 internally skip over no answers.
2003 If the offending word is in a piece of quoted text, then it is skipped."
2020 ;; surrounded by /, as in a URL or filename: /emacs/
2026 text)
2028 nil
2030 ;; If there is already an error, then generate
2031 ;; the warning output if applicable
2035 "Name %s should appear capitalized as %s"
2037 b e))
2040 "Name %s should appear capitalized as %s"
2042 bb b be e)))))))
2047 "Make sure all sentences have double spaces between BEGIN and END."
2067 ;; piece of an abbreviation
2072 b e
2073 "There should be two spaces after a period. Fix? "
2075 nil
2077 ;; If there is already an error, then generate
2078 ;; the warning output if applicable
2081 "There should be two spaces after a period"
2082 b e))
2084 "There should be two spaces after a period"
2085 bb b be e)))))))
2089 ;;; Ispell engine
2090 ;;
2094 "Initialize Ispell process (default version) with Lisp words.
2095 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2096 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2097 nil."
2103 ;; This code copied in part from ispell.el Emacs 19.34
2107 ;; Silence byte compiler
2114 "Run the Ispell tools on the doc string between point and END.
2115 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2116 before using the Ispell engine on it."
2118 ;; If the user wants no questions or fixing, then we must
2119 ;; disable spell checking as not useful.
2122 nil
2129 ;; Skip lists describing meta-syntax, or bound variables
2137 ;; This is probably repetitive in most cases, but not always.
2138 nil
2139 ;; Find out how we spell-check this word.
2141 ;; All caps w/ option th, or s tacked on the end
2142 ;; for pluralization or numberthness.
2145 )
2146 nil
2155 ;; Nothing here.
2156 )))))
2158 err))))
2160 ;;; Rogue space checking engine
2161 ;;
2163 "Return a message list if there is a line with white space at the end.
2164 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2165 If optional arguments START and END are non-nil, bound the check to
2166 this region.
2167 Optional argument INTERACT may permit the user to fix problems on the fly."
2171 ;; If end is nil, it means end of buffer to search anyway
2173 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2174 ;; (It's dangerous)
2179 "Don't use `? ' at the end of a line. \
2180 News agents may remove it"
2182 ;; If interactive is passed down, give them a chance to fix things.
2189 ;; Check for, and potentially remove whitespace appearing at the
2190 ;; end of different lines.
2193 ;; There is no documentation in the Emacs Lisp manual about this check,
2194 ;; it is intended to help clean up messy code and reduce the file size.
2196 ;; This is not a complex activity
2200 nil
2203 ;; Return an error and leave the cursor at that spot, or restore
2204 ;; the cursor.
2208 nil)))
2210 ;;; Comment checking engine
2211 ;;
2213 ;; We must load this to:
2214 ;; a) get symbols for compile and
2215 ;; b) determine if we have lm-history symbol which doesn't always exist
2219 "Return a message list if this file does not match the Emacs standard.
2220 This checks for style only, such as the first line, Commentary:,
2221 Code:, and others referenced in the style guide."
2223 nil
2225 ;; Old XEmacs don't have `lm-commentary-mark'
2234 ;; This file has been set up where ERR is a variable. Each check is
2235 ;; asked, and the function will make sure that if the user does not
2236 ;; auto-fix some error, that we still move on to the next auto-fix,
2237 ;; AND we remember the past errors.
2239 err
2240 ;; Lisp Maintenance checks first
2241 ;; Was: (lm-verify) -> not flexible enough for some people
2242 ;; * Summary at the beginning of the file:
2244 ;; This certifies as very complex so always ask unless
2245 ;; it's set to never
2254 nil))
2256 err
2258 ;; * Commentary Section
2265 nil t)
2278 nil nil t)))
2279 nil)
2280 err))
2282 err
2284 ;; * History section. Say nothing if there is a file ChangeLog
2290 nil
2296 nil t)
2308 err))
2310 err
2312 ;; * Code section
2323 nil)
2327 nil)
2328 err))
2330 err
2332 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2333 ;; The following is partially clipped from lm-verify
2341 nil t))
2348 fn fn fe)
2350 err))
2351 ;; The below checks will not return errors if the user says NO
2353 ;; Let's spellcheck the commentary section. This is the only
2354 ;; section that is easy to pick out, and it is also the most
2355 ;; visible section (with the finder).
2361 ;; Since the comments talk about Lisp, use the
2362 ;; specialized spell-checker we also used for doc
2363 ;; strings.
2368 err
2370 ;; Generic Full-file checks (should be comment related)
2372 err))
2373 ;; Done with full file comment checks
2374 err)))
2377 "Return t if point is outside the bounds of a valid sexp."
2384 ;;; `error' and `message' text verifier.
2385 ;;
2387 "Search between BEG and END for a style error with message text.
2388 Optional arguments BEG and END represent the boundary of the check.
2389 The default boundary is the entire buffer."
2396 e))
2399 "Move cursor to the next checkable message string after point.
2400 Return the message classification.
2401 Argument END is the maximum bounds to search in."
2420 nil
2422 return))
2425 "Return or fix errors found in strings passed to a message display function.
2426 According to the documentation for the function `error', the error list
2427 should not end with a period, and should start with a capital letter.
2428 The function `y-or-n-p' has similar constraints.
2429 Argument TYPE specifies the type of question, such as `error or `y-or-n-p."
2430 ;; If type is nil, then attempt to derive it.
2442 ;; From the documentation of the symbol `error':
2443 ;; In Emacs, the convention is that error messages start with a capital
2444 ;; letter but *do not* end with a period. Please follow this convention
2445 ;; for the sake of consistency.
2450 "Capitalize your message text? "
2452 t)))
2454 "Messages should start with a capital letter"
2456 nil)
2457 ;; In general, sentences should have two spaces after the period.
2461 ;; Look for proper nouns in this region too.
2465 ;; Here are message type specific questions.
2472 "Remove period from error? "
2473 ""
2474 t)))
2476 "Error messages should *not* end with a period"
2478 nil)
2479 ;; `y-or-n-p' documentation explicitly says:
2480 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2481 ;; I added the ? requirement. Without it, it is unclear that we
2482 ;; ask a question and it appears to be an undocumented style.
2487 nil
2491 ;; If we see a ?, then replace with "? ".
2496 nil
2507 nil
2519 nil
2523 ;; Now, let's just run the spell checker on this guy.
2526 )))
2528 ;;; Auto-fix helper functions
2529 ;;
2531 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2532 Argument QUESTION is the prompt passed to `y-or-n-p'."
2536 nil
2543 "Highlight between START and END and queries the user with QUESTION.
2544 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2545 the region marked by START and END with REPLACEWITH. If optional flag
2546 COMPLEX is non-nil, then we may ask the user a question. See the
2547 documentation for `checkdoc-autofix-flag' for details.
2549 If a section is auto-replaced without asking the user, this function
2550 will pause near the fixed code so the user will briefly see what
2551 happened.
2553 This function returns non-nil if the text was replaced.
2555 This function will not modify `match-data'."
2572 ;; On the off chance this is automatic, display
2573 ;; the question anyway so the user knows what's
2574 ;; going on.
2586 ret)))
2588 ;;; Warning management
2589 ;;
2603 "Set up the major mode for the buffer containing the list of errors."
2605 checkdoc-output-error-regex-alist)
2607 checkdoc-output-font-lock-keywords))
2610 "The name to use for a checkdoc buffer in the error list."
2616 "Initialize the checkdoc diagnostic buffer for a pass.
2617 Create the header so that the string CHECK-TYPE is displayed as the
2618 function called to create the messages."
2628 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2639 "Display the checkdoc diagnostic buffer in a temporary window."
2650 nil)))
2663 ;; arch-tag: c49a7ec8-3bb7-46f2-bfbc-d5f26e033b26
2664 ;;; checkdoc.el ends here