This commit was generated by cvs2svn to compensate for changes in r509,
[elisp/tm.git] / tm-def.el
1 ;;; tm-def.el --- definition module for tm
2
3 ;; Copyright (C) 1995,1996 Free Software Foundation, Inc.
4
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Version: $Id: tm-def.el,v 7.69 1997/01/21 06:13:15 shuhei-k Exp $
7 ;; Keywords: mail, news, MIME, multimedia, definition
8
9 ;; This file is part of tm (Tools for MIME).
10
11 ;; This program is free software; you can redistribute it and/or
12 ;; modify it under the terms of the GNU General Public License as
13 ;; published by the Free Software Foundation; either version 2, or (at
14 ;; your option) any later version.
15
16 ;; This program is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Code:
27
28 (require 'emu)
29
30
31 ;;; @ variables
32 ;;;
33
34 (defvar mime/tmp-dir (or (getenv "TM_TMP_DIR") "/tmp/"))
35
36 (defvar mime/use-multi-frame
37   (and (>= emacs-major-version 19) window-system))
38
39 (defvar mime/find-file-function
40   (if mime/use-multi-frame
41       (function find-file-other-frame)
42     (function find-file)
43     ))
44
45 (defvar mime/output-buffer-window-is-shared-with-bbdb t
46   "*If t, mime/output-buffer window is shared with BBDB window.")
47
48
49 ;;; @ constants
50 ;;;
51
52 (defconst mime/output-buffer-name "*MIME-out*")
53 (defconst mime/temp-buffer-name " *MIME-temp*")
54
55
56 ;;; @ charset and encoding
57 ;;;
58
59 (defvar mime-charset-type-list
60   '((us-ascii           7 nil)
61     (iso-8859-1         8 "quoted-printable")
62     (iso-8859-2         8 "quoted-printable")
63     (iso-8859-3         8 "quoted-printable")
64     (iso-8859-4         8 "quoted-printable")
65     (iso-8859-5         8 "quoted-printable")
66     (koi8-r             8 "quoted-printable")
67     (iso-8859-7         8 "quoted-printable")
68     (iso-8859-8         8 "quoted-printable")
69     (iso-8859-9         8 "quoted-printable")
70     (iso-2022-jp        7 "base64")
71     (iso-2022-kr        7 "base64")
72     (euc-kr             8 "base64")
73     (gb2312             8 "quoted-printable")
74     (big5               8 "base64")
75     (iso-2022-jp-2      7 "base64")
76     (iso-2022-int-1     7 "base64")
77     ))
78
79 (defun mime/encoding-name (transfer-level &optional not-omit)
80   (cond ((> transfer-level 8) "binary")
81         ((= transfer-level 8) "8bit")
82         (not-omit "7bit")
83         ))
84
85 (defun mime/make-charset-default-encoding-alist (transfer-level)
86   (mapcar (function
87            (lambda (charset-type)
88              (let ((charset  (upcase (symbol-name (car charset-type))))
89                    (type     (nth 1 charset-type))
90                    (encoding (nth 2 charset-type))
91                    )
92                (if (<= type transfer-level)
93                    (cons charset (mime/encoding-name type))
94                  (cons charset encoding)
95                  ))))
96           mime-charset-type-list))
97
98
99 ;;; @ button
100 ;;;
101
102 (defun tm:set-face-region (b e face)
103   (let ((overlay (tl:make-overlay b e)))
104     (tl:overlay-put overlay 'face face)
105     ))
106
107 (defvar tm:button-face 'bold
108   "Face used for content-button or URL-button of MIME-Preview buffer.
109 \[tm-def.el]")
110
111 (defvar tm:mouse-face 'highlight
112   "Face used for MIME-preview buffer mouse highlighting. [tm-def.el]")
113
114 (defvar tm:warning-face nil
115   "Face used for invalid encoded-word.")
116
117 (defun tm:add-button (from to func &optional data)
118   "Create a button between FROM and TO with callback FUNC and data DATA."
119   (and tm:button-face
120        (tl:overlay-put (tl:make-overlay from to) 'face tm:button-face))
121   (tl:add-text-properties from to
122                           (append (and tm:mouse-face
123                                        (list 'mouse-face tm:mouse-face))
124                                   (list 'tm-callback func)
125                                   (and data (list 'tm-data data))
126                                   ))
127   )
128
129 (defvar tm:mother-button-dispatcher nil)
130
131 (defun tm:button-dispatcher (event)
132   "Select the button under point."
133   (interactive "e")
134   (let (buf point func data)
135     (save-window-excursion
136       (mouse-set-point event)
137       (setq buf (current-buffer)
138             point (point)
139             func (get-text-property (point) 'tm-callback)
140             data (get-text-property (point) 'tm-data)
141             )
142       )
143     (save-excursion
144       (set-buffer buf)
145       (goto-char point)
146       (if func
147           (apply func data)
148         (if (fboundp tm:mother-button-dispatcher)
149             (funcall tm:mother-button-dispatcher event)
150           )
151         ))))
152
153
154 ;;; @ for URL
155 ;;;
156
157 (defvar tm:URL-regexp
158   "\\(http\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*[-a-zA-Z0-9_=#$@~`%&*+|\\/]")
159
160 (defvar browse-url-browser-function nil)
161
162 (defun tm:browse-url (&optional url)
163   (if (fboundp browse-url-browser-function)
164       (if url 
165         (funcall browse-url-browser-function url)
166       (call-interactively browse-url-browser-function))
167     (if (fboundp tm:mother-button-dispatcher)
168         (call-interactively tm:mother-button-dispatcher)
169       )
170     ))
171
172
173 ;;; @ definitions about MIME
174 ;;;
175
176 (defconst mime/tspecials "][\000-\040()<>@,\;:\\\"/?.=")
177 (defconst mime/token-regexp (concat "[^" mime/tspecials "]+"))
178 (defconst mime/charset-regexp mime/token-regexp)
179
180 (defconst mime/content-type-subtype-regexp
181   (concat mime/token-regexp "/" mime/token-regexp))
182
183 (defconst mime/disposition-type-regexp mime/token-regexp)
184
185
186 ;;; @@ Base64
187 ;;;
188
189 (defconst base64-token-regexp "[A-Za-z0-9+/]")
190 (defconst base64-token-padding-regexp "[A-Za-z0-9+/=]")
191
192 (defconst mime/B-encoded-text-regexp
193   (concat "\\(\\("
194           base64-token-regexp
195           base64-token-regexp
196           base64-token-regexp
197           base64-token-regexp
198           "\\)*"
199           base64-token-regexp
200           base64-token-regexp
201           base64-token-padding-regexp
202           base64-token-padding-regexp
203           "\\)"))
204
205 (defconst mime/B-encoding-and-encoded-text-regexp
206   (concat "\\(B\\)\\?" mime/B-encoded-text-regexp))
207
208
209 ;;; @@ Quoted-Printable
210 ;;;
211
212 (defconst quoted-printable-hex-chars "0123456789ABCDEF")
213 (defconst quoted-printable-octet-regexp
214   (concat "=[" quoted-printable-hex-chars
215           "][" quoted-printable-hex-chars "]"))
216
217 (defconst mime/Q-encoded-text-regexp
218   (concat "\\([^=?]\\|" quoted-printable-octet-regexp "\\)+"))
219 (defconst mime/Q-encoding-and-encoded-text-regexp
220   (concat "\\(Q\\)\\?" mime/Q-encoded-text-regexp))
221
222
223 ;;; @ rot13-47
224 ;;;
225 ;; caesar-region written by phr@prep.ai.mit.edu  Nov 86
226 ;; modified by tower@prep Nov 86
227 ;; gnus-caesar-region
228 ;; Modified by umerin@flab.flab.Fujitsu.JUNET for ROT47.
229 (defun tm:caesar-region (&optional n)
230   "Caesar rotation of region by N, default 13, for decrypting netnews.
231 ROT47 will be performed for Japanese text in any case."
232   (interactive (if current-prefix-arg   ; Was there a prefix arg?
233                    (list (prefix-numeric-value current-prefix-arg))
234                  (list nil)))
235   (cond ((not (numberp n)) (setq n 13))
236         (t (setq n (mod n 26))))        ;canonicalize N
237   (if (not (zerop n))           ; no action needed for a rot of 0
238       (progn
239         (if (or (not (boundp 'caesar-translate-table))
240                 (/= (aref caesar-translate-table ?a) (+ ?a n)))
241             (let ((i 0) (lower "abcdefghijklmnopqrstuvwxyz") upper)
242               (message "Building caesar-translate-table...")
243               (setq caesar-translate-table (make-vector 256 0))
244               (while (< i 256)
245                 (aset caesar-translate-table i i)
246                 (setq i (1+ i)))
247               (setq lower (concat lower lower) upper (upcase lower) i 0)
248               (while (< i 26)
249                 (aset caesar-translate-table (+ ?a i) (aref lower (+ i n)))
250                 (aset caesar-translate-table (+ ?A i) (aref upper (+ i n)))
251                 (setq i (1+ i)))
252               ;; ROT47 for Japanese text.
253               ;; Thanks to ichikawa@flab.fujitsu.junet.
254               (setq i 161)
255               (let ((t1 (logior ?O 128))
256                     (t2 (logior ?! 128))
257                     (t3 (logior ?~ 128)))
258                 (while (< i 256)
259                   (aset caesar-translate-table i
260                         (let ((v (aref caesar-translate-table i)))
261                           (if (<= v t1) (if (< v t2) v (+ v 47))
262                             (if (<= v t3) (- v 47) v))))
263                   (setq i (1+ i))))
264               (message "Building caesar-translate-table...done")))
265         (let ((from (region-beginning))
266               (to (region-end))
267               (i 0) str len)
268           (setq str (buffer-substring from to))
269           (setq len (length str))
270           (while (< i len)
271             (aset str i (aref caesar-translate-table (aref str i)))
272             (setq i (1+ i)))
273           (goto-char from)
274           (delete-region from to)
275           (insert str)))))
276
277
278 ;;; @ field
279 ;;;
280
281 (defun tm:set-fields (sym field-list &optional regexp-sym)
282   (or regexp-sym
283       (setq regexp-sym
284             (let ((name (symbol-name sym)))
285               (intern
286                (concat (if (string-match "\\(.*\\)-list" name)
287                            (substring name 0 (match-end 1))
288                          name)
289                        "-regexp")
290                )))
291       )
292   (set sym field-list)
293   (set regexp-sym
294        (concat "^" (apply (function regexp-or) field-list) ":"))
295   )
296
297 (defun tm:add-fields (sym field-list &optional regexp-sym)
298   (or regexp-sym
299       (setq regexp-sym
300             (let ((name (symbol-name sym)))
301               (intern
302                (concat (if (string-match "\\(.*\\)-list" name)
303                            (substring name 0 (match-end 1))
304                          name)
305                        "-regexp")
306                )))
307       )
308   (let ((fields (eval sym)))
309     (mapcar (function
310              (lambda (field)
311                (or (member field fields)
312                    (setq fields (cons field fields))
313                    )
314                ))
315             (reverse field-list)
316             )
317     (set regexp-sym
318          (concat "^" (apply (function regexp-or) fields) ":"))
319     (set sym fields)
320     ))
321
322 (defun tm:delete-fields (sym field-list &optional regexp-sym)
323   (or regexp-sym
324       (setq regexp-sym
325             (let ((name (symbol-name sym)))
326               (intern
327                (concat (if (string-match "\\(.*\\)-list" name)
328                            (substring name 0 (match-end 1))
329                          name)
330                        "-regexp")
331                )))
332       )
333   (let ((fields (eval sym)))
334     (mapcar (function
335              (lambda (field)
336                (setq fields (delete field fields))
337                ))
338             field-list)
339     (set regexp-sym
340          (concat "^" (apply (function regexp-or) fields) ":"))
341     (set sym fields)
342     ))
343
344
345 ;;; @ end
346 ;;;
347
348 (provide 'tm-def)
349
350 ;;; tm-def.el ends here