1 ;;; supercite.el --- minor mode for citing mail and news replies
3 ;; Copyright (C) 1993, 1997, 2001-2018 Free Software Foundation, Inc.
5 ;; Author: 1993 Barry A. Warsaw <bwarsaw@python.org>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Created: February 1993
8 ;; Keywords: mail, news
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
26 ;; supercite|Barry A. Warsaw|supercite-help@python.org
27 ;; |Mail and news reply citation package
28 ;; |1993/09/22 18:58:46|3.1|
37 ;; start user configuration variables
38 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
40 (defgroup supercite nil
46 (defgroup supercite-frames nil
47 "Supercite (regi) frames."
51 (defgroup supercite-attr nil
52 "Supercite attributions."
56 (defgroup supercite-cite nil
61 (defgroup supercite-hooks nil
62 "Hooking into supercite."
66 (defcustom sc-auto-fill-region-p t
67 "If non-nil, automatically fill each paragraph after it has been cited."
71 (defcustom sc-blank-lines-after-headers
1
72 "Number of blank lines to leave after mail headers have been nuked.
73 Set to nil, to use whatever blank lines happen to occur naturally."
74 :type
'(choice (const :tag
"leave" nil
)
78 (defcustom sc-citation-leader
" "
79 "String comprising first part of a citation."
81 :group
'supercite-cite
)
83 (defcustom sc-citation-delimiter
">"
84 "String comprising third part of a citation.
85 This string is used in both nested and non-nested citations."
87 :group
'supercite-cite
)
89 (defcustom sc-citation-separator
" "
90 "String comprising fourth and last part of a citation."
92 :group
'supercite-cite
)
94 (defcustom sc-citation-leader-regexp
"[ \t]*"
95 "Regexp describing citation leader for a cited line.
96 This should NOT have a leading `^' character."
98 :group
'supercite-cite
)
100 ;; Nemacs and Mule users note: please see the texinfo manual for
101 ;; suggestions on setting these variables.
102 (defcustom sc-citation-root-regexp
"[-._[:alnum:]]*"
103 "Regexp describing variable root part of a citation for a cited line.
104 This should NOT have a leading `^' character. See also
105 `sc-citation-nonnested-root-regexp'."
107 :group
'supercite-cite
)
109 (defcustom sc-citation-nonnested-root-regexp
"[-._[:alnum:]]+"
110 "Regexp describing the variable root part of a nested citation.
111 This should NOT have a leading `^' character. This variable is
112 related to `sc-citation-root-regexp' but whereas that variable
113 describes both nested and non-nested citation roots, this variable
114 describes only nested citation roots."
116 :group
'supercite-cite
)
118 (defcustom sc-citation-delimiter-regexp
"[>]+"
119 "Regexp describing citation delimiter for a cited line.
120 This should NOT have a leading `^' character."
122 :group
'supercite-cite
)
124 (defcustom sc-citation-separator-regexp
"[ \t]*"
125 "Regexp describing citation separator for a cited line.
126 This should NOT have a leading `^' character."
128 :group
'supercite-cite
)
130 (defcustom sc-cite-blank-lines-p nil
131 "If non-nil, put a citation on blank lines."
133 :group
'supercite-cite
)
135 (defcustom sc-cite-frame-alist
'()
136 "Alist for frame selection during citing.
137 Each element of this list has the following form:
138 (INFOKEY ((REGEXP . FRAME)
142 Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular
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."
146 :type
'(repeat (list symbol
(repeat (cons regexp
147 (choice (repeat (repeat sexp
))
149 :group
'supercite-frames
)
150 (put 'sc-cite-frame-alist
'risky-local-variable t
)
152 (defcustom sc-uncite-frame-alist
'()
153 "Alist for frame selection during unciting.
154 See the variable `sc-cite-frame-alist' for details."
155 :type
'(repeat (list symbol
(repeat (cons regexp
156 (choice (repeat (repeat sexp
))
158 :group
'supercite-frames
)
159 (put 'sc-uncite-frame-alist
'risky-local-variable t
)
161 (defcustom sc-recite-frame-alist
'()
162 "Alist for frame selection during reciting.
163 See the variable `sc-cite-frame-alist' for details."
164 :type
'(repeat (list symbol
(repeat (cons regexp
165 (choice (repeat (repeat sexp
))
167 :group
'supercite-frames
)
168 (put 'sc-recite-frame-alist
'risky-local-variable t
)
170 (defcustom sc-default-cite-frame
171 '(;; initialize fill state and temporary variables when entering
172 ;; frame. this makes things run much faster
174 (sc-fill-if-different)
175 (setq sc-tmp-nested-regexp
(sc-cite-regexp "")
176 sc-tmp-nonnested-regexp
(sc-cite-regexp)
182 sc-citation-nonnested-root-regexp
)))))
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
187 (if sc-nested-citation-p
188 (sc-add-citation-level)
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
"")
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
210 ;; be sure when we're done that we fill the last cited paragraph.
211 (end (sc-fill-if-different "")))
212 "Default REGI frame for citing a region."
213 :type
'(repeat (repeat sexp
))
214 :group
'supercite-frames
)
215 (put 'sc-default-cite-frame
'risky-local-variable t
)
217 (defcustom sc-default-uncite-frame
218 '(;; do nothing on a blank line
220 ;; if the line is cited, uncite it
221 ((sc-cite-regexp) (sc-uncite-line)))
222 "Default REGI frame for unciting a region."
223 :type
'(repeat (repeat sexp
))
224 :group
'supercite-frames
)
225 (put 'sc-default-uncite-frame
'risky-local-variable t
)
227 (defcustom sc-default-recite-frame
228 '(;; initialize fill state when entering frame
229 (begin (sc-fill-if-different))
230 ;; do nothing on a blank line
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
236 ;; be sure when we're done that we fill the last cited paragraph.
237 (end (sc-fill-if-different "")))
238 "Default REGI frame for reciting a region."
239 :type
'(repeat (repeat sexp
))
240 :group
'supercite-frames
)
241 (put 'sc-default-recite-frame
'risky-local-variable t
)
243 (defcustom sc-cite-region-limit t
244 "This variable controls automatic citation of yanked text.
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
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
258 during the initial citing via `sc-cite-original'."
259 :type
'(choice (const :tag
"do not cite" nil
)
260 (integer :tag
"citation threshold")
261 (other :tag
"always cite" t
))
262 :group
'supercite-cite
)
264 (defcustom sc-confirm-always-p t
265 "If non-nil, always confirm attribution string before citing text body."
267 :group
'supercite-attr
)
269 (defcustom sc-default-attribution
"Anon"
270 "String used when author's attribution cannot be determined."
272 :group
'supercite-attr
)
273 (defcustom sc-default-author-name
"Anonymous"
274 "String used when author's name cannot be determined."
276 :group
'supercite-attr
)
277 (defcustom sc-downcase-p nil
278 "Non-nil means downcase the attribution and citation strings."
280 :group
'supercite-attr
281 :group
'supercite-cite
)
282 (defcustom sc-electric-circular-p t
283 "If non-nil, treat electric references as circular."
285 :group
'supercite-attr
)
287 (defcustom sc-electric-mode-hook nil
288 "Hook for `sc-electric-mode' electric references mode."
290 :group
'supercite-hooks
)
291 (defcustom sc-electric-references-p nil
292 "Use electric references if non-nil."
296 (defcustom sc-fixup-whitespace-p nil
297 "If non-nil, delete all leading white space before citing."
301 (defcustom sc-load-hook nil
302 "Hook which gets run once after Supercite loads."
304 :group
'supercite-hooks
)
305 (make-obsolete-variable 'sc-load-hook
306 "use `with-eval-after-load' instead." "26.1")
308 (defcustom sc-pre-hook nil
309 "Hook which gets run before each invocation of `sc-cite-original'."
311 :group
'supercite-hooks
)
312 (defcustom sc-post-hook nil
313 "Hook which gets run after each invocation of `sc-cite-original'."
315 :group
'supercite-hooks
)
317 (defcustom sc-mail-warn-if-non-rfc822-p t
318 "Warn if mail headers don't conform to RFC822."
320 :group
'supercite-attr
)
321 (defcustom sc-mumble
""
322 "Value returned by `sc-mail-field' if field isn't in mail headers."
324 :group
'supercite-attr
)
326 (defcustom sc-name-filter-alist
327 '(("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" .
0)
328 ("^\\(Jr\\|Sr\\)[.]?$" . last
)
331 "Name list components which are filtered out as noise.
332 This variable contains an association list where each element is of
333 the form: (REGEXP . POSITION).
335 REGEXP is a regular expression which matches the name list component.
336 Match is performed using `string-match'. POSITION is the position in
337 the name list which can match the regular expression, starting at zero
338 for the first element. Use `last' to match the last element in the
339 list and `any' to match all elements."
340 :type
'(repeat (cons regexp
(choice (const last
) (const any
)
341 (integer :tag
"position"))))
342 :group
'supercite-attr
)
344 (defcustom sc-nested-citation-p nil
345 "Controls whether to use nested or non-nested citation style.
346 Non-nil uses nested citations, nil uses non-nested citations."
350 (defcustom sc-nuke-mail-headers
'all
351 "Controls mail header nuking.
352 Used in conjunction with `sc-nuke-mail-header-list'. Valid values are:
354 `all' -- nuke all mail headers
355 `none' -- don't nuke any mail headers
356 `specified' -- nuke headers specified in `sc-nuke-mail-header-list'
357 `keep' -- keep headers specified in `sc-nuke-mail-header-list'"
358 :type
'(choice (const all
) (const none
)
359 (const specified
) (const keep
))
362 (defcustom sc-nuke-mail-header-list nil
363 "List of mail header regexps to remove or keep in body of reply.
364 This list contains regular expressions describing the mail headers to
365 keep or nuke, depending on the value of `sc-nuke-mail-headers'."
366 :type
'(repeat regexp
)
369 (defcustom sc-preferred-attribution-list
370 '("sc-lastchoice" "x-attribution" "firstname" "initials" "lastname")
371 "Specifies what to use as the attribution string.
372 Supercite creates a list of possible attributions when it scans the
373 mail headers from the original message. Each attribution choice is
374 associated with a key in an attribution alist. Supercite tries to
375 pick a \"preferred\" attribution by matching the attribution alist
376 keys against the elements in `sc-preferred-attribution-list' in order.
377 The first non-empty string value found is used as the preferred
380 Note that Supercite now honors the X-Attribution: mail field. If
381 present in the original message, the value of this field should always
382 be used to select the most preferred attribution since it reflects how
383 the original author would like to be distinguished. It should be
384 considered bad taste to put any attribution preference key before
385 \"x-attribution\" in this list, except perhaps for \"sc-lastchoice\"
388 Supercite remembers the last attribution used when reciting an already
389 cited paragraph. This attribution will always be saved with the
390 \"sc-lastchoice\" key, which can be used in this list. Note that the
391 last choice is always reset after every call of `sc-cite-original'.
393 Barring error conditions, the following preferences are always present
394 in the attribution alist:
396 \"emailname\" -- email terminus name
397 \"initials\" -- initials of author
398 \"firstname\" -- first name of author
399 \"lastname\" -- last name of author
400 \"middlename-1\" -- first middle name of author
401 \"middlename-2\" -- second middle name of author
404 Middle name indexes can be any positive integer greater than 0,
405 although it is unlikely that many authors will supply more than one
406 middle name, if that many. The string of all middle names is
407 associated with the key \"middlenames\"."
408 :type
'(repeat string
)
409 :group
'supercite-attr
)
411 (defcustom sc-attrib-selection-list nil
412 "An alist for selecting preferred attribution based on mail headers.
413 Each element of this list has the following form:
415 (INFOKEY ((REGEXP . ATTRIBUTION)
416 (REGEXP . ATTRIBUTION)
419 Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular
420 expression to match against the INFOKEY's value. ATTRIBUTION can be a
421 string or a list. If it's a string, then it is the attribution that is
422 selected by `sc-select-attribution'. If it is a list, it is `eval'd
423 and the return value must be a string, which is used as the selected
424 attribution. Note that the variable `sc-preferred-attribution-list'
425 must contain an element of the string \"sc-consult\" for this variable
426 to be consulted during attribution selection."
427 :type
'(repeat (list string
429 (choice (sexp :tag
"List to eval")
431 :group
'supercite-attr
)
432 (put 'sc-attrib-selection-list
'risky-local-variable t
)
434 (defcustom sc-attribs-preselect-hook nil
435 "Hook to run before selecting an attribution."
437 :group
'supercite-attr
438 :group
'supercite-hooks
)
439 (defcustom sc-attribs-postselect-hook nil
440 "Hook to run after selecting an attribution, but before confirmation."
442 :group
'supercite-attr
443 :group
'supercite-hooks
)
445 (defcustom sc-pre-cite-hook nil
446 "Hook to run before citing a region of text."
448 :group
'supercite-cite
449 :group
'supercite-hooks
)
450 (defcustom sc-pre-uncite-hook nil
451 "Hook to run before unciting a region of text."
453 :group
'supercite-cite
454 :group
'supercite-hooks
)
455 (defcustom sc-pre-recite-hook nil
456 "Hook to run before reciting a region of text."
458 :group
'supercite-cite
459 :group
'supercite-hooks
)
461 (defcustom sc-preferred-header-style
4
462 "Index into `sc-rewrite-header-list' specifying preferred header style.
463 Index zero accesses the first function in the list."
467 (defcustom sc-reference-tag-string
">>>>> "
468 "String used at the beginning of built-in reference headers."
472 (defcustom sc-rewrite-header-list
475 (sc-header-inarticle-writes)
476 (sc-header-regarding-adds)
477 (sc-header-attributed-writes)
478 (sc-header-author-writes)
480 (sc-no-blank-line-or-header))
481 "List of reference header rewrite functions.
482 The variable `sc-preferred-header-style' controls which function in
483 this list is chosen for automatic reference header insertions.
484 Electric reference mode will cycle through this list of functions."
487 (put 'sc-rewrite-header-list
'risky-local-variable t
)
489 (defcustom sc-titlecue-regexp
"\\s +-+\\s +"
490 "Regular expression describing the separator between names and titles.
491 Set to nil to treat entire field as a name."
492 :type
'(choice (const :tag
"entire field as name" nil
)
494 :group
'supercite-attr
)
496 (defcustom sc-use-only-preference-p nil
497 "Controls what happens when the preferred attribution cannot be found.
498 If non-nil, then `sc-default-attribution' will be used. If nil, then
499 some secondary scheme will be employed to find a suitable attribution
502 :group
'supercite-attr
)
504 (defcustom sc-mode-map-prefix
"\C-c\C-p"
505 "Key binding to install Supercite keymap."
509 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
510 ;; end user configuration variables
512 (defvar sc-mail-info nil
513 "Alist of mail header information gleaned from reply buffer.")
514 (defvar sc-attributions nil
515 "Alist of attributions for use when citing.")
517 (defvar sc-tmp-nested-regexp nil
518 "Temporary regexp describing nested citations.")
519 (defvar sc-tmp-nonnested-regexp nil
520 "Temporary regexp describing non-nested citations.")
521 (defvar sc-tmp-dumb-regexp nil
522 "Temp regexp describing non-nested citation cited with a nesting citer.")
524 (make-variable-buffer-local 'sc-mail-info
)
525 (make-variable-buffer-local 'sc-attributions
)
528 ;; ======================================================================
532 (let ((map (make-sparse-keymap)))
533 (define-key map
"a" 'sc-S-preferred-attribution-list
)
534 (define-key map
"b" 'sc-T-mail-nuke-blank-lines
)
535 (define-key map
"c" 'sc-T-confirm-always
)
536 (define-key map
"d" 'sc-T-downcase
)
537 (define-key map
"e" 'sc-T-electric-references
)
538 (define-key map
"f" 'sc-T-auto-fill-region
)
539 (define-key map
"h" 'sc-T-describe
)
540 (define-key map
"l" 'sc-S-cite-region-limit
)
541 (define-key map
"n" 'sc-S-mail-nuke-mail-headers
)
542 (define-key map
"N" 'sc-S-mail-header-nuke-list
)
543 (define-key map
"o" 'sc-T-electric-circular
)
544 (define-key map
"p" 'sc-S-preferred-header-style
)
545 (define-key map
"s" 'sc-T-nested-citation
)
546 (define-key map
"u" 'sc-T-use-only-preferences
)
547 (define-key map
"w" 'sc-T-fixup-whitespace
)
548 (define-key map
"?" 'sc-T-describe
)
550 "Keymap for sub-keymap of setting and toggling functions.")
553 (let ((map (make-sparse-keymap)))
554 (define-key map
"c" 'sc-cite-region
)
555 (define-key map
"f" 'sc-mail-field-query
)
556 (define-key map
"g" 'sc-mail-process-headers
)
557 (define-key map
"h" 'sc-describe
)
558 (define-key map
"i" 'sc-insert-citation
)
559 (define-key map
"o" 'sc-open-line
)
560 (define-key map
"r" 'sc-recite-region
)
561 (define-key map
"\C-p" 'sc-raw-mode-toggle
)
562 (define-key map
"u" 'sc-uncite-region
)
563 (define-key map
"w" 'sc-insert-reference
)
564 (define-key map
"\C-t" sc-T-keymap
)
565 (define-key map
"?" 'sc-describe
)
567 "Keymap for Supercite quasi-mode.")
569 (defvar sc-electric-mode-map
570 (let ((map (make-sparse-keymap)))
571 (define-key map
"p" 'sc-eref-prev
)
572 (define-key map
"n" 'sc-eref-next
)
573 (define-key map
"s" 'sc-eref-setn
)
574 (define-key map
"j" 'sc-eref-jump
)
575 (define-key map
"x" 'sc-eref-abort
)
576 (define-key map
"q" 'sc-eref-abort
)
577 (define-key map
"\r" 'sc-eref-exit
)
578 (define-key map
"\n" 'sc-eref-exit
)
579 (define-key map
"g" 'sc-eref-goto
)
580 (define-key map
"?" 'describe-mode
)
581 (define-key map
"\C-h" 'describe-mode
)
582 (define-key map
[f1] 'describe-mode)
583 (define-key map [help] 'describe-mode)
585 "Keymap for `sc-electric-mode' electric references mode.")
588 (defvar sc-minibuffer-local-completion-map
589 (let ((map (copy-keymap minibuffer-local-completion-map)))
590 (define-key map "\C-t" 'sc-toggle-fn)
591 (define-key map " " 'self-insert-command)
593 "Keymap for minibuffer confirmation of attribution strings.")
595 (defvar sc-minibuffer-local-map
596 (let ((map (copy-keymap minibuffer-local-map)))
597 (define-key map "\C-t" 'sc-toggle-fn)
599 "Keymap for minibuffer confirmation of attribution strings.")
602 ;; ======================================================================
605 (defun sc-ask (alist)
606 "Ask a question in the minibuffer requiring a single character answer.
607 This function is kind of an extension of `y-or-n-p' where a single
608 letter is used to answer a question. Question is formed from ALIST
609 which has members of the form: (WORD . LETTER). WORD is the long
610 word form, while LETTER is the letter for selecting that answer. The
611 selected letter is returned, or nil if the question was not answered.
612 Note that WORD is a string and LETTER is a character. All LETTERs in
613 the list should be unique."
614 (let* ((prompt (concat
615 (mapconcat (lambda (elt) (car elt)) alist ", ")
618 (lambda (elt) (char-to-string (cdr elt))) alist "/")
622 (if (fboundp 'allocate-event)
626 (if (let ((cursor-in-echo-area t)
629 (setq event (read-event))
630 (prog1 quit-flag (setq quit-flag nil)))
632 (message "%s%s" p (single-key-description event))
633 (if (fboundp 'deallocate-event)
634 (deallocate-event event))
639 (if char (setq char (downcase char)))
641 ((setq elt (rassq char alist))
642 (message "%s%s" p (car elt))
644 ((if (fboundp 'button-release-event-p)
645 (button-release-event-p event)) ; ignore them
648 (message "%s%s" p (single-key-description event))
652 (setq p (concat "Try again. " prompt)))))))
653 (if (fboundp 'deallocate-event)
654 (deallocate-event event))
657 (defun sc-scan-info-alist (alist)
658 "Find a match in the info alist that matches a regexp in ALIST."
662 (let* ((elem (car alist))
664 (infoval (sc-mail-field infokey))
667 (let* ((ml-elem (car mlist))
668 (regexp (car ml-elem))
669 (thing (cdr ml-elem)))
670 (if (string-match regexp infoval)
671 ;; we found a match, time to return
675 ;; else we didn't find a match
676 (setq mlist (cdr mlist))))) ;end of mlist loop
677 (setq alist (cdr alist)))) ;end of alist loop
681 ;; ======================================================================
682 ;; extract mail field information from headers in reply buffer
684 ;; holder variables for bc happiness
685 (defvar sc-mail-headers-start nil
686 "Start of header fields.")
687 (defvar sc-mail-headers-end nil
688 "End of header fields.")
689 (defvar sc-mail-field-history nil
690 "For minibuffer completion on mail field queries.")
691 (defvar sc-mail-field-modification-history nil
692 "For minibuffer completion on mail field modifications.")
693 (defvar sc-mail-glom-frame
694 '((begin (setq sc-mail-headers-start (point)))
695 ("^From " (sc-mail-check-from) nil nil)
696 ("^x-attribution:[ \t]+.*$" (sc-mail-fetch-field t) nil t)
697 ("^\\S +:.*$" (sc-mail-fetch-field) nil t)
698 ("^$" (list 'abort '(step . 0)))
699 ("^[ \t]+" (sc-mail-append-field))
700 (sc-mail-warn-if-non-rfc822-p (sc-mail-error-in-mail-field))
701 (end (setq sc-mail-headers-end (point))))
702 "Regi frame for glomming mail header information.")
703 (put 'sc-mail-glom-frame 'risky-local-variable t)
705 (defvar curline) ; dynamic bondage
709 ;; https://lists.gnu.org/r/emacs-devel/2009-02/msg00691.html
710 ;; When rmail replies to a message with full headers visible, the "From "
711 ;; line can be included.
712 (defun sc-mail-check-from ()
713 "Deal with a \"From \" line in the header.
714 Such a line should only occur at the very start of the headers."
715 (and sc-mail-warn-if-non-rfc822-p
716 (/= (point) sc-mail-headers-start)
717 (sc-mail-error-in-mail-field)))
719 (defun sc-mail-fetch-field (&optional attribs-p)
720 "Insert a key and value into `sc-mail-info' alist.
721 If optional ATTRIBS-P is non-nil, the key/value pair is placed in
722 `sc-attributions' too."
723 (if (string-match "^\\(\\S *\\)\\s *:\\s +\\(.*\\)$" curline)
724 (let* ((key (downcase (match-string-no-properties 1 curline)))
725 (val (match-string-no-properties 2 curline))
726 (keyval (cons key val)))
727 (push keyval sc-mail-info)
729 (push keyval sc-attributions))))
732 (defun sc-mail-append-field ()
733 "Append a continuation line onto the last fetched mail field's info."
734 (let ((keyval (car sc-mail-info)))
735 (if (and keyval (string-match "^\\s *\\(.*\\)$" curline))
736 (setcdr keyval (concat (cdr keyval) " "
737 (match-string-no-properties 1 curline)))))
740 (defun sc-mail-error-in-mail-field ()
741 "Issue warning that mail headers don't conform to RFC 822."
742 (let* ((len (min (length curline) 10))
743 (ellipsis (if (< len (length curline)) "..." ""))
744 (msg "Mail header \"%s%s\" doesn't conform to RFC 822. skipping..."))
745 (message msg (substring curline 0 len) ellipsis))
750 ;; mail header nuking
751 (defvar sc-mail-last-header-nuked-p nil
752 "True if the last header was nuked.")
754 (defun sc-mail-nuke-line ()
755 "Nuke the current mail header line."
756 (delete-region (line-beginning-position) (line-beginning-position 2))
759 (defun sc-mail-nuke-header-line ()
760 "Delete current-line and set up for possible continuation."
761 (setq sc-mail-last-header-nuked-p t)
764 (defun sc-mail-nuke-continuation-line ()
765 "Delete a continuation line if the last header line was deleted."
766 (if sc-mail-last-header-nuked-p
767 (sc-mail-nuke-line)))
769 (defun sc-mail-cleanup-blank-lines ()
770 "Leave some blank lines after original mail headers are nuked.
771 The number of lines left is specified by `sc-blank-lines-after-headers'."
772 (if sc-blank-lines-after-headers
775 (skip-chars-backward " \t\n")
779 (if (looking-at "[ \t]*$")
780 (delete-region (line-beginning-position)
781 (line-beginning-position 2)))
782 (insert-char ?\n sc-blank-lines-after-headers)))
785 (defun sc-mail-build-nuke-frame ()
786 "Build the regiframe for nuking mail headers."
787 (let (every-func entry-func nonentry-func)
789 ((eq sc-nuke-mail-headers 'all)
790 (setq every-func '(progn (forward-line -1) (sc-mail-nuke-line))))
791 ((eq sc-nuke-mail-headers 'specified)
792 (setq entry-func '(sc-mail-nuke-header-line)
793 nonentry-func '(setq sc-mail-last-header-nuked-p nil)))
794 ((eq sc-nuke-mail-headers 'keep)
795 (setq entry-func '(setq sc-mail-last-header-nuked-p nil)
796 nonentry-func '(sc-mail-nuke-header-line)))
797 ;; we never get far enough to interpret a frame if s-n-m-h == 'none
798 ((eq sc-nuke-mail-headers 'none))
799 (t (error "Invalid value for sc-nuke-mail-headers: %s"
800 sc-nuke-mail-headers))) ; end-cond
803 (regi-mapcar sc-nuke-mail-header-list entry-func nil t))
804 (and nonentry-func (list (list "^\\S +:.*$" nonentry-func)))
805 (and (not every-func)
806 '(("^[ \t]+" (sc-mail-nuke-continuation-line))))
807 '((begin (setq sc-mail-last-header-zapped-p nil)))
808 '((end (sc-mail-cleanup-blank-lines)))
809 (and every-func (list (list 'every every-func))))))
811 ;; mail processing and zapping. this is the top level entry defun to
812 ;; all header processing.
813 (defun sc-mail-process-headers (start end)
814 "Process original mail message's mail headers.
815 After processing, mail headers may be nuked. Header information is
816 stored in `sc-mail-info', and any old information is lost unless an
819 (let ((info (copy-alist sc-mail-info))
820 (attribs (copy-alist sc-attributions)))
821 (setq sc-mail-info nil
823 (regi-interpret sc-mail-glom-frame start end)
824 (if (null sc-mail-info)
826 (message "No mail headers found! Restoring old information.")
827 (setq sc-mail-info info
828 sc-attributions attribs))
829 (regi-interpret (sc-mail-build-nuke-frame)
830 sc-mail-headers-start sc-mail-headers-end))))
833 ;; let the user change mail field information
834 (defun sc-mail-field (field)
835 "Return the mail header field value associated with FIELD.
836 If there was no mail header with FIELD as its key, return the value of
837 `sc-mumble'. FIELD is case insensitive."
838 (or (cdr (assoc-string field sc-mail-info 'case-fold)) sc-mumble))
840 (defun sc-mail-field-query (arg)
841 "View the value of a mail field.
842 With `\\[universal-argument]', prompts for action on mail field.
843 Action can be one of: View, Modify, Add, or Delete."
845 (let* ((alist '(("view" . ?v) ("modify" . ?m) ("add" . ?a) ("delete" . ?d)))
846 (action (if (not arg) ?v (sc-ask alist)))
850 (setq key (completing-read
851 (concat (car (rassq action alist))
852 " information key: ")
854 (if (eq action ?a) nil 'noexit)
855 nil 'sc-mail-field-history))
858 (message "%s: %s" key (cdr (assoc key sc-mail-info))))
860 (setq sc-mail-info (delq (assoc key sc-mail-info) sc-mail-info)))
862 (let ((keyval (assoc key sc-mail-info)))
863 ;; first put initial value onto list if not already there
864 (if (not (member (cdr keyval)
865 sc-mail-field-modification-history))
866 (setq sc-mail-field-modification-history
867 (cons (cdr keyval) sc-mail-field-modification-history)))
868 (setcdr keyval (read-string
869 (concat key ": ") (cdr keyval)
870 'sc-mail-field-modification-history))))
872 (push (cons key (read-string (concat key ": "))) sc-mail-info))))))
875 ;; ======================================================================
878 (defvar sc-attribution-confirmation-history nil
879 "History for confirmation of attribution strings.")
880 (defvar sc-citation-confirmation-history nil
881 "History for confirmation of attribution prefixes.")
883 (defun sc-attribs-%@-addresses (from &optional delim)
884 "Extract the author's email terminus from email address FROM.
885 Match addresses of the style \"name%[stuff].\" when called with DELIM
886 of \"%\" and addresses of the style \"[stuff]name@[stuff]\" when
887 called with DELIM \"@\". If DELIM is nil or not provided, matches
888 addresses of the style \"name\"."
889 (and (string-match (concat "[-[:alnum:]_.]+" delim) from 0)
892 (- (match-end 0) (if (null delim) 0 1)))))
894 (defun sc-attribs-!-addresses (from)
895 "Extract the author's email terminus from email address FROM.
896 Match addresses of the style \"[stuff]![stuff]...!name[stuff].\""
897 (let ((eos (length from))
898 (mstart (string-match "![-[:alnum:]_.]+\\([^-![:alnum:]_.]\\|$\\)"
900 (mend (match-end 0)))
902 (substring from (1+ mstart) (- mend (if (= mend eos) 0 1))))))
904 (defun sc-attribs-<>-addresses (from)
905 "Extract the author's email terminus from email address FROM.
906 Match addresses of the style \"<name[stuff]>.\""
907 (and (string-match "<\\(.*\\)>" from)
908 (match-string 1 from)))
910 (defun sc-get-address (from author)
911 "Get the full email address path from FROM.
912 AUTHOR is the author's name (which is removed from the address)."
913 (let ((eos (length from)))
914 (if (string-match (concat "\\`\"?" (regexp-quote author)
916 (let ((address (substring from (match-end 0) eos)))
917 (if (and (= (aref address 0) ?<)
918 (= (aref address (1- (length address))) ?>))
919 (substring address 1 (1- (length address)))
921 (if (string-match "[-[:alnum:]!@%._]+" from 0)
922 (match-string 0 from)
925 (defun sc-attribs-emailname (from)
926 "Get the email terminus name from FROM."
928 (sc-attribs-%@-addresses from "%")
929 (sc-attribs-%@-addresses from "@")
930 (sc-attribs-!-addresses from)
931 (sc-attribs-<>-addresses from)
932 (sc-attribs-%@-addresses from)
933 (substring from 0 10)))
935 (defun sc-name-substring (string start end extend)
936 "Extract the specified substring of STRING from START to END.
937 EXTEND is the number of characters on each side to extend the
940 (let ((sos (+ start extend))
941 (eos (- end extend)))
942 (substring string sos
943 (or (string-match sc-titlecue-regexp string sos) eos)))))
945 (defun sc-attribs-extract-namestring (from)
946 "Extract the name string from FROM.
947 This should be the author's full name minus an optional title."
948 ;; FIXME: we probably should use mail-extract-address-components.
951 ;; If there is a <...> in the name,
952 ;; treat everything before that as the full name.
953 ;; Even if it contains parens, use the whole thing.
954 ;; On the other hand, we do look for quotes in the usual way.
955 (and (string-match " *<.*>" from 0)
957 (sc-name-substring from 0 (match-beginning 0) 0)))
958 (if (string-match "\".*\"" before-angles 0)
960 before-angles (match-beginning 0) (match-end 0) 1)
963 from (string-match "(.*)" from 0) (match-end 0) 1)
965 from (string-match "\".*\"" from 0) (match-end 0) 1)
967 from (string-match "\\([-.[:alnum:]_]+\\s +\\)+<" from 0)
969 (sc-attribs-emailname from))))
970 ;; strip off any leading or trailing whitespace
973 (eos (1- (length namestring))))
974 (while (and (<= bos eos)
975 (memq (aref namestring bos) '(32 ?\t)))
977 (while (and (> eos bos)
978 (memq (aref namestring eos) '(32 ?\t)))
980 (substring namestring bos (1+ eos))))))
982 (defun sc-attribs-chop-namestring (namestring)
983 "Convert NAMESTRING to a list of names.
984 example: (sc-attribs-chop-namestring \"John Xavier Doe\")
985 => (\"John\" \"Xavier\" \"Doe\")"
986 (if (string-match "\\([ \t]*\\)\\([^ \t._]+\\)\\([ \t]*\\)" namestring)
987 (cons (match-string 2 namestring)
988 (sc-attribs-chop-namestring (substring namestring (match-end 3))))))
990 (defun sc-attribs-strip-initials (namelist)
991 "Extract the author's initials from the NAMELIST."
994 (if (< 0 (length name))
995 (substring name 0 1)))
998 (defun sc-guess-attribution (&optional string)
999 "Guess attribution string on current line.
1000 If attribution cannot be guessed, nil is returned. Optional STRING if
1001 supplied, is used instead of the line point is on in the current buffer."
1003 (string (or string (buffer-substring (line-beginning-position)
1004 (line-end-position))))
1007 (= start (or (string-match sc-citation-leader-regexp string start) -1))
1008 (setq start (match-end 0))
1009 (= start (or (string-match sc-citation-root-regexp string start) 1))
1010 (setq attribution (match-string 0 string)
1011 start (match-end 0))
1012 (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
1013 (setq start (match-end 0))
1014 (= start (or (string-match sc-citation-separator-regexp string start) -1))
1017 (defun sc-attribs-filter-namelist (namelist)
1018 "Filter out noise in NAMELIST according to `sc-name-filter-alist'."
1019 (let ((elements (length namelist))
1021 keepers filtered-list)
1024 (setq position (1+ position))
1029 (let ((regexp (car filter))
1031 (if (and (string-match regexp name)
1032 (or (and (numberp pos)
1035 (= position (1- elements)))
1037 (setq keep-p nil)))))
1038 sc-name-filter-alist)
1040 (setq keepers (cons position keepers)))))
1044 (setq filtered-list (cons (nth position namelist) filtered-list)))
1048 (defun sc-attribs-chop-address (from)
1049 "Extract attribution information from FROM.
1050 This populates the `sc-attributions' with the list of possible attributions."
1051 (if (and (stringp from)
1052 (< 0 (length from)))
1053 (let* ((sc-mumble "")
1054 (namestring (sc-attribs-extract-namestring from))
1055 (namelist (sc-attribs-filter-namelist
1056 (sc-attribs-chop-namestring namestring)))
1057 (revnames (reverse (cdr namelist)))
1058 (firstname (car namelist))
1059 (midnames (reverse (cdr revnames)))
1060 (lastname (car revnames))
1061 (initials (sc-attribs-strip-initials namelist))
1062 (emailname (sc-attribs-emailname from))
1066 ;; put basic information
1068 ;; put middle names and build sc-author entry
1069 middlenames (mapconcat
1071 (let ((key-attribs (format "middlename-%d" n))
1072 (key-mail (format "sc-middlename-%d" n)))
1073 (push (cons key-attribs midname) sc-attributions)
1074 (push (cons key-mail midname) sc-mail-info)
1079 author (concat firstname " " middlenames (and midnames " ") lastname)
1081 sc-attributions (append
1083 (cons "firstname" firstname)
1084 (cons "lastname" lastname)
1085 (cons "emailname" emailname)
1086 (cons "initials" initials))
1088 sc-mail-info (append
1090 (cons "sc-firstname" firstname)
1091 (cons "sc-middlenames" middlenames)
1092 (cons "sc-lastname" lastname)
1093 (cons "sc-emailname" emailname)
1094 (cons "sc-initials" initials)
1095 (cons "sc-author" author)
1096 (cons "sc-from-address" (sc-get-address
1097 (sc-mail-field "from")
1099 (cons "sc-reply-address" (sc-get-address
1100 (sc-mail-field "reply-to")
1102 (cons "sc-sender-address" (sc-get-address
1103 (sc-mail-field "sender")
1106 ;; from string is empty
1107 (push (cons "sc-author" sc-default-author-name) sc-mail-info)))
1109 (defvar sc-attrib-or-cite nil
1110 "Used to toggle between attribution input or citation input.")
1112 (defun sc-toggle-fn ()
1113 "Toggle between attribution selection and citation selection.
1114 Only used during confirmation."
1116 (setq sc-attrib-or-cite (not sc-attrib-or-cite))
1117 (throw 'sc-reconfirm t))
1119 (defun sc-select-attribution ()
1120 "Select an attribution from `sc-attributions'.
1122 Variables involved in selection process include:
1123 `sc-preferred-attribution-list'
1124 `sc-use-only-preference-p'
1125 `sc-confirm-always-p'
1126 `sc-default-attribution'
1127 `sc-attrib-selection-list'.
1129 Runs the hook `sc-attribs-preselect-hook' before selecting an
1130 attribution and the hook `sc-attribs-postselect-hook' after making the
1131 selection but before querying is performed. During
1132 `sc-attribs-postselect-hook' the variable `citation' is bound to the
1133 auto-selected citation string and the variable `attribution' is bound
1134 to the auto-selected attribution string."
1135 (run-hooks 'sc-attribs-preselect-hook)
1136 (let ((query-p sc-confirm-always-p)
1137 attribution citation
1138 (attriblist sc-preferred-attribution-list))
1140 ;; first cruise through sc-preferred-attribution-list looking for
1141 ;; a match in either sc-attributions or sc-mail-info. if the
1142 ;; element is "sc-consult", then we have to do the alist
1143 ;; consultation phase
1145 (let* ((preferred (car attriblist)))
1147 ((string= preferred "sc-consult")
1148 ;; we've been told to consult the attribution vs. mail
1149 ;; header key alist. we do this until we find a match in
1150 ;; the sc-attrib-selection-list. if we do not find a match,
1151 ;; we continue scanning attriblist
1152 (let ((attrib (sc-scan-info-alist sc-attrib-selection-list)))
1155 (setq attriblist (cdr attriblist)))
1157 (setq attribution attrib
1160 (setq attribution (eval attrib))
1161 (if (stringp attribution)
1162 (setq attriblist nil)
1163 (setq attribution nil
1164 attriblist (cdr attriblist))))
1165 (t (error "%s did not evaluate to a string or list!"
1166 "sc-attrib-selection-list")))))
1167 ((setq attribution (cdr (assoc preferred sc-attributions)))
1168 (setq attriblist nil))
1170 (setq attriblist (cdr attriblist))))))
1172 ;; if preference was not found, we may use a secondary method to
1173 ;; find a valid attribution
1174 (if (and (not attribution)
1175 (not sc-use-only-preference-p))
1176 ;; secondary method tries to find a preference in this order
1182 ;; 6. first non-empty attribution in alist
1184 (or (cdr (assoc "sc-lastchoice" sc-attributions))
1185 (cdr (assoc "x-attribution" sc-attributions))
1186 (cdr (assoc "firstname" sc-attributions))
1187 (cdr (assoc "lastname" sc-attributions))
1188 (cdr (assoc "initials" sc-attributions))
1189 (cdr (car sc-attributions)))))
1191 ;; still couldn't find an attribution. we're now limited to using
1192 ;; the default attribution, but we'll force a query when this happens
1193 (if (not attribution)
1194 (setq attribution sc-default-attribution
1197 ;; create the attribution prefix
1198 (setq citation (sc-make-citation attribution))
1200 ;; run the post selection hook before querying the user
1201 (run-hooks 'sc-attribs-postselect-hook)
1203 ;; query for confirmation
1205 (let* ((query-alist (mapcar (lambda (entry) (list (cdr entry)))
1207 (minibuffer-local-completion-map
1208 sc-minibuffer-local-completion-map)
1209 (minibuffer-local-map sc-minibuffer-local-map)
1210 (initial attribution)
1211 (completer-disable t) ; in case completer.el is used
1213 (setq sc-attrib-or-cite nil) ; nil==attribution, t==citation
1215 (catch 'sc-reconfirm
1218 (if sc-attrib-or-cite
1220 "Enter citation prefix: "
1222 'sc-citation-confirmation-history)
1224 "Complete attribution name: "
1227 'sc-attribution-confirmation-history)))
1229 (if sc-attrib-or-cite
1230 ;; since the citation was chosen, we have to guess at
1232 (setq citation choice
1233 attribution (or (sc-guess-attribution citation)
1236 (setq citation (sc-make-citation choice)
1237 attribution choice))))
1239 ;; its possible that the user wants to downcase the citation and
1242 (setq citation (downcase citation)
1243 attribution (downcase attribution)))
1245 ;; set up mail info alist
1246 (let* ((ckey "sc-citation")
1247 (akey "sc-attribution")
1248 (ckeyval (assoc ckey sc-mail-info))
1249 (akeyval (assoc akey sc-mail-info)))
1251 (setcdr ckeyval citation)
1252 (push (cons ckey citation) sc-mail-info))
1254 (setcdr akeyval attribution)
1255 (push (cons akey attribution) sc-mail-info)))
1257 ;; set the sc-lastchoice attribution
1258 (let* ((lkey "sc-lastchoice")
1259 (lastchoice (assoc lkey sc-attributions)))
1261 (setcdr lastchoice attribution)
1262 (push (cons lkey attribution) sc-attributions)))))
1265 ;; ======================================================================
1266 ;; filladapt hooks for supercite 3.1. you shouldn't need anything
1267 ;; extra to make gin-mode understand supercited lines. Even this
1268 ;; stuff might not be entirely necessary...
1270 (defun sc-cite-regexp (&optional root-regexp)
1271 "Return a regexp describing a Supercited line.
1272 The regexp is the concatenation of `sc-citation-leader-regexp',
1273 `sc-citation-root-regexp', `sc-citation-delimiter-regexp', and
1274 `sc-citation-separator-regexp'. If optional ROOT-REGEXP is supplied,
1275 use it instead of `sc-citation-root-regexp'."
1276 (concat sc-citation-leader-regexp
1277 (or root-regexp sc-citation-root-regexp)
1278 sc-citation-delimiter-regexp
1279 sc-citation-separator-regexp))
1281 (defun sc-make-citation (attribution)
1282 "Make a non-nested citation from ATTRIBUTION."
1283 (concat sc-citation-leader
1285 sc-citation-delimiter
1286 sc-citation-separator))
1288 (defvar filladapt-prefix-table)
1290 (defun sc-setup-filladapt ()
1291 "Setup `filladapt-prefix-table' to handle Supercited paragraphs."
1292 (let* ((fa-sc-elt 'filladapt-supercite-included-text)
1293 (elt (rassq fa-sc-elt filladapt-prefix-table)))
1294 (if elt (setcar elt (sc-cite-regexp))
1295 (message "Filladapt doesn't seem to know about Supercite.")
1299 ;; ======================================================================
1300 ;; citing and unciting regions of text
1302 (defvar sc-fill-begin 1
1303 "Buffer position to begin filling.")
1304 (defvar sc-fill-line-prefix ""
1305 "Fill prefix of previous line")
1308 (defun sc-fill-if-different (&optional prefix)
1309 "Fill the region bounded by `sc-fill-begin' and point.
1310 Only fill if optional PREFIX is different than `sc-fill-line-prefix'.
1311 If `sc-auto-fill-region-p' is nil, do not fill region. If PREFIX is
1312 not supplied, initialize fill variables. This is useful for a regi
1313 `begin' frame-entry."
1315 (setq sc-fill-line-prefix ""
1316 sc-fill-begin (line-beginning-position))
1317 (if (and sc-auto-fill-region-p
1318 (not (string= prefix sc-fill-line-prefix)))
1319 (let ((fill-prefix sc-fill-line-prefix))
1320 (if (not (string= fill-prefix ""))
1321 (fill-region sc-fill-begin (line-beginning-position)))
1322 (setq sc-fill-line-prefix prefix
1323 sc-fill-begin (line-beginning-position)))))
1326 (defun sc-cite-coerce-cited-line ()
1327 "Coerce a Supercited line to look like our style."
1328 (let* ((attribution (sc-guess-attribution))
1329 (regexp (sc-cite-regexp attribution))
1330 (prefix (sc-make-citation attribution)))
1331 (if (and attribution
1332 (looking-at regexp))
1337 (goto-char (match-end 0))
1338 (if (bolp) (forward-char -1))
1341 (sc-fill-if-different prefix)))
1344 (defun sc-cite-coerce-dumb-citer ()
1345 "Coerce a non-nested citation that's been cited with a dumb nesting citer."
1346 (delete-region (match-beginning 1) (match-end 1))
1348 (sc-cite-coerce-cited-line))
1350 (defun sc-guess-nesting (&optional string)
1351 "Guess the citation nesting on the current line.
1352 If nesting cannot be guessed, nil is returned. Optional STRING if
1353 supplied, is used instead of the line point is on in the current
1356 (string (or string (buffer-substring (line-beginning-position)
1357 (line-end-position))))
1360 (= start (or (string-match sc-citation-leader-regexp string start) -1))
1361 (setq start (match-end 0))
1362 (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
1363 (setq nesting (match-string 0 string)
1364 start (match-end 0))
1365 (= start (or (string-match sc-citation-separator-regexp string start) -1))
1368 (defun sc-add-citation-level ()
1369 "Add a citation level for nested citation style w/ coercion."
1370 (let* ((nesting (sc-guess-nesting))
1371 (citation (make-string (1+ (length nesting))
1372 (string-to-char sc-citation-delimiter)))
1373 (prefix (concat sc-citation-leader citation sc-citation-separator)))
1374 (if (looking-at (sc-cite-regexp ""))
1375 (delete-region (match-beginning 0) (match-end 0)))
1377 (sc-fill-if-different prefix)))
1379 (defun sc-cite-line (&optional citation)
1380 "Cite a single line of uncited text.
1381 Optional CITATION overrides any citation automatically selected."
1382 (if sc-fixup-whitespace-p
1384 (let ((prefix (or citation
1385 (cdr (assoc "sc-citation" sc-mail-info))
1386 sc-default-attribution)))
1388 (sc-fill-if-different prefix))
1391 (defun sc-uncite-line ()
1392 "Remove citation from current line."
1393 (let ((cited (looking-at (sc-cite-regexp))))
1395 (delete-region (match-beginning 0) (match-end 0))))
1398 (defun sc-recite-line (regexp)
1399 "Remove citation matching REGEXP from current line and recite line."
1400 (let ((cited (looking-at (concat "^" regexp)))
1401 (prefix (cdr (assoc "sc-citation" sc-mail-info))))
1403 (delete-region (match-beginning 0) (match-end 0)))
1404 (insert (or prefix sc-default-attribution))
1405 (sc-fill-if-different prefix))
1408 ;; interactive functions
1409 (defun sc-cite-region (start end &optional confirm-p interactive)
1410 "Cite a region delineated by START and END.
1411 If optional CONFIRM-P is non-nil, the attribution is confirmed before
1412 its use in the citation string. This function first runs
1415 When called interactively, the optional arg INTERACTIVE is non-nil,
1416 and that means call `sc-select-attribution' too."
1417 (interactive "r\nP\np")
1419 (let ((frame (sc-scan-info-alist sc-cite-frame-alist))
1420 (sc-confirm-always-p (if confirm-p t sc-confirm-always-p)))
1421 (if (and frame (symbolp frame))
1422 (setq frame (symbol-value frame)))
1423 (or frame (setq frame sc-default-cite-frame))
1424 (run-hooks 'sc-pre-cite-hook)
1426 (sc-select-attribution))
1427 (regi-interpret frame start end)))
1429 (defun sc-uncite-region (start end)
1430 "Uncite a region delineated by START and END.
1431 First runs `sc-pre-uncite-hook'."
1434 (let ((frame (sc-scan-info-alist sc-uncite-frame-alist)))
1435 (if (and frame (symbolp frame))
1436 (setq frame (symbol-value frame)))
1437 (or frame (setq frame sc-default-uncite-frame))
1438 (run-hooks 'sc-pre-uncite-hook)
1439 (regi-interpret frame start end)))
1441 (defun sc-recite-region (start end)
1442 "Recite a region delineated by START and END.
1443 First runs `sc-pre-recite-hook'."
1445 (let ((sc-confirm-always-p t))
1446 (sc-select-attribution))
1448 (let ((frame (sc-scan-info-alist sc-recite-frame-alist)))
1449 (if (and frame (symbolp frame))
1450 (setq frame (symbol-value frame)))
1451 (or frame (setq frame sc-default-recite-frame))
1452 (run-hooks 'sc-pre-recite-hook)
1453 (regi-interpret frame start end)))
1456 ;; ======================================================================
1459 (defun sc-hdr (prefix field &optional sep return-nil-p)
1460 "Returns a concatenation of PREFIX and FIELD.
1461 If FIELD is not a string or is the empty string, the empty string will
1462 be returned. Optional third argument SEP is concatenated on the end if
1463 it is a string. Returns empty string, unless optional RETURN-NIL-P is
1465 (if (and (stringp field)
1466 (not (string= field "")))
1467 (concat prefix field (or sep ""))
1468 (and (not return-nil-p) "")))
1470 (defun sc-whofrom ()
1471 "Return the value of (sc-mail-field \"from\") or nil."
1472 (let ((sc-mumble nil))
1473 (sc-mail-field "from")))
1475 (defun sc-no-header ()
1476 "Does nothing. Use this instead of nil to get a blank header."
1479 (declare-function mh-in-header-p "mh-utils" ())
1481 (defun sc-no-blank-line-or-header ()
1482 "Similar to `sc-no-header' except it removes the preceding blank line."
1485 (progn (forward-line -1)
1489 (line-beginning-position 2)))
1490 (and (eq major-mode 'mh-letter-mode)
1496 (defun sc-header-on-said ()
1497 "\"On <date>, <from> said:\" unless:
1498 1. the \"from\" field cannot be found, in which case nothing is inserted;
1499 2. the \"date\" field is missing in which case only the from part is printed."
1500 (let ((sc-mumble "")
1501 (whofrom (sc-whofrom)))
1503 (insert sc-reference-tag-string
1504 (sc-hdr "On " (sc-mail-field "date") ", ")
1505 whofrom " said:\n"))))
1507 (defun sc-header-inarticle-writes ()
1508 "\"In article <message-id>, <from> writes:\"
1509 Treats \"message-id\" and \"from\" fields similar to `sc-header-on-said'."
1510 (let ((sc-mumble "")
1511 (whofrom (sc-mail-field "from")))
1513 (insert sc-reference-tag-string
1514 (sc-hdr "In article " (sc-mail-field "message-id") ", ")
1515 whofrom " writes:\n"))))
1517 (defun sc-header-regarding-adds ()
1518 "\"Regarding <subject>; <from> adds:\"
1519 Treats \"subject\" and \"from\" fields similar to `sc-header-on-said'."
1520 (let ((sc-mumble "")
1521 (whofrom (sc-whofrom)))
1523 (insert sc-reference-tag-string
1524 (sc-hdr "Regarding " (sc-mail-field "subject") "; ")
1525 whofrom " adds:\n"))))
1527 (defun sc-header-attributed-writes ()
1528 "\"<sc-attribution>\" == <sc-author> <address> writes:
1529 Treats these fields in a similar manner to `sc-header-on-said'."
1530 (let ((sc-mumble "")
1531 (whofrom (sc-whofrom)))
1533 (insert sc-reference-tag-string
1534 (sc-hdr "\"" (sc-mail-field "sc-attribution") "\" == ")
1535 (sc-hdr "" (sc-mail-field "sc-author") " ")
1536 (or (sc-hdr "<" (sc-mail-field "sc-from-address") ">" t)
1537 (sc-hdr "<" (sc-mail-field "sc-reply-address") ">" t)
1541 (defun sc-header-author-writes ()
1542 "<sc-author> writes:"
1543 (let ((sc-mumble "")
1544 (whofrom (sc-whofrom)))
1546 (insert sc-reference-tag-string
1547 (sc-hdr "" (sc-mail-field "sc-author"))
1550 (defun sc-header-verbose ()
1551 "Very verbose, some say gross."
1552 (let ((sc-mumble "")
1553 (whofrom (sc-whofrom))
1554 (tag sc-reference-tag-string))
1556 (insert (sc-hdr (concat tag "On ") (sc-mail-field "date") ",\n")
1557 (or (sc-hdr tag (sc-mail-field "sc-author") "\n" t)
1558 (concat tag whofrom "\n"))
1559 (sc-hdr (concat tag "from the organization of ")
1560 (sc-mail-field "organization") "\n")
1561 (let ((rtag (concat tag "who can be reached at: ")))
1562 (or (sc-hdr rtag (sc-mail-field "sc-from-address") "\n" t)
1563 (sc-hdr rtag (sc-mail-field "sc-reply-address") "\n" t)
1566 (concat tag "(whose comments are cited below with \"")
1567 (sc-mail-field "sc-citation") "\"),\n")
1568 (sc-hdr (concat tag "had this to say in article ")
1569 (sc-mail-field "message-id") "\n")
1570 (sc-hdr (concat tag "in newsgroups ")
1571 (sc-mail-field "newsgroups") "\n")
1572 (sc-hdr (concat tag "concerning the subject of ")
1573 (sc-mail-field "subject") "\n")
1574 (sc-hdr (concat tag "(see ")
1575 (sc-mail-field "references")
1576 " for more details)\n")))))
1579 ;; ======================================================================
1582 (defconst sc-electric-bufname " *sc-erefs* "
1583 "Supercite electric reference mode's buffer name.")
1584 (defvar sc-eref-style 0
1585 "Current electric reference style.")
1587 (defun sc-valid-index-p (index)
1588 "Returns INDEX if it is a valid index into `sc-rewrite-header-list'.
1589 Otherwise returns nil."
1590 ;; a number, and greater than or equal to zero
1591 ;; less than or equal to the last index
1592 (and (natnump index)
1593 (< index (length sc-rewrite-header-list))
1596 (defun sc-eref-insert-selected (&optional nomsg)
1597 "Insert the selected reference header in the current buffer.
1598 Optional NOMSG, if non-nil, inhibits printing messages, unless an
1600 (let ((ref (nth sc-eref-style sc-rewrite-header-list)))
1604 (let ((lines (count-lines (point-min) (point-max))))
1605 (or nomsg (message "Ref header %d [%d line%s]: %s"
1607 (if (= lines 1) "" "s")
1611 "Symbol's function definition is void: %s (Header %d)"
1612 (cadr err) sc-eref-style)
1615 (defun sc-electric-mode (&optional style)
1616 "Mode for viewing Supercite reference headers. Commands are:
1617 \n\\{sc-electric-mode-map}
1619 `sc-electric-mode' is not intended to be run interactively, but rather
1620 accessed through Supercite's electric reference feature. See
1621 `sc-insert-reference' for more details. Optional STYLE is the initial
1622 header style to use, unless not supplied or invalid, in which case
1623 `sc-preferred-header-style' is used."
1625 (let ((info sc-mail-info))
1628 (or (sc-valid-index-p style)
1629 (sc-valid-index-p sc-preferred-header-style)
1632 (get-buffer-create sc-electric-bufname)
1633 ;; set up buffer and enter command loop
1635 (save-window-excursion
1636 (pop-to-buffer sc-electric-bufname)
1637 (kill-all-local-variables)
1638 (let ((sc-mail-info info)
1639 (buffer-read-only t)
1640 (mode-name "SC Electric Refs")
1641 (major-mode 'sc-electric-mode))
1642 (use-local-map sc-electric-mode-map)
1643 (sc-eref-show sc-eref-style)
1644 (run-mode-hooks 'sc-electric-mode-hook)
1648 (sc-eref-insert-selected))
1649 (kill-buffer sc-electric-bufname)))
1651 ;; functions for electric reference mode
1652 (defun sc-eref-show (index)
1653 "Show reference INDEX in `sc-rewrite-header-list'."
1654 (let ((msg "No %ing reference headers in list.")
1655 (last (length sc-rewrite-header-list)))
1658 ((sc-valid-index-p index) index)
1660 (if sc-electric-circular-p
1662 (progn (error msg "preced") 0)))
1664 (if sc-electric-circular-p
1666 (progn (error msg "follow") (1- last))))))
1667 (with-current-buffer sc-electric-bufname
1668 (let ((inhibit-read-only t))
1670 (goto-char (point-min))
1671 (sc-eref-insert-selected)
1672 ;; now shrink the window to just contain the electric reference
1674 (let ((hdrlines (count-lines (point-min) (point-max)))
1675 (winlines (1- (window-height))))
1676 (if (/= hdrlines winlines)
1677 (if (> hdrlines winlines)
1678 ;; we have to enlarge the window
1679 (enlarge-window (- hdrlines winlines))
1680 ;; we have to shrink the window
1681 (shrink-window (- winlines (max hdrlines
1682 window-min-height))))))))))
1684 (defun sc-eref-next ()
1685 "Display next reference in other buffer."
1687 (sc-eref-show (1+ sc-eref-style)))
1689 (defun sc-eref-prev ()
1690 "Display previous reference in other buffer."
1692 (sc-eref-show (1- sc-eref-style)))
1694 (defun sc-eref-setn ()
1695 "Set reference header selected as preferred."
1697 (setq sc-preferred-header-style sc-eref-style)
1698 (message "Preferred reference style set to header %d." sc-eref-style))
1700 (defun sc-eref-goto (refnum)
1701 "Show reference style indexed by REFNUM.
1702 If REFNUM is an invalid index, don't go to that reference and return
1704 (interactive "NGoto Reference: ")
1705 (if (sc-valid-index-p refnum)
1706 (sc-eref-show refnum)
1707 (error "Invalid reference: %d. (Range: [%d .. %d])"
1708 refnum 0 (1- (length sc-rewrite-header-list)))))
1710 (defun sc-eref-jump ()
1711 "Set reference header to preferred header."
1713 (sc-eref-show sc-preferred-header-style))
1715 (defun sc-eref-abort ()
1716 "Exit from electric reference mode without inserting reference."
1718 (setq sc-eref-style nil)
1719 (exit-recursive-edit))
1721 (defun sc-eref-exit ()
1722 "Exit from electric reference mode and insert selected reference."
1724 (exit-recursive-edit))
1726 (defun sc-insert-reference (arg)
1727 "Insert, at point, a reference header in the body of the reply.
1728 Numeric ARG indicates which header style from `sc-rewrite-header-list'
1729 to use when rewriting the header. No supplied ARG indicates use of
1730 `sc-preferred-header-style'.
1732 With just `\\[universal-argument]', electric reference insert mode is
1733 entered, regardless of the value of `sc-electric-references-p'. See
1734 `sc-electric-mode' for more information."
1738 (let ((preference (or (sc-valid-index-p arg)
1739 (sc-valid-index-p sc-preferred-header-style)
1740 sc-preferred-header-style
1742 (if sc-electric-references-p
1743 (sc-electric-mode preference)
1744 (sc-eref-insert-selected t)))))
1747 ;; ======================================================================
1748 ;; variable toggling
1750 (defun sc-raw-mode-toggle ()
1751 "Toggle, in one fell swoop, two important SC variables:
1752 `sc-fixup-whitespace-p' and `sc-auto-fill-region-p'"
1754 (setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p)
1755 sc-auto-fill-region-p (not sc-auto-fill-region-p))
1756 (force-mode-line-update))
1758 (defun sc-toggle-var (variable)
1759 "Boolean toggle VARIABLE's value.
1760 VARIABLE must be a bound symbol. nil values change to t, non-nil
1761 values are changed to nil."
1762 (message "%s changed from %s to %s"
1763 variable (symbol-value variable)
1764 (set variable (not (symbol-value variable)))))
1766 (defun sc-set-variable (var)
1767 "Set the Supercite VARIABLE.
1768 This function mimics `set-variable', except that the variable to set
1769 is determined non-interactively. The value is queried for in the
1770 minibuffer exactly the same way that `set-variable' does it.
1772 You can see the current value of the variable when the minibuffer is
1773 querying you by typing `C-h'. Note that the format is changed
1774 slightly from that used by `set-variable' -- the current value is
1775 printed just after the variable's name instead of at the bottom of the
1777 (let* ((minibuffer-help-form '(funcall myhelp))
1780 (with-output-to-temp-buffer "*Help*"
1783 (let ((print-length 20))
1784 (princ "\t(Current value: ")
1785 (prin1 (symbol-value var))
1787 (princ "\n\nDocumentation:\n")
1788 (princ (substring (documentation-property
1790 'variable-documentation)
1792 (with-current-buffer standard-output
1795 (set var (eval-minibuffer (format "Set %s to value: " var)))))
1797 (defmacro sc-toggle-symbol (rootname)
1798 `(defun ,(intern (concat "sc-T-" rootname)) ()
1800 (sc-toggle-var ',(intern (concat "sc-" rootname "-p")))))
1802 (defmacro sc-setvar-symbol (rootname)
1803 `(defun ,(intern (concat "sc-S-" rootname)) ()
1805 (sc-set-variable ',(intern (concat "sc-" rootname)))))
1807 (sc-toggle-symbol "confirm-always")
1808 (sc-toggle-symbol "downcase")
1809 (sc-toggle-symbol "electric-references")
1810 (sc-toggle-symbol "auto-fill-region")
1811 (sc-toggle-symbol "mail-nuke-blank-lines")
1812 (sc-toggle-symbol "nested-citation")
1813 (sc-toggle-symbol "electric-circular")
1814 (sc-toggle-symbol "use-only-preferences")
1815 (sc-toggle-symbol "fixup-whitespace")
1817 (sc-setvar-symbol "preferred-attribution-list")
1818 (sc-setvar-symbol "preferred-header-style")
1819 (sc-setvar-symbol "mail-nuke-mail-headers")
1820 (sc-setvar-symbol "mail-header-nuke-list")
1821 (sc-setvar-symbol "cite-region-limit")
1823 (defun sc-T-describe ()
1826 Supercite provides a number of key bindings which simplify the process
1827 of setting or toggling certain variables controlling its operation.
1829 Note on function names in this list: all functions of the form
1830 `sc-S-<name>' actually call `sc-set-variable' on the corresponding
1831 `sc-<name>' variable. All functions of the form `sc-T-<name>' call
1832 `sc-toggle-var' on the corresponding `sc-<name>-p' variable.
1836 (describe-function 'sc-T-describe))
1839 ;; ======================================================================
1840 ;; published interface to mail and news readers
1842 (define-minor-mode sc-minor-mode nil
1844 :lighter (" SC" (sc-auto-fill-region-p
1845 (":f" (sc-fixup-whitespace-p "w"))
1846 (sc-fixup-whitespace-p ":w")))
1847 :keymap `((,sc-mode-map-prefix . ,sc-mode-map)))
1850 (defun sc-cite-original ()
1851 "Workhorse citing function which performs the initial citation.
1852 This is callable from the various mail and news readers' reply
1853 function according to the agreed upon standard. See the associated
1854 info node `(SC)Top' for more details.
1855 `sc-cite-original' does not do any yanking of the
1856 original message but it does require a few things:
1858 1) The reply buffer is the current buffer.
1860 2) The original message has been yanked and inserted into the
1863 3) Verbose mail headers from the original message have been
1864 inserted into the reply buffer directly before the text of the
1867 4) Point is at the beginning of the verbose headers.
1869 5) Mark is at the end of the body of text to be cited.
1871 The region need not be active (and typically isn't when this
1872 function is called). Also, the hook `sc-pre-hook' is run before,
1873 and `sc-post-hook' is run after the guts of this function."
1874 (run-hooks 'sc-pre-hook)
1880 ;; grab point and mark since the region is probably not active when
1881 ;; this function gets automatically called. we want point to be a
1882 ;; mark so any deleting before point works properly
1883 (let* ((mark-active t)
1884 (point (point-marker))
1885 (mark (copy-marker (mark-marker))))
1887 ;; make sure point comes before mark, not all functions are
1894 ;; first process mail headers, and populate sc-mail-info
1895 (sc-mail-process-headers point mark)
1897 ;; now get possible attributions
1898 (sc-attribs-chop-address (or (sc-mail-field "from")
1899 (sc-mail-field "reply")
1900 (sc-mail-field "reply-to")
1901 (sc-mail-field "sender")))
1902 ;; select the attribution
1903 (sc-select-attribution)
1905 ;; cite the region, but first check the value of sc-cite-region-limit
1906 (let ((linecnt (count-lines point mark)))
1907 (and sc-cite-region-limit
1908 (if (or (not (numberp sc-cite-region-limit))
1909 (<= linecnt sc-cite-region-limit))
1911 ;; cite the region and insert the header rewrite
1912 (sc-cite-region point mark)
1914 (let ((sc-eref-style (or sc-preferred-header-style 0)))
1915 (if sc-electric-references-p
1916 (sc-electric-mode sc-eref-style)
1917 (sc-eref-insert-selected t))))
1920 "Region not cited. %d lines exceeds sc-cite-region-limit: %d"
1921 linecnt sc-cite-region-limit))))
1923 ;; finally, free the point-marker
1924 (set-marker point nil)
1925 (set-marker mark nil))
1926 (run-hooks 'sc-post-hook))
1929 ;; ======================================================================
1930 ;; bug reporting and miscellaneous commands
1932 (defun sc-open-line (arg)
1933 "Like `open-line', but insert the citation prefix at the front of the line.
1934 With numeric ARG, inserts that many new lines."
1937 (let ((start (point))
1938 (prefix (or (progn (beginning-of-line)
1939 (if (looking-at (sc-cite-regexp))
1948 (setq arg (1- arg))))))
1950 (defun sc-insert-citation (arg)
1951 "Insert citation string at beginning of current line if not already cited.
1952 With `\\[universal-argument]' insert citation even if line is already
1957 (if (or (not (looking-at (sc-cite-regexp)))
1958 (looking-at "^[ \t]*$")
1960 (insert (sc-mail-field "sc-citation"))
1961 (error "Line is already cited"))))
1963 (defun sc-describe ()
1964 "Read the Supercite info node."
1970 (provide 'supercite)
1971 (run-hooks 'sc-load-hook)
1973 ;;; supercite.el ends here