1 ;;; ietf-drums.el --- Functions for parsing RFC822bis headers
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; DRUMS is an IETF Working Group that works (or worked) on the
25 ;; successor to RFC822, "Standard For The Format Of Arpa Internet Text
26 ;; Messages". This library is based on
27 ;; draft-ietf-drums-msg-fmt-05.txt, released on 1998-08-05.
29 ;; Pending a real regression self test suite, Simon Josefsson added
30 ;; various self test expressions snipped from bug reports, and their
31 ;; expected value, below. I you believe it could be useful, please
32 ;; add your own test cases, or write a real self test suite, or just
35 ;; <m3oekvfd50.fsf@whitebox.m5r.de>
36 ;; (ietf-drums-parse-address "'foo' <foo@example.com>")
37 ;; => ("foo@example.com" . "'foo'")
41 (eval-when-compile (require 'cl
))
45 (defvar ietf-drums-no-ws-ctl-token
"\001-\010\013\014\016-\037\177"
46 "US-ASCII control characters excluding CR, LF and white space.")
47 (defvar ietf-drums-text-token
"\001-\011\013\014\016-\177"
48 "US-ASCII characters excluding CR and LF.")
49 (defvar ietf-drums-specials-token
"()<>[]:;@\\,.\""
50 "Special characters.")
51 (defvar ietf-drums-quote-token
"\\"
53 (defvar ietf-drums-wsp-token
" \t"
55 (defvar ietf-drums-fws-regexp
56 (concat "[" ietf-drums-wsp-token
"]*\n[" ietf-drums-wsp-token
"]+")
57 "Folding white space.")
58 (defvar ietf-drums-atext-token
"-^a-zA-Z0-9!#$%&'*+/=?_`{|}~"
60 (defvar ietf-drums-dot-atext-token
"-^a-zA-Z0-9!#$%&'*+/=?_`{|}~."
61 "Textual token including full stop.")
62 (defvar ietf-drums-qtext-token
63 (concat ietf-drums-no-ws-ctl-token
"\041\043-\133\135-\177")
64 "Non-white-space control characters, plus the rest of ASCII excluding
65 backslash and doublequote.")
66 (defvar ietf-drums-tspecials
"][()<>@,;:\\\"/?="
69 (defvar ietf-drums-syntax-table
70 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table
)))
71 (modify-syntax-entry ?
\\ "/" table
)
72 (modify-syntax-entry ?
< "(" table
)
73 (modify-syntax-entry ?
> ")" table
)
74 (modify-syntax-entry ?
@ "w" table
)
75 (modify-syntax-entry ?
/ "w" table
)
76 (modify-syntax-entry ?
* "_" table
)
77 (modify-syntax-entry ?\
; "_" table)
78 (modify-syntax-entry ?
\' "_" table
)
79 (if (featurep 'xemacs
)
82 (modify-syntax-entry i
"w" table
)
86 (defun ietf-drums-token-to-list (token)
87 "Translate TOKEN into a list of characters."
90 (while (< i
(length token
))
91 (setq c
(mm-char-int (aref token i
)))
94 ((eq c
(mm-char-int ?-
))
100 (push (make-char 'ascii b
) out
)
103 ((= i
(length token
))
104 (push (make-char 'ascii c
) out
))
107 (push (make-char 'ascii b
) out
))
111 (defsubst ietf-drums-init
(string)
112 (set-syntax-table ietf-drums-syntax-table
)
114 (ietf-drums-unfold-fws)
115 (goto-char (point-min)))
117 (defun ietf-drums-remove-comments (string)
118 "Remove comments from STRING."
121 (ietf-drums-init string
)
123 (setq c
(char-after))
128 (delete-region (point) (progn (forward-sexp 1) (point))))
133 (defun ietf-drums-remove-whitespace (string)
134 "Remove whitespace from STRING."
136 (ietf-drums-init string
)
139 (setq c
(char-after))
145 ((memq c
'(?\ ?
\t ?
\n))
151 (defun ietf-drums-get-comment (string)
152 "Return the first comment in STRING."
154 (ietf-drums-init string
)
157 (setq c
(char-after))
165 (progn (forward-sexp 1) (1- (point))))))
170 (defun ietf-drums-strip (string)
171 "Remove comments and whitespace from STRING."
172 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string
)))
174 (defun ietf-drums-parse-address (string)
175 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
177 (let (display-name mailbox c display-string
)
178 (ietf-drums-init string
)
180 (setq c
(char-after))
188 (push (buffer-substring
189 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
191 ((looking-at (concat "[" ietf-drums-atext-token
"@" "]"))
192 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
196 (ietf-drums-remove-whitespace
197 (ietf-drums-remove-comments
200 (progn (forward-sexp 1) (1- (point))))))))
202 (message "Unknown symbol: %c" c
)
204 ;; If we found no display-name, then we look for comments.
207 (mapconcat 'identity
(reverse display-name
) " "))
208 (setq display-string
(ietf-drums-get-comment string
)))
210 (when (string-match "@" display-string
)
212 (mapconcat 'identity
(nreverse display-name
) "")
213 (ietf-drums-get-comment string
)))
214 (cons mailbox display-string
)))))
216 (defun ietf-drums-parse-addresses (string &optional rawp
)
217 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs.
218 If RAWP, don't actually parse the addresses, but instead return
219 a list of address strings."
223 (ietf-drums-init string
)
227 (setq c
(char-after))
229 ((memq c
'(?
\" ?
< ?\
())
233 (skip-chars-forward "^,"))))
237 (buffer-substring beg
(point))
239 (ietf-drums-parse-address
240 (buffer-substring beg
(point)))
242 (if address
(push address pairs
))
249 (buffer-substring beg
(point))
251 (ietf-drums-parse-address
252 (buffer-substring beg
(point)))
254 (if address
(push address pairs
))
257 (defun ietf-drums-unfold-fws ()
258 "Unfold folding white space in the current buffer."
259 (goto-char (point-min))
260 (while (re-search-forward ietf-drums-fws-regexp nil t
)
261 (replace-match " " t t
))
262 (goto-char (point-min)))
264 (defun ietf-drums-parse-date (string)
265 "Return an Emacs time spec from STRING."
266 (apply 'encode-time
(parse-time-string string
)))
268 (defun ietf-drums-narrow-to-header ()
269 "Narrow to the header section in the current buffer."
271 (goto-char (point-min))
272 (if (re-search-forward "^\r?$" nil
1)
275 (goto-char (point-min)))
277 (defun ietf-drums-quote-string (string)
278 "Quote string if it needs quoting to be displayed in a header."
279 (if (string-match (concat "[^" ietf-drums-atext-token
"]") string
)
280 (concat "\"" string
"\"")
283 (defun ietf-drums-make-address (name address
)
285 (concat (ietf-drums-quote-string name
) " <" address
">")
288 (provide 'ietf-drums
)
290 ;; arch-tag: 379a0191-dbae-4ca6-a0f5-d4202c209ef9
291 ;;; ietf-drums.el ends here