| blob | a5fb3cede5e3c4bd31a502ced7d30ffb0d3c0c22 |
1 ;;; checkdoc.el --- check documentation strings for style requirements
3 ;;; Copyright (C) 1997, 1998, 2001 Free Software Foundation
5 ;; Author: Eric M. Ludlam <zappo@gnu.org>
6 ;; Version: 0.6.2
7 ;; Keywords: docs, maint, lisp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
27 ;;
28 ;; The Emacs Lisp manual has a nice chapter on how to write
29 ;; documentation strings. Many stylistic suggestions are fairly
30 ;; deterministic and easy to check for syntactically, but also easy
31 ;; to forget. The main checkdoc engine will perform the stylistic
32 ;; checks needed to make sure these styles are remembered.
33 ;;
34 ;; There are two ways to use checkdoc:
35 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'.
36 ;; `checkdoc' is a more interactive version of
37 ;; `checkdoc-current-buffer'
38 ;; 2) Use `checkdoc-minor-mode' to automatically check your
39 ;; documentation whenever you evaluate Lisp code with C-M-x
40 ;; or [menu-bar emacs-lisp eval-buffer]. Additional key-bindings
41 ;; are also provided under C-c ? KEY
42 ;; (require 'checkdoc)
43 ;; (add-hook 'emacs-lisp-mode-hook
44 ;; '(lambda () (checkdoc-minor-mode 1)))
45 ;;
46 ;; Using `checkdoc':
47 ;;
48 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level
49 ;; entry points to all of the different checks that are available. It
50 ;; breaks examination of your Lisp file into four sections (comments,
51 ;; documentation, messages, and spacing) and indicates its current
52 ;; state in a status buffer.
53 ;;
54 ;; The Comments check examines your headers, footers, and
55 ;; various tags (such as "Code:") to make sure that your code is ready
56 ;; for easy integration into existing systems.
57 ;;
58 ;; The Documentation check deals with documentation strings
59 ;; and their elements that help make Emacs easier to use.
60 ;;
61 ;; The Messages check ensures that the strings displayed in the
62 ;; minibuffer by some commands (such as `error' and `y-or-n-p')
63 ;; are consistent with the Emacs environment.
64 ;;
65 ;; The Spacing check cleans up white-space at the end of lines.
66 ;;
67 ;; The interface while working with documentation and messages is
68 ;; slightly different when being run in the interactive mode. The
69 ;; interface offers several options, including the ability to skip to
70 ;; the next error, or back up to previous errors. Auto-fixing is
71 ;; turned off at this stage, but you can use the `f' or `F' key to fix
72 ;; a given error (if the fix is available.)
73 ;;
74 ;; Auto-fixing:
75 ;;
76 ;; There are four classifications of style errors in terms of how
77 ;; easy they are to fix. They are simple, complex, really complex,
78 ;; and impossible. (Impossible really means that checkdoc does not
79 ;; have a fixing routine yet.) Typically white-space errors are
80 ;; classified as simple, and are auto-fixed by default. Typographic
81 ;; changes are considered complex, and the user is asked if they want
82 ;; the problem fixed before checkdoc makes the change. These changes
83 ;; can be done without asking if `checkdoc-autofix-flag' is properly
84 ;; set. Potentially redundant changes are considered really complex,
85 ;; and the user is always asked before a change is inserted. The
86 ;; variable `checkdoc-autofix-flag' controls how these types of errors
87 ;; are fixed.
88 ;;
89 ;; Spell checking text:
90 ;;
91 ;; The variable `checkdoc-spellcheck-documentation-flag' can be set
92 ;; to customize how spell checking is to be done. Since spell
93 ;; checking can be quite slow, you can optimize how best you want your
94 ;; checking done. The default is `defun', which spell checks each time
95 ;; `checkdoc-defun' or `checkdoc-eval-defun' is used. Setting to nil
96 ;; prevents spell checking during normal usage.
97 ;; Setting this variable to nil does not mean you cannot take
98 ;; advantage of the spell checking. You can instead use the
99 ;; interactive functions `checkdoc-ispell-*' to check the spelling of
100 ;; your documentation.
101 ;; There is a list of Lisp-specific words which checkdoc will
102 ;; install into Ispell on the fly, but only if Ispell is not already
103 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with
104 ;; these words enabled.
105 ;;
106 ;; Checking parameters:
107 ;;
108 ;; You might not always want a function to have its parameters listed
109 ;; in order. When this is the case, put the following comment just in
110 ;; front of the documentation string: "; checkdoc-order: nil" This
111 ;; overrides the value of `checkdoc-arguments-in-order-flag'.
112 ;;
113 ;; If you specifically wish to avoid mentioning a parameter of a
114 ;; function in the doc string (such as a hidden parameter, or a
115 ;; parameter which is very obvious like events), you can have checkdoc
116 ;; skip looking for it by putting the following comment just in front
117 ;; of the documentation string: "; checkdoc-params: (args go here)"
118 ;;
119 ;; Checking message strings:
120 ;;
121 ;; The text that follows the `error' and `y-or-n-p' commands is
122 ;; also checked. The documentation for `error' clearly states some
123 ;; simple style rules to follow which checkdoc will auto-fix for you.
124 ;; `y-or-n-p' also states that it should end in a space. I added that
125 ;; it should end in "? " since that is almost always used.
126 ;;
127 ;; Adding your own checks:
128 ;;
129 ;; You can experiment with adding your own checks by setting the
130 ;; hooks `checkdoc-style-hooks' and `checkdoc-comment-style-hooks'.
131 ;; Return a string which is the error you wish to report. The cursor
132 ;; position should be preserved.
133 ;;
134 ;; Error errors:
135 ;;
136 ;; Checkdoc does not always flag errors correctly. There are a
137 ;; couple ways you can coax your file into passing all of checkdoc's
138 ;; tests through buffer local variables.
139 ;;
140 ;; The variable `checkdoc-verb-check-experimental-flag' can be used
141 ;; to turn off the check for verb-voice in case you use words that are
142 ;; not semantically verbs, but are still in the incomplete list.
143 ;;
144 ;; The variable `checkdoc-symbol-words' can be a list of words that
145 ;; happen to also be symbols. This is not a problem for one-word
146 ;; symbols, but if you use a hyphenated word that is also a symbol,
147 ;; then you may need this.
148 ;;
149 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if
150 ;; you have many undocumented functions you don't wish to document.
151 ;;
152 ;; See the above section "Checking Parameters" for details about
153 ;; parameter checking.
154 ;;
155 ;; Dependencies:
156 ;;
157 ;; This file requires lisp-mnt (Lisp maintenance routines) for the
158 ;; comment checkers.
159 ;;
160 ;; Requires custom for Emacs v20.
162 ;;; TO DO:
163 ;; Hook into the byte compiler on a defun/defvar level to generate
164 ;; warnings in the byte-compiler's warning/error buffer.
165 ;; Better ways to override more typical `eval' functions. Advice
166 ;; might be good but hard to turn on/off as a minor mode.
167 ;;
168 ;;; Maybe Do:
169 ;; Code sweep checks for "forbidden functions", proper use of hooks,
170 ;; proper keybindings, and other items from the manual that are
171 ;; not specifically docstring related. Would this even be useful?
173 ;;; Code:
177 ;; From custom web page for compatibility between versions of custom:
183 nil ;; We've got what we needed
184 ;; We have the old custom-library, hack around it!
186 nil)
188 nil)
193 "*Non-nil means attempt auto-fixing of doc strings.
194 If this value is the symbol `query', then the user is queried before
195 any change is made. If the value is `automatic', then all changes are
196 made without asking unless the change is very-complex. If the value
197 is `semiautomatic' or any other value, then simple fixes are made
198 without asking, and complex changes are made by asking the user first.
199 The value `never' is the same as nil, never ask or change anything."
208 Setting this to nil will silently make fixes that require no user
209 interaction. See `checkdoc-autofix-flag' for auto-fixing details."
214 "*Non-nil means that all checkable definitions should have documentation.
215 Style guide dictates that interactive functions MUST have documentation,
216 and that it's good but not required practice to make non user visible items
217 have doc strings."
222 "*Non-nil means that files should have a History section or ChangeLog file.
223 This helps document the evolution of, and recent changes to, the package."
228 "*Non-nil means the first line of a docstring may end with a comma.
229 Ordinarily, a full sentence is required. This may be misleading when
230 there is a substantial caveat to the one-line description -- the comma
231 should be used when the first part could stand alone as a sentence, but
232 it indicates that a modifying clause follows."
237 "*Non-nil means run Ispell on text based on value.
238 This is automatically set to nil if Ispell does not exist on your
239 system. Possible values are:
241 nil - Don't spell-check during basic style checks.
242 defun - Spell-check when style checking a single defun
243 buffer - Spell-check when style checking the whole buffer
244 interactive - Spell-check during any interactive check.
245 t - Always spell-check"
259 Any more than this and a warning is generated suggesting that the construct
265 "*Non-nil means warn if arguments appear out of order.
266 Setting this to nil will mean only checking that all the arguments
267 appear in the proper form in the documentation, not that they are in
268 the same order as they appear in the argument list. No mention is
269 made in the style guide relating to order."
274 "Hooks called after the standard style check is completed.
275 All hooks must return nil or a string representing the error found.
276 Useful for adding new user implemented commands.
278 Each hook is called with two parameters, (DEFUNINFO ENDPOINT).
279 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the
283 "Hooks called after the standard comment style check is completed.
284 Must return nil if no errors are found, or a string describing the
293 "Regular expression used to identify a defun.
297 "*Non-nil means to attempt to check the voice of the doc string.
298 This check keys off some words which are commonly misused. See the
299 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own."
304 "Non-nil means generate warnings in a buffer for browsing.
305 Do not set this by hand, use a function like `checkdoc-current-buffer'
309 "A list of symbols which also happen to make good words.
310 These symbol-words are ignored when unquoted symbols are searched for.
311 This should be set in an Emacs Lisp file's local variables."
411 )
412 "Alist of common words in the wrong voice and what should be used instead.
413 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly
414 and experimental check. Do not modify this list without setting
415 the value of `checkdoc-common-verbs-regexp' to nil which cause it to
422 nil
424 ;; When dealing with syntax in doc strings, make sure that - are encompassed
425 ;; in words so we can use cheap \\> to get the end of a symbol, not the
426 ;; end of a word in a conglomerate.
428 )
431 ;;; Compatibility
432 ;;
442 )
450 )
452 ;; Emacs 20s have MULE characters which don't equate to numbers.
457 ;; Read events, not characters
460 ;;; User level commands
461 ;;
462 ;;;###autoload
464 "Interactively check the entire buffer for style errors.
465 The current status of the check will be displayed in a buffer which
466 the users will view as each check is completed."
472 ;; if the user set autofix to never, then that breaks the
473 ;; obviously requested asking implied by using this function.
474 ;; Set it to paranoia level.
477 'query
478 checkdoc-autofix-flag))
479 tmp)
481 ;; check the comments
489 ;; Check the documentation
496 ;; Check the message text
502 ;; Rogue spacing
511 "Display and update the status buffer for the current checkdoc mode.
512 CHECK is a list of four strings stating the current status of each
513 test; the nth string describes the status of the nth test."
521 )))
527 ;;;###autoload
529 "Interactively check the current buffer for doc string errors.
530 Prefix argument START-HERE will start the checking from the current
531 point, otherwise the check starts at the beginning of the current
532 buffer. Allows navigation forward and backwards through document
533 errors. Does not check for comment or space warnings.
534 Optional argument SHOWSTATUS indicates that we should update the
535 checkdoc status window instead of the usual behavior."
541 ;; Due to a design flaw, this will never spell check
542 ;; docstrings.
545 ;; This is a workaround to perform spell checking.
548 ;;;###autoload
550 "Interactively check the current buffer for message string errors.
551 Prefix argument START-HERE will start the checking from the current
552 point, otherwise the check starts at the beginning of the current
553 buffer. Allows navigation forward and backwards through document
554 errors. Does not check for comment or space warnings.
555 Optional argument SHOWSTATUS indicates that we should update the
556 checkdoc status window instead of the usual behavior."
562 ;; Due to a design flaw, this will never spell check messages.
565 ;; This is a workaround to perform spell checking.
569 "Interactively loop over all errors that can be found by a given method.
571 If START-HERE is nil, searching starts at the beginning of the current
572 buffer, otherwise searching starts at START-HERE. SHOWSTATUS
573 expresses the verbosity of the search, and whether ending the search
574 will auto-exit this function.
576 FINDFUNC is a symbol representing a function that will position the
577 cursor, and return error message text to present to the user. It is
578 assumed that the cursor will stop just before a major sexp, which will
579 be highlighted to present the user with feedback as to the offending
580 style."
581 ;; Determine where to start the test
584 ;; Assign a flag to spellcheck flag
588 ;; Fetch the error list
592 c)
595 ;; Include whatever function point is in for good measure.
599 ;; The cursor should be just in front of the offending doc string
610 ;; Make sure the whole doc string is visible if possible.
634 ;; Exit condition
636 ;; Request an auto-fix
641 ;; `automatic-then-never' tells the autofix function
642 ;; to only allow one fix to be automatic. The autofix
643 ;; function will then set the flag to 'never, allowing
644 ;; the checker to return a different error.
667 ;; Move to the next error (if available)
673 err-list nil)
679 ;; Go backwards in the list of errors
688 ;; Edit the buffer recursively.
699 err-list nil)
703 ;; Quit checkdoc
706 err-list nil
708 ;; Goofy stuff
718 ""
720 "f, y - auto Fix this warning without asking (if\
723 )
735 returnme))
738 "Interactively spell check doc strings in the current buffer.
739 If START-HERE is nil, searching starts at the beginning of the current
740 buffer, otherwise searching starts at START-HERE."
743 ;; Move point to where we need to start.
745 ;; Include whatever function point is in for good measure.
748 ;; Loop over docstrings.
758 "Interactively spell check messages in the current buffer.
759 If START-HERE is nil, searching starts at the beginning of the current
760 buffer, otherwise searching starts at START-HERE."
763 ;; Move point to where we need to start.
765 ;; Include whatever function point is in for good measure.
768 ;; Loop over message strings.
779 "Find and return the next checkdoc error list, or nil.
780 Only documentation strings are checked.
781 An error list is of the form (WARNING . POSITION) where WARNING is the
782 warning text, and POSITION is the point in the buffer where the error
783 was found. We can use points and not markers because we promise not
784 to edit the buffer before point without re-executing this check.
785 Argument ENABLE-FIX will enable auto-fixing while looking for the next
786 error. This argument assumes that the cursor is already positioned to
787 perform the fix."
798 ;; Quit.. restore position, Other errors, leave alone
800 msg)))
803 "Find and return the next checkdoc message related error list, or nil.
804 Only text for error and `y-or-n-p' strings are checked. See
805 `checkdoc-next-error' for details on the return value.
806 Argument ENABLE-FIX turns on the auto-fix feature. This argument
807 assumes that the cursor is already positioned to perform the fix."
820 ;; Quit.. restore position, Other errors, leave alone
822 msg)))
825 "Enter recursive edit to permit a user to fix some error checkdoc has found.
826 MSG is the error that was found, which is displayed in a help buffer."
841 ;;;###autoload
843 "Evaluate and check documentation for the current buffer.
844 Evaluation is done first because good documentation for something that
845 doesn't work is just not useful. Comments, doc strings, and rogue
846 spacing are all verified."
851 ;;;###autoload
853 "Check current buffer for document, comment, error style, and rogue spaces.
854 With a prefix argument (in Lisp, the argument TAKE-NOTES),
855 store all errors found in a warnings buffer,
856 otherwise stop after the first error."
859 ;; Assign a flag to spellcheck flag
864 checkdoc-autofix-flag))
869 ;; every test is responsible for returning the cursor.
879 ;;;###autoload
881 "Start scanning the current buffer for documentation string style errors.
882 Only documentation strings are checked.
883 Use `checkdoc-continue' to continue checking if an error cannot be fixed.
884 Prefix argument TAKE-NOTES means to collect all the warning messages into
885 a separate buffer."
892 ;; Go back since we can't be here without success above.
894 nil))
896 ;;;###autoload
898 "Find the next doc string in the current buffer which has a style error.
899 Prefix argument TAKE-NOTES means to continue through the whole buffer and
900 save warnings in a separate buffer. Second optional argument START-POINT
901 is the starting location. If this is nil, `point-min' is used instead."
904 ;; Assign a flag to spellcheck flag
909 checkdoc-autofix-flag))
913 ;; If we are taking notes, encompass the whole buffer, otherwise
914 ;; the user is navigating down through the buffer.
916 ;; OK, let's look at the doc string.
929 "Move to the next doc string after point, and return t.
930 Return nil if there are no more doc strings."
932 nil
933 ;; search drops us after the identifier. The next sexp is either
934 ;; the argument list or the value of the variable. skip it.
937 t))
939 ;;;###autoload
941 "Find missing comment sections in the current Emacs Lisp file.
942 Prefix argument TAKE-NOTES non-nil means to save warnings in a
943 separate buffer. Otherwise print a message. This returns the error
944 if there is one."
958 e))
960 ;;;###autoload
962 "Find extra spaces at the end of lines in the current file.
963 Prefix argument TAKE-NOTES non-nil means to save warnings in a
964 separate buffer. Otherwise print a message. This returns the error
965 if there is one.
966 Optional argument INTERACT permits more interactive fixing."
974 e
980 ;;;###autoload
982 "Scan the buffer for occurrences of the error function, and verify text.
983 Optional argument TAKE-NOTES causes all errors to be logged."
992 e
999 ;;;###autoload
1001 "Evaluate the current form with `eval-defun' and check its documentation.
1002 Evaluation is done first so the form will be read before the
1003 documentation is checked. If there is a documentation error, then the display
1004 of what was evaluated will be overwritten by the diagnostic message."
1009 ;;;###autoload
1011 "Examine the doc string of the function or variable under point.
1012 Call `error' if the doc string has problems. If NO-ERROR is
1013 non-nil, then do not call error, but call `message' instead.
1014 If the doc string passes the test, then check the function for rogue white
1015 space at the end of each line."
1020 ;; I found this more annoying than useful.
1021 ;;(if (not no-error)
1022 ;; (message "Cannot check this sexp's doc string."))
1023 nil
1024 ;; search drops us after the identifier. The next sexp is either
1025 ;; the argument list or the value of the variable. skip it.
1048 ;;; Ispell interface for forcing a spell check
1049 ;;
1051 ;;;###autoload
1053 "Check the style and spelling of everything interactively.
1054 Calls `checkdoc' with spell-checking turned on.
1055 Prefix argument TAKE-NOTES is the same as for `checkdoc'"
1060 ;;;###autoload
1062 "Check the style and spelling of the current buffer.
1063 Calls `checkdoc-current-buffer' with spell-checking turned on.
1064 Prefix argument TAKE-NOTES is the same as for `checkdoc-current-buffer'"
1069 ;;;###autoload
1071 "Check the style and spelling of the current buffer interactively.
1072 Calls `checkdoc-interactive' with spell-checking turned on.
1073 Prefix argument TAKE-NOTES is the same as for `checkdoc-interactive'"
1078 ;;;###autoload
1080 "Check the style and spelling of message text interactively.
1081 Calls `checkdoc-message-interactive' with spell-checking turned on.
1082 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-interactive'"
1087 ;;;###autoload
1089 "Check the style and spelling of message text interactively.
1090 Calls `checkdoc-message-text' with spell-checking turned on.
1091 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-text'"
1096 ;;;###autoload
1098 "Check the style and spelling of the current buffer.
1099 Calls `checkdoc-start' with spell-checking turned on.
1100 Prefix argument TAKE-NOTES is the same as for `checkdoc-start'"
1105 ;;;###autoload
1107 "Check the style and spelling of the current buffer after point.
1108 Calls `checkdoc-continue' with spell-checking turned on.
1109 Prefix argument TAKE-NOTES is the same as for `checkdoc-continue'"
1114 ;;;###autoload
1116 "Check the style and spelling of the current buffer's comments.
1117 Calls `checkdoc-comments' with spell-checking turned on.
1118 Prefix argument TAKE-NOTES is the same as for `checkdoc-comments'"
1123 ;;;###autoload
1125 "Check the style and spelling of the current defun with Ispell.
1126 Calls `checkdoc-defun' with spell-checking turned on.
1127 Prefix argument TAKE-NOTES is the same as for `checkdoc-defun'"
1132 ;;; Error Management
1133 ;;
1134 ;; Errors returned from checkdoc functions can have various
1135 ;; features and behaviors, so we need some ways of specifying
1136 ;; them, and making them easier to use in the wacked-out interfaces
1137 ;; people are requesting
1139 "Used to create the return error text returned from all engines.
1140 TEXT is the descriptive text of the error. START and END define the region
1141 it is sensible to highlight when describing the problem.
1142 Optional argument UNFIXABLE means that the error has no auto-fix available.
1144 A list of the form (TEXT START END UNFIXABLE) is returned if we are not
1145 generating a buffered list of errors."
1148 nil)
1152 "Return the text specified in the checkdoc ERR."
1153 ;; string-p part is for backwards compatibility
1157 "Return the start point specified in the checkdoc ERR."
1158 ;; string-p part is for backwards compatibility
1162 "Return the end point specified in the checkdoc ERR."
1163 ;; string-p part is for backwards compatibility
1167 "Return the t if we cannot autofix the error specified in the checkdoc ERR."
1168 ;; string-p part is for backwards compatibility
1171 ;;; Minor Mode specification
1172 ;;
1177 ;; Override some bindings
1183 ;; Add some new bindings under C-c ?
1201 ;; bind our submap into map
1203 map)
1210 ;; Add in a menubar with easy-menu
1213 nil checkdoc-minor-mode-map "Checkdoc Minor Mode Menu"
1219 "---"
1228 checkdoc-ispell-message-interactive t]
1233 buffer-file-name]
1235 "---"
1240 ))
1241 ;; XEmacs requires some weird stuff to add this menu in a minor mode.
1242 ;; What is it?
1244 ;;;###autoload
1246 "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings.
1247 With prefix ARG, turn Checkdoc minor mode on iff ARG is positive.
1249 In Checkdoc minor mode, the usual bindings for `eval-defun' which is
1250 bound to \\<checkdoc-minor-mode-map> \\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
1251 checking of documentation strings.
1254 nil " CDoc" nil
1257 ;;; Subst utils
1258 ;;
1260 "Run hooks in HOOKVAR with ARGS."
1263 ;; This method was similar to above. We ignore the warning
1264 ;; since we will use the above for future Emacs versions
1268 "Rebuild the contents of `checkdoc-common-verbs-regexp'."
1276 ;; Profiler says this is not yet faster than just calling assoc
1277 ;;(defun checkdoc-word-in-alist-vector (word vector)
1278 ;; "Check to see if WORD is in the car of an element of VECTOR.
1279 ;;VECTOR must be sorted. The CDR should be a replacement. Since the
1280 ;;word list is getting bigger, it is time for a quick bisecting search."
1281 ;; (let ((max (length vector)) (min 0) i
1282 ;; (found nil) (fw nil))
1283 ;; (setq i (/ max 2))
1284 ;; (while (and (not found) (/= min max))
1285 ;; (setq fw (car (aref vector i)))
1286 ;; (cond ((string= word fw) (setq found (cdr (aref vector i))))
1287 ;; ((string< word fw) (setq max i))
1288 ;; (t (setq min i)))
1289 ;; (setq i (/ (+ max min) 2))
1290 ;; )
1291 ;; found))
1293 ;;; Checking engines
1294 ;;
1296 "Return a message string if the current doc string is invalid.
1297 Check for style only, such as the first line always being a complete
1298 sentence, whitespace restrictions, and making sure there are no
1299 hard-coded key-codes such as C-[char] or mouse-[number] in the comment.
1300 See the style guide in the Emacs Lisp manual for more details."
1302 ;; Jump over comments between the last object and the doc string
1311 err
1312 ;; * Every command, function, or variable intended for users to know
1313 ;; about should have a documentation string.
1314 ;;
1315 ;; * An internal variable or subroutine of a Lisp program might as well
1316 ;; have a documentation string. In earlier Emacs versions, you could
1317 ;; save space by using a comment instead of a documentation string,
1318 ;; but that is no longer the case.
1323 ;; Sometimes old code has comments where the documentation should
1324 ;; be. Let's see if we can find the comment, and offer to turn it
1325 ;; into documentation for them.
1341 ;; Our point is at the beginning of the comment!
1342 ;; Insert a quote, then remove the comment chars.
1361 ;; quote any double-quote characters in the comment.
1367 "You should convert this comment to documentation"
1371 "All interactive functions should have documentation"
1372 "All variables and subroutines might as well have a \
1382 err)))
1385 "Return an error list or string if the current doc string is invalid.
1386 Depends on `checkdoc-this-string-valid' to reset the syntax table so that
1387 regexp short cuts work. FP is the function defun information."
1389 ;; Use a marker so if an early check modifies the text,
1390 ;; we won't accidentally loose our place. This could cause
1391 ;; end-of doc string whitespace to also delete the " char.
1397 ;; * *Do not* indent subsequent lines of a documentation string so that
1398 ;; the text is lined up in the source code with the text of the first
1399 ;; line. This looks nice in the source code, but looks bizarre when
1400 ;; users view the documentation. Remember that the indentation
1401 ;; before the starting double-quote is not part of the string!
1409 "Remove this whitespace? "
1411 nil
1413 "Second line should not have indentation"
1416 ;; * Check for '(' in column 0.
1421 "Escape this '('? "
1423 nil
1425 "Open parenthesis in column 0 should be escaped"
1427 ;; * Do not start or end a documentation string with whitespace.
1440 nil
1442 "Documentation strings should not start or end with whitespace"
1443 start end))))
1444 ;; * The first line of the documentation string should consist of one
1445 ;; or two complete sentences that stand on their own as a summary.
1446 ;; `M-x apropos' displays just the first line, and if it doesn't
1447 ;; stand on its own, the result looks bad. In particular, start the
1448 ;; first line with a capital letter and end with a period.
1456 ;; A backslashed double quote at the end of a sentence
1458 ;; We might have to add a period in this case
1461 nil
1466 nil
1468 "First sentence should end with punctuation"
1471 ;; These are ok
1472 nil)
1474 nil)
1476 ;; If it is not a complete sentence, let's see if we can
1477 ;; predict a clever way to make it one.
1482 ;; Here we have found a complete sentence, but no break.
1485 "First line not a complete sentence. Add RET here? "
1498 ;; We can merge these lines! Replace this CR
1499 ;; with a space.
1502 ;; Let's see if there is enough room to draw the next
1503 ;; line's sentence up here. I often get hit w/
1504 ;; auto-fill moving my words around.
1513 t)
1517 "1st line not a complete sentence. Join these lines? "
1520 ;; They said yes. We have more fill work to do...
1530 nil) ))))
1531 ;; Continuation of above. Make sure our sentence is capitalized.
1538 t)
1539 nil
1541 "First line should be capitalized"
1543 nil))
1544 ;; * Don't write key sequences directly in documentation strings.
1545 ;; Instead, use the `\\[...]' construct to stand for them.
1550 ;; Find the first key sequence not in a sample
1560 ;; It is not practical to use `\\[...]' very many times, because
1561 ;; display of the documentation string will become slow. So use this
1562 ;; to describe the most important commands in your major mode, and
1563 ;; then use `\\{...}' to display the rest of the mode's keymap.
1570 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound,
1571 ;; and is referred to in documentation, it should be prefixed with
1572 ;; something to disambiguate it. This check must be before the
1573 ;; 80 column check because it will probably break that.
1591 ;; We didn't actually replace anything. Here we find
1592 ;; out what special word form they wish to use as
1593 ;; a prefix.
1596 "Disambiguating Keyword (default: variable): "
1608 nil)))
1609 ;; * Format the documentation string so that it fits in an
1610 ;; Emacs window on an 80-column screen. It is a good idea
1611 ;; for most lines to be no wider than 60 characters. The
1612 ;; first line can be wider if necessary to fit the
1613 ;; information that ought to be there.
1622 eol t))
1628 "Some lines are over 80 columns wide"
1630 ;; Here we deviate to tests based on a variable or function.
1631 ;; We must do this before checking for symbols in quotes because there
1632 ;; is a chance that just such a symbol might really be an argument.
1634 ;; This is if we are in a variable
1636 ;; * The documentation string for a variable that is a
1637 ;; yes-or-no flag should start with words such as Non-nil
1638 ;; means..., to make it clear that all non-`nil' values are
1639 ;; equivalent and indicate explicitly what `nil' and non-`nil'
1640 ;; mean.
1641 ;; * If a user option variable records a true-or-false
1642 ;; condition, give it a name that ends in `-flag'.
1644 ;; If the variable has -flag in the name, make sure
1648 "Flag variable doc strings should usually start: Non-nil means"
1650 ;; If the doc string starts with "Non-nil means"
1659 "Rename to %s and Query-Replace all occurrences? "
1660 newname))
1665 newname))
1667 "Flag variable names should normally end in `-flag'" s
1669 ;; Done with variables
1670 ))
1672 ;; This if we are in a function definition
1674 ;; * When a function's documentation string mentions the value
1675 ;; of an argument of the function, use the argument name in
1676 ;; capital letters as if it were a name for that value. Thus,
1677 ;; the documentation string of the function `/' refers to its
1678 ;; second argument as `DIVISOR', because the actual argument
1679 ;; name is `divisor'.
1681 ;; Addendum: Make sure they appear in the doc in the same
1682 ;; order that they are found in the arg list.
1692 inopts t)
1697 ;; Require whitespace OR
1698 ;; ITEMth<space> OR
1699 ;; ITEMs<space>
1701 e t)))
1704 ;; If the symbol was not found, let's see if we
1705 ;; can find it with a different capitalization
1706 ;; and see if the user wants to capitalize it.
1710 ;; Require whitespace OR
1711 ;; ITEMth<space> OR
1712 ;; ITEMs<space>
1714 e t))
1718 "If this is the argument `%s', it should appear as %s. Fix? "
1724 ;; It wasn't found at all! Offer to attach this new symbol
1725 ;; to the end of the documentation string.
1728 "Add %s documentation to end of doc string? "
1730 ;; Now do some magic and invent a doc string.
1741 nil)
1744 "Argument `%s' should appear (as %s) in the doc string"
1751 "Arguments occur in the doc string out of order"
1753 ;; * For consistency, phrase the verb in the first sentence of a
1754 ;; documentation string for functions as an imperative.
1755 ;; For instance, use `Return the cons of A and
1756 ;; B.' in preference to `Returns the cons of A and B.'
1757 ;; Usually it looks good to do likewise for the rest of the
1758 ;; first paragraph. Subsequent paragraphs usually look better
1759 ;; if they have proper subjects.
1760 ;;
1761 ;; This is the least important of the above tests. Make sure
1762 ;; it occurs last.
1765 ;; Maybe rebuild the monster-regexp
1769 ;; check string-continuation
1777 checkdoc-common-verbs-regexp
1778 lim t))
1782 checkdoc-common-verbs-wrong-voice))
1793 replace t)
1796 ;; there was a match, but no replace
1800 original replace)
1802 ;; Done with functions
1803 )))
1804 ;;* When a documentation string refers to a Lisp symbol, write it as
1805 ;; it would be printed (which usually means in lower case), with
1806 ;; single-quotes around it. For example: `lambda'. There are two
1807 ;; exceptions: write t and nil without single-quotes. (In this
1808 ;; manual, we normally do use single-quotes for those symbols.)
1814 e t))
1817 ;; A . is a \s_ char, so we must remove periods from
1818 ;; sentences more carefully.
1828 ms))
1836 ms))))))
1841 nil)))
1842 ;; t and nil case
1850 nil
1852 "Symbols t and nil should not appear in `...' quotes"
1854 ;; Here is some basic sentence formatting
1856 ;; Here are common proper nouns that should always appear capitalized.
1858 ;; Make sure the doc string has correctly spelled English words
1859 ;; in it. This function is extracted due to its complexity,
1860 ;; and reliance on the Ispell program.
1862 ;; User supplied checks
1864 ;; Done!
1865 )))
1868 "Return a list of details about the current sexp.
1869 It is a list of the form:
1870 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...)
1871 where NAME is the name, VARIABLE is t if this is a `defvar',
1872 INTERACTIVE is nil if this is not an interactive function, otherwise
1873 it is the position of the `interactive' call, and PARAMETERS is a
1874 string which is the name of each variable in the function's argument
1875 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc
1876 comment for a given defun. If the first element is not a string, then
1877 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read
1878 from the comment."
1894 ;; The variable spot
1896 ;; Interactive
1901 t)
1902 ret)))
1906 ;; Overload th main obarray so read doesn't intern the
1907 ;; local symbols of the function we are checking.
1908 ;; Without this we end up cluttering the symbol space w/
1909 ;; useless symbols.
1911 ;; Ok, check for checkdoc parameter comment here
1919 t)
1925 t)
1939 sl1)
1940 ret)))
1941 ;; Read the list of parameters, but do not put the symbols in
1942 ;; the standard obarray.
1944 ;; This is because read will intern nil if it doesn't into the
1945 ;; new obarray.
1954 "Return non-nil if the current point is in a code fragment.
1955 A code fragment is identified by an open parenthesis followed by a
1956 symbol which is a valid function or a word in all CAPS, or a parenthesis
1957 that is quoted with the ' character. Only the region from START to LIMIT
1958 is is allowed while searching for the bounding parenthesis."
1969 ;; if this string is function bound, we are in
1970 ;; sample code. If it has a - or : character in
1971 ;; the name, then it is probably supposed to be bound
1972 ;; but isn't yet.
1981 The text checked is between START and LIMIT."
1992 "Check all text between BEGIN and END for lower case proper nouns.
1993 These are Emacs centric proper nouns which should be capitalized for
1994 consistency. Return an error list if any are not fixed, but
1995 internally skip over no answers.
1996 If the offending word is in a piece of quoted text, then it is skipped."
2013 ;; surrounded by /, as in a URL or filename: /emacs/
2019 text)
2021 nil
2023 ;; If there is already an error, then generate
2024 ;; the warning output if applicable
2028 "Name %s should appear capitalized as %s"
2030 b e))
2033 "Name %s should appear capitalized as %s"
2035 bb b be e)))))))
2040 "Make sure all sentences have double spaces between BEGIN and END."
2060 ;; piece of an abbreviation
2065 b e
2066 "There should be two spaces after a period. Fix? "
2068 nil
2070 ;; If there is already an error, then generate
2071 ;; the warning output if applicable
2074 "There should be two spaces after a period"
2075 b e))
2077 "There should be two spaces after a period"
2078 bb b be e)))))))
2082 ;;; Ispell engine
2083 ;;
2087 "Initialize Ispell process (default version) with Lisp words.
2088 The words used are from `checkdoc-ispell-lisp-words'. If `ispell'
2089 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to
2090 nil."
2096 ;; This code copied in part from ispell.el Emacs 19.34
2100 ;; Silence byte compiler
2107 "Run the Ispell tools on the doc string between point and END.
2108 Since Ispell isn't Lisp-smart, we must pre-process the doc string
2109 before using the Ispell engine on it."
2111 ;; If the user wants no questions or fixing, then we must
2112 ;; disable spell checking as not useful.
2115 nil
2122 ;; Skip lists describing meta-syntax, or bound variables
2130 ;; This is probably repetitive in most cases, but not always.
2131 nil
2132 ;; Find out how we spell-check this word.
2134 ;; All caps w/ option th, or s tacked on the end
2135 ;; for pluralization or numberthness.
2138 )
2139 nil
2148 ;; Nothing here.
2149 )))))
2151 err))))
2153 ;;; Rogue space checking engine
2154 ;;
2156 "Return a message list if there is a line with white space at the end.
2157 If `checkdoc-autofix-flag' permits, delete that whitespace instead.
2158 If optional arguments START and END are non nil, bound the check to
2159 this region.
2160 Optional argument INTERACT may permit the user to fix problems on the fly."
2164 ;; If end is nil, it means end of buffer to search anyway
2166 ;; Check for an error if `? ' or `?\ ' is used at the end of a line.
2167 ;; (It's dangerous)
2172 "Don't use `? ' at the end of a line. \
2173 News agents may remove it"
2175 ;; If interactive is passed down, give them a chance to fix things.
2182 ;; Check for, and potentially remove whitespace appearing at the
2183 ;; end of different lines.
2186 ;; There is no documentation in the Emacs Lisp manual about this check,
2187 ;; it is intended to help clean up messy code and reduce the file size.
2189 ;; This is not a complex activity
2193 nil
2196 ;; Return an error and leave the cursor at that spot, or restore
2197 ;; the cursor.
2201 nil)))
2203 ;;; Comment checking engine
2204 ;;
2206 ;; We must load this to:
2207 ;; a) get symbols for compile and
2208 ;; b) determine if we have lm-history symbol which doesn't always exist
2212 "Return a message list if this file does not match the Emacs standard.
2213 This checks for style only, such as the first line, Commentary:,
2214 Code:, and others referenced in the style guide."
2216 nil
2218 ;; Old XEmacs don't have `lm-commentary-mark'
2227 ;; This file has been set up where ERR is a variable. Each check is
2228 ;; asked, and the function will make sure that if the user does not
2229 ;; auto-fix some error, that we still move on to the next auto-fix,
2230 ;; AND we remember the past errors.
2232 err
2233 ;; Lisp Maintenance checks first
2234 ;; Was: (lm-verify) -> not flexible enough for some people
2235 ;; * Summary at the beginning of the file:
2237 ;; This certifies as very complex so always ask unless
2238 ;; it's set to never
2247 nil))
2249 err
2251 ;; * Commentary Section
2258 nil t)
2270 nil nil t)))
2271 nil)
2272 err))
2274 err
2276 ;; * History section. Say nothing if there is a file ChangeLog
2282 nil
2288 nil t)
2300 err))
2302 err
2304 ;; * Code section
2315 nil)
2319 nil)
2320 err))
2322 err
2324 ;; * A footer. Not compartmentalized from lm-verify: too bad.
2325 ;; The following is partially clipped from lm-verify
2333 nil t))
2340 fn fn fe)
2342 err))
2343 ;; The below checks will not return errors if the user says NO
2345 ;; Let's spellcheck the commentary section. This is the only
2346 ;; section that is easy to pick out, and it is also the most
2347 ;; visible section (with the finder).
2353 ;; Since the comments talk about Lisp, use the
2354 ;; specialized spell-checker we also used for doc
2355 ;; strings.
2360 err
2362 ;; Generic Full-file checks (should be comment related)
2364 err))
2365 ;; Done with full file comment checks
2366 err)))
2369 "Return t if point is outside the bounds of a valid sexp."
2376 ;;; `error' and `message' text verifier.
2377 ;;
2379 "Search between BEG and END for a style error with message text.
2380 Optional arguments BEG and END represent the boundary of the check.
2381 The default boundary is the entire buffer."
2388 e))
2391 "Move cursor to the next checkable message string after point.
2392 Return the message classification.
2393 Argument END is the maximum bounds to search in."
2412 nil
2414 return))
2417 "Return or fix errors found in strings passed to a message display function.
2418 According to the documentation for the function `error', the error list
2419 should not end with a period, and should start with a capital letter.
2420 The function `y-or-n-p' has similar constraints.
2421 Argument TYPE specifies the type of question, such as `error or `y-or-n-p."
2422 ;; If type is nil, then attempt to derive it.
2434 ;; From the documentation of the symbol `error':
2435 ;; In Emacs, the convention is that error messages start with a capital
2436 ;; letter but *do not* end with a period. Please follow this convention
2437 ;; for the sake of consistency.
2442 "Capitalize your message text? "
2444 t)))
2446 "Messages should start with a capital letter"
2448 nil)
2449 ;; In general, sentences should have two spaces after the period.
2453 ;; Look for proper nouns in this region too.
2457 ;; Here are message type specific questions.
2464 "Remove period from error? "
2465 ""
2466 t)))
2468 "Error messages should *not* end with a period"
2470 nil)
2471 ;; `y-or-n-p' documentation explicitly says:
2472 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it.
2473 ;; I added the ? requirement. Without it, it is unclear that we
2474 ;; ask a question and it appears to be an undocumented style.
2479 nil
2483 ;; If we see a ?, then replace with "? ".
2488 nil
2499 nil
2511 nil
2515 ;; Now, let's just run the spell checker on this guy.
2518 )))
2520 ;;; Auto-fix helper functions
2521 ;;
2523 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'.
2524 Argument QUESTION is the prompt passed to `y-or-n-p'."
2528 nil
2535 "Highlight between START and END and queries the user with QUESTION.
2536 If the user says yes, or if `checkdoc-autofix-flag' permits, replace
2537 the region marked by START and END with REPLACEWITH. If optional flag
2538 COMPLEX is non-nil, then we may ask the user a question. See the
2539 documentation for `checkdoc-autofix-flag' for details.
2541 If a section is auto-replaced without asking the user, this function
2542 will pause near the fixed code so the user will briefly see what
2543 happened.
2545 This function returns non-nil if the text was replaced.
2547 This function will not modify `match-data'."
2564 ;; On the off chance this is automatic, display
2565 ;; the question anyway so the user knows what's
2566 ;; going on.
2578 ret)))
2580 ;;; Warning management
2581 ;;
2597 nil
2606 "Create and setup the buffer used to maintain checkdoc warnings.
2623 ;; checkdoc-params: (e)
2624 "Call `checkdoc-find-error' where the user clicks the mouse."
2630 "In a checkdoc diagnostic buffer, find the error under point."
2642 "The name to use for a checkdoc buffer in the error list."
2648 "Initialize the checkdoc diagnostic buffer for a pass.
2649 Create the header so that the string CHECK-TYPE is displayed as the
2650 function called to create the messages."
2656 "Store POINT and MSG as errors in the checkdoc diagnostic buffer."
2661 msg))
2664 "Place TEXT into the checkdoc diagnostic buffer."
2671 "Display the checkdoc diagnostic buffer in a temporary window."
2682 nil)))
2685 "Support for doc string checking in Emacs Lisp."
2699 ;;; checkdoc.el ends here