1 ;;; ietf-drums.el --- Functions for parsing RFC822bis headers
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
25 ;; DRUMS is an IETF Working Group that works (or worked) on the
26 ;; successor to RFC822, "Standard For The Format Of Arpa Internet Text
27 ;; Messages". This library is based on
28 ;; draft-ietf-drums-msg-fmt-05.txt, released on 1998-08-05.
30 ;; Pending a real regression self test suite, Simon Josefsson added
31 ;; various self test expressions snipped from bug reports, and their
32 ;; expected value, below. I you believe it could be useful, please
33 ;; add your own test cases, or write a real self test suite, or just
36 ;; <m3oekvfd50.fsf@whitebox.m5r.de>
37 ;; (ietf-drums-parse-address "'foo' <foo@example.com>")
38 ;; => ("foo@example.com" . "'foo'")
42 (eval-when-compile (require 'cl))
46 (defvar ietf-drums-no-ws-ctl-token "\001-\010\013\014\016-\037\177"
47 "US-ASCII control characters excluding CR, LF and white space.")
48 (defvar ietf-drums-text-token "\001-\011\013\014\016-\177"
49 "US-ASCII characters excluding CR and LF.")
50 (defvar ietf-drums-specials-token "()<>[]:;@\\,.\""
51 "Special characters.")
52 (defvar ietf-drums-quote-token "\\"
54 (defvar ietf-drums-wsp-token " \t"
56 (defvar ietf-drums-fws-regexp
57 (concat "[" ietf-drums-wsp-token "]*\n[" ietf-drums-wsp-token "]+")
58 "Folding white space.")
59 (defvar ietf-drums-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~"
61 (defvar ietf-drums-dot-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~."
62 "Textual token including full stop.")
63 (defvar ietf-drums-qtext-token
64 (concat ietf-drums-no-ws-ctl-token "\041\043-\133\135-\177")
65 "Non-white-space control characters, plus the rest of ASCII excluding
66 backslash and doublequote.")
67 (defvar ietf-drums-tspecials "][()<>@,;:\\\"/?="
70 (defvar ietf-drums-syntax-table
71 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
72 (modify-syntax-entry ?\\ "/" table)
73 (modify-syntax-entry ?< "(" table)
74 (modify-syntax-entry ?> ")" table)
75 (modify-syntax-entry ?@ "w" table)
76 (modify-syntax-entry ?/ "w" table)
77 (modify-syntax-entry ?* "_" table)
78 (modify-syntax-entry ?\; "_" table)
79 (modify-syntax-entry ?\' "_" table)
80 (if (featurep 'xemacs)
83 (modify-syntax-entry i "w" table)
87 (defun ietf-drums-token-to-list (token)
88 "Translate TOKEN into a list of characters."
91 (while (< i (length token))
92 (setq c (mm-char-int (aref token i)))
95 ((eq c (mm-char-int ?-))
101 (push (make-char 'ascii b) out)
104 ((= i (length token))
105 (push (make-char 'ascii c) out))
108 (push (make-char 'ascii b) out))
112 (defsubst ietf-drums-init (string)
113 (set-syntax-table ietf-drums-syntax-table)
115 (ietf-drums-unfold-fws)
116 (goto-char (point-min)))
118 (defun ietf-drums-remove-comments (string)
119 "Remove comments from STRING."
122 (ietf-drums-init string)
124 (setq c (char-after))
129 (delete-region (point) (progn (forward-sexp 1) (point))))
134 (defun ietf-drums-remove-whitespace (string)
135 "Remove whitespace from STRING."
137 (ietf-drums-init string)
140 (setq c (char-after))
146 ((memq c '(?\ ?\t ?\n))
152 (defun ietf-drums-get-comment (string)
153 "Return the first comment in STRING."
155 (ietf-drums-init string)
158 (setq c (char-after))
166 (progn (forward-sexp 1) (1- (point))))))
171 (defun ietf-drums-strip (string)
172 "Remove comments and whitespace from STRING."
173 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string)))
175 (defun ietf-drums-parse-address (string)
176 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
178 (let (display-name mailbox c display-string)
179 (ietf-drums-init string)
181 (setq c (char-after))
189 (push (buffer-substring
190 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
192 ((looking-at (concat "[" ietf-drums-atext-token "@" "]"))
193 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
197 (ietf-drums-remove-whitespace
198 (ietf-drums-remove-comments
201 (progn (forward-sexp 1) (1- (point))))))))
202 (t (error "Unknown symbol: %c" c))))
203 ;; If we found no display-name, then we look for comments.
206 (mapconcat 'identity (reverse display-name) " "))
207 (setq display-string (ietf-drums-get-comment string)))
209 (when (string-match "@" display-string)
211 (mapconcat 'identity (nreverse display-name) "")
212 (ietf-drums-get-comment string)))
213 (cons mailbox display-string)))))
215 (defun ietf-drums-parse-addresses (string)
216 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs."
220 (ietf-drums-init string)
224 (setq c (char-after))
226 ((memq c '(?\" ?< ?\())
230 (skip-chars-forward "^,"))))
234 (ietf-drums-parse-address
235 (buffer-substring beg (point)))
237 (if address (push address pairs))
244 (ietf-drums-parse-address
245 (buffer-substring beg (point)))
247 (if address (push address pairs))
250 (defun ietf-drums-unfold-fws ()
251 "Unfold folding white space in the current buffer."
252 (goto-char (point-min))
253 (while (re-search-forward ietf-drums-fws-regexp nil t)
254 (replace-match " " t t))
255 (goto-char (point-min)))
257 (defun ietf-drums-parse-date (string)
258 "Return an Emacs time spec from STRING."
259 (apply 'encode-time (parse-time-string string)))
261 (defun ietf-drums-narrow-to-header ()
262 "Narrow to the header section in the current buffer."
264 (goto-char (point-min))
265 (if (re-search-forward "^\r?$" nil 1)
268 (goto-char (point-min)))
270 (defun ietf-drums-quote-string (string)
271 "Quote string if it needs quoting to be displayed in a header."
272 (if (string-match (concat "[^" ietf-drums-atext-token "]") string)
273 (concat "\"" string "\"")
276 (defun ietf-drums-make-address (name address)
278 (concat (ietf-drums-quote-string name) " <" address ">")
281 (provide 'ietf-drums)
283 ;;; ietf-drums.el ends here