1 ;;; ietf-drums.el --- Functions for parsing RFC822bis headers
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
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.
32 (eval-when-compile (require 'cl))
36 (defvar ietf-drums-no-ws-ctl-token "\001-\010\013\014\016-\037\177"
37 "US-ASCII control characters excluding CR, LF and white space.")
38 (defvar ietf-drums-text-token "\001-\011\013\014\016-\177"
39 "US-ASCII characters excluding CR and LF.")
40 (defvar ietf-drums-specials-token "()<>[]:;@\\,.\""
41 "Special characters.")
42 (defvar ietf-drums-quote-token "\\"
44 (defvar ietf-drums-wsp-token " \t"
46 (defvar ietf-drums-fws-regexp
47 (concat "[" ietf-drums-wsp-token "]*\n[" ietf-drums-wsp-token "]+")
48 "Folding white space.")
49 (defvar ietf-drums-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~"
51 (defvar ietf-drums-dot-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~."
52 "Textual token including full stop.")
53 (defvar ietf-drums-qtext-token
54 (concat ietf-drums-no-ws-ctl-token "\041\043-\133\135-\177")
55 "Non-white-space control characters, plus the rest of ASCII excluding
56 backslash and doublequote.")
57 (defvar ietf-drums-tspecials "][()<>@,;:\\\"/?="
60 (defvar ietf-drums-syntax-table
61 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
62 (modify-syntax-entry ?\\ "/" table)
63 (modify-syntax-entry ?< "(" table)
64 (modify-syntax-entry ?> ")" table)
65 (modify-syntax-entry ?@ "w" table)
66 (modify-syntax-entry ?/ "w" table)
67 (modify-syntax-entry ?* " " table)
68 (modify-syntax-entry ?\; " " table)
69 (modify-syntax-entry ?\' " " table)
70 (if (featurep 'xemacs)
73 (modify-syntax-entry i "w" table)
77 (defun ietf-drums-token-to-list (token)
78 "Translate TOKEN into a list of characters."
81 (while (< i (length token))
82 (setq c (mm-char-int (aref token i)))
85 ((eq c (mm-char-int ?-))
91 (push (make-char 'ascii b) out)
95 (push (make-char 'ascii c) out))
98 (push (make-char 'ascii b) out))
102 (defsubst ietf-drums-init (string)
103 (set-syntax-table ietf-drums-syntax-table)
105 (ietf-drums-unfold-fws)
106 (goto-char (point-min)))
108 (defun ietf-drums-remove-comments (string)
109 "Remove comments from STRING."
112 (ietf-drums-init string)
114 (setq c (char-after))
119 (delete-region (point) (progn (forward-sexp 1) (point))))
124 (defun ietf-drums-remove-whitespace (string)
125 "Remove whitespace from STRING."
127 (ietf-drums-init string)
130 (setq c (char-after))
136 ((memq c '(? ?\t ?\n))
142 (defun ietf-drums-get-comment (string)
143 "Return the first comment in STRING."
145 (ietf-drums-init string)
148 (setq c (char-after))
156 (progn (forward-sexp 1) (1- (point))))))
161 (defun ietf-drums-strip (string)
162 "Remove comments and whitespace from STRING."
163 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string)))
165 (defun ietf-drums-parse-address (string)
166 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
168 (let (display-name mailbox c display-string)
169 (ietf-drums-init string)
171 (setq c (char-after))
179 (push (buffer-substring
180 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
182 ((looking-at (concat "[" ietf-drums-atext-token "@" "]"))
183 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
187 (ietf-drums-remove-whitespace
188 (ietf-drums-remove-comments
191 (progn (forward-sexp 1) (1- (point))))))))
192 (t (error "Unknown symbol: %c" c))))
193 ;; If we found no display-name, then we look for comments.
196 (mapconcat 'identity (reverse display-name) " "))
197 (setq display-string (ietf-drums-get-comment string)))
199 (when (string-match "@" display-string)
201 (mapconcat 'identity (nreverse display-name) "")
202 (ietf-drums-get-comment string)))
203 (cons mailbox display-string)))))
205 (defun ietf-drums-parse-addresses (string)
206 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs."
210 (ietf-drums-init string)
214 (setq c (char-after))
216 ((memq c '(?\" ?< ?\())
220 (skip-chars-forward "^,"))))
224 (ietf-drums-parse-address
225 (buffer-substring beg (point)))
227 (if address (push address pairs))
234 (ietf-drums-parse-address
235 (buffer-substring beg (point)))
237 (if address (push address pairs))
240 (defun ietf-drums-unfold-fws ()
241 "Unfold folding white space in the current buffer."
242 (goto-char (point-min))
243 (while (re-search-forward ietf-drums-fws-regexp nil t)
244 (replace-match " " t t))
245 (goto-char (point-min)))
247 (defun ietf-drums-parse-date (string)
248 "Return an Emacs time spec from STRING."
249 (apply 'encode-time (parse-time-string string)))
251 (defun ietf-drums-narrow-to-header ()
252 "Narrow to the header section in the current buffer."
254 (goto-char (point-min))
255 (if (re-search-forward "^\r?$" nil 1)
258 (goto-char (point-min)))
260 (defun ietf-drums-quote-string (string)
261 "Quote string if it needs quoting to be displayed in a header."
262 (if (string-match (concat "[^" ietf-drums-atext-token "]") string)
263 (concat "\"" string "\"")
266 (provide 'ietf-drums)
268 ;;; ietf-drums.el ends here