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