mule.el 48.1 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1 2 3
;;; mule.el --- basic commands for mulitilingual environment

;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
Richard M. Stallman's avatar
Richard M. Stallman committed
4
;; Licensed to the Free Software Foundation.
Karl Heuer's avatar
Karl Heuer committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

;; Keywords: mule, multilingual, character set, coding system

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Karl Heuer's avatar
Karl Heuer committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Karl Heuer's avatar
Karl Heuer committed
24 25 26

;;; Code:

27
(defconst mule-version "4.0 (HANANOEN)" "\
Karl Heuer's avatar
Karl Heuer committed
28 29
Version number and name of this version of MULE (multilingual environment).")

30
(defconst mule-version-date "1998.7.1" "\
Karl Heuer's avatar
Karl Heuer committed
31 32 33
Distribution date of this version of MULE (multilingual environment).")

(defun load-with-code-conversion (fullname file &optional noerror nomessage)
34 35
  "Execute a file of Lisp code named FILE whose absolute name is FULLNAME.
The file contents are decoded before evaluation if necessary.
Karl Heuer's avatar
Karl Heuer committed
36 37 38 39 40 41 42 43 44 45 46 47
If optional second arg NOERROR is non-nil,
 report no error if FILE doesn't exist.
Print messages at start and end of loading unless
 optional third arg NOMESSAGE is non-nil.
Return t if file exists."
  (if (null (file-readable-p fullname))
      (and (null noerror)
	   (signal 'file-error (list "Cannot open load file" file)))
    ;; Read file with code conversion, and then eval.
    (let* ((buffer
	    ;; To avoid any autoloading, set default-major-mode to
	    ;; fundamental-mode.
48 49 50 51 52 53
	    ;; So that we don't get completely screwed if the
	    ;; file is encoded in some complicated character set,
	    ;; read it with real decoding, as a multibyte buffer,
	    ;; even if this is a --unibyte Emacs session.
	    (let ((default-major-mode 'fundamental-mode)
		  (default-enable-multibyte-characters t))
Karl Heuer's avatar
Karl Heuer committed
54 55 56
	      ;; We can't use `generate-new-buffer' because files.el
	      ;; is not yet loaded.
	      (get-buffer-create (generate-new-buffer-name " *load*"))))
57 58 59 60 61 62 63 64
	   (load-in-progress t)
	   (source (save-match-data (string-match "\\.el\\'" fullname))))
      (unless nomessage
	(if source
	    (message "Loading %s (source)..." file)
	  (message "Loading %s..." file)))
      (when purify-flag
	(setq preloaded-file-list (cons file preloaded-file-list)))
Karl Heuer's avatar
Karl Heuer committed
65
      (unwind-protect
66
	  (let ((load-file-name fullname)
67
		(set-auto-coding-for-load t)
68
		(inhibit-file-name-operation nil))
Karl Heuer's avatar
Karl Heuer committed
69 70 71 72 73
	    (save-excursion
	      (set-buffer buffer)
	      (insert-file-contents fullname)
	      ;; Make `kill-buffer' quiet.
	      (set-buffer-modified-p nil))
74
	    ;; Have the original buffer current while we eval.
75 76 77 78
	    (eval-buffer buffer nil file
			 ;; If this Emacs is running with --unibyte,
			 ;; convert multibyte strings to unibyte
			 ;; after reading them.
79 80
;;			 (not default-enable-multibyte-characters)
			 ))
81 82
	(let (kill-buffer-hook kill-buffer-query-functions)
	  (kill-buffer buffer)))
Karl Heuer's avatar
Karl Heuer committed
83
      (let ((hook (assoc file after-load-alist)))
84 85 86 87 88 89
	(when hook
	  (mapcar (function eval) (cdr hook))))
      (unless (or nomessage noninteractive)
	(if source
	    (message "Loading %s (source)...done" file)
	  (message "Loading %s...done" file)))
Karl Heuer's avatar
Karl Heuer committed
90 91 92 93
      t)))

;; API (Application Program Interface) for charsets.

94 95 96 97 98 99 100 101
;; Return t if OBJ is a quoted symbol
;; and the symbol is the name of a standard charset.
(defsubst charset-quoted-standard-p (obj)
  (and (listp obj) (eq (car obj) 'quote)
       (symbolp (car-safe (cdr obj)))
       (let ((vector (get (car-safe (cdr obj)) 'charset)))
	 (and (vectorp vector)
	      (< (aref vector 0) 160)))))
Karl Heuer's avatar
Karl Heuer committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

(defsubst charsetp (object)
  "T is OBJECT is a charset."
  (and (symbolp object) (vectorp (get object 'charset))))

(defsubst charset-info (charset)
  "Return a vector of information of CHARSET.
The elements of the vector are:
	CHARSET-ID, BYTES, DIMENSION, CHARS, WIDTH, DIRECTION,
	LEADING-CODE-BASE, LEADING-CODE-EXT,
	ISO-FINAL-CHAR, ISO-GRAPHIC-PLANE,
	REVERSE-CHARSET, SHORT-NAME, LONG-NAME,	DESCRIPTION,
	PLIST,
where
CHARSET-ID (integer) is the identification number of the charset.
DIMENSION (integer) is the number of bytes to represent a character of
the charset: 1 or 2.
CHARS (integer) is the number of characters in a dimension: 94 or 96.
BYTE (integer) is the length of multi-byte form of a character in
  the charset: one of 1, 2, 3, and 4.
WIDTH (integer) is the number of columns a character in the charset
  occupies on the screen: one of 0, 1, and 2.
DIRECTION (integer) is the rendering direction of characters in the
  charset when rendering.  If 0, render from right to left, else
  render from left to right.
LEADING-CODE-BASE (integer) is the base leading-code for the
  charset.
LEADING-CODE-EXT (integer) is the extended leading-code for the
  charset.  All charsets of less than 0xA0 has the value 0.
ISO-FINAL-CHAR (character) is the final character of the
  corresponding ISO 2022 charset.
ISO-GRAPHIC-PLANE (integer) is the graphic plane to be invoked
  while encoding to variants of ISO 2022 coding system, one of the
  following: 0/graphic-plane-left(GL), 1/graphic-plane-right(GR).
REVERSE-CHARSET (integer) is the charset which differs only in
  LEFT-TO-RIGHT value from the charset.  If there's no such a
  charset, the value is -1.
SHORT-NAME (string) is the short name to refer to the charset.
LONG-NAME (string) is the long name to refer to the charset
DESCRIPTION (string) is the description string of the charset.
PLIST (property list) may contain any type of information a user
  want to put and get by functions `put-charset-property' and
  `get-charset-property' respectively."
  (get charset 'charset))

(defmacro charset-id (charset)
  "Return charset identification number of CHARSET."
149
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
150 151 152 153
      (aref (charset-info (nth 1 charset)) 0)
    `(aref (charset-info ,charset) 0)))

(defmacro charset-bytes (charset)
154 155
  "Return bytes of CHARSET.
See the function `charset-info' for more detail."
156
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
157 158 159 160
      (aref (charset-info (nth 1 charset)) 1)
    `(aref (charset-info ,charset) 1)))

(defmacro charset-dimension (charset)
161 162
  "Return dimension of CHARSET.
See the function `charset-info' for more detail."
163
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
164 165 166 167
      (aref (charset-info (nth 1 charset)) 2)
    `(aref (charset-info ,charset) 2)))

(defmacro charset-chars (charset)
168 169
  "Return character numbers contained in a dimension of CHARSET.
See the function `charset-info' for more detail."
170
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
171 172 173 174
      (aref (charset-info (nth 1 charset)) 3)
    `(aref (charset-info ,charset) 3)))

(defmacro charset-width (charset)
175 176
  "Return width (how many column occupied on a screen) of CHARSET.
See the function `charset-info' for more detail."
177
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
178 179 180 181
      (aref (charset-info (nth 1 charset)) 4)
    `(aref (charset-info ,charset) 4)))

(defmacro charset-direction (charset)
182 183
  "Return direction of CHARSET.
See the function `charset-info' for more detail."
184
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
185 186 187 188
      (aref (charset-info (nth 1 charset)) 5)
    `(aref (charset-info ,charset) 5)))

(defmacro charset-iso-final-char (charset)
189 190
  "Return final char of CHARSET.
See the function `charset-info' for more detail."
191
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
192 193 194 195
      (aref (charset-info (nth 1 charset)) 8)
    `(aref (charset-info ,charset) 8)))

(defmacro charset-iso-graphic-plane (charset)
196 197
  "Return graphic plane of CHARSET.
See the function `charset-info' for more detail."
198
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
199 200 201 202
      (aref (charset-info (nth 1 charset)) 9)
    `(aref (charset-info ,charset) 9)))

(defmacro charset-reverse-charset (charset)
203 204
  "Return reverse charset of CHARSET.
See the function `charset-info' for more detail."
205
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
206 207 208 209
      (aref (charset-info (nth 1 charset)) 10)
    `(aref (charset-info ,charset) 10)))

(defmacro charset-short-name (charset)
210 211
  "Return short name of CHARSET.
See the function `charset-info' for more detail."
212
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
213 214 215 216
      (aref (charset-info (nth 1 charset)) 11)
    `(aref (charset-info ,charset) 11)))

