Commit | Line | Data |
---|---|---|
30b7c745 RS |
1 | ;;; supercite.el --- minor mode for citing mail and news replies |
2 | ||
f2e3589a | 3 | ;; Copyright (C) 1993, 1997, 2001, 2002, 2003, 2004, |
d7a0267c | 4 | ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
dcb38be8 | 5 | |
5231aacb | 6 | ;; Author: 1993 Barry A. Warsaw <bwarsaw@python.org> |
aff88519 | 7 | ;; Maintainer: Glenn Morris <rgm@gnu.org> |
30b7c745 | 8 | ;; Created: February 1993 |
30b7c745 | 9 | ;; Last Modified: 1993/09/22 18:58:46 |
b7f66977 | 10 | ;; Keywords: mail, news |
30b7c745 RS |
11 | |
12 | ;; supercite.el revision: 3.54 | |
13 | ||
30b7c745 RS |
14 | ;; This file is part of GNU Emacs. |
15 | ||
16 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
17 | ;; it under the terms of the GNU General Public License as published by | |
ceaeecb0 | 18 | ;; the Free Software Foundation; either version 3, or (at your option) |
30b7c745 RS |
19 | ;; any later version. |
20 | ||
21 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
22 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
23 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
24 | ;; GNU General Public License for more details. | |
25 | ||
26 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 27 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
3a35cf56 LK |
28 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
29 | ;; Boston, MA 02110-1301, USA. | |
30b7c745 RS |
30 | |
31 | ;; LCD Archive Entry | |
6923dac3 | 32 | ;; supercite|Barry A. Warsaw|supercite-help@python.org |
30b7c745 RS |
33 | ;; |Mail and news reply citation package |
34 | ;; |1993/09/22 18:58:46|3.1| | |
35 | ||
e8af40ee PJ |
36 | ;;; Commentary: |
37 | ||
38 | ;;; Code: | |
30b7c745 RS |
39 | |
40 | \f | |
41 | (require 'regi) | |
48ad0947 | 42 | (require 'sendmail) ;; For mail-header-end. |
30b7c745 RS |
43 | |
44 | ;; start user configuration variables | |
45 | ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv | |
46 | ||
e38eebc2 | 47 | (defgroup supercite nil |
434a76a2 | 48 | "Supercite package." |
e38eebc2 RS |
49 | :prefix "sc-" |
50 | :group 'mail | |
51 | :group 'news) | |
52 | ||
53 | (defgroup supercite-frames nil | |
434a76a2 | 54 | "Supercite (regi) frames." |
e38eebc2 RS |
55 | :prefix "sc-" |
56 | :group 'supercite) | |
57 | ||
58 | (defgroup supercite-attr nil | |
434a76a2 | 59 | "Supercite attributions." |
e38eebc2 RS |
60 | :prefix "sc-" |
61 | :group 'supercite) | |
62 | ||
63 | (defgroup supercite-cite nil | |
434a76a2 | 64 | "Supercite citings." |
e38eebc2 RS |
65 | :prefix "sc-" |
66 | :group 'supercite) | |
67 | ||
68 | (defgroup supercite-hooks nil | |
434a76a2 | 69 | "Hooking into supercite." |
e38eebc2 RS |
70 | :prefix "sc-" |
71 | :group 'supercite) | |
72 | ||
73 | (defcustom sc-auto-fill-region-p t | |
74 | "*If non-nil, automatically fill each paragraph after it has been cited." | |
75 | :type 'boolean | |
76 | :group 'supercite) | |
77 | ||
78 | (defcustom sc-blank-lines-after-headers 1 | |
30b7c745 | 79 | "*Number of blank lines to leave after mail headers have been nuked. |
e38eebc2 RS |
80 | Set to nil, to use whatever blank lines happen to occur naturally." |
81 | :type '(choice (const :tag "leave" nil) | |
82 | integer) | |
83 | :group 'supercite) | |
84 | ||
85 | (defcustom sc-citation-leader " " | |
86 | "*String comprising first part of a citation." | |
87 | :type 'string | |
88 | :group 'supercite-cite) | |
30b7c745 | 89 | |
e38eebc2 | 90 | (defcustom sc-citation-delimiter ">" |
30b7c745 | 91 | "*String comprising third part of a citation. |
e38eebc2 RS |
92 | This string is used in both nested and non-nested citations." |
93 | :type 'string | |
94 | :group 'supercite-cite) | |
95 | ||
96 | (defcustom sc-citation-separator " " | |
97 | "*String comprising fourth and last part of a citation." | |
98 | :type 'string | |
99 | :group 'supercite-cite) | |
30b7c745 | 100 | |
e38eebc2 | 101 | (defcustom sc-citation-leader-regexp "[ \t]*" |
30b7c745 | 102 | "*Regexp describing citation leader for a cited line. |
e38eebc2 RS |
103 | This should NOT have a leading `^' character." |
104 | :type 'regexp | |
105 | :group 'supercite-cite) | |
30b7c745 RS |
106 | |
107 | ;; Nemacs and Mule users note: please see the texinfo manual for | |
108 | ;; suggestions on setting these variables. | |
82db7fdf | 109 | (defcustom sc-citation-root-regexp "[-._[:alnum:]]*" |
30b7c745 RS |
110 | "*Regexp describing variable root part of a citation for a cited line. |
111 | This should NOT have a leading `^' character. See also | |
e38eebc2 RS |
112 | `sc-citation-nonnested-root-regexp'." |
113 | :type 'regexp | |
114 | :group 'supercite-cite) | |
115 | ||
82db7fdf | 116 | (defcustom sc-citation-nonnested-root-regexp "[-._[:alnum:]]+" |
30b7c745 RS |
117 | "*Regexp describing the variable root part of a nested citation. |
118 | This should NOT have a leading `^' character. This variable is | |
80f16257 | 119 | related to `sc-citation-root-regexp' but whereas that variable |
30b7c745 | 120 | describes both nested and non-nested citation roots, this variable |
e38eebc2 RS |
121 | describes only nested citation roots." |
122 | :type 'regexp | |
123 | :group 'supercite-cite) | |
124 | ||
125 | (defcustom sc-citation-delimiter-regexp "[>]+" | |
30b7c745 | 126 | "*Regexp describing citation delimiter for a cited line. |
e38eebc2 RS |
127 | This should NOT have a leading `^' character." |
128 | :type 'regexp | |
129 | :group 'supercite-cite) | |
130 | ||
131 | (defcustom sc-citation-separator-regexp "[ \t]*" | |
30b7c745 | 132 | "*Regexp describing citation separator for a cited line. |
e38eebc2 RS |
133 | This should NOT have a leading `^' character." |
134 | :type 'regexp | |
135 | :group 'supercite-cite) | |
30b7c745 | 136 | |
e38eebc2 RS |
137 | (defcustom sc-cite-blank-lines-p nil |
138 | "*If non-nil, put a citation on blank lines." | |
139 | :type 'boolean | |
140 | :group 'supercite-cite) | |
30b7c745 | 141 | |
e38eebc2 | 142 | (defcustom sc-cite-frame-alist '() |
30b7c745 RS |
143 | "*Alist for frame selection during citing. |
144 | Each element of this list has the following form: | |
30b7c745 RS |
145 | (INFOKEY ((REGEXP . FRAME) |
146 | (REGEXP . FRAME) | |
147 | (...))) | |
148 | ||
149 | Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular | |
37d8fcc2 JL |
150 | expression to match against the INFOKEY's value. FRAME is |
151 | a citation frame, or a symbol that represents the name of | |
152 | a variable whose value is a citation frame." | |
e38eebc2 RS |
153 | :type '(repeat (list symbol (repeat (cons regexp |
154 | (choice (repeat (repeat sexp)) | |
155 | symbol))))) | |
156 | :group 'supercite-frames) | |
22458c33 | 157 | (put 'sc-cite-frame-alist 'risky-local-variable t) |
e38eebc2 RS |
158 | |
159 | (defcustom sc-uncite-frame-alist '() | |
30b7c745 | 160 | "*Alist for frame selection during unciting. |
e38eebc2 RS |
161 | See the variable `sc-cite-frame-alist' for details." |
162 | :type '(repeat (list symbol (repeat (cons regexp | |
163 | (choice (repeat (repeat sexp)) | |
164 | symbol))))) | |
165 | :group 'supercite-frames) | |
22458c33 | 166 | (put 'sc-uncite-frame-alist 'risky-local-variable t) |
e38eebc2 RS |
167 | |
168 | (defcustom sc-recite-frame-alist '() | |
30b7c745 | 169 | "*Alist for frame selection during reciting. |
e38eebc2 RS |
170 | See the variable `sc-cite-frame-alist' for details." |
171 | :type '(repeat (list symbol (repeat (cons regexp | |
172 | (choice (repeat (repeat sexp)) | |
173 | symbol))))) | |
174 | :group 'supercite-frames) | |
22458c33 | 175 | (put 'sc-recite-frame-alist 'risky-local-variable t) |
30b7c745 | 176 | |
e38eebc2 | 177 | (defcustom sc-default-cite-frame |
30b7c745 RS |
178 | '(;; initialize fill state and temporary variables when entering |
179 | ;; frame. this makes things run much faster | |
180 | (begin (progn | |
181 | (sc-fill-if-different) | |
182 | (setq sc-tmp-nested-regexp (sc-cite-regexp "") | |
183 | sc-tmp-nonnested-regexp (sc-cite-regexp) | |
184 | sc-tmp-dumb-regexp | |
185 | (concat "\\(" | |
186 | (sc-cite-regexp "") | |
187 | "\\)" | |
188 | (sc-cite-regexp sc-citation-nonnested-root-regexp)) | |
189 | ))) | |
190 | ;; blank lines mean paragraph separators, so fill the last cited | |
191 | ;; paragraph, unless sc-cite-blank-lines-p is non-nil, in which | |
192 | ;; case we treat blank lines just like any other line. | |
193 | ("^[ \t]*$" (if sc-cite-blank-lines-p | |
194 | (sc-cite-line) | |
195 | (sc-fill-if-different ""))) | |
196 | ;; do nothing if looking at a reference tag. make sure that the | |
197 | ;; tag string isn't the empty string since this will match every | |
198 | ;; line. it cannot be nil. | |
199 | (sc-reference-tag-string (if (string= sc-reference-tag-string "") | |
200 | (list 'continue) | |
201 | nil)) | |
202 | ;; this regexp catches nested citations in which the author cited | |
203 | ;; a non-nested citation with a dumb citer. | |
204 | (sc-tmp-dumb-regexp (sc-cite-coerce-dumb-citer)) | |
205 | ;; if we are looking at a nested citation then add a citation level | |
206 | (sc-tmp-nested-regexp (sc-add-citation-level)) | |
207 | ;; if we're looking at a non-nested citation, coerce it to our style | |
208 | (sc-tmp-nonnested-regexp (sc-cite-coerce-cited-line)) | |
209 | ;; we must be looking at an uncited line. if we are in nested | |
210 | ;; citations, just add a citation level | |
211 | (sc-nested-citation-p (sc-add-citation-level)) | |
212 | ;; we're looking at an uncited line and we are in non-nested | |
213 | ;; citations, so cite it with a non-nested citation | |
214 | (t (sc-cite-line)) | |
215 | ;; be sure when we're done that we fill the last cited paragraph. | |
216 | (end (sc-fill-if-different "")) | |
217 | ) | |
e38eebc2 RS |
218 | "*Default REGI frame for citing a region." |
219 | :type '(repeat (repeat sexp)) | |
220 | :group 'supercite-frames) | |
22458c33 | 221 | (put 'sc-default-cite-frame 'risky-local-variable t) |
30b7c745 | 222 | |
e38eebc2 | 223 | (defcustom sc-default-uncite-frame |
30b7c745 RS |
224 | '(;; do nothing on a blank line |
225 | ("^[ \t]*$" nil) | |
226 | ;; if the line is cited, uncite it | |
227 | ((sc-cite-regexp) (sc-uncite-line)) | |
228 | ) | |
e38eebc2 RS |
229 | "*Default REGI frame for unciting a region." |
230 | :type '(repeat (repeat sexp)) | |
231 | :group 'supercite-frames) | |
22458c33 | 232 | (put 'sc-default-uncite-frame 'risky-local-variable t) |
30b7c745 | 233 | |
e38eebc2 | 234 | (defcustom sc-default-recite-frame |
30b7c745 RS |
235 | '(;; initialize fill state when entering frame |
236 | (begin (sc-fill-if-different)) | |
237 | ;; do nothing on a blank line | |
238 | ("^[ \t]*$" nil) | |
239 | ;; if we're looking at a cited line, recite it | |
240 | ((sc-cite-regexp) (sc-recite-line (sc-cite-regexp))) | |
241 | ;; otherwise, the line is uncited, so just cite it | |
242 | (t (sc-cite-line)) | |
243 | ;; be sure when we're done that we fill the last cited paragraph. | |
244 | (end (sc-fill-if-different "")) | |
245 | ) | |
e38eebc2 RS |
246 | "*Default REGI frame for reciting a region." |
247 | :type '(repeat (repeat sexp)) | |
248 | :group 'supercite-frames) | |
22458c33 | 249 | (put 'sc-default-recite-frame 'risky-local-variable t) |
30b7c745 | 250 | |
e38eebc2 | 251 | (defcustom sc-cite-region-limit t |
30b7c745 | 252 | "*This variable controls automatic citation of yanked text. |
0486e05a | 253 | Valid values are: |
30b7c745 RS |
254 | |
255 | non-nil -- cite the entire region, regardless of its size | |
256 | nil -- do not cite the region at all | |
257 | <integer> -- a number indicating the threshold for citation. When | |
258 | the number of lines in the region is greater than this | |
259 | value, a warning message will be printed and the region | |
260 | will not be cited. Lines in region are counted with | |
a1506d29 | 261 | `count-lines'. |
30b7c745 RS |
262 | |
263 | The gathering of attribution information is not affected by the value | |
264 | of this variable. The number of lines in the region is calculated | |
265 | *after* all mail headers are removed. This variable is only consulted | |
e38eebc2 | 266 | during the initial citing via `sc-cite-original'." |
1af20361 AS |
267 | :type '(choice (const :tag "do not cite" nil) |
268 | (integer :tag "citation threshold") | |
269 | (other :tag "always cite" t)) | |
e38eebc2 RS |
270 | :group 'supercite-cite) |
271 | ||
272 | (defcustom sc-confirm-always-p t | |
273 | "*If non-nil, always confirm attribution string before citing text body." | |
274 | :type 'boolean | |
275 | :group 'supercite-attr) | |
276 | ||
277 | (defcustom sc-default-attribution "Anon" | |
278 | "*String used when author's attribution cannot be determined." | |
279 | :type 'string | |
280 | :group 'supercite-attr) | |
281 | (defcustom sc-default-author-name "Anonymous" | |
282 | "*String used when author's name cannot be determined." | |
283 | :type 'string | |
284 | :group 'supercite-attr) | |
285 | (defcustom sc-downcase-p nil | |
286 | "*Non-nil means downcase the attribution and citation strings." | |
287 | :type 'boolean | |
288 | :group 'supercite-attr | |
289 | :group 'supercite-cite) | |
290 | (defcustom sc-electric-circular-p t | |
291 | "*If non-nil, treat electric references as circular." | |
292 | :type 'boolean | |
293 | :group 'supercite-attr) | |
294 | ||
295 | (defcustom sc-electric-mode-hook nil | |
296 | "*Hook for `sc-electric-mode' electric references mode." | |
297 | :type 'hook | |
298 | :group 'supercite-hooks) | |
299 | (defcustom sc-electric-references-p nil | |
300 | "*Use electric references if non-nil." | |
301 | :type 'boolean | |
302 | :group 'supercite) | |
303 | ||
304 | (defcustom sc-fixup-whitespace-p nil | |
305 | "*If non-nil, delete all leading white space before citing." | |
306 | :type 'boolean | |
307 | :group 'supercite) | |
308 | ||
309 | (defcustom sc-load-hook nil | |
310 | "*Hook which gets run once after Supercite loads." | |
311 | :type 'hook | |
312 | :group 'supercite-hooks) | |
313 | (defcustom sc-pre-hook nil | |
314 | "*Hook which gets run before each invocation of `sc-cite-original'." | |
315 | :type 'hook | |
316 | :group 'supercite-hooks) | |
317 | (defcustom sc-post-hook nil | |
318 | "*Hook which gets run after each invocation of `sc-cite-original'." | |
319 | :type 'hook | |
320 | :group 'supercite-hooks) | |
321 | ||
322 | (defcustom sc-mail-warn-if-non-rfc822-p t | |
323 | "*Warn if mail headers don't conform to RFC822." | |
324 | :type 'boolean | |
325 | :group 'supercite-attr) | |
326 | (defcustom sc-mumble "" | |
327 | "*Value returned by `sc-mail-field' if field isn't in mail headers." | |
328 | :type 'string | |
329 | :group 'supercite-attr) | |
330 | ||
331 | (defcustom sc-name-filter-alist | |
30b7c745 RS |
332 | '(("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0) |
333 | ("^\\(Jr\\|Sr\\)[.]?$" . last) | |
334 | ("^ASTS$" . 0) | |
335 | ("^[I]+$" . last)) | |
336 | "*Name list components which are filtered out as noise. | |
337 | This variable contains an association list where each element is of | |
338 | the form: (REGEXP . POSITION). | |
339 | ||
340 | REGEXP is a regular expression which matches the name list component. | |
341 | Match is performed using `string-match'. POSITION is the position in | |
342 | the name list which can match the regular expression, starting at zero | |
343 | for the first element. Use `last' to match the last element in the | |
e38eebc2 RS |
344 | list and `any' to match all elements." |
345 | :type '(repeat (cons regexp (choice (const last) (const any) | |
346 | (integer :tag "position")))) | |
347 | :group 'supercite-attr) | |
30b7c745 | 348 | |
e38eebc2 | 349 | (defcustom sc-nested-citation-p nil |
30b7c745 | 350 | "*Controls whether to use nested or non-nested citation style. |
e38eebc2 RS |
351 | Non-nil uses nested citations, nil uses non-nested citations." |
352 | :type 'boolean | |
353 | :group 'supercite) | |
30b7c745 | 354 | |
e38eebc2 | 355 | (defcustom sc-nuke-mail-headers 'all |
30b7c745 | 356 | "*Controls mail header nuking. |
0486e05a | 357 | Used in conjunction with `sc-nuke-mail-header-list'. Valid values are: |
30b7c745 RS |
358 | |
359 | `all' -- nuke all mail headers | |
360 | `none' -- don't nuke any mail headers | |
361 | `specified' -- nuke headers specified in `sc-nuke-mail-header-list' | |
e38eebc2 RS |
362 | `keep' -- keep headers specified in `sc-nuke-mail-header-list'" |
363 | :type '(choice (const all) (const none) | |
364 | (const specified) (const keep)) | |
365 | :group 'supercite) | |
30b7c745 | 366 | |
e38eebc2 | 367 | (defcustom sc-nuke-mail-header-list nil |
30b7c745 RS |
368 | "*List of mail header regexps to remove or keep in body of reply. |
369 | This list contains regular expressions describing the mail headers to | |
e38eebc2 RS |
370 | keep or nuke, depending on the value of `sc-nuke-mail-headers'." |
371 | :type '(repeat regexp) | |
372 | :group 'supercite) | |
30b7c745 | 373 | |
e38eebc2 | 374 | (defcustom sc-preferred-attribution-list |
30b7c745 RS |
375 | '("sc-lastchoice" "x-attribution" "firstname" "initials" "lastname") |
376 | "*Specifies what to use as the attribution string. | |
377 | Supercite creates a list of possible attributions when it scans the | |
378 | mail headers from the original message. Each attribution choice is | |
379 | associated with a key in an attribution alist. Supercite tries to | |
380 | pick a \"preferred\" attribution by matching the attribution alist | |
381 | keys against the elements in `sc-preferred-attribution-list' in order. | |
382 | The first non-empty string value found is used as the preferred | |
383 | attribution. | |
384 | ||
385 | Note that Supercite now honors the X-Attribution: mail field. If | |
386 | present in the original message, the value of this field should always | |
387 | be used to select the most preferred attribution since it reflects how | |
388 | the original author would like to be distinguished. It should be | |
389 | considered bad taste to put any attribution preference key before | |
390 | \"x-attribution\" in this list, except perhaps for \"sc-lastchoice\" | |
a4e104bf | 391 | \(see below). |
30b7c745 RS |
392 | |
393 | Supercite remembers the last attribution used when reciting an already | |
394 | cited paragraph. This attribution will always be saved with the | |
395 | \"sc-lastchoice\" key, which can be used in this list. Note that the | |
396 | last choice is always reset after every call of `sc-cite-original'. | |
397 | ||
398 | Barring error conditions, the following preferences are always present | |
399 | in the attribution alist: | |
400 | ||
401 | \"emailname\" -- email terminus name | |
402 | \"initials\" -- initials of author | |
403 | \"firstname\" -- first name of author | |
404 | \"lastname\" -- last name of author | |
405 | \"middlename-1\" -- first middle name of author | |
406 | \"middlename-2\" -- second middle name of author | |
407 | ... | |
408 | ||
409 | Middle name indexes can be any positive integer greater than 0, | |
410 | although it is unlikely that many authors will supply more than one | |
411 | middle name, if that many. The string of all middle names is | |
e38eebc2 RS |
412 | associated with the key \"middlenames\"." |
413 | :type '(repeat string) | |
414 | :group 'supercite-attr) | |
30b7c745 | 415 | |
e38eebc2 | 416 | (defcustom sc-attrib-selection-list nil |
30b7c745 RS |
417 | "*An alist for selecting preferred attribution based on mail headers. |
418 | Each element of this list has the following form: | |
419 | ||
420 | (INFOKEY ((REGEXP . ATTRIBUTION) | |
421 | (REGEXP . ATTRIBUTION) | |
422 | (...))) | |
423 | ||
424 | Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular | |
d7df8561 JB |
425 | expression to match against the INFOKEY's value. ATTRIBUTION can be a |
426 | string or a list. If it's a string, then it is the attribution that is | |
30b7c745 RS |
427 | selected by `sc-select-attribution'. If it is a list, it is `eval'd |
428 | and the return value must be a string, which is used as the selected | |
429 | attribution. Note that the variable `sc-preferred-attribution-list' | |
430 | must contain an element of the string \"sc-consult\" for this variable | |
e38eebc2 | 431 | to be consulted during attribution selection." |
98237e7c DL |
432 | :type '(repeat (list string |
433 | (repeat (cons regexp | |
434 | (choice (sexp :tag "List to eval") | |
435 | string))))) | |
e38eebc2 | 436 | :group 'supercite-attr) |
22458c33 | 437 | (put 'sc-attrib-selection-list 'risky-local-variable t) |
e38eebc2 RS |
438 | |
439 | (defcustom sc-attribs-preselect-hook nil | |
440 | "*Hook to run before selecting an attribution." | |
441 | :type 'hook | |
442 | :group 'supercite-attr | |
443 | :group 'supercite-hooks) | |
444 | (defcustom sc-attribs-postselect-hook nil | |
445 | "*Hook to run after selecting an attribution, but before confirmation." | |
446 | :type 'hook | |
447 | :group 'supercite-attr | |
448 | :group 'supercite-hooks) | |
449 | ||
450 | (defcustom sc-pre-cite-hook nil | |
451 | "*Hook to run before citing a region of text." | |
452 | :type 'hook | |
453 | :group 'supercite-cite | |
454 | :group 'supercite-hooks) | |
455 | (defcustom sc-pre-uncite-hook nil | |
456 | "*Hook to run before unciting a region of text." | |
457 | :type 'hook | |
458 | :group 'supercite-cite | |
459 | :group 'supercite-hooks) | |
460 | (defcustom sc-pre-recite-hook nil | |
461 | "*Hook to run before reciting a region of text." | |
462 | :type 'hook | |
463 | :group 'supercite-cite | |
464 | :group 'supercite-hooks) | |
465 | ||
466 | (defcustom sc-preferred-header-style 4 | |
30b7c745 | 467 | "*Index into `sc-rewrite-header-list' specifying preferred header style. |
e38eebc2 RS |
468 | Index zero accesses the first function in the list." |
469 | :type 'integer | |
470 | :group 'supercite) | |
30b7c745 | 471 | |
e38eebc2 RS |
472 | (defcustom sc-reference-tag-string ">>>>> " |
473 | "*String used at the beginning of built-in reference headers." | |
474 | :type 'string | |
475 | :group 'supercite) | |
30b7c745 | 476 | |
e38eebc2 | 477 | (defcustom sc-rewrite-header-list |
30b7c745 RS |
478 | '((sc-no-header) |
479 | (sc-header-on-said) | |
480 | (sc-header-inarticle-writes) | |
481 | (sc-header-regarding-adds) | |
482 | (sc-header-attributed-writes) | |
483 | (sc-header-author-writes) | |
484 | (sc-header-verbose) | |
485 | (sc-no-blank-line-or-header) | |
486 | ) | |
487 | "*List of reference header rewrite functions. | |
488 | The variable `sc-preferred-header-style' controls which function in | |
489 | this list is chosen for automatic reference header insertions. | |
e38eebc2 RS |
490 | Electric reference mode will cycle through this list of functions." |
491 | :type '(repeat sexp) | |
492 | :group 'supercite) | |
22458c33 | 493 | (put 'sc-rewrite-header-list 'risky-local-variable t) |
30b7c745 | 494 | |
e38eebc2 | 495 | (defcustom sc-titlecue-regexp "\\s +-+\\s +" |
30b7c745 | 496 | "*Regular expression describing the separator between names and titles. |
e38eebc2 RS |
497 | Set to nil to treat entire field as a name." |
498 | :type '(choice (const :tag "entire field as name" nil) | |
499 | regexp) | |
500 | :group 'supercite-attr) | |
30b7c745 | 501 | |
e38eebc2 | 502 | (defcustom sc-use-only-preference-p nil |
30b7c745 RS |
503 | "*Controls what happens when the preferred attribution cannot be found. |
504 | If non-nil, then `sc-default-attribution' will be used. If nil, then | |
505 | some secondary scheme will be employed to find a suitable attribution | |
e38eebc2 RS |
506 | string." |
507 | :type 'boolean | |
508 | :group 'supercite-attr) | |
30b7c745 RS |
509 | |
510 | ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
511 | ;; end user configuration variables | |
512 | \f | |
513 | (defconst sc-version "3.1" | |
514 | "Supercite version number.") | |
fedfa856 | 515 | (defconst sc-help-address "bug-supercite@gnu.org" |
30b7c745 RS |
516 | "Address accepting submissions of bug reports.") |
517 | ||
518 | (defvar sc-mail-info nil | |
519 | "Alist of mail header information gleaned from reply buffer.") | |
520 | (defvar sc-attributions nil | |
521 | "Alist of attributions for use when citing.") | |
522 | ||
30b7c745 | 523 | (defvar sc-tmp-nested-regexp nil |
d49b7f88 | 524 | "Temporary regexp describing nested citations.") |
30b7c745 RS |
525 | (defvar sc-tmp-nonnested-regexp nil |
526 | "Temporary regexp describing non-nested citations.") | |
527 | (defvar sc-tmp-dumb-regexp nil | |
528 | "Temp regexp describing non-nested citation cited with a nesting citer.") | |
529 | ||
30b7c745 RS |
530 | (make-variable-buffer-local 'sc-mail-info) |
531 | (make-variable-buffer-local 'sc-attributions) | |
30b7c745 RS |
532 | |
533 | \f | |
534 | ;; ====================================================================== | |
535 | ;; supercite keymaps | |
536 | ||
537 | (defvar sc-mode-map-prefix "\C-c\C-p" | |
538 | "*Key binding to install Supercite keymap. | |
539 | If this is nil, Supercite keymap is not installed.") | |
540 | ||
d49b7f88 SM |
541 | (defvar sc-T-keymap |
542 | (let ((map (make-sparse-keymap))) | |
543 | (define-key map "a" 'sc-S-preferred-attribution-list) | |
544 | (define-key map "b" 'sc-T-mail-nuke-blank-lines) | |
545 | (define-key map "c" 'sc-T-confirm-always) | |
546 | (define-key map "d" 'sc-T-downcase) | |
547 | (define-key map "e" 'sc-T-electric-references) | |
548 | (define-key map "f" 'sc-T-auto-fill-region) | |
549 | (define-key map "h" 'sc-T-describe) | |
550 | (define-key map "l" 'sc-S-cite-region-limit) | |
551 | (define-key map "n" 'sc-S-mail-nuke-mail-headers) | |
552 | (define-key map "N" 'sc-S-mail-header-nuke-list) | |
553 | (define-key map "o" 'sc-T-electric-circular) | |
554 | (define-key map "p" 'sc-S-preferred-header-style) | |
555 | (define-key map "s" 'sc-T-nested-citation) | |
556 | (define-key map "u" 'sc-T-use-only-preferences) | |
557 | (define-key map "w" 'sc-T-fixup-whitespace) | |
558 | (define-key map "?" 'sc-T-describe) | |
559 | map) | |
30b7c745 | 560 | "Keymap for sub-keymap of setting and toggling functions.") |
d49b7f88 SM |
561 | |
562 | (defvar sc-mode-map | |
563 | (let ((map (make-sparse-keymap))) | |
564 | (define-key map "c" 'sc-cite-region) | |
565 | (define-key map "f" 'sc-mail-field-query) | |
566 | (define-key map "g" 'sc-mail-process-headers) | |
567 | (define-key map "h" 'sc-describe) | |
568 | (define-key map "i" 'sc-insert-citation) | |
569 | (define-key map "o" 'sc-open-line) | |
570 | (define-key map "r" 'sc-recite-region) | |
571 | (define-key map "\C-p" 'sc-raw-mode-toggle) | |
572 | (define-key map "u" 'sc-uncite-region) | |
573 | (define-key map "v" 'sc-version) | |
574 | (define-key map "w" 'sc-insert-reference) | |
575 | (define-key map "\C-t" sc-T-keymap) | |
576 | (define-key map "\C-b" 'sc-submit-bug-report) | |
577 | (define-key map "?" 'sc-describe) | |
578 | map) | |
30b7c745 | 579 | "Keymap for Supercite quasi-mode.") |
d49b7f88 SM |
580 | |
581 | (defvar sc-electric-mode-map | |
582 | (let ((map (make-sparse-keymap))) | |
583 | (define-key map "p" 'sc-eref-prev) | |
584 | (define-key map "n" 'sc-eref-next) | |
585 | (define-key map "s" 'sc-eref-setn) | |
586 | (define-key map "j" 'sc-eref-jump) | |
587 | (define-key map "x" 'sc-eref-abort) | |
588 | (define-key map "q" 'sc-eref-abort) | |
589 | (define-key map "\r" 'sc-eref-exit) | |
590 | (define-key map "\n" 'sc-eref-exit) | |
591 | (define-key map "g" 'sc-eref-goto) | |
592 | (define-key map "?" 'describe-mode) | |
593 | (define-key map "\C-h" 'describe-mode) | |
594 | (define-key map [f1] 'describe-mode) | |
595 | (define-key map [help] 'describe-mode) | |
596 | map) | |
30b7c745 | 597 | "Keymap for `sc-electric-mode' electric references mode.") |
d49b7f88 SM |
598 | |
599 | ||
600 | (defvar sc-minibuffer-local-completion-map | |
601 | (let ((map (copy-keymap minibuffer-local-completion-map))) | |
602 | (define-key map "\C-t" 'sc-toggle-fn) | |
603 | (define-key map " " 'self-insert-command) | |
604 | map) | |
30b7c745 | 605 | "Keymap for minibuffer confirmation of attribution strings.") |
d49b7f88 SM |
606 | |
607 | (defvar sc-minibuffer-local-map | |
608 | (let ((map (copy-keymap minibuffer-local-map))) | |
609 | (define-key map "\C-t" 'sc-toggle-fn) | |
610 | map) | |
30b7c745 | 611 | "Keymap for minibuffer confirmation of attribution strings.") |
30b7c745 RS |
612 | |
613 | \f | |
614 | ;; ====================================================================== | |
615 | ;; utility functions | |
616 | ||
30b7c745 RS |
617 | (defun sc-ask (alist) |
618 | "Ask a question in the minibuffer requiring a single character answer. | |
619 | This function is kind of an extension of `y-or-n-p' where a single | |
620 | letter is used to answer a question. Question is formed from ALIST | |
621 | which has members of the form: (WORD . LETTER). WORD is the long | |
622 | word form, while LETTER is the letter for selecting that answer. The | |
623 | selected letter is returned, or nil if the question was not answered. | |
624 | Note that WORD is a string and LETTER is a character. All LETTERs in | |
625 | the list should be unique." | |
626 | (let* ((prompt (concat | |
627 | (mapconcat (function (lambda (elt) (car elt))) alist ", ") | |
628 | "? (" | |
629 | (mapconcat | |
630 | (function | |
631 | (lambda (elt) (char-to-string (cdr elt)))) alist "/") | |
632 | ") ")) | |
633 | (p prompt) | |
634 | (event | |
d49b7f88 | 635 | (if (fboundp 'allocate-event) |
30b7c745 RS |
636 | (allocate-event) |
637 | nil))) | |
638 | (while (stringp p) | |
639 | (if (let ((cursor-in-echo-area t) | |
640 | (inhibit-quit t)) | |
641 | (message "%s" p) | |
d49b7f88 | 642 | (setq event (read-event)) |
30b7c745 RS |
643 | (prog1 quit-flag (setq quit-flag nil))) |
644 | (progn | |
645 | (message "%s%s" p (single-key-description event)) | |
1eb6c5b8 RS |
646 | (if (fboundp 'deallocate-event) |
647 | (deallocate-event event)) | |
30b7c745 RS |
648 | (setq quit-flag nil) |
649 | (signal 'quit '()))) | |
650 | (let ((char | |
d49b7f88 | 651 | (if (featurep 'xemacs) |
30b7c745 RS |
652 | (let* ((key (and (key-press-event-p event) (event-key event))) |
653 | (char (and key (event-to-character event)))) | |
654 | char) | |
655 | event)) | |
656 | elt) | |
657 | (if char (setq char (downcase char))) | |
658 | (cond | |
659 | ((setq elt (rassq char alist)) | |
660 | (message "%s%s" p (car elt)) | |
661 | (setq p (cdr elt))) | |
1eb6c5b8 RS |
662 | ((if (fboundp 'button-release-event-p) |
663 | (button-release-event-p event)) ; ignore them | |
30b7c745 RS |
664 | nil) |
665 | (t | |
666 | (message "%s%s" p (single-key-description event)) | |
d49b7f88 | 667 | (if (featurep 'xemacs) |
30b7c745 RS |
668 | (ding nil 'y-or-n-p) |
669 | (ding)) | |
670 | (discard-input) | |
671 | (if (eq p prompt) | |
672 | (setq p (concat "Try again. " prompt))))))) | |
1eb6c5b8 RS |
673 | (if (fboundp 'deallocate-event) |
674 | (deallocate-event event)) | |
30b7c745 RS |
675 | p)) |
676 | ||
677 | (defun sc-scan-info-alist (alist) | |
678 | "Find a match in the info alist that matches a regexp in ALIST." | |
679 | (let ((sc-mumble "") | |
680 | rtnvalue) | |
681 | (while alist | |
682 | (let* ((elem (car alist)) | |
683 | (infokey (car elem)) | |
684 | (infoval (sc-mail-field infokey)) | |
685 | (mlist (car (cdr elem)))) | |
686 | (while mlist | |
687 | (let* ((ml-elem (car mlist)) | |
688 | (regexp (car ml-elem)) | |
689 | (thing (cdr ml-elem))) | |
690 | (if (string-match regexp infoval) | |
691 | ;; we found a match, time to return | |
98237e7c | 692 | (setq rtnvalue thing |
30b7c745 RS |
693 | mlist nil |
694 | alist nil) | |
695 | ;; else we didn't find a match | |
696 | (setq mlist (cdr mlist)) | |
697 | ))) ;end of mlist loop | |
698 | (setq alist (cdr alist)) | |
699 | )) ;end of alist loop | |
700 | rtnvalue)) | |
701 | ||
702 | \f | |
703 | ;; ====================================================================== | |
704 | ;; extract mail field information from headers in reply buffer | |
705 | ||
706 | ;; holder variables for bc happiness | |
707 | (defvar sc-mail-headers-start nil | |
708 | "Start of header fields.") | |
709 | (defvar sc-mail-headers-end nil | |
710 | "End of header fields.") | |
711 | (defvar sc-mail-field-history nil | |
712 | "For minibuffer completion on mail field queries.") | |
713 | (defvar sc-mail-field-modification-history nil | |
714 | "For minibuffer completion on mail field modifications.") | |
715 | (defvar sc-mail-glom-frame | |
716 | '((begin (setq sc-mail-headers-start (point))) | |
717 | ("^x-attribution:[ \t]+.*$" (sc-mail-fetch-field t) nil t) | |
718 | ("^\\S +:.*$" (sc-mail-fetch-field) nil t) | |
719 | ("^$" (list 'abort '(step . 0))) | |
720 | ("^[ \t]+" (sc-mail-append-field)) | |
721 | (sc-mail-warn-if-non-rfc822-p (sc-mail-error-in-mail-field)) | |
722 | (end (setq sc-mail-headers-end (point)))) | |
723 | "Regi frame for glomming mail header information.") | |
c4f7f786 | 724 | (put 'sc-mail-glom-frame 'risky-local-variable t) |
30b7c745 | 725 | |
d49b7f88 | 726 | (defvar curline) ; dynamic bondage |
82db7fdf | 727 | |
30b7c745 RS |
728 | ;; regi functions |
729 | (defun sc-mail-fetch-field (&optional attribs-p) | |
730 | "Insert a key and value into `sc-mail-info' alist. | |
731 | If optional ATTRIBS-P is non-nil, the key/value pair is placed in | |
732 | `sc-attributions' too." | |
733 | (if (string-match "^\\(\\S *\\)\\s *:\\s +\\(.*\\)$" curline) | |
d49b7f88 SM |
734 | (let* ((key (downcase (match-string-no-properties 1 curline))) |
735 | (val (match-string-no-properties 2 curline)) | |
30b7c745 | 736 | (keyval (cons key val))) |
d49b7f88 | 737 | (push keyval sc-mail-info) |
30b7c745 | 738 | (if attribs-p |
d49b7f88 | 739 | (push keyval sc-attributions)))) |
30b7c745 RS |
740 | nil) |
741 | ||
742 | (defun sc-mail-append-field () | |
743 | "Append a continuation line onto the last fetched mail field's info." | |
744 | (let ((keyval (car sc-mail-info))) | |
745 | (if (and keyval (string-match "^\\s *\\(.*\\)$" curline)) | |
4a3393e4 | 746 | (setcdr keyval (concat (cdr keyval) " " |
d49b7f88 | 747 | (match-string-no-properties 1 curline))))) |
30b7c745 RS |
748 | nil) |
749 | ||
750 | (defun sc-mail-error-in-mail-field () | |
751 | "Issue warning that mail headers don't conform to RFC 822." | |
752 | (let* ((len (min (length curline) 10)) | |
753 | (ellipsis (if (< len (length curline)) "..." "")) | |
754 | (msg "Mail header \"%s%s\" doesn't conform to RFC 822. skipping...")) | |
755 | (message msg (substring curline 0 len) ellipsis)) | |
756 | (beep) | |
757 | (sit-for 2) | |
758 | nil) | |
759 | ||
760 | ;; mail header nuking | |
761 | (defvar sc-mail-last-header-nuked-p nil | |
762 | "True if the last header was nuked.") | |
763 | ||
764 | (defun sc-mail-nuke-line () | |
765 | "Nuke the current mail header line." | |
d49b7f88 | 766 | (delete-region (line-beginning-position) (line-beginning-position 2)) |
30b7c745 RS |
767 | '((step . -1))) |
768 | ||
769 | (defun sc-mail-nuke-header-line () | |
770 | "Delete current-line and set up for possible continuation." | |
771 | (setq sc-mail-last-header-nuked-p t) | |
772 | (sc-mail-nuke-line)) | |
773 | ||
774 | (defun sc-mail-nuke-continuation-line () | |
775 | "Delete a continuation line if the last header line was deleted." | |
776 | (if sc-mail-last-header-nuked-p | |
777 | (sc-mail-nuke-line))) | |
778 | ||
779 | (defun sc-mail-cleanup-blank-lines () | |
780 | "Leave some blank lines after original mail headers are nuked. | |
781 | The number of lines left is specified by `sc-blank-lines-after-headers'." | |
782 | (if sc-blank-lines-after-headers | |
783 | (save-restriction | |
784 | (widen) | |
785 | (skip-chars-backward " \t\n") | |
786 | (forward-line 1) | |
787 | (delete-blank-lines) | |
788 | (beginning-of-line) | |
789 | (if (looking-at "[ \t]*$") | |
d49b7f88 SM |
790 | (delete-region (line-beginning-position) |
791 | (line-beginning-position 2))) | |
30b7c745 RS |
792 | (insert-char ?\n sc-blank-lines-after-headers))) |
793 | nil) | |
794 | ||
795 | (defun sc-mail-build-nuke-frame () | |
796 | "Build the regiframe for nuking mail headers." | |
797 | (let (every-func entry-func nonentry-func) | |
798 | (cond | |
799 | ((eq sc-nuke-mail-headers 'all) | |
800 | (setq every-func '(progn (forward-line -1) (sc-mail-nuke-line)))) | |
801 | ((eq sc-nuke-mail-headers 'specified) | |
802 | (setq entry-func '(sc-mail-nuke-header-line) | |
803 | nonentry-func '(setq sc-mail-last-header-nuked-p nil))) | |
804 | ((eq sc-nuke-mail-headers 'keep) | |
805 | (setq entry-func '(setq sc-mail-last-header-nuked-p nil) | |
806 | nonentry-func '(sc-mail-nuke-header-line))) | |
807 | ;; we never get far enough to interpret a frame if s-n-m-h == 'none | |
808 | ((eq sc-nuke-mail-headers 'none)) | |
9d034245 | 809 | (t (error "Invalid value for sc-nuke-mail-headers: %s" |
30b7c745 RS |
810 | sc-nuke-mail-headers)) |
811 | ) ; end-cond | |
812 | (append | |
813 | (and entry-func | |
814 | (regi-mapcar sc-nuke-mail-header-list entry-func nil t)) | |
815 | (and nonentry-func (list (list "^\\S +:.*$" nonentry-func))) | |
816 | (and (not every-func) | |
817 | '(("^[ \t]+" (sc-mail-nuke-continuation-line)))) | |
818 | '((begin (setq sc-mail-last-header-zapped-p nil))) | |
819 | '((end (sc-mail-cleanup-blank-lines))) | |
820 | (and every-func (list (list 'every every-func))) | |
821 | ))) | |
822 | ||
823 | ;; mail processing and zapping. this is the top level entry defun to | |
824 | ;; all header processing. | |
825 | (defun sc-mail-process-headers (start end) | |
826 | "Process original mail message's mail headers. | |
827 | After processing, mail headers may be nuked. Header information is | |
828 | stored in `sc-mail-info', and any old information is lost unless an | |
829 | error occurs." | |
830 | (interactive "r") | |
831 | (let ((info (copy-alist sc-mail-info)) | |
832 | (attribs (copy-alist sc-attributions))) | |
833 | (setq sc-mail-info nil | |
834 | sc-attributions nil) | |
835 | (regi-interpret sc-mail-glom-frame start end) | |
836 | (if (null sc-mail-info) | |
837 | (progn | |
838 | (message "No mail headers found! Restoring old information.") | |
839 | (setq sc-mail-info info | |
840 | sc-attributions attribs)) | |
841 | (regi-interpret (sc-mail-build-nuke-frame) | |
842 | sc-mail-headers-start sc-mail-headers-end) | |
843 | ))) | |
844 | ||
845 | \f | |
846 | ;; let the user change mail field information | |
847 | (defun sc-mail-field (field) | |
848 | "Return the mail header field value associated with FIELD. | |
849 | If there was no mail header with FIELD as its key, return the value of | |
850 | `sc-mumble'. FIELD is case insensitive." | |
caf3c78f | 851 | (or (cdr (assoc-string field sc-mail-info 'case-fold)) sc-mumble)) |
30b7c745 RS |
852 | |
853 | (defun sc-mail-field-query (arg) | |
854 | "View the value of a mail field. | |
855 | With `\\[universal-argument]', prompts for action on mail field. | |
856 | Action can be one of: View, Modify, Add, or Delete." | |
857 | (interactive "P") | |
858 | (let* ((alist '(("view" . ?v) ("modify" . ?m) ("add" . ?a) ("delete" . ?d))) | |
859 | (action (if (not arg) ?v (sc-ask alist))) | |
860 | key) | |
861 | (if (not action) | |
862 | () | |
d49b7f88 | 863 | (setq key (completing-read |
30b7c745 RS |
864 | (concat (car (rassq action alist)) |
865 | " information key: ") | |
866 | sc-mail-info nil | |
867 | (if (eq action ?a) nil 'noexit) | |
868 | nil 'sc-mail-field-history)) | |
869 | (cond | |
870 | ((eq action ?v) | |
871 | (message "%s: %s" key (cdr (assoc key sc-mail-info)))) | |
872 | ((eq action ?d) | |
873 | (setq sc-mail-info (delq (assoc key sc-mail-info) sc-mail-info))) | |
874 | ((eq action ?m) | |
875 | (let ((keyval (assoc key sc-mail-info))) | |
876 | ;; first put initial value onto list if not already there | |
d49b7f88 SM |
877 | (if (not (member (cdr keyval) |
878 | sc-mail-field-modification-history)) | |
30b7c745 RS |
879 | (setq sc-mail-field-modification-history |
880 | (cons (cdr keyval) sc-mail-field-modification-history))) | |
d49b7f88 | 881 | (setcdr keyval (read-string |
30b7c745 RS |
882 | (concat key ": ") (cdr keyval) |
883 | 'sc-mail-field-modification-history)))) | |
884 | ((eq action ?a) | |
d49b7f88 | 885 | (push (cons key (read-string (concat key ": "))) sc-mail-info)) |
30b7c745 RS |
886 | )))) |
887 | ||
888 | \f | |
889 | ;; ====================================================================== | |
890 | ;; attributions | |
891 | ||
892 | (defvar sc-attribution-confirmation-history nil | |
893 | "History for confirmation of attribution strings.") | |
894 | (defvar sc-citation-confirmation-history nil | |
895 | "History for confirmation of attribution prefixes.") | |
896 | ||
897 | (defun sc-attribs-%@-addresses (from &optional delim) | |
898 | "Extract the author's email terminus from email address FROM. | |
899 | Match addresses of the style ``name%[stuff].'' when called with DELIM | |
900 | of \"%\" and addresses of the style ``[stuff]name@[stuff]'' when | |
901 | called with DELIM \"@\". If DELIM is nil or not provided, matches | |
902 | addresses of the style ``name''." | |
d49b7f88 | 903 | (and (string-match (concat "[-[:alnum:]_.]+" delim) from 0) |
30b7c745 RS |
904 | (substring from |
905 | (match-beginning 0) | |
906 | (- (match-end 0) (if (null delim) 0 1))))) | |
907 | ||
908 | (defun sc-attribs-!-addresses (from) | |
909 | "Extract the author's email terminus from email address FROM. | |
910 | Match addresses of the style ``[stuff]![stuff]...!name[stuff].''" | |
911 | (let ((eos (length from)) | |
d49b7f88 | 912 | (mstart (string-match "![-[:alnum:]_.]+\\([^-![:alnum:]_.]\\|$\\)" |
30b7c745 RS |
913 | from 0)) |
914 | (mend (match-end 0))) | |
915 | (and mstart | |
916 | (substring from (1+ mstart) (- mend (if (= mend eos) 0 1))) | |
917 | ))) | |
918 | ||
919 | (defun sc-attribs-<>-addresses (from) | |
920 | "Extract the author's email terminus from email address FROM. | |
921 | Match addresses of the style ``<name[stuff]>.''" | |
922 | (and (string-match "<\\(.*\\)>" from) | |
d49b7f88 | 923 | (match-string 1 from))) |
30b7c745 RS |
924 | |
925 | (defun sc-get-address (from author) | |
926 | "Get the full email address path from FROM. | |
927 | AUTHOR is the author's name (which is removed from the address)." | |
928 | (let ((eos (length from))) | |
caf3c78f SM |
929 | (if (string-match (concat "\\`\"?" (regexp-quote author) |
930 | "\"?\\s +") from 0) | |
30b7c745 RS |
931 | (let ((address (substring from (match-end 0) eos))) |
932 | (if (and (= (aref address 0) ?<) | |
933 | (= (aref address (1- (length address))) ?>)) | |
934 | (substring address 1 (1- (length address))) | |
935 | address)) | |
82db7fdf | 936 | (if (string-match "[-[:alnum:]!@%._]+" from 0) |
d49b7f88 | 937 | (match-string 0 from) |
30b7c745 RS |
938 | "") |
939 | ))) | |
940 | ||
941 | (defun sc-attribs-emailname (from) | |
942 | "Get the email terminus name from FROM." | |
943 | (or | |
944 | (sc-attribs-%@-addresses from "%") | |
945 | (sc-attribs-%@-addresses from "@") | |
946 | (sc-attribs-!-addresses from) | |
947 | (sc-attribs-<>-addresses from) | |
948 | (sc-attribs-%@-addresses from) | |
949 | (substring from 0 10))) | |
950 | ||
951 | (defun sc-name-substring (string start end extend) | |
952 | "Extract the specified substring of STRING from START to END. | |
953 | EXTEND is the number of characters on each side to extend the | |
954 | substring." | |
955 | (and start | |
956 | (let ((sos (+ start extend)) | |
957 | (eos (- end extend))) | |
958 | (substring string sos | |
959 | (or (string-match sc-titlecue-regexp string sos) eos) | |
960 | )))) | |
961 | ||
962 | (defun sc-attribs-extract-namestring (from) | |
963 | "Extract the name string from FROM. | |
964 | This should be the author's full name minus an optional title." | |
d49b7f88 | 965 | ;; FIXME: we probably should use mail-extract-address-components. |
30b7c745 RS |
966 | (let ((namestring |
967 | (or | |
dcb38be8 RS |
968 | ;; If there is a <...> in the name, |
969 | ;; treat everything before that as the full name. | |
970 | ;; Even if it contains parens, use the whole thing. | |
f42dc896 | 971 | ;; On the other hand, we do look for quotes in the usual way. |
dcb38be8 | 972 | (and (string-match " *<.*>" from 0) |
f42dc896 KH |
973 | (let ((before-angles |
974 | (sc-name-substring from 0 (match-beginning 0) 0))) | |
975 | (if (string-match "\".*\"" before-angles 0) | |
976 | (sc-name-substring | |
977 | before-angles (match-beginning 0) (match-end 0) 1) | |
978 | before-angles))) | |
30b7c745 RS |
979 | (sc-name-substring |
980 | from (string-match "(.*)" from 0) (match-end 0) 1) | |
981 | (sc-name-substring | |
982 | from (string-match "\".*\"" from 0) (match-end 0) 1) | |
983 | (sc-name-substring | |
82db7fdf | 984 | from (string-match "\\([-.[:alnum:]_]+\\s +\\)+<" from 0) |
30b7c745 RS |
985 | (match-end 1) 0) |
986 | (sc-attribs-emailname from)))) | |
987 | ;; strip off any leading or trailing whitespace | |
988 | (if namestring | |
989 | (let ((bos 0) | |
990 | (eos (1- (length namestring)))) | |
991 | (while (and (<= bos eos) | |
992 | (memq (aref namestring bos) '(32 ?\t))) | |
993 | (setq bos (1+ bos))) | |
994 | (while (and (> eos bos) | |
995 | (memq (aref namestring eos) '(32 ?\t))) | |
996 | (setq eos (1- eos))) | |
997 | (substring namestring bos (1+ eos)))))) | |
998 | ||
999 | (defun sc-attribs-chop-namestring (namestring) | |
1000 | "Convert NAMESTRING to a list of names. | |
d49b7f88 | 1001 | example: (sc-attribs-chop-namestring \"John Xavier Doe\") |
30b7c745 RS |
1002 | => (\"John\" \"Xavier\" \"Doe\")" |
1003 | (if (string-match "\\([ \t]*\\)\\([^ \t._]+\\)\\([ \t]*\\)" namestring) | |
d49b7f88 | 1004 | (cons (match-string 2 namestring) |
30b7c745 RS |
1005 | (sc-attribs-chop-namestring (substring namestring (match-end 3))) |
1006 | ))) | |
1007 | ||
1008 | (defun sc-attribs-strip-initials (namelist) | |
1009 | "Extract the author's initials from the NAMELIST." | |
1010 | (mapconcat | |
1011 | (function | |
1012 | (lambda (name) | |
1013 | (if (< 0 (length name)) | |
1014 | (substring name 0 1)))) | |
1015 | namelist "")) | |
1016 | ||
1017 | (defun sc-guess-attribution (&optional string) | |
1018 | "Guess attribution string on current line. | |
1019 | If attribution cannot be guessed, nil is returned. Optional STRING if | |
1020 | supplied, is used instead of the line point is on in the current buffer." | |
1021 | (let ((start 0) | |
d49b7f88 SM |
1022 | (string (or string (buffer-substring (line-beginning-position) |
1023 | (line-end-position)))) | |
30b7c745 RS |
1024 | attribution) |
1025 | (and | |
1026 | (= start (or (string-match sc-citation-leader-regexp string start) -1)) | |
1027 | (setq start (match-end 0)) | |
1028 | (= start (or (string-match sc-citation-root-regexp string start) 1)) | |
d49b7f88 | 1029 | (setq attribution (match-string 0 string) |
30b7c745 RS |
1030 | start (match-end 0)) |
1031 | (= start (or (string-match sc-citation-delimiter-regexp string start) -1)) | |
1032 | (setq start (match-end 0)) | |
1033 | (= start (or (string-match sc-citation-separator-regexp string start) -1)) | |
1034 | attribution))) | |
1035 | ||
1036 | (defun sc-attribs-filter-namelist (namelist) | |
1037 | "Filter out noise in NAMELIST according to `sc-name-filter-alist'." | |
1038 | (let ((elements (length namelist)) | |
1039 | (position -1) | |
1040 | keepers filtered-list) | |
804edf03 | 1041 | (mapc |
30b7c745 RS |
1042 | (function |
1043 | (lambda (name) | |
1044 | (setq position (1+ position)) | |
1045 | (let ((keep-p t)) | |
804edf03 | 1046 | (mapc |
30b7c745 RS |
1047 | (function |
1048 | (lambda (filter) | |
1049 | (let ((regexp (car filter)) | |
1050 | (pos (cdr filter))) | |
1051 | (if (and (string-match regexp name) | |
1052 | (or (and (numberp pos) | |
1053 | (= pos position)) | |
1054 | (and (eq pos 'last) | |
1055 | (= position (1- elements))) | |
1056 | (eq pos 'any))) | |
1057 | (setq keep-p nil)) | |
1058 | ))) | |
1059 | sc-name-filter-alist) | |
1060 | (if keep-p | |
1061 | (setq keepers (cons position keepers))) | |
1062 | ))) | |
1063 | namelist) | |
804edf03 | 1064 | (mapc |
30b7c745 RS |
1065 | (function |
1066 | (lambda (position) | |
1067 | (setq filtered-list (cons (nth position namelist) filtered-list)) | |
1068 | )) | |
1069 | keepers) | |
1070 | filtered-list)) | |
1071 | ||
1072 | (defun sc-attribs-chop-address (from) | |
1073 | "Extract attribution information from FROM. | |
1074 | This populates the `sc-attributions' with the list of possible attributions." | |
1075 | (if (and (stringp from) | |
1076 | (< 0 (length from))) | |
a1506d29 | 1077 | (let* ((sc-mumble "") |
30b7c745 RS |
1078 | (namestring (sc-attribs-extract-namestring from)) |
1079 | (namelist (sc-attribs-filter-namelist | |
1080 | (sc-attribs-chop-namestring namestring))) | |
1081 | (revnames (reverse (cdr namelist))) | |
1082 | (firstname (car namelist)) | |
1083 | (midnames (reverse (cdr revnames))) | |
1084 | (lastname (car revnames)) | |
1085 | (initials (sc-attribs-strip-initials namelist)) | |
1086 | (emailname (sc-attribs-emailname from)) | |
1087 | (n 1) | |
1088 | author middlenames) | |
a1506d29 | 1089 | |
30b7c745 RS |
1090 | ;; put basic information |
1091 | (setq | |
1092 | ;; put middle names and build sc-author entry | |
1093 | middlenames (mapconcat | |
1094 | (function | |
1095 | (lambda (midname) | |
1096 | (let ((key-attribs (format "middlename-%d" n)) | |
1097 | (key-mail (format "sc-middlename-%d" n))) | |
d49b7f88 SM |
1098 | (push (cons key-attribs midname) sc-attributions) |
1099 | (push (cons key-mail midname) sc-mail-info) | |
1100 | (setq n (1+ n)) | |
30b7c745 RS |
1101 | midname))) |
1102 | midnames " ") | |
1103 | ||
1104 | author (concat firstname " " middlenames (and midnames " ") lastname) | |
1105 | ||
1106 | sc-attributions (append | |
1107 | (list | |
1108 | (cons "firstname" firstname) | |
1109 | (cons "lastname" lastname) | |
1110 | (cons "emailname" emailname) | |
1111 | (cons "initials" initials)) | |
1112 | sc-attributions) | |
1113 | sc-mail-info (append | |
1114 | (list | |
1115 | (cons "sc-firstname" firstname) | |
1116 | (cons "sc-middlenames" middlenames) | |
1117 | (cons "sc-lastname" lastname) | |
1118 | (cons "sc-emailname" emailname) | |
1119 | (cons "sc-initials" initials) | |
1120 | (cons "sc-author" author) | |
1121 | (cons "sc-from-address" (sc-get-address | |
1122 | (sc-mail-field "from") | |
1123 | namestring)) | |
1124 | (cons "sc-reply-address" (sc-get-address | |
1125 | (sc-mail-field "reply-to") | |
1126 | namestring)) | |
1127 | (cons "sc-sender-address" (sc-get-address | |
1128 | (sc-mail-field "sender") | |
1129 | namestring)) | |
1130 | ) | |
1131 | sc-mail-info) | |
1132 | )) | |
1133 | ;; from string is empty | |
d49b7f88 | 1134 | (push (cons "sc-author" sc-default-author-name) sc-mail-info))) |
30b7c745 RS |
1135 | |
1136 | (defvar sc-attrib-or-cite nil | |
1137 | "Used to toggle between attribution input or citation input.") | |
1138 | ||
1139 | (defun sc-toggle-fn () | |
1140 | "Toggle between attribution selection and citation selection. | |
1141 | Only used during confirmation." | |
1142 | (interactive) | |
1143 | (setq sc-attrib-or-cite (not sc-attrib-or-cite)) | |
1144 | (throw 'sc-reconfirm t)) | |
1145 | ||
1146 | (defun sc-select-attribution () | |
1147 | "Select an attribution from `sc-attributions'. | |
1148 | ||
1149 | Variables involved in selection process include: | |
1150 | `sc-preferred-attribution-list' | |
1151 | `sc-use-only-preference-p' | |
1152 | `sc-confirm-always-p' | |
1153 | `sc-default-attribution' | |
1154 | `sc-attrib-selection-list'. | |
1155 | ||
1156 | Runs the hook `sc-attribs-preselect-hook' before selecting an | |
1157 | attribution and the hook `sc-attribs-postselect-hook' after making the | |
1158 | selection but before querying is performed. During | |
1159 | `sc-attribs-postselect-hook' the variable `citation' is bound to the | |
1160 | auto-selected citation string and the variable `attribution' is bound | |
1161 | to the auto-selected attribution string." | |
1162 | (run-hooks 'sc-attribs-preselect-hook) | |
1163 | (let ((query-p sc-confirm-always-p) | |
1164 | attribution citation | |
1165 | (attriblist sc-preferred-attribution-list)) | |
1166 | ||
1167 | ;; first cruise through sc-preferred-attribution-list looking for | |
1168 | ;; a match in either sc-attributions or sc-mail-info. if the | |
1169 | ;; element is "sc-consult", then we have to do the alist | |
1170 | ;; consultation phase | |
1171 | (while attriblist | |
1172 | (let* ((preferred (car attriblist))) | |
1173 | (cond | |
1174 | ((string= preferred "sc-consult") | |
1175 | ;; we've been told to consult the attribution vs. mail | |
1176 | ;; header key alist. we do this until we find a match in | |
1177 | ;; the sc-attrib-selection-list. if we do not find a match, | |
1178 | ;; we continue scanning attriblist | |
1179 | (let ((attrib (sc-scan-info-alist sc-attrib-selection-list))) | |
1180 | (cond | |
1181 | ((not attrib) | |
1182 | (setq attriblist (cdr attriblist))) | |
1183 | ((stringp attrib) | |
1184 | (setq attribution attrib | |
1185 | attriblist nil)) | |
1186 | ((listp attrib) | |
9c6760b6 GM |
1187 | (setq attribution (eval attrib)) |
1188 | (if (stringp attribution) | |
1189 | (setq attriblist nil) | |
1190 | (setq attribution nil | |
1191 | attriblist (cdr attriblist)))) | |
30b7c745 RS |
1192 | (t (error "%s did not evaluate to a string or list!" |
1193 | "sc-attrib-selection-list")) | |
1194 | ))) | |
1195 | ((setq attribution (cdr (assoc preferred sc-attributions))) | |
1196 | (setq attriblist nil)) | |
1197 | (t | |
1198 | (setq attriblist (cdr attriblist))) | |
1199 | ))) | |
1200 | ||
1201 | ;; if preference was not found, we may use a secondary method to | |
1202 | ;; find a valid attribution | |
1203 | (if (and (not attribution) | |
1204 | (not sc-use-only-preference-p)) | |
1205 | ;; secondary method tries to find a preference in this order | |
1206 | ;; 1. sc-lastchoice | |
1207 | ;; 2. x-attribution | |
1208 | ;; 3. firstname | |
1209 | ;; 4. lastname | |
1210 | ;; 5. initials | |
1211 | ;; 6. first non-empty attribution in alist | |
1212 | (setq attribution | |
1213 | (or (cdr (assoc "sc-lastchoice" sc-attributions)) | |
1214 | (cdr (assoc "x-attribution" sc-attributions)) | |
1215 | (cdr (assoc "firstname" sc-attributions)) | |
1216 | (cdr (assoc "lastname" sc-attributions)) | |
1217 | (cdr (assoc "initials" sc-attributions)) | |
1218 | (cdr (car sc-attributions))))) | |
1219 | ||
1220 | ;; still couldn't find an attribution. we're now limited to using | |
1221 | ;; the default attribution, but we'll force a query when this happens | |
1222 | (if (not attribution) | |
1223 | (setq attribution sc-default-attribution | |
1224 | query-p t)) | |
1225 | ||
1226 | ;; create the attribution prefix | |
1227 | (setq citation (sc-make-citation attribution)) | |
1228 | ||
1229 | ;; run the post selection hook before querying the user | |
1230 | (run-hooks 'sc-attribs-postselect-hook) | |
1231 | ||
1232 | ;; query for confirmation | |
1233 | (if query-p | |
1234 | (let* ((query-alist (mapcar (function (lambda (entry) | |
1235 | (list (cdr entry)))) | |
1236 | sc-attributions)) | |
1237 | (minibuffer-local-completion-map | |
1238 | sc-minibuffer-local-completion-map) | |
1239 | (minibuffer-local-map sc-minibuffer-local-map) | |
1240 | (initial attribution) | |
1241 | (completer-disable t) ; in case completer.el is used | |
1242 | choice) | |
1243 | (setq sc-attrib-or-cite nil) ; nil==attribution, t==citation | |
1244 | (while | |
1245 | (catch 'sc-reconfirm | |
f67acc8d RS |
1246 | (progn |
1247 | (setq choice | |
1248 | (if sc-attrib-or-cite | |
d49b7f88 | 1249 | (read-string |
f67acc8d RS |
1250 | "Enter citation prefix: " |
1251 | citation | |
1252 | 'sc-citation-confirmation-history) | |
d49b7f88 | 1253 | (completing-read |
f67acc8d RS |
1254 | "Complete attribution name: " |
1255 | query-alist nil nil | |
1256 | (cons initial 0) | |
1257 | 'sc-attribution-confirmation-history) | |
1258 | )) | |
1259 | nil))) | |
30b7c745 RS |
1260 | (if sc-attrib-or-cite |
1261 | ;; since the citation was chosen, we have to guess at | |
1262 | ;; the attribution | |
1263 | (setq citation choice | |
1264 | attribution (or (sc-guess-attribution citation) | |
1265 | citation)) | |
a1506d29 | 1266 | |
30b7c745 RS |
1267 | (setq citation (sc-make-citation choice) |
1268 | attribution choice)) | |
1269 | )) | |
1270 | ||
1271 | ;; its possible that the user wants to downcase the citation and | |
1272 | ;; attribution | |
1273 | (if sc-downcase-p | |
1274 | (setq citation (downcase citation) | |
1275 | attribution (downcase attribution))) | |
1276 | ||
1277 | ;; set up mail info alist | |
1278 | (let* ((ckey "sc-citation") | |
1279 | (akey "sc-attribution") | |
1280 | (ckeyval (assoc ckey sc-mail-info)) | |
1281 | (akeyval (assoc akey sc-mail-info))) | |
1282 | (if ckeyval | |
1283 | (setcdr ckeyval citation) | |
d49b7f88 | 1284 | (push (cons ckey citation) sc-mail-info)) |
30b7c745 RS |
1285 | (if akeyval |
1286 | (setcdr akeyval attribution) | |
d49b7f88 | 1287 | (push (cons akey attribution) sc-mail-info))) |
30b7c745 RS |
1288 | |
1289 | ;; set the sc-lastchoice attribution | |
1290 | (let* ((lkey "sc-lastchoice") | |
1291 | (lastchoice (assoc lkey sc-attributions))) | |
1292 | (if lastchoice | |
1293 | (setcdr lastchoice attribution) | |
d49b7f88 | 1294 | (push (cons lkey attribution) sc-attributions))) |
30b7c745 RS |
1295 | )) |
1296 | ||
1297 | \f | |
1298 | ;; ====================================================================== | |
1299 | ;; filladapt hooks for supercite 3.1. you shouldn't need anything | |
1300 | ;; extra to make gin-mode understand supercited lines. Even this | |
1301 | ;; stuff might not be entirely necessary... | |
1302 | ||
1303 | (defun sc-cite-regexp (&optional root-regexp) | |
1304 | "Return a regexp describing a Supercited line. | |
1305 | The regexp is the concatenation of `sc-citation-leader-regexp', | |
1306 | `sc-citation-root-regexp', `sc-citation-delimiter-regexp', and | |
1307 | `sc-citation-separator-regexp'. If optional ROOT-REGEXP is supplied, | |
1308 | use it instead of `sc-citation-root-regexp'." | |
1309 | (concat sc-citation-leader-regexp | |
1310 | (or root-regexp sc-citation-root-regexp) | |
1311 | sc-citation-delimiter-regexp | |
1312 | sc-citation-separator-regexp)) | |
1313 | ||
1314 | (defun sc-make-citation (attribution) | |
1315 | "Make a non-nested citation from ATTRIBUTION." | |
1316 | (concat sc-citation-leader | |
1317 | attribution | |
1318 | sc-citation-delimiter | |
1319 | sc-citation-separator)) | |
1320 | ||
4703062c RS |
1321 | (defvar filladapt-prefix-table) |
1322 | ||
30b7c745 RS |
1323 | (defun sc-setup-filladapt () |
1324 | "Setup `filladapt-prefix-table' to handle Supercited paragraphs." | |
1325 | (let* ((fa-sc-elt 'filladapt-supercite-included-text) | |
1326 | (elt (rassq fa-sc-elt filladapt-prefix-table))) | |
1327 | (if elt (setcar elt (sc-cite-regexp)) | |
1328 | (message "Filladapt doesn't seem to know about Supercite.") | |
1329 | (beep)))) | |
1330 | ||
1331 | \f | |
1332 | ;; ====================================================================== | |
1333 | ;; citing and unciting regions of text | |
1334 | ||
1335 | (defvar sc-fill-begin 1 | |
1336 | "Buffer position to begin filling.") | |
1337 | (defvar sc-fill-line-prefix "" | |
1338 | "Fill prefix of previous line") | |
1339 | ||
1340 | ;; filling | |
1341 | (defun sc-fill-if-different (&optional prefix) | |
1342 | "Fill the region bounded by `sc-fill-begin' and point. | |
1343 | Only fill if optional PREFIX is different than `sc-fill-line-prefix'. | |
1344 | If `sc-auto-fill-region-p' is nil, do not fill region. If PREFIX is | |
1345 | not supplied, initialize fill variables. This is useful for a regi | |
1346 | `begin' frame-entry." | |
1347 | (if (not prefix) | |
1348 | (setq sc-fill-line-prefix "" | |
d49b7f88 | 1349 | sc-fill-begin (line-beginning-position)) |
30b7c745 RS |
1350 | (if (and sc-auto-fill-region-p |
1351 | (not (string= prefix sc-fill-line-prefix))) | |
1352 | (let ((fill-prefix sc-fill-line-prefix)) | |
1353 | (if (not (string= fill-prefix "")) | |
d49b7f88 | 1354 | (fill-region sc-fill-begin (line-beginning-position))) |
30b7c745 | 1355 | (setq sc-fill-line-prefix prefix |
d49b7f88 | 1356 | sc-fill-begin (line-beginning-position)))) |
30b7c745 RS |
1357 | ) |
1358 | nil) | |
1359 | ||
1360 | (defun sc-cite-coerce-cited-line () | |
1361 | "Coerce a Supercited line to look like our style." | |
1362 | (let* ((attribution (sc-guess-attribution)) | |
1363 | (regexp (sc-cite-regexp attribution)) | |
1364 | (prefix (sc-make-citation attribution))) | |
1365 | (if (and attribution | |
1366 | (looking-at regexp)) | |
1367 | (progn | |
1368 | (delete-region | |
1369 | (match-beginning 0) | |
1370 | (save-excursion | |
1371 | (goto-char (match-end 0)) | |
1372 | (if (bolp) (forward-char -1)) | |
1373 | (point))) | |
1374 | (insert prefix) | |
1375 | (sc-fill-if-different prefix))) | |
1376 | nil)) | |
1377 | ||
1378 | (defun sc-cite-coerce-dumb-citer () | |
1379 | "Coerce a non-nested citation that's been cited with a dumb nesting citer." | |
1380 | (delete-region (match-beginning 1) (match-end 1)) | |
1381 | (beginning-of-line) | |
1382 | (sc-cite-coerce-cited-line)) | |
1383 | ||
1384 | (defun sc-guess-nesting (&optional string) | |
1385 | "Guess the citation nesting on the current line. | |
1386 | If nesting cannot be guessed, nil is returned. Optional STRING if | |
1387 | supplied, is used instead of the line point is on in the current | |
1388 | buffer." | |
1389 | (let ((start 0) | |
d49b7f88 SM |
1390 | (string (or string (buffer-substring (line-beginning-position) |
1391 | (line-end-position)))) | |
30b7c745 RS |
1392 | nesting) |
1393 | (and | |
1394 | (= start (or (string-match sc-citation-leader-regexp string start) -1)) | |
1395 | (setq start (match-end 0)) | |
1396 | (= start (or (string-match sc-citation-delimiter-regexp string start) -1)) | |
d49b7f88 | 1397 | (setq nesting (match-string 0 string) |
30b7c745 RS |
1398 | start (match-end 0)) |
1399 | (= start (or (string-match sc-citation-separator-regexp string start) -1)) | |
1400 | nesting))) | |
1401 | ||
1402 | (defun sc-add-citation-level () | |
80f16257 | 1403 | "Add a citation level for nested citation style w/ coercion." |
30b7c745 RS |
1404 | (let* ((nesting (sc-guess-nesting)) |
1405 | (citation (make-string (1+ (length nesting)) | |
1406 | (string-to-char sc-citation-delimiter))) | |
1407 | (prefix (concat sc-citation-leader citation sc-citation-separator))) | |
1408 | (if (looking-at (sc-cite-regexp "")) | |
1409 | (delete-region (match-beginning 0) (match-end 0))) | |
1410 | (insert prefix) | |
1411 | (sc-fill-if-different prefix))) | |
1412 | ||
1413 | (defun sc-cite-line (&optional citation) | |
1414 | "Cite a single line of uncited text. | |
1415 | Optional CITATION overrides any citation automatically selected." | |
1416 | (if sc-fixup-whitespace-p | |
1417 | (fixup-whitespace)) | |
1418 | (let ((prefix (or citation | |
1419 | (cdr (assoc "sc-citation" sc-mail-info)) | |
1420 | sc-default-attribution))) | |
1421 | (insert prefix) | |
1422 | (sc-fill-if-different prefix)) | |
1423 | nil) | |
1424 | ||
1425 | (defun sc-uncite-line () | |
1426 | "Remove citation from current line." | |
1427 | (let ((cited (looking-at (sc-cite-regexp)))) | |
1428 | (if cited | |
1429 | (delete-region (match-beginning 0) (match-end 0)))) | |
1430 | nil) | |
1431 | ||
1432 | (defun sc-recite-line (regexp) | |
1433 | "Remove citation matching REGEXP from current line and recite line." | |
1434 | (let ((cited (looking-at (concat "^" regexp))) | |
1435 | (prefix (cdr (assoc "sc-citation" sc-mail-info)))) | |
1436 | (if cited | |
1437 | (delete-region (match-beginning 0) (match-end 0))) | |
1438 | (insert (or prefix sc-default-attribution)) | |
1439 | (sc-fill-if-different prefix)) | |
1440 | nil) | |
1441 | ||
1442 | ;; interactive functions | |
3fc1b264 | 1443 | (defun sc-cite-region (start end &optional confirm-p interactive) |
30b7c745 RS |
1444 | "Cite a region delineated by START and END. |
1445 | If optional CONFIRM-P is non-nil, the attribution is confirmed before | |
1446 | its use in the citation string. This function first runs | |
3fc1b264 RS |
1447 | `sc-pre-cite-hook'. |
1448 | ||
1449 | When called interactively, the optional arg INTERACTIVE is non-nil, | |
1450 | and that means call `sc-select-attribution' too." | |
1451 | (interactive "r\nP\np") | |
30b7c745 | 1452 | (undo-boundary) |
37d8fcc2 | 1453 | (let ((frame (sc-scan-info-alist sc-cite-frame-alist)) |
30b7c745 | 1454 | (sc-confirm-always-p (if confirm-p t sc-confirm-always-p))) |
37d8fcc2 JL |
1455 | (if (and frame (symbolp frame)) |
1456 | (setq frame (symbol-value frame))) | |
1457 | (or frame (setq frame sc-default-cite-frame)) | |
30b7c745 | 1458 | (run-hooks 'sc-pre-cite-hook) |
3fc1b264 | 1459 | (if interactive |
30b7c745 RS |
1460 | (sc-select-attribution)) |
1461 | (regi-interpret frame start end))) | |
1462 | ||
1463 | (defun sc-uncite-region (start end) | |
1464 | "Uncite a region delineated by START and END. | |
1465 | First runs `sc-pre-uncite-hook'." | |
1466 | (interactive "r") | |
1467 | (undo-boundary) | |
37d8fcc2 JL |
1468 | (let ((frame (sc-scan-info-alist sc-uncite-frame-alist))) |
1469 | (if (and frame (symbolp frame)) | |
1470 | (setq frame (symbol-value frame))) | |
1471 | (or frame (setq frame sc-default-uncite-frame)) | |
30b7c745 RS |
1472 | (run-hooks 'sc-pre-uncite-hook) |
1473 | (regi-interpret frame start end))) | |
a1506d29 | 1474 | |
30b7c745 RS |
1475 | (defun sc-recite-region (start end) |
1476 | "Recite a region delineated by START and END. | |
1477 | First runs `sc-pre-recite-hook'." | |
1478 | (interactive "r") | |
1479 | (let ((sc-confirm-always-p t)) | |
1480 | (sc-select-attribution)) | |
1481 | (undo-boundary) | |
37d8fcc2 JL |
1482 | (let ((frame (sc-scan-info-alist sc-recite-frame-alist))) |
1483 | (if (and frame (symbolp frame)) | |
1484 | (setq frame (symbol-value frame))) | |
1485 | (or frame (setq frame sc-default-recite-frame)) | |
30b7c745 RS |
1486 | (run-hooks 'sc-pre-recite-hook) |
1487 | (regi-interpret frame start end))) | |
1488 | ||
1489 | \f | |
1490 | ;; ====================================================================== | |
1491 | ;; building headers | |
1492 | ||
1493 | (defun sc-hdr (prefix field &optional sep return-nil-p) | |
1494 | "Returns a concatenation of PREFIX and FIELD. | |
1495 | If FIELD is not a string or is the empty string, the empty string will | |
1496 | be returned. Optional third argument SEP is concatenated on the end if | |
1497 | it is a string. Returns empty string, unless optional RETURN-NIL-P is | |
1498 | non-nil." | |
1499 | (if (and (stringp field) | |
1500 | (not (string= field ""))) | |
1501 | (concat prefix field (or sep "")) | |
1502 | (and (not return-nil-p) ""))) | |
1503 | ||
1504 | (defun sc-whofrom () | |
1505 | "Return the value of (sc-mail-field \"from\") or nil." | |
1506 | (let ((sc-mumble nil)) | |
1507 | (sc-mail-field "from"))) | |
1508 | ||
1509 | (defun sc-no-header () | |
1510 | "Does nothing. Use this instead of nil to get a blank header." | |
1511 | ()) | |
1512 | ||
1513 | (defun sc-no-blank-line-or-header() | |
80f16257 | 1514 | "Similar to `sc-no-header' except it removes the preceding blank line." |
30b7c745 RS |
1515 | (if (not (bobp)) |
1516 | (if (and (eolp) | |
1517 | (progn (forward-line -1) | |
48ad0947 | 1518 | (or (= (point) (mail-header-end)) |
30b7c745 | 1519 | (and (eq major-mode 'mh-letter-mode) |
1eb6c5b8 RS |
1520 | (with-no-warnings |
1521 | (mh-in-header-p)))))) | |
30b7c745 RS |
1522 | (progn (forward-line) |
1523 | (let ((kill-lines-magic t)) | |
1524 | (kill-line)))))) | |
1525 | ||
1526 | (defun sc-header-on-said () | |
1527 | "\"On <date>, <from> said:\" unless: | |
1528 | 1. the \"from\" field cannot be found, in which case nothing is inserted; | |
1529 | 2. the \"date\" field is missing in which case only the from part is printed." | |
1530 | (let ((sc-mumble "") | |
1531 | (whofrom (sc-whofrom))) | |
1532 | (if whofrom | |
1533 | (insert sc-reference-tag-string | |
1534 | (sc-hdr "On " (sc-mail-field "date") ", ") | |
1535 | whofrom " said:\n")))) | |
1536 | ||
1537 | (defun sc-header-inarticle-writes () | |
1538 | "\"In article <message-id>, <from> writes:\" | |
1539 | Treats \"message-id\" and \"from\" fields similar to `sc-header-on-said'." | |
1540 | (let ((sc-mumble "") | |
1541 | (whofrom (sc-mail-field "from"))) | |
1542 | (if whofrom | |
1543 | (insert sc-reference-tag-string | |
1544 | (sc-hdr "In article " (sc-mail-field "message-id") ", ") | |
1545 | whofrom " writes:\n")))) | |
1546 | ||
1547 | (defun sc-header-regarding-adds () | |
1548 | "\"Regarding <subject>; <from> adds:\" | |
1549 | Treats \"subject\" and \"from\" fields similar to `sc-header-on-said'." | |
1550 | (let ((sc-mumble "") | |
1551 | (whofrom (sc-whofrom))) | |
1552 | (if whofrom | |
1553 | (insert sc-reference-tag-string | |
1554 | (sc-hdr "Regarding " (sc-mail-field "subject") "; ") | |
1555 | whofrom " adds:\n")))) | |
1556 | ||
1557 | (defun sc-header-attributed-writes () | |
1558 | "\"<sc-attribution>\" == <sc-author> <address> writes: | |
1559 | Treats these fields in a similar manner to `sc-header-on-said'." | |
1560 | (let ((sc-mumble "") | |
1561 | (whofrom (sc-whofrom))) | |
1562 | (if whofrom | |
1563 | (insert sc-reference-tag-string | |
1564 | (sc-hdr "\"" (sc-mail-field "sc-attribution") "\" == ") | |
1565 | (sc-hdr "" (sc-mail-field "sc-author") " ") | |
1566 | (or (sc-hdr "<" (sc-mail-field "sc-from-address") ">" t) | |
1567 | (sc-hdr "<" (sc-mail-field "sc-reply-address") ">" t) | |
1568 | "") | |
1569 | " writes:\n")))) | |
1570 | ||
1571 | (defun sc-header-author-writes () | |
1572 | "<sc-author> writes:" | |
1573 | (let ((sc-mumble "") | |
1574 | (whofrom (sc-whofrom))) | |
1575 | (if whofrom | |
1576 | (insert sc-reference-tag-string | |
1577 | (sc-hdr "" (sc-mail-field "sc-author")) | |
1578 | " writes:\n")))) | |
1579 | ||
1580 | (defun sc-header-verbose () | |
1581 | "Very verbose, some say gross." | |
1582 | (let ((sc-mumble "") | |
1583 | (whofrom (sc-whofrom)) | |
1584 | (tag sc-reference-tag-string)) | |
1585 | (if whofrom | |
1586 | (insert (sc-hdr (concat tag "On ") (sc-mail-field "date") ",\n") | |
1587 | (or (sc-hdr tag (sc-mail-field "sc-author") "\n" t) | |
1588 | (concat tag whofrom "\n")) | |
1589 | (sc-hdr (concat tag "from the organization of ") | |
1590 | (sc-mail-field "organization") "\n") | |
1591 | (let ((rtag (concat tag "who can be reached at: "))) | |
1592 | (or (sc-hdr rtag (sc-mail-field "sc-from-address") "\n" t) | |
1593 | (sc-hdr rtag (sc-mail-field "sc-reply-address") "\n" t) | |
1594 | "")) | |
1595 | (sc-hdr | |
1596 | (concat tag "(whose comments are cited below with \"") | |
1597 | (sc-mail-field "sc-citation") "\"),\n") | |
1598 | (sc-hdr (concat tag "had this to say in article ") | |
1599 | (sc-mail-field "message-id") "\n") | |
1600 | (sc-hdr (concat tag "in newsgroups ") | |
1601 | (sc-mail-field "newsgroups") "\n") | |
1602 | (sc-hdr (concat tag "concerning the subject of ") | |
1603 | (sc-mail-field "subject") "\n") | |
1604 | (sc-hdr (concat tag "(see ") | |
1605 | (sc-mail-field "references") | |
1606 | " for more details)\n") | |
1607 | )))) | |
1608 | ||
1609 | \f | |
1610 | ;; ====================================================================== | |
1611 | ;; header rewrites | |
1612 | ||
1613 | (defconst sc-electric-bufname " *sc-erefs* " | |
1614 | "Supercite electric reference mode's buffer name.") | |
1615 | (defvar sc-eref-style 0 | |
1616 | "Current electric reference style.") | |
1617 | ||
1618 | (defun sc-valid-index-p (index) | |
1619 | "Returns INDEX if it is a valid index into `sc-rewrite-header-list'. | |
1620 | Otherwise returns nil." | |
1621 | ;; a number, and greater than or equal to zero | |
1622 | ;; less than or equal to the last index | |
1623 | (and (natnump index) | |
1624 | (< index (length sc-rewrite-header-list)) | |
1625 | index)) | |
1626 | ||
1627 | (defun sc-eref-insert-selected (&optional nomsg) | |
1628 | "Insert the selected reference header in the current buffer. | |
1629 | Optional NOMSG, if non-nil, inhibits printing messages, unless an | |
1630 | error occurs." | |
1631 | (let ((ref (nth sc-eref-style sc-rewrite-header-list))) | |
1632 | (condition-case err | |
1633 | (progn | |
1634 | (eval ref) | |
1635 | (let ((lines (count-lines (point-min) (point-max)))) | |
a1506d29 | 1636 | (or nomsg (message "Ref header %d [%d line%s]: %s" |
30b7c745 RS |
1637 | sc-eref-style lines |
1638 | (if (= lines 1) "" "s") | |
1639 | ref)))) | |
1640 | (void-function | |
1641 | (progn (message | |
1642 | "Symbol's function definition is void: %s (Header %d)" | |
1643 | (car (cdr err)) sc-eref-style) | |
1644 | (beep) | |
1645 | )) | |
1646 | ))) | |
1647 | ||
1648 | (defun sc-electric-mode (&optional arg) | |
1649 | " | |
1650 | Mode for viewing Supercite reference headers. Commands are: | |
1651 | \n\\{sc-electric-mode-map} | |
1652 | ||
1653 | `sc-electric-mode' is not intended to be run interactively, but rather | |
1654 | accessed through Supercite's electric reference feature. See | |
1655 | `sc-insert-reference' for more details. Optional ARG is the initial | |
1656 | header style to use, unless not supplied or invalid, in which case | |
1657 | `sc-preferred-header-style' is used." | |
1658 | ||
1659 | (let ((info sc-mail-info)) | |
1660 | ||
1661 | (setq sc-eref-style | |
1662 | (or (sc-valid-index-p arg) | |
1663 | (sc-valid-index-p sc-preferred-header-style) | |
1664 | 0)) | |
1665 | ||
1666 | (get-buffer-create sc-electric-bufname) | |
1667 | ;; set up buffer and enter command loop | |
1668 | (save-excursion | |
1669 | (save-window-excursion | |
1670 | (pop-to-buffer sc-electric-bufname) | |
1671 | (kill-all-local-variables) | |
1672 | (let ((sc-mail-info info) | |
1673 | (buffer-read-only t) | |
1674 | (mode-name "SC Electric Refs") | |
1675 | (major-mode 'sc-electric-mode)) | |
1676 | (use-local-map sc-electric-mode-map) | |
1677 | (sc-eref-show sc-eref-style) | |
ca11f4a8 | 1678 | (run-mode-hooks 'sc-electric-mode-hook) |
30b7c745 RS |
1679 | (recursive-edit) |
1680 | ))) | |
1681 | ||
1682 | (and sc-eref-style | |
1683 | (sc-eref-insert-selected)) | |
1684 | (kill-buffer sc-electric-bufname) | |
1685 | )) | |
1686 | ||
1687 | ;; functions for electric reference mode | |
1688 | (defun sc-eref-show (index) | |
1689 | "Show reference INDEX in `sc-rewrite-header-list'." | |
1690 | (let ((msg "No %ing reference headers in list.") | |
1691 | (last (length sc-rewrite-header-list))) | |
1692 | (setq sc-eref-style | |
1693 | (cond | |
1694 | ((sc-valid-index-p index) index) | |
1695 | ((< index 0) | |
1696 | (if sc-electric-circular-p | |
1697 | (1- last) | |
1698 | (progn (error msg "preced") 0))) | |
1699 | ((>= index last) | |
1700 | (if sc-electric-circular-p | |
1701 | 0 | |
1702 | (progn (error msg "follow") (1- last)))) | |
1703 | )) | |
1704 | (save-excursion | |
1705 | (set-buffer sc-electric-bufname) | |
1706 | (let ((buffer-read-only nil)) | |
1707 | (erase-buffer) | |
1708 | (goto-char (point-min)) | |
1709 | (sc-eref-insert-selected) | |
1710 | ;; now shrink the window to just contain the electric reference | |
1711 | ;; header. | |
1712 | (let ((hdrlines (count-lines (point-min) (point-max))) | |
1713 | (winlines (1- (window-height)))) | |
1714 | (if (/= hdrlines winlines) | |
1715 | (if (> hdrlines winlines) | |
1716 | ;; we have to enlarge the window | |
1717 | (enlarge-window (- hdrlines winlines)) | |
1718 | ;; we have to shrink the window | |
1719 | (shrink-window (- winlines (max hdrlines window-min-height))) | |
1720 | ))) | |
1721 | )))) | |
1722 | ||
1723 | (defun sc-eref-next () | |
1724 | "Display next reference in other buffer." | |
1725 | (interactive) | |
1726 | (sc-eref-show (1+ sc-eref-style))) | |
1727 | ||
1728 | (defun sc-eref-prev () | |
1729 | "Display previous reference in other buffer." | |
1730 | (interactive) | |
1731 | (sc-eref-show (1- sc-eref-style))) | |
1732 | ||
1733 | (defun sc-eref-setn () | |
1734 | "Set reference header selected as preferred." | |
1735 | (interactive) | |
1736 | (setq sc-preferred-header-style sc-eref-style) | |
1737 | (message "Preferred reference style set to header %d." sc-eref-style)) | |
1738 | ||
1739 | (defun sc-eref-goto (refnum) | |
1740 | "Show reference style indexed by REFNUM. | |
1741 | If REFNUM is an invalid index, don't go to that reference and return | |
1742 | nil." | |
1743 | (interactive "NGoto Reference: ") | |
1744 | (if (sc-valid-index-p refnum) | |
1745 | (sc-eref-show refnum) | |
1746 | (error "Invalid reference: %d. (Range: [%d .. %d])" | |
1747 | refnum 0 (1- (length sc-rewrite-header-list))) | |
1748 | )) | |
1749 | ||
1750 | (defun sc-eref-jump () | |
1751 | "Set reference header to preferred header." | |
1752 | (interactive) | |
1753 | (sc-eref-show sc-preferred-header-style)) | |
1754 | ||
1755 | (defun sc-eref-abort () | |
1756 | "Exit from electric reference mode without inserting reference." | |
1757 | (interactive) | |
1758 | (setq sc-eref-style nil) | |
1759 | (exit-recursive-edit)) | |
1760 | ||
1761 | (defun sc-eref-exit () | |
1762 | "Exit from electric reference mode and insert selected reference." | |
1763 | (interactive) | |
1764 | (exit-recursive-edit)) | |
1765 | ||
1766 | (defun sc-insert-reference (arg) | |
1767 | "Insert, at point, a reference header in the body of the reply. | |
1768 | Numeric ARG indicates which header style from `sc-rewrite-header-list' | |
1769 | to use when rewriting the header. No supplied ARG indicates use of | |
1770 | `sc-preferred-header-style'. | |
1771 | ||
1772 | With just `\\[universal-argument]', electric reference insert mode is | |
1773 | entered, regardless of the value of `sc-electric-references-p'. See | |
1774 | `sc-electric-mode' for more information." | |
1775 | (interactive "P") | |
1776 | (if (consp arg) | |
1777 | (sc-electric-mode) | |
1778 | (let ((preference (or (sc-valid-index-p arg) | |
1779 | (sc-valid-index-p sc-preferred-header-style) | |
1780 | sc-preferred-header-style | |
1781 | 0))) | |
1782 | (if sc-electric-references-p | |
1783 | (sc-electric-mode preference) | |
1784 | (sc-eref-insert-selected t) | |
1785 | )))) | |
1786 | ||
1787 | \f | |
1788 | ;; ====================================================================== | |
1789 | ;; variable toggling | |
1790 | ||
1791 | (defun sc-raw-mode-toggle () | |
1792 | "Toggle, in one fell swoop, two important SC variables: | |
1793 | `sc-fixup-whitespace-p' and `sc-auto-fill-region-p'" | |
1794 | (interactive) | |
1795 | (setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p) | |
1796 | sc-auto-fill-region-p (not sc-auto-fill-region-p)) | |
8d96f9de | 1797 | (force-mode-line-update)) |
30b7c745 RS |
1798 | |
1799 | (defun sc-toggle-var (variable) | |
1800 | "Boolean toggle VARIABLE's value. | |
f0529b5b | 1801 | VARIABLE must be a bound symbol. nil values change to t, non-nil |
30b7c745 RS |
1802 | values are changed to nil." |
1803 | (message "%s changed from %s to %s" | |
1804 | variable (symbol-value variable) | |
d49b7f88 | 1805 | (set variable (not (symbol-value variable))))) |
30b7c745 RS |
1806 | |
1807 | (defun sc-set-variable (var) | |
1808 | "Set the Supercite VARIABLE. | |
1809 | This function mimics `set-variable', except that the variable to set | |
1810 | is determined non-interactively. The value is queried for in the | |
1811 | minibuffer exactly the same way that `set-variable' does it. | |
1812 | ||
1813 | You can see the current value of the variable when the minibuffer is | |
1814 | querying you by typing `C-h'. Note that the format is changed | |
1815 | slightly from that used by `set-variable' -- the current value is | |
1816 | printed just after the variable's name instead of at the bottom of the | |
1817 | help window." | |
d49b7f88 | 1818 | (let* ((minibuffer-help-form '(funcall myhelp)) |
30b7c745 | 1819 | (myhelp |
d49b7f88 SM |
1820 | (lambda () |
1821 | (with-output-to-temp-buffer "*Help*" | |
1822 | (prin1 var) | |
1823 | (if (boundp var) | |
1824 | (let ((print-length 20)) | |
1825 | (princ "\t(Current value: ") | |
1826 | (prin1 (symbol-value var)) | |
1827 | (princ ")"))) | |
1828 | (princ "\n\nDocumentation:\n") | |
1829 | (princ (substring (documentation-property | |
1830 | var | |
1831 | 'variable-documentation) | |
1832 | 1)) | |
1833 | (with-current-buffer standard-output | |
1834 | (help-mode)) | |
1835 | nil)))) | |
1836 | (set var (eval-minibuffer (format "Set %s to value: " var))))) | |
30b7c745 RS |
1837 | |
1838 | (defmacro sc-toggle-symbol (rootname) | |
d49b7f88 SM |
1839 | `(defun ,(intern (concat "sc-T-" rootname)) () |
1840 | (interactive) | |
1841 | (sc-toggle-var ',(intern (concat "sc-" rootname "-p"))))) | |
30b7c745 RS |
1842 | |
1843 | (defmacro sc-setvar-symbol (rootname) | |
d49b7f88 SM |
1844 | `(defun ,(intern (concat "sc-S-" rootname)) () |
1845 | (interactive) | |
1846 | (sc-set-variable ',(intern (concat "sc-" rootname))))) | |
30b7c745 RS |
1847 | |
1848 | (sc-toggle-symbol "confirm-always") | |
1849 | (sc-toggle-symbol "downcase") | |
1850 | (sc-toggle-symbol "electric-references") | |
1851 | (sc-toggle-symbol "auto-fill-region") | |
1852 | (sc-toggle-symbol "mail-nuke-blank-lines") | |
1853 | (sc-toggle-symbol "nested-citation") | |
1854 | (sc-toggle-symbol "electric-circular") | |
1855 | (sc-toggle-symbol "use-only-preferences") | |
1856 | (sc-toggle-symbol "fixup-whitespace") | |
1857 | ||
1858 | (sc-setvar-symbol "preferred-attribution-list") | |
1859 | (sc-setvar-symbol "preferred-header-style") | |
1860 | (sc-setvar-symbol "mail-nuke-mail-headers") | |
1861 | (sc-setvar-symbol "mail-header-nuke-list") | |
1862 | (sc-setvar-symbol "cite-region-limit") | |
1863 | ||
1864 | (defun sc-T-describe () | |
1865 | " | |
1866 | ||
1867 | Supercite provides a number of key bindings which simplify the process | |
1868 | of setting or toggling certain variables controlling its operation. | |
1869 | ||
1870 | Note on function names in this list: all functions of the form | |
1871 | `sc-S-<name>' actually call `sc-set-variable' on the corresponding | |
1872 | `sc-<name>' variable. All functions of the form `sc-T-<name>' call | |
1873 | `sc-toggle-var' on the corresponding `sc-<name>-p' variable. | |
1874 | ||
1875 | \\{sc-T-keymap}" | |
1876 | (interactive) | |
1877 | (describe-function 'sc-T-describe)) | |
1878 | ||
30b7c745 RS |
1879 | \f |
1880 | ;; ====================================================================== | |
1881 | ;; published interface to mail and news readers | |
1882 | ||
d49b7f88 SM |
1883 | (define-minor-mode sc-minor-mode |
1884 | "Supercite minor mode." | |
feb02f95 LK |
1885 | :group 'supercite |
1886 | :lighter (" SC" (sc-auto-fill-region-p | |
1887 | (":f" (sc-fixup-whitespace-p "w")) | |
1888 | (sc-fixup-whitespace-p ":w"))) | |
1889 | :keymap `((,sc-mode-map-prefix . ,sc-mode-map))) | |
d49b7f88 | 1890 | |
80056f3d | 1891 | ;;;###autoload |
30b7c745 RS |
1892 | (defun sc-cite-original () |
1893 | "Workhorse citing function which performs the initial citation. | |
1894 | This is callable from the various mail and news readers' reply | |
d49b7f88 SM |
1895 | function according to the agreed upon standard. See the associated |
1896 | info node `(SC)Top' for more details. | |
1897 | `sc-cite-original' does not do any yanking of the | |
30b7c745 RS |
1898 | original message but it does require a few things: |
1899 | ||
1900 | 1) The reply buffer is the current buffer. | |
1901 | ||
1902 | 2) The original message has been yanked and inserted into the | |
1903 | reply buffer. | |
1904 | ||
1905 | 3) Verbose mail headers from the original message have been | |
1906 | inserted into the reply buffer directly before the text of the | |
1907 | original message. | |
1908 | ||
1909 | 4) Point is at the beginning of the verbose headers. | |
1910 | ||
1911 | 5) Mark is at the end of the body of text to be cited. | |
1912 | ||
1913 | For Emacs 19's, the region need not be active (and typically isn't | |
1914 | when this function is called. Also, the hook `sc-pre-hook' is run | |
1915 | before, and `sc-post-hook' is run after the guts of this function." | |
1916 | (run-hooks 'sc-pre-hook) | |
1917 | ||
d49b7f88 | 1918 | (sc-minor-mode 1) |
30b7c745 RS |
1919 | |
1920 | (undo-boundary) | |
1921 | ||
1922 | ;; grab point and mark since the region is probably not active when | |
1923 | ;; this function gets automatically called. we want point to be a | |
1924 | ;; mark so any deleting before point works properly | |
d49b7f88 | 1925 | (let* ((zmacs-regions nil) ; for XEemacs |
3f66fcdb | 1926 | (mark-active t) ; for Emacs |
30b7c745 RS |
1927 | (point (point-marker)) |
1928 | (mark (copy-marker (mark-marker)))) | |
a1506d29 | 1929 | |
30b7c745 RS |
1930 | ;; make sure point comes before mark, not all functions are |
1931 | ;; interactive "r" | |
1932 | (if (< mark point) | |
1933 | (let ((tmp point)) | |
1934 | (setq point mark | |
1935 | mark tmp))) | |
1936 | ||
1937 | ;; first process mail headers, and populate sc-mail-info | |
1938 | (sc-mail-process-headers point mark) | |
1939 | ||
1940 | ;; now get possible attributions | |
1941 | (sc-attribs-chop-address (or (sc-mail-field "from") | |
1942 | (sc-mail-field "reply") | |
1943 | (sc-mail-field "reply-to") | |
1944 | (sc-mail-field "sender"))) | |
1945 | ;; select the attribution | |
1946 | (sc-select-attribution) | |
1947 | ||
1948 | ;; cite the region, but first check the value of sc-cite-region-limit | |
1949 | (let ((linecnt (count-lines point mark))) | |
1950 | (and sc-cite-region-limit | |
1951 | (if (or (not (numberp sc-cite-region-limit)) | |
1952 | (<= linecnt sc-cite-region-limit)) | |
1953 | (progn | |
1954 | ;; cite the region and insert the header rewrite | |
1955 | (sc-cite-region point mark) | |
1956 | (goto-char point) | |
1957 | (let ((sc-eref-style (or sc-preferred-header-style 0))) | |
1958 | (if sc-electric-references-p | |
1959 | (sc-electric-mode sc-eref-style) | |
1960 | (sc-eref-insert-selected t)))) | |
1961 | (beep) | |
1962 | (message | |
1963 | "Region not cited. %d lines exceeds sc-cite-region-limit: %d" | |
1964 | linecnt sc-cite-region-limit)))) | |
1965 | ||
1966 | ;; finally, free the point-marker | |
1967 | (set-marker point nil) | |
1968 | (set-marker mark nil) | |
1969 | ) | |
d49b7f88 | 1970 | (run-hooks 'sc-post-hook)) |
30b7c745 RS |
1971 | |
1972 | \f | |
1973 | ;; ====================================================================== | |
1974 | ;; bug reporting and miscellaneous commands | |
1975 | ||
1976 | (defun sc-open-line (arg) | |
1977 | "Like `open-line', but insert the citation prefix at the front of the line. | |
1978 | With numeric ARG, inserts that many new lines." | |
1979 | (interactive "p") | |
1980 | (save-excursion | |
1981 | (let ((start (point)) | |
1982 | (prefix (or (progn (beginning-of-line) | |
1983 | (if (looking-at (sc-cite-regexp)) | |
d49b7f88 | 1984 | (match-string 0))) |
30b7c745 RS |
1985 | ""))) |
1986 | (goto-char start) | |
1987 | (open-line arg) | |
1988 | (forward-line 1) | |
1989 | (while (< 0 arg) | |
1990 | (insert prefix) | |
1991 | (forward-line 1) | |
1992 | (setq arg (1- arg)) | |
1993 | )))) | |
1994 | ||
1995 | (defun sc-insert-citation (arg) | |
1996 | "Insert citation string at beginning of current line if not already cited. | |
1997 | With `\\[universal-argument]' insert citation even if line is already | |
1998 | cited." | |
1999 | (interactive "P") | |
2000 | (save-excursion | |
2001 | (beginning-of-line) | |
2002 | (if (or (not (looking-at (sc-cite-regexp))) | |
2003 | (looking-at "^[ \t]*$") | |
2004 | (consp arg)) | |
2005 | (insert (sc-mail-field "sc-citation")) | |
e8af40ee | 2006 | (error "Line is already cited")))) |
30b7c745 | 2007 | |
3fc1b264 | 2008 | (defun sc-version (message) |
30b7c745 | 2009 | "Echo the current version of Supercite in the minibuffer. |
3fc1b264 | 2010 | If MESSAGE is non-nil (interactively, with no prefix argument), |
30b7c745 | 2011 | inserts the version string in the current buffer instead." |
3fc1b264 | 2012 | (interactive (not current-prefix-arg)) |
30b7c745 | 2013 | (let ((verstr (format "Using Supercite.el %s" sc-version))) |
3fc1b264 RS |
2014 | (if message |
2015 | (message verstr) | |
2016 | (insert "`sc-version' says: " verstr)))) | |
30b7c745 RS |
2017 | |
2018 | (defun sc-describe () | |
2019 | " | |
2020 | Supercite is a package which provides a flexible mechanism for citing | |
2021 | email and news replies. Please see the associated texinfo file for | |
d49b7f88 | 2022 | more information. Info node `(SC)Top'." |
30b7c745 RS |
2023 | (interactive) |
2024 | (describe-function 'sc-describe)) | |
2025 | ||
2026 | (defun sc-submit-bug-report () | |
2027 | "Submit a bug report on Supercite via mail." | |
2028 | (interactive) | |
2029 | (require 'reporter) | |
2030 | (and | |
2031 | (y-or-n-p "Do you want to submit a report on Supercite? ") | |
2032 | (reporter-submit-bug-report | |
2033 | sc-help-address | |
2034 | (concat "Supercite version " sc-version) | |
2035 | (list | |
2036 | 'sc-attrib-selection-list | |
2037 | 'sc-auto-fill-region-p | |
2038 | 'sc-blank-lines-after-headers | |
2039 | 'sc-citation-leader | |
2040 | 'sc-citation-delimiter | |
2041 | 'sc-citation-separator | |
2042 | 'sc-citation-leader-regexp | |
2043 | 'sc-citation-root-regexp | |
2044 | 'sc-citation-nonnested-root-regexp | |
2045 | 'sc-citation-delimiter-regexp | |
2046 | 'sc-citation-separator-regexp | |
2047 | 'sc-cite-region-limit | |
2048 | 'sc-confirm-always-p | |
2049 | 'sc-default-attribution | |
2050 | 'sc-default-author-name | |
2051 | 'sc-downcase-p | |
2052 | 'sc-electric-circular-p | |
2053 | 'sc-electric-references-p | |
2054 | 'sc-fixup-whitespace-p | |
2055 | 'sc-mail-warn-if-non-rfc822-p | |
2056 | 'sc-mumble | |
2057 | 'sc-name-filter-alist | |
2058 | 'sc-nested-citation-p | |
2059 | 'sc-nuke-mail-headers | |
2060 | 'sc-nuke-mail-header-list | |
2061 | 'sc-preferred-attribution-list | |
2062 | 'sc-preferred-header-style | |
2063 | 'sc-reference-tag-string | |
2064 | 'sc-rewrite-header-list | |
2065 | 'sc-titlecue-regexp | |
2066 | 'sc-use-only-preference-p | |
2067 | )))) | |
2068 | ||
2069 | \f | |
2070 | ;; useful stuff | |
2071 | (provide 'supercite) | |
2072 | (run-hooks 'sc-load-hook) | |
2073 | ||
caf3c78f | 2074 | ;; arch-tag: a5d5bfa6-3bd5-4414-8c65-0afc83e45cd3 |
30b7c745 | 2075 | ;;; supercite.el ends here |