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