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