Mercurial > emacs
annotate lisp/emacs-lisp/checkdoc.el @ 35097:bea6010c51b6
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 06 Jan 2001 18:55:45 +0000 |
parents | 07c7cb89c236 |
children | 0b99eb07fc17 |
rev | line source |
---|---|
20085 | 1 ;;; checkdoc --- Check documentation strings for style requirements |
2 | |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
3 ;;; Copyright (C) 1997, 1998 Free Software Foundation |
21181 | 4 |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
5 ;; Author: Eric M. Ludlam <zappo@gnu.org> |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
6 ;; Version: 0.6.2 |
20085 | 7 ;; Keywords: docs, maint, lisp |
21181 | 8 |
20085 | 9 ;; This file is part of GNU Emacs. |
21181 | 10 |
20085 | 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. | |
21181 | 15 |
20085 | 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. | |
21181 | 20 |
20085 | 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. | |
25 | |
26 ;;; Commentary: | |
27 ;; | |
22195 | 28 ;; The Emacs Lisp manual has a nice chapter on how to write |
20085 | 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: | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
35 ;; 1) Periodically use `checkdoc' or `checkdoc-current-buffer'. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
36 ;; `checkdoc' is a more interactive version of |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
37 ;; `checkdoc-current-buffer' |
20085 | 38 ;; 2) Use `checkdoc-minor-mode' to automatically check your |
22195 | 39 ;; documentation whenever you evaluate Lisp code with C-M-x |
20085 | 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 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
46 ;; Using `checkdoc': |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
47 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
48 ;; The commands `checkdoc' and `checkdoc-ispell' are the top-level |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
49 ;; entry points to all of the different checks that are available. It |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
50 ;; breaks examination of your Lisp file into four sections (comments, |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
51 ;; documentation, messages, and spacing) and indicates its current |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
52 ;; state in a status buffer. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
53 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
54 ;; The Comments check examines your headers, footers, and |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
55 ;; various tags (such as "Code:") to make sure that your code is ready |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
56 ;; for easy integration into existing systems. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
57 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
58 ;; The Documentation check deals with documentation strings |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
59 ;; and their elements that help make Emacs easier to use. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
60 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
61 ;; The Messages check ensures that the strings displayed in the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
62 ;; minibuffer by some commands (such as `error' and `y-or-n-p') |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
63 ;; are consistent with the Emacs environment. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
64 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
65 ;; The Spacing check cleans up white-space at the end of lines. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
66 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
67 ;; The interface while working with documentation and messages is |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
68 ;; slightly different when being run in the interactive mode. The |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
69 ;; interface offers several options, including the ability to skip to |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
70 ;; the next error, or back up to previous errors. Auto-fixing is |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
71 ;; turned off at this stage, but you can use the `f' or `F' key to fix |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
72 ;; a given error (if the fix is available.) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
73 ;; |
20085 | 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 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
89 ;; Spell checking text: |
20085 | 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. | |
22195 | 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 | |
20085 | 103 ;; running. Use `ispell-kill-ispell' to make checkdoc restart it with |
104 ;; these words enabled. | |
105 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
106 ;; Checking parameters: |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
107 ;; |
22514
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
108 ;; You might not always want a function to have its parameters listed |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
109 ;; in order. When this is the case, put the following comment just in |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
110 ;; front of the documentation string: "; checkdoc-order: nil" This |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
111 ;; overrides the value of `checkdoc-arguments-in-order-flag'. |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
112 ;; |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
113 ;; If you specifically wish to avoid mentioning a parameter of a |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
114 ;; function in the doc string (such as a hidden parameter, or a |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
115 ;; parameter which is very obvious like events), you can have checkdoc |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
116 ;; skip looking for it by putting the following comment just in front |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
117 ;; of the documentation string: "; checkdoc-params: (args go here)" |
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
118 ;; |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
119 ;; Checking message strings: |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
120 ;; |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
121 ;; The text that follows the `error' and `y-or-n-p' commands is |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
122 ;; also checked. The documentation for `error' clearly states some |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
123 ;; simple style rules to follow which checkdoc will auto-fix for you. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
124 ;; `y-or-n-p' also states that it should end in a space. I added that |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
125 ;; it should end in "? " since that is almost always used. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
126 ;; |
20085 | 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 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
134 ;; Error errors: |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
135 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
136 ;; Checkdoc does not always flag errors correctly. There are a |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
137 ;; couple ways you can coax your file into passing all of checkdoc's |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
138 ;; tests through buffer local variables. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
139 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
140 ;; The variable `checkdoc-verb-check-experimental-flag' can be used |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
141 ;; to turn off the check for verb-voice in case you use words that are |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
142 ;; not semantically verbs, but are still in the incomplete list. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
143 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
144 ;; The variable `checkdoc-symbol-words' can be a list of words that |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
145 ;; happen to also be symbols. This is not a problem for one-word |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
146 ;; symbols, but if you use a hyphenated word that is also a symbol, |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
147 ;; then you may need this. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
148 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
149 ;; The symbol `checkdoc-force-docstrings-flag' can be set to nil if |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
150 ;; you have many undocumented functions you don't wish to document. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
151 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
152 ;; See the above section "Checking Parameters" for details about |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
153 ;; parameter checking. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
154 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
155 ;; Dependencies: |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
156 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
157 ;; This file requires lisp-mnt (Lisp maintenance routines) for the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
158 ;; comment checkers. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
159 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
160 ;; Requires custom for Emacs v20. |
20085 | 161 |
162 ;;; TO DO: | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
163 ;; Hook into the byte compiler on a defun/defvar level to generate |
20085 | 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? | |
172 | |
173 ;;; Code: | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
174 (defvar checkdoc-version "0.6.1" |
20085 | 175 "Release version of checkdoc you are currently running.") |
176 | |
177 ;; From custom web page for compatibility between versions of custom: | |
178 (eval-and-compile | |
179 (condition-case () | |
180 (require 'custom) | |
181 (error nil)) | |
182 (if (and (featurep 'custom) (fboundp 'custom-declare-variable)) | |
183 nil ;; We've got what we needed | |
184 ;; We have the old custom-library, hack around it! | |
185 (defmacro defgroup (&rest args) | |
186 nil) | |
187 (defmacro custom-add-option (&rest args) | |
188 nil) | |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
189 (defmacro defcustom (var value doc &rest args) |
20085 | 190 (` (defvar (, var) (, value) (, doc)))))) |
191 | |
192 (defcustom checkdoc-autofix-flag 'semiautomatic | |
22195 | 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 | |
20085 | 196 made without asking unless the change is very-complex. If the value |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
197 is `semiautomatic' or any other value, then simple fixes are made |
20085 | 198 without asking, and complex changes are made by asking the user first. |
22195 | 199 The value `never' is the same as nil, never ask or change anything." |
20085 | 200 :group 'checkdoc |
201 :type '(choice (const automatic) | |
202 (const query) | |
22579
d0ad271c7774
(checkdoc-autofix-flag): Use `other'
Andreas Schwab <schwab@suse.de>
parents:
22514
diff
changeset
|
203 (const never) |
d0ad271c7774
(checkdoc-autofix-flag): Use `other'
Andreas Schwab <schwab@suse.de>
parents:
22514
diff
changeset
|
204 (other :tag "semiautomatic" semiautomatic))) |
20085 | 205 |
206 (defcustom checkdoc-bouncy-flag t | |
22195 | 207 "*Non-nil means to \"bounce\" to auto-fix locations. |
20085 | 208 Setting this to nil will silently make fixes that require no user |
209 interaction. See `checkdoc-autofix-flag' for auto-fixing details." | |
210 :group 'checkdoc | |
211 :type 'boolean) | |
212 | |
213 (defcustom checkdoc-force-docstrings-flag t | |
214 "*Non-nil means that all checkable definitions should have documentation. | |
215 Style guide dictates that interactive functions MUST have documentation, | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
216 and that it's good but not required practice to make non user visible items |
22195 | 217 have doc strings." |
20085 | 218 :group 'checkdoc |
219 :type 'boolean) | |
220 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
221 (defcustom checkdoc-force-history-flag t |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
222 "*Non-nil means that files should have a History section or ChangeLog file. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
223 This helps document the evolution of, and recent changes to, the package." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
224 :group 'checkdoc |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
225 :type 'boolean) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
226 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
227 (defcustom checkdoc-permit-comma-termination-flag nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
228 "*Non-nil means the first line of a docstring may end with a comma. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
229 Ordinarily, a full sentence is required. This may be misleading when |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
230 there is a substantial caveat to the one-line description -- the comma |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
231 should be used when the first part could stand alone as a sentence, but |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
232 it indicates that a modifying clause follows." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
233 :group 'checkdoc |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
234 :type 'boolean) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
235 |
20085 | 236 (defcustom checkdoc-spellcheck-documentation-flag nil |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
237 "*Non-nil means run Ispell on text based on value. |
22195 | 238 This is automatically set to nil if Ispell does not exist on your |
20085 | 239 system. Possible values are: |
240 | |
22195 | 241 nil - Don't spell-check during basic style checks. |
242 defun - Spell-check when style checking a single defun | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
243 buffer - Spell-check when style checking the whole buffer |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
244 interactive - Spell-check during any interactive check. |
22195 | 245 t - Always spell-check" |
20085 | 246 :group 'checkdoc |
247 :type '(choice (const nil) | |
248 (const defun) | |
249 (const buffer) | |
250 (const interactive) | |
251 (const t))) | |
252 | |
253 (defvar checkdoc-ispell-lisp-words | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
254 '("alist" "emacs" "etags" "iff" "keymap" "paren" "regexp" "sexp" "xemacs") |
22195 | 255 "List of words that are correct when spell-checking Lisp documentation.") |
20085 | 256 |
257 (defcustom checkdoc-max-keyref-before-warn 10 | |
22195 | 258 "*The number of \\ [command-to-keystroke] tokens allowed in a doc string. |
20085 | 259 Any more than this and a warning is generated suggesting that the construct |
260 \\ {keymap} be used instead." | |
261 :group 'checkdoc | |
262 :type 'integer) | |
263 | |
264 (defcustom checkdoc-arguments-in-order-flag t | |
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." | |
270 :group 'checkdoc | |
271 :type 'boolean) | |
272 | |
273 (defvar checkdoc-style-hooks nil | |
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. | |
277 | |
278 Each hook is called with two parameters, (DEFUNINFO ENDPOINT). | |
279 DEFUNINFO is the return value of `checkdoc-defun-info'. ENDPOINT is the | |
280 location of end of the documentation string.") | |
281 | |
282 (defvar checkdoc-comment-style-hooks nil | |
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 | |
285 problem discovered. This is useful for adding additional checks.") | |
286 | |
287 (defvar checkdoc-diagnostic-buffer "*Style Warnings*" | |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
288 "Name of warning message buffer.") |
20085 | 289 |
290 (defvar checkdoc-defun-regexp | |
291 "^(def\\(un\\|var\\|custom\\|macro\\|const\\|subst\\|advice\\)\ | |
292 \\s-+\\(\\(\\sw\\|\\s_\\)+\\)[ \t\n]+" | |
293 "Regular expression used to identify a defun. | |
294 A search leaves the cursor in front of the parameter list.") | |
295 | |
296 (defcustom checkdoc-verb-check-experimental-flag t | |
22195 | 297 "*Non-nil means to attempt to check the voice of the doc string. |
20085 | 298 This check keys off some words which are commonly misused. See the |
22195 | 299 variable `checkdoc-common-verbs-wrong-voice' if you wish to add your own." |
20085 | 300 :group 'checkdoc |
301 :type 'boolean) | |
302 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
303 (defvar checkdoc-generate-compile-warnings-flag nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
304 "Non-nil means generage warnings in a buffer for browsing. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
305 Do not set this by hand, use a function like `checkdoc-current-buffer' |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
306 with a universal argument.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
307 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
308 (defcustom checkdoc-symbol-words nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
309 "A list of symbols which also happen to make good words. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
310 These symbol-words are ignored when unquoted symbols are searched for. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
311 This should be set in an Emacs Lisp file's local variables." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
312 :group 'checkdoc |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
313 :type '(repeat (symbol :tag "Word"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
314 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
315 (defvar checkdoc-proper-noun-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
316 '("ispell" "xemacs" "emacs" "lisp") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
317 "List of words (not capitalized) which should be capitalized.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
318 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
319 (defvar checkdoc-proper-noun-regexp |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
320 (let ((expr "\\<\\(") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
321 (l checkdoc-proper-noun-list)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
322 (while l |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
323 (setq expr (concat expr (car l) (if (cdr l) "\\|" "")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
324 l (cdr l))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
325 (concat expr "\\)\\>")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
326 "Regular expression derived from `checkdoc-proper-noun-regexp'.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
327 |
20085 | 328 (defvar checkdoc-common-verbs-regexp nil |
329 "Regular expression derived from `checkdoc-common-verbs-regexp'.") | |
330 | |
331 (defvar checkdoc-common-verbs-wrong-voice | |
332 '(("adds" . "add") | |
333 ("allows" . "allow") | |
334 ("appends" . "append") | |
22514
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
335 ("applies" . "apply") |
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
336 ("arranges" . "arrange") |
20085 | 337 ("brings" . "bring") |
338 ("calls" . "call") | |
339 ("catches" . "catch") | |
340 ("changes" . "change") | |
341 ("checks" . "check") | |
342 ("contains" . "contain") | |
343 ("creates" . "create") | |
344 ("destroys" . "destroy") | |
345 ("disables" . "disable") | |
346 ("executes" . "execute") | |
22514
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
347 ("evals" . "evaluate") |
20085 | 348 ("evaluates" . "evaluate") |
349 ("finds" . "find") | |
350 ("forces" . "force") | |
351 ("gathers" . "gather") | |
352 ("generates" . "generate") | |
353 ("goes" . "go") | |
354 ("guesses" . "guess") | |
355 ("highlights" . "highlight") | |
356 ("holds" . "hold") | |
357 ("ignores" . "ignore") | |
358 ("indents" . "indent") | |
359 ("initializes" . "initialize") | |
360 ("inserts" . "insert") | |
361 ("installs" . "install") | |
362 ("investigates" . "investigate") | |
363 ("keeps" . "keep") | |
364 ("kills" . "kill") | |
365 ("leaves" . "leave") | |
366 ("lets" . "let") | |
367 ("loads" . "load") | |
368 ("looks" . "look") | |
369 ("makes" . "make") | |
370 ("marks" . "mark") | |
371 ("matches" . "match") | |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
372 ("moves" . "move") |
20085 | 373 ("notifies" . "notify") |
374 ("offers" . "offer") | |
375 ("parses" . "parse") | |
376 ("performs" . "perform") | |
377 ("prepares" . "prepare") | |
378 ("prepends" . "prepend") | |
379 ("reads" . "read") | |
380 ("raises" . "raise") | |
381 ("removes" . "remove") | |
382 ("replaces" . "replace") | |
383 ("resets" . "reset") | |
384 ("restores" . "restore") | |
385 ("returns" . "return") | |
386 ("runs" . "run") | |
387 ("saves" . "save") | |
388 ("says" . "say") | |
389 ("searches" . "search") | |
390 ("selects" . "select") | |
391 ("sets" . "set") | |
392 ("sex" . "s*x") | |
393 ("shows" . "show") | |
394 ("signifies" . "signify") | |
395 ("sorts" . "sort") | |
396 ("starts" . "start") | |
397 ("stores" . "store") | |
398 ("switches" . "switch") | |
399 ("tells" . "tell") | |
400 ("tests" . "test") | |
401 ("toggles" . "toggle") | |
22514
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
402 ("tries" . "try") |
20085 | 403 ("turns" . "turn") |
404 ("undoes" . "undo") | |
405 ("unloads" . "unload") | |
406 ("unmarks" . "unmark") | |
407 ("updates" . "update") | |
408 ("uses" . "use") | |
409 ("yanks" . "yank") | |
410 ) | |
411 "Alist of common words in the wrong voice and what should be used instead. | |
412 Set `checkdoc-verb-check-experimental-flag' to nil to avoid this costly | |
413 and experimental check. Do not modify this list without setting | |
414 the value of `checkdoc-common-verbs-regexp' to nil which cause it to | |
415 be re-created.") | |
416 | |
417 (defvar checkdoc-syntax-table nil | |
418 "Syntax table used by checkdoc in document strings.") | |
419 | |
420 (if checkdoc-syntax-table | |
421 nil | |
422 (setq checkdoc-syntax-table (copy-syntax-table emacs-lisp-mode-syntax-table)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
423 ;; When dealing with syntax in doc strings, make sure that - are encompassed |
20085 | 424 ;; in words so we can use cheap \\> to get the end of a symbol, not the |
425 ;; end of a word in a conglomerate. | |
426 (modify-syntax-entry ?- "w" checkdoc-syntax-table) | |
427 ) | |
428 | |
429 | |
430 ;;; Compatibility | |
431 ;; | |
432 (if (string-match "X[Ee]macs" emacs-version) | |
433 (progn | |
434 (defalias 'checkdoc-make-overlay 'make-extent) | |
435 (defalias 'checkdoc-overlay-put 'set-extent-property) | |
436 (defalias 'checkdoc-delete-overlay 'delete-extent) | |
437 (defalias 'checkdoc-overlay-start 'extent-start) | |
438 (defalias 'checkdoc-overlay-end 'extent-end) | |
439 (defalias 'checkdoc-mode-line-update 'redraw-modeline) | |
440 (defalias 'checkdoc-call-eval-buffer 'eval-buffer) | |
441 ) | |
442 (defalias 'checkdoc-make-overlay 'make-overlay) | |
443 (defalias 'checkdoc-overlay-put 'overlay-put) | |
444 (defalias 'checkdoc-delete-overlay 'delete-overlay) | |
445 (defalias 'checkdoc-overlay-start 'overlay-start) | |
446 (defalias 'checkdoc-overlay-end 'overlay-end) | |
447 (defalias 'checkdoc-mode-line-update 'force-mode-line-update) | |
448 (defalias 'checkdoc-call-eval-buffer 'eval-current-buffer) | |
449 ) | |
450 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
451 ;; Emacs 20 has this handy function. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
452 (if (not (fboundp 'princ-list)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
453 (defun princ-list (&rest args) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
454 "Call `princ' on ARGS." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
455 (mapcar 'princ args))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
456 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
457 ;; Emacs 20s have MULE characters which don't equate to numbers. |
20085 | 458 (if (fboundp 'char=) |
459 (defalias 'checkdoc-char= 'char=) | |
460 (defalias 'checkdoc-char= '=)) | |
461 | |
462 ;; Emacs 19.28 and earlier don't have the handy 'add-to-list function | |
463 (if (fboundp 'add-to-list) | |
464 | |
465 (defalias 'checkdoc-add-to-list 'add-to-list) | |
466 | |
467 (defun checkdoc-add-to-list (list-var element) | |
468 "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet." | |
469 (if (not (member element (symbol-value list-var))) | |
470 (set list-var (cons element (symbol-value list-var))))) | |
471 ) | |
472 | |
22195 | 473 ;; To be safe in new Emacsen, we want to read events, not characters |
20085 | 474 (if (fboundp 'read-event) |
475 (defalias 'checkdoc-read-event 'read-event) | |
476 (defalias 'checkdoc-read-event 'read-char)) | |
477 | |
478 ;;; User level commands | |
479 ;; | |
480 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
481 (defun checkdoc () |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
482 "Interactivly check the entire buffer for style errors. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
483 The current status of the ckeck will be displayed in a buffer which |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
484 the users will view as each check is completed." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
485 (interactive) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
486 (let ((status (list "Checking..." "-" "-" "-")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
487 (checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
488 (member checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
489 '(buffer interactive t))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
490 ;; if the user set autofix to never, then that breaks the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
491 ;; obviously requested asking implied by using this function. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
492 ;; Set it to paranoia level. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
493 (checkdoc-autofix-flag (if (or (not checkdoc-autofix-flag) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
494 (eq checkdoc-autofix-flag 'never)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
495 'query |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
496 checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
497 tmp) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
498 (checkdoc-display-status-buffer status) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
499 ;; check the comments |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
500 (if (not buffer-file-name) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
501 (setcar status "Not checked") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
502 (if (checkdoc-file-comments-engine) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
503 (setcar status "Errors") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
504 (setcar status "Ok"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
505 (setcar (cdr status) "Checking...") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
506 (checkdoc-display-status-buffer status) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
507 ;; Check the documentation |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
508 (setq tmp (checkdoc-interactive nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
509 (if tmp |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
510 (setcar (cdr status) (format "%d Errors" (length tmp))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
511 (setcar (cdr status) "Ok")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
512 (setcar (cdr (cdr status)) "Checking...") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
513 (checkdoc-display-status-buffer status) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
514 ;; Check the message text |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
515 (if (setq tmp (checkdoc-message-interactive nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
516 (setcar (cdr (cdr status)) (format "%d Errors" (length tmp))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
517 (setcar (cdr (cdr status)) "Ok")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
518 (setcar (cdr (cdr (cdr status))) "Checking...") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
519 (checkdoc-display-status-buffer status) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
520 ;; Rogue spacing |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
521 (if (condition-case nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
522 (checkdoc-rogue-spaces nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
523 (error t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
524 (setcar (cdr (cdr (cdr status))) "Errors") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
525 (setcar (cdr (cdr (cdr status))) "Ok")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
526 (checkdoc-display-status-buffer status))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
527 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
528 (defun checkdoc-display-status-buffer (check) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
529 "Display and update the status buffer for the current checkdoc mode. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
530 CHECK is a vector stating the current status of each test as an |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
531 element is the status of that level of teset." |
25697
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
532 (let (temp-buffer-setup-hook) |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
533 (with-output-to-temp-buffer " *Checkdoc Status*" |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
534 (princ-list |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
535 "Buffer comments and tags: " (nth 0 check) "\n" |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
536 "Documentation style: " (nth 1 check) "\n" |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
537 "Message/Query text style: " (nth 2 check) "\n" |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
538 "Unwanted Spaces: " (nth 3 check) |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
539 ))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
540 (shrink-window-if-larger-than-buffer |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
541 (get-buffer-window " *Checkdoc Status*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
542 (message nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
543 (sit-for 0)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
544 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
545 ;;;###autoload |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
546 (defun checkdoc-interactive (&optional start-here showstatus) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
547 "Interactively check the current buffer for doc string errors. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
548 Prefix argument START-HERE will start the checking from the current |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
549 point, otherwise the check starts at the beginning of the current |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
550 buffer. Allows navigation forward and backwards through document |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
551 errors. Does not check for comment or space warnings. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
552 Optional argument SHOWSTATUS indicates that we should update the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
553 checkdoc status window instead of the usual behavior." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
554 (interactive "P") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
555 (let ((checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
556 (member checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
557 '(interactive t)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
558 (checkdoc-interactive-loop start-here showstatus 'checkdoc-next-error))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
559 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
560 ;;;###autoload |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
561 (defun checkdoc-message-interactive (&optional start-here showstatus) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
562 "Interactively check the current buffer for message string errors. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
563 Prefix argument START-HERE will start the checking from the current |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
564 point, otherwise the check starts at the beginning of the current |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
565 buffer. Allows navigation forward and backwards through document |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
566 errors. Does not check for comment or space warnings. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
567 Optional argument SHOWSTATUS indicates that we should update the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
568 checkdoc status window instead of the usual behavior." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
569 (interactive "P") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
570 (let ((checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
571 (member checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
572 '(interactive t)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
573 (checkdoc-interactive-loop start-here showstatus |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
574 'checkdoc-next-message-error))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
575 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
576 (defun checkdoc-interactive-loop (start-here showstatus findfunc) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
577 "Interactivly loop over all errors that can be found by a given method. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
578 Searching starts at START-HERE. SHOWSTATUS expresses the verbosity |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
579 of the search, and wether ending the search will auto-exit this function. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
580 FINDFUNC is a symbol representing a function that will position the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
581 cursor, and return error message text to present the the user. It is |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
582 assumed that the cursor will stop just before a major sexp, which will |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
583 be highlighted to present the user with feedback as to the offending |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
584 style." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
585 ;; Determine where to start the test |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
586 (let* ((begin (prog1 (point) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
587 (if (not start-here) (goto-char (point-min))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
588 ;; Assign a flag to spellcheck flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
589 (checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
590 (member checkdoc-spellcheck-documentation-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
591 '(buffer interactive t))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
592 ;; Fetch the error list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
593 (err-list (list (funcall findfunc nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
594 (cdo nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
595 (returnme nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
596 c) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
597 (save-window-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
598 (if (not (car err-list)) (setq err-list nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
599 ;; Include whatever function point is in for good measure. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
600 (beginning-of-defun) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
601 (while err-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
602 (goto-char (cdr (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
603 ;; The cursor should be just in front of the offending doc string |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
604 (if (stringp (car (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
605 (setq cdo (save-excursion (checkdoc-make-overlay |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
606 (point) (progn (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
607 (point))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
608 (setq cdo (checkdoc-make-overlay |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
609 (checkdoc-error-start (car (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
610 (checkdoc-error-end (car (car err-list)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
611 (unwind-protect |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
612 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
613 (checkdoc-overlay-put cdo 'face 'highlight) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
614 ;; Make sure the whole doc string is visible if possible. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
615 (sit-for 0) |
27444
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
616 (if (and (looking-at "\"") |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
617 (not (pos-visible-in-window-p |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
618 (save-excursion (forward-sexp 1) (point)) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
619 (selected-window)))) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
620 (let ((l (count-lines (point) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
621 (save-excursion |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
622 (forward-sexp 1) (point))))) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
623 (if (> l (window-height)) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
624 (recenter 1) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
625 (recenter (/ (- (window-height) l) 2)))) |
89c53b25be12
(checkdoc-interactive-loop): Don't lose on a function with an empty
Dave Love <fx@gnu.org>
parents:
26615
diff
changeset
|
626 (recenter)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
627 (message "%s (C-h,%se,n,p,q)" (checkdoc-error-text |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
628 (car (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
629 (if (checkdoc-error-unfixable (car (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
630 "" "f,")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
631 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
632 (goto-char (checkdoc-error-start (car (car err-list)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
633 (if (not (pos-visible-in-window-p)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
634 (recenter (- (window-height) 2))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
635 (setq c (checkdoc-read-event)))1 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
636 (if (not (integerp c)) (setq c ??)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
637 (cond |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
638 ;; Exit condition |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
639 ((checkdoc-char= c ?\C-g) (signal 'quit nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
640 ;; Request an auto-fix |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
641 ((or (checkdoc-char= c ?y) (checkdoc-char= c ?f)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
642 (checkdoc-delete-overlay cdo) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
643 (setq cdo nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
644 (goto-char (cdr (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
645 ;; `automatic-then-never' tells the autofix function |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
646 ;; to only allow one fix to be automatic. The autofix |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
647 ;; function will than set the flag to 'never, allowing |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
648 ;; the checker to return a different error. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
649 (let ((checkdoc-autofix-flag 'automatic-then-never) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
650 (fixed nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
651 (funcall findfunc t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
652 (setq fixed (not (eq checkdoc-autofix-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
653 'automatic-then-never))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
654 (if (not fixed) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
655 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
656 (message "A Fix was not available.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
657 (sit-for 2)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
658 (setq err-list (cdr err-list)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
659 (beginning-of-defun) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
660 (let ((pe (car err-list)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
661 (ne (funcall findfunc nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
662 (if ne |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
663 (setq err-list (cons ne err-list)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
664 (cond ((not err-list) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
665 (message "No More Stylistic Errors.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
666 (sit-for 2)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
667 (t |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
668 (message |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
669 "No Additional style errors. Continuing...") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
670 (sit-for 2)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
671 ;; Move to the next error (if available) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
672 ((or (checkdoc-char= c ?n) (checkdoc-char= c ?\ )) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
673 (let ((ne (funcall findfunc nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
674 (if (not ne) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
675 (if showstatus |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
676 (setq returnme err-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
677 err-list nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
678 (if (not err-list) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
679 (message "No More Stylistic Errors.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
680 (message "No Additional style errors. Continuing...")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
681 (sit-for 2)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
682 (setq err-list (cons ne err-list))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
683 ;; Go backwards in the list of errors |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
684 ((or (checkdoc-char= c ?p) (checkdoc-char= c ?\C-?)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
685 (if (/= (length err-list) 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
686 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
687 (setq err-list (cdr err-list)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
688 (goto-char (cdr (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
689 (beginning-of-defun)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
690 (message "No Previous Errors.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
691 (sit-for 2))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
692 ;; Edit the buffer recursively. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
693 ((checkdoc-char= c ?e) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
694 (checkdoc-recursive-edit |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
695 (checkdoc-error-text (car (car err-list)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
696 (checkdoc-delete-overlay cdo) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
697 (setq err-list (cdr err-list)) ;back up the error found. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
698 (beginning-of-defun) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
699 (let ((ne (funcall findfunc nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
700 (if (not ne) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
701 (if showstatus |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
702 (setq returnme err-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
703 err-list nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
704 (message "No More Stylistic Errors.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
705 (sit-for 2)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
706 (setq err-list (cons ne err-list))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
707 ;; Quit checkdoc |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
708 ((checkdoc-char= c ?q) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
709 (setq returnme err-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
710 err-list nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
711 begin (point))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
712 ;; Goofy s tuff |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
713 (t |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
714 (if (get-buffer-window "*Checkdoc Help*") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
715 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
716 (delete-window (get-buffer-window "*Checkdoc Help*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
717 (kill-buffer "*Checkdoc Help*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
718 (with-output-to-temp-buffer "*Checkdoc Help*" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
719 (princ-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
720 "Checkdoc Keyboard Summary:\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
721 (if (checkdoc-error-unfixable (car (car err-list))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
722 "" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
723 (concat |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
724 "f, y - auto Fix this warning without asking (if\ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
725 available.)\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
726 " Very complex operations will still query.\n") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
727 ) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
728 "e - Enter recursive Edit. Press C-M-c to exit.\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
729 "SPC, n - skip to the Next error.\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
730 "DEL, p - skip to the Previous error.\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
731 "q - Quit checkdoc.\n" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
732 "C-h - Toggle this help buffer.")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
733 (shrink-window-if-larger-than-buffer |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
734 (get-buffer-window "*Checkdoc Help*")))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
735 (if cdo (checkdoc-delete-overlay cdo))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
736 (goto-char begin) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
737 (if (get-buffer "*Checkdoc Help*") (kill-buffer "*Checkdoc Help*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
738 (message "Checkdoc: Done.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
739 returnme)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
740 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
741 (defun checkdoc-next-error (enable-fix) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
742 "Find and return the next checkdoc error list, or nil. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
743 Only documentation strings are checked. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
744 Add error vector is of the form (WARNING . POSITION) where WARNING |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
745 is the warning text, and POSITION is the point in the buffer where the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
746 error was found. We can use points and not markers because we promise |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
747 not to edit the buffer before point without re-executing this check. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
748 Argument ENABLE-FIX will enable auto-fixing while looking for the next |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
749 error. This argument assumes that the cursor is already positioned to |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
750 perform the fix." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
751 (if enable-fix |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
752 (checkdoc-this-string-valid) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
753 (let ((msg nil) (p (point)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
754 (checkdoc-autofix-flag nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
755 (condition-case nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
756 (while (and (not msg) (checkdoc-next-docstring)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
757 (message "Searching for doc string error...%d%%" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
758 (/ (* 100 (point)) (point-max))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
759 (if (setq msg (checkdoc-this-string-valid)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
760 (setq msg (cons msg (point))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
761 ;; Quit.. restore position, Other errors, leave alone |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
762 (quit (goto-char p))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
763 msg))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
764 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
765 (defun checkdoc-next-message-error (enable-fix) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
766 "Find and return the next checkdoc mesasge related error list, or nil. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
767 Only text for error and `y-or-n-p' strings are checked. See |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
768 `checkdoc-next-error' for details on the return value. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
769 Argument ENABLE-FIX turns on the auto-fix feature. This argument |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
770 assumes that the cursor is already positioned to perform the fix." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
771 (if enable-fix |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
772 (checkdoc-message-text-engine) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
773 (let ((msg nil) (p (point)) (type nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
774 (checkdoc-autofix-flag nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
775 (condition-case nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
776 (while (and (not msg) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
777 (setq type |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
778 (checkdoc-message-text-next-string (point-max)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
779 (message "Searching for message string error...%d%%" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
780 (/ (* 100 (point)) (point-max))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
781 (if (setq msg (checkdoc-message-text-engine type)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
782 (setq msg (cons msg (point))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
783 ;; Quit.. restore position, Other errors, leave alone |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
784 (quit (goto-char p))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
785 msg))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
786 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
787 (defun checkdoc-recursive-edit (msg) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
788 "Enter recursive edit to permit a user to fix some error checkdoc has found. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
789 MSG is the error that was found, which is displayed in a help buffer." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
790 (with-output-to-temp-buffer "*Checkdoc Help*" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
791 (princ-list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
792 "Error message:\n " msg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
793 "\n\nEdit to fix this problem, and press C-M-c to continue.")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
794 (shrink-window-if-larger-than-buffer |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
795 (get-buffer-window "*Checkdoc Help*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
796 (message "When you're done editing press C-M-c to continue.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
797 (unwind-protect |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
798 (recursive-edit) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
799 (if (get-buffer-window "*Checkdoc Help*") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
800 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
801 (delete-window (get-buffer-window "*Checkdoc Help*")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
802 (kill-buffer "*Checkdoc Help*"))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
803 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
804 ;;;###autoload |
20085 | 805 (defun checkdoc-eval-current-buffer () |
806 "Evaluate and check documentation for the current buffer. | |
807 Evaluation is done first because good documentation for something that | |
22195 | 808 doesn't work is just not useful. Comments, doc strings, and rogue |
20085 | 809 spacing are all verified." |
810 (interactive) | |
811 (checkdoc-call-eval-buffer nil) | |
812 (checkdoc-current-buffer t)) | |
813 | |
814 ;;;###autoload | |
815 (defun checkdoc-current-buffer (&optional take-notes) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
816 "Check current buffer for document, comment, error style, and rogue spaces. |
22195 | 817 With a prefix argument (in Lisp, the argument TAKE-NOTES), |
818 store all errors found in a warnings buffer, | |
819 otherwise stop after the first error." | |
20085 | 820 (interactive "P") |
821 (if (interactive-p) (message "Checking buffer for style...")) | |
822 ;; Assign a flag to spellcheck flag | |
823 (let ((checkdoc-spellcheck-documentation-flag | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
824 (memq checkdoc-spellcheck-documentation-flag '(buffer t))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
825 (checkdoc-autofix-flag (if take-notes 'never |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
826 checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
827 (checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
828 (or take-notes checkdoc-generate-compile-warnings-flag))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
829 (if take-notes |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
830 (checkdoc-start-section "checkdoc-current-buffer")) |
20085 | 831 ;; every test is responsible for returning the cursor. |
832 (or (and buffer-file-name ;; only check comments in a file | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
833 (checkdoc-comments)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
834 (checkdoc-start) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
835 (checkdoc-message-text) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
836 (checkdoc-rogue-spaces) |
20085 | 837 (not (interactive-p)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
838 (if take-notes (checkdoc-show-diagnostics)) |
20085 | 839 (message "Checking buffer for style...Done.")))) |
840 | |
841 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
842 (defun checkdoc-start (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
843 "Start scanning the current buffer for documentation string style errors. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
844 Only documentation strings are checked. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
845 Use `checkdoc-continue' to continue checking if an error cannot be fixed. |
20085 | 846 Prefix argument TAKE-NOTES means to collect all the warning messages into |
847 a separate buffer." | |
848 (interactive "P") | |
849 (let ((p (point))) | |
850 (goto-char (point-min)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
851 (if (and take-notes (interactive-p)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
852 (checkdoc-start-section "checkdoc-start")) |
20085 | 853 (checkdoc-continue take-notes) |
854 ;; Go back since we can't be here without success above. | |
855 (goto-char p) | |
856 nil)) | |
857 | |
858 ;;;###autoload | |
859 (defun checkdoc-continue (&optional take-notes) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
860 "Find the next doc string in the current buffer which has a style error. |
20085 | 861 Prefix argument TAKE-NOTES means to continue through the whole buffer and |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
862 save warnings in a separate buffer. Second optional argument START-POINT |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
863 is the starting location. If this is nil, `point-min' is used instead." |
20085 | 864 (interactive "P") |
865 (let ((wrong nil) (msg nil) (errors nil) | |
866 ;; Assign a flag to spellcheck flag | |
867 (checkdoc-spellcheck-documentation-flag | |
868 (member checkdoc-spellcheck-documentation-flag | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
869 '(buffer t))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
870 (checkdoc-autofix-flag (if take-notes 'never |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
871 checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
872 (checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
873 (or take-notes checkdoc-generate-compile-warnings-flag))) |
20085 | 874 (save-excursion |
875 ;; If we are taking notes, encompass the whole buffer, otherwise | |
876 ;; the user is navigating down through the buffer. | |
877 (while (and (not wrong) (checkdoc-next-docstring)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
878 ;; OK, let's look at the doc string. |
21181 | 879 (setq msg (checkdoc-this-string-valid)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
880 (if msg (setq wrong (point))))) |
20085 | 881 (if wrong |
882 (progn | |
883 (goto-char wrong) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
884 (if (not take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
885 (error (checkdoc-error-text msg))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
886 (checkdoc-show-diagnostics) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
887 (if (interactive-p) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
888 (message "No style warnings.")))) |
20085 | 889 |
890 (defun checkdoc-next-docstring () | |
22195 | 891 "Move to the next doc string after point, and return t. |
892 Return nil if there are no more doc strings." | |
20085 | 893 (if (not (re-search-forward checkdoc-defun-regexp nil t)) |
894 nil | |
895 ;; search drops us after the identifier. The next sexp is either | |
896 ;; the argument list or the value of the variable. skip it. | |
897 (forward-sexp 1) | |
898 (skip-chars-forward " \n\t") | |
899 t)) | |
900 | |
901 ;;; ###autoload | |
902 (defun checkdoc-comments (&optional take-notes) | |
22195 | 903 "Find missing comment sections in the current Emacs Lisp file. |
20085 | 904 Prefix argument TAKE-NOTES non-nil means to save warnings in a |
905 separate buffer. Otherwise print a message. This returns the error | |
906 if there is one." | |
907 (interactive "P") | |
908 (if take-notes (checkdoc-start-section "checkdoc-comments")) | |
909 (if (not buffer-file-name) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
910 (error "Can only check comments for a file buffer")) |
20085 | 911 (let* ((checkdoc-spellcheck-documentation-flag |
912 (member checkdoc-spellcheck-documentation-flag | |
913 '(buffer t))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
914 (checkdoc-autofix-flag (if take-notes 'never checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
915 (e (checkdoc-file-comments-engine)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
916 (checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
917 (or take-notes checkdoc-generate-compile-warnings-flag))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
918 (if e (error (checkdoc-error-text e))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
919 (checkdoc-show-diagnostics) |
20085 | 920 e)) |
921 | |
922 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
923 (defun checkdoc-rogue-spaces (&optional take-notes interact) |
20085 | 924 "Find extra spaces at the end of lines in the current file. |
925 Prefix argument TAKE-NOTES non-nil means to save warnings in a | |
926 separate buffer. Otherwise print a message. This returns the error | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
927 if there is one. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
928 Optional argument INTERACT permits more interactive fixing." |
20085 | 929 (interactive "P") |
930 (if take-notes (checkdoc-start-section "checkdoc-rogue-spaces")) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
931 (let* ((checkdoc-autofix-flag (if take-notes 'never checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
932 (e (checkdoc-rogue-space-check-engine nil nil interact)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
933 (checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
934 (or take-notes checkdoc-generate-compile-warnings-flag))) |
20085 | 935 (if (not (interactive-p)) |
936 e | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
937 (if e |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
938 (message (checkdoc-error-text e)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
939 (checkdoc-show-diagnostics) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
940 (message "Space Check: done."))))) |
20085 | 941 |
942 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
943 (defun checkdoc-message-text (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
944 "Scan the buffer for occurrences of the error function, and verify text. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
945 Optional argument TAKE-NOTES causes all errors to be logged." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
946 (interactive "P") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
947 (if take-notes (checkdoc-start-section "checkdoc-message-text")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
948 (let* ((p (point)) e |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
949 (checkdoc-autofix-flag (if take-notes 'never checkdoc-autofix-flag)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
950 (checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
951 (or take-notes checkdoc-generate-compile-warnings-flag))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
952 (setq e (checkdoc-message-text-search)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
953 (if (not (interactive-p)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
954 e |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
955 (if e |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
956 (error (checkdoc-error-text e)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
957 (checkdoc-show-diagnostics))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
958 (goto-char p)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
959 (if (interactive-p) (message "Checking interactive message text...done."))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
960 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
961 ;;;###autoload |
20085 | 962 (defun checkdoc-eval-defun () |
22514
dee11277c07d
(checkdoc-eval-defun): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
22195
diff
changeset
|
963 "Evaluate the current form with `eval-defun' and check its documentation. |
20085 | 964 Evaluation is done first so the form will be read before the |
965 documentation is checked. If there is a documentation error, then the display | |
966 of what was evaluated will be overwritten by the diagnostic message." | |
967 (interactive) | |
968 (eval-defun nil) | |
969 (checkdoc-defun)) | |
970 | |
971 ;;;###autoload | |
972 (defun checkdoc-defun (&optional no-error) | |
22195 | 973 "Examine the doc string of the function or variable under point. |
974 Call `error' if the doc string has problems. If NO-ERROR is | |
20085 | 975 non-nil, then do not call error, but call `message' instead. |
22195 | 976 If the doc string passes the test, then check the function for rogue white |
20085 | 977 space at the end of each line." |
978 (interactive) | |
979 (save-excursion | |
980 (beginning-of-defun) | |
981 (if (not (looking-at checkdoc-defun-regexp)) | |
982 ;; I found this more annoying than useful. | |
983 ;;(if (not no-error) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
984 ;; (message "Cannot check this sexp's doc string.")) |
20085 | 985 nil |
986 ;; search drops us after the identifier. The next sexp is either | |
987 ;; the argument list or the value of the variable. skip it. | |
988 (goto-char (match-end 0)) | |
989 (forward-sexp 1) | |
990 (skip-chars-forward " \n\t") | |
991 (let* ((checkdoc-spellcheck-documentation-flag | |
992 (member checkdoc-spellcheck-documentation-flag | |
993 '(defun t))) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
994 (beg (save-excursion (beginning-of-defun) (point))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
995 (end (save-excursion (end-of-defun) (point))) |
20085 | 996 (msg (checkdoc-this-string-valid))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
997 (if msg (if no-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
998 (message (checkdoc-error-text msg)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
999 (error (checkdoc-error-text msg))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1000 (setq msg (checkdoc-message-text-search beg end)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1001 (if msg (if no-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1002 (message (checkdoc-error-text msg)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1003 (error (checkdoc-error-text msg))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1004 (setq msg (checkdoc-rogue-space-check-engine beg end)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1005 (if msg (if no-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1006 (message (checkdoc-error-text msg)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1007 (error (checkdoc-error-text msg)))))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1008 (if (interactive-p) (message "Checkdoc: done.")))))) |
20085 | 1009 |
1010 ;;; Ispell interface for forcing a spell check | |
1011 ;; | |
1012 | |
1013 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1014 (defun checkdoc-ispell (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1015 "Check the style and spelling of everything interactively. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1016 Calls `checkdoc' with spell-checking turned on. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1017 Prefix argument TAKE-NOTES is the same as for `checkdoc'" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1018 (interactive) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1019 (let ((checkdoc-spellcheck-documentation-flag t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1020 (call-interactively 'checkdoc nil current-prefix-arg))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1021 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1022 ;;;###autoload |
20085 | 1023 (defun checkdoc-ispell-current-buffer (&optional take-notes) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1024 "Check the style and spelling of the current buffer. |
20085 | 1025 Calls `checkdoc-current-buffer' with spell-checking turned on. |
1026 Prefix argument TAKE-NOTES is the same as for `checkdoc-current-buffer'" | |
1027 (interactive) | |
1028 (let ((checkdoc-spellcheck-documentation-flag t)) | |
1029 (call-interactively 'checkdoc-current-buffer nil current-prefix-arg))) | |
1030 | |
1031 ;;;###autoload | |
1032 (defun checkdoc-ispell-interactive (&optional take-notes) | |
1033 "Check the style and spelling of the current buffer interactively. | |
1034 Calls `checkdoc-interactive' with spell-checking turned on. | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1035 Prefix argument TAKE-NOTES is the same as for `checkdoc-interactive'" |
20085 | 1036 (interactive) |
1037 (let ((checkdoc-spellcheck-documentation-flag t)) | |
1038 (call-interactively 'checkdoc-interactive nil current-prefix-arg))) | |
1039 | |
1040 ;;;###autoload | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1041 (defun checkdoc-ispell-message-interactive (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1042 "Check the style and spelling of message text interactively. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1043 Calls `checkdoc-message-interactive' with spell-checking turned on. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1044 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-interactive'" |
20085 | 1045 (interactive) |
1046 (let ((checkdoc-spellcheck-documentation-flag t)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1047 (call-interactively 'checkdoc-message-interactive nil current-prefix-arg))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1048 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1049 ;;;###autoload |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1050 (defun checkdoc-ispell-message-text (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1051 "Check the style and spelling of message text interactively. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1052 Calls `checkdoc-message-text' with spell-checking turned on. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1053 Prefix argument TAKE-NOTES is the same as for `checkdoc-message-text'" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1054 (interactive) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1055 (let ((checkdoc-spellcheck-documentation-flag t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1056 (call-interactively 'checkdoc-message-text nil current-prefix-arg))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1057 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1058 ;;;###autoload |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1059 (defun checkdoc-ispell-start (&optional take-notes) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1060 "Check the style and spelling of the current buffer. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1061 Calls `checkdoc-start' with spell-checking turned on. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1062 Prefix argument TAKE-NOTES is the same as for `checkdoc-start'" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1063 (interactive) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1064 (let ((checkdoc-spellcheck-documentation-flag t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1065 (call-interactively 'checkdoc-start nil current-prefix-arg))) |
20085 | 1066 |
1067 ;;;###autoload | |
1068 (defun checkdoc-ispell-continue (&optional take-notes) | |
1069 "Check the style and spelling of the current buffer after point. | |
1070 Calls `checkdoc-continue' with spell-checking turned on. | |
1071 Prefix argument TAKE-NOTES is the same as for `checkdoc-continue'" | |
1072 (interactive) | |
1073 (let ((checkdoc-spellcheck-documentation-flag t)) | |
1074 (call-interactively 'checkdoc-continue nil current-prefix-arg))) | |
1075 | |
1076 ;;;###autoload | |
1077 (defun checkdoc-ispell-comments (&optional take-notes) | |
1078 "Check the style and spelling of the current buffer's comments. | |
1079 Calls `checkdoc-comments' with spell-checking turned on. | |
1080 Prefix argument TAKE-NOTES is the same as for `checkdoc-comments'" | |
1081 (interactive) | |
1082 (let ((checkdoc-spellcheck-documentation-flag t)) | |
1083 (call-interactively 'checkdoc-comments nil current-prefix-arg))) | |
1084 | |
1085 ;;;###autoload | |
1086 (defun checkdoc-ispell-defun (&optional take-notes) | |
22195 | 1087 "Check the style and spelling of the current defun with Ispell. |
20085 | 1088 Calls `checkdoc-defun' with spell-checking turned on. |
1089 Prefix argument TAKE-NOTES is the same as for `checkdoc-defun'" | |
1090 (interactive) | |
1091 (let ((checkdoc-spellcheck-documentation-flag t)) | |
1092 (call-interactively 'checkdoc-defun nil current-prefix-arg))) | |
1093 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1094 ;;; Error Management |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1095 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1096 ;; Errors returned from checkdoc functions can have various |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1097 ;; features and behaviors, so we need some ways of specifying |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1098 ;; them, and making them easier to use in the wacked-out interfaces |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1099 ;; people are requesting |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1100 (defun checkdoc-create-error (text start end &optional unfixable) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1101 "Used to create the return error text returned from all engines. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1102 TEXT is the descriptive text of the error. START and END define the region |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1103 it is sensible to highlight when describing the problem. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1104 Optional argument UNFIXABLE means that the error has no auto-fix available. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1105 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1106 A list of the form (TEXT START END UNFIXABLE) is returned if we are not |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1107 generating a buffered list of errors." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1108 (if checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1109 (progn (checkdoc-error start text) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1110 nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1111 (list text start end unfixable))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1112 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1113 (defun checkdoc-error-text (err) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1114 "Return the text specified in the checkdoc ERR." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1115 ;; string-p part is for backwards compatibility |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1116 (if (stringp err) err (car err))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1117 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1118 (defun checkdoc-error-start (err) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1119 "Return the start point specified in the checkdoc ERR." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1120 ;; string-p part is for backwards compatibility |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1121 (if (stringp err) nil (nth 1 err))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1122 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1123 (defun checkdoc-error-end (err) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1124 "Return the end point specified in the checkdoc ERR." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1125 ;; string-p part is for backwards compatibility |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1126 (if (stringp err) nil (nth 2 err))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1127 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1128 (defun checkdoc-error-unfixable (err) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1129 "Return the t if we cannot autofix the error specified in the checkdoc ERR." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1130 ;; string-p part is for backwards compatibility |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1131 (if (stringp err) nil (nth 3 err))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1132 |
20085 | 1133 ;;; Minor Mode specification |
1134 ;; | |
1135 | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1136 (defvar checkdoc-minor-mode-map |
20085 | 1137 (let ((map (make-sparse-keymap)) |
1138 (pmap (make-sparse-keymap))) | |
1139 ;; Override some bindings | |
1140 (define-key map "\C-\M-x" 'checkdoc-eval-defun) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1141 (define-key map "\C-x`" 'checkdoc-continue) |
20085 | 1142 (if (not (string-match "XEmacs" emacs-version)) |
1143 (define-key map [menu-bar emacs-lisp eval-buffer] | |
1144 'checkdoc-eval-current-buffer)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1145 ;; Add some new bindings under C-c ? |
20085 | 1146 (define-key pmap "x" 'checkdoc-defun) |
1147 (define-key pmap "X" 'checkdoc-ispell-defun) | |
1148 (define-key pmap "`" 'checkdoc-continue) | |
1149 (define-key pmap "~" 'checkdoc-ispell-continue) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1150 (define-key pmap "s" 'checkdoc-start) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1151 (define-key pmap "S" 'checkdoc-ispell-start) |
20085 | 1152 (define-key pmap "d" 'checkdoc) |
1153 (define-key pmap "D" 'checkdoc-ispell) | |
1154 (define-key pmap "b" 'checkdoc-current-buffer) | |
1155 (define-key pmap "B" 'checkdoc-ispell-current-buffer) | |
1156 (define-key pmap "e" 'checkdoc-eval-current-buffer) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1157 (define-key pmap "m" 'checkdoc-message-text) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1158 (define-key pmap "M" 'checkdoc-ispell-message-text) |
20085 | 1159 (define-key pmap "c" 'checkdoc-comments) |
1160 (define-key pmap "C" 'checkdoc-ispell-comments) | |
1161 (define-key pmap " " 'checkdoc-rogue-spaces) | |
1162 | |
1163 ;; bind our submap into map | |
1164 (define-key map "\C-c?" pmap) | |
1165 map) | |
1166 "Keymap used to override evaluation key-bindings for documentation checking.") | |
1167 | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1168 (defvar checkdoc-minor-keymap checkdoc-minor-mode-map |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1169 "Obsolete! Use `checkdoc-minor-mode-map'.") |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1170 |
20085 | 1171 ;; Add in a menubar with easy-menu |
1172 | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1173 (easy-menu-define |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1174 checkdoc-minor-menu checkdoc-minor-mode-map "Checkdoc Minor Mode Menu" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1175 '("CheckDoc" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1176 ["Interactive Buffer Style Check" checkdoc t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1177 ["Interactive Buffer Style and Spelling Check" checkdoc-ispell t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1178 ["Check Buffer" checkdoc-current-buffer t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1179 ["Check and Spell Buffer" checkdoc-ispell-current-buffer t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1180 "---" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1181 ["Interactive Style Check" checkdoc-interactive t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1182 ["Interactive Style and Spelling Check" checkdoc-ispell-interactive t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1183 ["Find First Style Error" checkdoc-start t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1184 ["Find First Style or Spelling Error" checkdoc-ispell-start t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1185 ["Next Style Error" checkdoc-continue t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1186 ["Next Style or Spelling Error" checkdoc-ispell-continue t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1187 ["Interactive Message Text Style Check" checkdoc-message-interactive t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1188 ["Interactive Message Text Style and Spelling Check" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1189 checkdoc-ispell-message-interactive t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1190 ["Check Message Text" checkdoc-message-text t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1191 ["Check and Spell Message Text" checkdoc-ispell-message-text t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1192 ["Check Comment Style" checkdoc-comments buffer-file-name] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1193 ["Check Comment Style and Spelling" checkdoc-ispell-comments |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1194 buffer-file-name] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1195 ["Check for Rogue Spaces" checkdoc-rogue-spaces t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1196 "---" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1197 ["Check Defun" checkdoc-defun t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1198 ["Check and Spell Defun" checkdoc-ispell-defun t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1199 ["Check and Evaluate Defun" checkdoc-eval-defun t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1200 ["Check and Evaluate Buffer" checkdoc-eval-current-buffer t] |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1201 )) |
20085 | 1202 ;; XEmacs requires some weird stuff to add this menu in a minor mode. |
1203 ;; What is it? | |
1204 | |
1205 ;;;###autoload | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1206 (easy-mmode-define-minor-mode checkdoc-minor-mode |
22195 | 1207 "Toggle Checkdoc minor mode, a mode for checking Lisp doc strings. |
1208 With prefix ARG, turn Checkdoc minor mode on iff ARG is positive. | |
20085 | 1209 |
22195 | 1210 In Checkdoc minor mode, the usual bindings for `eval-defun' which is |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1211 bound to \\<checkdoc-minor-mode-map> \\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include |
20085 | 1212 checking of documentation strings. |
1213 | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1214 \\{checkdoc-minor-mode-map}" |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1215 nil " CDoc" nil) |
20085 | 1216 |
1217 ;;; Subst utils | |
1218 ;; | |
1219 (defsubst checkdoc-run-hooks (hookvar &rest args) | |
1220 "Run hooks in HOOKVAR with ARGS." | |
1221 (if (fboundp 'run-hook-with-args-until-success) | |
1222 (apply 'run-hook-with-args-until-success hookvar args) | |
1223 ;; This method was similar to above. We ignore the warning | |
22195 | 1224 ;; since we will use the above for future Emacs versions |
20085 | 1225 (apply 'run-hook-with-args hookvar args))) |
1226 | |
1227 (defsubst checkdoc-create-common-verbs-regexp () | |
1228 "Rebuild the contents of `checkdoc-common-verbs-regexp'." | |
1229 (or checkdoc-common-verbs-regexp | |
1230 (setq checkdoc-common-verbs-regexp | |
1231 (concat "\\<\\(" | |
1232 (mapconcat (lambda (e) (concat (car e))) | |
1233 checkdoc-common-verbs-wrong-voice "\\|") | |
1234 "\\)\\>")))) | |
1235 | |
1236 ;; Profiler says this is not yet faster than just calling assoc | |
1237 ;;(defun checkdoc-word-in-alist-vector (word vector) | |
1238 ;; "Check to see if WORD is in the car of an element of VECTOR. | |
1239 ;;VECTOR must be sorted. The CDR should be a replacement. Since the | |
1240 ;;word list is getting bigger, it is time for a quick bisecting search." | |
1241 ;; (let ((max (length vector)) (min 0) i | |
1242 ;; (found nil) (fw nil)) | |
1243 ;; (setq i (/ max 2)) | |
1244 ;; (while (and (not found) (/= min max)) | |
1245 ;; (setq fw (car (aref vector i))) | |
1246 ;; (cond ((string= word fw) (setq found (cdr (aref vector i)))) | |
1247 ;; ((string< word fw) (setq max i)) | |
1248 ;; (t (setq min i))) | |
1249 ;; (setq i (/ (+ max min) 2)) | |
1250 ;; ) | |
1251 ;; found)) | |
1252 | |
1253 ;;; Checking engines | |
1254 ;; | |
1255 (defun checkdoc-this-string-valid () | |
22195 | 1256 "Return a message string if the current doc string is invalid. |
20085 | 1257 Check for style only, such as the first line always being a complete |
1258 sentence, whitespace restrictions, and making sure there are no | |
1259 hard-coded key-codes such as C-[char] or mouse-[number] in the comment. | |
1260 See the style guide in the Emacs Lisp manual for more details." | |
1261 | |
22195 | 1262 ;; Jump over comments between the last object and the doc string |
20085 | 1263 (while (looking-at "[ \t\n]*;") |
1264 (forward-line 1) | |
1265 (beginning-of-line) | |
1266 (skip-chars-forward " \n\t")) | |
1267 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1268 (let ((fp (checkdoc-defun-info)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1269 (err nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1270 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1271 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1272 ;; * Every command, function, or variable intended for users to know |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1273 ;; about should have a documentation string. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1274 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1275 ;; * An internal variable or subroutine of a Lisp program might as well |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1276 ;; have a documentation string. In earlier Emacs versions, you could |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1277 ;; save space by using a comment instead of a documentation string, |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1278 ;; but that is no longer the case. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1279 (if (and (not (nth 1 fp)) ; not a variable |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1280 (or (nth 2 fp) ; is interactive |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1281 checkdoc-force-docstrings-flag) ;or we always complain |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1282 (not (checkdoc-char= (following-char) ?\"))) ; no doc string |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1283 ;; Sometimes old code has comments where the documentation should |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1284 ;; be. Let's see if we can find the comment, and offer to turn it |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1285 ;; into documentation for them. |
25697
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
1286 (let ((have-comment nil) |
6060f83b1ffc
(checkdoc-display-status-buffer): Avoid
Dave Love <fx@gnu.org>
parents:
23371
diff
changeset
|
1287 (comment-start ";")) ; in case it's not default |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1288 (condition-case nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1289 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1290 (forward-sexp -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1291 (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1292 (skip-chars-forward "\n \t") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1293 (setq have-comment (looking-at comment-start))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1294 (error nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1295 (if have-comment |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1296 (if (or (eq checkdoc-autofix-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1297 'automatic-then-never) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1298 (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1299 "Convert comment to documentation? ")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1300 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1301 ;; Our point is at the beginning of the comment! |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1302 ;; Insert a quote, then remove the comment chars. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1303 (insert "\"") |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1304 (let ((docstring-start-point (point))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1305 (while (looking-at comment-start) |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1306 (while (looking-at comment-start) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1307 (delete-char 1)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1308 (if (looking-at "[ \t]+") |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1309 (delete-region (match-beginning 0) (match-end 0))) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1310 (forward-line 1) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1311 (beginning-of-line) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1312 (skip-chars-forward " \t") |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1313 (if (looking-at comment-start) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1314 (progn |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1315 (beginning-of-line) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1316 (zap-to-char 1 ?\;)))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1317 (beginning-of-line) |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1318 (forward-char -1) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1319 (insert "\"") |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1320 (forward-char -1) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1321 ;; quote any double-quote characters in the comment. |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1322 (while (search-backward "\"" docstring-start-point t) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1323 (insert "\\")) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1324 (if (eq checkdoc-autofix-flag 'automatic-then-never) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1325 (setq checkdoc-autofix-flag 'never)))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1326 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1327 "You should convert this comment to documentation" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1328 (point) (save-excursion (end-of-line) (point)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1329 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1330 (if (nth 2 fp) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1331 "All interactive functions should have documentation" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1332 "All variables and subroutines might as well have a \ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1333 documentation string") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1334 (point) (+ (point) 1) t))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1335 (if (and (not err) (looking-at "\"")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1336 (let ((old-syntax-table (syntax-table))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1337 (unwind-protect |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1338 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1339 (set-syntax-table checkdoc-syntax-table) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1340 (checkdoc-this-string-valid-engine fp)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1341 (set-syntax-table old-syntax-table))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1342 err))) |
20085 | 1343 |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1344 (defun checkdoc-this-string-valid-engine (fp) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1345 "Return an error list or string if the current doc string is invalid. |
20085 | 1346 Depends on `checkdoc-this-string-valid' to reset the syntax table so that |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1347 regexp short cuts work. FP is the function defun information." |
20085 | 1348 (let ((case-fold-search nil) |
1349 ;; Use a marker so if an early check modifies the text, | |
1350 ;; we won't accidentally loose our place. This could cause | |
22195 | 1351 ;; end-of doc string whitespace to also delete the " char. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1352 (s (point)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1353 (e (if (looking-at "\"") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1354 (save-excursion (forward-sexp 1) (point-marker)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1355 (point)))) |
20085 | 1356 (or |
1357 ;; * *Do not* indent subsequent lines of a documentation string so that | |
1358 ;; the text is lined up in the source code with the text of the first | |
1359 ;; line. This looks nice in the source code, but looks bizarre when | |
1360 ;; users view the documentation. Remember that the indentation | |
1361 ;; before the starting double-quote is not part of the string! | |
1362 (save-excursion | |
1363 (forward-line 1) | |
1364 (beginning-of-line) | |
1365 (if (and (< (point) e) | |
1366 (looking-at "\\([ \t]+\\)[^ \t\n]")) | |
1367 (if (checkdoc-autofix-ask-replace (match-beginning 1) | |
1368 (match-end 1) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1369 "Remove this whitespace? " |
20085 | 1370 "") |
1371 nil | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1372 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1373 "Second line should not have indentation" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1374 (match-beginning 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1375 (match-end 1))))) |
20085 | 1376 ;; * Do not start or end a documentation string with whitespace. |
1377 (let (start end) | |
1378 (if (or (if (looking-at "\"\\([ \t\n]+\\)") | |
1379 (setq start (match-beginning 1) | |
1380 end (match-end 1))) | |
1381 (save-excursion | |
1382 (forward-sexp 1) | |
1383 (forward-char -1) | |
1384 (if (/= (skip-chars-backward " \t\n") 0) | |
1385 (setq start (point) | |
1386 end (1- e))))) | |
1387 (if (checkdoc-autofix-ask-replace | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1388 start end "Remove this whitespace? " "") |
20085 | 1389 nil |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1390 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1391 "Documentation strings should not start or end with whitespace" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1392 start end)))) |
20085 | 1393 ;; * The first line of the documentation string should consist of one |
1394 ;; or two complete sentences that stand on their own as a summary. | |
1395 ;; `M-x apropos' displays just the first line, and if it doesn't | |
1396 ;; stand on its own, the result looks bad. In particular, start the | |
1397 ;; first line with a capital letter and end with a period. | |
1398 (save-excursion | |
1399 (end-of-line) | |
1400 (skip-chars-backward " \t\n") | |
1401 (if (> (point) e) (goto-char e)) ;of the form (defun n () "doc" nil) | |
1402 (forward-char -1) | |
1403 (cond | |
1404 ((and (checkdoc-char= (following-char) ?\") | |
1405 ;; A backslashed double quote at the end of a sentence | |
1406 (not (checkdoc-char= (preceding-char) ?\\))) | |
1407 ;; We might have to add a period in this case | |
1408 (forward-char -1) | |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1409 (if (looking-at "[.!?]") |
20085 | 1410 nil |
1411 (forward-char 1) | |
1412 (if (checkdoc-autofix-ask-replace | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1413 (point) (1+ (point)) "Add period to sentence? " |
20085 | 1414 ".\"" t) |
1415 nil | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1416 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1417 "First sentence should end with punctuation" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1418 (point) (1+ (point)))))) |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1419 ((looking-at "[\\!?;:.)]") |
20085 | 1420 ;; These are ok |
1421 nil) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1422 ((and checkdoc-permit-comma-termination-flag (looking-at ",")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1423 nil) |
20085 | 1424 (t |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1425 ;; If it is not a complete sentence, let's see if we can |
20085 | 1426 ;; predict a clever way to make it one. |
1427 (let ((msg "First line is not a complete sentence") | |
1428 (e (point))) | |
1429 (beginning-of-line) | |
1430 (if (re-search-forward "\\. +" e t) | |
1431 ;; Here we have found a complete sentence, but no break. | |
1432 (if (checkdoc-autofix-ask-replace | |
1433 (1+ (match-beginning 0)) (match-end 0) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1434 "First line not a complete sentence. Add RET here? " |
20085 | 1435 "\n" t) |
1436 (let (l1 l2) | |
1437 (forward-line 1) | |
1438 (end-of-line) | |
1439 (setq l1 (current-column) | |
1440 l2 (save-excursion | |
1441 (forward-line 1) | |
1442 (end-of-line) | |
1443 (current-column))) | |
1444 (if (> (+ l1 l2 1) 80) | |
22195 | 1445 (setq msg "Incomplete auto-fix; doc string \ |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1446 may require more formatting") |
20085 | 1447 ;; We can merge these lines! Replace this CR |
1448 ;; with a space. | |
1449 (delete-char 1) (insert " ") | |
1450 (setq msg nil)))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1451 ;; Let's see if there is enough room to draw the next |
20085 | 1452 ;; line's sentence up here. I often get hit w/ |
1453 ;; auto-fill moving my words around. | |
1454 (let ((numc (progn (end-of-line) (- 80 (current-column)))) | |
1455 (p (point))) | |
1456 (forward-line 1) | |
1457 (beginning-of-line) | |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1458 (if (and (re-search-forward "[.!?:\"]\\([ \t\n]+\\|\"\\)" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1459 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1460 (end-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1461 (point)) |
20085 | 1462 t) |
1463 (< (current-column) numc)) | |
1464 (if (checkdoc-autofix-ask-replace | |
1465 p (1+ p) | |
22195 | 1466 "1st line not a complete sentence. Join these lines? " |
20085 | 1467 " " t) |
1468 (progn | |
1469 ;; They said yes. We have more fill work to do... | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1470 (goto-char (match-beginning 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1471 (delete-region (point) (match-end 1)) |
20085 | 1472 (insert "\n") |
1473 (setq msg nil)))))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1474 (if msg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1475 (checkdoc-create-error msg s (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1476 (goto-char s) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1477 (end-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1478 (point))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1479 nil) )))) |
20085 | 1480 ;; Continuation of above. Make sure our sentence is capitalized. |
1481 (save-excursion | |
1482 (skip-chars-forward "\"\\*") | |
1483 (if (looking-at "[a-z]") | |
1484 (if (checkdoc-autofix-ask-replace | |
1485 (match-beginning 0) (match-end 0) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1486 "Capitalize your sentence? " (upcase (match-string 0)) |
20085 | 1487 t) |
1488 nil | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1489 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1490 "First line should be capitalized" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1491 (match-beginning 0) (match-end 0))) |
20085 | 1492 nil)) |
1493 ;; * Don't write key sequences directly in documentation strings. | |
1494 ;; Instead, use the `\\[...]' construct to stand for them. | |
1495 (save-excursion | |
1496 (let ((f nil) (m nil) (start (point)) | |
21181 | 1497 (re "[^`A-Za-z0-9_]\\([CMA]-[a-zA-Z]\\|\\(\\([CMA]-\\)?\ |
20085 | 1498 mouse-[0-3]\\)\\)\\>")) |
1499 ;; Find the first key sequence not in a sample | |
1500 (while (and (not f) (setq m (re-search-forward re e t))) | |
1501 (setq f (not (checkdoc-in-sample-code-p start e)))) | |
1502 (if m | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1503 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1504 (concat |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1505 "Keycode " (match-string 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1506 " embedded in doc string. Use \\\\<keymap> & \\\\[function] " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1507 "instead") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1508 (match-beginning 1) (match-end 1) t)))) |
20085 | 1509 ;; It is not practical to use `\\[...]' very many times, because |
1510 ;; display of the documentation string will become slow. So use this | |
1511 ;; to describe the most important commands in your major mode, and | |
1512 ;; then use `\\{...}' to display the rest of the mode's keymap. | |
1513 (save-excursion | |
1514 (if (re-search-forward "\\\\\\\\\\[\\w+" e t | |
1515 (1+ checkdoc-max-keyref-before-warn)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1516 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1517 "Too many occurrences of \\[function]. Use \\{keymap} instead" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1518 s (marker-position e)))) |
22195 | 1519 ;; Ambiguous quoted symbol. When a symbol is both bound and fbound, |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1520 ;; and is referred to in documentation, it should be prefixed with |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1521 ;; something to disambiguate it. This check must be before the |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1522 ;; 80 column check because it will probably break that. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1523 (save-excursion |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1524 (let ((case-fold-search t) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1525 (ret nil) mb me) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1526 (while (and (re-search-forward "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'" e t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1527 (not ret)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1528 (let* ((ms1 (match-string 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1529 (sym (intern-soft ms1))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1530 (setq mb (match-beginning 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1531 me (match-end 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1532 (if (and sym (boundp sym) (fboundp sym) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1533 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1534 (goto-char mb) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1535 (forward-word -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1536 (not (looking-at |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1537 "variable\\|option\\|function\\|command\\|symbol")))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1538 (if (checkdoc-autofix-ask-replace |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1539 mb me "Prefix this ambiguous symbol? " ms1 t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1540 ;; We didn't actually replace anything. Here we find |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1541 ;; out what special word form they wish to use as |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1542 ;; a prefix. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1543 (let ((disambiguate |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1544 (completing-read |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1545 "Disambiguating Keyword (default: variable): " |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1546 '(("function") ("command") ("variable") |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1547 ("option") ("symbol")) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1548 nil t nil nil "variable"))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1549 (goto-char (1- mb)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1550 (insert disambiguate " ") |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1551 (forward-word 1)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1552 (setq ret |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1553 (format "Disambiguate %s by preceding w/ \ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1554 function,command,variable,option or symbol." ms1)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1555 (if ret |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1556 (checkdoc-create-error ret mb me) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1557 nil))) |
20085 | 1558 ;; * Format the documentation string so that it fits in an |
1559 ;; Emacs window on an 80-column screen. It is a good idea | |
1560 ;; for most lines to be no wider than 60 characters. The | |
1561 ;; first line can be wider if necessary to fit the | |
1562 ;; information that ought to be there. | |
1563 (save-excursion | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1564 (let ((start (point)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1565 (eol nil)) |
20085 | 1566 (while (and (< (point) e) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1567 (or (progn (end-of-line) (setq eol (point)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1568 (< (current-column) 80)) |
20085 | 1569 (progn (beginning-of-line) |
1570 (re-search-forward "\\\\\\\\[[<{]" | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1571 eol t)) |
20085 | 1572 (checkdoc-in-sample-code-p start e))) |
1573 (forward-line 1)) | |
1574 (end-of-line) | |
1575 (if (and (< (point) e) (> (current-column) 80)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1576 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1577 "Some lines are over 80 columns wide" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1578 s (save-excursion (goto-char s) (end-of-line) (point)) )))) |
20085 | 1579 ;; Here we deviate to tests based on a variable or function. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1580 ;; We must do this before checking for symbols in quotes because there |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1581 ;; is a chance that just such a symbol might really be an argument. |
20085 | 1582 (cond ((eq (nth 1 fp) t) |
1583 ;; This is if we are in a variable | |
1584 (or | |
1585 ;; * The documentation string for a variable that is a | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1586 ;; yes-or-no flag should start with words such as Non-nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1587 ;; means..., to make it clear that all non-`nil' values are |
20085 | 1588 ;; equivalent and indicate explicitly what `nil' and non-`nil' |
1589 ;; mean. | |
1590 ;; * If a user option variable records a true-or-false | |
1591 ;; condition, give it a name that ends in `-flag'. | |
1592 | |
1593 ;; If the variable has -flag in the name, make sure | |
1594 (if (and (string-match "-flag$" (car fp)) | |
1595 (not (looking-at "\"\\*?Non-nil\\s-+means\\s-+"))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1596 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1597 "Flag variable doc strings should usually start: Non-nil means" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1598 s (marker-position e) t)) |
22195 | 1599 ;; If the doc string starts with "Non-nil means" |
20085 | 1600 (if (and (looking-at "\"\\*?Non-nil\\s-+means\\s-+") |
1601 (not (string-match "-flag$" (car fp)))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1602 (if (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1603 (format |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1604 "Rename to %s and Query-Replace all occurances? " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1605 (concat (car fp) "-flag"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1606 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1607 (beginning-of-defun) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1608 (query-replace-regexp |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1609 (concat "\\<" (regexp-quote (car fp)) "\\>") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1610 (concat (car fp) "-flag"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1611 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1612 "Flag variable names should normally end in `-flag'" s |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1613 (marker-position e)))) |
20085 | 1614 ;; Done with variables |
1615 )) | |
1616 (t | |
1617 ;; This if we are in a function definition | |
1618 (or | |
1619 ;; * When a function's documentation string mentions the value | |
1620 ;; of an argument of the function, use the argument name in | |
1621 ;; capital letters as if it were a name for that value. Thus, | |
1622 ;; the documentation string of the function `/' refers to its | |
1623 ;; second argument as `DIVISOR', because the actual argument | |
1624 ;; name is `divisor'. | |
1625 | |
1626 ;; Addendum: Make sure they appear in the doc in the same | |
1627 ;; order that they are found in the arg list. | |
1628 (let ((args (cdr (cdr (cdr (cdr fp))))) | |
1629 (last-pos 0) | |
1630 (found 1) | |
1631 (order (and (nth 3 fp) (car (nth 3 fp)))) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1632 (nocheck (append '("&optional" "&rest") (nth 3 fp))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1633 (inopts nil)) |
20085 | 1634 (while (and args found (> found last-pos)) |
1635 (if (member (car args) nocheck) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1636 (setq args (cdr args) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1637 inopts t) |
20085 | 1638 (setq last-pos found |
1639 found (save-excursion | |
1640 (re-search-forward | |
1641 (concat "\\<" (upcase (car args)) | |
1642 ;; Require whitespace OR | |
1643 ;; ITEMth<space> OR | |
1644 ;; ITEMs<space> | |
1645 "\\(\\>\\|th\\>\\|s\\>\\)") | |
1646 e t))) | |
1647 (if (not found) | |
1648 (let ((case-fold-search t)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1649 ;; If the symbol was not found, let's see if we |
20085 | 1650 ;; can find it with a different capitalization |
1651 ;; and see if the user wants to capitalize it. | |
1652 (if (save-excursion | |
1653 (re-search-forward | |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1654 (concat "\\<\\(" (car args) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1655 ;; Require whitespace OR |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1656 ;; ITEMth<space> OR |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1657 ;; ITEMs<space> |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1658 "\\)\\(\\>\\|th\\>\\|s\\>\\)") |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1659 e t)) |
20085 | 1660 (if (checkdoc-autofix-ask-replace |
1661 (match-beginning 1) (match-end 1) | |
1662 (format | |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1663 "If this is the argument `%s', it should appear as %s. Fix? " |
20085 | 1664 (car args) (upcase (car args))) |
1665 (upcase (car args)) t) | |
1666 (setq found (match-beginning 1)))))) | |
1667 (if found (setq args (cdr args))))) | |
1668 (if (not found) | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1669 ;; It wasn't found at all! Offer to attach this new symbol |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1670 ;; to the end of the documentation string. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1671 (if (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1672 (format |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1673 "Add %s documentation to end of doc string? " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1674 (upcase (car args)))) |
22195 | 1675 ;; Now do some magic and invent a doc string. |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1676 (save-excursion |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1677 (goto-char e) (forward-char -1) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1678 (insert "\n" |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1679 (if inopts "Optional a" "A") |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1680 "rgument " (upcase (car args)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1681 " ") |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1682 (insert (read-string "Describe: ")) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1683 (if (not (save-excursion (forward-char -1) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1684 (looking-at "[.?!]"))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1685 (insert ".")) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
1686 nil) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1687 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1688 (format |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1689 "Argument `%s' should appear (as %s) in the doc string" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1690 (car args) (upcase (car args))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1691 s (marker-position e))) |
20085 | 1692 (if (or (and order (eq order 'yes)) |
1693 (and (not order) checkdoc-arguments-in-order-flag)) | |
1694 (if (< found last-pos) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1695 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1696 "Arguments occur in the doc string out of order" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1697 s (marker-position e) t))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1698 ;; * For consistency, phrase the verb in the first sentence of a |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1699 ;; documentation string for functions as an imperative. |
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1700 ;; For instance, use `Return the cons of A and |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1701 ;; B.' in preference to `Returns the cons of A and B.' |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1702 ;; Usually it looks good to do likewise for the rest of the |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1703 ;; first paragraph. Subsequent paragraphs usually look better |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1704 ;; if they have proper subjects. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1705 ;; |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1706 ;; This is the least important of the above tests. Make sure |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1707 ;; it occurs last. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1708 (and checkdoc-verb-check-experimental-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1709 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1710 ;; Maybe rebuild the monster-regex |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1711 (checkdoc-create-common-verbs-regexp) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1712 (let ((lim (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1713 (end-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1714 ;; check string-continuation |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1715 (if (checkdoc-char= (preceding-char) ?\\) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1716 (progn (forward-line 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1717 (end-of-line))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1718 (point))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1719 (rs nil) replace original (case-fold-search t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1720 (while (and (not rs) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1721 (re-search-forward |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1722 checkdoc-common-verbs-regexp |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1723 lim t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1724 (setq original (buffer-substring-no-properties |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1725 (match-beginning 1) (match-end 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1726 rs (assoc (downcase original) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1727 checkdoc-common-verbs-wrong-voice)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1728 (if (not rs) (error "Verb voice alist corrupted")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1729 (setq replace (let ((case-fold-search nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1730 (save-match-data |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1731 (if (string-match "^[A-Z]" original) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1732 (capitalize (cdr rs)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1733 (cdr rs))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1734 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1735 (match-beginning 1) (match-end 1) |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1736 (format "Use the imperative for \"%s\". \ |
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1737 Replace with \"%s\"? " original replace) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1738 replace t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1739 (setq rs nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1740 (if rs |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1741 ;; there was a match, but no replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1742 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1743 (format |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1744 "Probably \"%s\" should be imperative \"%s\"" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1745 original replace) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1746 (match-beginning 1) (match-end 1)))))) |
20085 | 1747 ;; Done with functions |
1748 ))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1749 ;;* When a documentation string refers to a Lisp symbol, write it as |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1750 ;; it would be printed (which usually means in lower case), with |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1751 ;; single-quotes around it. For example: `lambda'. There are two |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1752 ;; exceptions: write t and nil without single-quotes. (In this |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1753 ;; manual, we normally do use single-quotes for those symbols.) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1754 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1755 (let ((found nil) (start (point)) (msg nil) (ms nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1756 (while (and (not msg) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1757 (re-search-forward |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1758 "[^-([`':a-zA-Z]\\(\\w+[:-]\\(\\w\\|\\s_\\)+\\)[^]']" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1759 e t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1760 (setq ms (match-string 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1761 (save-match-data |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1762 ;; A . is a \s_ char, so we must remove periods from |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1763 ;; sentences more carefully. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1764 (if (string-match "\\.$" ms) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1765 (setq ms (substring ms 0 (1- (length ms)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1766 (if (and (not (checkdoc-in-sample-code-p start e)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1767 (not (checkdoc-in-example-string-p start e)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1768 (not (member ms checkdoc-symbol-words)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1769 (setq found (intern-soft ms)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1770 (or (boundp found) (fboundp found))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1771 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1772 (setq msg (format "Add quotes around Lisp symbol `%s'? " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1773 ms)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1774 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1775 (match-beginning 1) (+ (match-beginning 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1776 (length ms)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1777 msg (concat "`" ms "'") t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1778 (setq msg nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1779 (setq msg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1780 (format "Lisp symbol `%s' should appear in quotes" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1781 ms)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1782 (if msg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1783 (checkdoc-create-error msg (match-beginning 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1784 (+ (match-beginning 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1785 (length ms))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1786 nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1787 ;; t and nil case |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1788 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1789 (if (re-search-forward "\\(`\\(t\\|nil\\)'\\)" e t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1790 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1791 (match-beginning 1) (match-end 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1792 (format "%s should not appear in quotes. Remove? " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1793 (match-string 2)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1794 (match-string 2) t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1795 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1796 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
1797 "Symbols t and nil should not appear in `...' quotes" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1798 (match-beginning 1) (match-end 1))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1799 ;; Here is some basic sentence formatting |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1800 (checkdoc-sentencespace-region-engine (point) e) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1801 ;; Here are common proper nouns that should always appear capitalized. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1802 (checkdoc-proper-noun-region-engine (point) e) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1803 ;; Make sure the doc string has correctly spelled English words |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1804 ;; in it. This function is extracted due to its complexity, |
22195 | 1805 ;; and reliance on the Ispell program. |
20085 | 1806 (checkdoc-ispell-docstring-engine e) |
1807 ;; User supplied checks | |
1808 (save-excursion (checkdoc-run-hooks 'checkdoc-style-hooks fp e)) | |
1809 ;; Done! | |
1810 ))) | |
1811 | |
1812 (defun checkdoc-defun-info nil | |
1813 "Return a list of details about the current sexp. | |
1814 It is a list of the form: | |
22195 | 1815 (NAME VARIABLE INTERACTIVE NODOCPARAMS PARAMETERS ...) |
20085 | 1816 where NAME is the name, VARIABLE is t if this is a `defvar', |
1817 INTERACTIVE is nil if this is not an interactive function, otherwise | |
1818 it is the position of the `interactive' call, and PARAMETERS is a | |
1819 string which is the name of each variable in the function's argument | |
1820 list. The NODOCPARAMS is a sublist of parameters specified by a checkdoc | |
1821 comment for a given defun. If the first element is not a string, then | |
1822 the token checkdoc-order: <TOKEN> exists, and TOKEN is a symbol read | |
1823 from the comment." | |
1824 (save-excursion | |
1825 (beginning-of-defun) | |
1826 (let ((defun (looking-at "(def\\(un\\|macro\\|subst\\|advice\\)")) | |
1827 (is-advice (looking-at "(defadvice")) | |
1828 (lst nil) | |
1829 (ret nil) | |
1830 (oo (make-vector 3 0))) ;substitute obarray for `read' | |
1831 (forward-char 1) | |
1832 (forward-sexp 1) | |
1833 (skip-chars-forward " \n\t") | |
1834 (setq ret | |
1835 (list (buffer-substring-no-properties | |
1836 (point) (progn (forward-sexp 1) (point))))) | |
1837 (if (not defun) | |
1838 (setq ret (cons t ret)) | |
1839 ;; The variable spot | |
1840 (setq ret (cons nil ret)) | |
1841 ;; Interactive | |
1842 (save-excursion | |
1843 (setq ret (cons | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
1844 (re-search-forward "^\\s-*(interactive" |
20085 | 1845 (save-excursion (end-of-defun) (point)) |
1846 t) | |
1847 ret))) | |
1848 (skip-chars-forward " \t\n") | |
1849 (let ((bss (buffer-substring (point) (save-excursion (forward-sexp 1) | |
1850 (point)))) | |
1851 ;; Overload th main obarray so read doesn't intern the | |
1852 ;; local symbols of the function we are checking. | |
1853 ;; Without this we end up cluttering the symbol space w/ | |
1854 ;; useless symbols. | |
1855 (obarray oo)) | |
1856 ;; Ok, check for checkdoc parameter comment here | |
1857 (save-excursion | |
1858 (setq ret | |
1859 (cons | |
1860 (let ((sl1 nil)) | |
1861 (if (re-search-forward ";\\s-+checkdoc-order:\\s-+" | |
1862 (save-excursion (end-of-defun) | |
1863 (point)) | |
1864 t) | |
1865 (setq sl1 (list (cond ((looking-at "nil") 'no) | |
1866 ((looking-at "t") 'yes))))) | |
1867 (if (re-search-forward ";\\s-+checkdoc-params:\\s-+" | |
1868 (save-excursion (end-of-defun) | |
1869 (point)) | |
1870 t) | |
1871 (let ((sl nil)) | |
1872 (goto-char (match-end 0)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1873 (condition-case nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1874 (setq lst (read (current-buffer))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1875 (error (setq lst nil))) ; error in text |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1876 (if (not (listp lst)) ; not a list of args |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1877 (setq lst (list lst))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1878 (if (and lst (not (symbolp (car lst)))) ;weird arg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1879 (setq lst nil)) |
20085 | 1880 (while lst |
1881 (setq sl (cons (symbol-name (car lst)) sl) | |
1882 lst (cdr lst))) | |
1883 (setq sl1 (append sl1 sl)))) | |
1884 sl1) | |
1885 ret))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1886 ;; Read the list of parameters, but do not put the symbols in |
20085 | 1887 ;; the standard obarray. |
1888 (setq lst (read bss))) | |
1889 ;; This is because read will intern nil if it doesn't into the | |
1890 ;; new obarray. | |
1891 (if (not (listp lst)) (setq lst nil)) | |
1892 (if is-advice nil | |
1893 (while lst | |
1894 (setq ret (cons (symbol-name (car lst)) ret) | |
1895 lst (cdr lst))))) | |
1896 (nreverse ret)))) | |
1897 | |
1898 (defun checkdoc-in-sample-code-p (start limit) | |
22195 | 1899 "Return non-nil if the current point is in a code fragment. |
20085 | 1900 A code fragment is identified by an open parenthesis followed by a |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1901 symbol which is a valid function or a word in all CAPS, or a parenthesis |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1902 that is quoted with the ' character. Only the region from START to LIMIT |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1903 is is allowed while searching for the bounding parenthesis." |
20085 | 1904 (save-match-data |
1905 (save-restriction | |
1906 (narrow-to-region start limit) | |
1907 (save-excursion | |
1908 (and (condition-case nil (progn (up-list 1) t) (error nil)) | |
1909 (condition-case nil (progn (forward-list -1) t) (error nil)) | |
1910 (or (save-excursion (forward-char -1) (looking-at "'(")) | |
1911 (and (looking-at "(\\(\\(\\w\\|[-:_]\\)+\\)[ \t\n;]") | |
1912 (let ((ms (buffer-substring-no-properties | |
1913 (match-beginning 1) (match-end 1)))) | |
1914 ;; if this string is function bound, we are in | |
1915 ;; sample code. If it has a - or : character in | |
1916 ;; the name, then it is probably supposed to be bound | |
1917 ;; but isn't yet. | |
1918 (or (fboundp (intern-soft ms)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1919 (let ((case-fold-search nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1920 (string-match "^[A-Z-]+$" ms)) |
20085 | 1921 (string-match "\\w[-:_]+\\w" ms)))))))))) |
1922 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1923 (defun checkdoc-in-example-string-p (start limit) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1924 "Return non-nil if the current point is in an \"example string\". |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1925 This string is identified by the characters \\\" surrounding the text. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1926 The text checked is between START and LIMIT." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1927 (save-match-data |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1928 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1929 (let ((p (point)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1930 (c 0)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1931 (goto-char start) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1932 (while (and (< (point) p) (re-search-forward "\\\\\"" limit t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1933 (setq c (1+ c))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1934 (and (< 0 c) (= (% c 2) 0)))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1935 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1936 (defun checkdoc-proper-noun-region-engine (begin end) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1937 "Check all text between BEGIN and END for lower case proper nouns. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1938 These are Emacs centric proper nouns which should be capitalized for |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1939 consistency. Return an error list if any are not fixed, but |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1940 internally skip over no answers. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1941 If the offending word is in a piece of quoted text, then it is skipped." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1942 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1943 (let ((case-fold-search nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1944 (errtxt nil) bb be |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1945 (old-syntax-table (syntax-table))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1946 (unwind-protect |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1947 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1948 (set-syntax-table checkdoc-syntax-table) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1949 (goto-char begin) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1950 (while (re-search-forward checkdoc-proper-noun-regexp end t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1951 (let ((text (match-string 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1952 (b (match-beginning 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1953 (e (match-end 1))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1954 (if (and (not (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1955 (goto-char b) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1956 (forward-char -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1957 (looking-at "`\\|\"\\|\\.\\|\\\\"))) |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1958 ;; surrounded by /, as in a URL or filename: /emacs/ |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1959 (not (and (= ?/ (char-after e)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1960 (= ?/ (char-before b)))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1961 (not (checkdoc-in-example-string-p begin end))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1962 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1963 b e (format "Text %s should be capitalized. Fix? " |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1964 text) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1965 (capitalize text) t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1966 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1967 (if errtxt |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1968 ;; If there is already an error, then generate |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1969 ;; the warning output if applicable |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1970 (if checkdoc-generate-compile-warnings-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1971 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1972 (format |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1973 "Name %s should appear capitalized as %s" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1974 text (capitalize text)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1975 b e)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1976 (setq errtxt |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1977 (format |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1978 "Name %s should appear capitalized as %s" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1979 text (capitalize text)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1980 bb b be e))))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1981 (set-syntax-table old-syntax-table)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1982 (if errtxt (checkdoc-create-error errtxt bb be))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1983 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1984 (defun checkdoc-sentencespace-region-engine (begin end) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
1985 "Make sure all sentences have double spaces between BEGIN and END." |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1986 (if sentence-end-double-space |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1987 (save-excursion |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1988 (let ((case-fold-search nil) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1989 (errtxt nil) bb be |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1990 (old-syntax-table (syntax-table))) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1991 (unwind-protect |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1992 (progn |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1993 (set-syntax-table checkdoc-syntax-table) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1994 (goto-char begin) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1995 (while (re-search-forward "[^.0-9]\\(\\. \\)[^ \n]" end t) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1996 (let ((b (match-beginning 1)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1997 (e (match-end 1))) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1998 (if (and (not (checkdoc-in-sample-code-p begin end)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
1999 (not (checkdoc-in-example-string-p begin end)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2000 (not (save-excursion |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2001 (goto-char (match-beginning 1)) |
23371
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2002 (condition-case nil |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2003 (progn |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2004 (forward-sexp -1) |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2005 ;; piece of an abbreviation |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2006 (looking-at |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2007 "\\([a-z]\\|[iI]\\.?e\\|[eE]\\.?g\\)\\.")) |
9808edcd3c95
(checkdoc-sentencespace-region-engine): Protect a `forward-sexp' call
Eric M. Ludlam <zappo@gnu.org>
parents:
23192
diff
changeset
|
2008 (error t))))) |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2009 (if (checkdoc-autofix-ask-replace |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2010 b e |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2011 "There should be two spaces after a period. Fix? " |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2012 ". ") |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2013 nil |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2014 (if errtxt |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2015 ;; If there is already an error, then generate |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2016 ;; the warning output if applicable |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2017 (if checkdoc-generate-compile-warnings-flag |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2018 (checkdoc-create-error |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2019 "There should be two spaces after a period" |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2020 b e)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2021 (setq errtxt |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2022 "There should be two spaces after a period" |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2023 bb b be e))))))) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2024 (set-syntax-table old-syntax-table)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2025 (if errtxt (checkdoc-create-error errtxt bb be)))))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2026 |
20085 | 2027 ;;; Ispell engine |
2028 ;; | |
2029 (eval-when-compile (require 'ispell)) | |
2030 | |
2031 (defun checkdoc-ispell-init () | |
22195 | 2032 "Initialize Ispell process (default version) with Lisp words. |
20085 | 2033 The words used are from `checkdoc-ispell-lisp-words'. If `ispell' |
2034 cannot be loaded, then set `checkdoc-spellcheck-documentation-flag' to | |
2035 nil." | |
2036 (require 'ispell) | |
2037 (if (not (symbol-value 'ispell-process)) ;Silence byteCompiler | |
2038 (condition-case nil | |
2039 (progn | |
2040 (ispell-buffer-local-words) | |
22195 | 2041 ;; This code copied in part from ispell.el Emacs 19.34 |
20085 | 2042 (let ((w checkdoc-ispell-lisp-words)) |
2043 (while w | |
2044 (process-send-string | |
2045 ;; Silence byte compiler | |
2046 (symbol-value 'ispell-process) | |
2047 (concat "@" (car w) "\n")) | |
2048 (setq w (cdr w))))) | |
2049 (error (setq checkdoc-spellcheck-documentation-flag nil))))) | |
2050 | |
2051 (defun checkdoc-ispell-docstring-engine (end) | |
22195 | 2052 "Run the Ispell tools on the doc string between point and END. |
2053 Since Ispell isn't Lisp-smart, we must pre-process the doc string | |
2054 before using the Ispell engine on it." | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2055 (if (or (not checkdoc-spellcheck-documentation-flag) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2056 ;; If the user wants no questions or fixing, then we must |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2057 ;; disable spell checking as not useful. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2058 (not checkdoc-autofix-flag) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2059 (eq checkdoc-autofix-flag 'never)) |
20085 | 2060 nil |
2061 (checkdoc-ispell-init) | |
2062 (save-excursion | |
2063 (skip-chars-forward "^a-zA-Z") | |
2064 (let ((word nil) (sym nil) (case-fold-search nil) (err nil)) | |
2065 (while (and (not err) (< (point) end)) | |
2066 (if (save-excursion (forward-char -1) (looking-at "[('`]")) | |
2067 ;; Skip lists describing meta-syntax, or bound variables | |
2068 (forward-sexp 1) | |
2069 (setq word (buffer-substring-no-properties | |
2070 (point) (progn | |
2071 (skip-chars-forward "a-zA-Z-") | |
2072 (point))) | |
2073 sym (intern-soft word)) | |
2074 (if (and sym (or (boundp sym) (fboundp sym))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2075 ;; This is probably repetitive in most cases, but not always. |
20085 | 2076 nil |
2077 ;; Find out how we spell-check this word. | |
2078 (if (or | |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
2079 ;; All caps w/ option th, or s tacked on the end |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2080 ;; for pluralization or numberthness. |
20603
24dda0afd915
Added some more comments in the commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
20085
diff
changeset
|
2081 (string-match "^[A-Z][A-Z]+\\(s\\|th\\)?$" word) |
20085 | 2082 (looking-at "}") ; a keymap expression |
2083 ) | |
2084 nil | |
2085 (save-excursion | |
2086 (if (not (eq checkdoc-autofix-flag 'never)) | |
2087 (let ((lk last-input-event)) | |
2088 (ispell-word nil t) | |
2089 (if (not (equal last-input-event lk)) | |
2090 (progn | |
2091 (sit-for 0) | |
2092 (message "Continuing...")))) | |
2093 ;; Nothing here. | |
2094 ))))) | |
2095 (skip-chars-forward "^a-zA-Z")) | |
2096 err)))) | |
2097 | |
2098 ;;; Rogue space checking engine | |
2099 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2100 (defun checkdoc-rogue-space-check-engine (&optional start end interact) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2101 "Return a message list if there is a line with white space at the end. |
20085 | 2102 If `checkdoc-autofix-flag' permits, delete that whitespace instead. |
2103 If optional arguments START and END are non nil, bound the check to | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2104 this region. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2105 Optional argument INTERACT may permit the user to fix problems on the fly." |
20085 | 2106 (let ((p (point)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2107 (msg nil) s e (f nil)) |
20085 | 2108 (if (not start) (setq start (point-min))) |
2109 ;; If end is nil, it means end of buffer to search anyway | |
2110 (or | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2111 ;; Check for an error if `? ' or `?\ ' is used at the end of a line. |
20085 | 2112 ;; (It's dangerous) |
2113 (progn | |
2114 (goto-char start) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2115 (while (and (not msg) (re-search-forward "\\?\\\\?[ \t][ \t]*$" end t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2116 (setq msg |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2117 "Don't use `? ' at the end of a line. \ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2118 News agents may remove it" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2119 s (match-beginning 0) e (match-end 0) f t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2120 ;; If interactive is passed down, give them a chance to fix things. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2121 (if (and interact (y-or-n-p (concat msg ". Fix? "))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2122 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2123 (checkdoc-recursive-edit msg) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2124 (setq msg nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2125 (goto-char s) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2126 (beginning-of-line))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2127 ;; Check for, and potentially remove whitespace appearing at the |
20085 | 2128 ;; end of different lines. |
2129 (progn | |
2130 (goto-char start) | |
22195 | 2131 ;; There is no documentation in the Emacs Lisp manual about this check, |
20085 | 2132 ;; it is intended to help clean up messy code and reduce the file size. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2133 (while (and (not msg) (re-search-forward "[^ \t\n;]\\([ \t]+\\)$" end t)) |
20085 | 2134 ;; This is not a complex activity |
2135 (if (checkdoc-autofix-ask-replace | |
2136 (match-beginning 1) (match-end 1) | |
22195 | 2137 "White space at end of line. Remove? " "") |
20085 | 2138 nil |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2139 (setq msg "White space found at end of line" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2140 s (match-beginning 1) e (match-end 1)))))) |
20085 | 2141 ;; Return an error and leave the cursor at that spot, or restore |
2142 ;; the cursor. | |
2143 (if msg | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2144 (checkdoc-create-error msg s e f) |
20085 | 2145 (goto-char p) |
2146 nil))) | |
2147 | |
2148 ;;; Comment checking engine | |
2149 ;; | |
2150 (eval-when-compile | |
2151 ;; We must load this to: | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2152 ;; a) get symbols for compile and |
20085 | 2153 ;; b) determine if we have lm-history symbol which doesn't always exist |
2154 (require 'lisp-mnt)) | |
2155 | |
2156 (defun checkdoc-file-comments-engine () | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2157 "Return a message list if this file does not match the Emacs standard. |
20085 | 2158 This checks for style only, such as the first line, Commentary:, |
2159 Code:, and others referenced in the style guide." | |
2160 (if (featurep 'lisp-mnt) | |
2161 nil | |
2162 (require 'lisp-mnt) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2163 ;; Old XEmacs don't have `lm-commentary-mark' |
20085 | 2164 (if (and (not (fboundp 'lm-commentary-mark)) (boundp 'lm-commentary)) |
2165 (defalias 'lm-commentary-mark 'lm-commentary))) | |
2166 (save-excursion | |
2167 (let* ((f1 (file-name-nondirectory (buffer-file-name))) | |
2168 (fn (file-name-sans-extension f1)) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2169 (fe (substring f1 (length fn))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2170 (err nil)) |
20085 | 2171 (goto-char (point-min)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2172 ;; This file has been set up where ERR is a variable. Each check is |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2173 ;; asked, and the function will make sure that if the user does not |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2174 ;; auto-fix some error, that we still move on to the next auto-fix, |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2175 ;; AND we remember the past errors. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2176 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2177 err |
20085 | 2178 ;; Lisp Maintenance checks first |
2179 ;; Was: (lm-verify) -> not flexible enough for some people | |
2180 ;; * Summary at the beginning of the file: | |
2181 (if (not (lm-summary)) | |
2182 ;; This certifies as very complex so always ask unless | |
2183 ;; it's set to never | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2184 (if (checkdoc-y-or-n-p "There is no first line summary! Add one? ") |
20085 | 2185 (progn |
2186 (goto-char (point-min)) | |
2187 (insert ";;; " fn fe " --- " (read-string "Summary: ") "\n")) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2188 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2189 "The first line should be of the form: \";;; package --- Summary\"" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2190 (point-min) (save-excursion (goto-char (point-min)) (end-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2191 (point)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2192 nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2193 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2194 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2195 (or |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2196 ;; * Commentary Section |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2197 (if (not (lm-commentary-mark)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2198 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2199 (goto-char (point-min)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2200 (cond |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2201 ((re-search-forward |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2202 "write\\s-+to\\s-+the\\s-+Free Software Foundation, Inc." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2203 nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2204 (re-search-forward "^;;\\s-*\n\\|^\n" nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2205 ((or (re-search-forward "^;;; History" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2206 (re-search-forward "^;;; Code" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2207 (re-search-forward "^(require" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2208 (re-search-forward "^(")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2209 (beginning-of-line))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2210 (if (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2211 "You should have a \";;; Commentary:\", add one? ") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2212 (insert "\n;;; Commentary:\n;; \n\n") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2213 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2214 "You should have a section marked \";;; Commentary:\"" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2215 nil nil t))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2216 nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2217 err)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2218 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2219 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2220 (or |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2221 ;; * History section. Say nothing if there is a file ChangeLog |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2222 (if (or (not checkdoc-force-history-flag) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2223 (file-exists-p "ChangeLog") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2224 (file-exists-p "../ChangeLog") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2225 (let ((fn 'lm-history-mark)) ;bestill byte-compiler |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2226 (and (fboundp fn) (funcall fn)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2227 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2228 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2229 (goto-char (or (lm-commentary-mark) (point-min))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2230 (cond |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2231 ((re-search-forward |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2232 "write\\s-+to\\s-+the\\s-+Free Software Foundation, Inc." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2233 nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2234 (re-search-forward "^;;\\s-*\n\\|^\n" nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2235 ((or (re-search-forward "^;;; Code" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2236 (re-search-forward "^(require" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2237 (re-search-forward "^(")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2238 (beginning-of-line))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2239 (if (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2240 "You should have a \";;; History:\", add one? ") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2241 (insert "\n;;; History:\n;; \n\n") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2242 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2243 "You should have a section marked \";;; History:\" or use a ChangeLog" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2244 (point) nil)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2245 err)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2246 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2247 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2248 (or |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2249 ;; * Code section |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2250 (if (not (lm-code-mark)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2251 (let ((cont t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2252 (goto-char (point-min)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2253 (while (and cont (re-search-forward "^(" nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2254 (setq cont (looking-at "require\\s-+"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2255 (if (and (not cont) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2256 (checkdoc-y-or-n-p |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2257 "There is no ;;; Code: marker. Insert one? ")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2258 (progn (beginning-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2259 (insert ";;; Code:\n") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2260 nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2261 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2262 "You should have a section marked \";;; Code:\"" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2263 (point) nil))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2264 nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2265 err)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2266 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2267 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2268 (or |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2269 ;; * A footer. Not compartmentalized from lm-verify: too bad. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2270 ;; The following is partially clipped from lm-verify |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2271 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2272 (goto-char (point-max)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2273 (if (not (re-search-backward |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2274 (concat "^;;;[ \t]+" fn "\\(" (regexp-quote fe) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2275 "\\)?[ \t]+ends here[ \t]*$" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2276 "\\|^;;;[ \t]+ End of file[ \t]+" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2277 fn "\\(" (regexp-quote fe) "\\)?") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2278 nil t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2279 (if (checkdoc-y-or-n-p "No identifiable footer! Add one? ") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2280 (progn |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2281 (goto-char (point-max)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2282 (insert "\n(provide '" fn ")\n\n;;; " fn fe " ends here\n")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2283 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2284 (format "The footer should be: (provide '%s)\\n;;; %s%s ends here" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2285 fn fn fe) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2286 (1- (point-max)) (point-max))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2287 err)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2288 ;; The below checks will not return errors if the user says NO |
20085 | 2289 |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2290 ;; Let's spellcheck the commentary section. This is the only |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2291 ;; section that is easy to pick out, and it is also the most |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2292 ;; visible section (with the finder). |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2293 (let ((cm (lm-commentary-mark))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2294 (if cm |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2295 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2296 (goto-char (lm-commentary-mark)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2297 ;; Spellcheck between the commentary, and the first |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2298 ;; non-comment line. We could use lm-commentary, but that |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2299 ;; returns a string, and Ispell wants to talk to a buffer. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2300 ;; Since the comments talk about Lisp, use the specialized |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2301 ;; spell-checker we also used for doc strings. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2302 (let ((e (save-excursion (re-search-forward "^[^;]" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2303 (point)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2304 (checkdoc-sentencespace-region-engine (point) e) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2305 (checkdoc-proper-noun-region-engine (point) e) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2306 (checkdoc-ispell-docstring-engine e))))) |
20085 | 2307 ;;; test comment out code |
2308 ;;; (foo 1 3) | |
2309 ;;; (bar 5 7) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2310 (setq |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2311 err |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2312 (or |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2313 ;; Generic Full-file checks (should be comment related) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2314 (checkdoc-run-hooks 'checkdoc-comment-style-hooks) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2315 err)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2316 ;; Done with full file comment checks |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2317 err))) |
20085 | 2318 |
2319 (defun checkdoc-outside-major-sexp () | |
2320 "Return t if point is outside the bounds of a valid sexp." | |
2321 (save-match-data | |
2322 (save-excursion | |
2323 (let ((p (point))) | |
2324 (or (progn (beginning-of-defun) (bobp)) | |
2325 (progn (end-of-defun) (< (point) p))))))) | |
2326 | |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2327 ;;; `error' and `message' text verifier. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2328 ;; |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2329 (defun checkdoc-message-text-search (&optional beg end) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2330 "Search between BEG and END for a style error with message text. |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2331 Optional arguments BEG and END represent the boundary of the check. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2332 The default boundary is the entire buffer." |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2333 (let ((e nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2334 (type nil)) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2335 (if (not (or beg end)) (setq beg (point-min) end (point-max))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2336 (goto-char beg) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2337 (while (setq type (checkdoc-message-text-next-string end)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2338 (setq e (checkdoc-message-text-engine type))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2339 e)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2340 |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2341 (defun checkdoc-message-text-next-string (end) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2342 "Move cursor to the next checkable message string after point. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2343 Return the message classification. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2344 Argument END is the maximum bounds to search in." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2345 (let ((return nil)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2346 (while (and (not return) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2347 (re-search-forward |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2348 "(\\s-*\\(\\(\\w\\|\\s_\\)*error\\|\ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2349 \\(\\w\\|\\s_\\)*y-or-n-p\\(-with-timeout\\)?\ |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2350 \\|checkdoc-autofix-ask-replace\\)[ \t\n]+" end t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2351 (let* ((fn (match-string 1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2352 (type (cond ((string-match "error" fn) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2353 'error) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2354 (t 'y-or-n-p)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2355 (if (string-match "checkdoc-autofix-ask-replace" fn) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2356 (progn (forward-sexp 2) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2357 (skip-chars-forward " \t\n"))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2358 (if (and (eq type 'y-or-n-p) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2359 (looking-at "(format[ \t\n]+")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2360 (goto-char (match-end 0))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2361 (skip-chars-forward " \t\n") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2362 (if (not (looking-at "\"")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2363 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2364 (setq return type)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2365 return)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2366 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2367 (defun checkdoc-message-text-engine (&optional type) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2368 "Return or fix errors found in strings passed to a message display function. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2369 According to the documentation for the function `error', the error list |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2370 should not end with a period, and should start with a capital letter. |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2371 The function `y-or-n-p' has similar constraints. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2372 Argument TYPE specifies the type of question, such as `error or `y-or-n-p." |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2373 ;; If type is nil, then attempt to derive it. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2374 (if (not type) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2375 (save-excursion |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2376 (up-list -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2377 (if (looking-at "(format") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2378 (up-list -1)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2379 (setq type |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2380 (cond ((looking-at "(error") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2381 'error) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2382 (t 'y-or-n-p))))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2383 (let ((case-fold-search nil)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2384 (or |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2385 ;; From the documentation of the symbol `error': |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2386 ;; In Emacs, the convention is that error messages start with a capital |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2387 ;; letter but *do not* end with a period. Please follow this convention |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2388 ;; for the sake of consistency. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2389 (if (and (save-excursion (forward-char 1) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2390 (looking-at "[a-z]\\w+")) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2391 (not (checkdoc-autofix-ask-replace |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2392 (match-beginning 0) (match-end 0) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2393 "Capitalize your message text? " |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2394 (capitalize (match-string 0)) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2395 t))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2396 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2397 "Messages should start with a capital letter" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2398 (match-beginning 0) (match-end 0)) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2399 nil) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2400 ;; In general, sentences should have two spaces after the period. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2401 (checkdoc-sentencespace-region-engine (point) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2402 (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2403 (point))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2404 ;; Look for proper nouns in this region too. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2405 (checkdoc-proper-noun-region-engine (point) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2406 (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2407 (point))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2408 ;; Here are message type specific questions. |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2409 (if (and (eq type 'error) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2410 (save-excursion (forward-sexp 1) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2411 (forward-char -2) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2412 (looking-at "\\.")) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2413 (not (checkdoc-autofix-ask-replace (match-beginning 0) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2414 (match-end 0) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2415 "Remove period from error? " |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2416 "" |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2417 t))) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2418 (checkdoc-create-error |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2419 "Error messages should *not* end with a period" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2420 (match-beginning 0) (match-end 0)) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2421 nil) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2422 ;; `y-or-n-p' documentation explicitly says: |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2423 ;; It should end in a space; `y-or-n-p' adds `(y or n) ' to it. |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2424 ;; I added the ? requirement. Without it, it is unclear that we |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2425 ;; ask a question and it appears to be an undocumented style. |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2426 (if (eq type 'y-or-n-p) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2427 (if (not (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2428 (forward-char -3) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2429 (not (looking-at "\\? ")))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2430 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2431 (if (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2432 (forward-char -2) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2433 (looking-at "\\?")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2434 ;; If we see a ?, then replace with "? ". |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2435 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2436 (match-beginning 0) (match-end 0) |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2437 "`y-or-n-p' argument should end with \"? \". Fix? " |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2438 "? " t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2439 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2440 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2441 "`y-or-n-p' argument should end with \"? \"" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2442 (match-beginning 0) (match-end 0))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2443 (if (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2444 (forward-char -2) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2445 (looking-at " ")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2446 (if (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2447 (match-beginning 0) (match-end 0) |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2448 "`y-or-n-p' argument should end with \"? \". Fix? " |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2449 "? " t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2450 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2451 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2452 "`y-or-n-p' argument should end with \"? \"" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2453 (match-beginning 0) (match-end 0))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2454 (if (and ;; if this isn't true, we have a problem. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2455 (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2456 (forward-char -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2457 (looking-at "\"")) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2458 (checkdoc-autofix-ask-replace |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2459 (match-beginning 0) (match-end 0) |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2460 "`y-or-n-p' argument should end with \"? \". Fix? " |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2461 "? \"" t)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2462 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2463 (checkdoc-create-error |
26615
1d769c66f407
(checkdoc-this-string-valid-engine):
Richard M. Stallman <rms@gnu.org>
parents:
25697
diff
changeset
|
2464 "`y-or-n-p' argument should end with \"? \"" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2465 (match-beginning 0) (match-end 0))))))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2466 ;; Now, let's just run the spell checker on this guy. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2467 (checkdoc-ispell-docstring-engine (save-excursion (forward-sexp 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2468 (point))) |
22111
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2469 ))) |
38f78542051a
Updated with latest version. Changes include:
Eric M. Ludlam <zappo@gnu.org>
parents:
21651
diff
changeset
|
2470 |
20085 | 2471 ;;; Auto-fix helper functions |
2472 ;; | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2473 (defun checkdoc-y-or-n-p (question) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2474 "Like `y-or-n-p', but pays attention to `checkdoc-autofix-flag'. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2475 Argument QUESTION is the prompt passed to `y-or-n-p'." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2476 (prog1 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2477 (if (or (not checkdoc-autofix-flag) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2478 (eq checkdoc-autofix-flag 'never)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2479 nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2480 (y-or-n-p question)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2481 (if (eq checkdoc-autofix-flag 'automatic-then-never) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2482 (setq checkdoc-autofix-flag 'never)))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2483 |
20085 | 2484 (defun checkdoc-autofix-ask-replace (start end question replacewith |
2485 &optional complex) | |
2486 "Highlight between START and END and queries the user with QUESTION. | |
2487 If the user says yes, or if `checkdoc-autofix-flag' permits, replace | |
2488 the region marked by START and END with REPLACEWITH. If optional flag | |
2489 COMPLEX is non-nil, then we may ask the user a question. See the | |
2490 documentation for `checkdoc-autofix-flag' for details. | |
2491 | |
2492 If a section is auto-replaced without asking the user, this function | |
2493 will pause near the fixed code so the user will briefly see what | |
2494 happened. | |
2495 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2496 This function returns non-nil if the text was replaced. |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2497 |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2498 This function will not modify `match-data'." |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2499 (if (and checkdoc-autofix-flag |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2500 (not (eq checkdoc-autofix-flag 'never))) |
20085 | 2501 (let ((o (checkdoc-make-overlay start end)) |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2502 (ret nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2503 (md (match-data))) |
20085 | 2504 (unwind-protect |
2505 (progn | |
2506 (checkdoc-overlay-put o 'face 'highlight) | |
2507 (if (or (eq checkdoc-autofix-flag 'automatic) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2508 (eq checkdoc-autofix-flag 'automatic-then-never) |
20085 | 2509 (and (eq checkdoc-autofix-flag 'semiautomatic) |
2510 (not complex)) | |
2511 (and (or (eq checkdoc-autofix-flag 'query) complex) | |
2512 (y-or-n-p question))) | |
2513 (save-excursion | |
2514 (goto-char start) | |
2515 ;; On the off chance this is automatic, display | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2516 ;; the question anyway so the user knows what's |
20085 | 2517 ;; going on. |
2518 (if checkdoc-bouncy-flag (message "%s -> done" question)) | |
2519 (delete-region start end) | |
2520 (insert replacewith) | |
2521 (if checkdoc-bouncy-flag (sit-for 0)) | |
2522 (setq ret t))) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2523 (checkdoc-delete-overlay o) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2524 (set-match-data md)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2525 (checkdoc-delete-overlay o) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2526 (set-match-data md)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2527 (if (eq checkdoc-autofix-flag 'automatic-then-never) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2528 (setq checkdoc-autofix-flag 'never)) |
20085 | 2529 ret))) |
2530 | |
2531 ;;; Warning management | |
2532 ;; | |
2533 (defvar checkdoc-output-font-lock-keywords | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2534 '(("\\(\\w+\\.el\\): \\(\\w+\\)" |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2535 (1 font-lock-function-name-face) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2536 (2 font-lock-comment-face)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2537 ("^\\(\\w+\\.el\\):" 1 font-lock-function-name-face) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2538 (":\\([0-9]+\\):" 1 font-lock-constant-face)) |
20085 | 2539 "Keywords used to highlight a checkdoc diagnostic buffer.") |
2540 | |
2541 (defvar checkdoc-output-mode-map nil | |
2542 "Keymap used in `checkdoc-output-mode'.") | |
2543 | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2544 (defvar checkdoc-pending-errors nil |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2545 "Non-nil when there are errors that have not been displayed yet.") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2546 |
20085 | 2547 (if checkdoc-output-mode-map |
2548 nil | |
2549 (setq checkdoc-output-mode-map (make-sparse-keymap)) | |
2550 (if (not (string-match "XEmacs" emacs-version)) | |
2551 (define-key checkdoc-output-mode-map [mouse-2] | |
2552 'checkdoc-find-error-mouse)) | |
2553 (define-key checkdoc-output-mode-map "\C-c\C-c" 'checkdoc-find-error) | |
2554 (define-key checkdoc-output-mode-map "\C-m" 'checkdoc-find-error)) | |
2555 | |
2556 (defun checkdoc-output-mode () | |
2557 "Create and setup the buffer used to maintain checkdoc warnings. | |
2558 \\<checkdoc-output-mode-map>\\[checkdoc-find-error] - Go to this error location | |
2559 \\[checkdoc-find-error-mouse] - Goto the error clicked on." | |
2560 (if (get-buffer checkdoc-diagnostic-buffer) | |
2561 (get-buffer checkdoc-diagnostic-buffer) | |
2562 (save-excursion | |
2563 (set-buffer (get-buffer-create checkdoc-diagnostic-buffer)) | |
2564 (kill-all-local-variables) | |
2565 (setq mode-name "Checkdoc" | |
2566 major-mode 'checkdoc-output-mode) | |
2567 (set (make-local-variable 'font-lock-defaults) | |
2568 '((checkdoc-output-font-lock-keywords) t t ((?- . "w") (?_ . "w")))) | |
2569 (use-local-map checkdoc-output-mode-map) | |
2570 (run-hooks 'checkdoc-output-mode-hook) | |
2571 (current-buffer)))) | |
2572 | |
2573 (defun checkdoc-find-error-mouse (e) | |
2574 ;; checkdoc-params: (e) | |
2575 "Call `checkdoc-find-error' where the user clicks the mouse." | |
2576 (interactive "e") | |
2577 (mouse-set-point e) | |
2578 (checkdoc-find-error)) | |
2579 | |
2580 (defun checkdoc-find-error () | |
2581 "In a checkdoc diagnostic buffer, find the error under point." | |
2582 (interactive) | |
2583 (beginning-of-line) | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2584 (if (looking-at "\\(\\(\\w+\\|\\s_\\)+\\.el\\):\\([0-9]+\\):") |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2585 (let ((l (string-to-int (match-string 3))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2586 (f (match-string 1))) |
20085 | 2587 (if (not (get-buffer f)) |
2588 (error "Can't find buffer %s" f)) | |
2589 (switch-to-buffer-other-window (get-buffer f)) | |
2590 (goto-line l)))) | |
2591 | |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2592 (defun checkdoc-buffer-label () |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2593 "The name to use for a checkdoc buffer in the error list." |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2594 (if (buffer-file-name) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2595 (file-name-nondirectory (buffer-file-name)) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2596 (concat "#<buffer "(buffer-name) ">"))) |
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2597 |
20085 | 2598 (defun checkdoc-start-section (check-type) |
2599 "Initialize the checkdoc diagnostic buffer for a pass. | |
2600 Create the header so that the string CHECK-TYPE is displayed as the | |
2601 function called to create the messages." | |
2602 (checkdoc-output-to-error-buffer | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2603 "\n\n\C-l\n*** " |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2604 (checkdoc-buffer-label) ": " check-type " V " checkdoc-version)) |
20085 | 2605 |
2606 (defun checkdoc-error (point msg) | |
2607 "Store POINT and MSG as errors in the checkdoc diagnostic buffer." | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2608 (setq checkdoc-pending-errors t) |
20085 | 2609 (checkdoc-output-to-error-buffer |
23192
1ea9db09a678
(checkdoc-buffer-label): New function.
Eric M. Ludlam <zappo@gnu.org>
parents:
22674
diff
changeset
|
2610 "\n" (checkdoc-buffer-label) ":" |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2611 (int-to-string (count-lines (point-min) (or point 1))) ": " |
20085 | 2612 msg)) |
2613 | |
2614 (defun checkdoc-output-to-error-buffer (&rest text) | |
2615 "Place TEXT into the checkdoc diagnostic buffer." | |
2616 (save-excursion | |
2617 (set-buffer (checkdoc-output-mode)) | |
2618 (goto-char (point-max)) | |
2619 (apply 'insert text))) | |
2620 | |
2621 (defun checkdoc-show-diagnostics () | |
2622 "Display the checkdoc diagnostic buffer in a temporary window." | |
22674
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2623 (if checkdoc-pending-errors |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2624 (let ((b (get-buffer checkdoc-diagnostic-buffer))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2625 (if b (progn (pop-to-buffer b) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2626 (goto-char (point-max)) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2627 (re-search-backward "\C-l" nil t) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2628 (beginning-of-line) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2629 (forward-line 1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2630 (recenter 0))) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2631 (other-window -1) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2632 (setq checkdoc-pending-errors nil) |
f72e7540940a
(checkdoc): Updated commentary.
Eric M. Ludlam <zappo@gnu.org>
parents:
22579
diff
changeset
|
2633 nil))) |
20085 | 2634 |
2635 (defgroup checkdoc nil | |
22195 | 2636 "Support for doc string checking in Emacs Lisp." |
20085 | 2637 :prefix "checkdoc" |
21651
86fcccceba7b
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21181
diff
changeset
|
2638 :group 'lisp |
86fcccceba7b
*** empty log message ***
Dan Nicolaescu <done@ece.arizona.edu>
parents:
21181
diff
changeset
|
2639 :version "20.3") |
20085 | 2640 |
2641 (custom-add-option 'emacs-lisp-mode-hook | |
2642 (lambda () (checkdoc-minor-mode 1))) | |
2643 | |
33495
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
2644 (add-to-list 'debug-ignored-errors |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
2645 "Argument `.*' should appear (as .*) in the doc string") |
07c7cb89c236
(checkdoc-minor-mode) <defvar>: Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27444
diff
changeset
|
2646 |
20085 | 2647 (provide 'checkdoc) |
22195 | 2648 |
20085 | 2649 ;;; checkdoc.el ends here |