Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; mailabbrev.el --- abbrev-expansion of mail aliases |
275da787 | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 1985-1987, 1992-1993, 1996-1997, 2000-2011 |
a4d9b7bc | 4 | ;; Free Software Foundation, Inc. |
275da787 | 5 | |
4c120732 | 6 | ;; Author: Jamie Zawinski <jwz@lucid.com; now jwz@jwz.org> |
fcc31755 | 7 | ;; Maintainer: FSF |
275da787 RM |
8 | ;; Created: 19 Oct 90 |
9 | ;; Keywords: mail | |
10 | ||
b578f267 | 11 | ;; This file is part of GNU Emacs. |
b01c3008 | 12 | |
b1fc2b50 | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
b578f267 | 14 | ;; it under the terms of the GNU General Public License as published by |
b1fc2b50 GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
b01c3008 | 17 | |
b578f267 EN |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
b01c3008 | 22 | |
b578f267 | 23 | ;; You should have received a copy of the GNU General Public License |
b1fc2b50 | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
b01c3008 | 25 | |
275da787 RM |
26 | ;;; Commentary: |
27 | ||
0f965ba3 | 28 | ;; This file ensures that, when the point is in a To:, CC:, BCC:, or From: |
b578f267 EN |
29 | ;; field, word-abbrevs are defined for each of your mail aliases. These |
30 | ;; aliases will be defined from your .mailrc file (or the file specified by | |
f6babbac | 31 | ;; `mail-personal-alias-file') if it exists. Your mail aliases will |
b578f267 EN |
32 | ;; expand any time you type a word-delimiter at the end of an abbreviation. |
33 | ;; | |
34 | ;; What you see is what you get: if mailabbrev is in use when you type | |
35 | ;; a name, and the name does not expand, you know it is not an abbreviation. | |
36 | ;; However, if you yank abbreviations into the headers | |
37 | ;; in a way that bypasses the check for abbreviations, | |
38 | ;; they are expanded (but not visibly) when you send the message. | |
39 | ;; | |
40 | ;; Your mail alias abbrevs will be in effect only when the point is in an | |
41 | ;; appropriate header field. When in the body of the message, or other | |
42 | ;; header fields, the mail aliases will not expand. Rather, the normal | |
fba75b6b | 43 | ;; mode-specific abbrev table will be used if |
b578f267 EN |
44 | ;; defined. So if you use mail-mode specific abbrevs, this code will not |
45 | ;; adversely affect you. You can control which header fields the abbrevs | |
46 | ;; are used in by changing the variable mail-abbrev-mode-regexp. | |
47 | ;; | |
48 | ;; If auto-fill mode is on, abbrevs will wrap at commas instead of at word | |
49 | ;; boundaries; also, header continuation-lines will be properly indented. | |
50 | ;; | |
85d0e9ed | 51 | ;; You can also insert a mail alias with mail-abbrev-insert-alias |
b578f267 EN |
52 | ;; (bound to C-c C-a), which prompts you for an alias (with completion) |
53 | ;; and inserts its expansion at point. | |
54 | ;; | |
55 | ;; This file fixes a bug in the old system which prohibited your .mailrc | |
56 | ;; file from having lines like | |
57 | ;; | |
58 | ;; alias someone "John Doe <doe@quux.com>" | |
59 | ;; | |
60 | ;; That is, if you want an address to have embedded spaces, simply surround it | |
61 | ;; with double-quotes. This is necessary because the format of the .mailrc | |
62 | ;; file bogusly uses spaces as address delimiters. The following line defines | |
63 | ;; an alias which expands to three addresses: | |
64 | ;; | |
65 | ;; alias foobar addr-1 addr-2 "address three <addr-3>" | |
66 | ;; | |
67 | ;; (This is bogus because mail-delivery programs want commas, not spaces, | |
68 | ;; but that's what the file format is, so we have to live with it.) | |
69 | ;; | |
70 | ;; If you like, you can call the function define-mail-abbrev to define your | |
71 | ;; mail aliases instead of using a .mailrc file. When you call it in this | |
72 | ;; way, addresses are separated by commas. | |
73 | ;; | |
74 | ;; CAVEAT: This works on most Sun systems; I have been told that some versions | |
75 | ;; of /bin/mail do not understand double-quotes in the .mailrc file. So you | |
76 | ;; should make sure your version does before including verbose addresses like | |
77 | ;; this. One solution to this, if you are on a system whose /bin/mail doesn't | |
78 | ;; work that way, (and you still want to be able to /bin/mail to send mail in | |
79 | ;; addition to emacs) is to define minimal aliases (without full names) in | |
80 | ;; your .mailrc file, and use define-mail-abbrev to redefine them when sending | |
81 | ;; mail from emacs; this way, mail sent from /bin/mail will work, and mail | |
82 | ;; sent from emacs will be pretty. | |
83 | ;; | |
84 | ;; Aliases in the mailrc file may be nested. If you define aliases like | |
85 | ;; alias group1 fred ethel | |
86 | ;; alias group2 larry curly moe | |
87 | ;; alias everybody group1 group2 | |
88 | ;; Then when you type "everybody" on the To: line, it will be expanded to | |
89 | ;; fred, ethyl, larry, curly, moe | |
90 | ;; | |
91 | ;; Aliases may also contain forward references; the alias of "everybody" can | |
92 | ;; precede the aliases of "group1" and "group2". | |
93 | ;; | |
94 | ;; This code also understands the "source" .mailrc command, for reading | |
95 | ;; aliases from some other file as well. | |
96 | ;; | |
97 | ;; Aliases may contain hyphens, as in "alias foo-bar foo@bar"; word-abbrevs | |
98 | ;; normally cannot contain hyphens, but this code works around that for the | |
99 | ;; specific case of mail-alias word-abbrevs. | |
100 | ;; | |
101 | ;; To read in the contents of another .mailrc-type file from emacs, use the | |
102 | ;; command Meta-X merge-mail-abbrevs. The rebuild-mail-abbrevs command is | |
103 | ;; similar, but will delete existing aliases first. | |
104 | ;; | |
105 | ;; If you would like your aliases to be expanded when you type M-> or ^N to | |
106 | ;; move out of the mail-header into the message body (instead of having to | |
107 | ;; type SPC at the end of the abbrev before moving away) then you can do | |
108 | ;; | |
109 | ;; (add-hook | |
bde4c7ce | 110 | ;; 'mail-mode-hook |
c0df1972 | 111 | ;; (lambda () |
6b823692 AS |
112 | ;; (define-key mail-mode-map [remap next-line] 'mail-abbrev-next-line) |
113 | ;; (define-key mail-mode-map [remap end-of-buffer] 'mail-abbrev-end-of-buffer))) | |
b578f267 EN |
114 | ;; |
115 | ;; If you want multiple addresses separated by a string other than ", " then | |
116 | ;; you can set the variable mail-alias-separator-string to it. This has to | |
117 | ;; be a comma bracketed by whitespace if you want any kind of reasonable | |
fffa137c | 118 | ;; behavior. |
b578f267 EN |
119 | ;; |
120 | ;; Thanks to Harald Hanche-Olsen, Michael Ernst, David Loeffler, and | |
121 | ;; Noah Friedman for suggestions and bug reports. | |
122 | ||
bde4c7ce | 123 | ;; To use this package, do (add-hook 'mail-mode-hook 'mail-abbrevs-setup). |
b01c3008 | 124 | |
275da787 RM |
125 | ;;; Code: |
126 | ||
d075ed70 RS |
127 | (eval-when-compile |
128 | (require 'sendmail)) | |
b01c3008 | 129 | |
7d4c958f KH |
130 | (defgroup mail-abbrev nil |
131 | "Expand mail aliases as abbrevs, in certain mail headers." | |
132 | :group 'abbrev-mode) | |
133 | ||
dcbb251e SM |
134 | ;;;###autoload |
135 | (define-minor-mode mail-abbrevs-mode | |
136 | "Non-nil means expand mail aliases as abbrevs, in certain message headers." | |
137 | :global t | |
7d4c958f | 138 | :group 'mail-abbrev |
dcbb251e SM |
139 | :version "20.3" |
140 | (if mail-abbrevs-mode (mail-abbrevs-enable) (mail-abbrevs-disable))) | |
7d4c958f KH |
141 | |
142 | (defcustom mail-abbrevs-only nil | |
dcbb251e | 143 | "Non-nil means only mail abbrevs should expand automatically. |
7d4c958f KH |
144 | Other abbrevs expand only when you explicitly use `expand-abbrev'." |
145 | :type 'boolean | |
146 | :group 'mail-abbrev) | |
147 | ||
b01c3008 | 148 | ;; originally defined in sendmail.el - used to be an alist, now is a table. |
753d16a6 | 149 | (defvar mail-abbrevs nil |
22f4ef2e | 150 | "Word-abbrev table of mail address aliases. |
b01c3008 RS |
151 | If this is nil, it means the aliases have not yet been initialized and |
152 | should be read from the .mailrc file. (This is distinct from there being | |
153 | no aliases, which is represented by this being a table with no entries.)") | |
154 | ||
00bafa45 RS |
155 | (defvar mail-abbrev-modtime nil |
156 | "The modification time of your mail alias file when it was last examined.") | |
157 | ||
158 | (defun mail-abbrevs-sync-aliases () | |
f7e85dcf RS |
159 | (when mail-personal-alias-file |
160 | (if (file-exists-p mail-personal-alias-file) | |
161 | (let ((modtime (nth 5 (file-attributes mail-personal-alias-file)))) | |
162 | (if (not (equal mail-abbrev-modtime modtime)) | |
163 | (progn | |
164 | (setq mail-abbrev-modtime modtime) | |
165 | (build-mail-abbrevs))))))) | |
00bafa45 | 166 | |
aa228418 | 167 | ;;;###autoload |
753d16a6 | 168 | (defun mail-abbrevs-setup () |
17804728 | 169 | "Initialize use of the `mailabbrev' package." |
753d16a6 | 170 | (if (and (not (vectorp mail-abbrevs)) |
a3039e32 | 171 | (file-exists-p mail-personal-alias-file)) |
00bafa45 | 172 | (progn |
0f965ba3 | 173 | (setq mail-abbrev-modtime |
00bafa45 RS |
174 | (nth 5 (file-attributes mail-personal-alias-file))) |
175 | (build-mail-abbrevs))) | |
176 | (mail-abbrevs-sync-aliases) | |
dcbb251e | 177 | (add-hook 'abbrev-expand-functions 'mail-abbrev-expand-wrapper nil t) |
b01c3008 RS |
178 | (abbrev-mode 1)) |
179 | ||
7d4c958f | 180 | (defun mail-abbrevs-enable () |
bde4c7ce | 181 | (add-hook 'mail-mode-hook 'mail-abbrevs-setup)) |
7d4c958f KH |
182 | |
183 | (defun mail-abbrevs-disable () | |
184 | "Turn off use of the `mailabbrev' package." | |
bde4c7ce | 185 | (remove-hook 'mail-mode-hook 'mail-abbrevs-setup) |
7d4c958f KH |
186 | (abbrev-mode (if (default-value 'abbrev-mode) 1 -1))) |
187 | ||
22f4ef2e | 188 | ;;;###autoload |
753d16a6 | 189 | (defun build-mail-abbrevs (&optional file recursivep) |
a3039e32 NF |
190 | "Read mail aliases from personal mail alias file and set `mail-abbrevs'. |
191 | By default this is the file specified by `mail-personal-alias-file'." | |
192 | (setq file (expand-file-name (or file mail-personal-alias-file))) | |
753d16a6 | 193 | (if (vectorp mail-abbrevs) |
b01c3008 | 194 | nil |
753d16a6 RS |
195 | (setq mail-abbrevs nil) |
196 | (define-abbrev-table 'mail-abbrevs '())) | |
5aefeeba | 197 | (message "Parsing %s..." file) |
dcbb251e SM |
198 | (with-temp-buffer |
199 | (buffer-disable-undo) | |
200 | (cond ((get-file-buffer file) | |
201 | (insert (with-current-buffer (get-file-buffer file) | |
202 | (buffer-substring (point-min) (point-max))))) | |
203 | ((not (file-exists-p file))) | |
204 | (t (insert-file-contents file))) | |
205 | ;; Don't lose if no final newline. | |
206 | (goto-char (point-max)) | |
207 | (or (eq (preceding-char) ?\n) (newline)) | |
208 | (goto-char (point-min)) | |
209 | ;; Delete comments from the file | |
210 | (while (search-forward "# " nil t) | |
211 | (let ((p (- (point) 2))) | |
212 | (end-of-line) | |
213 | (delete-region p (point)))) | |
214 | (goto-char (point-min)) | |
215 | ;; handle "\\\n" continuation lines | |
216 | (while (not (eobp)) | |
217 | (end-of-line) | |
218 | (if (= (preceding-char) ?\\) | |
219 | (progn (delete-char -1) (delete-char 1) (insert ?\ )) | |
220 | (forward-char 1))) | |
221 | (goto-char (point-min)) | |
222 | (while (re-search-forward | |
223 | "^\\(a\\(lias\\)?\\|g\\(roup\\)?\\|source\\)[ \t]+" nil t) | |
224 | (beginning-of-line) | |
225 | (if (looking-at "source[ \t]+\\([^ \t\n]+\\)") | |
226 | (progn | |
227 | (end-of-line) | |
228 | (build-mail-abbrevs | |
229 | (substitute-in-file-name | |
230 | (buffer-substring (match-beginning 1) (match-end 1))) | |
231 | t)) | |
232 | (re-search-forward "[ \t]+\\([^ \t\n]+\\)") | |
233 | (let* ((name (buffer-substring | |
234 | (match-beginning 1) (match-end 1))) | |
235 | (start (progn (skip-chars-forward " \t") (point)))) | |
236 | (end-of-line) | |
237 | ;; (message "** %s \"%s\"" name (buffer-substring start (point)))(sit-for 1) | |
238 | (define-mail-abbrev | |
239 | name | |
240 | (buffer-substring start (point)) | |
241 | t)))) | |
242 | ;; Resolve forward references in .mailrc file. | |
243 | ;; This would happen automatically before the first abbrev was | |
244 | ;; expanded, but why not do it now. | |
245 | (or recursivep (mail-resolve-all-aliases)) | |
246 | mail-abbrevs) | |
247 | (message "Parsing %s... done" file)) | |
b01c3008 | 248 | |
f22cd786 | 249 | (defvar mail-alias-separator-string ", " |
b01c3008 | 250 | "*A string inserted between addresses in multi-address mail aliases. |
0f965ba3 | 251 | This has to contain a comma, so \", \" is a reasonable value. You might |
b01c3008 RS |
252 | also want something like \",\\n \" to get each address on its own line.") |
253 | ||
51e4ece8 | 254 | ;; define-mail-abbrev sets this flag, which causes mail-resolve-all-aliases |
b01c3008 RS |
255 | ;; to be called before expanding abbrevs if it's necessary. |
256 | (defvar mail-abbrev-aliases-need-to-be-resolved t) | |
257 | ||
753d16a6 | 258 | ;; originally defined in mailalias.el ; build-mail-abbrevs calls this with |
b01c3008 RS |
259 | ;; stuff parsed from the .mailrc file. |
260 | ;; | |
aa228418 | 261 | ;;;###autoload |
51e4ece8 | 262 | (defun define-mail-abbrev (name definition &optional from-mailrc-file) |
92182a70 | 263 | "Define NAME as a mail alias abbrev that translates to DEFINITION. |
4bb79f82 CY |
264 | If DEFINITION contains multiple addresses, separate them with commas. |
265 | ||
266 | Optional argument FROM-MAILRC-FILE means that DEFINITION comes | |
267 | from a mailrc file. In that case, addresses are separated with | |
268 | spaces and addresses with embedded spaces are surrounded by | |
269 | double-quotes." | |
753d16a6 | 270 | ;; When this is called from build-mail-abbrevs, the third argument is |
b01c3008 RS |
271 | ;; true, and we do some evil space->comma hacking like /bin/mail does. |
272 | (interactive "sDefine mail alias: \nsDefine %s as mail alias for: ") | |
273 | ;; Read the defaults first, if we have not done so. | |
dcbb251e | 274 | (unless (vectorp mail-abbrevs) (build-mail-abbrevs)) |
b01c3008 RS |
275 | ;; strip garbage from front and end |
276 | (if (string-match "\\`[ \t\n,]+" definition) | |
277 | (setq definition (substring definition (match-end 0)))) | |
278 | (if (string-match "[ \t\n,]+\\'" definition) | |
279 | (setq definition (substring definition 0 (match-beginning 0)))) | |
4bb79f82 | 280 | (let* ((L (length definition)) |
8eb6c7da | 281 | (start (if (> L 0) 0)) |
4bb79f82 | 282 | end this-entry result) |
b01c3008 | 283 | (while start |
4bb79f82 CY |
284 | (cond |
285 | (from-mailrc-file | |
286 | ;; If we're reading from the mailrc file, addresses are | |
287 | ;; delimited by spaces, and addresses with embedded spaces are | |
288 | ;; surrounded by non-escaped double-quotes. | |
289 | (if (eq ?\" (aref definition start)) | |
290 | (setq start (1+ start) | |
291 | end (and (string-match | |
292 | "[^\\]\\(\\([\\][\\]\\)*\\)\"[ \t,]*" | |
293 | definition start) | |
294 | (match-end 1))) | |
295 | (setq end (string-match "[ \t,]+" definition start))) | |
296 | ;; Extract the address and advance the loop past it. | |
297 | (setq this-entry (substring definition start end) | |
298 | start (and end (/= (match-end 0) L) (match-end 0))) | |
299 | ;; If the full name contains a problem character, quote it. | |
300 | (and (string-match "\\(.+?\\)[ \t]*\\(<.*>\\)" this-entry) | |
301 | (string-match "[^- !#$%&'*+/0-9=?A-Za-z^_`{|}~]" | |
302 | (match-string 1 this-entry)) | |
303 | (setq this-entry (replace-regexp-in-string | |
304 | "\\(.+?\\)[ \t]*\\(<.*>\\)" | |
305 | "\"\\1\" \\2" | |
306 | this-entry))) | |
307 | (push this-entry result)) | |
308 | ;; When we are not reading from .mailrc, addresses are | |
309 | ;; separated by commas. Try to accept a rfc822-like syntax. | |
310 | ;; (Todo: extend rfc822.el to do the work for us.) | |
311 | ((equal (string-match | |
312 | "[ \t,]*\\(\"\\(?:[^\"]\\|[^\\]\\(?:[\\][\\]\\)*\"\\)*\"[ \t]*\ | |
313 | <[-.!#$%&'*+/0-9=?A-Za-z^_`{|}~@]+>\\)[ \t,]*" | |
314 | definition start) | |
315 | start) | |
316 | ;; If an entry has a valid [ "foo bar" <foo@example.com> ] | |
317 | ;; form, use it literally . This also allows commas in the | |
318 | ;; quoted string, e.g. [ "foo bar, jr" <foo@example.com> ] | |
319 | (push (match-string 1 definition) result) | |
320 | (setq start (and (/= (match-end 0) L) (match-end 0)))) | |
321 | (t | |
322 | ;; Otherwise, read the next address by looking for a comma. | |
323 | (setq end (string-match "[ \t\n,]*,[ \t\n]*" definition start)) | |
324 | (setq this-entry (substring definition start end)) | |
69ba53f7 | 325 | ;; Advance the loop past this address. |
4bb79f82 | 326 | (setq start (and end (/= (match-end 0) L) (match-end 0))) |
69ba53f7 | 327 | ;; If the full name contains a problem character, quote it. |
4bb79f82 CY |
328 | (and (string-match "\\(.+?\\)[ \t]*\\(<.*>\\)" this-entry) |
329 | (string-match "[^- !#$%&'*+/0-9=?A-Za-z^_`{|}~]" | |
330 | (match-string 1 this-entry)) | |
331 | (setq this-entry (replace-regexp-in-string | |
332 | "\\(.+?\\)[ \t]*\\(<.*>\\)" "\"\\1\" \\2" | |
333 | this-entry))) | |
334 | (push this-entry result)))) | |
335 | ||
b01c3008 RS |
336 | (setq definition (mapconcat (function identity) |
337 | (nreverse result) | |
f22cd786 | 338 | mail-alias-separator-string))) |
b01c3008 RS |
339 | (setq mail-abbrev-aliases-need-to-be-resolved t) |
340 | (setq name (downcase name)) | |
753d16a6 | 341 | ;; use an abbrev table instead of an alist for mail-abbrevs. |
b01c3008 | 342 | (let ((abbrevs-changed abbrevs-changed)) ; protect this from being changed. |
8fad672b | 343 | (define-abbrev mail-abbrevs name definition 'mail-abbrev-expand-hook 0 t))) |
b01c3008 RS |
344 | |
345 | ||
346 | (defun mail-resolve-all-aliases () | |
347 | "Resolve all forward references in the mail aliases table." | |
348 | (if mail-abbrev-aliases-need-to-be-resolved | |
349 | (progn | |
350 | ;; (message "Resolving mail aliases...") | |
753d16a6 RS |
351 | (if (vectorp mail-abbrevs) |
352 | (mapatoms (function mail-resolve-all-aliases-1) mail-abbrevs)) | |
b01c3008 RS |
353 | (setq mail-abbrev-aliases-need-to-be-resolved nil) |
354 | ;; (message "Resolving mail aliases... done.") | |
355 | ))) | |
356 | ||
d7c1ec4b RM |
357 | (defun mail-resolve-all-aliases-1 (sym &optional so-far) |
358 | (if (memq sym so-far) | |
359 | (error "mail alias loop detected: %s" | |
360 | (mapconcat 'symbol-name (cons sym so-far) " <- "))) | |
b01c3008 RS |
361 | (let ((definition (and (boundp sym) (symbol-value sym)))) |
362 | (if definition | |
363 | (let ((result '()) | |
364 | (start 0)) | |
365 | (while start | |
366 | (let ((end (string-match "[ \t\n]*,[, \t\n]*" definition start))) | |
367 | (setq result (cons (substring definition start end) result) | |
368 | start (and end (match-end 0))))) | |
369 | (setq definition | |
370 | (mapconcat (function (lambda (x) | |
371 | (or (mail-resolve-all-aliases-1 | |
e1d24183 | 372 | (intern-soft (downcase x) mail-abbrevs) |
d7c1ec4b | 373 | (cons sym so-far)) |
b01c3008 RS |
374 | x))) |
375 | (nreverse result) | |
f22cd786 | 376 | mail-alias-separator-string)) |
b01c3008 RS |
377 | (set sym definition)))) |
378 | (symbol-value sym)) | |
379 | ||
380 | ||
f22cd786 | 381 | (defun mail-abbrev-expand-hook () |
92182a70 RS |
382 | "For use as the fourth arg to `define-abbrev'. |
383 | After expanding a mail-abbrev, if Auto Fill mode is on and we're past the | |
384 | fill-column, break the line at the previous comma, and indent the next line." | |
0f965ba3 RM |
385 | ;; Disable abbrev mode to avoid recursion in indent-relative expanding |
386 | ;; part of the abbrev expansion as an abbrev itself. | |
387 | (let ((abbrev-mode nil)) | |
388 | (save-excursion | |
389 | (let ((p (point)) | |
390 | bol comma fp) | |
391 | (beginning-of-line) | |
392 | (setq bol (point)) | |
393 | (goto-char p) | |
394 | (while (and auto-fill-function | |
395 | (>= (current-column) fill-column) | |
396 | (search-backward "," bol t)) | |
397 | (setq comma (point)) | |
398 | (forward-char 1) ; Now we are just past the comma. | |
399 | (insert "\n") | |
400 | (delete-horizontal-space) | |
401 | (setq p (point)) | |
402 | (indent-relative) | |
403 | (setq fp (buffer-substring p (point))) | |
404 | ;; Go to the end of the new line. | |
405 | (end-of-line) | |
406 | (if (> (current-column) fill-column) | |
407 | ;; It's still too long; do normal auto-fill. | |
408 | (let ((fill-prefix (or fp "\t"))) | |
409 | (do-auto-fill))) | |
410 | ;; Resume the search. | |
411 | (goto-char comma) | |
412 | ))))) | |
22f4ef2e RM |
413 | \f |
414 | ;;; Syntax tables and abbrev-expansion | |
b01c3008 | 415 | |
0f965ba3 | 416 | (defvar mail-abbrev-mode-regexp |
450b15a0 | 417 | "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):" |
92182a70 | 418 | "*Regexp to select mail-headers in which mail abbrevs should be expanded. |
fb11ccf6 | 419 | This string will be handed to `looking-at' with point at the beginning |
b01c3008 RS |
420 | of the current line; if it matches, abbrev mode will be turned on, otherwise |
421 | it will be turned off. (You don't need to worry about continuation lines.) | |
422 | This should be set to match those mail fields in which you want abbreviations | |
423 | turned on.") | |
424 | ||
d075ed70 | 425 | (defvar mail-abbrev-syntax-table nil |
4d2795c3 RS |
426 | "The syntax-table used for abbrev-expansion purposes. |
427 | This is not actually made the current syntax table of the buffer, but | |
428 | simply controls the set of characters which may be a part of the name | |
d075ed70 | 429 | of a mail alias. The value is set up, buffer-local, when first needed.") |
22f4ef2e | 430 | |
cf8b484f RS |
431 | (defun mail-abbrev-make-syntax-table () |
432 | (make-local-variable 'mail-abbrev-syntax-table) | |
433 | (unless mail-abbrev-syntax-table | |
f436b1cb | 434 | (let ((tab (copy-syntax-table (syntax-table))) |
cf8b484f RS |
435 | (_ (aref (standard-syntax-table) ?_)) |
436 | (w (aref (standard-syntax-table) ?w))) | |
437 | (map-char-table | |
438 | (function (lambda (key value) | |
6946ae5b AS |
439 | (if (null value) |
440 | ;; Fetch the inherited value | |
441 | (setq value (aref tab key))) | |
cf8b484f RS |
442 | (if (equal value _) |
443 | (set-char-table-range tab key w)))) | |
444 | tab) | |
445 | (modify-syntax-entry ?@ "w" tab) | |
f8aba1ce MR |
446 | (modify-syntax-entry ?% "w" tab) |
447 | (modify-syntax-entry ?! "w" tab) | |
448 | (modify-syntax-entry ?. "w" tab) | |
449 | (modify-syntax-entry ?_ "w" tab) | |
450 | (modify-syntax-entry ?- "w" tab) | |
cf8b484f | 451 | (setq mail-abbrev-syntax-table tab)))) |
22f4ef2e RM |
452 | |
453 | (defun mail-abbrev-in-expansion-header-p () | |
454 | "Whether point is in a mail-address header field." | |
455 | (let ((case-fold-search t)) | |
456 | (and ;; | |
457 | ;; we are on an appropriate header line... | |
458 | (save-excursion | |
349deff4 GM |
459 | (unless (eobp) (forward-char 1)) |
460 | (re-search-backward "^[^ \t]" nil 'move) | |
22f4ef2e RM |
461 | ;; are we at the front of an appropriate header line? |
462 | (looking-at mail-abbrev-mode-regexp)) | |
463 | ;; | |
13aa1cde | 464 | ;; ...and are we in the headers? |
8fad672b RS |
465 | (< (point) |
466 | (save-restriction | |
467 | (widen) | |
468 | (save-excursion | |
469 | (rfc822-goto-eoh) | |
470 | (point))))))) | |
22f4ef2e | 471 | |
dcbb251e SM |
472 | (defun mail-abbrev-expand-wrapper (expand) |
473 | (if (and mail-abbrevs (not (eq mail-abbrevs t))) | |
474 | (if (mail-abbrev-in-expansion-header-p) | |
475 | ||
476 | ;; We are in a To: (or CC:, or whatever) header, and | |
477 | ;; should use word-abbrevs to expand mail aliases. | |
478 | (let ((local-abbrev-table mail-abbrevs)) | |
479 | ||
480 | ;; Before anything else, resolve aliases if they need it. | |
481 | (and mail-abbrev-aliases-need-to-be-resolved | |
482 | (mail-resolve-all-aliases)) | |
483 | ||
484 | ;; Now proceed with the abbrev section. | |
485 | ;; - We already installed mail-abbrevs as the abbrev table. | |
486 | ;; - Then install the mail-abbrev-syntax-table, which | |
487 | ;; temporarily marks all of the | |
488 | ;; non-alphanumeric-atom-characters (the "_" | |
489 | ;; syntax ones) as being normal word-syntax. We do this | |
490 | ;; because the C code for expand-abbrev only works on words, | |
491 | ;; and we want these characters to be considered words for | |
492 | ;; the purpose of abbrev expansion. | |
493 | ;; - Then we call the expand function, to do | |
494 | ;; the abbrev expansion with the above syntax table. | |
495 | ||
496 | (mail-abbrev-make-syntax-table) | |
497 | ||
498 | ;; If the character just typed was non-alpha-symbol-syntax, | |
499 | ;; then don't expand the abbrev now (that is, don't expand | |
500 | ;; when the user types -.) Check the character's syntax in | |
501 | ;; the usual syntax table. | |
502 | ||
a4d9b7bc | 503 | (or (and (integerp last-command-event) |
dcbb251e SM |
504 | ;; Some commands such as M-> may want to expand first. |
505 | (equal this-command 'self-insert-command) | |
a4d9b7bc | 506 | (or (eq (char-syntax last-command-event) ?_) |
dcbb251e | 507 | ;; Don't expand on @. |
a4d9b7bc | 508 | (memq last-command-event '(?@ ?. ?% ?! ?_ ?-)))) |
dcbb251e SM |
509 | ;; Use this table so that abbrevs can have hyphens in them. |
510 | (with-syntax-table mail-abbrev-syntax-table | |
511 | (funcall expand)))) | |
512 | ||
513 | (if (or (not mail-abbrevs-only) | |
514 | (eq this-command 'expand-abbrev)) | |
515 | ;; We're not in a mail header where mail aliases should | |
516 | ;; be expanded, then use the normal mail-mode abbrev table | |
517 | ;; (if any) and the normal mail-mode syntax table. | |
518 | (funcall expand) | |
519 | ;; This is not a mail abbrev, and we should not expand it. | |
520 | ;; Don't expand anything. | |
521 | nil)) | |
522 | ;; No mail-abbrevs at all, do the normal thing. | |
523 | (funcall expand))) | |
22f4ef2e RM |
524 | \f |
525 | ;;; utilities | |
b01c3008 | 526 | |
753d16a6 | 527 | (defun merge-mail-abbrevs (file) |
b01c3008 RS |
528 | "Merge mail aliases from the given file with existing ones." |
529 | (interactive (list | |
530 | (let ((insert-default-directory t) | |
531 | (default-directory (expand-file-name "~/")) | |
a3039e32 | 532 | (def mail-personal-alias-file)) |
b01c3008 | 533 | (read-file-name |
5b76833f | 534 | (format "Read additional aliases from file (default %s): " |
b01c3008 RS |
535 | def) |
536 | default-directory | |
537 | (expand-file-name def default-directory) | |
538 | t)))) | |
753d16a6 | 539 | (build-mail-abbrevs file)) |
b01c3008 | 540 | |
cf376527 | 541 | (defun rebuild-mail-abbrevs (&optional file) |
b01c3008 RS |
542 | "Rebuild all the mail aliases from the given file." |
543 | (interactive (list | |
544 | (let ((insert-default-directory t) | |
545 | (default-directory (expand-file-name "~/")) | |
a3039e32 | 546 | (def mail-personal-alias-file)) |
b01c3008 | 547 | (read-file-name |
5b76833f | 548 | (format "Read mail aliases from file (default %s): " def) |
b01c3008 RS |
549 | default-directory |
550 | (expand-file-name def default-directory) | |
551 | t)))) | |
cf376527 RS |
552 | (if (null file) |
553 | (setq file buffer-file-name)) | |
753d16a6 RS |
554 | (setq mail-abbrevs nil) |
555 | (build-mail-abbrevs file)) | |
49116ac0 | 556 | |
85d0e9ed | 557 | (defun mail-abbrev-insert-alias (&optional alias) |
22f4ef2e | 558 | "Prompt for and insert a mail alias." |
c540863c | 559 | (interactive (progn |
753d16a6 RS |
560 | (if (not (vectorp mail-abbrevs)) (mail-abbrevs-setup)) |
561 | (list (completing-read "Expand alias: " mail-abbrevs nil t)))) | |
562 | (if (not (vectorp mail-abbrevs)) (mail-abbrevs-setup)) | |
0eef787b RS |
563 | (insert (or (and alias (symbol-value (intern-soft alias mail-abbrevs))) "")) |
564 | (mail-abbrev-expand-hook)) | |
753d16a6 | 565 | |
85d0e9ed GM |
566 | (defun mail-abbrev-complete-alias () |
567 | "Perform completion on alias preceding point." | |
85d0e9ed | 568 | (interactive) |
da00bb18 | 569 | (mail-abbrev-make-syntax-table) |
e2d4ea5a SM |
570 | (let ((end (point)) |
571 | (beg (with-syntax-table mail-abbrev-syntax-table | |
572 | (save-excursion | |
573 | (backward-word 1) | |
574 | (point))))) | |
575 | (completion-in-region beg end mail-abbrevs))) | |
85d0e9ed | 576 | |
753d16a6 | 577 | (defun mail-abbrev-next-line (&optional arg) |
1fa1ea7d GM |
578 | "Expand a mail abbrev before point, then move vertically down ARG lines. |
579 | This only expands an abbrev (if one is present) if called with | |
580 | point at the end of a line, or on whitespace before the end of a line. | |
581 | ||
582 | In terms of line motion, this behaves like `next-line', which see." | |
22f4ef2e | 583 | (interactive "p") |
d7c1ec4b RM |
584 | (if (looking-at "[ \t]*\n") (expand-abbrev)) |
585 | (setq this-command 'next-line) | |
91dd4dc4 | 586 | (with-no-warnings (next-line arg))) |
22f4ef2e | 587 | |
753d16a6 | 588 | (defun mail-abbrev-end-of-buffer (&optional arg) |
1fa1ea7d GM |
589 | "Expand a mail abbrev before point, then move to the end of the buffer. |
590 | This only expands an abbrev (if one is present) if called with | |
591 | point at the end of a line, or on whitespace before the end of a line. | |
753d16a6 | 592 | |
1fa1ea7d | 593 | In other respects, this behaves like `end-of-buffer', which see." |
650d6486 | 594 | (interactive "P") |
d7c1ec4b RM |
595 | (if (looking-at "[ \t]*\n") (expand-abbrev)) |
596 | (setq this-command 'end-of-buffer) | |
1fa1ea7d | 597 | (with-no-warnings (end-of-buffer arg))) |
22f4ef2e | 598 | |
f526e65a RS |
599 | (eval-after-load "sendmail" |
600 | '(progn | |
601 | (define-key mail-mode-map "\C-c\C-a" 'mail-abbrev-insert-alias) | |
602 | (define-key mail-mode-map "\e\t" ; like lisp-complete-symbol | |
603 | 'mail-abbrev-complete-alias))) | |
22f4ef2e | 604 | |
753d16a6 RS |
605 | ;;(define-key mail-mode-map "\C-n" 'mail-abbrev-next-line) |
606 | ;;(define-key mail-mode-map "\M->" 'mail-abbrev-end-of-buffer) | |
b01c3008 | 607 | |
3e1b7a46 | 608 | (provide 'mailabbrev) |
b578f267 | 609 | |
55535639 | 610 | ;;; mailabbrev.el ends here |