(compilation-error-regexp-alist): Doc fix.
[bpt/emacs.git] / lisp / international / mule.el
CommitLineData
4ed46869
KH
1;;; mule.el --- basic commands for mulitilingual environment
2
2fd125a3
KH
3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
4;; Free Software Foundation, Inc.
5;; Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
6;; National Institute of Advanced Industrial Science and Technology (AIST)
7;; Registration Number H14PRO021
4ed46869
KH
8
9;; Keywords: mule, multilingual, character set, coding system
10
11;; This file is part of GNU Emacs.
12
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
15;; the Free Software Foundation; either version 2, or (at your option)
16;; any later version.
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
369314dc 24;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
4ed46869 27
60370d40
PJ
28;;; Commentary:
29
4ed46869
KH
30;;; Code:
31
d2542b42 32(defconst mule-version "5.0 (SAKAKI)" "\
4ed46869
KH
33Version number and name of this version of MULE (multilingual environment).")
34
35554641 35(defconst mule-version-date "1999.12.7" "\
4ed46869
KH
36Distribution date of this version of MULE (multilingual environment).")
37
38(defun load-with-code-conversion (fullname file &optional noerror nomessage)
0f69cb38
KH
39 "Execute a file of Lisp code named FILE whose absolute name is FULLNAME.
40The file contents are decoded before evaluation if necessary.
4ed46869
KH
41If optional second arg NOERROR is non-nil,
42 report no error if FILE doesn't exist.
43Print messages at start and end of loading unless
44 optional third arg NOMESSAGE is non-nil.
45Return t if file exists."
46 (if (null (file-readable-p fullname))
47 (and (null noerror)
48 (signal 'file-error (list "Cannot open load file" file)))
49 ;; Read file with code conversion, and then eval.
50 (let* ((buffer
51 ;; To avoid any autoloading, set default-major-mode to
52 ;; fundamental-mode.
88162676
RS
53 ;; So that we don't get completely screwed if the
54 ;; file is encoded in some complicated character set,
55 ;; read it with real decoding, as a multibyte buffer,
56 ;; even if this is a --unibyte Emacs session.
57 (let ((default-major-mode 'fundamental-mode)
58 (default-enable-multibyte-characters t))
4ed46869
KH
59 ;; We can't use `generate-new-buffer' because files.el
60 ;; is not yet loaded.
61 (get-buffer-create (generate-new-buffer-name " *load*"))))
db5cae4b
SM
62 (load-in-progress t)
63 (source (save-match-data (string-match "\\.el\\'" fullname))))
64 (unless nomessage
65 (if source
66 (message "Loading %s (source)..." file)
67 (message "Loading %s..." file)))
68 (when purify-flag
4c86cca0 69 (push file preloaded-file-list))
4ed46869 70 (unwind-protect
a6acd8a2 71 (let ((load-file-name fullname)
1c4cc63a 72 (set-auto-coding-for-load t)
a6acd8a2 73 (inhibit-file-name-operation nil))
4ed46869
KH
74 (save-excursion
75 (set-buffer buffer)
76 (insert-file-contents fullname)
7d276780
EZ
77 ;; If the loaded file was inserted with no-conversion or
78 ;; raw-text coding system, make the buffer unibyte.
79 ;; Otherwise, eval-buffer might try to interpret random
80 ;; binary junk as multibyte characters.
81 (if (and enable-multibyte-characters
82 (or (eq (coding-system-type last-coding-system-used) 5)
83 (eq last-coding-system-used 'no-conversion)))
84 (set-buffer-multibyte nil))
4ed46869
KH
85 ;; Make `kill-buffer' quiet.
86 (set-buffer-modified-p nil))
0f69cb38 87 ;; Have the original buffer current while we eval.
01ae35c1
RS
88 (eval-buffer buffer nil
89 ;; This is compatible with what `load' does.
90 (if purify-flag file fullname)
88162676
RS
91 ;; If this Emacs is running with --unibyte,
92 ;; convert multibyte strings to unibyte
93 ;; after reading them.
ba74e833 94;; (not default-enable-multibyte-characters)
8dd08b5b 95 nil t
ba74e833 96 ))
cfc70cdf
RS
97 (let (kill-buffer-hook kill-buffer-query-functions)
98 (kill-buffer buffer)))
4ed46869 99 (let ((hook (assoc file after-load-alist)))
db5cae4b
SM
100 (when hook
101 (mapcar (function eval) (cdr hook))))
102 (unless (or nomessage noninteractive)
103 (if source
104 (message "Loading %s (source)...done" file)
105 (message "Loading %s...done" file)))
4ed46869
KH
106 t)))
107
108;; API (Application Program Interface) for charsets.
109
2e02a76f 110(defsubst charset-quoted-standard-p (obj)
521d4010 111 "Return t if OBJ is a quoted symbol, and is the name of a standard charset."
2e02a76f
RS
112 (and (listp obj) (eq (car obj) 'quote)
113 (symbolp (car-safe (cdr obj)))
114 (let ((vector (get (car-safe (cdr obj)) 'charset)))
115 (and (vectorp vector)
116 (< (aref vector 0) 160)))))
4ed46869
KH
117
118(defsubst charsetp (object)
e4a7fdfc 119 "T if OBJECT is a charset."
4ed46869
KH
120 (and (symbolp object) (vectorp (get object 'charset))))
121
122(defsubst charset-info (charset)
123 "Return a vector of information of CHARSET.
124The elements of the vector are:
125 CHARSET-ID, BYTES, DIMENSION, CHARS, WIDTH, DIRECTION,
126 LEADING-CODE-BASE, LEADING-CODE-EXT,
127 ISO-FINAL-CHAR, ISO-GRAPHIC-PLANE,
128 REVERSE-CHARSET, SHORT-NAME, LONG-NAME, DESCRIPTION,
129 PLIST,
130where
131CHARSET-ID (integer) is the identification number of the charset.
aa8bb645
KH
132BYTES (integer) is the length of multi-byte form of a character in
133 the charset: one of 1, 2, 3, and 4.
4ed46869
KH
134DIMENSION (integer) is the number of bytes to represent a character of
135the charset: 1 or 2.
136CHARS (integer) is the number of characters in a dimension: 94 or 96.
4ed46869
KH
137WIDTH (integer) is the number of columns a character in the charset
138 occupies on the screen: one of 0, 1, and 2.
139DIRECTION (integer) is the rendering direction of characters in the
08b4ace5
KH
140 charset when rendering. If 0, render from left to right, else
141 render from right to left.
4ed46869
KH
142LEADING-CODE-BASE (integer) is the base leading-code for the
143 charset.
144LEADING-CODE-EXT (integer) is the extended leading-code for the
145 charset. All charsets of less than 0xA0 has the value 0.
146ISO-FINAL-CHAR (character) is the final character of the
7dd4c92d
KH
147 corresponding ISO 2022 charset. If the charset is not assigned
148 any final character, the value is -1.
4ed46869
KH
149ISO-GRAPHIC-PLANE (integer) is the graphic plane to be invoked
150 while encoding to variants of ISO 2022 coding system, one of the
151 following: 0/graphic-plane-left(GL), 1/graphic-plane-right(GR).
7dd4c92d 152 If the charset is not assigned any final character, the value is -1.
4ed46869
KH
153REVERSE-CHARSET (integer) is the charset which differs only in
154 LEFT-TO-RIGHT value from the charset. If there's no such a
155 charset, the value is -1.
156SHORT-NAME (string) is the short name to refer to the charset.
157LONG-NAME (string) is the long name to refer to the charset
158DESCRIPTION (string) is the description string of the charset.
159PLIST (property list) may contain any type of information a user
160 want to put and get by functions `put-charset-property' and
161 `get-charset-property' respectively."
162 (get charset 'charset))
163
40c81f74
PE
164;; It is better not to use backquote in this file,
165;; because that makes a bootstrapping problem
166;; if you need to recompile all the Lisp files using interpreted code.
167
4ed46869
KH
168(defmacro charset-id (charset)
169 "Return charset identification number of CHARSET."
2e02a76f 170 (if (charset-quoted-standard-p charset)
4ed46869 171 (aref (charset-info (nth 1 charset)) 0)
40c81f74 172 (list 'aref (list 'charset-info charset) 0)))
4ed46869
KH
173
174(defmacro charset-bytes (charset)
900dc6e3
KH
175 "Return bytes of CHARSET.
176See the function `charset-info' for more detail."
2e02a76f 177 (if (charset-quoted-standard-p charset)
4ed46869 178 (aref (charset-info (nth 1 charset)) 1)
40c81f74 179 (list 'aref (list 'charset-info charset) 1)))
4ed46869
KH
180
181(defmacro charset-dimension (charset)
900dc6e3
KH
182 "Return dimension of CHARSET.
183See the function `charset-info' for more detail."
2e02a76f 184 (if (charset-quoted-standard-p charset)
4ed46869 185 (aref (charset-info (nth 1 charset)) 2)
40c81f74 186 (list 'aref (list 'charset-info charset) 2)))
4ed46869
KH
187
188(defmacro charset-chars (charset)
900dc6e3
KH
189 "Return character numbers contained in a dimension of CHARSET.
190See the function `charset-info' for more detail."
2e02a76f 191 (if (charset-quoted-standard-p charset)
4ed46869 192 (aref (charset-info (nth 1 charset)) 3)
40c81f74 193 (list 'aref (list 'charset-info charset) 3)))
4ed46869
KH
194
195(defmacro charset-width (charset)
900dc6e3
KH
196 "Return width (how many column occupied on a screen) of CHARSET.
197See the function `charset-info' for more detail."
2e02a76f 198 (if (charset-quoted-standard-p charset)
4ed46869 199 (aref (charset-info (nth 1 charset)) 4)
40c81f74 200 (list 'aref (list 'charset-info charset) 4)))
4ed46869
KH
201
202(defmacro charset-direction (charset)
900dc6e3
KH
203 "Return direction of CHARSET.
204See the function `charset-info' for more detail."
2e02a76f 205 (if (charset-quoted-standard-p charset)
4ed46869 206 (aref (charset-info (nth 1 charset)) 5)
40c81f74 207 (list 'aref (list 'charset-info charset) 5)))
4ed46869
KH
208
209(defmacro charset-iso-final-char (charset)
900dc6e3
KH
210 "Return final char of CHARSET.
211See the function `charset-info' for more detail."
2e02a76f 212 (if (charset-quoted-standard-p charset)
4ed46869 213 (aref (charset-info (nth 1 charset)) 8)
40c81f74 214 (list 'aref (list 'charset-info charset) 8)))
4ed46869
KH
215
216(defmacro charset-iso-graphic-plane (charset)
900dc6e3
KH
217 "Return graphic plane of CHARSET.
218See the function `charset-info' for more detail."
2e02a76f 219 (if (charset-quoted-standard-p charset)
4ed46869 220 (aref (charset-info (nth 1 charset)) 9)
40c81f74 221 (list 'aref (list 'charset-info charset) 9)))
4ed46869
KH
222
223(defmacro charset-reverse-charset (charset)
900dc6e3
KH
224 "Return reverse charset of CHARSET.
225See the function `charset-info' for more detail."
2e02a76f 226 (if (charset-quoted-standard-p charset)
4ed46869 227 (aref (charset-info (nth 1 charset)) 10)
40c81f74 228 (list 'aref (list 'charset-info charset) 10)))
4ed46869
KH
229
230(defmacro charset-short-name (charset)
900dc6e3
KH
231 "Return short name of CHARSET.
232See the function `charset-info' for more detail."
2e02a76f 233 (if (charset-quoted-standard-p charset)
4ed46869 234 (aref (charset-info (nth 1 charset)) 11)
40c81f74 235 (list 'aref (list 'charset-info charset) 11)))
4ed46869
KH
236
237(defmacro charset-long-name (charset)
900dc6e3
KH
238 "Return long name of CHARSET.
239See the function `charset-info' for more detail."
2e02a76f 240 (if (charset-quoted-standard-p charset)
4ed46869 241 (aref (charset-info (nth 1 charset)) 12)
40c81f74 242 (list 'aref (list 'charset-info charset) 12)))
4ed46869
KH
243
244(defmacro charset-description (charset)
0611934b 245 "Return description of CHARSET.
900dc6e3 246See the function `charset-info' for more detail."
2e02a76f 247 (if (charset-quoted-standard-p charset)
4ed46869 248 (aref (charset-info (nth 1 charset)) 13)
40c81f74 249 (list 'aref (list 'charset-info charset) 13)))
4ed46869
KH
250
251(defmacro charset-plist (charset)
900dc6e3
KH
252 "Return list charset property of CHARSET.
253See the function `charset-info' for more detail."
40c81f74
PE
254 (list 'aref
255 (if (charset-quoted-standard-p charset)
256 (charset-info (nth 1 charset))
257 (list 'charset-info charset))
258 14))
4ed46869
KH
259
260(defun set-charset-plist (charset plist)
e8dd0160 261 "Set CHARSET's property list to PLIST, and return PLIST."
4ed46869
KH
262 (aset (charset-info charset) 14 plist))
263
d3e7e7cf
EZ
264(defun make-char (charset &optional code1 code2)
265 "Return a character of CHARSET whose position codes are CODE1 and CODE2.
f98e2797 266CODE1 and CODE2 are optional, but if you don't supply
a9fb0b58
KH
267sufficient position codes, return a generic character which stands for
268all characters or group of characters in the character set.
d3e7e7cf 269A generic character can be used to index a char table (e.g. syntax-table).
9ff05eae
KH
270
271Such character sets as ascii, eight-bit-control, and eight-bit-graphic
272don't have corresponding generic characters. If CHARSET is one of
273them and you don't supply CODE1, return the character of the smallest
274code in CHARSET.
275
6fb7766c
DL
276If CODE1 or CODE2 are invalid (out of range), this function signals an
277error. However, the eighth bit of both CODE1 and CODE2 is zeroed
278before they are used to index CHARSET. Thus you may use, say, the
279actual ISO 8859 character code rather than subtracting 128, as you
280would need to index the corresponding Emacs charset."
636799f2 281 (make-char-internal (charset-id charset) code1 code2))
a6acd8a2
KH
282
283(put 'make-char 'byte-compile
521d4010 284 (function
a6acd8a2
KH
285 (lambda (form)
286 (let ((charset (nth 1 form)))
287 (if (charset-quoted-standard-p charset)
288 (byte-compile-normal-call
289 (cons 'make-char-internal
290 (cons (charset-id (nth 1 charset)) (nthcdr 2 form))))
291 (byte-compile-normal-call
292 (cons 'make-char-internal
293 (cons (list 'charset-id charset) (nthcdr 2 form)))))))))
4ed46869 294
d3675a42 295(defun charset-list ()
900dc6e3
KH
296 "Return list of charsets ever defined.
297
d3675a42 298This function is provided for backward compatibility.
900dc6e3 299Now we have the variable `charset-list'."
d3675a42
KH
300 charset-list)
301
13d5617d
KH
302(defsubst generic-char-p (char)
303 "Return t if and only if CHAR is a generic character.
521d4010 304See also the documentation of `make-char'."
1d935669
KH
305 (and (>= char 0400)
306 (let ((l (split-char char)))
307 (and (or (= (nth 1 l) 0) (eq (nth 2 l) 0))
308 (not (eq (car l) 'composition))))))
69eba008 309
cc57cc54 310(defun decode-char (ccs code-point &optional restriction)
7f341749 311 "Return character specified by coded character set CCS and CODE-POINT in it.
cc57cc54 312Return nil if such a character is not supported.
e76938e7 313Currently the only supported coded character set is `ucs' (ISO/IEC
9fb1b1a8 31410646: Universal Multi-Octet Coded Character Set), and the result is
0c76a98d
KH
315translated through the translation-table named
316`utf-translation-table-for-decode' or the translation-hash-table named
317`utf-subst-table-for-decode'.
cc57cc54
KH
318
319Optional argument RESTRICTION specifies a way to map the pair of CCS
e7fea150 320and CODE-POINT to a character. Currently not supported and just ignored."
9fb1b1a8
DL
321 (cond
322 ((eq ccs 'ucs)
8458c8b9 323 (or (utf-lookup-subst-table-for-decode code-point)
0c76a98d
KH
324 (let ((c (cond
325 ((< code-point 160)
326 code-point)
327 ((< code-point 256)
328 (make-char 'latin-iso8859-1 code-point))
329 ((< code-point #x2500)
330 (setq code-point (- code-point #x0100))
331 (make-char 'mule-unicode-0100-24ff
332 (+ (/ code-point 96) 32) (+ (% code-point 96) 32)))
333 ((< code-point #x3400)
334 (setq code-point (- code-point #x2500))
335 (make-char 'mule-unicode-2500-33ff
336 (+ (/ code-point 96) 32) (+ (% code-point 96) 32)))
337 ((and (>= code-point #xe000) (< code-point #x10000))
338 (setq code-point (- code-point #xe000))
339 (make-char 'mule-unicode-e000-ffff
340 (+ (/ code-point 96) 32)
341 (+ (% code-point 96) 32))))))
342 (when c
343 (or (aref (get 'utf-translation-table-for-decode
344 'translation-table) c)
345 c)))))))
cc57cc54
KH
346
347(defun encode-char (char ccs &optional restriction)
7f341749 348 "Return code-point in coded character set CCS that corresponds to CHAR.
cc57cc54 349Return nil if CHAR is not included in CCS.
e76938e7 350Currently the only supported coded character set is `ucs' (ISO/IEC
9fb1b1a8 35110646: Universal Multi-Octet Coded Character Set), and CHAR is first
0c76a98d
KH
352translated through the translation-table named
353`utf-translation-table-for-encode' or the translation-hash-table named
354`utf-subst-table-for-encode'.
7f341749
KH
355
356CHAR should be in one of these charsets:
cc57cc54 357 ascii, latin-iso8859-1, mule-unicode-0100-24ff, mule-unicode-2500-33ff,
6ba9b20b 358 mule-unicode-e000-ffff, eight-bit-control
cc57cc54
KH
359Otherwise, return nil.
360
361Optional argument RESTRICTION specifies a way to map CHAR to a
362code-point in CCS. Currently not supported and just ignored."
363 (let* ((split (split-char char))
9fb1b1a8
DL
364 (charset (car split))
365 trans)
cc57cc54 366 (cond ((eq ccs 'ucs)
8458c8b9 367 (or (utf-lookup-subst-table-for-encode char)
0c76a98d
KH
368 (let ((table (get 'utf-translation-table-for-encode
369 'translation-table)))
370 (setq trans (aref table char))
371 (if trans
372 (setq split (split-char trans)
373 charset (car split)))
374 (cond ((eq charset 'ascii)
bb55c6c9 375 (or trans char))
0c76a98d
KH
376 ((eq charset 'latin-iso8859-1)
377 (+ (nth 1 split) 128))
378 ((eq charset 'mule-unicode-0100-24ff)
379 (+ #x0100 (+ (* (- (nth 1 split) 32) 96)
380 (- (nth 2 split) 32))))
381 ((eq charset 'mule-unicode-2500-33ff)
382 (+ #x2500 (+ (* (- (nth 1 split) 32) 96)
383 (- (nth 2 split) 32))))
384 ((eq charset 'mule-unicode-e000-ffff)
385 (+ #xe000 (+ (* (- (nth 1 split) 32) 96)
386 (- (nth 2 split) 32))))
387 ((eq charset 'eight-bit-control)
388 char))))))))
cc57cc54 389
0269ddfb 390\f
e76938e7 391;; Coding system stuff
4ed46869 392
8057896b 393;; Coding system is a symbol that has the property `coding-system'.
4ed46869 394;;
8057896b
KH
395;; The value of the property `coding-system' is a vector of the
396;; following format:
d3675a42 397;; [TYPE MNEMONIC DOC-STRING PLIST FLAGS]
8057896b 398;; We call this vector as coding-spec. See comments in src/coding.c
521d4010 399;; for more detail.
8057896b
KH
400
401(defconst coding-spec-type-idx 0)
402(defconst coding-spec-mnemonic-idx 1)
403(defconst coding-spec-doc-string-idx 2)
0269ddfb 404(defconst coding-spec-plist-idx 3)
8057896b
KH
405(defconst coding-spec-flags-idx 4)
406
a6acd8a2
KH
407;; PLIST is a property list of a coding system. To share PLIST among
408;; alias coding systems, a coding system has PLIST in coding-spec
409;; instead of having it in normal property list of Lisp symbol.
410;; Here's a list of coding system properties currently being used.
0269ddfb
KH
411;;
412;; o coding-category
413;;
414;; The value is a coding category the coding system belongs to. The
521d4010 415;; function `make-coding-system' sets this value automatically
1b46a680 416;; unless its argument PROPERTIES specifies this property.
4ed46869 417;;
0269ddfb 418;; o alias-coding-systems
4ed46869 419;;
0269ddfb
KH
420;; The value is a list of coding systems of the same alias group. The
421;; first element is the coding system made at first, which we call as
1b46a680
KH
422;; `base coding system'. The function `make-coding-system' sets this
423;; value automatically and `define-coding-system-alias' updates it.
0269ddfb 424;;
3c948dde
KH
425;; See the documentation of make-coding-system for the meanings of the
426;; following properties.
4ed46869 427;;
3c948dde 428;; o post-read-conversion
0269ddfb 429;; o pre-write-conversion
f967223b 430;; o translation-table-for-decode
f967223b 431;; o translation-table-for-encode
c11a8f77 432;; o safe-chars
a6acd8a2 433;; o safe-charsets
b25eef20 434;; o mime-charset
c76b5c99 435;; o valid-codes (meaningful only for a coding system based on CCL)
c76b5c99 436
0269ddfb 437
0269ddfb 438(defsubst coding-system-spec (coding-system)
521d4010 439 "Return coding-spec of CODING-SYSTEM."
0269ddfb 440 (get (check-coding-system coding-system) 'coding-system))
4ed46869 441
4ed46869 442(defun coding-system-type (coding-system)
0269ddfb
KH
443 "Return the coding type of CODING-SYSTEM.
444A coding type is an integer value indicating the encoding method
445of CODING-SYSTEM. See the function `make-coding-system' for more detail."
2653e2a7 446 (aref (coding-system-spec coding-system) coding-spec-type-idx))
4ed46869 447
4ed46869 448(defun coding-system-mnemonic (coding-system)
0269ddfb 449 "Return the mnemonic character of CODING-SYSTEM.
6e2c8840
KH
450The mnemonic character of a coding system is used in mode line
451to indicate the coding system. If the arg is nil, return ?-."
452 (let ((spec (coding-system-spec coding-system)))
453 (if spec (aref spec coding-spec-mnemonic-idx) ?-)))
4ed46869 454
8057896b 455(defun coding-system-doc-string (coding-system)
0269ddfb 456 "Return the documentation string for CODING-SYSTEM."
2653e2a7 457 (aref (coding-system-spec coding-system) coding-spec-doc-string-idx))
4ed46869 458
d3675a42 459(defun coding-system-plist (coding-system)
0269ddfb 460 "Return the property list of CODING-SYSTEM."
2653e2a7 461 (aref (coding-system-spec coding-system) coding-spec-plist-idx))
d3675a42 462
4ed46869 463(defun coding-system-flags (coding-system)
0269ddfb
KH
464 "Return `flags' of CODING-SYSTEM.
465A `flags' of a coding system is a vector of length 32 indicating detailed
466information of a coding system. See the function `make-coding-system'
467for more detail."
2653e2a7 468 (aref (coding-system-spec coding-system) coding-spec-flags-idx))
0269ddfb
KH
469
470(defun coding-system-get (coding-system prop)
471 "Extract a value from CODING-SYSTEM's property list for property PROP."
472 (plist-get (coding-system-plist coding-system) prop))
473
474(defun coding-system-put (coding-system prop val)
475 "Change value in CODING-SYSTEM's property list PROP to VAL."
476 (let ((plist (coding-system-plist coding-system)))
477 (if plist
478 (plist-put plist prop val)
2653e2a7
KH
479 (aset (coding-system-spec coding-system) coding-spec-plist-idx
480 (list prop val)))))
0269ddfb
KH
481
482(defun coding-system-category (coding-system)
72f73748
DL
483 "Return the coding category of CODING-SYSTEM.
484See also `coding-category-list'."
0269ddfb
KH
485 (coding-system-get coding-system 'coding-category))
486
487(defun coding-system-base (coding-system)
488 "Return the base coding system of CODING-SYSTEM.
d9e3229d
KH
489A base coding system is what made by `make-coding-system'.
490Any alias nor subsidiary coding systems are not base coding system."
0269ddfb
KH
491 (car (coding-system-get coding-system 'alias-coding-systems)))
492
0269ddfb
KH
493;; Coding system also has a property `eol-type'.
494;;
495;; This property indicates how the coding system handles end-of-line
496;; format. The value is integer 0, 1, 2, or a vector of three coding
497;; systems. Each integer value 0, 1, and 2 indicates the format of
498;; end-of-line LF, CRLF, and CR respectively. A vector value
499;; indicates that the format of end-of-line should be detected
500;; automatically. Nth element of the vector is the subsidiary coding
501;; system whose `eol-type' property is N.
4ed46869 502
8057896b 503(defun coding-system-eol-type (coding-system)
0269ddfb
KH
504 "Return eol-type of CODING-SYSTEM.
505An eol-type is integer 0, 1, 2, or a vector of coding systems.
4ed46869 506
0269ddfb
KH
507Integer values 0, 1, and 2 indicate a format of end-of-line; LF,
508CRLF, and CR respectively.
509
510A vector value indicates that a format of end-of-line should be
511detected automatically. Nth element of the vector is the subsidiary
512coding system whose eol-type is N."
513 (get coding-system 'eol-type))
bd882697 514
2e729bfa
JB
515(defun coding-system-eol-type-mnemonic (coding-system)
516 "Return the string indicating end-of-line format of CODING-SYSTEM."
517 (let* ((eol-type (coding-system-eol-type coding-system))
f4f00827 518 (val (cond ((eq eol-type 0) eol-mnemonic-unix)
2e729bfa
JB
519 ((eq eol-type 1) eol-mnemonic-dos)
520 ((eq eol-type 2) eol-mnemonic-mac)
f4f00827 521 (t eol-mnemonic-undecided))))
2e729bfa
JB
522 (if (stringp val)
523 val
524 (char-to-string val))))
525
857ea15c
AS
526(defun coding-system-lessp (x y)
527 (cond ((eq x 'no-conversion) t)
528 ((eq y 'no-conversion) nil)
529 ((eq x 'emacs-mule) t)
530 ((eq y 'emacs-mule) nil)
531 ((eq x 'undecided) t)
532 ((eq y 'undecided) nil)
533 (t (let ((c1 (coding-system-mnemonic x))
534 (c2 (coding-system-mnemonic y)))
535 (or (< (downcase c1) (downcase c2))
536 (and (not (> (downcase c1) (downcase c2)))
537 (< c1 c2)))))))
538
5e2e859a
KH
539(defun coding-system-equal (coding-system-1 coding-system-2)
540 "Return t if and only if CODING-SYSTEM-1 and CODING-SYSTEM-2 are identical.
541Two coding systems are identical if two symbols are equal
542or one is an alias of the other."
543 (or (eq coding-system-1 coding-system-2)
544 (and (equal (coding-system-spec coding-system-1)
545 (coding-system-spec coding-system-2))
546 (let ((eol-type-1 (coding-system-eol-type coding-system-1))
547 (eol-type-2 (coding-system-eol-type coding-system-2)))
548 (or (eq eol-type-1 eol-type-2)
549 (and (vectorp eol-type-1) (vectorp eol-type-2)))))))
550
857ea15c 551(defun add-to-coding-system-list (coding-system)
521d4010 552 "Add CODING-SYSTEM to `coding-system-list' while keeping it sorted."
857ea15c
AS
553 (if (or (null coding-system-list)
554 (coding-system-lessp coding-system (car coding-system-list)))
555 (setq coding-system-list (cons coding-system coding-system-list))
556 (let ((len (length coding-system-list))
557 mid (tem coding-system-list))
558 (while (> len 1)
559 (setq mid (nthcdr (/ len 2) tem))
560 (if (coding-system-lessp (car mid) coding-system)
561 (setq tem mid
562 len (- len (/ len 2)))
563 (setq len (/ len 2))))
564 (setcdr tem (cons coding-system (cdr tem))))))
565
80a7463d 566(defun coding-system-list (&optional base-only)
c11a8f77
KH
567 "Return a list of all existing non-subsidiary coding systems.
568If optional arg BASE-ONLY is non-nil, only base coding systems are listed.
569The value doesn't include subsidiary coding systems which are what
570made from bases and aliases automatically for various end-of-line
571formats (e.g. iso-latin-1-unix, koi8-r-dos)."
80a7463d
KH
572 (let* ((codings (copy-sequence coding-system-list))
573 (tail (cons nil codings)))
574 ;; Remove subsidiary coding systems (eol variants) and alias
575 ;; coding systems (if necessary).
576 (while (cdr tail)
577 (let* ((coding (car (cdr tail)))
578 (aliases (coding-system-get coding 'alias-coding-systems)))
579 (if (or
580 ;; CODING is an eol variant if not in ALIASES.
581 (not (memq coding aliases))
582 ;; CODING is an alias if it is not car of ALIASES.
583 (and base-only (not (eq coding (car aliases)))))
584 (setcdr tail (cdr (cdr tail)))
585 (setq tail (cdr tail)))))
586 codings))
587
6fb7766c
DL
588(defun map-charset-chars (func charset)
589 "Use FUNC to map over all characters in CHARSET for side effects.
590FUNC is a function of two args, the start and end (inclusive) of a
591character code range. Thus FUNC should iterate over [START, END]."
592 (let* ((dim (charset-dimension charset))
593 (chars (charset-chars charset))
594 (start (if (= chars 94)
595 33
596 32)))
597 (if (= dim 1)
598 (funcall func
599 (make-char charset start)
600 (make-char charset (+ start chars -1)))
601 (dotimes (i chars)
602 (funcall func
603 (make-char charset (+ i start) start)
604 (make-char charset (+ i start) (+ start chars -1)))))))
605
9857367f 606(defalias 'register-char-codings 'ignore "")
620956ca 607(make-obsolete 'register-char-codings
9857367f 608 "it exists just for backward compatibility, and does nothing."
620956ca
KH
609 "21.3")
610
611(defconst char-coding-system-table nil
612 "This is an obsolete variable.
613It exists just for backward compatibility, and the value is always nil.")
c11a8f77 614
6e9722b0 615(defun make-subsidiary-coding-system (coding-system)
521d4010 616 "Make subsidiary coding systems (eol-type variants) of CODING-SYSTEM."
0269ddfb
KH
617 (let ((coding-spec (coding-system-spec coding-system))
618 (subsidiaries (vector (intern (format "%s-unix" coding-system))
8057896b
KH
619 (intern (format "%s-dos" coding-system))
620 (intern (format "%s-mac" coding-system))))
0269ddfb
KH
621 (i 0)
622 temp)
8057896b 623 (while (< i 3)
0269ddfb 624 (put (aref subsidiaries i) 'coding-system coding-spec)
8057896b 625 (put (aref subsidiaries i) 'eol-type i)
857ea15c 626 (add-to-coding-system-list (aref subsidiaries i))
0269ddfb
KH
627 (setq coding-system-alist
628 (cons (list (symbol-name (aref subsidiaries i)))
629 coding-system-alist))
8057896b
KH
630 (setq i (1+ i)))
631 subsidiaries))
4ed46869 632
50c29104
KH
633(defun transform-make-coding-system-args (name type &optional doc-string props)
634 "For internal use only.
635Transform XEmacs style args for `make-coding-system' to Emacs style.
636Value is a list of transformed arguments."
637 (let ((mnemonic (string-to-char (or (plist-get props 'mnemonic) "?")))
638 (eol-type (plist-get props 'eol-type))
639 properties tmp)
640 (cond
641 ((eq eol-type 'lf) (setq eol-type 'unix))
642 ((eq eol-type 'crlf) (setq eol-type 'dos))
643 ((eq eol-type 'cr) (setq eol-type 'mac)))
644 (if (setq tmp (plist-get props 'post-read-conversion))
645 (setq properties (plist-put properties 'post-read-conversion tmp)))
646 (if (setq tmp (plist-get props 'pre-write-conversion))
647 (setq properties (plist-put properties 'pre-write-conversion tmp)))
648 (cond
f4a012a6
KH
649 ((eq type 'shift-jis)
650 `(,name 1 ,mnemonic ,doc-string () ,properties ,eol-type))
651 ((eq type 'iso2022) ; This is not perfect.
652 (if (plist-get props 'escape-quoted)
653 (error "escape-quoted is not supported: %S"
654 `(,name ,type ,doc-string ,props)))
655 (let ((g0 (plist-get props 'charset-g0))
656 (g1 (plist-get props 'charset-g1))
657 (g2 (plist-get props 'charset-g2))
658 (g3 (plist-get props 'charset-g3))
659 (use-roman
660 (and
661 (eq (cadr (assoc 'latin-jisx0201
662 (plist-get props 'input-charset-conversion)))
663 'ascii)
664 (eq (cadr (assoc 'ascii
665 (plist-get props 'output-charset-conversion)))
666 'latin-jisx0201)))
667 (use-oldjis
668 (and
669 (eq (cadr (assoc 'japanese-jisx0208-1978
670 (plist-get props 'input-charset-conversion)))
671 'japanese-jisx0208)
672 (eq (cadr (assoc 'japanese-jisx0208
673 (plist-get props 'output-charset-conversion)))
674 'japanese-jisx0208-1978))))
675 (if (charsetp g0)
676 (if (plist-get props 'force-g0-on-output)
677 (setq g0 `(nil ,g0))
678 (setq g0 `(,g0 t))))
679 (if (charsetp g1)
680 (if (plist-get props 'force-g1-on-output)
681 (setq g1 `(nil ,g1))
682 (setq g1 `(,g1 t))))
683 (if (charsetp g2)
684 (if (plist-get props 'force-g2-on-output)
685 (setq g2 `(nil ,g2))
686 (setq g2 `(,g2 t))))
687 (if (charsetp g3)
688 (if (plist-get props 'force-g3-on-output)
689 (setq g3 `(nil ,g3))
690 (setq g3 `(,g3 t))))
691 `(,name 2 ,mnemonic ,doc-string
692 (,g0 ,g1 ,g2 ,g3
693 ,(plist-get props 'short)
694 ,(not (plist-get props 'no-ascii-eol))
695 ,(not (plist-get props 'no-ascii-cntl))
696 ,(plist-get props 'seven)
697 t
698 ,(not (plist-get props 'lock-shift))
699 ,use-roman
700 ,use-oldjis
701 ,(plist-get props 'no-iso6429)
702 nil nil nil nil)
703 ,properties ,eol-type)))
704 ((eq type 'big5)
705 `(,name 3 ,mnemonic ,doc-string () ,properties ,eol-type))
50c29104 706 ((eq type 'ccl)
f4a012a6 707 `(,name 4 ,mnemonic ,doc-string
50c29104 708 (,(plist-get props 'decode) . ,(plist-get props 'encode))
f4a012a6 709 ,properties ,eol-type))
50c29104 710 (t
f4a012a6 711 (error "unsupported XEmacs style make-coding-style arguments: %S"
50c29104
KH
712 `(,name ,type ,doc-string ,props))))))
713
8057896b 714(defun make-coding-system (coding-system type mnemonic doc-string
1b46a680
KH
715 &optional
716 flags
717 properties
718 eol-type)
3bb1accb 719 "Define a new coding system CODING-SYSTEM (symbol).
521d4010 720Remaining arguments are TYPE, MNEMONIC, DOC-STRING, FLAGS (optional),
d9e3229d 721and PROPERTIES (optional) which construct a coding-spec of CODING-SYSTEM
a6acd8a2 722in the following format:
0269ddfb 723 [TYPE MNEMONIC DOC-STRING PLIST FLAGS]
3bb1accb
KH
724
725TYPE is an integer value indicating the type of the coding system as follows:
4ed46869 726 0: Emacs internal format,
d9f6dfe6 727 1: Shift-JIS (or MS-Kanji) used mainly on Japanese PCs,
4ed46869 728 2: ISO-2022 including many variants,
d9f6dfe6 729 3: Big5 used mainly on Chinese PCs,
cd9c3177 730 4: private, CCL programs provide encoding/decoding algorithm,
521d4010 731 5: Raw-text, which means that text contains random 8-bit codes.
0269ddfb 732
3bb1accb 733MNEMONIC is a character to be displayed on mode line for the coding system.
0269ddfb 734
3bb1accb 735DOC-STRING is a documentation string for the coding system.
0269ddfb 736
3bb1accb 737FLAGS specifies more detailed information of the coding system as follows:
d6d6d592 738
3bb1accb 739 If TYPE is 2 (ISO-2022), FLAGS is a list of these elements:
4ed46869
KH
740 CHARSET0, CHARSET1, CHARSET2, CHARSET3, SHORT-FORM,
741 ASCII-EOL, ASCII-CNTL, SEVEN, LOCKING-SHIFT, SINGLE-SHIFT,
d6d6d592 742 USE-ROMAN, USE-OLDJIS, NO-ISO6429, INIT-BOL, DESIGNATION-BOL,
850101ed 743 SAFE, ACCEPT-LATIN-EXTRA-CODE.
4ed46869
KH
744 CHARSETn are character sets initially designated to Gn graphic registers.
745 If CHARSETn is nil, Gn is never used.
746 If CHARSETn is t, Gn can be used but nothing designated initially.
747 If CHARSETn is a list of character sets, those character sets are
748 designated to Gn on output, but nothing designated to Gn initially.
421e3b4e 749 But, character set `ascii' can be designated only to G0.
4ed46869
KH
750 SHORT-FORM non-nil means use short designation sequence on output.
751 ASCII-EOL non-nil means designate ASCII to g0 at end of line on output.
752 ASCII-CNTL non-nil means designate ASCII to g0 before control codes and
753 SPACE on output.
754 SEVEN non-nil means use 7-bit code only on output.
755 LOCKING-SHIFT non-nil means use locking-shift.
756 SINGLE-SHIFT non-nil means use single-shift.
757 USE-ROMAN non-nil means designate JIS0201-1976-Roman instead of ASCII.
758 USE-OLDJIS non-nil means designate JIS0208-1976 instead of JIS0208-1983.
759 NO-ISO6429 non-nil means not use ISO6429's direction specification.
69eba008
KH
760 INIT-BOL non-nil means any designation state is assumed to be reset
761 to initial at each beginning of line on output.
762 DESIGNATION-BOL non-nil means designation sequences should be placed
763 at beginning of line on output.
a6acd8a2 764 SAFE non-nil means convert unsafe characters to `?' on output.
c11a8f77
KH
765 Characters not specified in the property `safe-charsets' nor
766 `safe-chars' are unsafe.
850101ed
RS
767 ACCEPT-LATIN-EXTRA-CODE non-nil means code-detection routine accepts
768 a code specified in `latin-extra-code-table' (which see) as a valid
769 code of the coding system.
d6d6d592 770
3bb1accb
KH
771 If TYPE is 4 (private), FLAGS should be a cons of CCL programs, for
772 decoding and encoding. CCL programs should be specified by their
773 symbols.
d9e3229d 774
a2852e45
KH
775PROPERTIES is an alist of properties vs the corresponding values. The
776following properties are recognized:
777
778 o post-read-conversion
0bca779a 779
a2852e45
KH
780 The value is a function to call after some text is inserted and
781 decoded by the coding system itself and before any functions in
521d4010
DL
782 `after-insert-functions' are called. The argument of this
783 function is the same as for a function in
784 `after-insert-file-functions', i.e. LENGTH of the text inserted,
785 with point at the head of the text to be decoded.
0bca779a 786
a2852e45 787 o pre-write-conversion
0bca779a 788
a2852e45
KH
789 The value is a function to call after all functions in
790 `write-region-annotate-functions' and `buffer-file-format' are
791 called, and before the text is encoded by the coding system itself.
a284eea3
DL
792 The arguments to this function are the same as those of a function
793 in `write-region-annotate-functions', i.e. FROM and TO, specifying
521d4010 794 a region of text.
0bca779a 795
a2852e45 796 o translation-table-for-decode
0bca779a 797
a2852e45
KH
798 The value is a translation table to be applied on decoding. See
799 the function `make-translation-table' for the format of translation
521d4010 800 table. This is not applicable to type 4 (CCL-based) coding systems.
0bca779a 801
a2852e45 802 o translation-table-for-encode
0bca779a 803
521d4010
DL
804 The value is a translation table to be applied on encoding. This is
805 not applicable to type 4 (CCL-based) coding systems.
0bca779a 806
a2852e45 807 o safe-chars
0bca779a 808
a2852e45
KH
809 The value is a char table. If a character has non-nil value in it,
810 the character is safely supported by the coding system. This
811 overrides the specification of safe-charsets.
812
813 o safe-charsets
521d4010 814
a2852e45
KH
815 The value is a list of charsets safely supported by the coding
816 system. The value t means that all charsets Emacs handles are
817 supported. Even if some charset is not in this list, it doesn't
521d4010
DL
818 mean that the charset can't be encoded in the coding system;
819 it just means that some other receiver of text encoded
a2852e45 820 in the coding system won't be able to handle that charset.
0bca779a 821
a2852e45 822 o mime-charset
0bca779a 823
d9f6dfe6 824 The value is a symbol whose name is the `MIME-charset' parameter of
a2852e45 825 the coding system.
0bca779a 826
3b6cc699
DL
827 o mime-text-unsuitable
828
829 A non-nil value means the `mime-charset' property names a charset
830 which is unsuitable for the top-level media type \"text\".
831
a2852e45 832 o valid-codes (meaningful only for a coding system based on CCL)
0bca779a 833
a2852e45
KH
834 The value is a list to indicate valid byte ranges of the encoded
835 file. Each element of the list is an integer or a cons of integer.
836 In the former case, the integer value is a valid byte code. In the
6fb7766c 837 latter case, the integers specify the range of valid byte codes.
a2852e45 838
1e7f6327
KH
839 o composition (meaningful only when TYPE is 0 or 2)
840
0ea0b6d2
DL
841 If the value is non-nil, the coding system preserves composition
842 information.
1e7f6327 843
43b557d5
KH
844 o ascii-incompatible
845
846 If the value is non-nil, the coding system is not compatible
847 with ASCII, which means it encodes or decodes ASCII character
848 string to the different byte sequence.
849
d9e3229d
KH
850These properties are set in PLIST, a property list. This function
851also sets properties `coding-category' and `alias-coding-systems'
852automatically.
4ed46869 853
1b46a680
KH
854EOL-TYPE specifies the EOL type of the coding-system in one of the
855following formats:
856
857 o symbol (unix, dos, or mac)
858
859 The symbol `unix' means Unix-like EOL (LF), `dos' means
860 DOS-like EOL (CRLF), and `mac' means MAC-like EOL (CR).
861
862 o number (0, 1, or 2)
863
864 The number 0, 1, and 2 mean UNIX, DOS, and MAC-like EOL
865 respectively.
866
867 o vector of coding-systems of length 3
868
869 The EOL type is detected automatically for the coding system.
870 And, according to the detected EOL type, one of the coding
871 systems in the vector is selected. Elements of the vector
4d3a9228 872 corresponds to Unix-like EOL, DOS-like EOL, and Mac-like EOL
1b46a680
KH
873 in this order.
874
3bb1accb
KH
875Kludgy features for backward compatibility:
876
8771. If TYPE is 4 and car or cdr of FLAGS is a vector, the vector is
878treated as a compiled CCL code.
879
8802. If PROPERTIES is just a list of character sets, the list is set as
881a value of `safe-charsets' in PLIST."
50c29104
KH
882
883 ;; For compatiblity with XEmacs, we check the type of TYPE. If it
c3d0ee51
EZ
884 ;; is a symbol, perhaps, this function is called with XEmacs-style
885 ;; arguments. Here, try to transform that kind of arguments to
50c29104
KH
886 ;; Emacs style.
887 (if (symbolp type)
888 (let ((args (transform-make-coding-system-args coding-system type
889 mnemonic doc-string)))
890 (setq coding-system (car args)
1053cc93 891 type (nth 1 args)
50c29104
KH
892 mnemonic (nth 2 args)
893 doc-string (nth 3 args)
894 flags (nth 4 args)
895 properties (nth 5 args)
896 eol-type (nth 6 args))))
897
0269ddfb 898 ;; Set a value of `coding-system' property.
6e9722b0 899 (let ((coding-spec (make-vector 5 nil))
d9e3229d
KH
900 (no-initial-designation t)
901 (no-alternative-designation t)
e6cddb1a 902 (accept-latin-extra-code nil)
6e9722b0 903 coding-category)
cd9c3177 904 (if (or (not (integerp type)) (< type 0) (> type 5))
0269ddfb 905 (error "TYPE argument must be 0..5"))
8057896b 906 (if (or (not (integerp mnemonic)) (<= mnemonic ? ) (> mnemonic 127))
521d4010 907 (error "MNEMONIC argument must be an ASCII printable character"))
0269ddfb
KH
908 (aset coding-spec coding-spec-type-idx type)
909 (aset coding-spec coding-spec-mnemonic-idx mnemonic)
910 (aset coding-spec coding-spec-doc-string-idx
e127a722 911 (purecopy (if (stringp doc-string) doc-string "")))
6e9722b0
KH
912 (cond ((= type 0)
913 (setq coding-category 'coding-category-emacs-mule))
914 ((= type 1)
915 (setq coding-category 'coding-category-sjis))
916 ((= type 2) ; ISO2022
4ed46869 917 (let ((i 0)
6e9722b0 918 (vec (make-vector 32 nil))
05134257
KH
919 (g1-designation nil)
920 (fl flags))
4ed46869 921 (while (< i 4)
05134257 922 (let ((charset (car fl)))
6e9722b0
KH
923 (if (and no-initial-designation
924 (> i 0)
925 (or (charsetp charset)
926 (and (consp charset)
927 (charsetp (car charset)))))
928 (setq no-initial-designation nil))
929 (if (charsetp charset)
930 (if (= i 1) (setq g1-designation charset))
931 (if (consp charset)
932 (let ((tail charset)
933 elt)
934 (while tail
935 (setq elt (car tail))
d9e3229d
KH
936 (if (eq elt t)
937 (setq no-alternative-designation nil)
938 (if (and elt (not (charsetp elt)))
939 (error "Invalid charset: %s" elt)))
6e9722b0
KH
940 (setq tail (cdr tail)))
941 (setq g1-designation (car charset)))
d9e3229d
KH
942 (if charset
943 (if (eq charset t)
944 (setq no-alternative-designation nil)
945 (error "Invalid charset: %s" charset)))))
4ed46869 946 (aset vec i charset))
05134257
KH
947 (setq fl (cdr fl) i (1+ i)))
948 (while (and (< i 32) fl)
949 (aset vec i (car fl))
e6cddb1a
KH
950 (if (and (= i 16) ; ACCEPT-LATIN-EXTRA-CODE
951 (car fl))
952 (setq accept-latin-extra-code t))
05134257 953 (setq fl (cdr fl) i (1+ i)))
6e9722b0 954 (aset coding-spec 4 vec)
6e9722b0
KH
955 (setq coding-category
956 (if (aref vec 8) ; Use locking-shift.
dc64cd19
KH
957 (or (and (aref vec 7) 'coding-category-iso-7-else)
958 'coding-category-iso-8-else)
6e9722b0
KH
959 (if (aref vec 7) ; 7-bit only.
960 (if (aref vec 9) ; Use single-shift.
dc64cd19 961 'coding-category-iso-7-else
d9e3229d
KH
962 (if no-alternative-designation
963 'coding-category-iso-7-tight
964 'coding-category-iso-7))
3ad911d8
KH
965 (if (or no-initial-designation
966 (not no-alternative-designation))
dc64cd19 967 'coding-category-iso-8-else
6e9722b0
KH
968 (if (and (charsetp g1-designation)
969 (= (charset-dimension g1-designation) 2))
970 'coding-category-iso-8-2
971 'coding-category-iso-8-1)))))))
972 ((= type 3)
973 (setq coding-category 'coding-category-big5))
974 ((= type 4) ; private
c76b5c99 975 (setq coding-category 'coding-category-ccl)
3bb1accb
KH
976 (if (not (consp flags))
977 (error "Invalid FLAGS argument for TYPE 4 (CCL)")
978 (let ((decoder (check-ccl-program
979 (car flags)
980 (intern (format "%s-decoder" coding-system))))
981 (encoder (check-ccl-program
982 (cdr flags)
983 (intern (format "%s-encoder" coding-system)))))
984 (if (and decoder encoder)
985 (aset coding-spec 4 (cons decoder encoder))
986 (error "Invalid FLAGS argument for TYPE 4 (CCL)")))))
cd9c3177
KH
987 (t ; i.e. (= type 5)
988 (setq coding-category 'coding-category-raw-text)))
0269ddfb
KH
989
990 (let ((plist (list 'coding-category coding-category
d9e3229d 991 'alias-coding-systems (list coding-system))))
0269ddfb 992 (if no-initial-designation
d9e3229d
KH
993 (plist-put plist 'no-initial-designation t))
994 (if (and properties
995 (or (eq properties t)
996 (not (consp (car properties)))))
997 ;; In the old version, the arg PROPERTIES is a list to be
998 ;; set in PLIST as a value of property `safe-charsets'.
c11a8f77
KH
999 (setq properties (list (cons 'safe-charsets properties))))
1000 ;; In the current version PROPERTIES is a property list.
1001 ;; Reflect it into PLIST one by one while handling safe-chars
1002 ;; specially.
1003 (let ((safe-charsets (cdr (assq 'safe-charsets properties)))
1004 (safe-chars (cdr (assq 'safe-chars properties)))
1005 (l properties)
1006 prop val)
1007 ;; If only safe-charsets is specified, make a char-table from
1008 ;; it, and store that char-table as the value of `safe-chars'.
1009 (if (and (not safe-chars) safe-charsets)
1010 (let (charset)
1011 (if (eq safe-charsets t)
1012 (setq safe-chars t)
1013 (setq safe-chars (make-char-table 'safe-chars))
1014 (while safe-charsets
1015 (setq charset (car safe-charsets)
1016 safe-charsets (cdr safe-charsets))
1017 (cond ((eq charset 'ascii)) ; just ignore
1018 ((eq charset 'eight-bit-control)
1019 (let ((i 128))
1020 (while (< i 160)
1021 (aset safe-chars i t)
1022 (setq i (1+ i)))))
1023 ((eq charset 'eight-bit-graphic)
1024 (let ((i 160))
1025 (while (< i 256)
1026 (aset safe-chars i t)
1027 (setq i (1+ i)))))
1028 (t
e6cddb1a
KH
1029 (aset safe-chars (make-char charset) t))))
1030 (if accept-latin-extra-code
1031 (let ((i 128))
1032 (while (< i 160)
1033 (if (aref latin-extra-code-table i)
1034 (aset safe-chars i t))
1035 (setq i (1+ i))))))
c11a8f77
KH
1036 (setq l (cons (cons 'safe-chars safe-chars) l))))
1037 (while l
1038 (setq prop (car (car l)) val (cdr (car l)) l (cdr l))
1039 (if (eq prop 'safe-chars)
1040 (progn
cc57cc54
KH
1041 (if (and (symbolp val)
1042 (get val 'translation-table))
1043 (setq safe-chars (get val 'translation-table)))
cc57cc54 1044 (setq val safe-chars)))
c11a8f77 1045 (plist-put plist prop val)))
1b46a680
KH
1046 ;; The property `coding-category' may have been set differently
1047 ;; through PROPERTIES.
1048 (setq coding-category (plist-get plist 'coding-category))
0269ddfb 1049 (aset coding-spec coding-spec-plist-idx plist))
6e9722b0 1050 (put coding-system 'coding-system coding-spec)
c95cf5ac 1051 (put coding-system 'coding-system-define-form nil)
6e9722b0
KH
1052 (put coding-category 'coding-systems
1053 (cons coding-system (get coding-category 'coding-systems))))
4ed46869 1054
1b46a680 1055 ;; Next, set a value of `eol-type' property.
af873cd1 1056 (if (not eol-type)
1b46a680
KH
1057 ;; If EOL-TYPE is nil, set a vector of subsidiary coding
1058 ;; systems, each corresponds to a coding system for the detected
1059 ;; EOL format.
1060 (setq eol-type (make-subsidiary-coding-system coding-system)))
1061 (setq eol-type
1062 (cond ((or (eq eol-type 'unix) (null eol-type))
1063 0)
1064 ((eq eol-type 'dos)
1065 1)
1066 ((eq eol-type 'mac)
1067 2)
1068 ((or (and (vectorp eol-type)
1069 (= (length eol-type) 3))
1070 (and (numberp eol-type)
1071 (and (>= eol-type 0)
1072 (<= eol-type 2))))
1073 eol-type)
1074 (t
1075 (error "Invalid EOL-TYPE spec:%S" eol-type))))
1076 (put coding-system 'eol-type eol-type)
0269ddfb 1077
620956ca
KH
1078 (define-coding-system-internal coding-system)
1079
0269ddfb
KH
1080 ;; At last, register CODING-SYSTEM in `coding-system-list' and
1081 ;; `coding-system-alist'.
857ea15c 1082 (add-to-coding-system-list coding-system)
0269ddfb 1083 (setq coding-system-alist (cons (list (symbol-name coding-system))
d9e3229d 1084 coding-system-alist))
05134257
KH
1085
1086 ;; For a coding system of cateogory iso-8-1 and iso-8-2, create
1087 ;; XXX-with-esc variants.
1088 (let ((coding-category (coding-system-category coding-system)))
1089 (if (or (eq coding-category 'coding-category-iso-8-1)
1090 (eq coding-category 'coding-category-iso-8-2))
1091 (let ((esc (intern (concat (symbol-name coding-system) "-with-esc")))
c11a8f77
KH
1092 (doc (format "Same as %s but can handle any charsets by ISO's escape sequences." coding-system))
1093 (safe-charsets (assq 'safe-charsets properties))
1094 (mime-charset (assq 'mime-charset properties)))
1095 (if safe-charsets
1096 (setcdr safe-charsets t)
1097 (setq properties (cons (cons 'safe-charsets t) properties)))
1098 (if mime-charset
1099 (setcdr mime-charset nil))
05134257
KH
1100 (make-coding-system esc type mnemonic doc
1101 (if (listp (car flags))
1102 (cons (append (car flags) '(t)) (cdr flags))
1103 (cons (list (car flags) t) (cdr flags)))
c11a8f77 1104 properties))))
05134257 1105
d9e3229d 1106 coding-system)
8057896b 1107
5470d5b6
KH
1108(put 'safe-chars 'char-table-extra-slots 0)
1109
a42763dc 1110(defun define-coding-system-alias (alias coding-system)
358d28fb 1111 "Define ALIAS as an alias for coding system CODING-SYSTEM."
0269ddfb 1112 (put alias 'coding-system (coding-system-spec coding-system))
c95cf5ac 1113 (put alias 'coding-system-define-form nil)
857ea15c 1114 (add-to-coding-system-list alias)
0269ddfb
KH
1115 (setq coding-system-alist (cons (list (symbol-name alias))
1116 coding-system-alist))
1117 (let ((eol-type (coding-system-eol-type coding-system)))
1118 (if (vectorp eol-type)
708fc465
KH
1119 (progn
1120 (nconc (coding-system-get alias 'alias-coding-systems) (list alias))
1121 (put alias 'eol-type (make-subsidiary-coding-system alias)))
0269ddfb 1122 (put alias 'eol-type eol-type))))
4ed46869 1123
bbdea948
RS
1124(defun merge-coding-systems (first second)
1125 "Fill in any unspecified aspects of coding system FIRST from SECOND.
1126Return the resulting coding system."
1127 (let ((base (coding-system-base second))
1128 (eol (coding-system-eol-type second)))
1129 ;; If FIRST doesn't specify text conversion, merge with that of SECOND.
1130 (if (eq (coding-system-base first) 'undecided)
1131 (setq first (coding-system-change-text-conversion first base)))
1132 ;; If FIRST doesn't specify eol conversion, merge with that of SECOND.
1133 (if (and (vectorp (coding-system-eol-type first))
1134 (numberp eol) (>= eol 0) (<= eol 2))
1135 (setq first (coding-system-change-eol-conversion
1136 first eol)))
1137 first))
1138
2b96ab33
KH
1139(defun autoload-coding-system (symbol form)
1140 "Define SYMBOL as a coding-system that is defined on demand.
1141
1142FROM is a form to evaluate to define the coding-system."
28849ffc
KH
1143 (put symbol 'coding-system-define-form form)
1144 (setq coding-system-alist (cons (list (symbol-name symbol))
1145 coding-system-alist)))
2b96ab33 1146
14b3fa07 1147(defun set-buffer-file-coding-system (coding-system &optional force nomodify)
358d28fb
RS
1148 "Set the file coding-system of the current buffer to CODING-SYSTEM.
1149This means that when you save the buffer, it will be converted
1150according to CODING-SYSTEM. For a list of possible values of CODING-SYSTEM,
1151use \\[list-coding-systems].
1152
bbdea948
RS
1153If CODING-SYSTEM leaves the text conversion unspecified, or if it
1154leaves the end-of-line conversion unspecified, FORCE controls what to
1155do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1156buffer's previous `buffer-file-coding-system' value (if it is
3b6cc699 1157specified there). Otherwise, leave it unspecified.
aeef8f07
KH
1158
1159This marks the buffer modified so that the succeeding \\[save-buffer]
1160surely saves the buffer with CODING-SYSTEM. From a program, if you
14b3fa07
RS
1161don't want to mark the buffer modified, specify t for NOMODIFY.
1162If you know exactly what coding system you want to use,
1163just set the variable `buffer-file-coding-system' directly."
5b76833f 1164 (interactive "zCoding system for saving file (default nil): \nP")
4ed46869 1165 (check-coding-system coding-system)
36d455c4 1166 (if (and coding-system buffer-file-coding-system (null force))
bbdea948
RS
1167 (setq coding-system
1168 (merge-coding-systems coding-system buffer-file-coding-system)))
4ed46869 1169 (setq buffer-file-coding-system coding-system)
38a1356d
RS
1170 ;; This is in case of an explicit call. Normally, `normal-mode' and
1171 ;; `set-buffer-major-mode-hook' take care of setting the table.
1172 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1173 (ucs-set-table-for-input))
de5ffead
RS
1174 (unless nomodify
1175 (set-buffer-modified-p t))
4ed46869
KH
1176 (force-mode-line-update))
1177
bbdea948
RS
1178(defun revert-buffer-with-coding-system (coding-system &optional force)
1179 "Visit the current buffer's file again using coding system CODING-SYSTEM.
1180For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1181
1182If CODING-SYSTEM leaves the text conversion unspecified, or if it
1183leaves the end-of-line conversion unspecified, FORCE controls what to
1184do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1185buffer's previous `buffer-file-coding-system' value (if it is
1186specified there). Otherwise, determine it from the file contents as
1187usual for visiting a file."
5b76833f 1188 (interactive "zCoding system for visited file (default nil): \nP")
bbdea948
RS
1189 (check-coding-system coding-system)
1190 (if (and coding-system buffer-file-coding-system (null force))
1191 (setq coding-system
1192 (merge-coding-systems coding-system buffer-file-coding-system)))
1193 (let ((coding-system-for-read coding-system))
1194 (revert-buffer)))
1195
701414e3
KH
1196(defun set-file-name-coding-system (coding-system)
1197 "Set coding system for decoding and encoding file names to CODING-SYSTEM.
1198It actually just set the variable `file-name-coding-system' (which
1199see) to CODING-SYSTEM."
5b76833f 1200 (interactive "zCoding system for file names (default nil): ")
701414e3 1201 (check-coding-system coding-system)
43b557d5
KH
1202 (if (and coding-system
1203 (coding-system-get coding-system 'ascii-incompatible))
1204 (error "%s is not ASCII-compatible" coding-system))
701414e3
KH
1205 (setq file-name-coding-system coding-system))
1206
358d28fb
RS
1207(defvar default-terminal-coding-system nil
1208 "Default value for the terminal coding system.
1209This is normally set according to the selected language environment.
1210See also the command `set-terminal-coding-system'.")
1211
df100398
KH
1212(defun set-terminal-coding-system (coding-system)
1213 "Set coding system of your terminal to CODING-SYSTEM.
358d28fb
RS
1214All text output to the terminal will be encoded
1215with the specified coding system.
1216For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1217The default is determined by the selected language environment
1218or by the previous use of this command."
1219 (interactive
2e02a76f
RS
1220 (list (let ((default (if (and (not (terminal-coding-system))
1221 default-terminal-coding-system)
1222 default-terminal-coding-system)))
1223 (read-coding-system
5b76833f 1224 (format "Coding system for terminal display (default %s): "
2e02a76f
RS
1225 default)
1226 default))))
358d28fb
RS
1227 (if (and (not coding-system)
1228 (not (terminal-coding-system)))
1229 (setq coding-system default-terminal-coding-system))
1230 (if coding-system
521d4010 1231 (setq default-terminal-coding-system coding-system))
df100398
KH
1232 (set-terminal-coding-system-internal coding-system)
1233 (redraw-frame (selected-frame)))
1234
358d28fb
RS
1235(defvar default-keyboard-coding-system nil
1236 "Default value of the keyboard coding system.
1237This is normally set according to the selected language environment.
1238See also the command `set-keyboard-coding-system'.")
1239
df100398 1240(defun set-keyboard-coding-system (coding-system)
358d28fb
RS
1241 "Set coding system for keyboard input to CODING-SYSTEM.
1242In addition, this command enables Encoded-kbd minor mode.
6d34f495
DL
1243\(If CODING-SYSTEM is nil, Encoded-kbd mode is turned off -- see
1244`encoded-kbd-mode'.)
358d28fb
RS
1245For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1246The default is determined by the selected language environment
1247or by the previous use of this command."
1248 (interactive
2e02a76f
RS
1249 (list (let ((default (if (and (not (keyboard-coding-system))
1250 default-keyboard-coding-system)
1251 default-keyboard-coding-system)))
1252 (read-coding-system
5b76833f 1253 (format "Coding system for keyboard input (default %s): "
2e02a76f
RS
1254 default)
1255 default))))
358d28fb
RS
1256 (if (and (not coding-system)
1257 (not (keyboard-coding-system)))
1258 (setq coding-system default-keyboard-coding-system))
1259 (if coding-system
1260 (setq default-keyboard-coding-system coding-system))
43b557d5
KH
1261 (if (and coding-system
1262 (coding-system-get coding-system 'ascii-incompatible))
1263 (error "%s is not ASCII-compatible" coding-system))
df100398 1264 (set-keyboard-coding-system-internal coding-system)
b23bad0b 1265 (setq keyboard-coding-system coding-system)
df100398
KH
1266 (encoded-kbd-mode (if coding-system 1 0)))
1267
6d34f495
DL
1268(defcustom keyboard-coding-system nil
1269 "Specify coding system for keyboard input.
1270If you set this on a terminal which can't distinguish Meta keys from
12718-bit characters, you will have to use ESC to type Meta characters.
1272See Info node `Specify Coding' and Info node `Single-Byte Character Support'.
1273
237e5993
DL
1274On non-windowing terminals, this is set from the locale by default.
1275
6d34f495 1276Setting this variable directly does not take effect;
c4131d96 1277use either \\[customize] or \\[set-keyboard-coding-system]."
6d34f495
DL
1278 :type '(coding-system :tag "Coding system")
1279 :link '(info-link "(emacs)Specify Coding")
1280 :link '(info-link "(emacs)Single-Byte Character Support")
1281 :set (lambda (symbol value)
1282 ;; Don't load encoded-kbd-mode unnecessarily.
1283 (if (or value (boundp 'encoded-kbd-mode))
1284 (set-keyboard-coding-system value)
1285 (set-default 'keyboard-coding-system nil))) ; must initialize
bf247b6e 1286 :version "22.1"
6d34f495
DL
1287 :group 'keyboard
1288 :group 'mule)
1289
df100398 1290(defun set-buffer-process-coding-system (decoding encoding)
358d28fb 1291 "Set coding systems for the process associated with the current buffer.
df100398 1292DECODING is the coding system to be used to decode input from the process,
358d28fb
RS
1293ENCODING is the coding system to be used to encode output to the process.
1294
1295For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
4ed46869 1296 (interactive
83911021 1297 "zCoding-system for output from the process: \nzCoding-system for input to the process: ")
4ed46869
KH
1298 (let ((proc (get-buffer-process (current-buffer))))
1299 (if (null proc)
521d4010 1300 (error "No process")
df100398
KH
1301 (check-coding-system decoding)
1302 (check-coding-system encoding)
1303 (set-process-coding-system proc decoding encoding)))
4ed46869
KH
1304 (force-mode-line-update))
1305
d0b99881
RS
1306(defalias 'set-clipboard-coding-system 'set-selection-coding-system)
1307
14915c37 1308(defun set-selection-coding-system (coding-system)
8c52d564 1309 "Make CODING-SYSTEM used for communicating with other X clients.
b25eef20
KH
1310When sending or receiving text via cut_buffer, selection, and clipboard,
1311the text is encoded or decoded by CODING-SYSTEM."
a03b3ce1 1312 (interactive "zCoding system for X selection: ")
b25eef20 1313 (check-coding-system coding-system)
14915c37 1314 (setq selection-coding-system coding-system))
b25eef20 1315
e8dd0160 1316;; Coding system lastly specified by the command
a03b3ce1
KH
1317;; set-next-selection-coding-system.
1318(defvar last-next-selection-coding-system nil)
1319
1320(defun set-next-selection-coding-system (coding-system)
1321 "Make CODING-SYSTEM used for the next communication with other X clients.
1322This setting is effective for the next communication only."
1323 (interactive
1324 (list (read-coding-system
1325 (if last-next-selection-coding-system
5b76833f 1326 (format "Coding system for the next X selection (default %S): "
a03b3ce1
KH
1327 last-next-selection-coding-system)
1328 "Coding system for the next X selection: ")
1329 last-next-selection-coding-system)))
1330 (if coding-system
1331 (setq last-next-selection-coding-system coding-system)
1332 (setq coding-system last-next-selection-coding-system))
1333 (check-coding-system coding-system)
1334
1335 (setq next-selection-coding-system coding-system))
1336
4ed46869 1337(defun set-coding-priority (arg)
521d4010
DL
1338 "Set priority of coding categories according to ARG.
1339ARG is a list of coding categories ordered by priority."
d9e3229d
KH
1340 (let ((l arg)
1341 (current-list (copy-sequence coding-category-list)))
e8dd0160 1342 ;; Check the validity of ARG while deleting coding categories in
d9e3229d
KH
1343 ;; ARG from CURRENT-LIST. We assume that CODING-CATEGORY-LIST
1344 ;; contains all coding categories.
1345 (while l
1346 (if (or (null (get (car l) 'coding-category-index))
1347 (null (memq (car l) current-list)))
1348 (error "Invalid or duplicated element in argument: %s" arg))
1349 (setq current-list (delq (car l) current-list))
1350 (setq l (cdr l)))
4ed46869 1351 ;; Update `coding-category-list' and return it.
2feaf204
KH
1352 (setq coding-category-list (append arg current-list))
1353 (set-coding-priority-internal)))
4ed46869 1354
835cbadb
EZ
1355;;; X selections
1356
cc926903 1357(defvar ctext-non-standard-encodings-alist
6c805023
KH
1358 '(("big5-0" big5 2 (chinese-big5-1 chinese-big5-2))
1359 ("ISO8859-14" iso-8859-14 1 latin-iso8859-14)
1360 ("ISO8859-15" iso-8859-15 1 latin-iso8859-15))
1361 "Alist of non-standard encoding names vs the corresponding usages in CTEXT.
1362
1363It controls how extended segments of a compound text are handled
1364by the coding system `compound-text-with-extensions'.
1365
1366Each element has the form (ENCODING-NAME CODING-SYSTEM N-OCTET CHARSET).
1367
1368ENCODING-NAME is an encoding name of an \"extended segments\".
1369
1370CODING-SYSTEM is the coding-system to encode (or decode) the
1371characters into (or from) the extended segment.
1372
1373N-OCTET is the number of octets (bytes) that encodes a character
1374in the segment. It can be 0 (meaning the number of octets per
1375character is variable), 1, 2, 3, or 4.
1376
1377CHARSET is a charater set containing characters that are encoded
1378in the segment. It can be a list of character sets. It can also
1379be a char-table, in which case characters that have non-nil value
1380in the char-table are the target.
1381
1382On decoding CTEXT, all encoding names listed here are recognized.
1383
1384On encoding CTEXT, encoding names in the variable
1385`ctext-non-standard-encodings' (which see) and in the information
1386listed for the current language environment under the key
1387`ctext-non-standard-encodings' are used.")
1388
1389(defvar ctext-non-standard-encodings
1390 '("big5-0")
1391 "List of non-standard encoding names used in extended segments of CTEXT.
1392Each element must be one of the names listed in the variable
1393`ctext-non-standard-encodings-alist' (which see).")
cc926903
KH
1394
1395(defvar ctext-non-standard-encodings-regexp
1396 (string-to-multibyte
1397 (concat
1398 ;; For non-standard encodings.
1399 "\\(\e%/[0-4][\200-\377][\200-\377]\\([^\002]+\\)\002\\)"
1400 "\\|"
1401 ;; For UTF-8 encoding.
1402 "\\(\e%G[^\e]*\e%@\\)")))
835cbadb
EZ
1403
1404;; Functions to support "Non-Standard Character Set Encodings" defined
6c805023
KH
1405;; by the COMPOUND-TEXT spec. They also support "The UTF-8 encoding"
1406;; described in the section 7 of the documentation of COMPOUND-TEXT
1407;; distributed with XFree86.
5c88a01e 1408
835cbadb
EZ
1409(defun ctext-post-read-conversion (len)
1410 "Decode LEN characters encoded as Compound Text with Extended Segments."
835cbadb 1411 (save-match-data
cc926903
KH
1412 (save-restriction
1413 (let ((case-fold-search nil)
1414 (in-workbuf (string= (buffer-name) " *code-converting-work*"))
1415 last-coding-system-used
1416 pos bytes)
1417 (or in-workbuf
1418 (narrow-to-region (point) (+ (point) len)))
cc926903
KH
1419 (if in-workbuf
1420 (set-buffer-multibyte t))
1421 (while (re-search-forward ctext-non-standard-encodings-regexp
1422 nil 'move)
1423 (setq pos (match-beginning 0))
1424 (if (match-beginning 1)
1425 ;; ESC % / [0-4] M L --ENCODING-NAME-- \002 --BYTES--
1426 (let* ((M (char-after (+ pos 4)))
1427 (L (char-after (+ pos 5)))
1428 (encoding (match-string 2))
9857367f 1429 (encoding-info (assoc-string
6c805023 1430 encoding
c12bc1fb 1431 ctext-non-standard-encodings-alist t))
6c805023
KH
1432 (coding (if encoding-info
1433 (nth 1 encoding-info)
1434 (setq encoding (intern (downcase encoding)))
1435 (and (coding-system-p encoding)
1436 encoding))))
cc926903
KH
1437 (setq bytes (- (+ (* (- M 128) 128) (- L 128))
1438 (- (point) (+ pos 6))))
1439 (when coding
1440 (delete-region pos (point))
1441 (forward-char bytes)
1442 (decode-coding-region (- (point) bytes) (point) coding)))
1443 ;; ESC % G --UTF-8-BYTES-- ESC % @
6c805023
KH
1444 (delete-char -3)
1445 (delete-region pos (+ pos 3))
1446 (decode-coding-region pos (point) 'utf-8))))
cc926903
KH
1447 (goto-char (point-min))
1448 (- (point-max) (point)))))
835cbadb 1449
6c805023
KH
1450;; Return a char table of extended segment usage for each character.
1451;; Each value of the char table is nil, one of the elements of
1452;; `ctext-non-standard-encodings-alist', or the symbol `utf-8'.
1453
1454(defun ctext-non-standard-encodings-table ()
1455 (let ((table (make-char-table 'translation-table)))
1456 (aset table (make-char 'mule-unicode-0100-24ff) 'utf-8)
1457 (aset table (make-char 'mule-unicode-2500-33ff) 'utf-8)
1458 (aset table (make-char 'mule-unicode-e000-ffff) 'utf-8)
1459 (dolist (encoding (reverse
1460 (append
1461 (get-language-info current-language-environment
1462 'ctext-non-standard-encodings)
1463 ctext-non-standard-encodings)))
1464 (let* ((slot (assoc encoding ctext-non-standard-encodings-alist))
1465 (charset (nth 3 slot)))
1466 (if charset
1467 (cond ((charsetp charset)
1468 (aset table (make-char charset) slot))
1469 ((listp charset)
1470 (dolist (elt charset)
1471 (aset table (make-char elt) slot)))
1472 ((char-table-p charset)
9857367f 1473 (map-char-table #'(lambda (k v)
6c805023
KH
1474 (if (and v (> k 128)) (aset table k slot)))
1475 charset))))))
1476 table))
835cbadb
EZ
1477
1478(defun ctext-pre-write-conversion (from to)
5dde3c71
EZ
1479 "Encode characters between FROM and TO as Compound Text w/Extended Segments.
1480
1481If FROM is a string, or if the current buffer is not the one set up for us
cc926903 1482by encode-coding-string, generate a new temp buffer, insert the
5dde3c71 1483text, and convert it in the temporary buffer. Otherwise, convert in-place."
835cbadb 1484 (save-match-data
002dc239
KH
1485 (let ((workbuf (get-buffer-create " *code-conversion-work*")))
1486 ;; Setup a working buffer if necessary.
1487 (cond ((stringp from)
1488 (set-buffer workbuf)
1489 (erase-buffer)
cc926903 1490 (set-buffer-multibyte (multibyte-string-p from))
002dc239
KH
1491 (insert from))
1492 ((not (eq (current-buffer) workbuf))
1493 (let ((buf (current-buffer))
1494 (multibyte enable-multibyte-characters))
1495 (set-buffer workbuf)
1496 (erase-buffer)
1497 (set-buffer-multibyte multibyte)
1498 (insert-buffer-substring buf from to)))))
cc926903
KH
1499
1500 ;; Now we can encode the whole buffer.
6c805023 1501 (let ((encoding-table (ctext-non-standard-encodings-table))
cc926903 1502 last-coding-system-used
6c805023
KH
1503 last-pos last-encoding-info
1504 encoding-info end-pos)
1505 (goto-char (setq last-pos (point-min)))
1506 (setq end-pos (point-marker))
1507 (while (re-search-forward "[^\000-\177]+" nil t)
1508 ;; Found a sequence of non-ASCII characters.
1509 (setq last-pos (match-beginning 0)
1510 last-encoding-info (aref encoding-table (char-after last-pos)))
1511 (set-marker end-pos (match-end 0))
1512 (goto-char (1+ last-pos))
1513 (catch 'tag
1514 (while t
1515 (setq encoding-info
1516 (if (< (point) end-pos)
1517 (aref encoding-table (following-char))))
1518 (unless (eq last-encoding-info encoding-info)
1519 (cond ((consp last-encoding-info)
1520 ;; Encode the previous range using an extended
1521 ;; segment.
1522 (let ((encoding-name (car last-encoding-info))
1523 (coding-system (nth 1 last-encoding-info))
1524 (noctets (nth 2 last-encoding-info))
1525 len)
1526 (encode-coding-region last-pos (point) coding-system)
1527 (setq len (+ (length encoding-name) 1
1528 (- (point) last-pos)))
1529 (save-excursion
1530 (goto-char last-pos)
9857367f 1531 (insert (string-to-multibyte
6c805023
KH
1532 (format "\e%%/%d%c%c%s\ 2"
1533 noctets
1534 (+ (/ len 128) 128)
1535 (+ (% len 128) 128)
1536 encoding-name))))))
1537 ((eq last-encoding-info 'utf-8)
1538 ;; Encode the previous range using UTF-8 encoding
1539 ;; extention.
1540 (encode-coding-region last-pos (point) 'mule-utf-8)
1541 (save-excursion
1542 (goto-char last-pos)
1543 (insert "\e%G"))
1544 (insert "\e%@")))
1545 (setq last-pos (point)
1546 last-encoding-info encoding-info))
1547 (if (< (point) end-pos)
1548 (forward-char 1)
1549 (throw 'tag nil)))))
1550 (set-marker end-pos nil)
cc926903 1551 (goto-char (point-min))))
5dde3c71 1552 ;; Must return nil, as build_annotations_2 expects that.
835cbadb
EZ
1553 nil)
1554
4ed46869
KH
1555;;; FILE I/O
1556
e76938e7 1557(defcustom auto-coding-alist
d8df8af1
EZ
1558 '(("\\.\\(arc\\|zip\\|lzh\\|zoo\\|[jew]ar\\|xpi\\)\\'" . no-conversion)
1559 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . no-conversion)
e3668698 1560 ("\\.\\(sx[dmicw]\\|tar\\|tgz\\)\\'" . no-conversion)
6caef2da 1561 ("\\.\\(gz\\|Z\\|bz\\|bz2\\|gpg\\)\\'" . no-conversion)
ba40634b 1562 ("\\.\\(jpe?g\\|png\\|gif\\|tiff?\\|p[bpgn]m\\)\\'" . no-conversion)
45885400 1563 ("/#[^/]+#\\'" . emacs-mule))
835f49b8
KH
1564 "Alist of filename patterns vs corresponding coding systems.
1565Each element looks like (REGEXP . CODING-SYSTEM).
558b0c86 1566A file whose name matches REGEXP is decoded by CODING-SYSTEM on reading.
835f49b8 1567
7fed493a
RS
1568The settings in this alist take priority over `coding:' tags
1569in the file (see the function `set-auto-coding')
e76938e7
DL
1570and the contents of `file-coding-system-alist'."
1571 :group 'files
1572 :group 'mule
1573 :type '(repeat (cons (regexp :tag "File name regexp")
1574 (symbol :tag "Coding system"))))
835f49b8 1575
502522b2
GM
1576(defcustom auto-coding-regexp-alist
1577 '(("^BABYL OPTIONS:[ \t]*-\\*-[ \t]*rmail[ \t]*-\\*-" . no-conversion))
1578 "Alist of patterns vs corresponding coding systems.
1579Each element looks like (REGEXP . CODING-SYSTEM).
1580A file whose first bytes match REGEXP is decoded by CODING-SYSTEM on reading.
1581
1582The settings in this alist take priority over `coding:' tags
1583in the file (see the function `set-auto-coding')
1584and the contents of `file-coding-system-alist'."
1585 :group 'files
1586 :group 'mule
1587 :type '(repeat (cons (regexp :tag "Regexp")
1588 (symbol :tag "Coding system"))))
1589
d9f6dfe6 1590;; See the bottom of this file for built-in auto coding functions.
447404a3
CW
1591(defcustom auto-coding-functions '(sgml-xml-auto-coding-function
1592 sgml-html-meta-auto-coding-function)
d9f6dfe6
CW
1593 "A list of functions which attempt to determine a coding system.
1594
66643502
RS
1595Each function in this list should be written to operate on the
1596current buffer, but should not modify it in any way. The buffer
1597will contain undecoded text of parts of the file. Each function
1598should take one argument, SIZE, which says how many
1599characters (starting from point) it should look at.
1600
1601If one of these functions succeeds in determining a coding
1602system, it should return that coding system. Otherwise, it
1603should return nil.
1604
1605If a file has a `coding:' tag, that takes precedence over these
1606functions, so they won't be called at all."
d9f6dfe6
CW
1607 :group 'files
1608 :group 'mule
1609 :type '(repeat function))
1610
1c4cc63a
KH
1611(defvar set-auto-coding-for-load nil
1612 "Non-nil means look for `load-coding' property instead of `coding'.
1613This is used for loading and byte-compiling Emacs Lisp files.")
1614
8a592131
RS
1615(defun auto-coding-alist-lookup (filename)
1616 "Return the coding system specified by `auto-coding-alist' for FILENAME."
1617 (let ((alist auto-coding-alist)
c60ee5e7 1618 (case-fold-search (memq system-type '(vax-vms windows-nt ms-dos cygwin)))
8a592131
RS
1619 coding-system)
1620 (while (and alist (not coding-system))
1621 (if (string-match (car (car alist)) filename)
1622 (setq coding-system (cdr (car alist)))
1623 (setq alist (cdr alist))))
1624 coding-system))
1625
e9b01d1f
KH
1626(defun find-auto-coding (filename size)
1627 "Find a coding system for a file FILENAME of which SIZE bytes follow point.
1c4cc63a
KH
1628These bytes should include at least the first 1k of the file
1629and the last 3k of the file, but the middle may be omitted.
63561304 1630
d21ba5e0
DL
1631The function checks FILENAME against the variable `auto-coding-alist'.
1632If FILENAME doesn't match any entries in the variable, it checks the
502522b2 1633contents of the current buffer following point against
447404a3 1634`auto-coding-regexp-alist'. If no match is found, it checks for a
502522b2 1635`coding:' tag in the first one or two lines following point. If no
d21ba5e0 1636`coding:' tag is found, it checks any local variables list in the last
447404a3 16373K bytes out of the SIZE bytes. Finally, if none of these methods
d21ba5e0
DL
1638succeed, it checks to see if any function in `auto-coding-functions'
1639gives a match.
63561304 1640
e9b01d1f
KH
1641If a coding system is specifed, the return value is a
1642cons (CODING . SOURCE), where CODING is the specified coding
1643system and SOURCE is a symbol `auto-coding-alist',
1644`auto-coding-regexp-alist', `coding:', or `auto-coding-functions'
1645indicating by what CODING is specified. Note that the validity
1646of CODING is not checked; it's callers responsibility to check
1647it.
1648
1649If nothing is specified, the return value is nil.
87aba788 1650
ba74e833 1651The variable `set-auto-coding-function' (which see) is set to this
87aba788 1652function by default."
e9b01d1f
KH
1653 (or (let ((coding-system (auto-coding-alist-lookup filename)))
1654 (if coding-system
1655 (cons coding-system 'auto-coding-alist)))
447404a3
CW
1656 ;; Try using `auto-coding-regexp-alist'.
1657 (save-excursion
1658 (let ((alist auto-coding-regexp-alist)
1659 coding-system)
1660 (while (and alist (not coding-system))
1661 (let ((regexp (car (car alist))))
1662 (when (re-search-forward regexp (+ (point) size) t)
1663 (setq coding-system (cdr (car alist)))))
0bca779a 1664 (setq alist (cdr alist)))
e9b01d1f
KH
1665 (if coding-system
1666 (cons coding-system 'auto-coding-regexp-alist))))
502522b2
GM
1667 (let* ((case-fold-search t)
1668 (head-start (point))
1669 (head-end (+ head-start (min size 1024)))
1670 (tail-start (+ head-start (max (- size 3072) 0)))
1671 (tail-end (+ head-start size))
1672 coding-system head-found tail-found pos)
1673 ;; Try a short cut by searching for the string "coding:"
1674 ;; and for "unibyte:" at the head and tail of SIZE bytes.
1675 (setq head-found (or (search-forward "coding:" head-end t)
1676 (search-forward "unibyte:" head-end t)))
1677 (if (and head-found (> head-found tail-start))
1678 ;; Head and tail are overlapped.
1679 (setq tail-found head-found)
1680 (goto-char tail-start)
1681 (setq tail-found (or (search-forward "coding:" tail-end t)
1682 (search-forward "unibyte:" tail-end t))))
1683
1684 ;; At first check the head.
1685 (when head-found
1686 (goto-char head-start)
6b66d028
RS
1687 (setq head-end (set-auto-mode-1))
1688 (setq head-start (point))
1d8e9a7c 1689 (when (and head-end (< head-found head-end))
835f49b8 1690 (goto-char head-start)
502522b2
GM
1691 (when (and set-auto-coding-for-load
1692 (re-search-forward
6b66d028 1693 "\\(.*;\\)?[ \t]*unibyte:[ \t]*\\([^ ;]+\\)"
502522b2
GM
1694 head-end t))
1695 (setq coding-system 'raw-text))
1696 (when (and (not coding-system)
1697 (re-search-forward
6b66d028 1698 "\\(.*;\\)?[ \t]*coding:[ \t]*\\([^ ;]+\\)"
502522b2 1699 head-end t))
e9b01d1f 1700 (setq coding-system (intern (match-string 2))))))
502522b2
GM
1701
1702 ;; If no coding: tag in the head, check the tail.
c251286b
KH
1703 ;; Here we must pay attention to the case that the end-of-line
1704 ;; is just "\r" and we can't use "^" nor "$" in regexp.
502522b2
GM
1705 (when (and tail-found (not coding-system))
1706 (goto-char tail-start)
c251286b 1707 (re-search-forward "[\r\n]\^L" nil t)
502522b2 1708 (if (re-search-forward
9857367f 1709 "[\r\n]\\([^[\r\n]*\\)[ \t]*Local Variables:[ \t]*\\([^\r\n]*\\)[\r\n]"
c251286b
KH
1710 tail-end t)
1711 ;; The prefix is what comes before "local variables:" in its
1712 ;; line. The suffix is what comes after "local variables:"
502522b2
GM
1713 ;; in its line.
1714 (let* ((prefix (regexp-quote (match-string 1)))
1715 (suffix (regexp-quote (match-string 2)))
1716 (re-coding
1717 (concat
c251286b 1718 "[\r\n]" prefix
cfe98f50
GM
1719 ;; N.B. without the \n below, the regexp can
1720 ;; eat newlines.
c251286b
KH
1721 "[ \t]*coding[ \t]*:[ \t]*\\([^ \t\r\n]+\\)[ \t]*"
1722 suffix "[\r\n]"))
502522b2
GM
1723 (re-unibyte
1724 (concat
c251286b
KH
1725 "[\r\n]" prefix
1726 "[ \t]*unibyte[ \t]*:[ \t]*\\([^ \t\r\n]+\\)[ \t]*"
1727 suffix "[\r\n]"))
502522b2 1728 (re-end
9857367f 1729 (concat "[\r\n]" prefix "[ \t]*End *:[ \t]*" suffix
c251286b
KH
1730 "[\r\n]?"))
1731 (pos (1- (point))))
1732 (forward-char -1) ; skip back \r or \n.
502522b2
GM
1733 (re-search-forward re-end tail-end 'move)
1734 (setq tail-end (point))
1735 (goto-char pos)
1736 (when (and set-auto-coding-for-load
1737 (re-search-forward re-unibyte tail-end t))
1738 (setq coding-system 'raw-text))
1739 (when (and (not coding-system)
1740 (re-search-forward re-coding tail-end t))
e9b01d1f
KH
1741 (setq coding-system (intern (match-string 1)))))))
1742 (if coding-system
1743 (cons coding-system :coding)))
447404a3
CW
1744 ;; Finally, try all the `auto-coding-functions'.
1745 (let ((funcs auto-coding-functions)
1746 (coding-system nil))
1747 (while (and funcs (not coding-system))
1748 (setq coding-system (condition-case e
1749 (save-excursion
1750 (goto-char (point-min))
1751 (funcall (pop funcs) size))
1752 (error nil))))
e9b01d1f
KH
1753 (if coding-system
1754 (cons coding-system 'auto-coding-functions)))))
1755
1756(defun set-auto-coding (filename size)
1757 "Return coding system for a file FILENAME of which SIZE bytes follow point.
1758See `find-auto-coding' for how the coding system is found.
1759Return nil if an invalid coding system is found."
1760 (let ((found (find-auto-coding filename size)))
1761 (if (and found (coding-system-p (car found)))
1762 (car found))))
63561304
KH
1763
1764(setq set-auto-coding-function 'set-auto-coding)
87aba788 1765
0436cc1b
KH
1766;; This variable is set in these two cases:
1767;; (1) A file is read by a coding system specified explicitly.
1768;; after-insert-file-set-coding sets this value to
1769;; coding-system-for-read.
1770;; (2) A buffer is saved.
1771;; After writing, basic-save-buffer-1 sets this value to
1772;; last-coding-system-used.
1773;; This variable is used for decoding in revert-buffer.
e205f8c1 1774(defvar buffer-file-coding-system-explicit nil
0436cc1b
KH
1775 "The file coding system explicitly specified for the current buffer.
1776Internal use only.")
e205f8c1
KH
1777(make-variable-buffer-local 'buffer-file-coding-system-explicit)
1778(put 'buffer-file-coding-system-explicit 'permanent-local t)
0436cc1b
KH
1779
1780(defun after-insert-file-set-coding (inserted &optional visit)
872a0a6f
RS
1781 "Set `buffer-file-coding-system' of current buffer after text is inserted.
1782INSERTED is the number of characters that were inserted, as figured
1783in the situation before this function. Return the number of characters
1784inserted, as figured in the situation after. The two numbers can be
0436cc1b
KH
1785different if the buffer has become unibyte.
1786The optional second arg VISIT non-nil means that we are visiting a file."
1787 (if (and visit
1788 coding-system-for-read
1789 (not (eq coding-system-for-read 'auto-save-coding)))
e205f8c1 1790 (setq buffer-file-coding-system-explicit coding-system-for-read))
4ed46869
KH
1791 (if last-coding-system-used
1792 (let ((coding-system
1793 (find-new-buffer-file-coding-system last-coding-system-used))
1794 (modified-p (buffer-modified-p)))
0269ddfb 1795 (when coding-system
14b3fa07
RS
1796 ;; Tell set-buffer-file-coding-system not to mark the file
1797 ;; as modified; we just read it, and it's supposed to be unmodified.
1798 ;; Marking it modified would try to lock it, which would
1799 ;; check the modtime, and we don't want to do that again now.
1800 (set-buffer-file-coding-system coding-system t t)
d0c26c63
KH
1801 (if (and enable-multibyte-characters
1802 (or (eq coding-system 'no-conversion)
ccb77b4e 1803 (eq (coding-system-type coding-system) 5))
136e48e4
KH
1804 ;; If buffer was unmodified and the size is the
1805 ;; same as INSERTED, we must be visiting it.
1806 (not modified-p)
1807 (= (buffer-size) inserted))
ccb77b4e
RS
1808 ;; For coding systems no-conversion and raw-text...,
1809 ;; edit the buffer as unibyte.
14b3fa07
RS
1810 (let ((pos-marker (copy-marker (+ (point) inserted)))
1811 ;; Prevent locking.
1812 (buffer-file-name nil))
d0c26c63 1813 (set-buffer-multibyte nil)
872a0a6f 1814 (setq inserted (- pos-marker (point)))))
0269ddfb 1815 (set-buffer-modified-p modified-p))))
d0c26c63 1816 inserted)
4ed46869 1817
8057896b 1818;; The coding-spec and eol-type of coding-system returned is decided
4ed46869
KH
1819;; independently in the following order.
1820;; 1. That of buffer-file-coding-system locally bound.
1821;; 2. That of CODING.
1822
1823(defun find-new-buffer-file-coding-system (coding)
1824 "Return a coding system for a buffer when a file of CODING is inserted.
a73a8c89
KH
1825The local variable `buffer-file-coding-system' of the current buffer
1826is set to the returned value.
509064c5 1827Return nil if there's no need to set `buffer-file-coding-system'."
4ed46869 1828 (let (local-coding local-eol
b685f8d6 1829 found-coding found-eol
4ed46869
KH
1830 new-coding new-eol)
1831 (if (null coding)
1832 ;; Nothing found about coding.
1833 nil
1834
b685f8d6
RS
1835 ;; Get information of `buffer-file-coding-system' in LOCAL-EOL
1836 ;; and LOCAL-CODING.
1837 (setq local-eol (coding-system-eol-type buffer-file-coding-system))
1838 (if (null (numberp local-eol))
1839 ;; But eol-type is not yet set.
1840 (setq local-eol nil))
0269ddfb
KH
1841 (if (and buffer-file-coding-system
1842 (not (eq (coding-system-type buffer-file-coding-system) t)))
1843 ;; This is not `undecided'.
1844 (setq local-coding (coding-system-base buffer-file-coding-system)))
b685f8d6
RS
1845
1846 (if (and (local-variable-p 'buffer-file-coding-system)
1847 local-eol local-coding)
4ed46869
KH
1848 ;; The current buffer has already set full coding-system, we
1849 ;; had better not change it.
1850 nil
1851
8057896b 1852 (setq found-eol (coding-system-eol-type coding))
4ed46869 1853 (if (null (numberp found-eol))
be02cd54
EZ
1854 ;; But eol-type is not found.
1855 ;; If EOL conversions are inhibited, force unix eol-type.
1856 (setq found-eol (if inhibit-eol-conversion 0)))
c76b5c99
KH
1857 (if (eq (coding-system-type coding) t)
1858 (setq found-coding 'undecided)
1859 (setq found-coding (coding-system-base coding)))
1860
1861 (if (and (not found-eol) (eq found-coding 'undecided))
1862 ;; No valid coding information found.
1863 nil
1864
1865 ;; Some coding information (eol or text) found.
1866
1867 ;; The local setting takes precedence over the found one.
1868 (setq new-coding (if (local-variable-p 'buffer-file-coding-system)
1869 (or local-coding found-coding)
1870 (or found-coding local-coding)))
1871 (setq new-eol (if (local-variable-p 'buffer-file-coding-system)
1872 (or local-eol found-eol)
1873 (or found-eol local-eol)))
1874
1875 (let ((eol-type (coding-system-eol-type new-coding)))
1876 (if (and (numberp new-eol) (vectorp eol-type))
1877 (aref eol-type new-eol)
1878 new-coding)))))))
4ed46869 1879
fe831d33
GV
1880(defun modify-coding-system-alist (target-type regexp coding-system)
1881 "Modify one of look up tables for finding a coding system on I/O operation.
8c453b46
RS
1882There are three of such tables, `file-coding-system-alist',
1883`process-coding-system-alist', and `network-coding-system-alist'.
fe831d33
GV
1884
1885TARGET-TYPE specifies which of them to modify.
8c453b46
RS
1886If it is `file', it affects `file-coding-system-alist' (which see).
1887If it is `process', it affects `process-coding-system-alist' (which see).
e8dd0160 1888If it is `network', it affects `network-coding-system-alist' (which see).
fe831d33
GV
1889
1890REGEXP is a regular expression matching a target of I/O operation.
1891The target is a file name if TARGET-TYPE is `file', a program name if
1892TARGET-TYPE is `process', or a network service name or a port number
1893to connect to if TARGET-TYPE is `network'.
1894
1895CODING-SYSTEM is a coding system to perform code conversion on the I/O
8c453b46
RS
1896operation, or a cons cell (DECODING . ENCODING) specifying the coding systems
1897for decoding and encoding respectively,
1898or a function symbol which, when called, returns such a cons cell."
fe831d33
GV
1899 (or (memq target-type '(file process network))
1900 (error "Invalid target type: %s" target-type))
1901 (or (stringp regexp)
1902 (and (eq target-type 'network) (integerp regexp))
1903 (error "Invalid regular expression: %s" regexp))
1904 (if (symbolp coding-system)
1905 (if (not (fboundp coding-system))
1906 (progn
1907 (check-coding-system coding-system)
1908 (setq coding-system (cons coding-system coding-system))))
1909 (check-coding-system (car coding-system))
1910 (check-coding-system (cdr coding-system)))
1911 (cond ((eq target-type 'file)
1912 (let ((slot (assoc regexp file-coding-system-alist)))
1913 (if slot
1914 (setcdr slot coding-system)
1915 (setq file-coding-system-alist
1916 (cons (cons regexp coding-system)
1917 file-coding-system-alist)))))
1918 ((eq target-type 'process)
1919 (let ((slot (assoc regexp process-coding-system-alist)))
1920 (if slot
1921 (setcdr slot coding-system)
1922 (setq process-coding-system-alist
1923 (cons (cons regexp coding-system)
1924 process-coding-system-alist)))))
1925 (t
1926 (let ((slot (assoc regexp network-coding-system-alist)))
1927 (if slot
1928 (setcdr slot coding-system)
1929 (setq network-coding-system-alist
1930 (cons (cons regexp coding-system)
1931 network-coding-system-alist)))))))
1932
db046b7d
KH
1933(defun decode-coding-inserted-region (from to filename
1934 &optional visit beg end replace)
f29387e8 1935 "Decode the region between FROM and TO as if it is read from file FILENAME.
9c848353 1936The idea is that the text between FROM and TO was just inserted somehow.
f29387e8 1937Optional arguments VISIT, BEG, END, and REPLACE are the same as those
9c848353
RS
1938of the function `insert-file-contents'.
1939Part of the job of this function is setting `buffer-undo-list' appropriately."
f29387e8
KH
1940 (save-excursion
1941 (save-restriction
9c848353
RS
1942 (let ((coding coding-system-for-read)
1943 undo-list-saved)
1944 (if visit
1945 ;; Temporarily turn off undo recording, if we're decoding the
1946 ;; text of a visited file.
1947 (setq buffer-undo-list t)
1948 ;; Otherwise, if we can recognize the undo elt for the insertion,
1949 ;; remove it and get ready to replace it later.
1950 ;; In the mean time, turn off undo recording.
bf247b6e 1951 (let ((last (car-safe buffer-undo-list)))
9c848353
RS
1952 (if (and (consp last) (eql (car last) from) (eql (cdr last) to))
1953 (setq undo-list-saved (cdr buffer-undo-list)
1954 buffer-undo-list t))))
1955 (narrow-to-region from to)
1956 (goto-char (point-min))
f29387e8
KH
1957 (or coding
1958 (setq coding (funcall set-auto-coding-function
1959 filename (- (point-max) (point-min)))))
1960 (or coding
b69ff51b
KH
1961 (setq coding (car (find-operation-coding-system
1962 'insert-file-contents
1963 filename visit beg end replace))))
f29387e8
KH
1964 (if (coding-system-p coding)
1965 (or enable-multibyte-characters
1966 (setq coding
1967 (coding-system-change-text-conversion coding 'raw-text)))
1968 (setq coding nil))
1969 (if coding
b12e19b2 1970 (decode-coding-region (point-min) (point-max) coding)
9c848353
RS
1971 (setq last-coding-system-used coding))
1972 ;; If we're decoding the text of a visited file,
1973 ;; the undo list should start out empty.
1974 (if visit
1975 (setq buffer-undo-list nil)
1976 ;; If we decided to replace the undo entry for the insertion,
1977 ;; do so now.
1978 (if undo-list-saved
1979 (setq buffer-undo-list
1980 (cons (cons from (point-max)) undo-list-saved))))))))
f29387e8 1981
27a91cf7
KH
1982(defun recode-region (start end new-coding coding)
1983 "Re-decode the region (previously decoded by CODING) by NEW-CODING."
1984 (interactive
1985 (list (region-beginning) (region-end)
1986 (read-coding-system "Text was really in: ")
1987 (let ((coding (or buffer-file-coding-system last-coding-system-used)))
1988 (read-coding-system
1989 (concat "But was interpreted as"
1990 (if coding (format " (default %S): " coding) ": "))
1991 coding))))
1992 (or (and new-coding coding)
1993 (error "Coding system not specified"))
1994 ;; Check it before we encode the region.
1995 (check-coding-system new-coding)
1996 (save-restriction
1997 (narrow-to-region start end)
1998 (encode-coding-region (point-min) (point-max) coding)
1999 (decode-coding-region (point-min) (point-max) new-coding)))
2000
b25eef20 2001(defun make-translation-table (&rest args)
a284eea3 2002 "Make a translation table from arguments.
d38b07f9 2003A translation table is a char table intended for character
a284eea3
DL
2004translation in CCL programs.
2005
d38b07f9 2006Each argument is a list of elements of the form (FROM . TO), where FROM
a284eea3 2007is a character to be translated to TO.
13d5617d 2008
452fdb31 2009FROM can be a generic character (see `make-char'). In this case, TO is
d38b07f9 2010a generic character containing the same number of characters, or an
452fdb31 2011ordinary character. If FROM and TO are both generic characters, all
b25eef20 2012characters belonging to FROM are translated to characters belonging to TO
4e003d37
KH
2013without changing their position code(s).
2014
2015The arguments and forms in each argument are processed in the given
2016order, and if a previous form already translates TO to some other
2017character, say TO-ALT, FROM is also translated to TO-ALT."
f967223b 2018 (let ((table (make-char-table 'translation-table))
a73a8c89
KH
2019 revlist)
2020 (while args
2021 (let ((elts (car args)))
2022 (while elts
13d5617d
KH
2023 (let* ((from (car (car elts)))
2024 (from-i 0) ; degree of freedom of FROM
2025 (from-rev (nreverse (split-char from)))
2026 (to (cdr (car elts)))
2027 (to-i 0) ; degree of freedom of TO
2028 (to-rev (nreverse (split-char to))))
2029 ;; Check numbers of heading 0s in FROM-REV and TO-REV.
2030 (while (eq (car from-rev) 0)
2031 (setq from-i (1+ from-i) from-rev (cdr from-rev)))
2032 (while (eq (car to-rev) 0)
2033 (setq to-i (1+ to-i) to-rev (cdr to-rev)))
2034 (if (and (/= from-i to-i) (/= to-i 0))
2035 (error "Invalid character pair (%d . %d)" from to))
b25eef20
KH
2036 ;; If we have already translated TO to TO-ALT, FROM should
2037 ;; also be translated to TO-ALT. But, this is only if TO
2038 ;; is a generic character or TO-ALT is not a generic
13d5617d
KH
2039 ;; character.
2040 (let ((to-alt (aref table to)))
2041 (if (and to-alt
2042 (or (> to-i 0) (not (generic-char-p to-alt))))
2043 (setq to to-alt)))
2044 (if (> from-i 0)
2045 (set-char-table-default table from to)
2046 (aset table from to))
b25eef20
KH
2047 ;; If we have already translated some chars to FROM, they
2048 ;; should also be translated to TO.
a73a8c89
KH
2049 (let ((l (assq from revlist)))
2050 (if l
2051 (let ((ch (car l)))
2052 (setcar l to)
2053 (setq l (cdr l))
2054 (while l
2055 (aset table ch to)
2056 (setq l (cdr l)) ))))
2057 ;; Now update REVLIST.
2058 (let ((l (assq to revlist)))
2059 (if l
2060 (setcdr l (cons from (cdr l)))
2061 (setq revlist (cons (list to from) revlist)))))
2062 (setq elts (cdr elts))))
2063 (setq args (cdr args)))
2064 ;; Return TABLE just created.
2065 table))
2066
c76b5c99
KH
2067(defun make-translation-table-from-vector (vec)
2068 "Make translation table from decoding vector VEC.
9e3b6057
DL
2069VEC is an array of 256 elements to map unibyte codes to multibyte
2070characters. Elements may be nil for undefined code points.
c76b5c99
KH
2071See also the variable `nonascii-translation-table'."
2072 (let ((table (make-char-table 'translation-table))
2073 (rev-table (make-char-table 'translation-table))
c76b5c99 2074 ch)
9e3b6057 2075 (dotimes (i 256)
c76b5c99 2076 (setq ch (aref vec i))
9e3b6057
DL
2077 (when ch
2078 (aset table i ch)
2079 (if (>= ch 256)
2080 (aset rev-table ch i))))
c76b5c99
KH
2081 (set-char-table-extra-slot table 0 rev-table)
2082 table))
2083
f967223b 2084(defun define-translation-table (symbol &rest args)
a284eea3
DL
2085 "Define SYMBOL as the name of translation table made by ARGS.
2086This sets up information so that the table can be used for
2087translations in a CCL program.
b25eef20 2088
a284eea3
DL
2089If the first element of ARGS is a char-table whose purpose is
2090`translation-table', just define SYMBOL to name it. (Note that this
2091function does not bind SYMBOL.)
007c79c8 2092
a284eea3 2093Any other ARGS should be suitable as arguments of the function
007c79c8 2094`make-translation-table' (which see).
b25eef20 2095
452fdb31 2096This function sets properties `translation-table' and
521d4010
DL
2097`translation-table-id' of SYMBOL to the created table itself and the
2098identification number of the table respectively. It also registers
2099the table in `translation-table-vector'."
007c79c8
KH
2100 (let ((table (if (and (char-table-p (car args))
2101 (eq (char-table-subtype (car args))
2102 'translation-table))
2103 (car args)
2104 (apply 'make-translation-table args)))
f967223b 2105 (len (length translation-table-vector))
d9e3229d 2106 (id 0)
b25eef20 2107 (done nil))
f967223b 2108 (put symbol 'translation-table table)
b25eef20
KH
2109 (while (not done)
2110 (if (>= id len)
f967223b
KH
2111 (setq translation-table-vector
2112 (vconcat translation-table-vector (make-vector len nil))))
2113 (let ((slot (aref translation-table-vector id)))
b25eef20
KH
2114 (if (or (not slot)
2115 (eq (car slot) symbol))
2116 (progn
f967223b 2117 (aset translation-table-vector id (cons symbol table))
007c79c8
KH
2118 (setq done t))
2119 (setq id (1+ id)))))
f967223b 2120 (put symbol 'translation-table-id id)
d9e3229d
KH
2121 id))
2122
0e86dca1
KH
2123(defun translate-region (start end table)
2124 "From START to END, translate characters according to TABLE.
2125TABLE is a string or a char-table.
2126If TABLE is a string, the Nth character in it is the mapping
2127for the character with code N.
2128If TABLE is a char-table, the element for character N is the mapping
2129for the character with code N.
2130It returns the number of characters changed."
2131 (interactive
2132 (list (region-beginning)
2133 (region-end)
2134 (let (table l)
2135 (dotimes (i (length translation-table-vector))
2136 (if (consp (aref translation-table-vector i))
2137 (push (list (symbol-name
2138 (car (aref translation-table-vector i)))) l)))
2139 (if (not l)
2140 (error "No translation table defined"))
2141 (while (not table)
2142 (setq table (completing-read "Translation table: " l nil t)))
2143 (intern table))))
2144 (if (symbolp table)
2145 (let ((val (get table 'translation-table)))
2146 (or (char-table-p val)
2147 (error "Invalid translation table name: %s" table))
2148 (setq table val)))
2149 (translate-region-internal start end table))
2150
35554641
KH
2151(put 'with-category-table 'lisp-indent-function 1)
2152
ef6e365d
JPW
2153(defmacro with-category-table (table &rest body)
2154 "Evaluate BODY with category table of current buffer set to TABLE.
2155The category table of the current buffer is saved, BODY is evaluated,
2156then the saved table is restored, even in case of an abnormal exit.
2157Value is what BODY returns."
2158 (let ((old-table (make-symbol "old-table"))
2159 (old-buffer (make-symbol "old-buffer")))
2160 `(let ((,old-table (category-table))
2161 (,old-buffer (current-buffer)))
2162 (unwind-protect
2163 (progn
2164 (set-category-table ,table)
2165 ,@body)
2166 (save-current-buffer
2167 (set-buffer ,old-buffer)
2168 (set-category-table ,old-table))))))
35554641 2169
394e4eb0
DL
2170(defun define-translation-hash-table (symbol table)
2171 "Define SYMBOL as the name of the hash translation TABLE for use in CCL.
2172
2173Analogous to `define-translation-table', but updates
2174`translation-hash-table-vector' and the table is for use in the CCL
2175`lookup-integer' and `lookup-character' functions."
2176 (unless (and (symbolp symbol)
2177 (hash-table-p table))
2178 (error "Bad args to define-translation-hash-table"))
2179 (let ((len (length translation-hash-table-vector))
2180 (id 0)
2181 done)
2182 (put symbol 'translation-hash-table table)
2183 (while (not done)
2184 (if (>= id len)
2185 (setq translation-hash-table-vector
2186 (vconcat translation-hash-table-vector [nil])))
2187 (let ((slot (aref translation-hash-table-vector id)))
2188 (if (or (not slot)
2189 (eq (car slot) symbol))
2190 (progn
2191 (aset translation-hash-table-vector id (cons symbol table))
2192 (setq done t))
2193 (setq id (1+ id)))))
2194 (put symbol 'translation-hash-table-id id)
2195 id))
2196
69eba008
KH
2197;;; Initialize some variables.
2198
2199(put 'use-default-ascent 'char-table-extra-slots 0)
2200(setq use-default-ascent (make-char-table 'use-default-ascent))
d6d6d592
KH
2201(put 'ignore-relative-composition 'char-table-extra-slots 0)
2202(setq ignore-relative-composition
2203 (make-char-table 'ignore-relative-composition))
69eba008 2204
d9f6dfe6
CW
2205
2206;;; Built-in auto-coding-functions:
2207
2208(defun sgml-xml-auto-coding-function (size)
2209 "Determine whether the buffer is XML, and if so, its encoding.
2210This function is intended to be added to `auto-coding-functions'."
c069d3ac
SM
2211 (setq size (+ (point) size))
2212 (when (re-search-forward "\\`[[:space:]\n]*<\\?xml" size t)
d9f6dfe6
CW
2213 (let ((end (save-excursion
2214 ;; This is a hack.
c2c51a11 2215 (re-search-forward "[\"']\\s-*\\?>" size t))))
d9f6dfe6 2216 (when end
c2c51a11 2217 (if (re-search-forward "encoding=[\"']\\(.+?\\)[\"']" end t)
447404a3
CW
2218 (let* ((match (match-string 1))
2219 (sym (intern (downcase match))))
2220 (if (coding-system-p sym)
2221 sym
2222 (message "Warning: unknown coding system \"%s\"" match)
2223 nil))
d9f6dfe6
CW
2224 'utf-8)))))
2225
447404a3
CW
2226(defun sgml-html-meta-auto-coding-function (size)
2227 "If the buffer has an HTML meta tag, use it to determine encoding.
2228This function is intended to be added to `auto-coding-functions'."
c069d3ac 2229 (setq size (min (+ (point) size)
447404a3
CW
2230 ;; Only search forward 10 lines
2231 (save-excursion
2232 (forward-line 10)
2233 (point))))
81668eb2 2234 (when (and (search-forward "<html" size t)
447404a3
CW
2235 (re-search-forward "<meta\\s-+http-equiv=\"content-type\"\\s-+content=\"text/\\sw+;\\s-*charset=\\(.+?\\)\"" size t))
2236 (let* ((match (match-string 1))
2237 (sym (intern (downcase match))))
2238 (if (coding-system-p sym)
2239 sym
2240 (message "Warning: unknown coding system \"%s\"" match)
2241 nil))))
0bca779a 2242
69eba008 2243;;;
4ed46869
KH
2244(provide 'mule)
2245
ab5796a9 2246;;; arch-tag: 9aebaa6e-0e8a-40a9-b857-cb5d04a39e7c
4ed46869 2247;;; mule.el ends here