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