cgit.sxemacs.org Git - gnus/blob - lisp/mm-util.el

   1 ;;; mm-util.el --- Utility functions for MIME things
   2 ;; Copyright (C) 1998, 1999, 2000 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 (require 'mail-prsvr)
  28
  29 (defvar mm-mime-mule-charset-alist
  30   '((us-ascii ascii)
  31     (iso-8859-1 latin-iso8859-1)
  32     (iso-8859-2 latin-iso8859-2)
  33     (iso-8859-3 latin-iso8859-3)
  34     (iso-8859-4 latin-iso8859-4)
  35     (iso-8859-5 cyrillic-iso8859-5)
  36     ;; Non-mule (X)Emacs uses the last mule-charset for 8bit characters.
  37     ;; The fake mule-charset, gnus-koi8-r, tells Gnus that the default
  38     ;; charset is koi8-r, not iso-8859-5.
  39     (koi8-r cyrillic-iso8859-5 gnus-koi8-r)
  40     (iso-8859-6 arabic-iso8859-6)
  41     (iso-8859-7 greek-iso8859-7)
  42     (iso-8859-8 hebrew-iso8859-8)
  43     (iso-8859-9 latin-iso8859-9)
  44     (viscii vietnamese-viscii-lower)
  45     (iso-2022-jp latin-jisx0201 japanese-jisx0208 japanese-jisx0208-1978)
  46     (euc-kr korean-ksc5601)
  47     (cn-gb-2312 chinese-gb2312)
  48     (cn-big5 chinese-big5-1 chinese-big5-2)
  49     (tibetan tibetan)
  50     (thai-tis620 thai-tis620)
  51     (iso-2022-7bit ethiopic arabic-1-column arabic-2-column)
  52     (iso-2022-jp-2 latin-iso8859-1 greek-iso8859-7
  53                    latin-jisx0201 japanese-jisx0208-1978
  54                    chinese-gb2312 japanese-jisx0208
  55                    korean-ksc5601 japanese-jisx0212
  56                    katakana-jisx0201)
  57     (iso-2022-int-1 latin-iso8859-1 greek-iso8859-7
  58                     latin-jisx0201 japanese-jisx0208-1978
  59                     chinese-gb2312 japanese-jisx0208
  60                     korean-ksc5601 japanese-jisx0212
  61                     chinese-cns11643-1 chinese-cns11643-2)
  62     (iso-2022-int-1 latin-iso8859-1 latin-iso8859-2
  63                     cyrillic-iso8859-5 greek-iso8859-7
  64                     latin-jisx0201 japanese-jisx0208-1978
  65                     chinese-gb2312 japanese-jisx0208
  66                     korean-ksc5601 japanese-jisx0212
  67                     chinese-cns11643-1 chinese-cns11643-2
  68                     chinese-cns11643-3 chinese-cns11643-4
  69                     chinese-cns11643-5 chinese-cns11643-6
  70                     chinese-cns11643-7)
  71     (utf-8 unicode-a unicode-b unicode-c unicode-d unicode-e))
  72   "Alist of MIME-charset/MULE-charsets.")
  73
  74 (eval-and-compile
  75   (mapcar
  76    (lambda (elem)
  77      (let ((nfunc (intern (format "mm-%s" (car elem)))))
  78        (if (fboundp (car elem))
  79            (defalias nfunc (car elem))
  80          (defalias nfunc (cdr elem)))))
  81    '((decode-coding-string . (lambda (s a) s))
  82      (encode-coding-string . (lambda (s a) s))
  83      (encode-coding-region . ignore)
  84      (coding-system-list . ignore)
  85      (decode-coding-region . ignore)
  86      (char-int . identity)
  87      (device-type . ignore)
  88      (coding-system-equal . equal)
  89      (annotationp . ignore)
  90      (set-buffer-file-coding-system . ignore)
  91      (make-char
  92       . (lambda (charset int)
  93           (int-to-char int)))
  94      (read-coding-system
  95       . (lambda (prompt)
  96           "Prompt the user for a coding system."
  97           (completing-read
  98            prompt (mapcar (lambda (s) (list (symbol-name (car s))))
  99                           mm-mime-mule-charset-alist))))
 100      (read-charset
 101       . (lambda (prompt)
 102           "Return a charset."
 103           (intern
 104            (completing-read
 105             prompt
 106             (mapcar (lambda (e) (list (symbol-name (car e))))
 107                     mm-mime-mule-charset-alist)
 108             nil t)))))))
 109
 110 (eval-and-compile
 111   (defalias 'mm-char-or-char-int-p
 112     (cond
 113      ((fboundp 'char-or-char-int-p) 'char-or-char-int-p)
 114      ((fboundp 'char-valid-p) 'char-valid-p)
 115      (t 'identity))))
 116
 117 (defvar mm-coding-system-list nil)
 118 (defun mm-get-coding-system-list ()
 119   "Get the coding system list."
 120   (or mm-coding-system-list
 121       (setq mm-coding-system-list (mm-coding-system-list))))
 122
 123 (defvar mm-charset-synonym-alist
 124   '((big5 . cn-big5)
 125     (gb2312 . cn-gb-2312)
 126     (x-ctext . ctext))
 127   "A mapping from invalid charset names to the real charset names.")
 128
 129 (defun mm-coding-system-p (sym)
 130   "Return non-nil if SYM is a coding system."
 131   (or (and (fboundp 'coding-system-p) (coding-system-p sym))
 132       (memq sym (mm-get-coding-system-list))))
 133
 134 (defvar mm-binary-coding-system
 135   (cond
 136    ((mm-coding-system-p 'binary) 'binary)
 137    ((mm-coding-system-p 'no-conversion) 'no-conversion)
 138    (t nil))
 139   "100% binary coding system.")
 140
 141 (defvar mm-text-coding-system
 142   (or (if (memq system-type '(windows-nt ms-dos ms-windows))
 143           (and (mm-coding-system-p 'raw-text-dos) 'raw-text-dos)
 144         (and (mm-coding-system-p 'raw-text) 'raw-text))
 145       mm-binary-coding-system)
 146   "Text-safe coding system (For removing ^M).")
 147
 148 (defvar mm-text-coding-system-for-write nil
 149   "Text coding system for write.")
 150
 151 (defvar mm-auto-save-coding-system
 152   (cond
 153    ((mm-coding-system-p 'emacs-mule)
 154     (if (memq system-type '(windows-nt ms-dos ms-windows))
 155         (if (mm-coding-system-p 'emacs-mule-dos)
 156             'emacs-mule-dos mm-binary-coding-system)
 157       'emacs-mule))
 158    ((mm-coding-system-p 'escape-quoted) 'escape-quoted)
 159    (t mm-binary-coding-system))
 160   "Coding system of auto save file.")
 161
 162 ;;; Internal variables:
 163
 164 ;;; Functions:
 165
 166 (defun mm-mule-charset-to-mime-charset (charset)
 167   "Return the MIME charset corresponding to MULE CHARSET."
 168   (let ((alist mm-mime-mule-charset-alist)
 169         out)
 170     (while alist
 171       (when (memq charset (cdar alist))
 172         (setq out (caar alist)
 173               alist nil))
 174       (pop alist))
 175     out))
 176
 177 (defun mm-charset-to-coding-system (charset &optional lbt)
 178   "Return coding-system corresponding to CHARSET.
 179 CHARSET is a symbol naming a MIME charset.
 180 If optional argument LBT (`unix', `dos' or `mac') is specified, it is
 181 used as the line break code type of the coding system."
 182   (when (stringp charset)
 183     (setq charset (intern (downcase charset))))
 184   (setq charset
 185         (or (cdr (assq charset mm-charset-synonym-alist))
 186             charset))
 187   (when lbt
 188     (setq charset (intern (format "%s-%s" charset lbt))))
 189   (cond
 190    ;; Running in a non-MULE environment.
 191    ((null (mm-get-coding-system-list))
 192     charset)
 193    ;; ascii
 194    ((eq charset 'us-ascii)
 195     'ascii)
 196    ;; Check to see whether we can handle this charset.
 197    ((memq charset (mm-get-coding-system-list))
 198     charset)
 199    ;; Nope.
 200    (t
 201     nil)))
 202
 203 (if (fboundp 'subst-char-in-string)
 204     (defsubst mm-replace-chars-in-string (string from to)
 205       (subst-char-in-string from to string))
 206   (defun mm-replace-chars-in-string (string from to)
 207     "Replace characters in STRING from FROM to TO."
 208     (let ((string (substring string 0)) ;Copy string.
 209           (len (length string))
 210           (idx 0))
 211       ;; Replace all occurrences of FROM with TO.
 212       (while (< idx len)
 213         (when (= (aref string idx) from)
 214           (aset string idx to))
 215         (setq idx (1+ idx)))
 216       string)))
 217
 218 (defsubst mm-enable-multibyte ()
 219   "Enable multibyte in the current buffer."
 220   (when (and (fboundp 'set-buffer-multibyte)
 221              (boundp 'enable-multibyte-characters)
 222              (default-value 'enable-multibyte-characters))
 223     (set-buffer-multibyte t)))
 224
 225 (defsubst mm-disable-multibyte ()
 226   "Disable multibyte in the current buffer."
 227   (when (fboundp 'set-buffer-multibyte)
 228     (set-buffer-multibyte nil)))
 229
 230 (defun mm-preferred-coding-system (charset)
 231   ;; A typo in some Emacs versions.
 232   (or (get-charset-property charset 'prefered-coding-system)
 233       (get-charset-property charset 'preferred-coding-system)))
 234
 235 (defun mm-charset-after (&optional pos)
 236   "Return charset of a character in current buffer at position POS.
 237 If POS is nil, it defauls to the current point.
 238 If POS is out of range, the value is nil.
 239 If the charset is `composition', return the actual one."
 240   (let ((charset (cond
 241                   ((fboundp 'charset-after)
 242                    (charset-after pos))
 243                   ((fboundp 'char-charset)
 244                    (char-charset (char-after pos)))
 245                   ((< (mm-char-int (char-after pos)) 128)
 246                    'ascii)
 247                   (mail-parse-mule-charset ;; cached mule-charset
 248                    mail-parse-mule-charset)
 249                   ((boundp 'current-language-environment)
 250                    (let ((entry (assoc current-language-environment
 251                                        language-info-alist)))
 252                      (setq mail-parse-mule-charset
 253                            (or (car (last (assq 'charset entry)))
 254                                'latin-iso8859-1))))
 255                   (t                       ;; figure out the charset
 256                    (setq mail-parse-mule-charset
 257                          (or (car (last (assq mail-parse-charset
 258                                               mm-mime-mule-charset-alist)))
 259                              'latin-iso8859-1))))))
 260     (if (eq charset 'composition)
 261         (let ((p (or pos (point))))
 262           (cadr (find-charset-region p (1+ p))))
 263       charset)))
 264
 265 (defun mm-mime-charset (charset)
 266   "Return the MIME charset corresponding to the MULE CHARSET."
 267   (if (and (fboundp 'coding-system-get) (fboundp 'get-charset-property))
 268       ;; This exists in Emacs 20.
 269       (or
 270        (and (mm-preferred-coding-system charset)
 271             (coding-system-get
 272              (mm-preferred-coding-system charset) 'mime-charset))
 273        (and (eq charset 'ascii)
 274             'us-ascii)
 275        (mm-preferred-coding-system charset)
 276        (mm-mule-charset-to-mime-charset charset))
 277     ;; This is for XEmacs.
 278     (mm-mule-charset-to-mime-charset charset)))
 279
 280 (defun mm-delete-duplicates (list)
 281   "Simple  substitute for CL `delete-duplicates', testing with `equal'."
 282   (let (result head)
 283     (while list
 284       (setq head (car list))
 285       (setq list (delete head list))
 286       (setq result (cons head result)))
 287     (nreverse result)))
 288
 289 (defun mm-find-mime-charset-region (b e)
 290   "Return the MIME charsets needed to encode the region between B and E."
 291   (let ((charsets (mapcar 'mm-mime-charset
 292                           (delq 'ascii
 293                                 (mm-find-charset-region b e)))))
 294     (when (memq 'iso-2022-jp-2 charsets)
 295       (setq charsets (delq 'iso-2022-jp charsets)))
 296     (setq charsets (mm-delete-duplicates charsets))
 297     (if (and (> (length charsets) 1)
 298              (fboundp 'find-coding-systems-region)
 299              (memq 'utf-8 (find-coding-systems-region b e)))
 300         '(utf-8)
 301       charsets)))
 302
 303 (defsubst mm-multibyte-p ()
 304   "Say whether multibyte is enabled."
 305   (or (featurep 'xemacs)
 306       (and (boundp 'enable-multibyte-characters)
 307            enable-multibyte-characters)))
 308
 309 (defmacro mm-with-unibyte-buffer (&rest forms)
 310   "Create a temporary buffer, and evaluate FORMS there like `progn'.
 311 Use unibyte mode for this."
 312        (let ((,multibyte (default-value 'enable-multibyte-characters))
 313              ,temp-buffer)
 314          (unwind-protect
 315              (progn
 316                (setq-default enable-multibyte-characters nil)
 317                (setq ,temp-buffer
 318                      (get-buffer-create (generate-new-buffer-name " *temp*")))
 319                (unwind-protect
 320                    (with-current-buffer ,temp-buffer
 321                      (let ((buffer-file-coding-system mm-binary-coding-system)
 322                            (coding-system-for-read mm-binary-coding-system)
 323                            (coding-system-for-write mm-binary-coding-system))
 324                        ,@forms))
 325                  (and (buffer-name ,temp-buffer)
 326                       (kill-buffer ,temp-buffer))))
 327            (setq-default enable-multibyte-characters ,multibyte))))))
 328 (put 'mm-with-unibyte-buffer 'lisp-indent-function 0)
 329 (put 'mm-with-unibyte-buffer 'edebug-form-spec '(body))
 330
 331 (defmacro mm-with-unibyte-current-buffer (&rest forms)
 332   "Evaluate FORMS there like `progn' in current buffer."
 333   (let ((multibyte (make-symbol "multibyte")))
 334     `(if (or (featurep 'xemacs)
 335              (not (fboundp 'set-buffer-multibyte)))
 336          (progn
 337            ,@forms)
 338        (let ((,multibyte (default-value 'enable-multibyte-characters)))
 339          (unwind-protect
 340              (let ((buffer-file-coding-system mm-binary-coding-system)
 341                    (coding-system-for-read mm-binary-coding-system)
 342                    (coding-system-for-write mm-binary-coding-system))
 343                (set-buffer-multibyte nil)
 344                (setq-default enable-multibyte-characters nil)
 345                ,@forms)
 346            (setq-default enable-multibyte-characters ,multibyte)
 347            (set-buffer-multibyte ,multibyte))))))
 348 (put 'mm-with-unibyte-current-buffer 'lisp-indent-function 0)
 349 (put 'mm-with-unibyte-current-buffer 'edebug-form-spec '(body))
 350
 351 (defmacro mm-with-unibyte (&rest forms)
 352   "Set default `enable-multibyte-characters' to `nil', eval the FORMS."
 353   (let ((multibyte (make-symbol "multibyte")))
 354     `(if (or (featurep 'xemacs)
 355              (not (boundp 'enable-multibyte-characters)))
 356          (progn ,@forms)
 357        (let ((,multibyte (default-value 'enable-multibyte-characters)))
 358          (unwind-protect
 359              (progn
 360                (setq-default enable-multibyte-characters nil)
 361                ,@forms)
 362            (setq-default enable-multibyte-characters ,multibyte))))))
 363 (put 'mm-with-unibyte 'lisp-indent-function 0)
 364 (put 'mm-with-unibyte 'edebug-form-spec '(body))
 365
 366 (defun mm-find-charset-region (b e)
 367   "Return a list of charsets in the region."
 368   (cond
 369    ((and (mm-multibyte-p)
 370          (fboundp 'find-charset-region))
 371     ;; Remove composition since the base charsets have been included.
 372     (delq 'composition (find-charset-region b e)))
 373    ((not (boundp 'current-language-environment))
 374     (save-excursion
 375       (save-restriction
 376         (narrow-to-region b e)
 377         (goto-char (point-min))
 378         (skip-chars-forward "\0-\177")
 379         (if (eobp)
 380             '(ascii)
 381           (delq nil (list 'ascii
 382                           (or (car (last (assq mail-parse-charset
 383                                                mm-mime-mule-charset-alist)))
 384                               'latin-iso8859-1)))))))
 385    (t
 386     ;; We are in a unibyte buffer, so we futz around a bit.
 387     (save-excursion
 388       (save-restriction
 389         (narrow-to-region b e)
 390         (goto-char (point-min))
 391         (let ((entry (assoc current-language-environment
 392                             language-info-alist)))
 393           (skip-chars-forward "\0-\177")
 394           (if (eobp)
 395               '(ascii)
 396             (delq nil (list 'ascii
 397                             (or (car (last (assq 'charset entry)))
 398                                 'latin-iso8859-1))))))))))
 399
 400 (if (fboundp 'shell-quote-argument)
 401     (defalias 'mm-quote-arg 'shell-quote-argument)
 402   (defun mm-quote-arg (arg)
 403     "Return a version of ARG that is safe to evaluate in a shell."
 404     (let ((pos 0) new-pos accum)
 405       ;; *** bug: we don't handle newline characters properly
 406       (while (setq new-pos (string-match "[]*[;!'`\"$\\& \t{} |()<>]" arg pos))
 407         (push (substring arg pos new-pos) accum)
 408         (push "\\" accum)
 409         (push (list (aref arg new-pos)) accum)
 410         (setq pos (1+ new-pos)))
 411       (if (= pos 0)
 412           arg
 413         (apply 'concat (nconc (nreverse accum) (list (substring arg pos))))))))
 414
 415 (defun mm-auto-mode-alist ()
 416   "Return an `auto-mode-alist' with only the .gz (etc) thingies."
 417   (let ((alist auto-mode-alist)
 418         out)
 419     (while alist
 420       (when (listp (cdar alist))
 421         (push (car alist) out))
 422       (pop alist))
 423     (nreverse out)))
 424
 425 (defvar mm-inhibit-file-name-handlers
 426   '(jka-compr-handler)
 427   "A list of handlers doing (un)compression (etc) thingies.")
 428
 429 (defun mm-insert-file-contents (filename &optional visit beg end replace
 430                                          inhibit)
 431   "Like `insert-file-contents', q.v., but only reads in the file.
 432 A buffer may be modified in several ways after reading into the buffer due
 433 to advanced Emacs features, such as file-name-handlers, format decoding,
 434 find-file-hooks, etc.
 435 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers.
 436   This function ensures that none of these modifications will take place."
 437   (let ((format-alist nil)
 438         (auto-mode-alist (if inhibit nil (mm-auto-mode-alist)))
 439         (default-major-mode 'fundamental-mode)
 440         (enable-local-variables nil)
 441         (after-insert-file-functions nil)
 442         (enable-local-eval nil)
 443         (find-file-hooks nil)
 444         (inhibit-file-name-operation (if inhibit
 445                                          'insert-file-contents
 446                                        inhibit-file-name-operation))
 447         (inhibit-file-name-handlers
 448          (if inhibit
 449              (append mm-inhibit-file-name-handlers
 450                      inhibit-file-name-handlers)
 451            inhibit-file-name-handlers)))
 452     (insert-file-contents filename visit beg end replace)))
 453
 454 (defun mm-append-to-file (start end filename &optional codesys inhibit)
 455   "Append the contents of the region to the end of file FILENAME.
 456 When called from a function, expects three arguments,
 457 START, END and FILENAME.  START and END are buffer positions
 458 saying what text to write.
 459 Optional fourth argument specifies the coding system to use when
 460 encoding the file.
 461 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers."
 462   (let ((coding-system-for-write
 463          (or codesys mm-text-coding-system-for-write
 464              mm-text-coding-system))
 465         (inhibit-file-name-operation (if inhibit
 466                                          'append-to-file
 467                                        inhibit-file-name-operation))
 468         (inhibit-file-name-handlers
 469          (if inhibit
 470              (append mm-inhibit-file-name-handlers
 471                      inhibit-file-name-handlers)
 472            inhibit-file-name-handlers)))
 473     (append-to-file start end filename)))
 474
 475 (defun mm-write-region (start end filename &optional append visit lockname
 476                               coding-system inhibit)
 477
 478   "Like `write-region'.
 479 If INHIBIT is non-nil, inhibit mm-inhibit-file-name-handlers."
 480   (let ((coding-system-for-write
 481          (or coding-system mm-text-coding-system-for-write
 482              mm-text-coding-system))
 483         (inhibit-file-name-operation (if inhibit
 484                                          'write-region
 485                                        inhibit-file-name-operation))
 486         (inhibit-file-name-handlers
 487          (if inhibit
 488              (append mm-inhibit-file-name-handlers
 489                      inhibit-file-name-handlers)
 490            inhibit-file-name-handlers)))
 491     (write-region start end filename append visit lockname)))
 492
 493 (provide 'mm-util)
 494
 495 ;;; mm-util.el ends here