* gnus-vers.el (gnus-revision-number): Increment to 01.
[elisp/gnus.git-] / lisp / mm-util.el
1 ;;; mm-util.el --- Utility functions for Mule and low level things
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; This file is part of GNU Emacs.
7
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
12
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 ;; GNU General Public License for more details.
17
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 (eval-when-compile (require 'cl))
28 (eval-when-compile (require 'gnus-clfns))
29 (eval-when-compile (require 'static))
30
31 (require 'mail-prsvr)
32
33 (eval-and-compile
34   (mapcar
35    (lambda (elem)
36      (let ((nfunc (intern (format "mm-%s" (car elem)))))
37        (if (fboundp (car elem))
38            (defalias nfunc (car elem))
39          (defalias nfunc (cdr elem)))))
40    '((decode-coding-string . (lambda (s a) s))
41      (encode-coding-string . (lambda (s a) s))
42      (encode-coding-region . ignore)
43      (coding-system-list . ignore)
44      (decode-coding-region . ignore)
45      (char-int . identity)
46      (device-type . ignore)
47      (coding-system-equal . equal)
48      (annotationp . ignore)
49      (set-buffer-file-coding-system . ignore)
50      (make-char
51       . (lambda (charset int)
52           (int-to-char int)))
53      (read-charset
54       . (lambda (prompt)
55           "Return a charset."
56           (intern
57            (completing-read
58             prompt
59             (mapcar (lambda (e) (list (symbol-name (car e))))
60                     mm-mime-mule-charset-alist)
61             nil t))))
62      (subst-char-in-string
63       . (lambda (from to string) ;; stolen (and renamed) from nnheader.el
64           "Replace characters in STRING from FROM to TO."
65           (let ((string (substring string 0)) ;Copy string.
66                 (len (length string))
67                 (idx 0))
68             ;; Replace all occurrences of FROM with TO.
69             (while (< idx len)
70               (when (= (aref string idx) from)
71                 (aset string idx to))
72               (setq idx (1+ idx)))
73             string)))
74      (string-as-unibyte . identity)
75      (string-as-multibyte . identity)
76      (multibyte-string-p . ignore))))
77
78 (eval-and-compile
79   (defalias 'mm-char-or-char-int-p
80     (cond
81      ((fboundp 'char-or-char-int-p) 'char-or-char-int-p)
82      ((fboundp 'char-valid-p) 'char-valid-p)
83      (t 'identity))))
84
85 (eval-and-compile
86   (defalias 'mm-read-coding-system
87     (cond
88      ((fboundp 'read-coding-system)
89       (if (and (featurep 'xemacs)
90                (<= (string-to-number emacs-version) 21.1))
91           (lambda (prompt &optional default-coding-system)
92             (read-coding-system prompt))
93         'read-coding-system))
94      (t (lambda (prompt &optional default-coding-system)
95           "Prompt the user for a coding system."
96           (completing-read
97            prompt (mapcar (lambda (s) (list (symbol-name (car s))))
98                           mm-mime-mule-charset-alist)))))))
99
100 (defvar mm-coding-system-list nil)
101 (defun mm-get-coding-system-list ()
102   "Get the coding system list."
103   (or mm-coding-system-list
104       (setq mm-coding-system-list (mm-coding-system-list))))
105
106 (defun mm-coding-system-p (sym)
107   "Return non-nil if SYM is a coding system."
108   (or (and (fboundp 'coding-system-p) (coding-system-p sym))
109       (memq sym (mm-get-coding-system-list))))
110
111 (defvar mm-charset-synonym-alist
112   `(
113     ;; Perfectly fine?  A valid MIME name, anyhow.
114     ,@(unless (mm-coding-system-p 'big5)
115        '((big5 . cn-big5)))
116     ;; Not in XEmacs, but it's not a proper MIME charset anyhow.
117     ,@(unless (mm-coding-system-p 'x-ctext)
118        '((x-ctext . ctext)))
119     ;; Apparently not defined in Emacs 20, but is a valid MIME name.
120     ,@(unless (mm-coding-system-p 'gb2312)
121        '((gb2312 . cn-gb-2312)))
122     ;; ISO-8859-15 is very similar to ISO-8859-1.
123     ,@(unless (mm-coding-system-p 'iso-8859-15) ; Emacs 21 defines it.
124        '((iso-8859-15 . iso-8859-1)))
125     ;; Windows-1252 is actually a superset of Latin-1.  See also
126     ;; `gnus-article-dumbquotes-map'.
127     ,@(unless (mm-coding-system-p 'windows-1252)
128        (if (mm-coding-system-p 'cp1252)
129            '((windows-1252 . cp1252))
130          '((windows-1252 . iso-8859-1))))
131     ;; Windows-1250 is a variant of Latin-2 heavily used by Microsoft
132     ;; Outlook users in Czech republic. Use this to allow reading of their
133     ;; e-mails. cp1250 should be defined by M-x codepage-setup.
134     ,@(if (and (not (mm-coding-system-p 'windows-1250))
135                (mm-coding-system-p 'cp1250))
136           '((windows-1250 . cp1250)))
137     )
138   "A mapping from invalid charset names to the real charset names.")
139
140 (defvar mm-binary-coding-system
141   (cond
142    ((mm-coding-system-p 'binary) 'binary)
143    ((mm-coding-system-p 'no-conversion) 'no-conversion)
144    (t nil))
145   "100% binary coding system.")
146
147 (defvar mm-text-coding-system
148   (or (if (memq system-type '(windows-nt ms-dos ms-windows))
149           (and (mm-coding-system-p 'raw-text-dos) 'raw-text-dos)
150         (and (mm-coding-system-p 'raw-text) 'raw-text))
151       mm-binary-coding-system)
152   "Text-safe coding system (For removing ^M).")
153
154 (defvar mm-text-coding-system-for-write nil
155   "Text coding system for write.")
156
157 (defvar mm-auto-save-coding-system
158   (cond
159    ((mm-coding-system-p 'emacs-mule)
160     (if (memq system-type '(windows-nt ms-dos ms-windows))
161         (if (mm-coding-system-p 'emacs-mule-dos)
162             'emacs-mule-dos mm-binary-coding-system)
163       'emacs-mule))
164    ((mm-coding-system-p 'escape-quoted) 'escape-quoted)
165    (t mm-binary-coding-system))
166   "Coding system of auto save file.")
167
168 (defvar mm-universal-coding-system mm-auto-save-coding-system
169   "The universal coding system.")
170
171 ;; Fixme: some of the cars here aren't valid MIME charsets.  That
172 ;; should only matter with XEmacs, though.
173 (defvar mm-mime-mule-charset-alist
174   `((us-ascii ascii)
175     (iso-8859-1 latin-iso8859-1)
176     (iso-8859-2 latin-iso8859-2)
177     (iso-8859-3 latin-iso8859-3)
178     (iso-8859-4 latin-iso8859-4)
179     (iso-8859-5 cyrillic-iso8859-5)
180     ;; Non-mule (X)Emacs uses the last mule-charset for 8bit characters.
181     ;; The fake mule-charset, gnus-koi8-r, tells Gnus that the default
182     ;; charset is koi8-r, not iso-8859-5.
183     (koi8-r cyrillic-iso8859-5 gnus-koi8-r)
184     (iso-8859-6 arabic-iso8859-6)
185     (iso-8859-7 greek-iso8859-7)
186     (iso-8859-8 hebrew-iso8859-8)
187     (iso-8859-9 latin-iso8859-9)
188     (iso-8859-14 latin-iso8859-14)
189     (iso-8859-15 latin-iso8859-15)
190     (viscii vietnamese-viscii-lower)
191     (iso-2022-jp latin-jisx0201 japanese-jisx0208 japanese-jisx0208-1978)
192     (euc-kr korean-ksc5601)
193     (gb2312 chinese-gb2312)
194     (big5 chinese-big5-1 chinese-big5-2)
195     (tibetan tibetan)
196     (thai-tis620 thai-tis620)
197     (iso-2022-7bit ethiopic arabic-1-column arabic-2-column)
198     (iso-2022-jp-2 latin-iso8859-1 greek-iso8859-7
199                    latin-jisx0201 japanese-jisx0208-1978
200                    chinese-gb2312 japanese-jisx0208
201                    korean-ksc5601 japanese-jisx0212
202                    katakana-jisx0201)
203     (iso-2022-int-1 latin-iso8859-1 greek-iso8859-7
204                     latin-jisx0201 japanese-jisx0208-1978
205                     chinese-gb2312 japanese-jisx0208
206                     korean-ksc5601 japanese-jisx0212
207                     chinese-cns11643-1 chinese-cns11643-2)
208     (iso-2022-int-1 latin-iso8859-1 latin-iso8859-2
209                     cyrillic-iso8859-5 greek-iso8859-7
210                     latin-jisx0201 japanese-jisx0208-1978
211                     chinese-gb2312 japanese-jisx0208
212                     korean-ksc5601 japanese-jisx0212
213                     chinese-cns11643-1 chinese-cns11643-2
214                     chinese-cns11643-3 chinese-cns11643-4
215                     chinese-cns11643-5 chinese-cns11643-6
216                     chinese-cns11643-7)
217     ,(if (or (not (fboundp 'charsetp)) ;; non-Mule case
218              (charsetp 'unicode-a)
219              (not (mm-coding-system-p 'mule-utf-8)))
220          '(utf-8 unicode-a unicode-b unicode-c unicode-d unicode-e)
221        ;; If we have utf-8 we're in Mule 5+.
222        (append '(utf-8)
223                (delete 'ascii
224                        (coding-system-get 'mule-utf-8 'safe-charsets)))))
225   "Alist of MIME-charset/MULE-charsets.")
226
227 ;; Correct by construction, but should be unnecessary:
228 ;; XEmacs hates it.
229 (when (and (not (featurep 'xemacs))
230            (fboundp 'coding-system-list)
231            (fboundp 'sort-coding-systems))
232   (setq mm-mime-mule-charset-alist
233         (apply
234          'nconc
235          (mapcar
236           (lambda (cs)
237             (when (and (coding-system-get cs 'mime-charset)
238                        (not (eq t (coding-system-get cs 'safe-charsets))))
239               (list (cons (coding-system-get cs 'mime-charset)
240                           (delq 'ascii
241                                 (coding-system-get cs 'safe-charsets))))))
242           (sort-coding-systems (coding-system-list 'base-only))))))
243
244 (defvar mm-hack-charsets '(iso-8859-15 iso-2022-jp-2)
245   "A list of special charsets.
246 Valid elements include:
247 `iso-8859-15'    convert ISO-8859-1, -9 to ISO-8859-15 if ISO-8859-15 exists.
248 `iso-2022-jp-2'  convert ISO-2022-jp to ISO-2022-jp-2 if ISO-2022-jp-2 exists."
249 )
250
251 (defvar mm-iso-8859-15-compatible
252   '((iso-8859-1 "\xA4\xA6\xA8\xB4\xB8\xBC\xBD\xBE")
253     (iso-8859-9 "\xA4\xA6\xA8\xB4\xB8\xBC\xBD\xBE\xD0\xDD\xDE\xF0\xFD\xFE"))
254   "ISO-8859-15 exchangeable coding systems and inconvertible characters.")
255
256 (defvar mm-iso-8859-x-to-15-table
257   (and (fboundp 'coding-system-p)
258        (mm-coding-system-p 'iso-8859-15)
259        (mapcar
260         (lambda (cs)
261           (if (mm-coding-system-p (car cs))
262               (let ((c (string-to-char
263                         (decode-coding-string "\341" (car cs)))))
264                 (cons (char-charset c)
265                       (cons
266                        (- (string-to-char
267                            (decode-coding-string "\341" 'iso-8859-15)) c)
268                        (string-to-list (decode-coding-string (car (cdr cs))
269                                                              (car cs))))))
270             '(gnus-charset 0)))
271         mm-iso-8859-15-compatible))
272   "A table of the difference character between ISO-8859-X and ISO-8859-15.")
273
274 (defcustom mm-coding-system-priorities nil
275   "Preferred coding systems for encoding outgoing mails.
276
277 More than one suitable coding systems may be found for some texts.  By
278 default, a coding system with the highest priority is used to encode
279 outgoing mails (see `sort-coding-systems').  If this variable is set,
280 it overrides the default priority.  For example, Japanese users may
281 prefer iso-2022-jp to japanese-shift-jis:
282
283 \(setq mm-coding-system-priorities
284   '(iso-2022-jp iso-2022-jp-2 japanese-shift-jis iso-latin-1 utf-8))
285 "
286   :type '(repeat (coding-system :tag "Coding system"))
287   :group 'mime)
288
289 (defvar mm-use-find-coding-systems-region
290   (fboundp 'find-coding-systems-region)
291   "Use `find-coding-systems-region' to find proper coding systems.
292
293 Setting it to nil is useful on Emacsen supporting Unicode if sending
294 mail with multiple parts is preferred to sending a Unicode one.")
295
296 ;;; Internal variables:
297
298 ;;; Functions:
299
300 (defun mm-mule-charset-to-mime-charset (charset)
301   "Return the MIME charset corresponding to the given Mule CHARSET."
302   (if (fboundp 'find-coding-systems-for-charsets)
303       (let (mime)
304         (dolist (cs (find-coding-systems-for-charsets (list charset)))
305           (unless mime
306             (when cs
307               (setq mime (coding-system-get cs 'mime-charset)))))
308         mime)
309     (let ((alist mm-mime-mule-charset-alist)
310           out)
311       (while alist
312         (when (memq charset (cdar alist))
313           (setq out (caar alist)
314                 alist nil))
315         (pop alist))
316       out)))
317
318 (defun mm-charset-to-coding-system (charset &optional lbt)
319   "Return coding-system corresponding to CHARSET.
320 CHARSET is a symbol naming a MIME charset.
321 If optional argument LBT (`unix', `dos' or `mac') is specified, it is
322 used as the line break code type of the coding system."
323   (when (stringp charset)
324     (setq charset (intern (downcase charset))))
325   (when lbt
326     (setq charset (intern (format "%s-%s" charset lbt))))
327   (cond
328    ((null charset)
329     charset)
330    ;; Running in a non-MULE environment.
331    ((null (mm-get-coding-system-list))
332     charset)
333    ;; ascii
334    ((eq charset 'us-ascii)
335     'ascii)
336    ;; Check to see whether we can handle this charset.  (This depends
337    ;; on there being some coding system matching each `mime-charset'
338    ;; property defined, as there should be.)
339    ((and (mm-coding-system-p charset)
340 ;;; Doing this would potentially weed out incorrect charsets.
341 ;;;      charset
342 ;;;      (eq charset (coding-system-get charset 'mime-charset))
343          )
344     charset)
345    ;; Translate invalid charsets.
346    ((let ((cs (cdr (assq charset mm-charset-synonym-alist))))
347       (and cs (mm-coding-system-p cs) cs)))
348    ;; Last resort: search the coding system list for entries which
349    ;; have the right mime-charset in case the canonical name isn't
350    ;; defined (though it should be).
351    ((let (cs)
352       ;; mm-get-coding-system-list returns a list of cs without lbt.
353       ;; Do we need -lbt?
354       (dolist (c (mm-get-coding-system-list))
355         (if (and (null cs)
356                  (eq charset (coding-system-get c 'mime-charset)))
357             (setq cs c)))
358       cs))))
359
360 (defsubst mm-replace-chars-in-string (string from to)
361   (mm-subst-char-in-string from to string))
362
363 (eval-and-compile
364   (defvar mm-emacs-mule (and (not (featurep 'xemacs))
365                              (boundp 'default-enable-multibyte-characters)
366                              default-enable-multibyte-characters
367                              (fboundp 'set-buffer-multibyte))
368     "Emacs mule.")
369
370   (defvar mm-mule4-p (and mm-emacs-mule
371                           (fboundp 'charsetp)
372                           (not (charsetp 'eight-bit-control)))
373     "Mule version 4.")
374
375   (if mm-emacs-mule
376       (defun mm-enable-multibyte ()
377         "Set the multibyte flag of the current buffer.
378 Only do this if the default value of `enable-multibyte-characters' is
379 non-nil.  This is a no-op in XEmacs."
380         (set-buffer-multibyte t))
381     (defalias 'mm-enable-multibyte 'ignore))
382
383   (if mm-emacs-mule
384       (defun mm-disable-multibyte ()
385         "Unset the multibyte flag of in the current buffer.
386 This is a no-op in XEmacs."
387         (set-buffer-multibyte nil))
388     (defalias 'mm-disable-multibyte 'ignore))
389
390   (if mm-mule4-p
391       (defun mm-enable-multibyte-mule4  ()
392         "Enable multibyte in the current buffer.
393 Only used in Emacs Mule 4."
394         (set-buffer-multibyte t))
395     (defalias 'mm-enable-multibyte-mule4 'ignore))
396
397   (if mm-mule4-p
398       (defun mm-disable-multibyte-mule4 ()
399         "Disable multibyte in the current buffer.
400 Only used in Emacs Mule 4."
401         (set-buffer-multibyte nil))
402     (defalias 'mm-disable-multibyte-mule4 'ignore)))
403
404 (defun mm-preferred-coding-system (charset)
405   ;; A typo in some Emacs versions.
406   (or (get-charset-property charset 'preferred-coding-system)
407       (get-charset-property charset 'prefered-coding-system)))
408
409 (defsubst mm-guess-charset ()
410   "Guess Mule charset from the language environment."
411   (or
412    mail-parse-mule-charset ;; cached mule-charset
413    (progn
414      (setq mail-parse-mule-charset
415            (and (boundp 'current-language-environment)
416                 (car (last
417                       (assq 'charset
418                             (assoc current-language-environment
419                                    language-info-alist))))))
420      (if (or (not mail-parse-mule-charset)
421              (eq mail-parse-mule-charset 'ascii))
422          (setq mail-parse-mule-charset
423                (or (car (last (assq mail-parse-charset
424                                     mm-mime-mule-charset-alist)))
425                    ;; default
426                    'latin-iso8859-1)))
427      mail-parse-mule-charset)))
428
429 (defun mm-charset-after (&optional pos)
430   "Return charset of a character in current buffer at position POS.
431 If POS is nil, it defauls to the current point.
432 If POS is out of range, the value is nil.
433 If the charset is `composition', return the actual one."
434   (let ((char (char-after pos)) charset)
435     (if (< (mm-char-int char) 128)
436         (setq charset 'ascii)
437       ;; charset-after is fake in some Emacsen.
438       (setq charset (and (fboundp 'char-charset) (char-charset char)))
439       (if (eq charset 'composition)
440           (let ((p (or pos (point))))
441             (cadr (find-charset-region p (1+ p))))
442         (if (and charset (not (memq charset '(ascii eight-bit-control
443                                                     eight-bit-graphic))))
444             charset
445           (mm-guess-charset))))))
446
447 (defun mm-mime-charset (charset)
448   "Return the MIME charset corresponding to the given Mule CHARSET."
449   (if (eq charset 'unknown)
450       (error "The message contains non-printable characters, please use attachment"))
451   (if (and (fboundp 'coding-system-get) (fboundp 'get-charset-property))
452       ;; This exists in Emacs 20.
453       (or
454        (and (mm-preferred-coding-system charset)
455             (coding-system-get
456              (mm-preferred-coding-system charset) 'mime-charset))
457        (and (eq charset 'ascii)
458             'us-ascii)
459        (mm-preferred-coding-system charset)
460        (mm-mule-charset-to-mime-charset charset))
461     ;; This is for XEmacs.
462     (mm-mule-charset-to-mime-charset charset)))
463
464 (defun mm-delete-duplicates (list)
465   "Simple  substitute for CL `delete-duplicates', testing with `equal'."
466   (let (result head)
467     (while list
468       (setq head (car list))
469       (setq list (delete head list))
470       (setq result (cons head result)))
471     (nreverse result)))
472
473 (if (and (not (featurep 'xemacs))
474          (boundp 'enable-multibyte-characters))
475     (defalias 'mm-multibyte-p
476       (lambda ()
477         "Say whether multibyte is enabled in the current buffer."
478         enable-multibyte-characters))
479   (defalias 'mm-multibyte-p (lambda () (featurep 'mule))))
480
481 (defun mm-iso-8859-x-to-15-region (&optional b e)
482   (if (fboundp 'char-charset)
483       (let (charset item c inconvertible)
484         (save-restriction
485           (if e (narrow-to-region b e))
486           (goto-char (point-min))
487           (skip-chars-forward "\0-\177")
488           (while (not (eobp))
489             (cond
490              ((not (setq item (assq (char-charset (setq c (char-after)))
491                                     mm-iso-8859-x-to-15-table)))
492               (forward-char))
493              ((memq c (cdr (cdr item)))
494               (setq inconvertible t)
495               (forward-char))
496              (t
497               (insert-before-markers (prog1 (+ c (car (cdr item)))
498                                        (delete-char 1))))
499             (skip-chars-forward "\0-\177"))))
500         (not inconvertible))))
501
502 (defun mm-sort-coding-systems-predicate (a b)
503   (> (length (memq a mm-coding-system-priorities))
504      (length (memq b mm-coding-system-priorities))))
505
506 (defun mm-find-mime-charset-region (b e &optional hack-charsets)
507   "Return the MIME charsets needed to encode the region between B and E.
508 nil means ASCII, a single-element list represents an appropriate MIME
509 charset, and a longer list means no appropriate charset."
510   (let (charsets)
511     ;; The return possibilities of this function are a mess...
512     (or (and (mm-multibyte-p)
513              mm-use-find-coding-systems-region
514              ;; Find the mime-charset of the most preferred coding
515              ;; system that has one.
516              (let ((systems (find-coding-systems-region b e)))
517                (when mm-coding-system-priorities
518                  (setq systems
519                        (sort systems 'mm-sort-coding-systems-predicate)))
520                ;; Fixme: The `mime-charset' (`x-ctext') of `compound-text'
521                ;; is not in the IANA list.
522                (setq systems (delq 'compound-text systems))
523                (unless (equal systems '(undecided))
524                  (while systems
525                    (let ((cs (coding-system-get (pop systems) 'mime-charset)))
526                      (if cs
527                          (setq systems nil
528                                charsets (list cs))))))
529                charsets))
530         ;; Otherwise we're not multibyte, XEmacs or a single coding
531         ;; system won't cover it.
532         (setq charsets
533               (mm-delete-duplicates
534                (mapcar 'mm-mime-charset
535                        (delq 'ascii
536                              (mm-find-charset-region b e))))))
537     (if (and (memq 'iso-8859-15 charsets)
538              (memq 'iso-8859-15 hack-charsets)
539              (save-excursion (mm-iso-8859-x-to-15-region b e)))
540         (mapcar (lambda (x) (setq charsets (delq (car x) charsets)))
541                 mm-iso-8859-15-compatible))
542     (if (and (memq 'iso-2022-jp-2 charsets)
543              (memq 'iso-2022-jp-2 hack-charsets))
544         (setq charsets (delq 'iso-2022-jp charsets)))
545     charsets))
546
547 (defmacro mm-with-unibyte-buffer (&rest forms)
548   "Create a temporary buffer, and evaluate FORMS there like `progn'.
549 Use unibyte mode for this."
550   `(let (default-enable-multibyte-characters)
551      (with-temp-buffer ,@forms)))
552 (put 'mm-with-unibyte-buffer 'lisp-indent-function 0)
553 (put 'mm-with-unibyte-buffer 'edebug-form-spec '(body))
554
555 (defmacro mm-with-unibyte-current-buffer (&rest forms)
556   "Evaluate FORMS with current current buffer temporarily made unibyte.
557 Also bind `default-enable-multibyte-characters' to nil.
558 Equivalent to `progn' in XEmacs"
559   (let ((multibyte (make-symbol "multibyte"))
560         (buffer (make-symbol "buffer")))
561     `(if mm-emacs-mule
562          (let ((,multibyte enable-multibyte-characters)
563                (,buffer (current-buffer)))
564            (unwind-protect
565                (let (default-enable-multibyte-characters)
566                  (set-buffer-multibyte nil)
567                  ,@forms)
568              (set-buffer ,buffer)
569              (set-buffer-multibyte ,multibyte)))
570        (let (default-enable-multibyte-characters)
571          ,@forms))))
572 (put 'mm-with-unibyte-current-buffer 'lisp-indent-function 0)
573 (put 'mm-with-unibyte-current-buffer 'edebug-form-spec '(body))
574
575 (defmacro mm-with-unibyte-current-buffer-mule4 (&rest forms)
576   "Evaluate FORMS there like `progn' in current buffer.
577 Mule4 only."
578   (let ((multibyte (make-symbol "multibyte"))
579         (buffer (make-symbol "buffer")))
580     `(if mm-mule4-p
581          (let ((,multibyte enable-multibyte-characters)
582                (,buffer (current-buffer)))
583            (unwind-protect
584                (let (default-enable-multibyte-characters)
585                  (set-buffer-multibyte nil)
586                  ,@forms)
587              (set-buffer ,buffer)
588              (set-buffer-multibyte ,multibyte)))
589        (let (default-enable-multibyte-characters)
590          ,@forms))))
591 (put 'mm-with-unibyte-current-buffer-mule4 'lisp-indent-function 0)
592 (put 'mm-with-unibyte-current-buffer-mule4 'edebug-form-spec '(body))
593
594 (defmacro mm-with-unibyte (&rest forms)
595   "Eval the FORMS with the default value of `enable-multibyte-characters' nil, ."
596   `(let (default-enable-multibyte-characters)
597      ,@forms))
598 (put 'mm-with-unibyte 'lisp-indent-function 0)
599 (put 'mm-with-unibyte 'edebug-form-spec '(body))
600
601 (defun mm-find-charset-region (b e)
602   "Return a list of Emacs charsets in the region B to E."
603   (cond
604    ((and (mm-multibyte-p)
605          (fboundp 'find-charset-region))
606     ;; Remove composition since the base charsets have been included.
607     ;; Remove eight-bit-*, treat them as ascii.
608     (let ((css (find-charset-region b e)))
609       (mapcar (lambda (cs) (setq css (delq cs css)))
610               '(composition eight-bit-control eight-bit-graphic
611                             control-1))
612       css))
613    (t
614     ;; We are in a unibyte buffer or XEmacs non-mule, so we futz around a bit.
615     (save-excursion
616       (save-restriction
617         (narrow-to-region b e)
618         (goto-char (point-min))
619         (skip-chars-forward "\0-\177")
620         (if (eobp)
621             '(ascii)
622           (let (charset)
623             (setq charset
624                   (and (boundp 'current-language-environment)
625                        (car (last (assq 'charset
626                                         (assoc current-language-environment
627                                                language-info-alist))))))
628             (if (eq charset 'ascii) (setq charset nil))
629             (or charset
630                 (setq charset
631                       (car (last (assq mail-parse-charset
632                                        mm-mime-mule-charset-alist)))))
633             (list 'ascii (or charset 'latin-iso8859-1)))))))))
634
635 (static-if (fboundp 'shell-quote-argument)
636     (defalias 'mm-quote-arg 'shell-quote-argument)
637   (defun mm-quote-arg (arg)
638     "Return a version of ARG that is safe to evaluate in a shell."
639     (let ((pos 0) new-pos accum)
640       ;; *** bug: we don't handle newline characters properly
641       (while (setq new-pos (string-match "[]*[;!'`\"$\\& \t{} |()<>]" arg pos))
642         (push (substring arg pos new-pos) accum)
643         (push "\\" accum)
644         (push (list (aref arg new-pos)) accum)
645         (setq pos (1+ new-pos)))
646       (if (= pos 0)
647           arg
648         (apply 'concat (nconc (nreverse accum) (list (substring arg pos))))))))
649
650 (defun mm-auto-mode-alist ()
651   "Return an `auto-mode-alist' with only the .gz (etc) thingies."
652   (let ((alist auto-mode-alist)
653         out)
654     (while alist
655       (when (listp (cdar alist))
656         (push (car alist) out))
657       (pop alist))
658     (nreverse out)))
659
660 (defvar mm-inhibit-file-name-handlers
661   '(jka-compr-handler image-file-handler)
662   "A list of handlers doing (un)compression (etc) thingies.")
663
664 (defun mm-insert-file-contents (filename &optional visit beg end replace
665                                          inhibit)
666   "Like `insert-file-contents', q.v., but only reads in the file.
667 A buffer may be modified in several ways after reading into the buffer due
668 to advanced Emacs features, such as file-name-handlers, format decoding,
669 find-file-hooks, etc.
670 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers.
671   This function ensures that none of these modifications will take place."
672   (let ((format-alist nil)
673         (auto-mode-alist (if inhibit nil (mm-auto-mode-alist)))
674         (default-major-mode 'fundamental-mode)
675         (enable-local-variables nil)
676         (after-insert-file-functions nil)
677         (enable-local-eval nil)
678         (find-file-hooks nil)
679         (inhibit-file-name-operation (if inhibit
680                                          'insert-file-contents
681                                        inhibit-file-name-operation))
682         (inhibit-file-name-handlers
683          (if inhibit
684              (append mm-inhibit-file-name-handlers
685                      inhibit-file-name-handlers)
686            inhibit-file-name-handlers)))
687     (insert-file-contents filename visit beg end replace)))
688
689 (defun mm-append-to-file (start end filename &optional codesys inhibit)
690   "Append the contents of the region to the end of file FILENAME.
691 When called from a function, expects three arguments,
692 START, END and FILENAME.  START and END are buffer positions
693 saying what text to write.
694 Optional fourth argument specifies the coding system to use when
695 encoding the file.
696 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers."
697   (let ((coding-system-for-write
698          (or codesys mm-text-coding-system-for-write
699              mm-text-coding-system))
700         (inhibit-file-name-operation (if inhibit
701                                          'append-to-file
702                                        inhibit-file-name-operation))
703         (inhibit-file-name-handlers
704          (if inhibit
705              (append mm-inhibit-file-name-handlers
706                      inhibit-file-name-handlers)
707            inhibit-file-name-handlers)))
708     (append-to-file start end filename)))
709
710 (defun mm-write-region (start end filename &optional append visit lockname
711                               coding-system inhibit)
712
713   "Like `write-region'.
714 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers."
715   (let ((coding-system-for-write
716          (or coding-system mm-text-coding-system-for-write
717              mm-text-coding-system))
718         (inhibit-file-name-operation (if inhibit
719                                          'write-region
720                                        inhibit-file-name-operation))
721         (inhibit-file-name-handlers
722          (if inhibit
723              (append mm-inhibit-file-name-handlers
724                      inhibit-file-name-handlers)
725            inhibit-file-name-handlers)))
726     (write-region start end filename append visit lockname)))
727
728 (defun mm-image-load-path (&optional package)
729   (let (dir result)
730     (dolist (path load-path (nreverse result))
731       (if (file-directory-p
732            (setq dir (concat (file-name-directory
733                               (directory-file-name path))
734                              "etc/" (or package "gnus/"))))
735           (push dir result))
736       (push path result))))
737
738 (if (fboundp 'detect-coding-region)
739     (defun mm-detect-coding-region (start end)
740       "Like 'detect-coding-region' except returning the best one."
741       (let ((coding-systems
742              (detect-coding-region (point) (point-max))))
743         (or (car-safe coding-systems)
744             coding-systems)))
745   (defun mm-detect-coding-region (start end)
746     (let ((point (point)))
747       (goto-char start)
748       (skip-chars-forward "\0-\177" end)
749       (prog1
750           (if (eq (point) end) 'ascii (mm-guess-charset))
751         (goto-char point)))))
752
753 (if (fboundp 'coding-system-get)
754     (defun mm-detect-mime-charset-region (start end)
755       "Detect MIME charset of the text in the region between START and END."
756       (let ((cs (mm-detect-coding-region start end)))
757         (coding-system-get cs 'mime-charset)))
758   (defun mm-detect-mime-charset-region (start end)
759     "Detect MIME charset of the text in the region between START and END."
760     (let ((cs (mm-detect-coding-region start end)))
761       cs)))
762
763 (defun mm-guess-mime-charset ()
764   "Guess the default MIME charset from the language environment."
765   (let ((language-info
766          (and (boundp 'current-language-environment)
767               (assoc current-language-environment
768                      language-info-alist)))
769         item)
770     (cond
771      ((null language-info)
772       'iso-8859-1)
773      ((setq item
774             (cadr
775              (or (assq 'coding-priority language-info)
776                  (assq 'coding-system language-info))))
777       (if (fboundp 'coding-system-get)
778           (or (coding-system-get item 'mime-charset)
779               item)
780         item))
781      ((setq item (car (last (assq 'charset language-info))))
782       (if (eq item 'ascii)
783           'iso-8859-1
784         (mm-mime-charset item)))
785      (t
786       'iso-8859-1))))
787
788 ;; It is not a MIME function, but some MIME functions use it.
789 (defalias 'mm-make-temp-file
790   (if (fboundp 'make-temp-file)
791       'make-temp-file
792     (lambda (prefix &optional dir-flag)
793       (let ((file (expand-file-name
794                    (make-temp-name prefix)
795                    (if (fboundp 'temp-directory)
796                        (temp-directory)
797                      temporary-file-directory))))
798         (if dir-flag
799             (make-directory file))
800         file))))
801
802 (provide 'mm-util)
803
804 ;;; mm-util.el ends here