(defmacro charset-long-name (charset)
217 218
  "Return long name of CHARSET.
See the function `charset-info' for more detail."
219
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
220 221 222 223
      (aref (charset-info (nth 1 charset)) 12)
    `(aref (charset-info ,charset) 12)))

(defmacro charset-description (charset)
Paul Eggert's avatar
Paul Eggert committed
224
  "Return description of CHARSET.
225
See the function `charset-info' for more detail."
226
  (if (charset-quoted-standard-p charset)
Karl Heuer's avatar
Karl Heuer committed
227 228 229 230
      (aref (charset-info (nth 1 charset)) 13)
    `(aref (charset-info ,charset) 13)))

(defmacro charset-plist (charset)
231 232
  "Return list charset property of CHARSET.
See the function `charset-info' for more detail."
233
  (if (charset-quoted-standard-p charset)
Kenichi Handa's avatar
Kenichi Handa committed
234
      `(aref ,(charset-info (nth 1 charset)) 14)
Karl Heuer's avatar
Karl Heuer committed
235 236 237
    `(aref (charset-info ,charset) 14)))

(defun set-charset-plist (charset plist)
Karl Heuer's avatar
Karl Heuer committed
238
  "Set CHARSET's property list to PLIST, and return PLIST."
Karl Heuer's avatar
Karl Heuer committed
239 240
  (aset (charset-info  charset) 14 plist))

241
(defun make-char (charset &optional c1 c2)
Kenichi Handa's avatar
Kenichi Handa committed
242 243
  "Return a character of CHARSET and position-codes CODE1 and CODE2.
CODE1 and CODE2 are optional, but if you don't supply
244
sufficient position-codes, return a generic character which stands for
Kenichi Handa's avatar
Kenichi Handa committed
245
all characters or group of characters in the character sets.
246
A generic character can be used to index a char table (e.g. syntax-table)."
247 248 249 250 251 252 253 254 255 256 257 258 259
  (make-char-internal (charset-id charset) c1 c2))

(put 'make-char 'byte-compile
     (function 
      (lambda (form)
	(let ((charset (nth 1 form)))
	  (if (charset-quoted-standard-p charset)
	      (byte-compile-normal-call
	       (cons 'make-char-internal
		     (cons (charset-id (nth 1 charset)) (nthcdr 2 form))))
	    (byte-compile-normal-call
	     (cons 'make-char-internal
		   (cons (list 'charset-id charset) (nthcdr 2 form)))))))))
Karl Heuer's avatar
Karl Heuer committed
260

261
(defun charset-list ()
262 263
  "Return list of charsets ever defined.

264
This function is provided for backward compatibility.
265
Now we have the variable `charset-list'."
266 267
  charset-list)

