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