| blob | d10b073eb12d70b56518c0726af019f35eccf943 |
1 ;;; supercite.el --- minor mode for citing mail and news replies
3 ;; Copyright (C) 1993, 1997, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: 1993 Barry A. Warsaw <bwarsaw@python.org>
6 ;; Maintainer: Glenn Morris <rgm@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 <http://www.gnu.org/licenses/>.
25 ;; LCD Archive Entry
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|
30 ;;; Commentary:
32 ;;; Code:
34 \f
37 ;; start user configuration variables
38 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
41 "Supercite package."
47 "Supercite (regi) frames."
52 "Supercite attributions."
57 "Supercite citings."
62 "Hooking into supercite."
67 "If non-nil, automatically fill each paragraph after it has been cited."
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."
75 integer)
79 "String comprising first part of a citation."
84 "String comprising third part of a citation.
85 This string is used in both nested and non-nested citations."
90 "String comprising fourth and last part of a citation."
95 "Regexp describing citation leader for a cited line.
96 This should NOT have a leading `^' character."
100 ;; Nemacs and Mule users note: please see the texinfo manual for
101 ;; suggestions on setting these variables.
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'."
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."
119 "Regexp describing citation delimiter for a cited line.
120 This should NOT have a leading `^' character."
125 "Regexp describing citation separator for a cited line.
126 This should NOT have a leading `^' character."
131 "If non-nil, put a citation on blank lines."
136 "Alist for frame selection during citing.
137 Each element of this list has the following form:
138 (INFOKEY ((REGEXP . FRAME)
139 (REGEXP . FRAME)
140 (...)))
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."
148 symbol)))))
153 "Alist for frame selection during unciting.
154 See the variable `sc-cite-frame-alist' for details."
157 symbol)))))
162 "Alist for frame selection during reciting.
163 See the variable `sc-cite-frame-alist' for details."
166 symbol)))))
172 ;; frame. this makes things run much faster
177 sc-tmp-dumb-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.
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.
196 nil))
197 ;; this regexp catches nested citations in which the author cited
198 ;; a non-nested citation with a dumb citer.
200 ;; if we are looking at a nested citation then add a citation level
202 ;; if we're looking at a non-nested citation, coerce it to our style
204 ;; we must be looking at an uncited line. if we are in nested
205 ;; citations, just add a 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.
212 "Default REGI frame for citing a region."
220 ;; if the line is cited, uncite it
222 "Default REGI frame for unciting a region."
230 ;; do nothing on a blank line
232 ;; if we're looking at a cited line, recite it
234 ;; otherwise, the line is uncited, so just cite it
236 ;; be sure when we're done that we fill the last cited paragraph.
238 "Default REGI frame for reciting a region."
244 "This variable controls automatic citation of yanked text.
245 Valid values are:
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
253 `count-lines'.
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'."
265 "If non-nil, always confirm attribution string before citing text body."
270 "String used when author's attribution cannot be determined."
274 "String used when author's name cannot be determined."
278 "Non-nil means downcase the attribution and citation strings."
283 "If non-nil, treat electric references as circular."
288 "Hook for `sc-electric-mode' electric references mode."
292 "Use electric references if non-nil."
297 "If non-nil, delete all leading white space before citing."
302 "Hook which gets run once after Supercite loads."
306 "Hook which gets run before each invocation of `sc-cite-original'."
310 "Hook which gets run after each invocation of `sc-cite-original'."
315 "Warn if mail headers don't conform to RFC822."
319 "Value returned by `sc-mail-field' if field isn't in mail headers."
328 "Name list components which are filtered out as noise.
329 This variable contains an association list where each element is of
330 the form: (REGEXP . POSITION).
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
336 list and `any' to match all elements."
342 "Controls whether to use nested or non-nested citation style.
343 Non-nil uses nested citations, nil uses non-nested citations."
348 "Controls mail header nuking.
349 Used in conjunction with `sc-nuke-mail-header-list'. Valid values are:
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'
354 `keep' -- keep headers specified in `sc-nuke-mail-header-list'"
360 "List of mail header regexps to remove or keep in body of reply.
361 This list contains regular expressions describing the mail headers to
362 keep or nuke, depending on the value of `sc-nuke-mail-headers'."
368 "Specifies what to use as the attribution string.
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
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.
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
383 \(see below).
385 Supercite remembers the last attribution used when reciting an already
386 cited paragraph. This attribution will always be saved with the
388 last choice is always reset after every call of `sc-cite-original'.
390 Barring error conditions, the following preferences are always present
391 in the attribution alist:
399 ...
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
409 "An alist for selecting preferred attribution based on mail headers.
410 Each element of this list has the following form:
412 (INFOKEY ((REGEXP . ATTRIBUTION)
413 (REGEXP . ATTRIBUTION)
414 (...)))
416 Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular
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
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'
423 to be consulted during attribution selection."
427 string)))))
432 "Hook to run before selecting an attribution."
437 "Hook to run after selecting an attribution, but before confirmation."
443 "Hook to run before citing a region of text."
448 "Hook to run before unciting a region of text."
453 "Hook to run before reciting a region of text."
459 "Index into `sc-rewrite-header-list' specifying preferred header style.
460 Index zero accesses the first function in the list."
465 "String used at the beginning of built-in reference headers."
478 "List of reference header rewrite functions.
479 The variable `sc-preferred-header-style' controls which function in
480 this list is chosen for automatic reference header insertions.
481 Electric reference mode will cycle through this list of functions."
487 "Regular expression describing the separator between names and titles.
488 Set to nil to treat entire field as a name."
490 regexp)
494 "Controls what happens when the preferred attribution cannot be found.
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
497 string."
502 "Key binding to install Supercite keymap."
506 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
507 ;; end user configuration variables
508 \f
526 \f
527 ;; ======================================================================
528 ;; supercite keymaps
548 map)
567 map)
584 (define-key map [help] 'describe-mode)
585 map)
586 "Keymap for `sc-electric-mode' electric references mode.")
589 (defvar sc-minibuffer-local-completion-map
590 (let ((map (copy-keymap minibuffer-local-completion-map)))
591 (define-key map "\C-t" 'sc-toggle-fn)
592 (define-key map " " 'self-insert-command)
593 map)
594 "Keymap for minibuffer confirmation of attribution strings.")
596 (defvar sc-minibuffer-local-map
597 (let ((map (copy-keymap minibuffer-local-map)))
598 (define-key map "\C-t" 'sc-toggle-fn)
599 map)
600 "Keymap for minibuffer confirmation of attribution strings.")
602 \f
603 ;; ======================================================================
604 ;; utility functions
606 (defun sc-ask (alist)
607 "Ask a question in the minibuffer requiring a single character answer.
608 This function is kind of an extension of `y-or-n-p' where a single
609 letter is used to answer a question. Question is formed from ALIST
610 which has members of the form: (WORD . LETTER). WORD is the long
611 word form, while LETTER is the letter for selecting that answer. The
612 selected letter is returned, or nil if the question was not answered.
613 Note that WORD is a string and LETTER is a character. All LETTERs in
614 the list should be unique."
615 (let* ((prompt (concat
616 (mapconcat (lambda (elt) (car elt)) alist ", ")
617 "? ("
618 (mapconcat
619 (lambda (elt) (char-to-string (cdr elt))) alist "/")
620 ") "))
621 (p prompt)
622 (event
623 (if (fboundp 'allocate-event)
624 (allocate-event)
625 nil)))
626 (while (stringp p)
627 (if (let ((cursor-in-echo-area t)
628 (inhibit-quit t))
629 (message "%s" p)
630 (setq event (read-event))
631 (prog1 quit-flag (setq quit-flag nil)))
632 (progn
633 (message "%s%s" p (single-key-description event))
634 (if (fboundp 'deallocate-event)
635 (deallocate-event event))
636 (setq quit-flag nil)
637 (signal 'quit '())))
638 (let ((char
639 (if (featurep 'xemacs)
640 (let* ((key (and (key-press-event-p event) (event-key event)))
641 (char (and key (event-to-character event))))
642 char)
643 event))
644 elt)
645 (if char (setq char (downcase char)))
646 (cond
647 ((setq elt (rassq char alist))
648 (message "%s%s" p (car elt))
649 (setq p (cdr elt)))
650 ((if (fboundp 'button-release-event-p)
651 (button-release-event-p event)) ; ignore them
652 nil)
653 (t
654 (message "%s%s" p (single-key-description event))
655 (if (featurep 'xemacs)
656 (ding nil 'y-or-n-p)
657 (ding))
658 (discard-input)
659 (if (eq p prompt)
660 (setq p (concat "Try again. " prompt)))))))
661 (if (fboundp 'deallocate-event)
662 (deallocate-event event))
663 p))
665 (defun sc-scan-info-alist (alist)
666 "Find a match in the info alist that matches a regexp in ALIST."
667 (let ((sc-mumble "")
668 rtnvalue)
669 (while alist
670 (let* ((elem (car alist))
671 (infokey (car elem))
672 (infoval (sc-mail-field infokey))
673 (mlist (cadr elem)))
674 (while mlist
675 (let* ((ml-elem (car mlist))
676 (regexp (car ml-elem))
677 (thing (cdr ml-elem)))
678 (if (string-match regexp infoval)
679 ;; we found a match, time to return
680 (setq rtnvalue thing
681 mlist nil
682 alist nil)
683 ;; else we didn't find a match
684 (setq mlist (cdr mlist))))) ;end of mlist loop
685 (setq alist (cdr alist)))) ;end of alist loop
686 rtnvalue))
688 \f
689 ;; ======================================================================
690 ;; extract mail field information from headers in reply buffer
692 ;; holder variables for bc happiness
693 (defvar sc-mail-headers-start nil
694 "Start of header fields.")
695 (defvar sc-mail-headers-end nil
696 "End of header fields.")
697 (defvar sc-mail-field-history nil
698 "For minibuffer completion on mail field queries.")
699 (defvar sc-mail-field-modification-history nil
700 "For minibuffer completion on mail field modifications.")
701 (defvar sc-mail-glom-frame
702 '((begin (setq sc-mail-headers-start (point)))
703 ("^From " (sc-mail-check-from) nil nil)
706 ("^$" (list 'abort '(step . 0)))
708 (sc-mail-warn-if-non-rfc822-p (sc-mail-error-in-mail-field))
709 (end (setq sc-mail-headers-end (point))))
710 "Regi frame for glomming mail header information.")
711 (put 'sc-mail-glom-frame 'risky-local-variable t)
713 (defvar curline) ; dynamic bondage
715 ;; regi functions
717 ;; http://lists.gnu.org/archive/html/emacs-devel/2009-02/msg00691.html
718 ;; When rmail replies to a message with full headers visible, the "From "
719 ;; line can be included.
720 (defun sc-mail-check-from ()
722 Such a line should only occur at the very start of the headers."
723 (and sc-mail-warn-if-non-rfc822-p
724 (/= (point) sc-mail-headers-start)
725 (sc-mail-error-in-mail-field)))
727 (defun sc-mail-fetch-field (&optional attribs-p)
728 "Insert a key and value into `sc-mail-info' alist.
729 If optional ATTRIBS-P is non-nil, the key/value pair is placed in
730 `sc-attributions' too."
732 (let* ((key (downcase (match-string-no-properties 1 curline)))
733 (val (match-string-no-properties 2 curline))
734 (keyval (cons key val)))
735 (push keyval sc-mail-info)
736 (if attribs-p
737 (push keyval sc-attributions))))
738 nil)
740 (defun sc-mail-append-field ()
741 "Append a continuation line onto the last fetched mail field's info."
742 (let ((keyval (car sc-mail-info)))
744 (setcdr keyval (concat (cdr keyval) " "
745 (match-string-no-properties 1 curline)))))
746 nil)
748 (defun sc-mail-error-in-mail-field ()
749 "Issue warning that mail headers don't conform to RFC 822."
750 (let* ((len (min (length curline) 10))
751 (ellipsis (if (< len (length curline)) "..." ""))
753 (message msg (substring curline 0 len) ellipsis))
754 (beep)
755 (sit-for 2)
756 nil)
758 ;; mail header nuking
759 (defvar sc-mail-last-header-nuked-p nil
760 "True if the last header was nuked.")
762 (defun sc-mail-nuke-line ()
763 "Nuke the current mail header line."
764 (delete-region (line-beginning-position) (line-beginning-position 2))
765 '((step . -1)))
767 (defun sc-mail-nuke-header-line ()
768 "Delete current-line and set up for possible continuation."
769 (setq sc-mail-last-header-nuked-p t)
770 (sc-mail-nuke-line))
772 (defun sc-mail-nuke-continuation-line ()
773 "Delete a continuation line if the last header line was deleted."
774 (if sc-mail-last-header-nuked-p
775 (sc-mail-nuke-line)))
777 (defun sc-mail-cleanup-blank-lines ()
778 "Leave some blank lines after original mail headers are nuked.
779 The number of lines left is specified by `sc-blank-lines-after-headers'."
780 (if sc-blank-lines-after-headers
781 (save-restriction
782 (widen)
784 (forward-line 1)
785 (delete-blank-lines)
786 (beginning-of-line)
788 (delete-region (line-beginning-position)
789 (line-beginning-position 2)))
791 nil)
793 (defun sc-mail-build-nuke-frame ()
794 "Build the regiframe for nuking mail headers."
795 (let (every-func entry-func nonentry-func)
796 (cond
797 ((eq sc-nuke-mail-headers 'all)
798 (setq every-func '(progn (forward-line -1) (sc-mail-nuke-line))))
799 ((eq sc-nuke-mail-headers 'specified)
800 (setq entry-func '(sc-mail-nuke-header-line)
801 nonentry-func '(setq sc-mail-last-header-nuked-p nil)))
802 ((eq sc-nuke-mail-headers 'keep)
803 (setq entry-func '(setq sc-mail-last-header-nuked-p nil)
804 nonentry-func '(sc-mail-nuke-header-line)))
805 ;; we never get far enough to interpret a frame if s-n-m-h == 'none
806 ((eq sc-nuke-mail-headers 'none))
807 (t (error "Invalid value for sc-nuke-mail-headers: %s"
808 sc-nuke-mail-headers))) ; end-cond
809 (append
810 (and entry-func
811 (regi-mapcar sc-nuke-mail-header-list entry-func nil t))
813 (and (not every-func)
815 '((begin (setq sc-mail-last-header-zapped-p nil)))
816 '((end (sc-mail-cleanup-blank-lines)))
817 (and every-func (list (list 'every every-func))))))
819 ;; mail processing and zapping. this is the top level entry defun to
820 ;; all header processing.
821 (defun sc-mail-process-headers (start end)
822 "Process original mail message's mail headers.
823 After processing, mail headers may be nuked. Header information is
824 stored in `sc-mail-info', and any old information is lost unless an
825 error occurs."
826 (interactive "r")
827 (let ((info (copy-alist sc-mail-info))
828 (attribs (copy-alist sc-attributions)))
829 (setq sc-mail-info nil
830 sc-attributions nil)
831 (regi-interpret sc-mail-glom-frame start end)
832 (if (null sc-mail-info)
833 (progn
834 (message "No mail headers found! Restoring old information.")
835 (setq sc-mail-info info
836 sc-attributions attribs))
837 (regi-interpret (sc-mail-build-nuke-frame)
838 sc-mail-headers-start sc-mail-headers-end))))
840 \f
841 ;; let the user change mail field information
842 (defun sc-mail-field (field)
843 "Return the mail header field value associated with FIELD.
844 If there was no mail header with FIELD as its key, return the value of
845 `sc-mumble'. FIELD is case insensitive."
846 (or (cdr (assoc-string field sc-mail-info 'case-fold)) sc-mumble))
848 (defun sc-mail-field-query (arg)
849 "View the value of a mail field.
851 Action can be one of: View, Modify, Add, or Delete."
852 (interactive "P")
853 (let* ((alist '(("view" . ?v) ("modify" . ?m) ("add" . ?a) ("delete" . ?d)))
854 (action (if (not arg) ?v (sc-ask alist)))
855 key)
856 (if (not action)
857 ()
858 (setq key (completing-read
859 (concat (car (rassq action alist))
860 " information key: ")
861 sc-mail-info nil
862 (if (eq action ?a) nil 'noexit)
863 nil 'sc-mail-field-history))
864 (cond
865 ((eq action ?v)
866 (message "%s: %s" key (cdr (assoc key sc-mail-info))))
867 ((eq action ?d)
868 (setq sc-mail-info (delq (assoc key sc-mail-info) sc-mail-info)))
869 ((eq action ?m)
870 (let ((keyval (assoc key sc-mail-info)))
871 ;; first put initial value onto list if not already there
872 (if (not (member (cdr keyval)
873 sc-mail-field-modification-history))
874 (setq sc-mail-field-modification-history
875 (cons (cdr keyval) sc-mail-field-modification-history)))
876 (setcdr keyval (read-string
877 (concat key ": ") (cdr keyval)
878 'sc-mail-field-modification-history))))
879 ((eq action ?a)
880 (push (cons key (read-string (concat key ": "))) sc-mail-info))))))
882 \f
883 ;; ======================================================================
884 ;; attributions
886 (defvar sc-attribution-confirmation-history nil
887 "History for confirmation of attribution strings.")
888 (defvar sc-citation-confirmation-history nil
889 "History for confirmation of attribution prefixes.")
891 (defun sc-attribs-%@-addresses (from &optional delim)
892 "Extract the author's email terminus from email address FROM.
893 Match addresses of the style ``name%[stuff].'' when called with DELIM
896 addresses of the style ``name''."
897 (and (string-match (concat "[-[:alnum:]_.]+" delim) from 0)
898 (substring from
899 (match-beginning 0)
900 (- (match-end 0) (if (null delim) 0 1)))))
902 (defun sc-attribs-!-addresses (from)
903 "Extract the author's email terminus from email address FROM.
904 Match addresses of the style ``[stuff]![stuff]...!name[stuff].''"
905 (let ((eos (length from))
907 from 0))
908 (mend (match-end 0)))
909 (and mstart
910 (substring from (1+ mstart) (- mend (if (= mend eos) 0 1))))))
912 (defun sc-attribs-<>-addresses (from)
913 "Extract the author's email terminus from email address FROM.
914 Match addresses of the style ``<name[stuff]>.''"
916 (match-string 1 from)))
918 (defun sc-get-address (from author)
919 "Get the full email address path from FROM.
920 AUTHOR is the author's name (which is removed from the address)."
921 (let ((eos (length from)))
924 (let ((address (substring from (match-end 0) eos)))
925 (if (and (= (aref address 0) ?<)
926 (= (aref address (1- (length address))) ?>))
927 (substring address 1 (1- (length address)))
928 address))
929 (if (string-match "[-[:alnum:]!@%._]+" from 0)
930 (match-string 0 from)
931 ""))))
933 (defun sc-attribs-emailname (from)
934 "Get the email terminus name from FROM."
935 (or
936 (sc-attribs-%@-addresses from "%")
937 (sc-attribs-%@-addresses from "@")
938 (sc-attribs-!-addresses from)
939 (sc-attribs-<>-addresses from)
940 (sc-attribs-%@-addresses from)
941 (substring from 0 10)))
943 (defun sc-name-substring (string start end extend)
944 "Extract the specified substring of STRING from START to END.
945 EXTEND is the number of characters on each side to extend the
946 substring."
947 (and start
948 (let ((sos (+ start extend))
949 (eos (- end extend)))
950 (substring string sos
951 (or (string-match sc-titlecue-regexp string sos) eos)))))
953 (defun sc-attribs-extract-namestring (from)
954 "Extract the name string from FROM.
955 This should be the author's full name minus an optional title."
956 ;; FIXME: we probably should use mail-extract-address-components.
957 (let ((namestring
958 (or
959 ;; If there is a <...> in the name,
960 ;; treat everything before that as the full name.
961 ;; Even if it contains parens, use the whole thing.
962 ;; On the other hand, we do look for quotes in the usual way.
963 (and (string-match " *<.*>" from 0)
964 (let ((before-angles
965 (sc-name-substring from 0 (match-beginning 0) 0)))
967 (sc-name-substring
968 before-angles (match-beginning 0) (match-end 0) 1)
969 before-angles)))
970 (sc-name-substring
971 from (string-match "(.*)" from 0) (match-end 0) 1)
972 (sc-name-substring
974 (sc-name-substring
976 (match-end 1) 0)
977 (sc-attribs-emailname from))))
978 ;; strip off any leading or trailing whitespace
979 (if namestring
980 (let ((bos 0)
981 (eos (1- (length namestring))))
982 (while (and (<= bos eos)
984 (setq bos (1+ bos)))
985 (while (and (> eos bos)
987 (setq eos (1- eos)))
988 (substring namestring bos (1+ eos))))))
990 (defun sc-attribs-chop-namestring (namestring)
991 "Convert NAMESTRING to a list of names.
995 (cons (match-string 2 namestring)
996 (sc-attribs-chop-namestring (substring namestring (match-end 3))))))
998 (defun sc-attribs-strip-initials (namelist)
999 "Extract the author's initials from the NAMELIST."
1000 (mapconcat
1001 (lambda (name)
1002 (if (< 0 (length name))
1003 (substring name 0 1)))
1004 namelist ""))
1006 (defun sc-guess-attribution (&optional string)
1007 "Guess attribution string on current line.
1008 If attribution cannot be guessed, nil is returned. Optional STRING if
1009 supplied, is used instead of the line point is on in the current buffer."
1010 (let ((start 0)
1011 (string (or string (buffer-substring (line-beginning-position)
1012 (line-end-position))))
1013 attribution)
1014 (and
1015 (= start (or (string-match sc-citation-leader-regexp string start) -1))
1016 (setq start (match-end 0))
1017 (= start (or (string-match sc-citation-root-regexp string start) 1))
1018 (setq attribution (match-string 0 string)
1019 start (match-end 0))
1020 (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
1021 (setq start (match-end 0))
1022 (= start (or (string-match sc-citation-separator-regexp string start) -1))
1023 attribution)))
1025 (defun sc-attribs-filter-namelist (namelist)
1026 "Filter out noise in NAMELIST according to `sc-name-filter-alist'."
1027 (let ((elements (length namelist))
1028 (position -1)
1029 keepers filtered-list)
1030 (mapc
1031 (lambda (name)
1032 (setq position (1+ position))
1033 (let ((keep-p t))
1034 (mapc
1035 (function
1036 (lambda (filter)
1037 (let ((regexp (car filter))
1038 (pos (cdr filter)))
1039 (if (and (string-match regexp name)
1040 (or (and (numberp pos)
1041 (= pos position))
1042 (and (eq pos 'last)
1043 (= position (1- elements)))
1044 (eq pos 'any)))
1045 (setq keep-p nil)))))
1046 sc-name-filter-alist)
1047 (if keep-p
1048 (setq keepers (cons position keepers)))))
1049 namelist)
1050 (mapc
1051 (lambda (position)
1052 (setq filtered-list (cons (nth position namelist) filtered-list)))
1053 keepers)
1054 filtered-list))
1056 (defun sc-attribs-chop-address (from)
1057 "Extract attribution information from FROM.
1058 This populates the `sc-attributions' with the list of possible attributions."
1059 (if (and (stringp from)
1060 (< 0 (length from)))
1061 (let* ((sc-mumble "")
1062 (namestring (sc-attribs-extract-namestring from))
1063 (namelist (sc-attribs-filter-namelist
1064 (sc-attribs-chop-namestring namestring)))
1065 (revnames (reverse (cdr namelist)))
1066 (firstname (car namelist))
1067 (midnames (reverse (cdr revnames)))
1068 (lastname (car revnames))
1069 (initials (sc-attribs-strip-initials namelist))
1070 (emailname (sc-attribs-emailname from))
1071 (n 1)
1072 author middlenames)
1074 ;; put basic information
1075 (setq
1076 ;; put middle names and build sc-author entry
1077 middlenames (mapconcat
1078 (lambda (midname)
1079 (let ((key-attribs (format "middlename-%d" n))
1080 (key-mail (format "sc-middlename-%d" n)))
1081 (push (cons key-attribs midname) sc-attributions)
1082 (push (cons key-mail midname) sc-mail-info)
1083 (setq n (1+ n))
1084 midname))
1085 midnames " ")
1087 author (concat firstname " " middlenames (and midnames " ") lastname)
1089 sc-attributions (append
1090 (list
1091 (cons "firstname" firstname)
1092 (cons "lastname" lastname)
1093 (cons "emailname" emailname)
1094 (cons "initials" initials))
1095 sc-attributions)
1096 sc-mail-info (append
1097 (list
1098 (cons "sc-firstname" firstname)
1099 (cons "sc-middlenames" middlenames)
1100 (cons "sc-lastname" lastname)
1101 (cons "sc-emailname" emailname)
1102 (cons "sc-initials" initials)
1103 (cons "sc-author" author)
1104 (cons "sc-from-address" (sc-get-address
1105 (sc-mail-field "from")
1106 namestring))
1107 (cons "sc-reply-address" (sc-get-address
1108 (sc-mail-field "reply-to")
1109 namestring))
1110 (cons "sc-sender-address" (sc-get-address
1111 (sc-mail-field "sender")
1112 namestring)))
1113 sc-mail-info)))
1114 ;; from string is empty
1115 (push (cons "sc-author" sc-default-author-name) sc-mail-info)))
1117 (defvar sc-attrib-or-cite nil
1118 "Used to toggle between attribution input or citation input.")
1120 (defun sc-toggle-fn ()
1121 "Toggle between attribution selection and citation selection.
1122 Only used during confirmation."
1123 (interactive)
1124 (setq sc-attrib-or-cite (not sc-attrib-or-cite))
1125 (throw 'sc-reconfirm t))
1127 (defun sc-select-attribution ()
1128 "Select an attribution from `sc-attributions'.
1130 Variables involved in selection process include:
1131 `sc-preferred-attribution-list'
1132 `sc-use-only-preference-p'
1133 `sc-confirm-always-p'
1134 `sc-default-attribution'
1135 `sc-attrib-selection-list'.
1137 Runs the hook `sc-attribs-preselect-hook' before selecting an
1138 attribution and the hook `sc-attribs-postselect-hook' after making the
1139 selection but before querying is performed. During
1140 `sc-attribs-postselect-hook' the variable `citation' is bound to the
1141 auto-selected citation string and the variable `attribution' is bound
1142 to the auto-selected attribution string."
1143 (run-hooks 'sc-attribs-preselect-hook)
1144 (let ((query-p sc-confirm-always-p)
1145 attribution citation
1146 (attriblist sc-preferred-attribution-list))
1148 ;; first cruise through sc-preferred-attribution-list looking for
1149 ;; a match in either sc-attributions or sc-mail-info. if the
1150 ;; element is "sc-consult", then we have to do the alist
1151 ;; consultation phase
1152 (while attriblist
1153 (let* ((preferred (car attriblist)))
1154 (cond
1155 ((string= preferred "sc-consult")
1156 ;; we've been told to consult the attribution vs. mail
1157 ;; header key alist. we do this until we find a match in
1158 ;; the sc-attrib-selection-list. if we do not find a match,
1159 ;; we continue scanning attriblist
1160 (let ((attrib (sc-scan-info-alist sc-attrib-selection-list)))
1161 (cond
1162 ((not attrib)
1163 (setq attriblist (cdr attriblist)))
1164 ((stringp attrib)
1165 (setq attribution attrib
1166 attriblist nil))
1167 ((listp attrib)
1168 (setq attribution (eval attrib))
1169 (if (stringp attribution)
1170 (setq attriblist nil)
1171 (setq attribution nil
1172 attriblist (cdr attriblist))))
1173 (t (error "%s did not evaluate to a string or list!"
1174 "sc-attrib-selection-list")))))
1175 ((setq attribution (cdr (assoc preferred sc-attributions)))
1176 (setq attriblist nil))
1177 (t
1178 (setq attriblist (cdr attriblist))))))
1180 ;; if preference was not found, we may use a secondary method to
1181 ;; find a valid attribution
1182 (if (and (not attribution)
1183 (not sc-use-only-preference-p))
1184 ;; secondary method tries to find a preference in this order
1185 ;; 1. sc-lastchoice
1186 ;; 2. x-attribution
1187 ;; 3. firstname
1188 ;; 4. lastname
1189 ;; 5. initials
1190 ;; 6. first non-empty attribution in alist
1191 (setq attribution
1192 (or (cdr (assoc "sc-lastchoice" sc-attributions))
1193 (cdr (assoc "x-attribution" sc-attributions))
1194 (cdr (assoc "firstname" sc-attributions))
1195 (cdr (assoc "lastname" sc-attributions))
1196 (cdr (assoc "initials" sc-attributions))
1197 (cdr (car sc-attributions)))))
1199 ;; still couldn't find an attribution. we're now limited to using
1200 ;; the default attribution, but we'll force a query when this happens
1201 (if (not attribution)
1202 (setq attribution sc-default-attribution
1203 query-p t))
1205 ;; create the attribution prefix
1206 (setq citation (sc-make-citation attribution))
1208 ;; run the post selection hook before querying the user
1209 (run-hooks 'sc-attribs-postselect-hook)
1211 ;; query for confirmation
1212 (if query-p
1213 (let* ((query-alist (mapcar (lambda (entry) (list (cdr entry)))
1214 sc-attributions))
1215 (minibuffer-local-completion-map
1216 sc-minibuffer-local-completion-map)
1217 (minibuffer-local-map sc-minibuffer-local-map)
1218 (initial attribution)
1219 (completer-disable t) ; in case completer.el is used
1220 choice)
1221 (setq sc-attrib-or-cite nil) ; nil==attribution, t==citation
1222 (while
1223 (catch 'sc-reconfirm
1224 (progn
1225 (setq choice
1226 (if sc-attrib-or-cite
1227 (read-string
1228 "Enter citation prefix: "
1229 citation
1230 'sc-citation-confirmation-history)
1231 (completing-read
1232 "Complete attribution name: "
1233 query-alist nil nil
1234 (cons initial 0)
1235 'sc-attribution-confirmation-history)))
1236 nil)))
1237 (if sc-attrib-or-cite
1238 ;; since the citation was chosen, we have to guess at
1239 ;; the attribution
1240 (setq citation choice
1241 attribution (or (sc-guess-attribution citation)
1242 citation))
1244 (setq citation (sc-make-citation choice)
1245 attribution choice))))
1247 ;; its possible that the user wants to downcase the citation and
1248 ;; attribution
1249 (if sc-downcase-p
1250 (setq citation (downcase citation)
1251 attribution (downcase attribution)))
1253 ;; set up mail info alist
1254 (let* ((ckey "sc-citation")
1255 (akey "sc-attribution")
1256 (ckeyval (assoc ckey sc-mail-info))
1257 (akeyval (assoc akey sc-mail-info)))
1258 (if ckeyval
1259 (setcdr ckeyval citation)
1260 (push (cons ckey citation) sc-mail-info))
1261 (if akeyval
1262 (setcdr akeyval attribution)
1263 (push (cons akey attribution) sc-mail-info)))
1265 ;; set the sc-lastchoice attribution
1266 (let* ((lkey "sc-lastchoice")
1267 (lastchoice (assoc lkey sc-attributions)))
1268 (if lastchoice
1269 (setcdr lastchoice attribution)
1270 (push (cons lkey attribution) sc-attributions)))))
1272 \f
1273 ;; ======================================================================
1274 ;; filladapt hooks for supercite 3.1. you shouldn't need anything
1275 ;; extra to make gin-mode understand supercited lines. Even this
1276 ;; stuff might not be entirely necessary...
1278 (defun sc-cite-regexp (&optional root-regexp)
1279 "Return a regexp describing a Supercited line.
1280 The regexp is the concatenation of `sc-citation-leader-regexp',
1281 `sc-citation-root-regexp', `sc-citation-delimiter-regexp', and
1282 `sc-citation-separator-regexp'. If optional ROOT-REGEXP is supplied,
1283 use it instead of `sc-citation-root-regexp'."
1284 (concat sc-citation-leader-regexp
1285 (or root-regexp sc-citation-root-regexp)
1286 sc-citation-delimiter-regexp
1287 sc-citation-separator-regexp))
1289 (defun sc-make-citation (attribution)
1290 "Make a non-nested citation from ATTRIBUTION."
1291 (concat sc-citation-leader
1292 attribution
1293 sc-citation-delimiter
1294 sc-citation-separator))
1296 (defvar filladapt-prefix-table)
1298 (defun sc-setup-filladapt ()
1299 "Setup `filladapt-prefix-table' to handle Supercited paragraphs."
1300 (let* ((fa-sc-elt 'filladapt-supercite-included-text)
1301 (elt (rassq fa-sc-elt filladapt-prefix-table)))
1302 (if elt (setcar elt (sc-cite-regexp))
1303 (message "Filladapt doesn't seem to know about Supercite.")
1304 (beep))))
1306 \f
1307 ;; ======================================================================
1308 ;; citing and unciting regions of text
1310 (defvar sc-fill-begin 1
1311 "Buffer position to begin filling.")
1312 (defvar sc-fill-line-prefix ""
1313 "Fill prefix of previous line")
1315 ;; filling
1316 (defun sc-fill-if-different (&optional prefix)
1317 "Fill the region bounded by `sc-fill-begin' and point.
1318 Only fill if optional PREFIX is different than `sc-fill-line-prefix'.
1319 If `sc-auto-fill-region-p' is nil, do not fill region. If PREFIX is
1320 not supplied, initialize fill variables. This is useful for a regi
1321 `begin' frame-entry."
1322 (if (not prefix)
1323 (setq sc-fill-line-prefix ""
1324 sc-fill-begin (line-beginning-position))
1325 (if (and sc-auto-fill-region-p
1326 (not (string= prefix sc-fill-line-prefix)))
1327 (let ((fill-prefix sc-fill-line-prefix))
1328 (if (not (string= fill-prefix ""))
1329 (fill-region sc-fill-begin (line-beginning-position)))
1330 (setq sc-fill-line-prefix prefix
1331 sc-fill-begin (line-beginning-position)))))
1332 nil)
1334 (defun sc-cite-coerce-cited-line ()
1335 "Coerce a Supercited line to look like our style."
1336 (let* ((attribution (sc-guess-attribution))
1337 (regexp (sc-cite-regexp attribution))
1338 (prefix (sc-make-citation attribution)))
1339 (if (and attribution
1340 (looking-at regexp))
1341 (progn
1342 (delete-region
1343 (match-beginning 0)
1344 (save-excursion
1345 (goto-char (match-end 0))
1346 (if (bolp) (forward-char -1))
1347 (point)))
1348 (insert prefix)
1349 (sc-fill-if-different prefix)))
1350 nil))
1352 (defun sc-cite-coerce-dumb-citer ()
1353 "Coerce a non-nested citation that's been cited with a dumb nesting citer."
1354 (delete-region (match-beginning 1) (match-end 1))
1355 (beginning-of-line)
1356 (sc-cite-coerce-cited-line))
1358 (defun sc-guess-nesting (&optional string)
1359 "Guess the citation nesting on the current line.
1360 If nesting cannot be guessed, nil is returned. Optional STRING if
1361 supplied, is used instead of the line point is on in the current
1362 buffer."
1363 (let ((start 0)
1364 (string (or string (buffer-substring (line-beginning-position)
1365 (line-end-position))))
1366 nesting)
1367 (and
1368 (= start (or (string-match sc-citation-leader-regexp string start) -1))
1369 (setq start (match-end 0))
1370 (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
1371 (setq nesting (match-string 0 string)
1372 start (match-end 0))
1373 (= start (or (string-match sc-citation-separator-regexp string start) -1))
1374 nesting)))
1376 (defun sc-add-citation-level ()
1377 "Add a citation level for nested citation style w/ coercion."
1378 (let* ((nesting (sc-guess-nesting))
1379 (citation (make-string (1+ (length nesting))
1380 (string-to-char sc-citation-delimiter)))
1381 (prefix (concat sc-citation-leader citation sc-citation-separator)))
1382 (if (looking-at (sc-cite-regexp ""))
1383 (delete-region (match-beginning 0) (match-end 0)))
1384 (insert prefix)
1385 (sc-fill-if-different prefix)))
1387 (defun sc-cite-line (&optional citation)
1388 "Cite a single line of uncited text.
1389 Optional CITATION overrides any citation automatically selected."
1390 (if sc-fixup-whitespace-p
1391 (fixup-whitespace))
1392 (let ((prefix (or citation
1393 (cdr (assoc "sc-citation" sc-mail-info))
1394 sc-default-attribution)))
1395 (insert prefix)
1396 (sc-fill-if-different prefix))
1397 nil)
1399 (defun sc-uncite-line ()
1400 "Remove citation from current line."
1401 (let ((cited (looking-at (sc-cite-regexp))))
1402 (if cited
1403 (delete-region (match-beginning 0) (match-end 0))))
1404 nil)
1406 (defun sc-recite-line (regexp)
1407 "Remove citation matching REGEXP from current line and recite line."
1408 (let ((cited (looking-at (concat "^" regexp)))
1409 (prefix (cdr (assoc "sc-citation" sc-mail-info))))
1410 (if cited
1411 (delete-region (match-beginning 0) (match-end 0)))
1412 (insert (or prefix sc-default-attribution))
1413 (sc-fill-if-different prefix))
1414 nil)
1416 ;; interactive functions
1417 (defun sc-cite-region (start end &optional confirm-p interactive)
1418 "Cite a region delineated by START and END.
1419 If optional CONFIRM-P is non-nil, the attribution is confirmed before
1420 its use in the citation string. This function first runs
1421 `sc-pre-cite-hook'.
1423 When called interactively, the optional arg INTERACTIVE is non-nil,
1424 and that means call `sc-select-attribution' too."
1426 (undo-boundary)
1427 (let ((frame (sc-scan-info-alist sc-cite-frame-alist))
1428 (sc-confirm-always-p (if confirm-p t sc-confirm-always-p)))
1429 (if (and frame (symbolp frame))
1430 (setq frame (symbol-value frame)))
1431 (or frame (setq frame sc-default-cite-frame))
1432 (run-hooks 'sc-pre-cite-hook)
1433 (if interactive
1434 (sc-select-attribution))
1435 (regi-interpret frame start end)))
1437 (defun sc-uncite-region (start end)
1438 "Uncite a region delineated by START and END.
1439 First runs `sc-pre-uncite-hook'."
1440 (interactive "r")
1441 (undo-boundary)
1442 (let ((frame (sc-scan-info-alist sc-uncite-frame-alist)))
1443 (if (and frame (symbolp frame))
1444 (setq frame (symbol-value frame)))
1445 (or frame (setq frame sc-default-uncite-frame))
1446 (run-hooks 'sc-pre-uncite-hook)
1447 (regi-interpret frame start end)))
1449 (defun sc-recite-region (start end)
1450 "Recite a region delineated by START and END.
1451 First runs `sc-pre-recite-hook'."
1452 (interactive "r")
1453 (let ((sc-confirm-always-p t))
1454 (sc-select-attribution))
1455 (undo-boundary)
1456 (let ((frame (sc-scan-info-alist sc-recite-frame-alist)))
1457 (if (and frame (symbolp frame))
1458 (setq frame (symbol-value frame)))
1459 (or frame (setq frame sc-default-recite-frame))
1460 (run-hooks 'sc-pre-recite-hook)
1461 (regi-interpret frame start end)))
1463 \f
1464 ;; ======================================================================
1465 ;; building headers
1467 (defun sc-hdr (prefix field &optional sep return-nil-p)
1468 "Returns a concatenation of PREFIX and FIELD.
1469 If FIELD is not a string or is the empty string, the empty string will
1470 be returned. Optional third argument SEP is concatenated on the end if
1471 it is a string. Returns empty string, unless optional RETURN-NIL-P is
1472 non-nil."
1473 (if (and (stringp field)
1474 (not (string= field "")))
1475 (concat prefix field (or sep ""))
1476 (and (not return-nil-p) "")))
1478 (defun sc-whofrom ()
1480 (let ((sc-mumble nil))
1481 (sc-mail-field "from")))
1483 (defun sc-no-header ()
1484 "Does nothing. Use this instead of nil to get a blank header."
1485 ())
1487 (declare-function mh-in-header-p "mh-utils" ())
1489 (defun sc-no-blank-line-or-header ()
1490 "Similar to `sc-no-header' except it removes the preceding blank line."
1491 (and (not (bobp))
1492 (eolp)
1493 (progn (forward-line -1)
1494 (or (= (point)
1495 (save-excursion
1496 (rfc822-goto-eoh)
1497 (line-beginning-position 2)))
1498 (and (eq major-mode 'mh-letter-mode)
1499 (mh-in-header-p))))
1500 (progn
1501 (forward-line)
1502 (kill-line))))
1504 (defun sc-header-on-said ()
1508 (let ((sc-mumble "")
1509 (whofrom (sc-whofrom)))
1510 (if whofrom
1511 (insert sc-reference-tag-string
1512 (sc-hdr "On " (sc-mail-field "date") ", ")
1515 (defun sc-header-inarticle-writes ()
1518 (let ((sc-mumble "")
1519 (whofrom (sc-mail-field "from")))
1520 (if whofrom
1521 (insert sc-reference-tag-string
1522 (sc-hdr "In article " (sc-mail-field "message-id") ", ")
1525 (defun sc-header-regarding-adds ()
1528 (let ((sc-mumble "")
1529 (whofrom (sc-whofrom)))
1530 (if whofrom
1531 (insert sc-reference-tag-string
1532 (sc-hdr "Regarding " (sc-mail-field "subject") "; ")
1535 (defun sc-header-attributed-writes ()
1537 Treats these fields in a similar manner to `sc-header-on-said'."
1538 (let ((sc-mumble "")
1539 (whofrom (sc-whofrom)))
1540 (if whofrom
1541 (insert sc-reference-tag-string
1543 (sc-hdr "" (sc-mail-field "sc-author") " ")
1544 (or (sc-hdr "<" (sc-mail-field "sc-from-address") ">" t)
1545 (sc-hdr "<" (sc-mail-field "sc-reply-address") ">" t)
1546 "")
1549 (defun sc-header-author-writes ()
1550 "<sc-author> writes:"
1551 (let ((sc-mumble "")
1552 (whofrom (sc-whofrom)))
1553 (if whofrom
1554 (insert sc-reference-tag-string
1555 (sc-hdr "" (sc-mail-field "sc-author"))
1558 (defun sc-header-verbose ()
1559 "Very verbose, some say gross."
1560 (let ((sc-mumble "")
1561 (whofrom (sc-whofrom))
1562 (tag sc-reference-tag-string))
1563 (if whofrom
1567 (sc-hdr (concat tag "from the organization of ")
1569 (let ((rtag (concat tag "who can be reached at: ")))
1572 ""))
1573 (sc-hdr
1576 (sc-hdr (concat tag "had this to say in article ")
1578 (sc-hdr (concat tag "in newsgroups ")
1580 (sc-hdr (concat tag "concerning the subject of ")
1582 (sc-hdr (concat tag "(see ")
1583 (sc-mail-field "references")
1586 \f
1587 ;; ======================================================================
1588 ;; header rewrites
1590 (defconst sc-electric-bufname " *sc-erefs* "
1591 "Supercite electric reference mode's buffer name.")
1592 (defvar sc-eref-style 0
1593 "Current electric reference style.")
1595 (defun sc-valid-index-p (index)
1596 "Returns INDEX if it is a valid index into `sc-rewrite-header-list'.
1597 Otherwise returns nil."
1598 ;; a number, and greater than or equal to zero
1599 ;; less than or equal to the last index
1600 (and (natnump index)
1601 (< index (length sc-rewrite-header-list))
1602 index))
1604 (defun sc-eref-insert-selected (&optional nomsg)
1605 "Insert the selected reference header in the current buffer.
1606 Optional NOMSG, if non-nil, inhibits printing messages, unless an
1607 error occurs."
1608 (let ((ref (nth sc-eref-style sc-rewrite-header-list)))
1609 (condition-case err
1610 (progn
1611 (eval ref)
1612 (let ((lines (count-lines (point-min) (point-max))))
1613 (or nomsg (message "Ref header %d [%d line%s]: %s"
1614 sc-eref-style lines
1615 (if (= lines 1) "" "s")
1616 ref))))
1617 (void-function
1618 (progn (message
1619 "Symbol's function definition is void: %s (Header %d)"
1620 (cadr err) sc-eref-style)
1621 (beep))))))
1623 (defun sc-electric-mode (&optional style)
1624 "Mode for viewing Supercite reference headers. Commands are:
1627 `sc-electric-mode' is not intended to be run interactively, but rather
1628 accessed through Supercite's electric reference feature. See
1629 `sc-insert-reference' for more details. Optional STYLE is the initial
1630 header style to use, unless not supplied or invalid, in which case
1631 `sc-preferred-header-style' is used."
1633 (let ((info sc-mail-info))
1635 (setq sc-eref-style
1636 (or (sc-valid-index-p style)
1637 (sc-valid-index-p sc-preferred-header-style)
1638 0))
1640 (get-buffer-create sc-electric-bufname)
1641 ;; set up buffer and enter command loop
1642 (save-excursion
1643 (save-window-excursion
1644 (pop-to-buffer sc-electric-bufname)
1645 (kill-all-local-variables)
1646 (let ((sc-mail-info info)
1647 (buffer-read-only t)
1648 (mode-name "SC Electric Refs")
1649 (major-mode 'sc-electric-mode))
1650 (use-local-map sc-electric-mode-map)
1651 (sc-eref-show sc-eref-style)
1652 (run-mode-hooks 'sc-electric-mode-hook)
1653 (recursive-edit))))
1655 (and sc-eref-style
1656 (sc-eref-insert-selected))
1657 (kill-buffer sc-electric-bufname)))
1659 ;; functions for electric reference mode
1660 (defun sc-eref-show (index)
1661 "Show reference INDEX in `sc-rewrite-header-list'."
1662 (let ((msg "No %ing reference headers in list.")
1663 (last (length sc-rewrite-header-list)))
1664 (setq sc-eref-style
1665 (cond
1666 ((sc-valid-index-p index) index)
1667 ((< index 0)
1668 (if sc-electric-circular-p
1669 (1- last)
1670 (progn (error msg "preced") 0)))
1671 ((>= index last)
1672 (if sc-electric-circular-p
1673 0
1674 (progn (error msg "follow") (1- last))))))
1675 (with-current-buffer sc-electric-bufname
1676 (let ((inhibit-read-only t))
1677 (erase-buffer)
1678 (goto-char (point-min))
1679 (sc-eref-insert-selected)
1680 ;; now shrink the window to just contain the electric reference
1681 ;; header.
1682 (let ((hdrlines (count-lines (point-min) (point-max)))
1683 (winlines (1- (window-height))))
1684 (if (/= hdrlines winlines)
1685 (if (> hdrlines winlines)
1686 ;; we have to enlarge the window
1687 (enlarge-window (- hdrlines winlines))
1688 ;; we have to shrink the window
1689 (shrink-window (- winlines (max hdrlines
1690 window-min-height))))))))))
1692 (defun sc-eref-next ()
1693 "Display next reference in other buffer."
1694 (interactive)
1695 (sc-eref-show (1+ sc-eref-style)))
1697 (defun sc-eref-prev ()
1698 "Display previous reference in other buffer."
1699 (interactive)
1700 (sc-eref-show (1- sc-eref-style)))
1702 (defun sc-eref-setn ()
1703 "Set reference header selected as preferred."
1704 (interactive)
1705 (setq sc-preferred-header-style sc-eref-style)
1706 (message "Preferred reference style set to header %d." sc-eref-style))
1708 (defun sc-eref-goto (refnum)
1709 "Show reference style indexed by REFNUM.
1710 If REFNUM is an invalid index, don't go to that reference and return
1711 nil."
1712 (interactive "NGoto Reference: ")
1713 (if (sc-valid-index-p refnum)
1714 (sc-eref-show refnum)
1715 (error "Invalid reference: %d. (Range: [%d .. %d])"
1716 refnum 0 (1- (length sc-rewrite-header-list)))))
1718 (defun sc-eref-jump ()
1719 "Set reference header to preferred header."
1720 (interactive)
1721 (sc-eref-show sc-preferred-header-style))
1723 (defun sc-eref-abort ()
1724 "Exit from electric reference mode without inserting reference."
1725 (interactive)
1726 (setq sc-eref-style nil)
1727 (exit-recursive-edit))
1729 (defun sc-eref-exit ()
1730 "Exit from electric reference mode and insert selected reference."
1731 (interactive)
1732 (exit-recursive-edit))
1734 (defun sc-insert-reference (arg)
1735 "Insert, at point, a reference header in the body of the reply.
1736 Numeric ARG indicates which header style from `sc-rewrite-header-list'
1737 to use when rewriting the header. No supplied ARG indicates use of
1738 `sc-preferred-header-style'.
1741 entered, regardless of the value of `sc-electric-references-p'. See
1742 `sc-electric-mode' for more information."
1743 (interactive "P")
1744 (if (consp arg)
1745 (sc-electric-mode)
1746 (let ((preference (or (sc-valid-index-p arg)
1747 (sc-valid-index-p sc-preferred-header-style)
1748 sc-preferred-header-style
1749 0)))
1750 (if sc-electric-references-p
1751 (sc-electric-mode preference)
1752 (sc-eref-insert-selected t)))))
1754 \f
1755 ;; ======================================================================
1756 ;; variable toggling
1758 (defun sc-raw-mode-toggle ()
1759 "Toggle, in one fell swoop, two important SC variables:
1760 `sc-fixup-whitespace-p' and `sc-auto-fill-region-p'"
1761 (interactive)
1762 (setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p)
1763 sc-auto-fill-region-p (not sc-auto-fill-region-p))
1764 (force-mode-line-update))
1766 (defun sc-toggle-var (variable)
1767 "Boolean toggle VARIABLE's value.
1768 VARIABLE must be a bound symbol. nil values change to t, non-nil
1769 values are changed to nil."
1770 (message "%s changed from %s to %s"
1771 variable (symbol-value variable)
1772 (set variable (not (symbol-value variable)))))
1774 (defun sc-set-variable (var)
1775 "Set the Supercite VARIABLE.
1776 This function mimics `set-variable', except that the variable to set
1777 is determined non-interactively. The value is queried for in the
1778 minibuffer exactly the same way that `set-variable' does it.
1780 You can see the current value of the variable when the minibuffer is
1781 querying you by typing `C-h'. Note that the format is changed
1782 slightly from that used by `set-variable' -- the current value is
1783 printed just after the variable's name instead of at the bottom of the
1784 help window."
1785 (let* ((minibuffer-help-form '(funcall myhelp))
1786 (myhelp
1787 (lambda ()
1788 (with-output-to-temp-buffer "*Help*"
1789 (prin1 var)
1790 (if (boundp var)
1791 (let ((print-length 20))
1793 (prin1 (symbol-value var))
1794 (princ ")")))
1796 (princ (substring (documentation-property
1797 var
1798 'variable-documentation)
1799 1))
1800 (with-current-buffer standard-output
1801 (help-mode))
1802 nil))))
1803 (set var (eval-minibuffer (format "Set %s to value: " var)))))
1805 (defmacro sc-toggle-symbol (rootname)
1806 `(defun ,(intern (concat "sc-T-" rootname)) ()
1807 (interactive)
1808 (sc-toggle-var ',(intern (concat "sc-" rootname "-p")))))
1810 (defmacro sc-setvar-symbol (rootname)
1811 `(defun ,(intern (concat "sc-S-" rootname)) ()
1812 (interactive)
1813 (sc-set-variable ',(intern (concat "sc-" rootname)))))
1815 (sc-toggle-symbol "confirm-always")
1816 (sc-toggle-symbol "downcase")
1817 (sc-toggle-symbol "electric-references")
1818 (sc-toggle-symbol "auto-fill-region")
1819 (sc-toggle-symbol "mail-nuke-blank-lines")
1820 (sc-toggle-symbol "nested-citation")
1821 (sc-toggle-symbol "electric-circular")
1822 (sc-toggle-symbol "use-only-preferences")
1823 (sc-toggle-symbol "fixup-whitespace")
1825 (sc-setvar-symbol "preferred-attribution-list")
1826 (sc-setvar-symbol "preferred-header-style")
1827 (sc-setvar-symbol "mail-nuke-mail-headers")
1828 (sc-setvar-symbol "mail-header-nuke-list")
1829 (sc-setvar-symbol "cite-region-limit")
1831 (defun sc-T-describe ()
1832 "
1834 Supercite provides a number of key bindings which simplify the process
1835 of setting or toggling certain variables controlling its operation.
1837 Note on function names in this list: all functions of the form
1838 `sc-S-<name>' actually call `sc-set-variable' on the corresponding
1839 `sc-<name>' variable. All functions of the form `sc-T-<name>' call
1840 `sc-toggle-var' on the corresponding `sc-<name>-p' variable.
1843 (interactive)
1844 (describe-function 'sc-T-describe))
1846 \f
1847 ;; ======================================================================
1848 ;; published interface to mail and news readers
1850 (define-minor-mode sc-minor-mode nil
1851 :group 'supercite
1852 :lighter (" SC" (sc-auto-fill-region-p
1853 (":f" (sc-fixup-whitespace-p "w"))
1854 (sc-fixup-whitespace-p ":w")))
1855 :keymap `((,sc-mode-map-prefix . ,sc-mode-map)))
1857 ;;;###autoload
1858 (defun sc-cite-original ()
1859 "Workhorse citing function which performs the initial citation.
1860 This is callable from the various mail and news readers' reply
1861 function according to the agreed upon standard. See the associated
1862 info node `(SC)Top' for more details.
1863 `sc-cite-original' does not do any yanking of the
1864 original message but it does require a few things:
1866 1) The reply buffer is the current buffer.
1868 2) The original message has been yanked and inserted into the
1869 reply buffer.
1871 3) Verbose mail headers from the original message have been
1872 inserted into the reply buffer directly before the text of the
1873 original message.
1875 4) Point is at the beginning of the verbose headers.
1877 5) Mark is at the end of the body of text to be cited.
1879 The region need not be active (and typically isn't when this
1880 function is called). Also, the hook `sc-pre-hook' is run before,
1881 and `sc-post-hook' is run after the guts of this function."
1882 (run-hooks 'sc-pre-hook)
1884 (sc-minor-mode 1)
1886 (undo-boundary)
1888 ;; grab point and mark since the region is probably not active when
1889 ;; this function gets automatically called. we want point to be a
1890 ;; mark so any deleting before point works properly
1891 (let* ((zmacs-regions nil) ; for XEemacs
1892 (mark-active t) ; for Emacs
1893 (point (point-marker))
1894 (mark (copy-marker (mark-marker))))
1896 ;; make sure point comes before mark, not all functions are
1897 ;; interactive "r"
1898 (if (< mark point)
1899 (let ((tmp point))
1900 (setq point mark
1901 mark tmp)))
1903 ;; first process mail headers, and populate sc-mail-info
1904 (sc-mail-process-headers point mark)
1906 ;; now get possible attributions
1907 (sc-attribs-chop-address (or (sc-mail-field "from")
1908 (sc-mail-field "reply")
1909 (sc-mail-field "reply-to")
1910 (sc-mail-field "sender")))
1911 ;; select the attribution
1912 (sc-select-attribution)
1914 ;; cite the region, but first check the value of sc-cite-region-limit
1915 (let ((linecnt (count-lines point mark)))
1916 (and sc-cite-region-limit
1917 (if (or (not (numberp sc-cite-region-limit))
1918 (<= linecnt sc-cite-region-limit))
1919 (progn
1920 ;; cite the region and insert the header rewrite
1921 (sc-cite-region point mark)
1922 (goto-char point)
1923 (let ((sc-eref-style (or sc-preferred-header-style 0)))
1924 (if sc-electric-references-p
1925 (sc-electric-mode sc-eref-style)
1926 (sc-eref-insert-selected t))))
1927 (beep)
1928 (message
1929 "Region not cited. %d lines exceeds sc-cite-region-limit: %d"
1930 linecnt sc-cite-region-limit))))
1932 ;; finally, free the point-marker
1933 (set-marker point nil)
1934 (set-marker mark nil))
1935 (run-hooks 'sc-post-hook))
1937 \f
1938 ;; ======================================================================
1939 ;; bug reporting and miscellaneous commands
1941 (defun sc-open-line (arg)
1942 "Like `open-line', but insert the citation prefix at the front of the line.
1943 With numeric ARG, inserts that many new lines."
1944 (interactive "p")
1945 (save-excursion
1946 (let ((start (point))
1947 (prefix (or (progn (beginning-of-line)
1948 (if (looking-at (sc-cite-regexp))
1949 (match-string 0)))
1950 "")))
1951 (goto-char start)
1952 (open-line arg)
1953 (forward-line 1)
1954 (while (< 0 arg)
1955 (insert prefix)
1956 (forward-line 1)
1957 (setq arg (1- arg))))))
1959 (defun sc-insert-citation (arg)
1960 "Insert citation string at beginning of current line if not already cited.
1962 cited."
1963 (interactive "P")
1964 (save-excursion
1965 (beginning-of-line)
1966 (if (or (not (looking-at (sc-cite-regexp)))
1968 (consp arg))
1969 (insert (sc-mail-field "sc-citation"))
1970 (error "Line is already cited"))))
1972 ;; The argument logic here is crazy.
1973 (defun sc-version (message)
1974 "Return the current Supercite version.
1975 If MESSAGE is non-nil (interactively, with no prefix argument),
1976 echoes the version in the minibuffer. Otherwise, inserts the
1977 version at point."
1978 (interactive (list (not current-prefix-arg)))
1979 (let ((verstr (format "Using Supercite.el %s" emacs-version)))
1980 (if message
1981 (message verstr)
1982 (insert "`sc-version' says: " verstr))))
1984 (make-obsolete 'sc-version 'emacs-version "23.1")
1986 (defun sc-describe ()
1987 "Read the Supercite info node."
1988 (interactive)
1989 (info "(SC)top"))
1991 (make-obsolete 'sc-describe "read the SC manual using `info'." "23.1")
1993 (define-obsolete-function-alias 'sc-submit-bug-report 'report-emacs-bug "23.1")
1995 \f
1996 ;; useful stuff
1997 (provide 'supercite)
1998 (run-hooks 'sc-load-hook)
2000 ;;; supercite.el ends here