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