1 ;;; mailabbrev.el --- abbrev-expansion of mail aliases
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1996, 1997, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>, now <jwz@jwz.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This file ensures that, when the point is in a To:, CC:, BCC:, or From:
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
31 ;; `mail-personal-alias-file') if it exists. Your mail aliases will
32 ;; expand any time you type a word-delimiter at the end of an abbreviation.
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.
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
43 ;; mode-specific abbrev table will be used if
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.
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.
51 ;; You can also insert a mail alias with mail-abbrev-insert-alias
52 ;; (bound to C-c C-a), which prompts you for an alias (with completion)
53 ;; and inserts its expansion at point.
55 ;; This file fixes a bug in the old system which prohibited your .mailrc
56 ;; file from having lines like
58 ;; alias someone "John Doe <doe@quux.com>"
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:
65 ;; alias foobar addr-1 addr-2 "address three <addr-3>"
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.)
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.
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.
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
91 ;; Aliases may also contain forward references; the alias of "everybody" can
92 ;; precede the aliases of "group1" and "group2".
94 ;; This code also understands the "source" .mailrc command, for reading
95 ;; aliases from some other file as well.
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.
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.
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
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)))
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
120 ;; Thanks to Harald Hanche-Olsen, Michael Ernst, David Loeffler, and
121 ;; Noah Friedman for suggestions and bug reports.
123 ;; To use this package, do (add-hook 'mail-mode-hook 'mail-abbrevs-setup).
130 (defgroup mail-abbrev nil
131 "Expand mail aliases as abbrevs, in certain mail headers."
135 (define-minor-mode mail-abbrevs-mode
136 "Non-nil means expand mail aliases as abbrevs, in certain message headers."
140 (if mail-abbrevs-mode
(mail-abbrevs-enable) (mail-abbrevs-disable)))
142 (defcustom mail-abbrevs-only nil
143 "Non-nil means only mail abbrevs should expand automatically.
144 Other abbrevs expand only when you explicitly use `expand-abbrev'."
148 ;; originally defined in sendmail.el - used to be an alist, now is a table.
149 (defvar mail-abbrevs nil
150 "Word-abbrev table of mail address aliases.
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.)")
155 (defvar mail-abbrev-modtime nil
156 "The modification time of your mail alias file when it was last examined.")
158 (defun mail-abbrevs-sync-aliases ()
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
))
164 (setq mail-abbrev-modtime modtime
)
165 (build-mail-abbrevs)))))))
168 (defun mail-abbrevs-setup ()
169 "Initialize use of the `mailabbrev' package."
170 (if (and (not (vectorp mail-abbrevs
))
171 (file-exists-p mail-personal-alias-file
))
173 (setq mail-abbrev-modtime
174 (nth 5 (file-attributes mail-personal-alias-file
)))
175 (build-mail-abbrevs)))
176 (mail-abbrevs-sync-aliases)
177 (add-hook 'abbrev-expand-functions
'mail-abbrev-expand-wrapper nil t
)
180 (defun mail-abbrevs-enable ()
181 (add-hook 'mail-mode-hook
'mail-abbrevs-setup
))
183 (defun mail-abbrevs-disable ()
184 "Turn off use of the `mailabbrev' package."
185 (remove-hook 'mail-mode-hook
'mail-abbrevs-setup
)
186 (abbrev-mode (if (default-value 'abbrev-mode
) 1 -
1)))
189 (defun build-mail-abbrevs (&optional file recursivep
)
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
)))
193 (if (vectorp mail-abbrevs
)
195 (setq mail-abbrevs nil
)
196 (define-abbrev-table 'mail-abbrevs
'()))
197 (message "Parsing %s..." file
)
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)))
213 (delete-region p
(point))))
214 (goto-char (point-min))
215 ;; handle "\\\n" continuation lines
218 (if (= (preceding-char) ?
\\)
219 (progn (delete-char -
1) (delete-char 1) (insert ?\
))
221 (goto-char (point-min))
222 (while (re-search-forward
223 "^\\(a\\(lias\\)?\\|g\\(roup\\)?\\|source\\)[ \t]+" nil t
)
225 (if (looking-at "source[ \t]+\\([^ \t\n]+\\)")
229 (substitute-in-file-name
230 (buffer-substring (match-beginning 1) (match-end 1)))
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))))
237 ;; (message "** %s \"%s\"" name (buffer-substring start (point)))(sit-for 1)
240 (buffer-substring start
(point))
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))
247 (message "Parsing %s... done" file
))
249 (defvar mail-alias-separator-string
", "
250 "*A string inserted between addresses in multi-address mail aliases.
251 This has to contain a comma, so \", \" is a reasonable value. You might
252 also want something like \",\\n \" to get each address on its own line.")
254 ;; define-mail-abbrev sets this flag, which causes mail-resolve-all-aliases
255 ;; to be called before expanding abbrevs if it's necessary.
256 (defvar mail-abbrev-aliases-need-to-be-resolved t
)
258 ;; originally defined in mailalias.el ; build-mail-abbrevs calls this with
259 ;; stuff parsed from the .mailrc file.
262 (defun define-mail-abbrev (name definition
&optional from-mailrc-file
)
263 "Define NAME as a mail alias abbrev that translates to DEFINITION.
264 If DEFINITION contains multiple addresses, separate them with commas."
265 ;; When this is called from build-mail-abbrevs, the third argument is
266 ;; true, and we do some evil space->comma hacking like /bin/mail does.
267 (interactive "sDefine mail alias: \nsDefine %s as mail alias for: ")
268 ;; Read the defaults first, if we have not done so.
269 (unless (vectorp mail-abbrevs
) (build-mail-abbrevs))
270 ;; strip garbage from front and end
271 (if (string-match "\\`[ \t\n,]+" definition
)
272 (setq definition
(substring definition
(match-end 0))))
273 (if (string-match "[ \t\n,]+\\'" definition
)
274 (setq definition
(substring definition
0 (match-beginning 0))))
276 (L (length definition
))
277 (start (if (> L
0) 0))
280 ;; If we're reading from the mailrc file, then addresses are delimited
281 ;; by spaces, and addresses with embedded spaces must be surrounded by
282 ;; double-quotes. Otherwise, addresses are separated by commas.
284 (if (eq ?
\" (aref definition start
))
285 (setq start
(1+ start
)
286 end
(string-match "\"[ \t,]*" definition start
))
287 (setq end
(string-match "[ \t,]+" definition start
)))
288 (setq end
(string-match "[ \t\n,]*,[ \t\n,]*" definition start
)))
289 (let ((tem (substring definition start end
)))
290 ;; Advance the loop past this address.
294 ;; If the full name contains a problem character, quote it.
295 (when (string-match "\\(.+?\\)[ \t]*\\(<.*>\\)" tem
)
296 (if (string-match "[^- !#$%&'*+/0-9=?A-Za-z^_`{|}~]"
297 (match-string 1 tem
))
298 (setq tem
(replace-regexp-in-string
299 "\\(.+?\\)[ \t]*\\(<.*>\\)" "\"\\1\" \\2"
302 (setq definition
(mapconcat (function identity
)
304 mail-alias-separator-string
)))
305 (setq mail-abbrev-aliases-need-to-be-resolved t
)
306 (setq name
(downcase name
))
307 ;; use an abbrev table instead of an alist for mail-abbrevs.
308 (let ((abbrevs-changed abbrevs-changed
)) ; protect this from being changed.
309 (define-abbrev mail-abbrevs name definition
'mail-abbrev-expand-hook
0 t
)))
312 (defun mail-resolve-all-aliases ()
313 "Resolve all forward references in the mail aliases table."
314 (if mail-abbrev-aliases-need-to-be-resolved
316 ;; (message "Resolving mail aliases...")
317 (if (vectorp mail-abbrevs
)
318 (mapatoms (function mail-resolve-all-aliases-1
) mail-abbrevs
))
319 (setq mail-abbrev-aliases-need-to-be-resolved nil
)
320 ;; (message "Resolving mail aliases... done.")
323 (defun mail-resolve-all-aliases-1 (sym &optional so-far
)
324 (if (memq sym so-far
)
325 (error "mail alias loop detected: %s"
326 (mapconcat 'symbol-name
(cons sym so-far
) " <- ")))
327 (let ((definition (and (boundp sym
) (symbol-value sym
))))
332 (let ((end (string-match "[ \t\n]*,[, \t\n]*" definition start
)))
333 (setq result
(cons (substring definition start end
) result
)
334 start
(and end
(match-end 0)))))
336 (mapconcat (function (lambda (x)
337 (or (mail-resolve-all-aliases-1
338 (intern-soft (downcase x
) mail-abbrevs
)
342 mail-alias-separator-string
))
343 (set sym definition
))))
347 (defun mail-abbrev-expand-hook ()
348 "For use as the fourth arg to `define-abbrev'.
349 After expanding a mail-abbrev, if Auto Fill mode is on and we're past the
350 fill-column, break the line at the previous comma, and indent the next line."
351 ;; Disable abbrev mode to avoid recursion in indent-relative expanding
352 ;; part of the abbrev expansion as an abbrev itself.
353 (let ((abbrev-mode nil
))
360 (while (and auto-fill-function
361 (>= (current-column) fill-column
)
362 (search-backward "," bol t
))
364 (forward-char 1) ; Now we are just past the comma.
366 (delete-horizontal-space)
369 (setq fp
(buffer-substring p
(point)))
370 ;; Go to the end of the new line.
372 (if (> (current-column) fill-column
)
373 ;; It's still too long; do normal auto-fill.
374 (let ((fill-prefix (or fp
"\t")))
376 ;; Resume the search.
380 ;;; Syntax tables and abbrev-expansion
382 (defvar mail-abbrev-mode-regexp
383 "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):"
384 "*Regexp to select mail-headers in which mail abbrevs should be expanded.
385 This string will be handed to `looking-at' with point at the beginning
386 of the current line; if it matches, abbrev mode will be turned on, otherwise
387 it will be turned off. (You don't need to worry about continuation lines.)
388 This should be set to match those mail fields in which you want abbreviations
391 (defvar mail-abbrev-syntax-table nil
392 "The syntax-table used for abbrev-expansion purposes.
393 This is not actually made the current syntax table of the buffer, but
394 simply controls the set of characters which may be a part of the name
395 of a mail alias. The value is set up, buffer-local, when first needed.")
397 (defun mail-abbrev-make-syntax-table ()
398 (make-local-variable 'mail-abbrev-syntax-table
)
399 (unless mail-abbrev-syntax-table
400 (let ((tab (copy-syntax-table (syntax-table)))
401 (_ (aref (standard-syntax-table) ?_
))
402 (w (aref (standard-syntax-table) ?w
)))
404 (function (lambda (key value
)
406 ;; Fetch the inherited value
407 (setq value
(aref tab key
)))
409 (set-char-table-range tab key w
))))
411 (modify-syntax-entry ?
@ "w" tab
)
412 (modify-syntax-entry ?%
"w" tab
)
413 (modify-syntax-entry ?
! "w" tab
)
414 (modify-syntax-entry ?.
"w" tab
)
415 (modify-syntax-entry ?_
"w" tab
)
416 (modify-syntax-entry ?-
"w" tab
)
417 (setq mail-abbrev-syntax-table tab
))))
419 (defun mail-abbrev-in-expansion-header-p ()
420 "Whether point is in a mail-address header field."
421 (let ((case-fold-search t
))
423 ;; we are on an appropriate header line...
425 (unless (eobp) (forward-char 1))
426 (re-search-backward "^[^ \t]" nil
'move
)
427 ;; are we at the front of an appropriate header line?
428 (looking-at mail-abbrev-mode-regexp
))
430 ;; ...and are we in the headers?
438 (defun mail-abbrev-expand-wrapper (expand)
439 (if (and mail-abbrevs
(not (eq mail-abbrevs t
)))
440 (if (mail-abbrev-in-expansion-header-p)
442 ;; We are in a To: (or CC:, or whatever) header, and
443 ;; should use word-abbrevs to expand mail aliases.
444 (let ((local-abbrev-table mail-abbrevs
))
446 ;; Before anything else, resolve aliases if they need it.
447 (and mail-abbrev-aliases-need-to-be-resolved
448 (mail-resolve-all-aliases))
450 ;; Now proceed with the abbrev section.
451 ;; - We already installed mail-abbrevs as the abbrev table.
452 ;; - Then install the mail-abbrev-syntax-table, which
453 ;; temporarily marks all of the
454 ;; non-alphanumeric-atom-characters (the "_"
455 ;; syntax ones) as being normal word-syntax. We do this
456 ;; because the C code for expand-abbrev only works on words,
457 ;; and we want these characters to be considered words for
458 ;; the purpose of abbrev expansion.
459 ;; - Then we call the expand function, to do
460 ;; the abbrev expansion with the above syntax table.
462 (mail-abbrev-make-syntax-table)
464 ;; If the character just typed was non-alpha-symbol-syntax,
465 ;; then don't expand the abbrev now (that is, don't expand
466 ;; when the user types -.) Check the character's syntax in
467 ;; the usual syntax table.
469 (or (and (integerp last-command-char
)
470 ;; Some commands such as M-> may want to expand first.
471 (equal this-command
'self-insert-command
)
472 (or (eq (char-syntax last-command-char
) ?_
)
473 ;; Don't expand on @.
474 (memq last-command-char
'(?
@ ?. ?% ?
! ?_ ?-
))))
475 ;; Use this table so that abbrevs can have hyphens in them.
476 (with-syntax-table mail-abbrev-syntax-table
479 (if (or (not mail-abbrevs-only
)
480 (eq this-command
'expand-abbrev
))
481 ;; We're not in a mail header where mail aliases should
482 ;; be expanded, then use the normal mail-mode abbrev table
483 ;; (if any) and the normal mail-mode syntax table.
485 ;; This is not a mail abbrev, and we should not expand it.
486 ;; Don't expand anything.
488 ;; No mail-abbrevs at all, do the normal thing.
493 (defun merge-mail-abbrevs (file)
494 "Merge mail aliases from the given file with existing ones."
496 (let ((insert-default-directory t
)
497 (default-directory (expand-file-name "~/"))
498 (def mail-personal-alias-file
))
500 (format "Read additional aliases from file (default %s): "
503 (expand-file-name def default-directory
)
505 (build-mail-abbrevs file
))
507 (defun rebuild-mail-abbrevs (&optional file
)
508 "Rebuild all the mail aliases from the given file."
510 (let ((insert-default-directory t
)
511 (default-directory (expand-file-name "~/"))
512 (def mail-personal-alias-file
))
514 (format "Read mail aliases from file (default %s): " def
)
516 (expand-file-name def default-directory
)
519 (setq file buffer-file-name
))
520 (setq mail-abbrevs nil
)
521 (build-mail-abbrevs file
))
523 (defun mail-abbrev-insert-alias (&optional alias
)
524 "Prompt for and insert a mail alias."
526 (if (not (vectorp mail-abbrevs
)) (mail-abbrevs-setup))
527 (list (completing-read "Expand alias: " mail-abbrevs nil t
))))
528 (if (not (vectorp mail-abbrevs
)) (mail-abbrevs-setup))
529 (insert (or (and alias
(symbol-value (intern-soft alias mail-abbrevs
))) ""))
530 (mail-abbrev-expand-hook))
532 (defun mail-abbrev-complete-alias ()
533 "Perform completion on alias preceding point."
534 ;; Based on lisp.el:lisp-complete-symbol
536 (mail-abbrev-make-syntax-table)
538 (beg (with-syntax-table mail-abbrev-syntax-table
542 (alias (buffer-substring beg end
))
543 (completion (try-completion alias mail-abbrevs
)))
544 (cond ((eq completion t
)
545 (message "%s" alias
)) ; confirm
547 (error "[Can't complete \"%s\"]" alias
)) ; (message ...) (ding)
548 ((not (string= completion alias
))
549 (delete-region beg end
)
551 (t (with-output-to-temp-buffer "*Completions*"
552 (display-completion-list
554 (message "Making completion list...")
555 (all-completions alias mail-abbrevs
)
556 (message "Making completion list...done"))
559 (defun mail-abbrev-next-line (&optional arg
)
560 "Expand any mail abbrev, then move cursor vertically down ARG lines.
561 If there is no character in the target line exactly under the current column,
562 the cursor is positioned after the character in that line which spans this
563 column, or at the end of the line if it is not long enough.
564 If there is no line in the buffer after this one,
565 a newline character is inserted to create a line
566 and the cursor moves to that line.
568 The command \\[set-goal-column] can be used to create
569 a semipermanent goal column to which this command always moves.
570 Then it does not try to move vertically. This goal column is stored
571 in `goal-column', which is nil when there is none.
573 If you are thinking of using this in a Lisp program, consider
574 using `forward-line' instead. It is usually easier to use
575 and more reliable (no dependence on goal column, etc.)."
577 (if (looking-at "[ \t]*\n") (expand-abbrev))
578 (setq this-command
'next-line
)
579 (with-no-warnings (next-line arg
)))
581 (defun mail-abbrev-end-of-buffer (&optional arg
)
582 "Expand any mail abbrev, then move point to end of buffer.
583 Leave mark at previous position.
584 With arg N, put point N/10 of the way from the true end.
586 Don't use this command in Lisp programs!
587 \(goto-char (point-max)) is faster and avoids clobbering the mark."
589 (if (looking-at "[ \t]*\n") (expand-abbrev))
590 (setq this-command
'end-of-buffer
)
592 (end-of-buffer arg
)))
594 (eval-after-load "sendmail"
596 (define-key mail-mode-map
"\C-c\C-a" 'mail-abbrev-insert-alias
)
597 (define-key mail-mode-map
"\e\t" ; like lisp-complete-symbol
598 'mail-abbrev-complete-alias
)))
600 ;;(define-key mail-mode-map "\C-n" 'mail-abbrev-next-line)
601 ;;(define-key mail-mode-map "\M->" 'mail-abbrev-end-of-buffer)
603 (provide 'mailabbrev
)
605 ;; arch-tag: 5aa2d901-73f8-4ad7-b73c-4802282ad2ff
606 ;;; mailabbrev.el ends here