(composition-function-table): Variable declaration
[bpt/emacs.git] / lisp / international / mule.el
CommitLineData
4ed46869
KH
1;;; mule.el --- basic commands for mulitilingual environment
2
4ed46869 3;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
58cfed09 4;; Licensed to the Free Software Foundation.
4ed46869
KH
5
6;; Keywords: mule, multilingual, character set, coding system
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software; you can redistribute it and/or modify
11;; it under the terms of the GNU General Public License as published by
12;; the Free Software Foundation; either version 2, or (at your option)
13;; any later version.
14
15;; GNU Emacs is distributed in the hope that it will be useful,
16;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
369314dc
KH
21;; along with GNU Emacs; see the file COPYING. If not, write to the
22;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23;; Boston, MA 02111-1307, USA.
4ed46869
KH
24
25;;; Code:
26
d2542b42 27(defconst mule-version "5.0 (SAKAKI)" "\
4ed46869
KH
28Version number and name of this version of MULE (multilingual environment).")
29
35554641 30(defconst mule-version-date "1999.12.7" "\
4ed46869
KH
31Distribution date of this version of MULE (multilingual environment).")
32
33(defun load-with-code-conversion (fullname file &optional noerror nomessage)
0f69cb38
KH
34 "Execute a file of Lisp code named FILE whose absolute name is FULLNAME.
35The file contents are decoded before evaluation if necessary.
4ed46869
KH
36If optional second arg NOERROR is non-nil,
37 report no error if FILE doesn't exist.
38Print messages at start and end of loading unless
39 optional third arg NOMESSAGE is non-nil.
40Return t if file exists."
41 (if (null (file-readable-p fullname))
42 (and (null noerror)
43 (signal 'file-error (list "Cannot open load file" file)))
44 ;; Read file with code conversion, and then eval.
45 (let* ((buffer
46 ;; To avoid any autoloading, set default-major-mode to
47 ;; fundamental-mode.
88162676
RS
48 ;; So that we don't get completely screwed if the
49 ;; file is encoded in some complicated character set,
50 ;; read it with real decoding, as a multibyte buffer,
51 ;; even if this is a --unibyte Emacs session.
52 (let ((default-major-mode 'fundamental-mode)
53 (default-enable-multibyte-characters t))
4ed46869
KH
54 ;; We can't use `generate-new-buffer' because files.el
55 ;; is not yet loaded.
56 (get-buffer-create (generate-new-buffer-name " *load*"))))
db5cae4b
SM
57 (load-in-progress t)
58 (source (save-match-data (string-match "\\.el\\'" fullname))))
59 (unless nomessage
60 (if source
61 (message "Loading %s (source)..." file)
62 (message "Loading %s..." file)))
63 (when purify-flag
64 (setq preloaded-file-list (cons file preloaded-file-list)))
4ed46869 65 (unwind-protect
a6acd8a2 66 (let ((load-file-name fullname)
1c4cc63a 67 (set-auto-coding-for-load t)
a6acd8a2 68 (inhibit-file-name-operation nil))
4ed46869
KH
69 (save-excursion
70 (set-buffer buffer)
71 (insert-file-contents fullname)
7d276780
EZ
72 ;; If the loaded file was inserted with no-conversion or
73 ;; raw-text coding system, make the buffer unibyte.
74 ;; Otherwise, eval-buffer might try to interpret random
75 ;; binary junk as multibyte characters.
76 (if (and enable-multibyte-characters
77 (or (eq (coding-system-type last-coding-system-used) 5)
78 (eq last-coding-system-used 'no-conversion)))
79 (set-buffer-multibyte nil))
4ed46869
KH
80 ;; Make `kill-buffer' quiet.
81 (set-buffer-modified-p nil))
0f69cb38 82 ;; Have the original buffer current while we eval.
88162676
RS
83 (eval-buffer buffer nil file
84 ;; If this Emacs is running with --unibyte,
85 ;; convert multibyte strings to unibyte
86 ;; after reading them.
ba74e833 87;; (not default-enable-multibyte-characters)
8dd08b5b 88 nil t
ba74e833 89 ))
cfc70cdf
RS
90 (let (kill-buffer-hook kill-buffer-query-functions)
91 (kill-buffer buffer)))
4ed46869 92 (let ((hook (assoc file after-load-alist)))
db5cae4b
SM
93 (when hook
94 (mapcar (function eval) (cdr hook))))
95 (unless (or nomessage noninteractive)
96 (if source
97 (message "Loading %s (source)...done" file)
98 (message "Loading %s...done" file)))
4ed46869
KH
99 t)))
100
101;; API (Application Program Interface) for charsets.
102
2e02a76f
RS
103;; Return t if OBJ is a quoted symbol
104;; and the symbol is the name of a standard charset.
105(defsubst charset-quoted-standard-p (obj)
106 (and (listp obj) (eq (car obj) 'quote)
107 (symbolp (car-safe (cdr obj)))
108 (let ((vector (get (car-safe (cdr obj)) 'charset)))
109 (and (vectorp vector)
110 (< (aref vector 0) 160)))))
4ed46869
KH
111
112(defsubst charsetp (object)
e4a7fdfc 113 "T if OBJECT is a charset."
4ed46869
KH
114 (and (symbolp object) (vectorp (get object 'charset))))
115
116(defsubst charset-info (charset)
117 "Return a vector of information of CHARSET.
118The elements of the vector are:
119 CHARSET-ID, BYTES, DIMENSION, CHARS, WIDTH, DIRECTION,
120 LEADING-CODE-BASE, LEADING-CODE-EXT,
121 ISO-FINAL-CHAR, ISO-GRAPHIC-PLANE,
122 REVERSE-CHARSET, SHORT-NAME, LONG-NAME, DESCRIPTION,
123 PLIST,
124where
125CHARSET-ID (integer) is the identification number of the charset.
aa8bb645
KH
126BYTES (integer) is the length of multi-byte form of a character in
127 the charset: one of 1, 2, 3, and 4.
4ed46869
KH
128DIMENSION (integer) is the number of bytes to represent a character of
129the charset: 1 or 2.
130CHARS (integer) is the number of characters in a dimension: 94 or 96.
4ed46869
KH
131WIDTH (integer) is the number of columns a character in the charset
132 occupies on the screen: one of 0, 1, and 2.
133DIRECTION (integer) is the rendering direction of characters in the
08b4ace5
KH
134 charset when rendering. If 0, render from left to right, else
135 render from right to left.
4ed46869
KH
136LEADING-CODE-BASE (integer) is the base leading-code for the
137 charset.
138LEADING-CODE-EXT (integer) is the extended leading-code for the
139 charset. All charsets of less than 0xA0 has the value 0.
140ISO-FINAL-CHAR (character) is the final character of the
141 corresponding ISO 2022 charset.
142ISO-GRAPHIC-PLANE (integer) is the graphic plane to be invoked
143 while encoding to variants of ISO 2022 coding system, one of the
144 following: 0/graphic-plane-left(GL), 1/graphic-plane-right(GR).
145REVERSE-CHARSET (integer) is the charset which differs only in
146 LEFT-TO-RIGHT value from the charset. If there's no such a
147 charset, the value is -1.
148SHORT-NAME (string) is the short name to refer to the charset.
149LONG-NAME (string) is the long name to refer to the charset
150DESCRIPTION (string) is the description string of the charset.
151PLIST (property list) may contain any type of information a user
152 want to put and get by functions `put-charset-property' and
153 `get-charset-property' respectively."
154 (get charset 'charset))
155
40c81f74
PE
156;; It is better not to use backquote in this file,
157;; because that makes a bootstrapping problem
158;; if you need to recompile all the Lisp files using interpreted code.
159
4ed46869
KH
160(defmacro charset-id (charset)
161 "Return charset identification number of CHARSET."
2e02a76f 162 (if (charset-quoted-standard-p charset)
4ed46869 163 (aref (charset-info (nth 1 charset)) 0)
40c81f74 164 (list 'aref (list 'charset-info charset) 0)))
4ed46869
KH
165
166(defmacro charset-bytes (charset)
900dc6e3
KH
167 "Return bytes of CHARSET.
168See the function `charset-info' for more detail."
2e02a76f 169 (if (charset-quoted-standard-p charset)
4ed46869 170 (aref (charset-info (nth 1 charset)) 1)
40c81f74 171 (list 'aref (list 'charset-info charset) 1)))
4ed46869
KH
172
173(defmacro charset-dimension (charset)
900dc6e3
KH
174 "Return dimension of CHARSET.
175See the function `charset-info' for more detail."
2e02a76f 176 (if (charset-quoted-standard-p charset)
4ed46869 177 (aref (charset-info (nth 1 charset)) 2)
40c81f74 178 (list 'aref (list 'charset-info charset) 2)))
4ed46869
KH
179
180(defmacro charset-chars (charset)
900dc6e3
KH
181 "Return character numbers contained in a dimension of CHARSET.
182See the function `charset-info' for more detail."
2e02a76f 183 (if (charset-quoted-standard-p charset)
4ed46869 184 (aref (charset-info (nth 1 charset)) 3)
40c81f74 185 (list 'aref (list 'charset-info charset) 3)))
4ed46869
KH
186
187(defmacro charset-width (charset)
900dc6e3
KH
188 "Return width (how many column occupied on a screen) of CHARSET.
189See the function `charset-info' for more detail."
2e02a76f 190 (if (charset-quoted-standard-p charset)
4ed46869 191 (aref (charset-info (nth 1 charset)) 4)
40c81f74 192 (list 'aref (list 'charset-info charset) 4)))
4ed46869
KH
193
194(defmacro charset-direction (charset)
900dc6e3
KH
195 "Return direction of CHARSET.
196See the function `charset-info' for more detail."
2e02a76f 197 (if (charset-quoted-standard-p charset)
4ed46869 198 (aref (charset-info (nth 1 charset)) 5)
40c81f74 199 (list 'aref (list 'charset-info charset) 5)))
4ed46869
KH
200
201(defmacro charset-iso-final-char (charset)
900dc6e3
KH
202 "Return final char of CHARSET.
203See the function `charset-info' for more detail."
2e02a76f 204 (if (charset-quoted-standard-p charset)
4ed46869 205 (aref (charset-info (nth 1 charset)) 8)
40c81f74 206 (list 'aref (list 'charset-info charset) 8)))
4ed46869
KH
207
208(defmacro charset-iso-graphic-plane (charset)
900dc6e3
KH
209 "Return graphic plane of CHARSET.
210See the function `charset-info' for more detail."
2e02a76f 211 (if (charset-quoted-standard-p charset)
4ed46869 212 (aref (charset-info (nth 1 charset)) 9)
40c81f74 213 (list 'aref (list 'charset-info charset) 9)))
4ed46869
KH
214
215(defmacro charset-reverse-charset (charset)
900dc6e3
KH
216 "Return reverse charset of CHARSET.
217See the function `charset-info' for more detail."
2e02a76f 218 (if (charset-quoted-standard-p charset)
4ed46869 219 (aref (charset-info (nth 1 charset)) 10)
40c81f74 220 (list 'aref (list 'charset-info charset) 10)))
4ed46869
KH
221
222(defmacro charset-short-name (charset)
900dc6e3
KH
223 "Return short name of CHARSET.
224See the function `charset-info' for more detail."
2e02a76f 225 (if (charset-quoted-standard-p charset)
4ed46869 226 (aref (charset-info (nth 1 charset)) 11)
40c81f74 227 (list 'aref (list 'charset-info charset) 11)))
4ed46869
KH
228
229(defmacro charset-long-name (charset)
900dc6e3
KH
230 "Return long name of CHARSET.
231See the function `charset-info' for more detail."
2e02a76f 232 (if (charset-quoted-standard-p charset)
4ed46869 233 (aref (charset-info (nth 1 charset)) 12)
40c81f74 234 (list 'aref (list 'charset-info charset) 12)))
4ed46869
KH
235
236(defmacro charset-description (charset)
0611934b 237 "Return description of CHARSET.
900dc6e3 238See the function `charset-info' for more detail."
2e02a76f 239 (if (charset-quoted-standard-p charset)
4ed46869 240 (aref (charset-info (nth 1 charset)) 13)
40c81f74 241 (list 'aref (list 'charset-info charset) 13)))
4ed46869
KH
242
243(defmacro charset-plist (charset)
900dc6e3
KH
244 "Return list charset property of CHARSET.
245See the function `charset-info' for more detail."
40c81f74
PE
246 (list 'aref
247 (if (charset-quoted-standard-p charset)
248 (charset-info (nth 1 charset))
249 (list 'charset-info charset))
250 14))
4ed46869
KH
251
252(defun set-charset-plist (charset plist)
e8dd0160 253 "Set CHARSET's property list to PLIST, and return PLIST."
4ed46869
KH
254 (aset (charset-info charset) 14 plist))
255
a6acd8a2 256(defun make-char (charset &optional c1 c2)
a9fb0b58 257 "Return a character of CHARSET and position codes CODE1 and CODE2.
f98e2797 258CODE1 and CODE2 are optional, but if you don't supply
a9fb0b58
KH
259sufficient position codes, return a generic character which stands for
260all characters or group of characters in the character set.
a73a8c89 261A generic character can be used to index a char table (e.g. syntax-table)."
a6acd8a2
KH
262 (make-char-internal (charset-id charset) c1 c2))
263
264(put 'make-char 'byte-compile
265 (function
266 (lambda (form)
267 (let ((charset (nth 1 form)))
268 (if (charset-quoted-standard-p charset)
269 (byte-compile-normal-call
270 (cons 'make-char-internal
271 (cons (charset-id (nth 1 charset)) (nthcdr 2 form))))
272 (byte-compile-normal-call
273 (cons 'make-char-internal
274 (cons (list 'charset-id charset) (nthcdr 2 form)))))))))
4ed46869 275
d3675a42 276(defun charset-list ()
900dc6e3
KH
277 "Return list of charsets ever defined.
278
d3675a42 279This function is provided for backward compatibility.
900dc6e3 280Now we have the variable `charset-list'."
d3675a42
KH
281 charset-list)
282
13d5617d
KH
283(defsubst generic-char-p (char)
284 "Return t if and only if CHAR is a generic character.
285See also the documentation of make-char."
1d935669
KH
286 (and (>= char 0400)
287 (let ((l (split-char char)))
288 (and (or (= (nth 1 l) 0) (eq (nth 2 l) 0))
289 (not (eq (car l) 'composition))))))
69eba008 290
cc57cc54
KH
291(defun decode-char (ccs code-point &optional restriction)
292 "Return a character specified by coded character set CCS and CODE-POINT in it.
293Return nil if such a character is not supported.
294Currently, supported coded character set is `ucs' (ISO/IEC
29510646: Universal Multi-Octet Coded Character Set) only.
296
297Optional argument RESTRICTION specifies a way to map the pair of CCS
298and CODE-POINT to a chracter. Currently not supported and just ignored."
299 (cond ((eq ccs 'ucs)
300 (cond ((< code-point 128)
301 code-point)
302 ((< code-point 256)
303 (make-char 'latin-iso8859-1 code-point))
304 ((< code-point #x2500)
305 (setq code-point (- code-point #x0100))
306 (make-char 'mule-unicode-0100-24ff
307 (+ (/ code-point 96) 32) (+ (% code-point 96) 32)))
308 ((< code-point #x33ff)
309 (setq code-point (- code-point #x2500))
310 (make-char 'mule-unicode-2500-33ff
311 (+ (/ code-point 96) 32) (+ (% code-point 96) 32)))
312 ((and (>= code-point #xe000) (< code-point #x10000))
313 (setq code-point (- code-point #xe000))
314 (make-char 'mule-unicode-e000-ffff
315 (+ (/ code-point 96) 32) (+ (% code-point 96) 32)))
316 ))))
317
318(defun encode-char (char ccs &optional restriction)
319 "Return a code-point in coded character set CCS that corresponds to CHAR.
320Return nil if CHAR is not included in CCS.
321Currently, supported coded character set is `ucs' (ISO/IEC
32210646: Universal Multi-Octet Coded Character Set) only.
323Return a Unicode character code for CHAR.
324Charset of CHAR should be one of these:
325 ascii, latin-iso8859-1, mule-unicode-0100-24ff, mule-unicode-2500-33ff,
326 mule-unicode-e000-ffff
327Otherwise, return nil.
328
329Optional argument RESTRICTION specifies a way to map CHAR to a
330code-point in CCS. Currently not supported and just ignored."
331 (let* ((split (split-char char))
332 (charset (car split)))
333 (cond ((eq ccs 'ucs)
334 (cond ((eq charset 'ascii)
335 char)
336 ((eq charset 'latin-iso8859-1)
337 (+ (nth 1 split) 128))
338 ((eq charset 'mule-unicode-0100-24ff)
339 (+ #x0100 (+ (* (- (nth 1 split) 32) 96)
340 (- (nth 2 split) 32))))
341 ((eq charset 'mule-unicode-2500-33ff)
342 (+ #x2500 (+ (* (- (nth 1 split) 32) 96)
343 (- (nth 2 split) 32))))
344 ((eq charset 'mule-unicode-e000-ffff)
345 (+ #xe000 (+ (* (- (nth 1 split) 32) 96)
346 (- (nth 2 split) 32)))))))))
347
0269ddfb 348\f
8057896b 349;; Coding system staffs
4ed46869 350
8057896b 351;; Coding system is a symbol that has the property `coding-system'.
4ed46869 352;;
8057896b
KH
353;; The value of the property `coding-system' is a vector of the
354;; following format:
d3675a42 355;; [TYPE MNEMONIC DOC-STRING PLIST FLAGS]
8057896b 356;; We call this vector as coding-spec. See comments in src/coding.c
d3675a42 357;; for more detail.
8057896b
KH
358
359(defconst coding-spec-type-idx 0)
360(defconst coding-spec-mnemonic-idx 1)
361(defconst coding-spec-doc-string-idx 2)
0269ddfb 362(defconst coding-spec-plist-idx 3)
8057896b
KH
363(defconst coding-spec-flags-idx 4)
364
a6acd8a2
KH
365;; PLIST is a property list of a coding system. To share PLIST among
366;; alias coding systems, a coding system has PLIST in coding-spec
367;; instead of having it in normal property list of Lisp symbol.
368;; Here's a list of coding system properties currently being used.
0269ddfb
KH
369;;
370;; o coding-category
371;;
372;; The value is a coding category the coding system belongs to. The
1b46a680
KH
373;; function `make-coding-system' sets this value automatically
374;; unless its argument PROPERTIES specifies this property.
4ed46869 375;;
0269ddfb 376;; o alias-coding-systems
4ed46869 377;;
0269ddfb
KH
378;; The value is a list of coding systems of the same alias group. The
379;; first element is the coding system made at first, which we call as
1b46a680
KH
380;; `base coding system'. The function `make-coding-system' sets this
381;; value automatically and `define-coding-system-alias' updates it.
0269ddfb
KH
382;;
383;; o post-read-conversion
384;;
385;; The value is a function to call after some text is inserted and
386;; decoded by the coding system itself and before any functions in
387;; `after-insert-functions' are called. The arguments to this
388;; function is the same as those of a function in
4ed46869
KH
389;; `after-insert-functions', i.e. LENGTH of a text while putting point
390;; at the head of the text to be decoded
391;;
0269ddfb
KH
392;; o pre-write-conversion
393;;
394;; The value is a function to call after all functions in
395;; `write-region-annotate-functions' and `buffer-file-format' are
396;; called, and before the text is encoded by the coding system itself.
397;; The arguments to this function is the same as those of a function
398;; in `write-region-annotate-functions', i.e. FROM and TO specifying
399;; region of a text.
400;;
f967223b 401;; o translation-table-for-decode
0269ddfb 402;;
f967223b
KH
403;; The value is a translation table to be applied on decoding. See
404;; the function `make-translation-table' for the format of translation
405;; table.
0269ddfb 406;;
f967223b 407;; o translation-table-for-encode
0269ddfb 408;;
f967223b 409;; The value is a translation table to be applied on encoding.
a6acd8a2 410;;
c11a8f77
KH
411;; o safe-chars
412;;
413;; The value is a char table. If a character has non-nil value in it,
414;; the character is safely supported by the coding system. This
415;; overrides the specification of safe-charsets.
416
a6acd8a2
KH
417;; o safe-charsets
418;;
419;; The value is a list of charsets safely supported by the coding
420;; system. The value t means that all charsets Emacs handles are
421;; supported. Even if some charset is not in this list, it doesn't
422;; mean that the charset can't be encoded in the coding system,
423;; instead, it just means that some other receiver of a text encoded
424;; in the coding system won't be able to handle that charset.
b25eef20
KH
425;;
426;; o mime-charset
427;;
428;; The value is a symbol of which name is `MIME-charset' parameter of
429;; the coding system.
c76b5c99 430;;
1322c8ca
KH
431;; o charset-origin-alist
432;;
433;; The value is a list of this form:
434;; (CHARSET EXTERNAL-CHARSET-NAME ENCODING-FUNCTION).
435;; ENCODING-FUNCTION is a function to encode a character in CHARSET
436;; to the code in EXTERNAL-CHARSET-NAME. The command what-cursor-position
437;; uses this information of the buffer-file-coding-system.
caa85ad9
KH
438;; ENCODING-FUNCTION may be a translation table or a symbol whose
439;; property `translation-table' is a translation table. In these case,
440;; the translation table is used to encode the character.
1322c8ca 441;;
c76b5c99
KH
442;; o valid-codes (meaningful only for a coding system based on CCL)
443;;
444;; The value is a list to indicate valid byte ranges of the encoded
445;; file. Each element of the list is an integer or a cons of integer.
446;; In the former case, the integer value is a valid byte code. In the
e8dd0160 447;; latter case, the integers specifies the range of valid byte codes.
c76b5c99 448
0269ddfb
KH
449
450;; Return coding-spec of CODING-SYSTEM
451(defsubst coding-system-spec (coding-system)
452 (get (check-coding-system coding-system) 'coding-system))
4ed46869 453
4ed46869 454(defun coding-system-type (coding-system)
0269ddfb
KH
455 "Return the coding type of CODING-SYSTEM.
456A coding type is an integer value indicating the encoding method
457of CODING-SYSTEM. See the function `make-coding-system' for more detail."
458 (aref (coding-system-spec coding-system) coding-spec-type-idx))
4ed46869 459
4ed46869 460(defun coding-system-mnemonic (coding-system)
0269ddfb 461 "Return the mnemonic character of CODING-SYSTEM.
6e2c8840
KH
462The mnemonic character of a coding system is used in mode line
463to indicate the coding system. If the arg is nil, return ?-."
464 (let ((spec (coding-system-spec coding-system)))
465 (if spec (aref spec coding-spec-mnemonic-idx) ?-)))
4ed46869 466
8057896b 467(defun coding-system-doc-string (coding-system)
0269ddfb
KH
468 "Return the documentation string for CODING-SYSTEM."
469 (aref (coding-system-spec coding-system) coding-spec-doc-string-idx))
4ed46869 470
d3675a42 471(defun coding-system-plist (coding-system)
0269ddfb
KH
472 "Return the property list of CODING-SYSTEM."
473 (aref (coding-system-spec coding-system) coding-spec-plist-idx))
d3675a42 474
4ed46869 475(defun coding-system-flags (coding-system)
0269ddfb
KH
476 "Return `flags' of CODING-SYSTEM.
477A `flags' of a coding system is a vector of length 32 indicating detailed
478information of a coding system. See the function `make-coding-system'
479for more detail."
480 (aref (coding-system-spec coding-system) coding-spec-flags-idx))
481
482(defun coding-system-get (coding-system prop)
483 "Extract a value from CODING-SYSTEM's property list for property PROP."
484 (plist-get (coding-system-plist coding-system) prop))
485
486(defun coding-system-put (coding-system prop val)
487 "Change value in CODING-SYSTEM's property list PROP to VAL."
488 (let ((plist (coding-system-plist coding-system)))
489 (if plist
490 (plist-put plist prop val)
491 (aset (coding-system-spec coding-system) coding-spec-plist-idx
492 (list prop val)))))
493
494(defun coding-system-category (coding-system)
495 "Return the coding category of CODING-SYSTEM."
496 (coding-system-get coding-system 'coding-category))
497
498(defun coding-system-base (coding-system)
499 "Return the base coding system of CODING-SYSTEM.
d9e3229d
KH
500A base coding system is what made by `make-coding-system'.
501Any alias nor subsidiary coding systems are not base coding system."
0269ddfb
KH
502 (car (coding-system-get coding-system 'alias-coding-systems)))
503
504(defalias 'coding-system-parent 'coding-system-base)
2598a293 505(make-obsolete 'coding-system-parent 'coding-system-base "20.3")
0269ddfb
KH
506
507;; Coding system also has a property `eol-type'.
508;;
509;; This property indicates how the coding system handles end-of-line
510;; format. The value is integer 0, 1, 2, or a vector of three coding
511;; systems. Each integer value 0, 1, and 2 indicates the format of
512;; end-of-line LF, CRLF, and CR respectively. A vector value
513;; indicates that the format of end-of-line should be detected
514;; automatically. Nth element of the vector is the subsidiary coding
515;; system whose `eol-type' property is N.
4ed46869 516
8057896b 517(defun coding-system-eol-type (coding-system)
0269ddfb
KH
518 "Return eol-type of CODING-SYSTEM.
519An eol-type is integer 0, 1, 2, or a vector of coding systems.
4ed46869 520
0269ddfb
KH
521Integer values 0, 1, and 2 indicate a format of end-of-line; LF,
522CRLF, and CR respectively.
523
524A vector value indicates that a format of end-of-line should be
525detected automatically. Nth element of the vector is the subsidiary
526coding system whose eol-type is N."
527 (get coding-system 'eol-type))
bd882697 528
857ea15c
AS
529(defun coding-system-lessp (x y)
530 (cond ((eq x 'no-conversion) t)
531 ((eq y 'no-conversion) nil)
532 ((eq x 'emacs-mule) t)
533 ((eq y 'emacs-mule) nil)
534 ((eq x 'undecided) t)
535 ((eq y 'undecided) nil)
536 (t (let ((c1 (coding-system-mnemonic x))
537 (c2 (coding-system-mnemonic y)))
538 (or (< (downcase c1) (downcase c2))
539 (and (not (> (downcase c1) (downcase c2)))
540 (< c1 c2)))))))
541
542;; Add CODING-SYSTEM to coding-system-list while keeping it sorted.
543(defun add-to-coding-system-list (coding-system)
544 (if (or (null coding-system-list)
545 (coding-system-lessp coding-system (car coding-system-list)))
546 (setq coding-system-list (cons coding-system coding-system-list))
547 (let ((len (length coding-system-list))
548 mid (tem coding-system-list))
549 (while (> len 1)
550 (setq mid (nthcdr (/ len 2) tem))
551 (if (coding-system-lessp (car mid) coding-system)
552 (setq tem mid
553 len (- len (/ len 2)))
554 (setq len (/ len 2))))
555 (setcdr tem (cons coding-system (cdr tem))))))
556
80a7463d 557(defun coding-system-list (&optional base-only)
c11a8f77
KH
558 "Return a list of all existing non-subsidiary coding systems.
559If optional arg BASE-ONLY is non-nil, only base coding systems are listed.
560The value doesn't include subsidiary coding systems which are what
561made from bases and aliases automatically for various end-of-line
562formats (e.g. iso-latin-1-unix, koi8-r-dos)."
80a7463d
KH
563 (let* ((codings (copy-sequence coding-system-list))
564 (tail (cons nil codings)))
565 ;; Remove subsidiary coding systems (eol variants) and alias
566 ;; coding systems (if necessary).
567 (while (cdr tail)
568 (let* ((coding (car (cdr tail)))
569 (aliases (coding-system-get coding 'alias-coding-systems)))
570 (if (or
571 ;; CODING is an eol variant if not in ALIASES.
572 (not (memq coding aliases))
573 ;; CODING is an alias if it is not car of ALIASES.
574 (and base-only (not (eq coding (car aliases)))))
575 (setcdr tail (cdr (cdr tail)))
576 (setq tail (cdr tail)))))
577 codings))
578
c11a8f77
KH
579(defun register-char-codings (coding-system safe-chars)
580 (let ((general (char-table-extra-slot char-coding-system-table 0)))
581 (if (eq safe-chars t)
582 (or (memq coding-system general)
583 (set-char-table-extra-slot char-coding-system-table 0
584 (cons coding-system general)))
585 (map-char-table
586 (function
587 (lambda (key val)
588 (if (and (>= key 128) val)
589 (let ((codings (aref char-coding-system-table key)))
590 (or (memq coding-system codings)
591 (aset char-coding-system-table key
592 (cons coding-system codings)))))))
593 safe-chars))))
594
595
6e9722b0
KH
596;; Make subsidiary coding systems (eol-type variants) of CODING-SYSTEM.
597(defun make-subsidiary-coding-system (coding-system)
0269ddfb
KH
598 (let ((coding-spec (coding-system-spec coding-system))
599 (subsidiaries (vector (intern (format "%s-unix" coding-system))
8057896b
KH
600 (intern (format "%s-dos" coding-system))
601 (intern (format "%s-mac" coding-system))))
0269ddfb
KH
602 (i 0)
603 temp)
8057896b 604 (while (< i 3)
0269ddfb 605 (put (aref subsidiaries i) 'coding-system coding-spec)
8057896b 606 (put (aref subsidiaries i) 'eol-type i)
857ea15c 607 (add-to-coding-system-list (aref subsidiaries i))
0269ddfb
KH
608 (setq coding-system-alist
609 (cons (list (symbol-name (aref subsidiaries i)))
610 coding-system-alist))
8057896b
KH
611 (setq i (1+ i)))
612 subsidiaries))
4ed46869 613
8057896b 614(defun make-coding-system (coding-system type mnemonic doc-string
1b46a680
KH
615 &optional
616 flags
617 properties
618 eol-type)
3bb1accb 619 "Define a new coding system CODING-SYSTEM (symbol).
a6acd8a2 620Remaining arguments are TYPE, MNEMONIC, DOC-STRING, FLAGS (optional),
d9e3229d 621and PROPERTIES (optional) which construct a coding-spec of CODING-SYSTEM
a6acd8a2 622in the following format:
0269ddfb 623 [TYPE MNEMONIC DOC-STRING PLIST FLAGS]
3bb1accb
KH
624
625TYPE is an integer value indicating the type of the coding system as follows:
4ed46869
KH
626 0: Emacs internal format,
627 1: Shift-JIS (or MS-Kanji) used mainly on Japanese PC,
628 2: ISO-2022 including many variants,
629 3: Big5 used mainly on Chinese PC,
cd9c3177
KH
630 4: private, CCL programs provide encoding/decoding algorithm,
631 5: Raw-text, which means that text contains random 8-bit codes.
0269ddfb 632
3bb1accb 633MNEMONIC is a character to be displayed on mode line for the coding system.
0269ddfb 634
3bb1accb 635DOC-STRING is a documentation string for the coding system.
0269ddfb 636
3bb1accb 637FLAGS specifies more detailed information of the coding system as follows:
d6d6d592 638
3bb1accb 639 If TYPE is 2 (ISO-2022), FLAGS is a list of these elements:
4ed46869
KH
640 CHARSET0, CHARSET1, CHARSET2, CHARSET3, SHORT-FORM,
641 ASCII-EOL, ASCII-CNTL, SEVEN, LOCKING-SHIFT, SINGLE-SHIFT,
d6d6d592 642 USE-ROMAN, USE-OLDJIS, NO-ISO6429, INIT-BOL, DESIGNATION-BOL,
850101ed 643 SAFE, ACCEPT-LATIN-EXTRA-CODE.
4ed46869
KH
644 CHARSETn are character sets initially designated to Gn graphic registers.
645 If CHARSETn is nil, Gn is never used.
646 If CHARSETn is t, Gn can be used but nothing designated initially.
647 If CHARSETn is a list of character sets, those character sets are
648 designated to Gn on output, but nothing designated to Gn initially.
421e3b4e 649 But, character set `ascii' can be designated only to G0.
4ed46869
KH
650 SHORT-FORM non-nil means use short designation sequence on output.
651 ASCII-EOL non-nil means designate ASCII to g0 at end of line on output.
652 ASCII-CNTL non-nil means designate ASCII to g0 before control codes and
653 SPACE on output.
654 SEVEN non-nil means use 7-bit code only on output.
655 LOCKING-SHIFT non-nil means use locking-shift.
656 SINGLE-SHIFT non-nil means use single-shift.
657 USE-ROMAN non-nil means designate JIS0201-1976-Roman instead of ASCII.
658 USE-OLDJIS non-nil means designate JIS0208-1976 instead of JIS0208-1983.
659 NO-ISO6429 non-nil means not use ISO6429's direction specification.
69eba008
KH
660 INIT-BOL non-nil means any designation state is assumed to be reset
661 to initial at each beginning of line on output.
662 DESIGNATION-BOL non-nil means designation sequences should be placed
663 at beginning of line on output.
a6acd8a2 664 SAFE non-nil means convert unsafe characters to `?' on output.
c11a8f77
KH
665 Characters not specified in the property `safe-charsets' nor
666 `safe-chars' are unsafe.
850101ed
RS
667 ACCEPT-LATIN-EXTRA-CODE non-nil means code-detection routine accepts
668 a code specified in `latin-extra-code-table' (which see) as a valid
669 code of the coding system.
d6d6d592 670
3bb1accb
KH
671 If TYPE is 4 (private), FLAGS should be a cons of CCL programs, for
672 decoding and encoding. CCL programs should be specified by their
673 symbols.
d9e3229d
KH
674
675PROPERTIES is an alist of properties vs the corresponding values.
676These properties are set in PLIST, a property list. This function
677also sets properties `coding-category' and `alias-coding-systems'
678automatically.
4ed46869 679
1b46a680
KH
680EOL-TYPE specifies the EOL type of the coding-system in one of the
681following formats:
682
683 o symbol (unix, dos, or mac)
684
685 The symbol `unix' means Unix-like EOL (LF), `dos' means
686 DOS-like EOL (CRLF), and `mac' means MAC-like EOL (CR).
687
688 o number (0, 1, or 2)
689
690 The number 0, 1, and 2 mean UNIX, DOS, and MAC-like EOL
691 respectively.
692
693 o vector of coding-systems of length 3
694
695 The EOL type is detected automatically for the coding system.
696 And, according to the detected EOL type, one of the coding
697 systems in the vector is selected. Elements of the vector
4d3a9228 698 corresponds to Unix-like EOL, DOS-like EOL, and Mac-like EOL
1b46a680
KH
699 in this order.
700
3bb1accb
KH
701Kludgy features for backward compatibility:
702
7031. If TYPE is 4 and car or cdr of FLAGS is a vector, the vector is
704treated as a compiled CCL code.
705
7062. If PROPERTIES is just a list of character sets, the list is set as
707a value of `safe-charsets' in PLIST."
0269ddfb 708 ;; Set a value of `coding-system' property.
6e9722b0 709 (let ((coding-spec (make-vector 5 nil))
d9e3229d
KH
710 (no-initial-designation t)
711 (no-alternative-designation t)
6e9722b0 712 coding-category)
cd9c3177 713 (if (or (not (integerp type)) (< type 0) (> type 5))
0269ddfb 714 (error "TYPE argument must be 0..5"))
8057896b 715 (if (or (not (integerp mnemonic)) (<= mnemonic ? ) (> mnemonic 127))
e8dd0160 716 (error "MNEMONIC argument must be an ASCII printable character."))
0269ddfb
KH
717 (aset coding-spec coding-spec-type-idx type)
718 (aset coding-spec coding-spec-mnemonic-idx mnemonic)
719 (aset coding-spec coding-spec-doc-string-idx
e127a722 720 (purecopy (if (stringp doc-string) doc-string "")))
6e9722b0
KH
721 (cond ((= type 0)
722 (setq coding-category 'coding-category-emacs-mule))
723 ((= type 1)
724 (setq coding-category 'coding-category-sjis))
725 ((= type 2) ; ISO2022
4ed46869 726 (let ((i 0)
6e9722b0 727 (vec (make-vector 32 nil))
05134257
KH
728 (g1-designation nil)
729 (fl flags))
4ed46869 730 (while (< i 4)
05134257 731 (let ((charset (car fl)))
6e9722b0
KH
732 (if (and no-initial-designation
733 (> i 0)
734 (or (charsetp charset)
735 (and (consp charset)
736 (charsetp (car charset)))))
737 (setq no-initial-designation nil))
738 (if (charsetp charset)
739 (if (= i 1) (setq g1-designation charset))
740 (if (consp charset)
741 (let ((tail charset)
742 elt)
743 (while tail
744 (setq elt (car tail))
d9e3229d
KH
745 (if (eq elt t)
746 (setq no-alternative-designation nil)
747 (if (and elt (not (charsetp elt)))
748 (error "Invalid charset: %s" elt)))
6e9722b0
KH
749 (setq tail (cdr tail)))
750 (setq g1-designation (car charset)))
d9e3229d
KH
751 (if charset
752 (if (eq charset t)
753 (setq no-alternative-designation nil)
754 (error "Invalid charset: %s" charset)))))
4ed46869 755 (aset vec i charset))
05134257
KH
756 (setq fl (cdr fl) i (1+ i)))
757 (while (and (< i 32) fl)
758 (aset vec i (car fl))
759 (setq fl (cdr fl) i (1+ i)))
6e9722b0 760 (aset coding-spec 4 vec)
6e9722b0
KH
761 (setq coding-category
762 (if (aref vec 8) ; Use locking-shift.
dc64cd19
KH
763 (or (and (aref vec 7) 'coding-category-iso-7-else)
764 'coding-category-iso-8-else)
6e9722b0
KH
765 (if (aref vec 7) ; 7-bit only.
766 (if (aref vec 9) ; Use single-shift.
dc64cd19 767 'coding-category-iso-7-else
d9e3229d
KH
768 (if no-alternative-designation
769 'coding-category-iso-7-tight
770 'coding-category-iso-7))
3ad911d8
KH
771 (if (or no-initial-designation
772 (not no-alternative-designation))
dc64cd19 773 'coding-category-iso-8-else
6e9722b0
KH
774 (if (and (charsetp g1-designation)
775 (= (charset-dimension g1-designation) 2))
776 'coding-category-iso-8-2
777 'coding-category-iso-8-1)))))))
778 ((= type 3)
779 (setq coding-category 'coding-category-big5))
780 ((= type 4) ; private
c76b5c99 781 (setq coding-category 'coding-category-ccl)
3bb1accb
KH
782 (if (not (consp flags))
783 (error "Invalid FLAGS argument for TYPE 4 (CCL)")
784 (let ((decoder (check-ccl-program
785 (car flags)
786 (intern (format "%s-decoder" coding-system))))
787 (encoder (check-ccl-program
788 (cdr flags)
789 (intern (format "%s-encoder" coding-system)))))
790 (if (and decoder encoder)
791 (aset coding-spec 4 (cons decoder encoder))
792 (error "Invalid FLAGS argument for TYPE 4 (CCL)")))))
cd9c3177
KH
793 (t ; i.e. (= type 5)
794 (setq coding-category 'coding-category-raw-text)))
0269ddfb
KH
795
796 (let ((plist (list 'coding-category coding-category
d9e3229d 797 'alias-coding-systems (list coding-system))))
0269ddfb 798 (if no-initial-designation
d9e3229d
KH
799 (plist-put plist 'no-initial-designation t))
800 (if (and properties
801 (or (eq properties t)
802 (not (consp (car properties)))))
803 ;; In the old version, the arg PROPERTIES is a list to be
804 ;; set in PLIST as a value of property `safe-charsets'.
c11a8f77
KH
805 (setq properties (list (cons 'safe-charsets properties))))
806 ;; In the current version PROPERTIES is a property list.
807 ;; Reflect it into PLIST one by one while handling safe-chars
808 ;; specially.
809 (let ((safe-charsets (cdr (assq 'safe-charsets properties)))
810 (safe-chars (cdr (assq 'safe-chars properties)))
811 (l properties)
812 prop val)
813 ;; If only safe-charsets is specified, make a char-table from
814 ;; it, and store that char-table as the value of `safe-chars'.
815 (if (and (not safe-chars) safe-charsets)
816 (let (charset)
817 (if (eq safe-charsets t)
818 (setq safe-chars t)
819 (setq safe-chars (make-char-table 'safe-chars))
820 (while safe-charsets
821 (setq charset (car safe-charsets)
822 safe-charsets (cdr safe-charsets))
823 (cond ((eq charset 'ascii)) ; just ignore
824 ((eq charset 'eight-bit-control)
825 (let ((i 128))
826 (while (< i 160)
827 (aset safe-chars i t)
828 (setq i (1+ i)))))
829 ((eq charset 'eight-bit-graphic)
830 (let ((i 160))
831 (while (< i 256)
832 (aset safe-chars i t)
833 (setq i (1+ i)))))
834 (t
835 (aset safe-chars (make-char charset) t)))))
836 (setq l (cons (cons 'safe-chars safe-chars) l))))
837 (while l
838 (setq prop (car (car l)) val (cdr (car l)) l (cdr l))
839 (if (eq prop 'safe-chars)
840 (progn
cc57cc54
KH
841 (if (and (symbolp val)
842 (get val 'translation-table))
843 (setq safe-chars (get val 'translation-table)))
844 (register-char-codings coding-system safe-chars)
845 (setq val safe-chars)))
c11a8f77 846 (plist-put plist prop val)))
1b46a680
KH
847 ;; The property `coding-category' may have been set differently
848 ;; through PROPERTIES.
849 (setq coding-category (plist-get plist 'coding-category))
0269ddfb 850 (aset coding-spec coding-spec-plist-idx plist))
6e9722b0 851 (put coding-system 'coding-system coding-spec)
6e9722b0
KH
852 (put coding-category 'coding-systems
853 (cons coding-system (get coding-category 'coding-systems))))
4ed46869 854
1b46a680 855 ;; Next, set a value of `eol-type' property.
af873cd1 856 (if (not eol-type)
1b46a680
KH
857 ;; If EOL-TYPE is nil, set a vector of subsidiary coding
858 ;; systems, each corresponds to a coding system for the detected
859 ;; EOL format.
860 (setq eol-type (make-subsidiary-coding-system coding-system)))
861 (setq eol-type
862 (cond ((or (eq eol-type 'unix) (null eol-type))
863 0)
864 ((eq eol-type 'dos)
865 1)
866 ((eq eol-type 'mac)
867 2)
868 ((or (and (vectorp eol-type)
869 (= (length eol-type) 3))
870 (and (numberp eol-type)
871 (and (>= eol-type 0)
872 (<= eol-type 2))))
873 eol-type)
874 (t
875 (error "Invalid EOL-TYPE spec:%S" eol-type))))
876 (put coding-system 'eol-type eol-type)
0269ddfb
KH
877
878 ;; At last, register CODING-SYSTEM in `coding-system-list' and
879 ;; `coding-system-alist'.
857ea15c 880 (add-to-coding-system-list coding-system)
0269ddfb 881 (setq coding-system-alist (cons (list (symbol-name coding-system))
d9e3229d 882 coding-system-alist))
05134257
KH
883
884 ;; For a coding system of cateogory iso-8-1 and iso-8-2, create
885 ;; XXX-with-esc variants.
886 (let ((coding-category (coding-system-category coding-system)))
887 (if (or (eq coding-category 'coding-category-iso-8-1)
888 (eq coding-category 'coding-category-iso-8-2))
889 (let ((esc (intern (concat (symbol-name coding-system) "-with-esc")))
c11a8f77
KH
890 (doc (format "Same as %s but can handle any charsets by ISO's escape sequences." coding-system))
891 (safe-charsets (assq 'safe-charsets properties))
892 (mime-charset (assq 'mime-charset properties)))
893 (if safe-charsets
894 (setcdr safe-charsets t)
895 (setq properties (cons (cons 'safe-charsets t) properties)))
896 (if mime-charset
897 (setcdr mime-charset nil))
05134257
KH
898 (make-coding-system esc type mnemonic doc
899 (if (listp (car flags))
900 (cons (append (car flags) '(t)) (cdr flags))
901 (cons (list (car flags) t) (cdr flags)))
c11a8f77 902 properties))))
05134257 903
d9e3229d 904 coding-system)
8057896b 905
a42763dc 906(defun define-coding-system-alias (alias coding-system)
358d28fb 907 "Define ALIAS as an alias for coding system CODING-SYSTEM."
0269ddfb
KH
908 (put alias 'coding-system (coding-system-spec coding-system))
909 (nconc (coding-system-get alias 'alias-coding-systems) (list alias))
857ea15c 910 (add-to-coding-system-list alias)
0269ddfb
KH
911 (setq coding-system-alist (cons (list (symbol-name alias))
912 coding-system-alist))
913 (let ((eol-type (coding-system-eol-type coding-system)))
914 (if (vectorp eol-type)
915 (put alias 'eol-type (make-subsidiary-coding-system alias))
916 (put alias 'eol-type eol-type))))
4ed46869
KH
917
918(defun set-buffer-file-coding-system (coding-system &optional force)
358d28fb
RS
919 "Set the file coding-system of the current buffer to CODING-SYSTEM.
920This means that when you save the buffer, it will be converted
921according to CODING-SYSTEM. For a list of possible values of CODING-SYSTEM,
922use \\[list-coding-systems].
923
924If the buffer's previous file coding-system value specifies end-of-line
925conversion, and CODING-SYSTEM does not specify one, CODING-SYSTEM is
926merged with the already-specified end-of-line conversion.
b839fdcc
KH
927
928If the buffer's previous file coding-system value specifies text
929conversion, and CODING-SYSTEM does not specify one, CODING-SYSTEM is
930merged with the already-specified text conversion.
931
932However, if the optional prefix argument FORCE is non-nil, then
933CODING-SYSTEM is used exactly as specified.
aeef8f07
KH
934
935This marks the buffer modified so that the succeeding \\[save-buffer]
936surely saves the buffer with CODING-SYSTEM. From a program, if you
937don't want to mark the buffer modified, just set the variable
938`buffer-file-coding-system' directly."
d9e3229d 939 (interactive "zCoding system for visited file (default, nil): \nP")
4ed46869 940 (check-coding-system coding-system)
36d455c4 941 (if (and coding-system buffer-file-coding-system (null force))
8dd735c1
KH
942 (let ((base (coding-system-base buffer-file-coding-system))
943 (eol (coding-system-eol-type buffer-file-coding-system)))
944 ;; If CODING-SYSTEM doesn't specify text conversion, merge
945 ;; with that of buffer-file-coding-system.
946 (if (eq (coding-system-base coding-system) 'undecided)
947 (setq coding-system (coding-system-change-text-conversion
948 coding-system base)))
949 ;; If CODING-SYSTEM doesn't specify eol conversion, merge with
950 ;; that of buffer-file-coding-system.
951 (if (and (vectorp (coding-system-eol-type coding-system))
952 (numberp eol) (>= eol 0) (<= eol 2))
953 (setq coding-system (coding-system-change-eol-conversion
954 coding-system eol)))))
4ed46869
KH
955 (setq buffer-file-coding-system coding-system)
956 (set-buffer-modified-p t)
957 (force-mode-line-update))
958
358d28fb
RS
959(defvar default-terminal-coding-system nil
960 "Default value for the terminal coding system.
961This is normally set according to the selected language environment.
962See also the command `set-terminal-coding-system'.")
963
df100398
KH
964(defun set-terminal-coding-system (coding-system)
965 "Set coding system of your terminal to CODING-SYSTEM.
358d28fb
RS
966All text output to the terminal will be encoded
967with the specified coding system.
968For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
969The default is determined by the selected language environment
970or by the previous use of this command."
971 (interactive
2e02a76f
RS
972 (list (let ((default (if (and (not (terminal-coding-system))
973 default-terminal-coding-system)
974 default-terminal-coding-system)))
975 (read-coding-system
976 (format "Coding system for terminal display (default, %s): "
977 default)
978 default))))
358d28fb
RS
979 (if (and (not coding-system)
980 (not (terminal-coding-system)))
981 (setq coding-system default-terminal-coding-system))
982 (if coding-system
983 (setq default-terminal-coding-system coding-system))
df100398
KH
984 (set-terminal-coding-system-internal coding-system)
985 (redraw-frame (selected-frame)))
986
358d28fb
RS
987(defvar default-keyboard-coding-system nil
988 "Default value of the keyboard coding system.
989This is normally set according to the selected language environment.
990See also the command `set-keyboard-coding-system'.")
991
df100398 992(defun set-keyboard-coding-system (coding-system)
358d28fb
RS
993 "Set coding system for keyboard input to CODING-SYSTEM.
994In addition, this command enables Encoded-kbd minor mode.
26471f06 995\(If CODING-SYSTEM is nil, Encoded-kbd mode is turned off.)
358d28fb
RS
996For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
997The default is determined by the selected language environment
998or by the previous use of this command."
999 (interactive
2e02a76f
RS
1000 (list (let ((default (if (and (not (keyboard-coding-system))
1001 default-keyboard-coding-system)
1002 default-keyboard-coding-system)))
1003 (read-coding-system
1004 (format "Coding system for keyboard input (default, %s): "
1005 default)
1006 default))))
358d28fb
RS
1007 (if (and (not coding-system)
1008 (not (keyboard-coding-system)))
1009 (setq coding-system default-keyboard-coding-system))
1010 (if coding-system
1011 (setq default-keyboard-coding-system coding-system))
df100398
KH
1012 (set-keyboard-coding-system-internal coding-system)
1013 (encoded-kbd-mode (if coding-system 1 0)))
1014
1015(defun set-buffer-process-coding-system (decoding encoding)
358d28fb 1016 "Set coding systems for the process associated with the current buffer.
df100398 1017DECODING is the coding system to be used to decode input from the process,
358d28fb
RS
1018ENCODING is the coding system to be used to encode output to the process.
1019
1020For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
4ed46869 1021 (interactive
83911021 1022 "zCoding-system for output from the process: \nzCoding-system for input to the process: ")
4ed46869
KH
1023 (let ((proc (get-buffer-process (current-buffer))))
1024 (if (null proc)
1025 (error "no process")
df100398
KH
1026 (check-coding-system decoding)
1027 (check-coding-system encoding)
1028 (set-process-coding-system proc decoding encoding)))
4ed46869
KH
1029 (force-mode-line-update))
1030
d0b99881
RS
1031(defalias 'set-clipboard-coding-system 'set-selection-coding-system)
1032
14915c37 1033(defun set-selection-coding-system (coding-system)
b25eef20
KH
1034 "Make CODING-SYSTEM used for communicating with other X clients .
1035When sending or receiving text via cut_buffer, selection, and clipboard,
1036the text is encoded or decoded by CODING-SYSTEM."
a03b3ce1 1037 (interactive "zCoding system for X selection: ")
b25eef20 1038 (check-coding-system coding-system)
14915c37 1039 (setq selection-coding-system coding-system))
b25eef20 1040
e8dd0160 1041;; Coding system lastly specified by the command
a03b3ce1
KH
1042;; set-next-selection-coding-system.
1043(defvar last-next-selection-coding-system nil)
1044
1045(defun set-next-selection-coding-system (coding-system)
1046 "Make CODING-SYSTEM used for the next communication with other X clients.
1047This setting is effective for the next communication only."
1048 (interactive
1049 (list (read-coding-system
1050 (if last-next-selection-coding-system
1051 (format "Coding system for the next X selection (default, %S): "
1052 last-next-selection-coding-system)
1053 "Coding system for the next X selection: ")
1054 last-next-selection-coding-system)))
1055 (if coding-system
1056 (setq last-next-selection-coding-system coding-system)
1057 (setq coding-system last-next-selection-coding-system))
1058 (check-coding-system coding-system)
1059
1060 (setq next-selection-coding-system coding-system))
1061
4ed46869 1062(defun set-coding-priority (arg)
d9e3229d
KH
1063 "Set priority of coding categories according to LIST.
1064LIST is a list of coding categories ordered by priority."
1065 (let ((l arg)
1066 (current-list (copy-sequence coding-category-list)))
e8dd0160 1067 ;; Check the validity of ARG while deleting coding categories in
d9e3229d
KH
1068 ;; ARG from CURRENT-LIST. We assume that CODING-CATEGORY-LIST
1069 ;; contains all coding categories.
1070 (while l
1071 (if (or (null (get (car l) 'coding-category-index))
1072 (null (memq (car l) current-list)))
1073 (error "Invalid or duplicated element in argument: %s" arg))
1074 (setq current-list (delq (car l) current-list))
1075 (setq l (cdr l)))
4ed46869 1076 ;; Update `coding-category-list' and return it.
2feaf204
KH
1077 (setq coding-category-list (append arg current-list))
1078 (set-coding-priority-internal)))
4ed46869
KH
1079
1080;;; FILE I/O
1081
835f49b8 1082(defvar auto-coding-alist
0735296c
DL
1083 '(("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\|tar\\|tgz\\)\\'" . no-conversion)
1084 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\|TAR\\|TGZ\\)\\'" . no-conversion))
835f49b8
KH
1085 "Alist of filename patterns vs corresponding coding systems.
1086Each element looks like (REGEXP . CODING-SYSTEM).
558b0c86 1087A file whose name matches REGEXP is decoded by CODING-SYSTEM on reading.
835f49b8 1088
7fed493a
RS
1089The settings in this alist take priority over `coding:' tags
1090in the file (see the function `set-auto-coding')
1091and the contents of `file-coding-system-alist'.")
835f49b8 1092
1c4cc63a
KH
1093(defvar set-auto-coding-for-load nil
1094 "Non-nil means look for `load-coding' property instead of `coding'.
1095This is used for loading and byte-compiling Emacs Lisp files.")
1096
8a592131
RS
1097(defun auto-coding-alist-lookup (filename)
1098 "Return the coding system specified by `auto-coding-alist' for FILENAME."
1099 (let ((alist auto-coding-alist)
ca128d75 1100 (case-fold-search (memq system-type '(vax-vms windows-nt ms-dos)))
8a592131
RS
1101 coding-system)
1102 (while (and alist (not coding-system))
1103 (if (string-match (car (car alist)) filename)
1104 (setq coding-system (cdr (car alist)))
1105 (setq alist (cdr alist))))
1106 coding-system))
1107
835f49b8
KH
1108(defun set-auto-coding (filename size)
1109 "Return coding system for a file FILENAME of which SIZE bytes follow point.
1c4cc63a
KH
1110These bytes should include at least the first 1k of the file
1111and the last 3k of the file, but the middle may be omitted.
63561304 1112
835f49b8
KH
1113It checks FILENAME against the variable `auto-coding-alist'.
1114If FILENAME doesn't match any entries in the variable,
1115it checks for a `coding:' tag in the first one or two lines following
e8dd0160 1116point. If no `coding:' tag is found, it checks for local variables
1c4cc63a 1117list in the last 3K bytes out of the SIZE bytes.
63561304
KH
1118
1119The return value is the specified coding system,
1120or nil if nothing specified.
87aba788 1121
ba74e833 1122The variable `set-auto-coding-function' (which see) is set to this
87aba788 1123function by default."
8a592131 1124 (let ((coding-system (auto-coding-alist-lookup filename)))
835f49b8
KH
1125
1126 (or coding-system
1127 (let* ((case-fold-search t)
1128 (head-start (point))
1129 (head-end (+ head-start (min size 1024)))
1130 (tail-start (+ head-start (max (- size 3072) 0)))
1131 (tail-end (+ head-start size))
1132 coding-system head-found tail-found pos)
1133 ;; Try a short cut by searching for the string "coding:"
e8dd0160 1134 ;; and for "unibyte:" at the head and tail of SIZE bytes.
835f49b8
KH
1135 (setq head-found (or (search-forward "coding:" head-end t)
1136 (search-forward "unibyte:" head-end t)))
1137 (if (and head-found (> head-found tail-start))
1138 ;; Head and tail are overlapped.
1139 (setq tail-found head-found)
1140 (goto-char tail-start)
1141 (setq tail-found (or (search-forward "coding:" tail-end t)
1142 (search-forward "unibyte:" tail-end t))))
1143
1144 ;; At first check the head.
1145 (when head-found
1146 (goto-char head-start)
1147 (setq pos (re-search-forward "[\n\r]" head-end t))
1148 (if (and pos
1149 (= (char-after head-start) ?#)
1150 (= (char-after (1+ head-start)) ?!))
1151 ;; If the file begins with "#!" (exec interpreter magic),
1152 ;; look for coding frobs in the first two lines. You cannot
1153 ;; necessarily put them in the first line of such a file
1154 ;; without screwing up the interpreter invocation.
1155 (setq pos (search-forward "\n" head-end t)))
1156 (if pos (setq head-end pos))
1157 (when (< head-found head-end)
1158 (goto-char head-start)
1159 (when (and set-auto-coding-for-load
1160 (re-search-forward
1161 "-\\*-\\(.*;\\)?[ \t]*unibyte:[ \t]*\\([^ ;]+\\)"
1162 head-end t))
1163 (setq coding-system 'raw-text))
1164 (when (and (not coding-system)
1165 (re-search-forward
1166 "-\\*-\\(.*;\\)?[ \t]*coding:[ \t]*\\([^ ;]+\\)"
1167 head-end t))
1168 (setq coding-system (intern (match-string 2)))
1169 (or (coding-system-p coding-system)
1170 (setq coding-system nil)))))
1171
1172 ;; If no coding: tag in the head, check the tail.
1173 (when (and tail-found (not coding-system))
1174 (goto-char tail-start)
1175 (search-forward "\n\^L" nil t)
1176 (if (re-search-forward
1177 "^\\(.*\\)[ \t]*Local Variables:[ \t]*\\(.*\\)$" tail-end t)
1178 ;; The prefix is what comes before "local variables:" in its
1179 ;; line. The suffix is what comes after "local variables:"
1180 ;; in its line.
1181 (let* ((prefix (regexp-quote (match-string 1)))
1182 (suffix (regexp-quote (match-string 2)))
d318fcf4
EZ
1183 (re-coding
1184 (concat
1185 "^" prefix
1186 "[ \t]*coding[ \t]*:[ \t]*\\([^ \t]+\\)[ \t]*"
1187 suffix "$"))
1188 (re-unibyte
1189 (concat
1190 "^" prefix
1191 "[ \t]*unibyte[ \t]*:[ \t]*\\([^ \t]+\\)[ \t]*"
1192 suffix "$"))
1193 (re-end
1194 (concat "^" prefix "[ \t]*end *:[ \t]*" suffix "$"))
835f49b8
KH
1195 (pos (point)))
1196 (re-search-forward re-end tail-end 'move)
1197 (setq tail-end (point))
1198 (goto-char pos)
1199 (when (and set-auto-coding-for-load
1200 (re-search-forward re-unibyte tail-end t))
1201 (setq coding-system 'raw-text))
1202 (when (and (not coding-system)
1203 (re-search-forward re-coding tail-end t))
1204 (setq coding-system (intern (match-string 1)))
1205 (or (coding-system-p coding-system)
1206 (setq coding-system nil))))))
1207 coding-system))))
63561304
KH
1208
1209(setq set-auto-coding-function 'set-auto-coding)
87aba788 1210
4ed46869
KH
1211;; Set buffer-file-coding-system of the current buffer after some text
1212;; is inserted.
1213(defun after-insert-file-set-buffer-file-coding-system (inserted)
1214 (if last-coding-system-used
1215 (let ((coding-system
1216 (find-new-buffer-file-coding-system last-coding-system-used))
1217 (modified-p (buffer-modified-p)))
0269ddfb 1218 (when coding-system
71983219 1219 (set-buffer-file-coding-system coding-system t)
d0c26c63
KH
1220 (if (and enable-multibyte-characters
1221 (or (eq coding-system 'no-conversion)
ccb77b4e 1222 (eq (coding-system-type coding-system) 5))
136e48e4
KH
1223 ;; If buffer was unmodified and the size is the
1224 ;; same as INSERTED, we must be visiting it.
1225 (not modified-p)
1226 (= (buffer-size) inserted))
ccb77b4e
RS
1227 ;; For coding systems no-conversion and raw-text...,
1228 ;; edit the buffer as unibyte.
d0c26c63
KH
1229 (let ((pos-byte (position-bytes (+ (point) inserted))))
1230 (set-buffer-multibyte nil)
1231 (setq inserted (- pos-byte (position-bytes (point))))))
0269ddfb 1232 (set-buffer-modified-p modified-p))))
d0c26c63 1233 inserted)
4ed46869 1234
84c9d215
KH
1235(add-hook 'after-insert-file-functions
1236 'after-insert-file-set-buffer-file-coding-system)
4ed46869 1237
8057896b 1238;; The coding-spec and eol-type of coding-system returned is decided
4ed46869
KH
1239;; independently in the following order.
1240;; 1. That of buffer-file-coding-system locally bound.
1241;; 2. That of CODING.
1242
1243(defun find-new-buffer-file-coding-system (coding)
1244 "Return a coding system for a buffer when a file of CODING is inserted.
a73a8c89
KH
1245The local variable `buffer-file-coding-system' of the current buffer
1246is set to the returned value.
509064c5 1247Return nil if there's no need to set `buffer-file-coding-system'."
4ed46869 1248 (let (local-coding local-eol
b685f8d6 1249 found-coding found-eol
4ed46869
KH
1250 new-coding new-eol)
1251 (if (null coding)
1252 ;; Nothing found about coding.
1253 nil
1254
b685f8d6
RS
1255 ;; Get information of `buffer-file-coding-system' in LOCAL-EOL
1256 ;; and LOCAL-CODING.
1257 (setq local-eol (coding-system-eol-type buffer-file-coding-system))
1258 (if (null (numberp local-eol))
1259 ;; But eol-type is not yet set.
1260 (setq local-eol nil))
0269ddfb
KH
1261 (if (and buffer-file-coding-system
1262 (not (eq (coding-system-type buffer-file-coding-system) t)))
1263 ;; This is not `undecided'.
1264 (setq local-coding (coding-system-base buffer-file-coding-system)))
b685f8d6
RS
1265
1266 (if (and (local-variable-p 'buffer-file-coding-system)
1267 local-eol local-coding)
4ed46869
KH
1268 ;; The current buffer has already set full coding-system, we
1269 ;; had better not change it.
1270 nil
1271
8057896b 1272 (setq found-eol (coding-system-eol-type coding))
4ed46869 1273 (if (null (numberp found-eol))
be02cd54
EZ
1274 ;; But eol-type is not found.
1275 ;; If EOL conversions are inhibited, force unix eol-type.
1276 (setq found-eol (if inhibit-eol-conversion 0)))
c76b5c99
KH
1277 (if (eq (coding-system-type coding) t)
1278 (setq found-coding 'undecided)
1279 (setq found-coding (coding-system-base coding)))
1280
1281 (if (and (not found-eol) (eq found-coding 'undecided))
1282 ;; No valid coding information found.
1283 nil
1284
1285 ;; Some coding information (eol or text) found.
1286
1287 ;; The local setting takes precedence over the found one.
1288 (setq new-coding (if (local-variable-p 'buffer-file-coding-system)
1289 (or local-coding found-coding)
1290 (or found-coding local-coding)))
1291 (setq new-eol (if (local-variable-p 'buffer-file-coding-system)
1292 (or local-eol found-eol)
1293 (or found-eol local-eol)))
1294
1295 (let ((eol-type (coding-system-eol-type new-coding)))
1296 (if (and (numberp new-eol) (vectorp eol-type))
1297 (aref eol-type new-eol)
1298 new-coding)))))))
4ed46869 1299
fe831d33
GV
1300(defun modify-coding-system-alist (target-type regexp coding-system)
1301 "Modify one of look up tables for finding a coding system on I/O operation.
8c453b46
RS
1302There are three of such tables, `file-coding-system-alist',
1303`process-coding-system-alist', and `network-coding-system-alist'.
fe831d33
GV
1304
1305TARGET-TYPE specifies which of them to modify.
8c453b46
RS
1306If it is `file', it affects `file-coding-system-alist' (which see).
1307If it is `process', it affects `process-coding-system-alist' (which see).
e8dd0160 1308If it is `network', it affects `network-coding-system-alist' (which see).
fe831d33
GV
1309
1310REGEXP is a regular expression matching a target of I/O operation.
1311The target is a file name if TARGET-TYPE is `file', a program name if
1312TARGET-TYPE is `process', or a network service name or a port number
1313to connect to if TARGET-TYPE is `network'.
1314
1315CODING-SYSTEM is a coding system to perform code conversion on the I/O
8c453b46
RS
1316operation, or a cons cell (DECODING . ENCODING) specifying the coding systems
1317for decoding and encoding respectively,
1318or a function symbol which, when called, returns such a cons cell."
fe831d33
GV
1319 (or (memq target-type '(file process network))
1320 (error "Invalid target type: %s" target-type))
1321 (or (stringp regexp)
1322 (and (eq target-type 'network) (integerp regexp))
1323 (error "Invalid regular expression: %s" regexp))
1324 (if (symbolp coding-system)
1325 (if (not (fboundp coding-system))
1326 (progn
1327 (check-coding-system coding-system)
1328 (setq coding-system (cons coding-system coding-system))))
1329 (check-coding-system (car coding-system))
1330 (check-coding-system (cdr coding-system)))
1331 (cond ((eq target-type 'file)
1332 (let ((slot (assoc regexp file-coding-system-alist)))
1333 (if slot
1334 (setcdr slot coding-system)
1335 (setq file-coding-system-alist
1336 (cons (cons regexp coding-system)
1337 file-coding-system-alist)))))
1338 ((eq target-type 'process)
1339 (let ((slot (assoc regexp process-coding-system-alist)))
1340 (if slot
1341 (setcdr slot coding-system)
1342 (setq process-coding-system-alist
1343 (cons (cons regexp coding-system)
1344 process-coding-system-alist)))))
1345 (t
1346 (let ((slot (assoc regexp network-coding-system-alist)))
1347 (if slot
1348 (setcdr slot coding-system)
1349 (setq network-coding-system-alist
1350 (cons (cons regexp coding-system)
1351 network-coding-system-alist)))))))
1352
b25eef20 1353(defun make-translation-table (&rest args)
f967223b 1354 "Make a translation table (char table) from arguments.
13d5617d 1355Each argument is a list of the form (FROM . TO),
b25eef20 1356where FROM is a character to be translated to TO.
13d5617d 1357
452fdb31
RS
1358FROM can be a generic character (see `make-char'). In this case, TO is
1359a generic character containing the same number of characters, or a
1360ordinary character. If FROM and TO are both generic characters, all
b25eef20 1361characters belonging to FROM are translated to characters belonging to TO
13d5617d 1362without changing their position code(s)."
f967223b 1363 (let ((table (make-char-table 'translation-table))
a73a8c89
KH
1364 revlist)
1365 (while args
1366 (let ((elts (car args)))
1367 (while elts
13d5617d
KH
1368 (let* ((from (car (car elts)))
1369 (from-i 0) ; degree of freedom of FROM
1370 (from-rev (nreverse (split-char from)))
1371 (to (cdr (car elts)))
1372 (to-i 0) ; degree of freedom of TO
1373 (to-rev (nreverse (split-char to))))
1374 ;; Check numbers of heading 0s in FROM-REV and TO-REV.
1375 (while (eq (car from-rev) 0)
1376 (setq from-i (1+ from-i) from-rev (cdr from-rev)))
1377 (while (eq (car to-rev) 0)
1378 (setq to-i (1+ to-i) to-rev (cdr to-rev)))
1379 (if (and (/= from-i to-i) (/= to-i 0))
1380 (error "Invalid character pair (%d . %d)" from to))
b25eef20
KH
1381 ;; If we have already translated TO to TO-ALT, FROM should
1382 ;; also be translated to TO-ALT. But, this is only if TO
1383 ;; is a generic character or TO-ALT is not a generic
13d5617d
KH
1384 ;; character.
1385 (let ((to-alt (aref table to)))
1386 (if (and to-alt
1387 (or (> to-i 0) (not (generic-char-p to-alt))))
1388 (setq to to-alt)))
1389 (if (> from-i 0)
1390 (set-char-table-default table from to)
1391 (aset table from to))
b25eef20
KH
1392 ;; If we have already translated some chars to FROM, they
1393 ;; should also be translated to TO.
a73a8c89
KH
1394 (let ((l (assq from revlist)))
1395 (if l
1396 (let ((ch (car l)))
1397 (setcar l to)
1398 (setq l (cdr l))
1399 (while l
1400 (aset table ch to)
1401 (setq l (cdr l)) ))))
1402 ;; Now update REVLIST.
1403 (let ((l (assq to revlist)))
1404 (if l
1405 (setcdr l (cons from (cdr l)))
1406 (setq revlist (cons (list to from) revlist)))))
1407 (setq elts (cdr elts))))
1408 (setq args (cdr args)))
1409 ;; Return TABLE just created.
1410 table))
1411
c76b5c99
KH
1412(defun make-translation-table-from-vector (vec)
1413 "Make translation table from decoding vector VEC.
1414VEC is an array of 256 elements to map unibyte codes to multibyte characters.
1415See also the variable `nonascii-translation-table'."
1416 (let ((table (make-char-table 'translation-table))
1417 (rev-table (make-char-table 'translation-table))
1418 (i 0)
1419 ch)
1420 (while (< i 256)
1421 (setq ch (aref vec i))
1422 (aset table i ch)
1423 (if (>= ch 256)
1424 (aset rev-table ch i))
1425 (setq i (1+ i)))
1426 (set-char-table-extra-slot table 0 rev-table)
1427 table))
1428
f967223b 1429(defun define-translation-table (symbol &rest args)
e8dd0160 1430 "Define SYMBOL as a name of translation table made by ARGS.
b25eef20 1431
007c79c8
KH
1432If the first element of ARGS is a char-table of which purpose is
1433translation-table, just define SYMBOL as the name of it.
1434
1435In the other case, ARGS are the same as arguments to the function
1436`make-translation-table' (which see).
b25eef20 1437
452fdb31
RS
1438This function sets properties `translation-table' and
1439`translation-table-id' of SYMBOL to the created table itself and
f967223b 1440identification number of the table respectively."
007c79c8
KH
1441 (let ((table (if (and (char-table-p (car args))
1442 (eq (char-table-subtype (car args))
1443 'translation-table))
1444 (car args)
1445 (apply 'make-translation-table args)))
f967223b 1446 (len (length translation-table-vector))
d9e3229d 1447 (id 0)
b25eef20 1448 (done nil))
f967223b 1449 (put symbol 'translation-table table)
b25eef20
KH
1450 (while (not done)
1451 (if (>= id len)
f967223b
KH
1452 (setq translation-table-vector
1453 (vconcat translation-table-vector (make-vector len nil))))
1454 (let ((slot (aref translation-table-vector id)))
b25eef20
KH
1455 (if (or (not slot)
1456 (eq (car slot) symbol))
1457 (progn
f967223b 1458 (aset translation-table-vector id (cons symbol table))
007c79c8
KH
1459 (setq done t))
1460 (setq id (1+ id)))))
f967223b 1461 (put symbol 'translation-table-id id)
d9e3229d
KH
1462 id))
1463
35554641
KH
1464(put 'with-category-table 'lisp-indent-function 1)
1465
1466(defmacro with-category-table (category-table &rest body)
1467 `(let ((current-category-table (category-table)))
1468 (set-category-table ,category-table)
1469 (unwind-protect
1470 (progn ,@body)
1471 (set-category-table current-category-table))))
1472
69eba008
KH
1473;;; Initialize some variables.
1474
1475(put 'use-default-ascent 'char-table-extra-slots 0)
1476(setq use-default-ascent (make-char-table 'use-default-ascent))
d6d6d592
KH
1477(put 'ignore-relative-composition 'char-table-extra-slots 0)
1478(setq ignore-relative-composition
1479 (make-char-table 'ignore-relative-composition))
69eba008
KH
1480
1481;;;
4ed46869
KH
1482(provide 'mule)
1483
1484;;; mule.el ends here