Require 'cl when it is compiled.
[elisp/flim.git] / mime-def.el
1 ;;; mime-def.el --- definition module about MIME
2
3 ;; Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
4
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Keywords: definition, MIME, multimedia, mail, news
7
8 ;; This file is part of FLIM (Faithful Library about Internet Message).
9
10 ;; This program is free software; you can redistribute it and/or
11 ;; modify it under the terms of the GNU General Public License as
12 ;; published by the Free Software Foundation; either version 2, or (at
13 ;; your option) any later version.
14
15 ;; This program is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 ;; General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Code:
26
27 (defconst mime-library-version-string "FLIM 1.4.1 - \"Momoyama-Gory\e.D\eNrmae\"")
28
29
30 ;;; @ variables
31 ;;;
32
33 (require 'custom)
34
35 (eval-when-compile (require 'cl))
36
37 (defgroup mime nil
38   "Emacs MIME Interfaces"
39   :group 'news
40   :group 'mail)
41
42 (custom-handle-keyword 'default-mime-charset :group 'mime
43                        'custom-variable)
44
45 (defcustom mime-temp-directory (or (getenv "MIME_TMP_DIR")
46                                    (getenv "TM_TMP_DIR")
47                                    (getenv "TMPDIR")
48                                    (getenv "TMP")
49                                    (getenv "TEMP")
50                                    "/tmp/")
51   "*Directory for temporary files."
52   :group 'mime
53   :type 'directory)
54
55
56 ;;; @ required functions
57 ;;;
58
59 (unless (fboundp 'butlast)
60   (defun butlast (x &optional n)
61     "Returns a copy of LIST with the last N elements removed."
62     (if (and n (<= n 0)) x
63       (nbutlast (copy-sequence x) n)))
64   
65   (defun nbutlast (x &optional n)
66     "Modifies LIST to remove the last N elements."
67     (let ((m (length x)))
68       (or n (setq n 1))
69       (and (< n m)
70            (progn
71              (if (> n 0) (setcdr (nthcdr (- (1- m) n) x) nil))
72              x))))
73   )
74
75 (defsubst eliminate-top-spaces (string)
76   "Eliminate top sequence of space or tab in STRING."
77   (if (string-match "^[ \t]+" string)
78       (substring string (match-end 0))
79     string))
80
81 (defsubst regexp-* (regexp)
82   (concat regexp "*"))
83
84 (defsubst regexp-or (&rest args)
85   (concat "\\(" (mapconcat (function identity) args "\\|") "\\)"))
86
87
88 ;;; @ about STD 11
89 ;;;
90
91 (defconst std11-quoted-pair-regexp "\\\\.")
92 (defconst std11-non-qtext-char-list '(?\" ?\\ ?\r ?\n))
93 (defconst std11-qtext-regexp
94   (concat "[^" (char-list-to-string std11-non-qtext-char-list) "]"))
95 (defconst std11-quoted-string-regexp
96   (concat "\""
97           (regexp-*
98            (regexp-or std11-qtext-regexp std11-quoted-pair-regexp))
99           "\""))
100
101
102 ;;; @ about MIME
103 ;;;
104
105 (defconst mime-tspecials "][()<>@,\;:\\\"/?=")
106 (defconst mime-token-regexp (concat "[^" mime-tspecials "\000-\040]+"))
107 (defconst mime-charset-regexp mime-token-regexp)
108
109 (defconst mime-media-type/subtype-regexp
110   (concat mime-token-regexp "/" mime-token-regexp))
111
112
113 ;;; @@ Quoted-Printable
114 ;;;
115
116 (defconst quoted-printable-hex-chars "0123456789ABCDEF")
117
118 (defconst quoted-printable-octet-regexp
119   (concat "=[" quoted-printable-hex-chars
120           "][" quoted-printable-hex-chars "]"))
121
122
123 ;;; @ MIME-entity
124 ;;;
125
126 (defsubst make-mime-entity (buffer
127                             header-start header-end body-start body-end
128                             &optional node-id
129                             content-type content-disposition
130                             encoding children)
131   (vector buffer header-start header-end body-start body-end
132           node-id content-type content-disposition encoding nil
133           children nil))
134
135 (defsubst mime-entity-buffer (entity)              (aref entity  0))
136 (defsubst mime-entity-header-start (entity)        (aref entity  1))
137 (defsubst mime-entity-header-end (entity)          (aref entity  2))
138 (defsubst mime-entity-body-start (entity)          (aref entity  3))
139 (defsubst mime-entity-body-end (entity)            (aref entity  4))
140 (defsubst mime-entity-node-id (entity)             (aref entity  5))
141 (defsubst mime-entity-content-type (entity)        (aref entity  6))
142 (defsubst mime-entity-content-disposition (entity) (aref entity  7))
143 (defsubst mime-entity-encoding (entity)            (aref entity  8))
144 (defsubst mime-entity-original-header (entity)     (aref entity  9))
145 (defsubst mime-entity-children (entity)            (aref entity 10))
146 (defsubst mime-entity-parsed-header (entity)       (aref entity 11))
147
148 (defsubst mime-entity-set-original-header (entity header)
149   (aset entity 9 header))
150 (defsubst mime-entity-set-parsed-header (entity header)
151   (aset entity 11 header))
152
153 (defsubst mime-entity-number (entity)
154   (reverse (mime-entity-node-id entity)))
155
156
157 ;;; @ utility
158 ;;;
159
160 (defsubst mime-type/subtype-string (type &optional subtype)
161   "Return type/subtype string from TYPE and SUBTYPE."
162   (if type
163       (if subtype
164           (format "%s/%s" type subtype)
165         (format "%s" type))))
166
167
168 ;;; @ end
169 ;;;
170
171 (provide 'mime-def)
172
173 ;;; mime-def.el ends here