d074951c3b76481682a32ec351ded25289a54fc5
[elisp/tm.git] / tm-def.el
1 ;;;
2 ;;; tm-def.el --- definition module for tm
3 ;;;
4 ;;; Copyright (C) 1995 Free Software Foundation, Inc.
5 ;;; Copyright (C) 1995,1996 MORIOKA Tomohiko
6 ;;;
7 ;;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
8 ;;; Version:
9 ;;;     $Id: tm-def.el,v 7.47 1996/07/04 16:57:03 morioka Exp $
10 ;;; Keywords: mail, news, MIME, multimedia, definition
11 ;;;
12 ;;; This file is part of tm (Tools for MIME).
13 ;;;
14 ;;; This program is free software; you can redistribute it and/or
15 ;;; modify it under the terms of the GNU General Public License as
16 ;;; published by the Free Software Foundation; either version 2, or
17 ;;; (at your option) any later version.
18 ;;;
19 ;;; This program is distributed in the hope that it will be useful,
20 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22 ;;; General Public License for more details.
23 ;;;
24 ;;; You should have received a copy of the GNU General Public License
25 ;;; along with This program.  If not, write to the Free Software
26 ;;; Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 ;;;
28 ;;; Code:
29
30 (require 'emu)
31 (require 'tl-822)
32
33
34 ;;; @ variables
35 ;;;
36
37 (defvar mime/tmp-dir (or (getenv "TM_TMP_DIR") "/tmp/"))
38
39 (defvar mime/use-multi-frame
40   (and (>= emacs-major-version 19) window-system))
41
42 (defvar mime/find-file-function
43   (if mime/use-multi-frame
44       (function find-file-other-frame)
45     (function find-file)
46     ))
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 ;;; @ leading-character and charset
57 ;;;
58
59 (defvar mime/lc-charset-alist
60   (foldr (function
61           (lambda (a cell)
62             (or (catch 'tag
63                   (cons (cons (foldr (function
64                                       (lambda (a sym)
65                                         (if (boundp sym)
66                                             (cons (symbol-value sym) a)
67                                           (throw 'tag nil)
68                                           )))
69                                      nil
70                                      (car cell))
71                               (cdr cell))
72                         a))
73                 a)
74             ))
75          nil
76          '(((charset-ascii)   . "US-ASCII")
77            ((charset-ascii
78              charset-latin-1) . "ISO-8859-1")
79            ((charset-ascii
80              charset-latin-2) . "ISO-8859-2")
81            ((charset-ascii
82              charset-latin-3) . "ISO-8859-3")
83            ((charset-ascii
84              charset-latin-4) . "ISO-8859-4")
85 ;;;        ((charset-ascii
86 ;;;          charset-cyrillic) . "ISO-8859-5")
87            ((charset-ascii
88              charset-cyrillic) . "KOI8-R")
89            ((charset-ascii
90              charset-arabic)   . "ISO-8859-6")
91            ((charset-ascii
92              charset-greek)    . "ISO-8859-7")
93            ((charset-ascii
94              charset-hebrew)   . "ISO-8859-8")
95            ((charset-ascii
96              charset-latin-5)  . "ISO-8859-9")
97            ((charset-ascii
98              charset-jisx0208) . "ISO-2022-JP")
99            ((charset-ascii
100              charset-ksc5601)  . "EUC-KR")
101            ((charset-ascii
102              charset-big5-1
103              charset-big5-2)   . "BIG5")
104            ((charset-ascii
105              charset-gb2312
106              charset-jisx0208
107              charset-ksc5601
108              charset-jisx0212
109              charset-latin-1
110              charset-greek)    . "ISO-2022-JP-2")
111            ((charset-ascii
112              charset-gb2312
113              charset-jisx0208
114              charset-ksc5601
115              charset-jisx0212
116              charset-cns11643-1
117              charset-cns11643-2
118              charset-latin-1
119              charset-greek)    . "ISO-2022-INT-1")
120            )))
121
122 (defvar mime/unknown-charset "ISO-2022-INT-1")
123
124
125 ;;; @ charset and encoding
126 ;;;
127
128 (defun mime/find-charset (lcl)
129   (if lcl
130       (or (cdr (some-element
131                 (function
132                  (lambda (elt)
133                    (subsetp lcl (car elt))
134                    ))
135                 mime/lc-charset-alist)
136                )
137           mime/unknown-charset)
138     ))
139
140 (defun mime/find-charset-region (beg end)
141   (mime/find-charset (cons charset-ascii (find-charset-region beg end)))
142   )
143
144 (defvar mime/charset-type-list
145   '(("US-ASCII"       7 nil)
146     ("ISO-8859-1"     8 "quoted-printable")
147     ("ISO-8859-2"     8 "quoted-printable")
148     ("ISO-8859-3"     8 "quoted-printable")
149     ("ISO-8859-4"     8 "quoted-printable")
150     ("ISO-8859-5"     8 "quoted-printable")
151     ("KOI8-R"         8 "quoted-printable")
152     ("ISO-8859-7"     8 "quoted-printable")
153     ("ISO-8859-8"     8 "quoted-printable")
154     ("ISO-8859-9"     8 "quoted-printable")
155     ("ISO-2022-JP"    7 "base64")
156     ("ISO-2022-KR"    7 "base64")
157     ("EUC-KR"         8 "base64")
158     ("BIG5"           8 "base64")
159     ("ISO-2022-JP-2"  7 "base64")
160     ("ISO-2022-INT-1" 7 "base64")
161     ))
162
163 (defun mime/encoding-name (transfer-level &optional not-omit)
164   (cond ((> transfer-level 8) "binary")
165         ((= transfer-level 8) "8bit")
166         (not-omit "7bit")
167         ))
168
169 (defun mime/make-charset-default-encoding-alist (transfer-level)
170   (mapcar (function
171            (lambda (charset-type)
172              (let ((charset  (car charset-type))
173                    (type     (nth 1 charset-type))
174                    (encoding (nth 2 charset-type))
175                    )
176                (if (<= type transfer-level)
177                    (cons charset (mime/encoding-name type))
178                  (cons charset encoding)
179                  ))))
180           mime/charset-type-list))
181
182
183 ;;; @ coding-system
184 ;;;
185
186 (defvar mime/charset-coding-system-alist
187   (let* (csl
188          (f (if (and running-xemacs-20 (featurep 'mule))
189                 (progn
190                   (setq csl (coding-system-list))
191                   (function
192                    (lambda (a cell)
193                      (if (memq (cdr cell) csl)
194                          (cons cell a)
195                        a))))
196               (function
197                (lambda (a cell)
198                  (let ((sym (symbol-concat "*" (cdr cell) "*")))
199                    (if (boundp sym)
200                        (cons (cons (car cell) (symbol-value sym)) a)
201                      a))))
202               )))
203     (foldr f nil
204            '(("ISO-2022-JP"     . junet)
205              ("ISO-2022-KR"     . iso-2022-kr)
206              ("EUC-KR"          . euc-kr)
207              ("GB2312"          . euc-china)
208              ("ISO-8859-1"      . ctext)
209              ("ISO-8859-2"      . iso-8859-2)
210              ("ISO-8859-3"      . iso-8859-3)
211              ("ISO-8859-4"      . iso-8859-4)
212              ("ISO-8859-5"      . iso-8859-5)
213              ("KOI8-R"          . koi8)
214              ("ISO-8859-7"      . iso-8859-7)
215              ("ISO-8859-8"      . iso-8859-8)
216              ("ISO-8859-9"      . iso-8859-9)
217              ("ISO-2022-JP-2"   . iso-2022-ss2-7)
218              ("X-ISO-2022-JP-2" . iso-2022-ss2-7)
219              ("ISO-2022-INT-1"  . iso-2022-int-1)
220              ("SHIFT_JIS"       . sjis)
221              ("X-SHIFTJIS"      . sjis)
222              ("BIG5"            . big5)
223              ))))
224
225 (defvar mime/default-coding-system *ctext*)
226
227 (defun mime-charset-encode-string (str charset)
228   (let ((cs (assoc charset mime/charset-coding-system-alist)))
229     (if cs
230         (character-encode-string str (cdr cs))
231       )))
232
233 (defun mime-charset-decode-string (str charset)
234   (let ((cs (assoc charset mime/charset-coding-system-alist)))
235     (if cs
236         (character-decode-string str (cdr cs))
237       )))
238
239 (defun mime-charset-encode-region (beg end charset &optional encoding)
240   (let ((ct
241          (if (stringp charset)
242              (cdr (assoc (upcase charset) mime/charset-coding-system-alist))
243            mime/default-coding-system)))
244     (if ct
245         (character-encode-region beg end ct)
246       )))
247
248 (defun mime-charset-decode-region (beg end charset &optional encoding)
249   (let ((ct
250          (if (stringp charset)
251              (cdr (assoc (upcase charset) mime/charset-coding-system-alist))
252            mime/default-coding-system)))
253     (if ct
254         (character-decode-region beg end ct)
255       )))
256
257
258 ;;; @ button
259 ;;;
260
261 (defun tm:set-face-region (b e face)
262   (let ((overlay (tl:make-overlay b e)))
263     (tl:overlay-put overlay 'face face)
264     ))
265
266 (setq tm:button-face 'bold)
267 (setq tm:mouse-face 'highlight)
268
269 (defun tm:add-button (from to func &optional data)
270   "Create a button between FROM and TO with callback FUNC and data DATA."
271   (and tm:button-face
272        (tl:overlay-put (tl:make-overlay from to) 'face tm:button-face))
273   (tl:add-text-properties from to
274                           (append (and tm:mouse-face
275                                        (list 'mouse-face tm:mouse-face))
276                                   (list 'tm-callback func)
277                                   (and data (list 'tm-data data))
278                                   ))
279   )
280
281 (defvar tm:mother-button-dispatcher nil)
282
283 (defun tm:button-dispatcher (event)
284   "Select the button under point."
285   (interactive "e")
286   (save-window-excursion
287     (mouse-set-point event)
288     (let ((func (get-text-property (point) 'tm-callback))
289           (data (get-text-property (point) 'tm-data))
290           )
291       (if func
292           (apply func data)
293         (if (fboundp tm:mother-button-dispatcher)
294             (funcall tm:mother-button-dispatcher event)
295           )
296         ))))
297
298
299 ;;; @ for URL
300 ;;;
301
302 (defvar tm:URL-regexp
303   "\\(http\\|ftp\\|file\\|gopher\\|news\\|telnet\\|wais\\|mailto\\):\\(//[-a-zA-Z0-9_.]+:[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*[-a-zA-Z0-9_=#$@~`%&*+|\\/]")
304
305 (defvar browse-url-browser-function nil)
306
307 (defun tm:browse-url (&optional url)
308   (if (fboundp browse-url-browser-function)
309       (if url 
310         (funcall browse-url-browser-function url)
311       (call-interactively browse-url-browser-function))
312     (if (fboundp tm:mother-button-dispatcher)
313         (call-interactively tm:mother-button-dispatcher)
314       )
315     ))
316
317
318 ;;; @ definitions about MIME
319 ;;;
320
321 (defconst mime/tspecials "][\000-\040()<>@,\;:\\\"/?.=")
322 (defconst mime/token-regexp (concat "[^" mime/tspecials "]+"))
323 (defconst mime/charset-regexp mime/token-regexp)
324
325 (defconst mime/content-type-subtype-regexp
326   (concat mime/token-regexp "/" mime/token-regexp))
327 (defconst mime/content-parameter-value-regexp
328   (concat "\\("
329           rfc822/quoted-string-regexp
330           "\\|[^; \t\n]*\\)"))
331
332 (defconst mime/disposition-type-regexp mime/token-regexp)
333
334
335 ;;; @@ Base64
336 ;;;
337
338 (defconst base64-token-regexp "[A-Za-z0-9+/=]")
339
340 (defconst mime/B-encoded-text-regexp
341   (concat "\\("
342           base64-token-regexp
343           base64-token-regexp
344           base64-token-regexp
345           base64-token-regexp
346           "\\)+"))
347 (defconst mime/B-encoding-and-encoded-text-regexp
348   (concat "\\(B\\)\\?" mime/B-encoded-text-regexp))
349
350
351 ;;; @@ Quoted-Printable
352 ;;;
353
354 (defconst quoted-printable-hex-chars "0123456789ABCDEF")
355 (defconst quoted-printable-octet-regexp
356   (concat "=[" quoted-printable-hex-chars
357           "][" quoted-printable-hex-chars "]"))
358
359 (defconst mime/Q-encoded-text-regexp
360   (concat "\\([^=?]\\|" quoted-printable-octet-regexp "\\)+"))
361 (defconst mime/Q-encoding-and-encoded-text-regexp
362   (concat "\\(Q\\)\\?" mime/Q-encoded-text-regexp))
363
364
365 ;;; @ rot13-47
366 ;;;
367 ;; caesar-region written by phr@prep.ai.mit.edu  Nov 86
368 ;; modified by tower@prep Nov 86
369 ;; gnus-caesar-region
370 ;; Modified by umerin@flab.flab.Fujitsu.JUNET for ROT47.
371 (defun tm:caesar-region (&optional n)
372   "Caesar rotation of region by N, default 13, for decrypting netnews.
373 ROT47 will be performed for Japanese text in any case."
374   (interactive (if current-prefix-arg   ; Was there a prefix arg?
375                    (list (prefix-numeric-value current-prefix-arg))
376                  (list nil)))
377   (cond ((not (numberp n)) (setq n 13))
378         (t (setq n (mod n 26))))        ;canonicalize N
379   (if (not (zerop n))           ; no action needed for a rot of 0
380       (progn
381         (if (or (not (boundp 'caesar-translate-table))
382                 (/= (aref caesar-translate-table ?a) (+ ?a n)))
383             (let ((i 0) (lower "abcdefghijklmnopqrstuvwxyz") upper)
384               (message "Building caesar-translate-table...")
385               (setq caesar-translate-table (make-vector 256 0))
386               (while (< i 256)
387                 (aset caesar-translate-table i i)
388                 (setq i (1+ i)))
389               (setq lower (concat lower lower) upper (upcase lower) i 0)
390               (while (< i 26)
391                 (aset caesar-translate-table (+ ?a i) (aref lower (+ i n)))
392                 (aset caesar-translate-table (+ ?A i) (aref upper (+ i n)))
393                 (setq i (1+ i)))
394               ;; ROT47 for Japanese text.
395               ;; Thanks to ichikawa@flab.fujitsu.junet.
396               (setq i 161)
397               (let ((t1 (logior ?O 128))
398                     (t2 (logior ?! 128))
399                     (t3 (logior ?~ 128)))
400                 (while (< i 256)
401                   (aset caesar-translate-table i
402                         (let ((v (aref caesar-translate-table i)))
403                           (if (<= v t1) (if (< v t2) v (+ v 47))
404                             (if (<= v t3) (- v 47) v))))
405                   (setq i (1+ i))))
406               (message "Building caesar-translate-table...done")))
407         (let ((from (region-beginning))
408               (to (region-end))
409               (i 0) str len)
410           (setq str (buffer-substring from to))
411           (setq len (length str))
412           (while (< i len)
413             (aset str i (aref caesar-translate-table (aref str i)))
414             (setq i (1+ i)))
415           (goto-char from)
416           (delete-region from to)
417           (insert str)))))
418
419
420 ;;; @ field
421 ;;;
422
423 (defun tm:set-fields (sym field-list &optional regexp-sym)
424   (or regexp-sym
425       (setq regexp-sym
426             (let ((name (symbol-name sym)))
427               (intern
428                (concat (if (string-match "\\(.*\\)-list" name)
429                            (substring name 0 (match-end 1))
430                          name)
431                        "-regexp")
432                )))
433       )
434   (set sym field-list)
435   (set regexp-sym
436        (concat "^" (apply (function regexp-or) field-list) ":"))
437   )
438
439 (defun tm:add-fields (sym field-list &optional regexp-sym)
440   (or regexp-sym
441       (setq regexp-sym
442             (let ((name (symbol-name sym)))
443               (intern
444                (concat (if (string-match "\\(.*\\)-list" name)
445                            (substring name 0 (match-end 1))
446                          name)
447                        "-regexp")
448                )))
449       )
450   (let ((fields (eval sym)))
451     (mapcar (function
452              (lambda (field)
453                (or (member field fields)
454                    (setq fields (cons field fields))
455                    )
456                ))
457             (reverse field-list)
458             )
459     (set regexp-sym
460          (concat "^" (apply (function regexp-or) fields) ":"))
461     (set sym fields)
462     ))
463
464 (defun tm:delete-fields (sym field-list &optional regexp-sym)
465   (or regexp-sym
466       (setq regexp-sym
467             (let ((name (symbol-name sym)))
468               (intern
469                (concat (if (string-match "\\(.*\\)-list" name)
470                            (substring name 0 (match-end 1))
471                          name)
472                        "-regexp")
473                )))
474       )
475   (let ((fields (eval sym)))
476     (mapcar (function
477              (lambda (field)
478                (setq fields (delete field fields))
479                ))
480             field-list)
481     (set regexp-sym
482          (concat "^" (apply (function regexp-or) fields) ":"))
483     (set sym fields)
484     ))
485
486
487 ;;; @ end
488 ;;;
489
490 (provide 'tm-def)
491
492 ;;; tm-def.el ends here