268 269 270
(defsubst generic-char-p (char)
  "Return t if and only if CHAR is a generic character.
See also the documentation of make-char."
271 272 273 274
  (and (>= char 0400)
       (let ((l (split-char char)))
	 (and (or (= (nth 1 l) 0) (eq (nth 2 l) 0))
	      (not (eq (car l) 'composition))))))
275

276

277
;; Coding system staffs
Karl Heuer's avatar
Karl Heuer committed
278

279
;; Coding system is a symbol that has the property `coding-system'.
Karl Heuer's avatar
Karl Heuer committed
280
;;
281 282
;; The value of the property `coding-system' is a vector of the
;; following format:
283
;;	[TYPE MNEMONIC DOC-STRING PLIST FLAGS]
284
;; We call this vector as coding-spec.  See comments in src/coding.c
285
;; for more detail.  
286 287 288 289

(defconst coding-spec-type-idx 0)
(defconst coding-spec-mnemonic-idx 1)
(defconst coding-spec-doc-string-idx 2)
290
(defconst coding-spec-plist-idx 3)
291 292
(defconst coding-spec-flags-idx 4)

293 294 295 296
;; PLIST is a property list of a coding system.  To share PLIST among
;; alias coding systems, a coding system has PLIST in coding-spec
;; instead of having it in normal property list of Lisp symbol.
;; Here's a list of coding system properties currently being used.
297 298 299 300 301 302
;;
;; o coding-category
;;
;; The value is a coding category the coding system belongs to.  The
;; function `make-coding-system' and `define-coding-system-alias' sets
;; this value automatically.
Karl Heuer's avatar
Karl Heuer committed
303
;;
304
;; o alias-coding-systems
Karl Heuer's avatar
Karl Heuer committed
305
;;
306 307 308 309 310 311 312 313 314 315 316
;; The value is a list of coding systems of the same alias group.  The
;; first element is the coding system made at first, which we call as
;; `base coding system'.  The function `make-coding-system' and
;; `define-coding-system-alias' set this value automatically.
;;
;; o post-read-conversion
;;
;; The value is a function to call after some text is inserted and
;; decoded by the coding system itself and before any functions in
;; `after-insert-functions' are called.  The arguments to this
;; function is the same as those of a function in
Karl Heuer's avatar
Karl Heuer committed
317 318 319
;; `after-insert-functions', i.e. LENGTH of a text while putting point
;; at the head of the text to be decoded
;;
320 321 322 323 324 325 326 327 328
;; o pre-write-conversion
;;
;; The value is a function to call after all functions in
;; `write-region-annotate-functions' and `buffer-file-format' are
;; called, and before the text is encoded by the coding system itself.
;; The arguments to this function is the same as those of a function
;; in `write-region-annotate-functions', i.e. FROM and TO specifying
;; region of a text.
;;
329
;; o translation-table-for-decode
330
;;
331 332 333
;; The value is a translation table to be applied on decoding.  See
;; the function `make-translation-table' for the format of translation
;; table.
334
;;
335
;; o translation-table-for-encode
336
;;
337
;; The value is a translation table to be applied on encoding.
338 339 340 341 342 343 344 345 346
;;
;; o safe-charsets
;;
;; The value is a list of charsets safely supported by the coding
;; system.  The value t means that all charsets Emacs handles are
;; supported.  Even if some charset is not in this list, it doesn't
;; mean that the charset can't be encoded in the coding system,
;; instead, it just means that some other receiver of a text encoded
;; in the coding system won't be able to handle that charset.
347 348 349 350 351
;;
;; o mime-charset
;;
;; The value is a symbol of which name is `MIME-charset' parameter of
;; the coding system.
352 353 354 355 356 357
;;
;; o valid-codes (meaningful only for a coding system based on CCL)
;;
;; The value is a list to indicate valid byte ranges of the encoded
;; file.  Each element of the list is an integer or a cons of integer.
;; In the former case, the integer value is a valid byte code.  In the
Karl Heuer's avatar
Karl Heuer committed
358
;; latter case, the integers specifies the range of valid byte codes.
359

360 361 362 363

;; Return coding-spec of CODING-SYSTEM
(defsubst coding-system-spec (coding-system)
  (get (check-coding-system coding-system) 'coding-system))
Karl Heuer's avatar
Karl Heuer committed
364 365

(defun coding-system-type (coding-system)
366 367 368 369
  "Return the coding type of CODING-SYSTEM.
A coding type is an integer value indicating the encoding method
of CODING-SYSTEM.  See the function `make-coding-system' for more detail."
  (aref (coding-system-spec coding-system) coding-spec-type-idx))
Karl Heuer's avatar
Karl Heuer committed
370 371

(defun coding-system-mnemonic (coding-system)
372
  "Return the mnemonic character of CODING-SYSTEM.
373 374 375 376
The mnemonic character of a coding system is used in mode line
to indicate the coding system.  If the arg is nil, return ?-."
  (let ((spec (coding-system-spec coding-system)))
    (if spec (aref spec coding-spec-mnemonic-idx) ?-)))
Karl Heuer's avatar
Karl Heuer committed
377

378
(defun coding-system-doc-string (coding-system)
379 380
  "Return the documentation string for CODING-SYSTEM."
  (aref (coding-system-spec coding-system) coding-spec-doc-string-idx))
Karl Heuer's avatar
Karl Heuer committed
381

382
(defun coding-system-plist (coding-system)
383 384
  "Return the property list of CODING-SYSTEM."
  (aref (coding-system-spec coding-system) coding-spec-plist-idx))
385

Karl Heuer's avatar
Karl Heuer committed
386
(defun coding-system-flags (coding-system)
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
  "Return `flags' of CODING-SYSTEM.
A `flags' of a coding system is a vector of length 32 indicating detailed
information of a coding system.  See the function `make-coding-system'
for more detail."
  (aref (coding-system-spec coding-system) coding-spec-flags-idx))

(defun coding-system-get (coding-system prop)
  "Extract a value from CODING-SYSTEM's property list for property PROP."
  (plist-get (coding-system-plist coding-system) prop))

(defun coding-system-put (coding-system prop val)
  "Change value in CODING-SYSTEM's property list PROP to VAL."
  (let ((plist (coding-system-plist coding-system)))
    (if plist
	(plist-put plist prop val)
      (aset (coding-system-spec coding-system) coding-spec-plist-idx
	    (list prop val)))))

(defun coding-system-category (coding-system)
  "Return the coding category of CODING-SYSTEM."
  (coding-system-get coding-system 'coding-category))

(defun coding-system-base (coding-system)
  "Return the base coding system of CODING-SYSTEM.
411 412
A base coding system is what made by `make-coding-system'.
Any alias nor subsidiary coding systems are not base coding system."
413 414 415 416 417 418 419 420 421 422 423 424 425 426
  (car (coding-system-get coding-system 'alias-coding-systems)))

(defalias 'coding-system-parent 'coding-system-base)
(make-obsolete 'coding-system-parent 'coding-system-base)

;; Coding system also has a property `eol-type'.
;;
;; This property indicates how the coding system handles end-of-line
;; format.  The value is integer 0, 1, 2, or a vector of three coding
;; systems.  Each integer value 0, 1, and 2 indicates the format of
;; end-of-line LF, CRLF, and CR respectively.  A vector value
;; indicates that the format of end-of-line should be detected
;; automatically.  Nth element of the vector is the subsidiary coding
;; system whose `eol-type' property is N.
Karl Heuer's avatar
Karl Heuer committed
427

428
(defun coding-system-eol-type (coding-system)
429 430
  "Return eol-type of CODING-SYSTEM.
An eol-type is integer 0, 1, 2, or a vector of coding systems.
Karl Heuer's avatar
Karl Heuer committed
431

432 433 434 435 436 437 438
Integer values 0, 1, and 2 indicate a format of end-of-line; LF,
CRLF, and CR respectively.

A vector value indicates that a format of end-of-line should be
detected automatically.  Nth element of the vector is the subsidiary
coding system whose eol-type is N."
  (get coding-system 'eol-type))
439

440 441
;; Make subsidiary coding systems (eol-type variants) of CODING-SYSTEM.
(defun make-subsidiary-coding-system (coding-system)
442 443
  (let ((coding-spec (coding-system-spec coding-system))
	(subsidiaries (vector (intern (format "%s-unix" coding-system))
444 445
			      (intern (format "%s-dos" coding-system))
			      (intern (format "%s-mac" coding-system))))
446 447
	(i 0)
	temp)
448
    (while (< i 3)
449
      (put (aref subsidiaries i) 'coding-system coding-spec)
450
      (put (aref subsidiaries i) 'eol-type i)
451 452 453 454 455
      (setq coding-system-list
	    (cons (aref subsidiaries i) coding-system-list))
      (setq coding-system-alist
	    (cons (list (symbol-name (aref subsidiaries i)))
		  coding-system-alist))
456 457
      (setq i (1+ i)))
    subsidiaries))
Karl Heuer's avatar
Karl Heuer committed
458

459
(defun make-coding-system (coding-system type mnemonic doc-string
460
					 &optional flags properties)
461
  "Define a new coding system CODING-SYSTEM (symbol).
462
Remaining arguments are TYPE, MNEMONIC, DOC-STRING, FLAGS (optional), 
463
and PROPERTIES (optional) which construct a coding-spec of CODING-SYSTEM
464
in the following format:
465
	[TYPE MNEMONIC DOC-STRING PLIST FLAGS]
466 467

TYPE is an integer value indicating the type of the coding system as follows:
Karl Heuer's avatar
Karl Heuer committed
468 469 470 471
  0: Emacs internal format,
  1: Shift-JIS (or MS-Kanji) used mainly on Japanese PC,
  2: ISO-2022 including many variants,
  3: Big5 used mainly on Chinese PC,
472 473
  4: private, CCL programs provide encoding/decoding algorithm,
  5: Raw-text, which means that text contains random 8-bit codes. 
474

475
MNEMONIC is a character to be displayed on mode line for the coding system.
476

477
DOC-STRING is a documentation string for the coding system.
478

479
FLAGS specifies more detailed information of the coding system as follows:
480

481
  If TYPE is 2 (ISO-2022), FLAGS is a list of these elements:
Karl Heuer's avatar
Karl Heuer committed
482 483
      CHARSET0, CHARSET1, CHARSET2, CHARSET3, SHORT-FORM,
      ASCII-EOL, ASCII-CNTL, SEVEN, LOCKING-SHIFT, SINGLE-SHIFT,
484
      USE-ROMAN, USE-OLDJIS, NO-ISO6429, INIT-BOL, DESIGNATION-BOL,
485
      SAFE, ACCEPT-LATIN-EXTRA-CODE.
Karl Heuer's avatar
Karl Heuer committed
486 487 488 489 490
    CHARSETn are character sets initially designated to Gn graphic registers.
      If CHARSETn is nil, Gn is never used.
      If CHARSETn is t, Gn can be used but nothing designated initially.
      If CHARSETn is a list of character sets, those character sets are
        designated to Gn on output, but nothing designated to Gn initially.
491
        But, character set `ascii' can be designated only to G0.
Karl Heuer's avatar
Karl Heuer committed
492 493 494 495 496 497 498 499 500 501
    SHORT-FORM non-nil means use short designation sequence on output.
    ASCII-EOL non-nil means designate ASCII to g0 at end of line on output.
    ASCII-CNTL non-nil means designate ASCII to g0 before control codes and
      SPACE on output.
    SEVEN non-nil means use 7-bit code only on output.
    LOCKING-SHIFT non-nil means use locking-shift.
    SINGLE-SHIFT non-nil means use single-shift.
    USE-ROMAN non-nil means designate JIS0201-1976-Roman instead of ASCII.
    USE-OLDJIS non-nil means designate JIS0208-1976 instead of JIS0208-1983.
    NO-ISO6429 non-nil means not use ISO6429's direction specification.
502 503 504 505
    INIT-BOL non-nil means any designation state is assumed to be reset
      to initial at each beginning of line on output.
    DESIGNATION-BOL non-nil means designation sequences should be placed
      at beginning of line on output.
506 507
    SAFE non-nil means convert unsafe characters to `?' on output.
      Unsafe characters are what not specified in SAFE-CHARSET.
508 509 510
    ACCEPT-LATIN-EXTRA-CODE non-nil means code-detection routine accepts
      a code specified in `latin-extra-code-table' (which see) as a valid
      code of the coding system.
511

512 513 514
  If TYPE is 4 (private), FLAGS should be a cons of CCL programs, for
    decoding and encoding.  CCL programs should be specified by their
    symbols.
515 516 517 518 519

PROPERTIES is an alist of properties vs the corresponding values.
These properties are set in PLIST, a property list.  This function
also sets properties `coding-category' and `alias-coding-systems'
automatically.
Karl Heuer's avatar
Karl Heuer committed
520

521 522 523 524 525 526 527
Kludgy features for backward compatibility:

1. If TYPE is 4 and car or cdr of FLAGS is a vector, the vector is
treated as a compiled CCL code.

2. If PROPERTIES is just a list of character sets, the list is set as
a value of `safe-charsets' in PLIST."
528
  (if (memq coding-system coding-system-list)
529
      (error "Coding system %s already exists" coding-system))
530 531

  ;; Set a value of `coding-system' property.
532
  (let ((coding-spec (make-vector 5 nil))
533 534
	(no-initial-designation t)
	(no-alternative-designation t)
535
	coding-category)
536
    (if (or (not (integerp type)) (< type 0) (> type 5))
537
	(error "TYPE argument must be 0..5"))
538
    (if (or (not (integerp mnemonic)) (<= mnemonic ? ) (> mnemonic 127))
Karl Heuer's avatar
Karl Heuer committed
539
	(error "MNEMONIC argument must be an ASCII printable character."))
540 541 542 543
    (aset coding-spec coding-spec-type-idx type)
    (aset coding-spec coding-spec-mnemonic-idx mnemonic)
    (aset coding-spec coding-spec-doc-string-idx
	  (if (stringp doc-string) doc-string ""))
544 545 546 547 548
    (cond ((= type 0)
	   (setq coding-category 'coding-category-emacs-mule))
	  ((= type 1)
	   (setq coding-category 'coding-category-sjis))
	  ((= type 2)			; ISO2022
Karl Heuer's avatar
Karl Heuer committed
549
	   (let ((i 0)
550
		 (vec (make-vector 32 nil))
551 552
		 (g1-designation nil)
		 (fl flags))
Karl Heuer's avatar
Karl Heuer committed
553
	     (while (< i 4)
554
	       (let ((charset (car fl)))
555 556 557 558 559 560 561 562 563 564 565 566 567
		 (if (and no-initial-designation
			  (> i 0)
			  (or (charsetp charset)
			      (and (consp charset)
				   (charsetp (car charset)))))
		     (setq no-initial-designation nil))
		 (if (charsetp charset)
		     (if (= i 1) (setq g1-designation charset))
		   (if (consp charset)
		       (let ((tail charset)
			     elt)
			 (while tail
			   (setq elt (car tail))
568 569 570 571
			   (if (eq elt t)
			       (setq no-alternative-designation nil)
			     (if (and elt (not (charsetp elt)))
				 (error "Invalid charset: %s" elt)))
572 573
			   (setq tail (cdr tail)))
			 (setq g1-designation (car charset)))
574 575 576 577
		     (if charset
			 (if (eq charset t)
			     (setq no-alternative-designation nil)
			   (error "Invalid charset: %s" charset)))))
Karl Heuer's avatar
Karl Heuer committed
578
		 (aset vec i charset))
579 580 581 582
	       (setq fl (cdr fl) i (1+ i)))
	     (while (and (< i 32) fl)
	       (aset vec i (car fl))
	       (setq fl (cdr fl) i (1+ i)))
583 584 585
	     (aset coding-spec 4 vec)
	     (setq coding-category
		   (if (aref vec 8)	; Use locking-shift.
586 587
		       (or (and (aref vec 7) 'coding-category-iso-7-else)
			   'coding-category-iso-8-else)
588 589
		     (if (aref vec 7)	; 7-bit only.
			 (if (aref vec 9) ; Use single-shift.
590
			     'coding-category-iso-7-else
591 592 593
			   (if no-alternative-designation
			       'coding-category-iso-7-tight
			     'coding-category-iso-7))
594 595
		       (if (or no-initial-designation
			       (not no-alternative-designation))
596
			   'coding-category-iso-8-else
597 598 599 600 601 602 603
			 (if (and (charsetp g1-designation)
				  (= (charset-dimension g1-designation) 2))
			     'coding-category-iso-8-2
			   'coding-category-iso-8-1)))))))
	  ((= type 3)
	   (setq coding-category 'coding-category-big5))
	  ((= type 4)			; private
604
	   (setq coding-category 'coding-category-ccl)
605 606 607 608 609 610 611 612 613 614 615
	   (if (not (consp flags))
	       (error "Invalid FLAGS argument for TYPE 4 (CCL)")
	     (let ((decoder (check-ccl-program
			     (car flags)
			     (intern (format "%s-decoder" coding-system))))
		   (encoder (check-ccl-program
			     (cdr flags)
			     (intern (format "%s-encoder" coding-system)))))
	       (if (and decoder encoder)
		   (aset coding-spec 4 (cons decoder encoder))
		 (error "Invalid FLAGS argument for TYPE 4 (CCL)")))))
616 617
	  (t				; i.e. (= type 5)
	   (setq coding-category 'coding-category-raw-text)))
618 619

    (let ((plist (list 'coding-category coding-category
620
		       'alias-coding-systems (list coding-system))))
621
      (if no-initial-designation
622 623 624 625 626 627 628
	  (plist-put plist 'no-initial-designation t))
      (if (and properties
	       (or (eq properties t)
		   (not (consp (car properties)))))
	  ;; In the old version, the arg PROPERTIES is a list to be
	  ;; set in PLIST as a value of property `safe-charsets'.
	  (plist-put plist 'safe-charsets properties)
629 630 631 632
	(let ((l properties))
	  (while l
	    (plist-put plist (car (car l)) (cdr (car l)))
	    (setq l (cdr l)))))
633
      (aset coding-spec coding-spec-plist-idx plist))
634 635 636
    (put coding-system 'coding-system coding-spec)
    (put coding-category 'coding-systems
	 (cons coding-system (get coding-category 'coding-systems))))
Karl Heuer's avatar
Karl Heuer committed
637 638

  ;; Next, set a value of `eol-type' property.  The value is a vector
639
  ;; of subsidiary coding systems, each corresponds to a coding system
Karl Heuer's avatar
Karl Heuer committed
640
  ;; for the detected end-of-line format.
641
  (put coding-system 'eol-type
642
       (if (or (<= type 3) (= type 5))
643
	   (make-subsidiary-coding-system coding-system)
644 645 646 647 648 649
	 0))

  ;; At last, register CODING-SYSTEM in `coding-system-list' and
  ;; `coding-system-alist'.
  (setq coding-system-list (cons coding-system coding-system-list))
  (setq coding-system-alist (cons (list (symbol-name coding-system))
650
				  coding-system-alist))
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

  ;; For a coding system of cateogory iso-8-1 and iso-8-2, create
  ;; XXX-with-esc variants.
  (let ((coding-category (coding-system-category coding-system)))
    (if (or (eq coding-category 'coding-category-iso-8-1)
	    (eq coding-category 'coding-category-iso-8-2))
	(let ((esc (intern (concat (symbol-name coding-system) "-with-esc")))
	      (doc (format "Same as %s but can handle any charsets by ISO's escape sequences." coding-system)))
	  (make-coding-system esc type mnemonic doc
			      (if (listp (car flags))
				  (cons (append (car flags) '(t)) (cdr flags))
				(cons (list (car flags) t) (cdr flags)))
			      properties)
	  (coding-system-put esc 'safe-charsets t))))

666
  coding-system)
667

668
(defun define-coding-system-alias (alias coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
669
  "Define ALIAS as an alias for coding system CODING-SYSTEM."
670 671 672 673 674 675 676 677 678
  (put alias 'coding-system (coding-system-spec coding-system))
  (nconc (coding-system-get alias 'alias-coding-systems) (list alias))
  (setq coding-system-list (cons alias coding-system-list))
  (setq coding-system-alist (cons (list (symbol-name alias))
				  coding-system-alist))
  (let ((eol-type (coding-system-eol-type coding-system)))
    (if (vectorp eol-type)
	(put alias 'eol-type (make-subsidiary-coding-system alias))
      (put alias 'eol-type eol-type))))
Karl Heuer's avatar
Karl Heuer committed
679 680

(defun set-buffer-file-coding-system (coding-system &optional force)
Richard M. Stallman's avatar
Richard M. Stallman committed
681 682 683 684 685 686 687 688 689
  "Set the file coding-system of the current buffer to CODING-SYSTEM.
This means that when you save the buffer, it will be converted
according to CODING-SYSTEM.  For a list of possible values of CODING-SYSTEM,
use \\[list-coding-systems].

If the buffer's previous file coding-system value specifies end-of-line
conversion, and CODING-SYSTEM does not specify one, CODING-SYSTEM is
merged with the already-specified end-of-line conversion.
However, if the optional prefix argument FORCE is non-nil,
690
then CODING-SYSTEM is used exactly as specified."
691
  (interactive "zCoding system for visited file (default, nil): \nP")
Karl Heuer's avatar
Karl Heuer committed
692 693
  (check-coding-system coding-system)
  (if (null force)
694 695
      (let ((x (coding-system-eol-type buffer-file-coding-system))
	    (y (coding-system-eol-type coding-system)))
Karl Heuer's avatar
Karl Heuer committed
696 697 698 699 700 701
	(if (and (numberp x) (>= x 0) (<= x 2) (vectorp y))
	    (setq coding-system (aref y x)))))
  (setq buffer-file-coding-system coding-system)
  (set-buffer-modified-p t)
  (force-mode-line-update))

Richard M. Stallman's avatar
Richard M. Stallman committed
702 703 704 705 706
(defvar default-terminal-coding-system nil
  "Default value for the terminal coding system.
This is normally set according to the selected language environment.
See also the command `set-terminal-coding-system'.")

707 708
(defun set-terminal-coding-system (coding-system)
  "Set coding system of your terminal to CODING-SYSTEM.
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710 711 712 713 714
All text output to the terminal will be encoded
with the specified coding system.
For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
The default is determined by the selected language environment
or by the previous use of this command."
  (interactive
715 716 717 718 719 720 721
   (list (let ((default (if (and (not (terminal-coding-system))
				 default-terminal-coding-system)
			    default-terminal-coding-system)))
	   (read-coding-system
	    (format "Coding system for terminal display (default, %s): "
		    default)
	    default))))
Richard M. Stallman's avatar
Richard M. Stallman committed
722 723 724 725 726
  (if (and (not coding-system)
	   (not (terminal-coding-system)))
      (setq coding-system default-terminal-coding-system))
  (if coding-system
      (setq default-terminal-coding-system coding-system))      
727 728 729
  (set-terminal-coding-system-internal coding-system)
  (redraw-frame (selected-frame)))

Richard M. Stallman's avatar
Richard M. Stallman committed
730 731 732 733 734
(defvar default-keyboard-coding-system nil
  "Default value of the keyboard coding system.
This is normally set according to the selected language environment.
See also the command `set-keyboard-coding-system'.")

735
(defun set-keyboard-coding-system (coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
736 737
  "Set coding system for keyboard input to CODING-SYSTEM.
In addition, this command enables Encoded-kbd minor mode.
738
\(If CODING-SYSTEM is nil, Encoded-kbd mode is turned off.)
Richard M. Stallman's avatar
Richard M. Stallman committed
739 740 741 742
For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
The default is determined by the selected language environment
or by the previous use of this command."
  (interactive
743 744 745 746 747 748 749
   (list (let ((default (if (and (not (keyboard-coding-system))
				 default-keyboard-coding-system)
			    default-keyboard-coding-system)))
	   (read-coding-system
	    (format "Coding system for keyboard input (default, %s): "
		    default)
	    default))))
Richard M. Stallman's avatar
Richard M. Stallman committed
750 751 752 753 754
  (if (and (not coding-system)
	   (not (keyboard-coding-system)))
      (setq coding-system default-keyboard-coding-system))
  (if coding-system
      (setq default-keyboard-coding-system coding-system))
755 756 757 758
  (set-keyboard-coding-system-internal coding-system)
  (encoded-kbd-mode (if coding-system 1 0)))

(defun set-buffer-process-coding-system (decoding encoding)
Richard M. Stallman's avatar
Richard M. Stallman committed
759
  "Set coding systems for the process associated with the current buffer.
760
DECODING is the coding system to be used to decode input from the process,
Richard M. Stallman's avatar
Richard M. Stallman committed
761 762 763
ENCODING is the coding system to be used to encode output to the process.

For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
Karl Heuer's avatar
Karl Heuer committed
764 765 766 767 768
  (interactive
   "zCoding-system for process input: \nzCoding-system for process output: ")
  (let ((proc (get-buffer-process (current-buffer))))
    (if (null proc)
	(error "no process")
769 770 771
      (check-coding-system decoding)
      (check-coding-system encoding)
      (set-process-coding-system proc decoding encoding)))
Karl Heuer's avatar
Karl Heuer committed
772 773
  (force-mode-line-update))

774 775
(defalias 'set-clipboard-coding-system 'set-selection-coding-system)

776
(defun set-selection-coding-system (coding-system)
777 778 779
  "Make CODING-SYSTEM used for communicating with other X clients .
When sending or receiving text via cut_buffer, selection, and clipboard,
the text is encoded or decoded by CODING-SYSTEM."
780
  (interactive "zCoding system for X selection: ")
781
  (check-coding-system coding-system)
782
  (setq selection-coding-system coding-system))
783

Karl Heuer's avatar
Karl Heuer committed
784
;; Coding system lastly specified by the command
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
;; set-next-selection-coding-system.
(defvar last-next-selection-coding-system nil)

(defun set-next-selection-coding-system (coding-system)
  "Make CODING-SYSTEM used for the next communication with other X clients.
This setting is effective for the next communication only."
  (interactive
   (list (read-coding-system
	  (if last-next-selection-coding-system
	      (format "Coding system for the next X selection (default, %S): "
		      last-next-selection-coding-system)
	    "Coding system for the next X selection: ")
	  last-next-selection-coding-system)))
  (if coding-system
      (setq last-next-selection-coding-system coding-system)
    (setq coding-system last-next-selection-coding-system))
  (check-coding-system coding-system)

  (setq next-selection-coding-system coding-system))

Karl Heuer's avatar
Karl Heuer committed
805
(defun set-coding-priority (arg)
806 807 808 809
  "Set priority of coding categories according to LIST.
LIST is a list of coding categories ordered by priority."
  (let ((l arg)
	(current-list (copy-sequence coding-category-list)))
Karl Heuer's avatar
Karl Heuer committed
810
    ;; Check the validity of ARG while deleting coding categories in
811 812 813 814 815 816 817 818
    ;; ARG from CURRENT-LIST.  We assume that CODING-CATEGORY-LIST
    ;; contains all coding categories.
    (while l
      (if (or (null (get (car l) 'coding-category-index))
	      (null (memq (car l) current-list)))
	  (error "Invalid or duplicated element in argument: %s" arg))
      (setq current-list (delq (car l) current-list))
      (setq l (cdr l)))
Karl Heuer's avatar
Karl Heuer committed
819
    ;; Update `coding-category-list' and return it.
Kenichi Handa's avatar
Kenichi Handa committed
820 821
    (setq coding-category-list (append arg current-list))
    (set-coding-priority-internal)))
Karl Heuer's avatar
Karl Heuer committed
822 823 824

;;; FILE I/O

825
(defvar auto-coding-alist
826 827
  '(("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\|tar\\)\\'" . no-conversion)
    ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\|TAR\\)\\'" . no-conversion))
828 829
  "Alist of filename patterns vs corresponding coding systems.
Each element looks like (REGEXP . CODING-SYSTEM).
830
A file whose name matches REGEXP is decoded by CODING-SYSTEM on reading.
831

832 833 834
The settings in this alist take priority over `coding:' tags
in the file (see the function `set-auto-coding')
and the contents of `file-coding-system-alist'.")
835

836 837 838 839
(defvar set-auto-coding-for-load nil
  "Non-nil means look for `load-coding' property instead of `coding'.
This is used for loading and byte-compiling Emacs Lisp files.")

840 841
(defun set-auto-coding (filename size)
  "Return coding system for a file FILENAME of which SIZE bytes follow point.
842 843
These bytes should include at least the first 1k of the file
and the last 3k of the file, but the middle may be omitted.
844

845 846 847
It checks FILENAME against the variable `auto-coding-alist'.
If FILENAME doesn't match any entries in the variable,
it checks for a `coding:' tag in the first one or two lines following
Karl Heuer's avatar
Karl Heuer committed
848
point.  If no `coding:' tag is found, it checks for local variables
849
list in the last 3K bytes out of the SIZE bytes.
850 851 852

The return value is the specified coding system,
or nil if nothing specified.
853

854
The variable `set-auto-coding-function' (which see) is set to this
855
function by default."
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
  (let ((alist auto-coding-alist)
	(case-fold-search (memq system-type '(vax-vms windows-nt)))
	coding-system)
    (while (and alist (not coding-system))
      (if (string-match (car (car alist)) filename)
	  (setq coding-system (cdr (car alist)))
	(setq alist (cdr alist))))

    (or coding-system
	(let* ((case-fold-search t)
	       (head-start (point))
	       (head-end (+ head-start (min size 1024)))
	       (tail-start (+ head-start (max (- size 3072) 0)))
	       (tail-end (+ head-start size))
	       coding-system head-found tail-found pos)
	  ;; Try a short cut by searching for the string "coding:"
Karl Heuer's avatar
Karl Heuer committed
872
	  ;; and for "unibyte:" at the head and tail of SIZE bytes.
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
	  (setq head-found (or (search-forward "coding:" head-end t)
			       (search-forward "unibyte:" head-end t)))
	  (if (and head-found (> head-found tail-start))
	      ;; Head and tail are overlapped.
	      (setq tail-found head-found)
	    (goto-char tail-start)
	    (setq tail-found (or (search-forward "coding:" tail-end t)
				 (search-forward "unibyte:" tail-end t))))

	  ;; At first check the head.
	  (when head-found
	    (goto-char head-start)
	    (setq pos (re-search-forward "[\n\r]" head-end t))
	    (if (and pos
		     (= (char-after head-start) ?#)
		     (= (char-after (1+ head-start)) ?!))
		;; If the file begins with "#!" (exec interpreter magic),
		;; look for coding frobs in the first two lines.  You cannot
		;; necessarily put them in the first line of such a file
		;; without screwing up the interpreter invocation.
		(setq pos (search-forward "\n" head-end t)))
	    (if pos (setq head-end pos))
	    (when (< head-found head-end)
	      (goto-char head-start)
	      (when (and set-auto-coding-for-load
			 (re-search-forward
			  "-\\*-\\(.*;\\)?[ \t]*unibyte:[ \t]*\\([^ ;]+\\)"
			  head-end t))
		(setq coding-system 'raw-text))
	      (when (and (not coding-system)
			 (re-search-forward
			  "-\\*-\\(.*;\\)?[ \t]*coding:[ \t]*\\([^ ;]+\\)"
			  head-end t))
		(setq coding-system (intern (match-string 2)))
		(or (coding-system-p coding-system)
		    (setq coding-system nil)))))

	  ;; If no coding: tag in the head, check the tail.
	  (when (and tail-found (not coding-system))
	    (goto-char tail-start)
	    (search-forward "\n\^L" nil t)
	    (if (re-search-forward
		 "^\\(.*\\)[ \t]*Local Variables:[ \t]*\\(.*\\)$" tail-end t)
		;; The prefix is what comes before "local variables:" in its
		;; line.  The suffix is what comes after "local variables:"
		;; in its line.
		(let* ((prefix (regexp-quote (match-string 1)))
		       (suffix (regexp-quote (match-string 2)))
		       (re-coding (concat
				   "^" prefix
				   "coding[ \t]*:[ \t]*\\([^ \t]+\\)[ \t]*"
				   suffix "$"))
		       (re-unibyte (concat
				    "^" prefix
				    "unibyte[ \t]*:[ \t]*\\([^ \t]+\\)[ \t]*"
				    suffix "$"))
		       (re-end (concat
				"^" prefix "end *:[ \t]*" suffix "$"))
		       (pos (point)))
		  (re-search-forward re-end tail-end 'move)
		  (setq tail-end (point))
		  (goto-char pos)
		  (when (and set-auto-coding-for-load
			     (re-search-forward re-unibyte tail-end t))
		    (setq coding-system 'raw-text))
		  (when (and (not coding-system)
			     (re-search-forward re-coding tail-end t))
		    (setq coding-system (intern (match-string 1)))
		    (or (coding-system-p coding-system)
			(setq coding-system nil))))))
	  coding-system))))
944 945

(setq set-auto-coding-function 'set-auto-coding)
946

Karl Heuer's avatar
Karl Heuer committed
947 948 949 950 951 952 953
;; Set buffer-file-coding-system of the current buffer after some text
;; is inserted.
(defun after-insert-file-set-buffer-file-coding-system (inserted)
  (if last-coding-system-used
      (let ((coding-system
	     (find-new-buffer-file-coding-system last-coding-system-used))
	    (modified-p (buffer-modified-p)))
954 955
	(when coding-system
	  (set-buffer-file-coding-system coding-system)
956 957
	  (if (and enable-multibyte-characters
		   (or (eq coding-system 'no-conversion)
958 959 960 961 962
		       (eq (coding-system-type coding-system) 5))
		   ;; If buffer was unmodified, we must be visiting it.
		   (not modified-p))
	      ;; For coding systems no-conversion and raw-text...,
	      ;; edit the buffer as unibyte.
963 964 965
	      (let ((pos-byte (position-bytes (+ (point) inserted))))
		(set-buffer-multibyte nil)
		(setq inserted (- pos-byte (position-bytes (point))))))
966
	  (set-buffer-modified-p modified-p))))
967
  inserted)
Karl Heuer's avatar
Karl Heuer committed
968

Karl Heuer's avatar
Karl Heuer committed
969 970
(add-hook 'after-insert-file-functions
	  'after-insert-file-set-buffer-file-coding-system)
Karl Heuer's avatar
Karl Heuer committed
971

972
;; The coding-spec and eol-type of coding-system returned is decided
Karl Heuer's avatar
Karl Heuer committed
973 974 975 976 977 978
;; independently in the following order.
;;	1. That of buffer-file-coding-system locally bound.
;;	2. That of CODING.

(defun find-new-buffer-file-coding-system (coding)
  "Return a coding system for a buffer when a file of CODING is inserted.
979 980
The local variable `buffer-file-coding-system' of the current buffer
is set to the returned value.
981
Return nil if there's no need of setting new buffer-file-coding-system."
Karl Heuer's avatar
Karl Heuer committed
982
  (let (local-coding local-eol
983
	found-coding found-eol
Karl Heuer's avatar
Karl Heuer committed
984 985 986 987 988
	new-coding new-eol)
    (if (null coding)
	;; Nothing found about coding.
	nil

989 990 991 992 993 994
      ;; Get information of `buffer-file-coding-system' in LOCAL-EOL
      ;; and LOCAL-CODING.
      (setq local-eol (coding-system-eol-type buffer-file-coding-system))
      (if (null (numberp local-eol))
	  ;; But eol-type is not yet set.
	  (setq local-eol nil))
995 996 997 998
      (if (and buffer-file-coding-system
	       (not (eq (coding-system-type buffer-file-coding-system) t)))
	  ;; This is not `undecided'.
	  (setq local-coding (coding-system-base buffer-file-coding-system)))
999 1000 1001

      (if (and (local-variable-p 'buffer-file-coding-system)
	       local-eol local-coding)
Karl Heuer's avatar
Karl Heuer committed
1002 1003 1004 1005
	  ;; The current buffer has already set full coding-system, we
	  ;; had better not change it.
	  nil

1006
	(setq found-eol (coding-system-eol-type coding))
Karl Heuer's avatar
Karl Heuer committed
1007
	(if (null (numberp found-eol))
1008 1009 1010
  	    ;; But eol-type is not found.
	    ;; If EOL conversions are inhibited, force unix eol-type.
	    (setq found-eol (if inhibit-eol-conversion 0)))
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
	(if (eq (coding-system-type coding) t)
	    (setq found-coding 'undecided)
	  (setq found-coding (coding-system-base coding)))

	(if (and (not found-eol) (eq found-coding 'undecided))
	    ;; No valid coding information found.
	    nil

	  ;; Some coding information (eol or text) found.

	  ;; The local setting takes precedence over the found one.
	  (setq new-coding (if (local-variable-p 'buffer-file-coding-system)
			       (or local-coding found-coding)
			     (or found-coding local-coding)))
	  (setq new-eol (if (local-variable-p 'buffer-file-coding-system)
			    (or local-eol found-eol)
			  (or found-eol local-eol)))

	  (let ((eol-type (coding-system-eol-type new-coding)))
	    (if (and (numberp new-eol) (vectorp eol-type))
		(aref eol-type new-eol)
	      new-coding)))))))
Karl Heuer's avatar
Karl Heuer committed
1033

1034 1035
(defun modify-coding-system-alist (target-type regexp coding-system)
  "Modify one of look up tables for finding a coding system on I/O operation.
1036 1037
There are three of such tables, `file-coding-system-alist',
`process-coding-system-alist', and `network-coding-system-alist'.
1038 1039

TARGET-TYPE specifies which of them to modify.
1040 1041
If it is `file', it affects `file-coding-system-alist' (which see).
If it is `process', it affects `process-coding-system-alist' (which see).
Karl Heuer's avatar
Karl Heuer committed
1042
If it is `network', it affects `network-coding-system-alist' (which see).
1043 1044 1045 1046 1047 1048 1049

REGEXP is a regular expression matching a target of I/O operation.
The target is a file name if TARGET-TYPE is `file', a program name if
TARGET-TYPE is `process', or a network service name or a port number
to connect to if TARGET-TYPE is `network'.

CODING-SYSTEM is a coding system to perform code conversion on the I/O
1050 1051 1052
operation, or a cons cell (DECODING . ENCODING) specifying the coding systems
for decoding and encoding respectively,
or a function symbol which, when called, returns such a cons cell."
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 <