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