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