git.chise.org Git - elisp/gnus.git-/blob - lisp/mm-util.el

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