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 (modify-syntax-entry ?\' " " table)
71 (if (featurep 'xemacs)
74 (modify-syntax-entry i "w" table)
78 (defun ietf-drums-token-to-list (token)
79 "Translate TOKEN into a list of characters."
82 (while (< i (length token))
83 (setq c (mm-char-int (aref token i)))
86 ((eq c (mm-char-int ?-))
92 (push (mm-make-char 'ascii b) out)
96 (push (mm-make-char 'ascii c) out))
99 (push (mm-make-char 'ascii b) out))
103 (defsubst ietf-drums-init (string)
104 (set-syntax-table ietf-drums-syntax-table)
106 (ietf-drums-unfold-fws)
107 (goto-char (point-min)))
109 (defun ietf-drums-remove-comments (string)
110 "Remove comments from STRING."
113 (ietf-drums-init string)
115 (setq c (char-after))
120 (delete-region (point) (progn (forward-sexp 1) (point))))
125 (defun ietf-drums-remove-whitespace (string)
126 "Remove whitespace from STRING."
128 (ietf-drums-init string)
131 (setq c (char-after))
137 ((memq c '(? ?\t ?\n))
143 (defun ietf-drums-get-comment (string)
144 "Return the first comment in STRING."
146 (ietf-drums-init string)
149 (setq c (char-after))
157 (progn (forward-sexp 1) (1- (point))))))
162 (defun ietf-drums-strip (string)
163 "Remove comments and whitespace from STRING."
164 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string)))
166 (defun ietf-drums-parse-address (string)
167 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
169 (let (display-name mailbox c display-string)
170 (ietf-drums-init string)
172 (setq c (char-after))
180 (push (buffer-substring
181 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
183 ((looking-at (concat "[" ietf-drums-atext-token "@" "]"))
184 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
188 (ietf-drums-remove-whitespace
189 (ietf-drums-remove-comments
192 (progn (forward-sexp 1) (1- (point))))))))
193 (t (error "Unknown symbol: %c" c))))
194 ;; If we found no display-name, then we look for comments.
197 (mapconcat 'identity (reverse display-name) " "))
198 (setq display-string (ietf-drums-get-comment string)))
200 (when (string-match "@" display-string)
202 (mapconcat 'identity (nreverse display-name) "")
203 (ietf-drums-get-comment string)))
204 (cons mailbox display-string)))))
206 (defun ietf-drums-parse-addresses (string)
207 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs."
211 (ietf-drums-init string)
215 (setq c (char-after))
217 ((memq c '(?\" ?< ?\())
221 (skip-chars-forward "^,"))))
225 (ietf-drums-parse-address
226 (buffer-substring beg (point)))
228 (if address (push address pairs))
235 (ietf-drums-parse-address
236 (buffer-substring beg (point)))
238 (if address (push address pairs))
241 (defun ietf-drums-unfold-fws ()
242 "Unfold folding white space in the current buffer."
243 (goto-char (point-min))
244 (while (re-search-forward ietf-drums-fws-regexp nil t)
245 (replace-match " " t t))
246 (goto-char (point-min)))
248 (defun ietf-drums-parse-date (string)
249 "Return an Emacs time spec from STRING."
250 (apply 'encode-time (parse-time-string string)))
252 (defun ietf-drums-narrow-to-header ()
253 "Narrow to the header section in the current buffer."
255 (goto-char (point-min))
256 (if (re-search-forward "^\r?$" nil 1)
259 (goto-char (point-min)))
261 (defun ietf-drums-quote-string (string)
262 "Quote string if it needs quoting to be displayed in a header."
263 (if (string-match (concat "[^" ietf-drums-atext-token "]") string)
264 (concat "\"" string "\"")
267 (provide 'ietf-drums)
269 ;;; ietf-drums.el ends here