1 ;;; ietf-drums.el --- Functions for parsing RFC822bis headers
2 ;; Copyright (C) 1998, 1999, 2000
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Maintainer: bugs@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 2, or (at your option)
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; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; DRUMS is an IETF Working Group that works (or worked) on the
27 ;; successor to RFC822, "Standard For The Format Of Arpa Internet Text
28 ;; Messages". This library is based on
29 ;; draft-ietf-drums-msg-fmt-05.txt, released on 1998-08-05.
33 (eval-when-compile (require 'cl))
37 (defvar ietf-drums-no-ws-ctl-token "\001-\010\013\014\016-\037\177"
38 "US-ASCII control characters excluding CR, LF and white space.")
39 (defvar ietf-drums-text-token "\001-\011\013\014\016-\177"
40 "US-ASCII characters exlcuding CR and LF.")
41 (defvar ietf-drums-specials-token "()<>[]:;@\\,.\""
42 "Special characters.")
43 (defvar ietf-drums-quote-token "\\"
45 (defvar ietf-drums-wsp-token " \t"
47 (defvar ietf-drums-fws-regexp
48 (concat "[" ietf-drums-wsp-token "]*\n[" ietf-drums-wsp-token "]+")
49 "Folding white space.")
50 (defvar ietf-drums-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~"
52 (defvar ietf-drums-dot-atext-token "-^a-zA-Z0-9!#$%&'*+/=?_`{|}~."
53 "Textual token including full stop.")
54 (defvar ietf-drums-qtext-token
55 (concat ietf-drums-no-ws-ctl-token "\041\043-\133\135-\177")
56 "Non-white-space control characaters, plus the rest of ASCII excluding 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)
73 (defun ietf-drums-token-to-list (token)
74 "Translate TOKEN into a list of characters."
77 (while (< i (length token))
78 (setq c (mm-char-int (aref token i)))
81 ((eq c (mm-char-int ?-))
87 (push (mm-make-char 'ascii b) out)
91 (push (mm-make-char 'ascii c) out))
94 (push (mm-make-char 'ascii b) out))
98 (defsubst ietf-drums-init (string)
99 (set-syntax-table ietf-drums-syntax-table)
101 (ietf-drums-unfold-fws)
102 (goto-char (point-min)))
104 (defun ietf-drums-remove-comments (string)
105 "Remove comments from STRING."
108 (ietf-drums-init string)
110 (setq c (char-after))
115 (delete-region (point) (progn (forward-sexp 1) (point))))
120 (defun ietf-drums-remove-whitespace (string)
121 "Remove whitespace from STRING."
123 (ietf-drums-init string)
126 (setq c (char-after))
132 ((memq c '(? ?\t ?\n))
138 (defun ietf-drums-get-comment (string)
139 "Return the first comment in STRING."
141 (ietf-drums-init string)
144 (setq c (char-after))
152 (progn (forward-sexp 1) (1- (point))))))
157 (defun ietf-drums-strip (string)
158 "Remove comments and whitespace from STRING."
159 (ietf-drums-remove-whitespace (ietf-drums-remove-comments string)))
161 (defun ietf-drums-parse-address (string)
162 "Parse STRING and return a MAILBOX / DISPLAY-NAME pair."
164 (let (display-name mailbox c display-string)
165 (ietf-drums-init string)
167 (setq c (char-after))
175 (push (buffer-substring
176 (1+ (point)) (progn (forward-sexp 1) (1- (point))))
178 ((looking-at (concat "[" ietf-drums-atext-token "@" "]"))
179 (push (buffer-substring (point) (progn (forward-sexp 1) (point)))
183 (ietf-drums-remove-whitespace
184 (ietf-drums-remove-comments
187 (progn (forward-sexp 1) (1- (point))))))))
188 (t (error "Unknown symbol: %c" c))))
189 ;; If we found no display-name, then we look for comments.
192 (mapconcat 'identity (reverse display-name) " "))
193 (setq display-string (ietf-drums-get-comment string)))
195 (when (string-match "@" display-string)
197 (mapconcat 'identity (nreverse display-name) "")
198 (ietf-drums-get-comment string)))
199 (cons mailbox display-string)))))
201 (defun ietf-drums-parse-addresses (string)
202 "Parse STRING and return a list of MAILBOX / DISPLAY-NAME pairs."
204 (ietf-drums-init string)
208 (setq c (char-after))
210 ((memq c '(?\" ?< ?\())
213 (push (ietf-drums-parse-address (buffer-substring beg (point)))
219 (push (ietf-drums-parse-address (buffer-substring beg (point)))
223 (defun ietf-drums-unfold-fws ()
224 "Unfold folding white space in the current buffer."
225 (goto-char (point-min))
226 (while (re-search-forward ietf-drums-fws-regexp nil t)
227 (replace-match " " t t))
228 (goto-char (point-min)))
230 (defun ietf-drums-parse-date (string)
231 "Return an Emacs time spec from STRING."
232 (apply 'encode-time (parse-time-string string)))
234 (defun ietf-drums-narrow-to-header ()
235 "Narrow to the header section in the current buffer."
237 (goto-char (point-min))
238 (if (re-search-forward "^\r?$" nil 1)
241 (goto-char (point-min)))
243 (defun ietf-drums-quote-string (string)
244 "Quote string if it needs quoting to be displayed in a header."
245 (if (string-match (concat "[^" ietf-drums-atext-token "]") string)
246 (concat "\"" string "\"")
249 (provide 'ietf-drums)
251 ;;; ietf-drums.el ends here