1 ;;; mime-def.el --- definition module about MIME
3 ;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
4 ;; Copyright (C) 1999 Electrotechnical Laboratory, JAPAN.
5 ;; Licensed to the Free Software Foundation.
7 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
8 ;; Keywords: definition, MIME, multimedia, mail, news
10 ;; This file is part of FLIM (Faithful Library about Internet Message).
12 ;; This program is free software; you can redistribute it and/or
13 ;; modify it under the terms of the GNU General Public License as
14 ;; published by the Free Software Foundation; either version 2, or (at
15 ;; your option) any later version.
17 ;; This program is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
35 (eval-when-compile (require 'cl)) ; list*
38 (defconst mime-library-product ["CLIME" (1 13 3) "
\e$BJ?C<
\e(B"]
39 "Product name, version number and code name of MIME-library package.")
42 (defmacro mime-product-name (product)
43 (` (aref (, product) 0)))
45 (defmacro mime-product-version (product)
46 (` (aref (, product) 1)))
48 (defmacro mime-product-code-name (product)
49 (` (aref (, product) 2)))
51 (defconst mime-library-version
53 (concat (mime-product-name mime-library-product) " "
54 (mapconcat (function int-to-string)
55 (mime-product-version mime-library-product) ".")
56 " - \"" (mime-product-code-name mime-library-product) "\"")))
62 (defgroup mime '((default-mime-charset custom-variable))
63 "Emacs MIME Interfaces"
67 (defcustom mime-uuencode-encoding-name-list '("x-uue" "x-uuencode")
68 "*List of encoding names for uuencode format."
70 :type '(repeat string))
73 ;;; @ required functions
76 (defsubst regexp-* (regexp)
79 (defsubst regexp-or (&rest args)
80 (concat "\\(" (mapconcat (function identity) args "\\|") "\\)"))
87 (defconst std11-quoted-pair-regexp "\\\\.")
88 (defconst std11-non-qtext-char-list '(?\" ?\\ ?\r ?\n))
89 (defconst std11-qtext-regexp
91 (concat "[^" std11-non-qtext-char-list "]"))))
92 (defconst std11-quoted-string-regexp
96 (regexp-or std11-qtext-regexp std11-quoted-pair-regexp))
104 (defconst mime-tspecial-char-list
105 '(?\] ?\[ ?\( ?\) ?< ?> ?@ ?, ?\; ?: ?\\ ?\" ?/ ?? ?=)))
106 (defconst mime-token-regexp
108 (concat "[^" mime-tspecial-char-list "\000-\040]+")))
109 (defconst mime-charset-regexp mime-token-regexp)
111 (defconst mime-media-type/subtype-regexp
112 (concat mime-token-regexp "/" mime-token-regexp))
118 (defconst base64-token-regexp "[A-Za-z0-9+/]")
119 (defconst base64-token-padding-regexp "[A-Za-z0-9+/=]")
121 (defconst B-encoded-text-regexp
130 base64-token-padding-regexp
131 base64-token-padding-regexp
134 ;; (defconst eword-B-encoding-and-encoded-text-regexp
135 ;; (concat "\\(B\\)\\?" eword-B-encoded-text-regexp))
138 ;;; @@ Quoted-Printable / Q
141 (defconst quoted-printable-hex-chars "0123456789ABCDEF")
143 (defconst quoted-printable-octet-regexp
144 (concat "=[" quoted-printable-hex-chars
145 "][" quoted-printable-hex-chars "]"))
147 (defconst Q-encoded-text-regexp
148 (concat "\\([^=?]\\|" quoted-printable-octet-regexp "\\)+"))
150 ;; (defconst eword-Q-encoding-and-encoded-text-regexp
151 ;; (concat "\\(Q\\)\\?" eword-Q-encoded-text-regexp))
157 (defsubst make-mime-content-type (type subtype &optional parameters)
158 (list* (cons 'type type)
159 (cons 'subtype subtype)
160 (nreverse parameters))
163 (defsubst mime-content-type-primary-type (content-type)
164 "Return primary-type of CONTENT-TYPE."
165 (cdr (car content-type)))
167 (defsubst mime-content-type-subtype (content-type)
168 "Return primary-type of CONTENT-TYPE."
169 (cdr (cadr content-type)))
171 (defsubst mime-content-type-parameters (content-type)
172 "Return primary-type of CONTENT-TYPE."
175 (defsubst mime-content-type-parameter (content-type parameter)
176 "Return PARAMETER value of CONTENT-TYPE."
177 (cdr (assoc parameter (mime-content-type-parameters content-type))))
180 (defsubst mime-type/subtype-string (type &optional subtype)
181 "Return type/subtype string from TYPE and SUBTYPE."
184 (format "%s/%s" type subtype)
185 (format "%s" type))))
188 ;;; @ Content-Disposition
191 (defsubst mime-content-disposition-type (content-disposition)
192 "Return disposition-type of CONTENT-DISPOSITION."
193 (cdr (car content-disposition)))
195 (defsubst mime-content-disposition-parameters (content-disposition)
196 "Return disposition-parameters of CONTENT-DISPOSITION."
197 (cdr content-disposition))
199 (defsubst mime-content-disposition-parameter (content-disposition parameter)
200 "Return PARAMETER value of CONTENT-DISPOSITION."
201 (cdr (assoc parameter (cdr content-disposition))))
203 (defsubst mime-content-disposition-filename (content-disposition)
204 "Return filename of CONTENT-DISPOSITION."
205 (mime-content-disposition-parameter content-disposition "filename"))
213 (autoload 'mime-entity-content-type "mime")
214 (autoload 'mime-parse-multipart "mime-parse")
215 (autoload 'mime-parse-encapsulated "mime-parse")
216 (autoload 'mime-entity-content "mime")
218 (luna-define-class mime-entity ()
220 content-type children parent
222 content-disposition encoding
224 original-header parsed-header))
226 (defalias 'mime-entity-representation-type-internal 'luna-class-name)
227 (defalias 'mime-entity-set-representation-type-internal 'luna-set-class-name)
229 (luna-define-internal-accessors 'mime-entity)
231 (luna-define-method mime-entity-fetch-field ((entity mime-entity)
233 (or (symbolp field-name)
234 (setq field-name (intern (capitalize (capitalize field-name)))))
235 (cdr (assq field-name
236 (mime-entity-original-header-internal entity))))
238 (luna-define-method mime-entity-children ((entity mime-entity))
239 (let* ((content-type (mime-entity-content-type entity))
240 (primary-type (mime-content-type-primary-type content-type)))
241 (cond ((eq primary-type 'multipart)
242 (mime-parse-multipart entity)
244 ((and (eq primary-type 'message)
245 (memq (mime-content-type-subtype content-type)
246 '(rfc822 news external-body)
248 (mime-parse-encapsulated entity)
252 (luna-define-method mime-insert-text-content ((entity mime-entity))
254 (decode-mime-charset-string (mime-entity-content entity)
255 (or (mime-content-type-parameter
256 (mime-entity-content-type entity)
258 default-mime-charset)
266 (defmacro mm-expand-class-name (type)
267 (` (intern (format "mime-%s-entity" (, type)))))
269 (defmacro mm-define-backend (type &optional parents)
270 (` (luna-define-class (, (mm-expand-class-name type))
271 (, (nconc (mapcar (function
273 (mm-expand-class-name parent)
278 (defmacro mm-define-method (name args &rest body)
279 (or (eq name 'initialize-instance)
280 (setq name (intern (format "mime-%s" name))))
281 (let ((spec (car args)))
283 (cons (list (car spec)
284 (mm-expand-class-name (nth 1 spec)))
286 (` (luna-define-method (, name) (, args) (,@ body)))
289 (put 'mm-define-method 'lisp-indent-function 'defun)
291 (def-edebug-spec mm-define-method
292 (&define name ((arg symbolp)
294 [&optional ["&optional" arg &rest arg]]
295 &optional ["&rest" arg]
300 ;;; @ message structure
303 (defvar mime-message-structure nil
304 "Information about structure of message.
305 Please use reference function `mime-entity-SLOT' to get value of SLOT.
307 Following is a list of slots of the structure:
309 node-id node-id (list of integers)
310 content-type content-type (content-type)
311 content-disposition content-disposition (content-disposition)
312 encoding Content-Transfer-Encoding (string or nil)
313 children entities included in this entity (list of entity)
315 If an entity includes other entities in its body, such as multipart or
316 message/rfc822, `mime-entity' structures of them are included in
317 `children', so the `mime-entity' structure become a tree.")
319 (make-variable-buffer-local 'mime-message-structure)
321 (make-obsolete-variable 'mime-message-structure "should not use it.")
324 ;;; @ for mel-backend
327 (defvar mel-service-list nil)
329 (defmacro mel-define-service (name &optional args &rest rest)
330 "Define NAME as a service for Content-Transfer-Encodings.
331 If ARGS is specified, NAME is defined as a generic function for the
334 (add-to-list 'mel-service-list '(, name))
335 (defvar (, (intern (format "%s-obarray" name))) (make-vector 7 0))
337 (` ((defun (, name) (, args)
339 (funcall (mel-find-function '(, name)
340 (, (car (last args))))
341 (,@ (luna-arglist-to-arguments (butlast args))))
345 (put 'mel-define-service 'lisp-indent-function 'defun)
348 (defvar mel-encoding-module-alist nil)
350 (defsubst mel-find-function-from-obarray (ob-array encoding)
351 (let* ((f (intern-soft encoding ob-array)))
353 (let ((rest (cdr (assoc encoding mel-encoding-module-alist))))
357 (null (setq f (intern-soft encoding ob-array)))
359 (setq rest (cdr rest))
363 (defsubst mel-copy-method (service src-backend dst-backend)
364 (let* ((oa (symbol-value (intern (format "%s-obarray" service))))
365 (f (mel-find-function-from-obarray oa src-backend))
368 (setq sym (intern dst-backend oa))
370 (fset sym (symbol-function f))
373 (defsubst mel-copy-backend (src-backend dst-backend)
374 (let ((services mel-service-list))
376 (mel-copy-method (car services) src-backend dst-backend)
377 (setq services (cdr services)))))
379 (defmacro mel-define-backend (type &optional parents)
380 "Define TYPE as a mel-backend.
381 If PARENTS is specified, TYPE inherits PARENTS.
382 Each parent must be backend name (string)."
386 (` (mel-copy-backend (, parent) (, type)))
390 (defmacro mel-define-method (name args &rest body)
391 "Define NAME as a method function of (nth 1 (car (last ARGS))) backend.
392 ARGS is like an argument list of lambda, but (car (last ARGS)) must be
393 specialized parameter. (car (car (last ARGS))) is name of variable
394 and (nth 1 (car (last ARGS))) is name of backend (encoding)."
395 (let* ((specializer (car (last args)))
396 (class (nth 1 specializer)))
398 (mel-define-service (, name))
399 (fset (intern (, class) (, (intern (format "%s-obarray" name))))
401 (lambda (, (butlast args))
404 (put 'mel-define-method 'lisp-indent-function 'defun)
406 (defmacro mel-define-method-function (spec function)
407 "Set SPEC's function definition to FUNCTION.
408 First element of SPEC is service.
409 Rest of ARGS is like an argument list of lambda, but (car (last ARGS))
410 must be specialized parameter. (car (car (last ARGS))) is name of
411 variable and (nth 1 (car (last ARGS))) is name of backend (encoding)."
412 (let* ((name (car spec))
414 (specializer (car (last args)))
415 (class (nth 1 specializer)))
417 (mel-define-service (, name))
418 (setq sym (intern (, class) (, (intern (format "%s-obarray" name)))))
420 (fset sym (symbol-function (, function))))))))
422 (defmacro mel-define-function (function spec)
423 (let* ((name (car spec))
425 (specializer (car (last args)))
426 (class (nth 1 specializer)))
428 (define-function (, function)
429 (intern (, class) (, (intern (format "%s-obarray" name)))))
432 (defvar base64-dl-module
433 (if (and (fboundp 'base64-encode-string)
434 (subrp (symbol-function 'base64-encode-string)))
436 (if (fboundp 'dynamic-link)
437 (let ((path (expand-file-name "base64.so" exec-directory)))
438 (and (file-exists-p path)
448 ;;; mime-def.el ends here