(setup-default-fontset): Add OpenType
[bpt/emacs.git] / lisp / international / mule.el
CommitLineData
07513d64 1;;; mule.el --- basic commands for multilingual environment
4ed46869 2
d7a0267c 3;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
2fd125a3 4;; Free Software Foundation, Inc.
7976eda0 5;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
d7a0267c 6;; 2005, 2006, 2007
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
17;; GNU Emacs is free software; you can redistribute it and/or modify
18;; it under the terms of the GNU General Public License as published by
d7142f3e 19;; the Free Software Foundation; either version 3, or (at your option)
4ed46869
KH
20;; any later version.
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
369314dc 28;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
29;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30;; Boston, MA 02110-1301, USA.
4ed46869 31
60370d40
PJ
32;;; Commentary:
33
4ed46869
KH
34;;; Code:
35
8f924df7 36(defconst mule-version "6.0 (HANACHIRUSATO)" "\
4ed46869
KH
37Version number and name of this version of MULE (multilingual environment).")
38
8f924df7 39(defconst mule-version-date "2003.9.1" "\
4ed46869
KH
40Distribution date of this version of MULE (multilingual environment).")
41
c1841772
KH
42\f
43;;; CHARSET
44
6d2b6635
KH
45;; Backward compatibility code for handling emacs-mule charsets.
46(defvar private-char-area-1-min #xF0000)
47(defvar private-char-area-1-max #xFFFFE)
48(defvar private-char-area-2-min #x100000)
49(defvar private-char-area-2-max #x10FFFE)
50
51;; Table of emacs-mule charsets indexed by their emacs-mule ID.
52(defvar emacs-mule-charset-table (make-vector 256 nil))
53(aset emacs-mule-charset-table 0 'ascii)
54
55;; Convert the argument of old-style calll of define-charset to a
56;; property list used by the new-style.
57;; INFO-VECTOR is a vector of the format:
58;; [DIMENSION CHARS WIDTH DIRECTION ISO-FINAL-CHAR ISO-GRAPHIC-PLANE
59;; SHORT-NAME LONG-NAME DESCRIPTION]
60
61(defun convert-define-charset-argument (emacs-mule-id info-vector)
62 (let* ((dim (aref info-vector 0))
63 (chars (aref info-vector 1))
64 (total (if (= dim 1) chars (* chars chars)))
65 (code-space (if (= dim 1) (if (= chars 96) [32 127] [33 126])
66 (if (= chars 96) [32 127 32 127] [33 126 33 126])))
67 code-offset)
68 (if (integerp emacs-mule-id)
69 (or (= emacs-mule-id 0)
70 (and (>= emacs-mule-id 129) (< emacs-mule-id 256))
71 (error "Invalid CHARSET-ID: %d" emacs-mule-id))
72 (let (from-id to-id)
73 (if (= dim 1) (setq from-id 160 to-id 224)
74 (setq from-id 224 to-id 255))
75 (while (and (< from-id to-id)
76 (not (aref emacs-mule-charset-table from-id)))
77 (setq from-id (1+ from-id)))
78 (if (= from-id to-id)
79 (error "No more room for the new Emacs-mule charset"))
80 (setq emacs-mule-id from-id)))
81 (if (> (- private-char-area-1-max private-char-area-1-min) total)
82 (setq code-offset private-char-area-1-min
83 private-char-area-1-min (+ private-char-area-1-min total))
84 (if (> (- private-char-area-2-max private-char-area-2-min) total)
85 (setq code-offset private-char-area-2-min
86 private-char-area-2-min (+ private-char-area-2-min total))
87 (error "No more space for a new charset.")))
88 (list :dimension dim
89 :code-space code-space
90 :iso-final-char (aref info-vector 4)
91 :code-offset code-offset
92 :emacs-mule-id emacs-mule-id)))
93
c1841772
KH
94(defun define-charset (name docstring &rest props)
95 "Define NAME (symbol) as a charset with DOCSTRING.
96The remaining arguments must come in pairs ATTRIBUTE VALUE. ATTRIBUTE
07513d64 97may be any symbol. The following have special meanings, and one of
bec25acc 98`:code-offset', `:map', `:subset', `:superset' must be specified.
c1841772
KH
99
100`:short-name'
101
102VALUE must be a short string to identify the charset. If omitted,
103NAME is used.
104
105`:long-name'
106
107VALUE must be a string longer than `:short-name' to identify the
07513d64 108charset. If omitted, the value of the `:short-name' attribute is used.
c1841772
KH
109
110`:dimension'
111
112VALUE must be an integer 0, 1, 2, or 3, specifying the dimension of
07513d64
DL
113code-points of the charsets. If omitted, it is calculated from the
114value of the `:code-space' attribute.
c1841772
KH
115
116`:code-space'
117
118VALUE must be a vector of length at most 8 specifying the byte code
119range of each dimension in this format:
120 [ MIN-1 MAX-1 MIN-2 MAX-2 ... ]
07513d64 121where MIN-N is the minimum byte value of Nth dimension of code-point,
c1841772
KH
122MAX-N is the maximum byte value of that.
123
b1a79461
KH
124`:min-code'
125
126VALUE must be an integer specifying the mininum code point of the
127charset. If omitted, it is calculated from `:code-space'. VALUE may
128be a cons (HIGH . LOW), where HIGH is the most significant 16 bits of
129the code point and LOW is the least significant 16 bits.
130
1f32125f 131`:max-code'
b1a79461
KH
132
133VALUE must be an integer specifying the maxinum code point of the
134charset. If omitted, it is calculated from `:code-space'. VALUE may
135be a cons (HIGH . LOW), where HIGH is the most significant 16 bits of
136the code point and LOW is the least significant 16 bits.
137
c1841772
KH
138`:iso-final-char'
139
140VALUE must be a character in the range 32 to 127 (inclusive)
141specifying the final char of the charset for ISO-2022 encoding. If
142omitted, the charset can't be encoded by ISO-2022 based
143coding-systems.
144
145`:iso-revision-number'
146
147VALUE must be an integer in the range 0..63, specifying the revision
148number of the charset for ISO-2022 encoding.
149
150`:emacs-mule-id'
151
6d2b6635 152VALUE must be an integer of 0, 129..255. If omitted, the charset
c1841772
KH
153can't be encoded by coding-systems of type `emacs-mule'.
154
155`:ascii-compatible-p'
156
07513d64
DL
157VALUE must be nil or t (default nil). If VALUE is t, the charset is
158compatible with ASCII, i.e. the first 128 code points map to ASCII.
c1841772
KH
159
160`:supplementary-p'
161
162VALUE must be nil or t. If the VALUE is t, the charset is
07513d64
DL
163supplementary, which means it is used only as a parent of some other
164charset.
c1841772
KH
165
166`:invalid-code'
167
168VALUE must be a nonnegative integer that can be used as an invalid
169code point of the charset. If the minimum code is 0 and the maximum
170code is greater than Emacs' maximum integer value, `:invalid-code'
171should not be omitted.
172
173`:code-offset'
174
07513d64
DL
175VALUE must be an integer added to the index number of a character to
176get the corresponding character code.
c1841772
KH
177
178`:map'
179
180VALUE must be vector or string.
181
182If it is a vector, the format is [ CODE-1 CHAR-1 CODE-2 CHAR-2 ... ],
183where CODE-n is a code-point of the charset, and CHAR-n is the
07513d64 184corresponding character code.
c1841772
KH
185
186If it is a string, it is a name of file that contains the above
3e4abc9e
KH
187information. Each line of the file must be this format:
188 0xXXX 0xYYY
189where XXX is a hexadecimal representation of CODE-n and YYY is a
190hexadecimal representation of CHAR-n. A line starting with `#' is a
191comment line.
c1841772 192
2c2a254f
KH
193`:subset'
194
195VALUE must be a list:
196 ( PARENT MIN-CODE MAX-CODE OFFSET )
197PARENT is a parent charset. MIN-CODE and MAX-CODE specify the range
198of characters inherited from the parent. OFFSET is an integer value
199to add to a code point of the parent charset to get the corresponding
200code point of this charset.
201
202`:superset'
c1841772
KH
203
204VALUE must be a list of parent charsets. The charset inherits
205characters from them. Each element of the list may be a cons (PARENT
206. OFFSET), where PARENT is a parent charset, and OFFSET is an offset
2c2a254f
KH
207value to add to a code point of PARENT to get the corresponding code
208point of this charset.
c1841772
KH
209
210`:unify-map'
211
212VALUE must be vector or string.
213
214If it is a vector, the format is [ CODE-1 CHAR-1 CODE-2 CHAR-2 ... ],
215where CODE-n is a code-point of the charset, and CHAR-n is the
07513d64 216corresponding Unicode character code.
c1841772
KH
217
218If it is a string, it is a name of file that contains the above
3e4abc9e
KH
219information. The file format is the same as what described for `:map'
220attribute."
6d2b6635
KH
221 (when (vectorp (car props))
222 ;; Old style code:
223 ;; (define-charset CHARSET-ID CHARSET-SYMBOL INFO-VECTOR)
224 ;; Convert the argument to make it fit with the current style.
225 (let ((vec (car props)))
226 (setq props (convert-define-charset-argument name vec)
227 name docstring
228 docstring (aref vec 8))))
c1841772
KH
229 (let ((attrs (mapcar 'list '(:dimension
230 :code-space
b1a79461
KH
231 :min-code
232 :max-code
c1841772
KH
233 :iso-final-char
234 :iso-revision-number
235 :emacs-mule-id
236 :ascii-compatible-p
237 :supplementary-p
238 :invalid-code
239 :code-offset
240 :map
2c2a254f
KH
241 :subset
242 :superset
c1841772
KH
243 :unify-map
244 :plist))))
245
246 ;; If :dimension is omitted, get the dimension from :code-space.
247 (let ((dimension (plist-get props :dimension)))
248 (or dimension
c04e918c
KH
249 (let ((code-space (plist-get props :code-space)))
250 (setq dimension (if code-space (/ (length code-space) 2) 4))
c1841772
KH
251 (setq props (plist-put props :dimension dimension)))))
252
c04e918c
KH
253 (let ((code-space (plist-get props :code-space)))
254 (or code-space
255 (let ((dimension (plist-get props :dimension)))
256 (setq code-space (make-vector 8 0))
257 (dotimes (i dimension)
258 (aset code-space (1+ (* i 2)) #xFF))
259 (setq props (plist-put props :code-space code-space)))))
260
6d2b6635
KH
261 ;; If :emacs-mule-id is specified, update emacs-mule-charset-table.
262 (let ((emacs-mule-id (plist-get props :emacs-mule-id)))
263 (if (integerp emacs-mule-id)
264 (aset emacs-mule-charset-table emacs-mule-id name)))
265
c1841772
KH
266 (dolist (slot attrs)
267 (setcdr slot (plist-get props (car slot))))
268
269 ;; Make sure that the value of :code-space is a vector of 8
270 ;; elements.
271 (let* ((slot (assq :code-space attrs))
272 (val (cdr slot))
273 (len (length val)))
274 (if (< len 8)
275 (setcdr slot
276 (vconcat val (make-vector (- 8 len) 0)))))
277
278 ;; Add :name and :docstring properties to PROPS.
279 (setq props
280 (cons :name (cons name (cons :docstring (cons docstring props)))))
281 (or (plist-get props :short-name)
282 (plist-put props :short-name (symbol-name name)))
283 (or (plist-get props :long-name)
284 (plist-put props :long-name (plist-get props :short-name)))
e1e529fa
DL
285 ;; We can probably get a worthwhile amount in purespace.
286 (setq props
287 (mapcar (lambda (elt)
288 (if (stringp elt)
289 (purecopy elt)
290 elt))
291 props))
c1841772
KH
292 (setcdr (assq :plist attrs) props)
293
294 (apply 'define-charset-internal name (mapcar 'cdr attrs))))
295
296
4ed46869 297(defun load-with-code-conversion (fullname file &optional noerror nomessage)
0f69cb38
KH
298 "Execute a file of Lisp code named FILE whose absolute name is FULLNAME.
299The file contents are decoded before evaluation if necessary.
5dd1c041 300If optional third arg NOERROR is non-nil,
4ed46869
KH
301 report no error if FILE doesn't exist.
302Print messages at start and end of loading unless
5dd1c041 303 optional fourth arg NOMESSAGE is non-nil.
4ed46869
KH
304Return t if file exists."
305 (if (null (file-readable-p fullname))
306 (and (null noerror)
307 (signal 'file-error (list "Cannot open load file" file)))
308 ;; Read file with code conversion, and then eval.
309 (let* ((buffer
310 ;; To avoid any autoloading, set default-major-mode to
311 ;; fundamental-mode.
88162676
RS
312 ;; So that we don't get completely screwed if the
313 ;; file is encoded in some complicated character set,
314 ;; read it with real decoding, as a multibyte buffer,
315 ;; even if this is a --unibyte Emacs session.
316 (let ((default-major-mode 'fundamental-mode)
317 (default-enable-multibyte-characters t))
4ed46869
KH
318 ;; We can't use `generate-new-buffer' because files.el
319 ;; is not yet loaded.
320 (get-buffer-create (generate-new-buffer-name " *load*"))))
db5cae4b
SM
321 (load-in-progress t)
322 (source (save-match-data (string-match "\\.el\\'" fullname))))
323 (unless nomessage
324 (if source
325 (message "Loading %s (source)..." file)
326 (message "Loading %s..." file)))
327 (when purify-flag
4c86cca0 328 (push file preloaded-file-list))
4ed46869 329 (unwind-protect
a6acd8a2 330 (let ((load-file-name fullname)
1c4cc63a 331 (set-auto-coding-for-load t)
a6acd8a2 332 (inhibit-file-name-operation nil))
053f45dd 333 (with-current-buffer buffer
9fe1108c
RS
334 ;; Don't let deactivate-mark remain set.
335 (let (deactivate-mark)
336 (insert-file-contents fullname))
7d276780
EZ
337 ;; If the loaded file was inserted with no-conversion or
338 ;; raw-text coding system, make the buffer unibyte.
339 ;; Otherwise, eval-buffer might try to interpret random
340 ;; binary junk as multibyte characters.
341 (if (and enable-multibyte-characters
8f924df7
KH
342 (or (eq (coding-system-type last-coding-system-used)
343 'raw-text)))
7d276780 344 (set-buffer-multibyte nil))
4ed46869
KH
345 ;; Make `kill-buffer' quiet.
346 (set-buffer-modified-p nil))
0f69cb38 347 ;; Have the original buffer current while we eval.
01ae35c1
RS
348 (eval-buffer buffer nil
349 ;; This is compatible with what `load' does.
350 (if purify-flag file fullname)
88162676
RS
351 ;; If this Emacs is running with --unibyte,
352 ;; convert multibyte strings to unibyte
353 ;; after reading them.
ba74e833 354;; (not default-enable-multibyte-characters)
8dd08b5b 355 nil t
ba74e833 356 ))
cfc70cdf
RS
357 (let (kill-buffer-hook kill-buffer-query-functions)
358 (kill-buffer buffer)))
33d74677
AM
359 (unless purify-flag
360 (do-after-load-evaluation fullname))
5dd1c041 361
db5cae4b
SM
362 (unless (or nomessage noninteractive)
363 (if source
364 (message "Loading %s (source)...done" file)
365 (message "Loading %s...done" file)))
4ed46869
KH
366 t)))
367
8f924df7 368(defun charset-info (charset)
4ed46869 369 "Return a vector of information of CHARSET.
8f924df7 370This function is provided for backward compatibility.
4ed46869 371
4ed46869
KH
372The elements of the vector are:
373 CHARSET-ID, BYTES, DIMENSION, CHARS, WIDTH, DIRECTION,
374 LEADING-CODE-BASE, LEADING-CODE-EXT,
375 ISO-FINAL-CHAR, ISO-GRAPHIC-PLANE,
376 REVERSE-CHARSET, SHORT-NAME, LONG-NAME, DESCRIPTION,
8f924df7 377 PLIST.
4ed46869 378where
8f924df7
KH
379CHARSET-ID is always 0.
380BYTES is always 0.
381DIMENSION is the number of bytes of a code-point of the charset:
382 1, 2, 3, or 4.
383CHARS is the number of characters in a dimension:
384 94, 96, 128, or 256.
385WIDTH is always 0.
386DIRECTION is always 0.
387LEADING-CODE-BASE is always 0.
388LEADING-CODE-EXT is always 0.
4ed46869 389ISO-FINAL-CHAR (character) is the final character of the
7dd4c92d
KH
390 corresponding ISO 2022 charset. If the charset is not assigned
391 any final character, the value is -1.
8f924df7
KH
392ISO-GRAPHIC-PLANE is always 0.
393REVERSE-CHARSET is always -1.
4ed46869
KH
394SHORT-NAME (string) is the short name to refer to the charset.
395LONG-NAME (string) is the long name to refer to the charset
396DESCRIPTION (string) is the description string of the charset.
397PLIST (property list) may contain any type of information a user
398 want to put and get by functions `put-charset-property' and
399 `get-charset-property' respectively."
8f924df7
KH
400 (vector 0
401 0
402 (charset-dimension charset)
403 (charset-chars charset)
404 0
405 0
406 0
407 0
408 (charset-iso-final-char charset)
409 0
410 -1
411 (get-charset-property charset :short-name)
412 (get-charset-property charset :short-name)
413 (charset-description charset)
414 (charset-plist charset)))
4ed46869 415
40c81f74
PE
416;; It is better not to use backquote in this file,
417;; because that makes a bootstrapping problem
418;; if you need to recompile all the Lisp files using interpreted code.
419
8f924df7
KH
420(defun charset-id (charset)
421 "Always return 0. This is provided for backward compatibility."
422 0)
4ed46869
KH
423
424(defmacro charset-bytes (charset)
8f924df7
KH
425 "Always return 0. This is provided for backward compatibility."
426 0)
c1841772
KH
427
428(defun get-charset-property (charset propname)
429 "Return the value of CHARSET's PROPNAME property.
430This is the last value stored with
431 (put-charset-property CHARSET PROPNAME VALUE)."
432 (plist-get (charset-plist charset) propname))
433
434(defun put-charset-property (charset propname value)
1f32125f 435 "Set CHARSETS's PROPNAME property to value VALUE.
c1841772
KH
436It can be retrieved with `(get-charset-property CHARSET PROPNAME)'."
437 (set-charset-plist charset
438 (plist-put (charset-plist charset) propname value)))
439
c1841772
KH
440(defun charset-description (charset)
441 "Return description string of CHARSET."
442 (plist-get (charset-plist charset) :docstring))
443
444(defun charset-dimension (charset)
12504f57 445 "Return dimension of CHARSET."
c1841772
KH
446 (plist-get (charset-plist charset) :dimension))
447
346a8d64 448(defun charset-chars (charset &optional dimension)
12504f57 449 "Return number of characters contained in DIMENSION of CHARSET.
346a8d64
DL
450DIMENSION defaults to the first dimension."
451 (unless dimension (setq dimension 1))
103cc921 452 (let ((code-space (plist-get (charset-plist charset) :code-space)))
346a8d64
DL
453 (1+ (- (aref code-space (1- (* 2 dimension)))
454 (aref code-space (- (* 2 dimension) 2))))))
c1841772
KH
455
456(defun charset-iso-final-char (charset)
1d839a14
DL
457 "Return ISO-2022 final character of CHARSET.
458Return -1 if charset isn't an ISO 2022 one."
c1841772
KH
459 (or (plist-get (charset-plist charset) :iso-final-char)
460 -1))
4ed46869
KH
461
462(defmacro charset-short-name (charset)
c1841772
KH
463 "Return short name of CHARSET."
464 (plist-get (charset-plist charset) :short-name))
4ed46869
KH
465
466(defmacro charset-long-name (charset)
c1841772
KH
467 "Return long name of CHARSET."
468 (plist-get (charset-plist charset) :long-name))
4ed46869 469
d3675a42 470(defun charset-list ()
12504f57 471 "Return list of all charsets ever defined.
900dc6e3 472
d3675a42 473This function is provided for backward compatibility.
900dc6e3 474Now we have the variable `charset-list'."
d3675a42 475 charset-list)
8589dc17 476(make-obsolete 'charset-list "Use variable `charset-list'" "23.1")
d3675a42 477
6d2b6635
KH
478\f
479;;; CHARACTER
480(defalias 'char-valid-p 'characterp)
8589dc17 481(make-obsolete 'char-valid-p 'characterp "23.1")
6d2b6635 482
c1841772 483(defun generic-char-p (char)
8f924df7 484 "Always return nil. This is provided for backward compatibility."
c1841772 485 nil)
8589dc17 486(make-obsolete 'generic-char-p "Generic characters no longer exist" "23.1")
6d2b6635
KH
487
488(defun make-char-internal (charset-id &optional code1 code2)
489 (let ((charset (aref emacs-mule-charset-table charset-id)))
490 (or charset
491 (error "Invalid Emacs-mule charset ID: %d" charset-id))
492 (make-char charset code1 code2)))
0269ddfb 493\f
bd72e34f
CY
494;; Save the ASCII case table in case we need it later. Some locales
495;; (such as Turkish) modify the case behavior of ASCII characters,
496;; which can interfere with networking code that uses ASCII strings.
497
498(defvar ascii-case-table
499 ;; Code copied from copy-case-table to avoid requiring case-table.el
500 (let ((tbl (copy-sequence (standard-case-table)))
501 (up (char-table-extra-slot (standard-case-table) 0)))
502 (if up (set-char-table-extra-slot tbl 0 (copy-sequence up)))
503 (set-char-table-extra-slot tbl 1 nil)
504 (set-char-table-extra-slot tbl 2 nil)
505 tbl)
506 "Case table for the ASCII character set.")
507\f
e76938e7 508;; Coding system stuff
4ed46869 509
c1841772
KH
510;; Coding system is a symbol that has been defined by the function
511;; `define-coding-system'.
4ed46869 512
c1841772
KH
513(defconst coding-system-iso-2022-flags
514 '(long-form
515 ascii-at-eol
516 ascii-at-cntl
517 7-bit
518 locking-shift
519 single-shift
520 designation
521 revision
522 direction
523 init-at-bol
524 designate-at-bol
525 safe
526 latin-extra
527 composition
3ed58a15
KH
528 euc-tw-shift
529 use-roman
530 use-oldjis)
c1841772 531 "List of symbols that control ISO-2022 encoder/decoder.
4ed46869 532
12504f57 533The value of the `:flags' attribute in the argument of the function
caa7db3a 534`define-coding-system' must be one of them.
4ed46869 535
c1841772
KH
536If `long-form' is specified, use a long designation sequence on
537encoding for the charsets `japanese-jisx0208-1978', `chinese-gb2312',
538and `japanese-jisx0208'. The long designation sequence doesn't
12504f57 539conform to ISO 2022, but is used by such coding systems as
c1841772
KH
540`compound-text'.
541
542If `ascii-at-eol' is specified, designate ASCII to g0 at end of line
543on encoding.
544
545If `ascii-at-cntl' is specified, designate ASCII to g0 before control
546codes and SPC on encoding.
547
548If `7-bit' is specified, use 7-bit code only on encoding.
549
550If `locking-shift' is specified, decode locking-shift code correctly
551on decoding, and use locking-shift to invoke a graphic element on
552encoding.
553
554If `single-shift' is specified, decode single-shift code correctly on
555decoding, and use single-shift to invoke a graphic element on encoding.
556
557If `designation' is specified, decode designation code correctly on
558decoding, and use designation to designate a charset to a graphic
559element on encoding.
560
561If `revision' is specified, produce an escape sequence to specify
562revision number of a charset on encoding. Such an escape sequence is
563always correctly decoded on decoding.
564
565If `direction' is specified, decode ISO6429's code for specifying
12504f57 566direction correctly, and produce the code on encoding.
c1841772
KH
567
568If `init-at-bol' is specified, on encoding, it is assumed that
569invocation and designation statuses are reset at each beginning of
12504f57 570line even if `ascii-at-eol' is not specified; thus no codes for
c1841772
KH
571resetting them are produced.
572
573If `safe' is specified, on encoding, characters not supported by a
574coding are replaced with `?'.
575
12504f57 576If `latin-extra' is specified, the code-detection routine assumes that a
c1841772
KH
577code specified in `latin-extra-code-table' (which see) is valid.
578
579If `composition' is specified, an escape sequence to specify
12504f57 580composition sequence is correctly decoded on decoding, and is produced
c1841772
KH
581on encoding.
582
583If `euc-tw-shift' is specified, the EUC-TW specific shifting code is
12504f57 584correctly decoded on decoding, and is produced on encoding.
c1841772 585
12504f57
DL
586If `use-roman' is specified, JIS0201-1976-Roman is designated instead
587of ASCII.
588
589If `use-oldjis' is specified, JIS0208-1976 is designated instead of
590JIS0208-1983.")
591
c1841772 592(defun define-coding-system (name docstring &rest props)
12504f57 593 "Define NAME (a symbol) as a coding system with DOCSTRING and attributes.
c1841772
KH
594The remaining arguments must come in pairs ATTRIBUTE VALUE. ATTRIBUTE
595may be any symbol.
596
12504f57
DL
597The following attributes have special meanings. Those labeled as
598\"(required)\", should not be omitted.
c1841772
KH
599
600`:mnemonic' (required)
601
602VALUE is a character to display on mode line for the coding system.
603
604`:coding-type' (required)
605
606VALUE must be one of `charset', `utf-8', `utf-16', `iso-2022',
1bfd603c 607`emacs-mule', `shift-jis', `ccl', `raw-text', `undecided'.
c1841772 608
12504f57 609`:eol-type'
c1841772 610
12504f57 611VALUE is the EOL (end-of-line) format of the coding system. It must be
c1841772
KH
612one of `unix', `dos', `mac'. The symbol `unix' means Unix-like EOL
613\(i.e. single LF), `dos' means DOS-like EOL \(i.e. sequence of CR LF),
614and `mac' means MAC-like EOL \(i.e. single CR). If omitted, on
12504f57 615decoding by the coding system, Emacs automatically detects the EOL
c1841772
KH
616format of the source text.
617
736345cb 618`:charset-list'
c1841772
KH
619
620VALUE must be a list of charsets supported by the coding system. On
621encoding by the coding system, if a character belongs to multiple
622charsets in the list, a charset that comes earlier in the list is
736345cb
KH
623selected. If `:coding-type' is `iso-2022', VALUE may be `iso-2022',
624which indicates that the coding system supports all ISO-2022 based
625charsets. If `:coding-type' is `emacs-mule', VALUE may be
626`emacs-mule', which indicates that the coding system supports all
1d839a14 627charsets that have the `:emacs-mule-id' property.
c1841772 628
12504f57 629`:ascii-compatible-p'
c1841772
KH
630
631If VALUE is non-nil, the coding system decodes all 7-bit bytes into
07513d64 632the corresponding ASCII characters, and encodes all ASCII characters
12504f57 633back to the corresponding 7-bit bytes. VALUE defaults to nil.
c1841772 634
12504f57 635`:decode-translation-table'
c1841772
KH
636
637VALUE must be a translation table to use on decoding.
638
12504f57 639`:encode-translation-table'
c1841772
KH
640
641VALUE must be a translation table to use on encoding.
642
12504f57 643`:post-read-conversion'
c1841772
KH
644
645VALUE must be a function to call after some text is inserted and
646decoded by the coding system itself and before any functions in
647`after-insert-functions' are called. The arguments to this function
12504f57
DL
648are the same as those of a function in `after-insert-file-functions',
649i.e. LENGTH of the text to be decoded with point at the head of it,
650and the function should leave point unchanged.
c1841772
KH
651
652`:pre-write-conversion'
653
654VALUE must be a function to call after all functions in
655`write-region-annotate-functions' and `buffer-file-format' are called,
656and before the text is encoded by the coding system itself. The
12504f57
DL
657arguments to this function are the same as those of a function in
658`write-region-annotate-functions'.
c1841772
KH
659
660`:default-char'
661
662VALUE must be a character. On encoding, a character not supported by
663the coding system is replaced with VALUE.
664
8f924df7
KH
665`:for-unibyte'
666
667VALUE non-nil means that visiting a file with the coding system
668results in a unibyte buffer.
669
c1841772
KH
670`:eol-type'
671
672VALUE must be `unix', `dos', `mac'. The symbol `unix' means Unix-like
673EOL (LF), `dos' means DOS-like EOL (CRLF), and `mac' means MAC-like
12504f57
DL
674EOL (CR). If omitted, on decoding, the coding system detects EOL
675format automatically, and on encoding, uses Unix-like EOL.
c1841772
KH
676
677`:mime-charset'
678
12504f57
DL
679VALUE must be a symbol whose name is that of a MIME charset converted
680to lower case.
c1841772 681
1bfd603c
DL
682`:mime-text-unsuitable'
683
684VALUE non-nil means the `:mime-charset' property names a charset which
1894d108 685is unsuitable for the top-level media type \"text\".
1bfd603c 686
c1841772
KH
687`:flags'
688
12504f57
DL
689VALUE must be a list of symbols that control the ISO-2022 converter.
690Each must be a member of the list `coding-system-iso-2022-flags'
c1841772
KH
691\(which see). This attribute has a meaning only when `:coding-type'
692is `iso-2022'.
693
694`:designation'
695
12504f57 696VALUE must be a vector [G0-USAGE G1-USAGE G2-USAGE G3-USAGE].
c1841772
KH
697GN-USAGE specifies the usage of graphic register GN as follows.
698
699If it is nil, no charset can be designated to GN.
700
07513d64 701If it is a charset, the charset is initially designated to GN, and
c1841772
KH
702never used by the other charsets.
703
704If it is a list, the elements must be charsets, nil, 94, or 96. GN
12504f57
DL
705can be used by all the listed charsets. If the list contains 94, any
706iso-2022 charset whose code-space ranges are 94 long can be designated
707to GN. If the list contains 96, any charsets whose whose ranges are
70896 long can be designated to GN. If the first element is a charset,
709that charset is initially designated to GN.
c1841772
KH
710
711This attribute has a meaning only when `:coding-type' is `iso-2022'.
712
713`:bom'
714
12504f57
DL
715This attributes specifies whether the coding system uses a `byte order
716mark'. VALUE must nil, t, or cons of coding systems whose
717`:coding-type' is `utf-16'.
c1841772 718
0ea1a6ca
KH
719If the value is nil, on decoding, don't treat the first two-byte as
720BOM, and on encoding, don't produce BOM bytes.
721
722If the value is t, on decoding, skip the first two-byte as BOM, and on
723encoding, produce BOM bytes accoding to the value of `:endian'.
724
725If the value is cons, on decoding, check the first two-byte. If theyq
726are 0xFE 0xFF, use the car part coding system of the value. If they
727are 0xFF 0xFE, use the car part coding system of the value.
728Otherwise, treat them as bytes for a normal character. On encoding,
729produce BOM bytes accoding to the value of `:endian'.
730
c1841772
KH
731This attribute has a meaning only when `:coding-type' is `utf-16'.
732
733`:endian'
734
0ea1a6ca
KH
735VALUE must be `big' or `little' specifying big-endian and
736little-endian respectively. The default value is `big'.
c1841772
KH
737
738This attribute has a meaning only when `:coding-type' is `utf-16'.
739
740`:ccl-decoder'
741
12504f57
DL
742VALUE is a symbol representing the registered CCL program used for
743decoding. This attribute has a meaning only when `:coding-type' is
744`ccl'.
c1841772
KH
745
746`:ccl-encoder'
747
12504f57
DL
748VALUE is a symbol representing the registered CCL program used for
749encoding. This attribute has a meaning only when `:coding-type' is
750`ccl'."
c1841772
KH
751 (let* ((common-attrs (mapcar 'list
752 '(:mnemonic
753 :coding-type
754 :charset-list
755 :ascii-compatible-p
1a9db556 756 :decode-translation-table
c1841772
KH
757 :encode-translation-table
758 :post-read-conversion
759 :pre-write-conversion
760 :default-char
7e742024 761 :for-unibyte
c1841772
KH
762 :plist
763 :eol-type)))
764 (coding-type (plist-get props :coding-type))
765 (spec-attrs (mapcar 'list
766 (cond ((eq coding-type 'iso-2022)
767 '(:initial
768 :reg-usage
769 :request
770 :flags))
771 ((eq coding-type 'utf-16)
772 '(:bom
773 :endian))
774 ((eq coding-type 'ccl)
775 '(:ccl-decoder
776 :ccl-encoder
777 :valids))))))
778
779 (dolist (slot common-attrs)
780 (setcdr slot (plist-get props (car slot))))
781
782 (dolist (slot spec-attrs)
783 (setcdr slot (plist-get props (car slot))))
784
785 (if (eq coding-type 'iso-2022)
786 (let ((designation (plist-get props :designation))
787 (flags (plist-get props :flags))
788 (initial (make-vector 4 nil))
789 (reg-usage (cons 4 4))
790 request elt)
791 (dotimes (i 4)
792 (setq elt (aref designation i))
793 (cond ((charsetp elt)
794 (aset initial i elt)
795 (setq request (cons (cons elt i) request)))
796 ((consp elt)
797 (aset initial i (car elt))
798 (if (charsetp (car elt))
799 (setq request (cons (cons (car elt) i) request)))
800 (dolist (e (cdr elt))
801 (cond ((charsetp e)
802 (setq request (cons (cons e i) request)))
803 ((eq e 94)
804 (setcar reg-usage i))
805 ((eq e 96)
806 (setcdr reg-usage i))
807 ((eq e t)
808 (setcar reg-usage i)
809 (setcdr reg-usage i)))))))
810 (setcdr (assq :initial spec-attrs) initial)
811 (setcdr (assq :reg-usage spec-attrs) reg-usage)
812 (setcdr (assq :request spec-attrs) request)
813
814 ;; Change :flags value from a list to a bit-mask.
815 (let ((bits 0)
816 (i 0))
817 (dolist (elt coding-system-iso-2022-flags)
818 (if (memq elt flags)
819 (setq bits (logior bits (lsh 1 i))))
820 (setq i (1+ i)))
821 (setcdr (assq :flags spec-attrs) bits))))
822
823 ;; Add :name and :docstring properties to PROPS.
824 (setq props
e1e529fa
DL
825 (cons :name (cons name (cons :docstring (cons (purecopy docstring)
826 props)))))
c1841772 827 (setcdr (assq :plist common-attrs) props)
c1841772
KH
828 (apply 'define-coding-system-internal
829 name (mapcar 'cdr (append common-attrs spec-attrs)))))
4ed46869 830
8057896b 831(defun coding-system-doc-string (coding-system)
0269ddfb 832 "Return the documentation string for CODING-SYSTEM."
c1841772 833 (plist-get (coding-system-plist coding-system) :docstring))
4ed46869 834
4ed46869 835(defun coding-system-mnemonic (coding-system)
0269ddfb 836 "Return the mnemonic character of CODING-SYSTEM.
12504f57
DL
837The mnemonic character of a coding system is used in mode line to
838indicate the coding system. If CODING-SYSTEM. is nil, return ?=."
c1841772 839 (plist-get (coding-system-plist coding-system) :mnemonic))
4ed46869 840
c1841772
KH
841(defun coding-system-type (coding-system)
842 "Return the coding type of CODING-SYSTEM.
843A coding type is a symbol indicating the encoding method of CODING-SYSTEM.
844See the function `define-coding-system' for more detail."
845 (plist-get (coding-system-plist coding-system) :coding-type))
d3675a42 846
c1841772 847(defun coding-system-charset-list (coding-system)
07513d64 848 "Return list of charsets supported by CODING-SYSTEM.
c1841772
KH
849If CODING-SYSTEM supports all ISO-2022 charsets, return `iso-2022'.
850If CODING-SYSTEM supports all emacs-mule charsets, return `emacs-mule'."
851 (plist-get (coding-system-plist coding-system) :charset-list))
0269ddfb 852
2f1e746b
KH
853(defun coding-system-category (coding-system)
854 "Return a category symbol of CODING-SYSTEM."
855 (plist-get (coding-system-plist coding-system) :category))
0269ddfb
KH
856
857(defun coding-system-get (coding-system prop)
07513d64
DL
858 "Extract a value from CODING-SYSTEM's property list for property PROP.
859For compatibility with Emacs 20/21, this accepts old-style symbols
860like `mime-charset' as well as the current style like `:mime-charset'."
861 (or (plist-get (coding-system-plist coding-system) prop)
862 (if (not (keywordp prop))
356384dc
KH
863 ;; For backward compatiblity.
864 (if (eq prop 'ascii-incompatible)
865 (not (plist-get (coding-system-plist coding-system)
866 :ascii-compatible-p))
867 (plist-get (coding-system-plist coding-system)
868 (intern (concat ":" (symbol-name prop))))))))
0269ddfb 869
2e729bfa
JB
870(defun coding-system-eol-type-mnemonic (coding-system)
871 "Return the string indicating end-of-line format of CODING-SYSTEM."
872 (let* ((eol-type (coding-system-eol-type coding-system))
f4f00827 873 (val (cond ((eq eol-type 0) eol-mnemonic-unix)
2e729bfa
JB
874 ((eq eol-type 1) eol-mnemonic-dos)
875 ((eq eol-type 2) eol-mnemonic-mac)
f4f00827 876 (t eol-mnemonic-undecided))))
2e729bfa
JB
877 (if (stringp val)
878 val
879 (char-to-string val))))
880
857ea15c
AS
881(defun coding-system-lessp (x y)
882 (cond ((eq x 'no-conversion) t)
883 ((eq y 'no-conversion) nil)
884 ((eq x 'emacs-mule) t)
885 ((eq y 'emacs-mule) nil)
886 ((eq x 'undecided) t)
887 ((eq y 'undecided) nil)
888 (t (let ((c1 (coding-system-mnemonic x))
889 (c2 (coding-system-mnemonic y)))
890 (or (< (downcase c1) (downcase c2))
891 (and (not (> (downcase c1) (downcase c2)))
892 (< c1 c2)))))))
893
5e2e859a
KH
894(defun coding-system-equal (coding-system-1 coding-system-2)
895 "Return t if and only if CODING-SYSTEM-1 and CODING-SYSTEM-2 are identical.
896Two coding systems are identical if two symbols are equal
897or one is an alias of the other."
898 (or (eq coding-system-1 coding-system-2)
daff7d74
KH
899 (and (equal (coding-system-plist coding-system-1)
900 (coding-system-plist coding-system-2))
5e2e859a
KH
901 (let ((eol-type-1 (coding-system-eol-type coding-system-1))
902 (eol-type-2 (coding-system-eol-type coding-system-2)))
903 (or (eq eol-type-1 eol-type-2)
904 (and (vectorp eol-type-1) (vectorp eol-type-2)))))))
905
857ea15c 906(defun add-to-coding-system-list (coding-system)
521d4010 907 "Add CODING-SYSTEM to `coding-system-list' while keeping it sorted."
857ea15c
AS
908 (if (or (null coding-system-list)
909 (coding-system-lessp coding-system (car coding-system-list)))
910 (setq coding-system-list (cons coding-system coding-system-list))
911 (let ((len (length coding-system-list))
912 mid (tem coding-system-list))
913 (while (> len 1)
914 (setq mid (nthcdr (/ len 2) tem))
915 (if (coding-system-lessp (car mid) coding-system)
916 (setq tem mid
917 len (- len (/ len 2)))
918 (setq len (/ len 2))))
919 (setcdr tem (cons coding-system (cdr tem))))))
920
80a7463d 921(defun coding-system-list (&optional base-only)
c11a8f77 922 "Return a list of all existing non-subsidiary coding systems.
12504f57
DL
923If optional arg BASE-ONLY is non-nil, only base coding systems are
924listed. The value doesn't include subsidiary coding systems which are
c11a8f77
KH
925made from bases and aliases automatically for various end-of-line
926formats (e.g. iso-latin-1-unix, koi8-r-dos)."
4f06ffe1
KH
927 (let ((codings nil))
928 (dolist (coding coding-system-list)
929 (if (eq (coding-system-base coding) coding)
930 (if base-only
931 (setq codings (cons coding codings))
932 (dolist (alias (coding-system-aliases coding))
933 (setq codings (cons alias codings))))))
80a7463d
KH
934 codings))
935
620956ca
KH
936(defconst char-coding-system-table nil
937 "This is an obsolete variable.
938It exists just for backward compatibility, and the value is always nil.")
c11a8f77 939
50c29104
KH
940(defun transform-make-coding-system-args (name type &optional doc-string props)
941 "For internal use only.
942Transform XEmacs style args for `make-coding-system' to Emacs style.
943Value is a list of transformed arguments."
944 (let ((mnemonic (string-to-char (or (plist-get props 'mnemonic) "?")))
945 (eol-type (plist-get props 'eol-type))
946 properties tmp)
947 (cond
948 ((eq eol-type 'lf) (setq eol-type 'unix))
949 ((eq eol-type 'crlf) (setq eol-type 'dos))
950 ((eq eol-type 'cr) (setq eol-type 'mac)))
951 (if (setq tmp (plist-get props 'post-read-conversion))
952 (setq properties (plist-put properties 'post-read-conversion tmp)))
953 (if (setq tmp (plist-get props 'pre-write-conversion))
954 (setq properties (plist-put properties 'pre-write-conversion tmp)))
955 (cond
f4a012a6
KH
956 ((eq type 'shift-jis)
957 `(,name 1 ,mnemonic ,doc-string () ,properties ,eol-type))
958 ((eq type 'iso2022) ; This is not perfect.
959 (if (plist-get props 'escape-quoted)
960 (error "escape-quoted is not supported: %S"
961 `(,name ,type ,doc-string ,props)))
962 (let ((g0 (plist-get props 'charset-g0))
963 (g1 (plist-get props 'charset-g1))
964 (g2 (plist-get props 'charset-g2))
965 (g3 (plist-get props 'charset-g3))
966 (use-roman
967 (and
968 (eq (cadr (assoc 'latin-jisx0201
969 (plist-get props 'input-charset-conversion)))
970 'ascii)
971 (eq (cadr (assoc 'ascii
972 (plist-get props 'output-charset-conversion)))
973 'latin-jisx0201)))
974 (use-oldjis
975 (and
976 (eq (cadr (assoc 'japanese-jisx0208-1978
977 (plist-get props 'input-charset-conversion)))
978 'japanese-jisx0208)
979 (eq (cadr (assoc 'japanese-jisx0208
980 (plist-get props 'output-charset-conversion)))
981 'japanese-jisx0208-1978))))
982 (if (charsetp g0)
983 (if (plist-get props 'force-g0-on-output)
984 (setq g0 `(nil ,g0))
985 (setq g0 `(,g0 t))))
986 (if (charsetp g1)
987 (if (plist-get props 'force-g1-on-output)
988 (setq g1 `(nil ,g1))
989 (setq g1 `(,g1 t))))
990 (if (charsetp g2)
991 (if (plist-get props 'force-g2-on-output)
992 (setq g2 `(nil ,g2))
993 (setq g2 `(,g2 t))))
994 (if (charsetp g3)
995 (if (plist-get props 'force-g3-on-output)
996 (setq g3 `(nil ,g3))
997 (setq g3 `(,g3 t))))
998 `(,name 2 ,mnemonic ,doc-string
999 (,g0 ,g1 ,g2 ,g3
1000 ,(plist-get props 'short)
1001 ,(not (plist-get props 'no-ascii-eol))
1002 ,(not (plist-get props 'no-ascii-cntl))
1003 ,(plist-get props 'seven)
1004 t
1005 ,(not (plist-get props 'lock-shift))
1006 ,use-roman
1007 ,use-oldjis
1008 ,(plist-get props 'no-iso6429)
1009 nil nil nil nil)
1010 ,properties ,eol-type)))
1011 ((eq type 'big5)
1012 `(,name 3 ,mnemonic ,doc-string () ,properties ,eol-type))
50c29104 1013 ((eq type 'ccl)
f4a012a6 1014 `(,name 4 ,mnemonic ,doc-string
50c29104 1015 (,(plist-get props 'decode) . ,(plist-get props 'encode))
f4a012a6 1016 ,properties ,eol-type))
50c29104 1017 (t
f4a012a6 1018 (error "unsupported XEmacs style make-coding-style arguments: %S"
50c29104
KH
1019 `(,name ,type ,doc-string ,props))))))
1020
8057896b 1021(defun make-coding-system (coding-system type mnemonic doc-string
1b46a680
KH
1022 &optional
1023 flags
1024 properties
1025 eol-type)
3bb1accb 1026 "Define a new coding system CODING-SYSTEM (symbol).
8f924df7
KH
1027This function is provided for backward compatibility.
1028Use `define-coding-system' instead."
50c29104 1029 ;; For compatiblity with XEmacs, we check the type of TYPE. If it
c3d0ee51
EZ
1030 ;; is a symbol, perhaps, this function is called with XEmacs-style
1031 ;; arguments. Here, try to transform that kind of arguments to
50c29104
KH
1032 ;; Emacs style.
1033 (if (symbolp type)
1034 (let ((args (transform-make-coding-system-args coding-system type
1035 mnemonic doc-string)))
1036 (setq coding-system (car args)
1053cc93 1037 type (nth 1 args)
50c29104
KH
1038 mnemonic (nth 2 args)
1039 doc-string (nth 3 args)
1040 flags (nth 4 args)
1041 properties (nth 5 args)
1042 eol-type (nth 6 args))))
1043
8f924df7
KH
1044 (setq type
1045 (cond ((eq type 0) 'emacs-mule)
1046 ((eq type 1) 'shift-jis)
1047 ((eq type 2) 'iso2022)
1048 ((eq type 3) 'big5)
1049 ((eq type 4) 'ccl)
1050 ((eq type 5) 'raw-text)
1b46a680 1051 (t
8f924df7
KH
1052 (error "Invalid coding system type: %s" type))))
1053
1054 (setq properties
1055 (let ((plist nil) key)
1056 (dolist (elt properties)
1057 (setq key (car elt))
1058 (cond ((eq key 'post-read-conversion)
1059 (setq key :post-read-conversion))
1060 ((eq key 'pre-write-conversion)
1061 (setq key :pre-write-conversion))
1062 ((eq key 'translation-table-for-decode)
1063 (setq key :decode-translation-table))
1064 ((eq key 'translation-table-for-encode)
1065 (setq key :encode-translation-table))
1066 ((eq key 'safe-charsets)
1067 (setq key :charset-list))
1068 ((eq key 'mime-charset)
1069 (setq key :mime-charset))
1070 ((eq key 'valid-codes)
1071 (setq key :valids)))
1072 (setq plist (plist-put plist key (cdr elt))))
1073 plist))
28380f17 1074 (setq properties (plist-put properties :mnemonic mnemonic))
8f924df7
KH
1075 (plist-put properties :coding-type type)
1076 (cond ((eq eol-type 0) (setq eol-type 'unix))
1077 ((eq eol-type 1) (setq eol-type 'dos))
1078 ((eq eol-type 2) (setq eol-type 'mac))
1079 ((vectorp eol-type) (setq eol-type nil)))
1080 (plist-put properties :eol-type eol-type)
1081
1082 (cond
1083 ((eq type 'iso2022)
1084 (plist-put properties :flags
1085 (list (and (or (consp (nth 0 flags))
1086 (consp (nth 1 flags))
1087 (consp (nth 2 flags))
1088 (consp (nth 3 flags))) 'designation)
1089 (or (nth 4 flags) 'long-form)
1090 (and (nth 5 flags) 'ascii-at-eol)
1091 (and (nth 6 flags) 'ascii-at-cntl)
1092 (and (nth 7 flags) '7-bit)
1093 (and (nth 8 flags) 'locking-shift)
1094 (and (nth 9 flags) 'single-shift)
1095 (and (nth 10 flags) 'use-roman)
1096 (and (nth 11 flags) 'use-oldjis)
1097 (or (nth 12 flags) 'direction)
1098 (and (nth 13 flags) 'init-at-bol)
1099 (and (nth 14 flags) 'designate-at-bol)
1100 (and (nth 15 flags) 'safe)
1101 (and (nth 16 flags) 'latin-extra)))
1102 (plist-put properties :designation
1103 (let ((vec (make-vector 4 nil)))
1104 (dotimes (i 4)
1105 (let ((spec (nth i flags)))
1106 (if (eq spec t)
1107 (aset vec i '(94 96))
1108 (if (consp spec)
1109 (progn
1110 (if (memq t spec)
1111 (setq spec (append (delq t spec) '(94 96))))
1112 (aset vec i spec))))))
1113 vec)))
1114
1115 ((eq type 'ccl)
1116 (plist-put properties :ccl-decoder (car flags))
1117 (plist-put properties :ccl-encoder (cdr flags))))
1118
1119 (apply 'define-coding-system coding-system doc-string properties))
4ed46869 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
1139FROM is a form to evaluate to define the coding-system."
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
1151according to CODING-SYSTEM. For a list of possible values of CODING-SYSTEM,
1152use \\[list-coding-systems].
1153
bbdea948
RS
1154If CODING-SYSTEM leaves the text conversion unspecified, or if it
1155leaves the end-of-line conversion unspecified, FORCE controls what to
1156do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1157buffer's previous `buffer-file-coding-system' value (if it is
6b61353c 1158specified there). Otherwise, 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
1183If CODING-SYSTEM leaves the text conversion unspecified, or if it
1184leaves the end-of-line conversion unspecified, FORCE controls what to
1185do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1186buffer's previous `buffer-file-coding-system' value (if it is
1187specified there). Otherwise, determine it from the file contents as
1188usual for visiting a file."
5b76833f 1189 (interactive "zCoding system for visited file (default nil): \nP")
bbdea948
RS
1190 (check-coding-system coding-system)
1191 (if (and coding-system buffer-file-coding-system (null force))
1192 (setq coding-system
1193 (merge-coding-systems coding-system buffer-file-coding-system)))
1194 (let ((coding-system-for-read coding-system))
1195 (revert-buffer)))
1196
701414e3
KH
1197(defun set-file-name-coding-system (coding-system)
1198 "Set coding system for decoding and encoding file names to CODING-SYSTEM.
1199It actually just set the variable `file-name-coding-system' (which
1200see) to CODING-SYSTEM."
5b76833f 1201 (interactive "zCoding system for file names (default nil): ")
701414e3 1202 (check-coding-system coding-system)
356384dc
KH
1203 (if (and coding-system
1204 (not (coding-system-get coding-system :ascii-compatible-p))
1205 (not (coding-system-get coding-system :suitable-for-file-name)))
1206 (error "%s is not suitable for file names" coding-system))
701414e3
KH
1207 (setq file-name-coding-system coding-system))
1208
358d28fb
RS
1209(defvar default-terminal-coding-system nil
1210 "Default value for the terminal coding system.
1211This is normally set according to the selected language environment.
1212See also the command `set-terminal-coding-system'.")
1213
68bba4e4
KL
1214(defun set-terminal-coding-system (coding-system &optional display)
1215 "Set coding system of terminal output to CODING-SYSTEM.
1216All text output to DISPLAY will be encoded
358d28fb 1217with the specified coding system.
68bba4e4 1218
358d28fb
RS
1219For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1220The default is determined by the selected language environment
68bba4e4
KL
1221or by the previous use of this command.
1222
1223DISPLAY may be a display id, a frame, or nil for the selected frame's display.
1224The setting has no effect on graphical displays."
358d28fb 1225 (interactive
2e02a76f
RS
1226 (list (let ((default (if (and (not (terminal-coding-system))
1227 default-terminal-coding-system)
1228 default-terminal-coding-system)))
1229 (read-coding-system
5b76833f 1230 (format "Coding system for terminal display (default %s): "
2e02a76f
RS
1231 default)
1232 default))))
358d28fb
RS
1233 (if (and (not coding-system)
1234 (not (terminal-coding-system)))
1235 (setq coding-system default-terminal-coding-system))
1236 (if coding-system
521d4010 1237 (setq default-terminal-coding-system coding-system))
68bba4e4 1238 (set-terminal-coding-system-internal coding-system display)
df100398
KH
1239 (redraw-frame (selected-frame)))
1240
358d28fb
RS
1241(defvar default-keyboard-coding-system nil
1242 "Default value of the keyboard coding system.
1243This is normally set according to the selected language environment.
1244See also the command `set-keyboard-coding-system'.")
1245
68bba4e4
KL
1246(defun set-keyboard-coding-system (coding-system &optional display)
1247 "Set coding system for keyboard input on DISPLAY to CODING-SYSTEM.
40df3a99
KL
1248In addition, this command calls `encoded-kbd-setup-display' to set up the
1249translation of keyboard input events to the specified coding system.
68bba4e4 1250
358d28fb
RS
1251For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1252The default is determined by the selected language environment
68bba4e4
KL
1253or by the previous use of this command.
1254
1255DISPLAY may be a display id, a frame, or nil for the selected frame's display.
1256The setting has no effect on graphical displays."
358d28fb 1257 (interactive
2e02a76f
RS
1258 (list (let ((default (if (and (not (keyboard-coding-system))
1259 default-keyboard-coding-system)
1260 default-keyboard-coding-system)))
1261 (read-coding-system
5b76833f 1262 (format "Coding system for keyboard input (default %s): "
2e02a76f
RS
1263 default)
1264 default))))
358d28fb
RS
1265 (if (and (not coding-system)
1266 (not (keyboard-coding-system)))
1267 (setq coding-system default-keyboard-coding-system))
1268 (if coding-system
1269 (setq default-keyboard-coding-system coding-system))
356384dc
KH
1270 (if (and coding-system
1271 (not (coding-system-get coding-system :ascii-compatible-p))
1272 (not (coding-system-get coding-system :suitable-for-keyboard)))
1273 (error "%s is not suitable for keyboard" coding-system))
68bba4e4 1274 (set-keyboard-coding-system-internal coding-system display)
b23bad0b 1275 (setq keyboard-coding-system coding-system)
40df3a99 1276 (encoded-kbd-setup-display display))
df100398 1277
6d34f495
DL
1278(defcustom keyboard-coding-system nil
1279 "Specify coding system for keyboard input.
1280If you set this on a terminal which can't distinguish Meta keys from
12818-bit characters, you will have to use ESC to type Meta characters.
50e5c885 1282See Info node `Terminal Coding' and Info node `Unibyte Mode'.
6d34f495 1283
237e5993
DL
1284On non-windowing terminals, this is set from the locale by default.
1285
6d34f495 1286Setting this variable directly does not take effect;
6b61353c 1287use either \\[customize] or \\[set-keyboard-coding-system]."
6d34f495 1288 :type '(coding-system :tag "Coding system")
50e5c885
EZ
1289 :link '(info-link "(emacs)Terminal Coding")
1290 :link '(info-link "(emacs)Unibyte Mode")
6d34f495 1291 :set (lambda (symbol value)
2a42d440
KL
1292 ;; Don't load encoded-kb unnecessarily.
1293 (if (or value (boundp 'encoded-kbd-setup-display))
6d34f495
DL
1294 (set-keyboard-coding-system value)
1295 (set-default 'keyboard-coding-system nil))) ; must initialize
bf247b6e 1296 :version "22.1"
6d34f495
DL
1297 :group 'keyboard
1298 :group 'mule)
1299
df100398 1300(defun set-buffer-process-coding-system (decoding encoding)
358d28fb 1301 "Set coding systems for the process associated with the current buffer.
df100398 1302DECODING is the coding system to be used to decode input from the process,
358d28fb
RS
1303ENCODING is the coding system to be used to encode output to the process.
1304
1305For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
4ed46869 1306 (interactive
83911021 1307 "zCoding-system for output from the process: \nzCoding-system for input to the process: ")
4ed46869
KH
1308 (let ((proc (get-buffer-process (current-buffer))))
1309 (if (null proc)
521d4010 1310 (error "No process")
df100398
KH
1311 (check-coding-system decoding)
1312 (check-coding-system encoding)
1313 (set-process-coding-system proc decoding encoding)))
4ed46869
KH
1314 (force-mode-line-update))
1315
d0b99881
RS
1316(defalias 'set-clipboard-coding-system 'set-selection-coding-system)
1317
14915c37 1318(defun set-selection-coding-system (coding-system)
8c52d564 1319 "Make CODING-SYSTEM used for communicating with other X clients.
b25eef20
KH
1320When sending or receiving text via cut_buffer, selection, and clipboard,
1321the text is encoded or decoded by CODING-SYSTEM."
a03b3ce1 1322 (interactive "zCoding system for X selection: ")
b25eef20 1323 (check-coding-system coding-system)
14915c37 1324 (setq selection-coding-system coding-system))
b25eef20 1325
e8dd0160 1326;; Coding system lastly specified by the command
a03b3ce1
KH
1327;; set-next-selection-coding-system.
1328(defvar last-next-selection-coding-system nil)
1329
1330(defun set-next-selection-coding-system (coding-system)
12504f57 1331 "Use CODING-SYSTEM for next communication with other window system clients.
a03b3ce1
KH
1332This setting is effective for the next communication only."
1333 (interactive
1334 (list (read-coding-system
1335 (if last-next-selection-coding-system
7b9dc9af 1336 (format "Coding system for the next selection (default %S): "
a03b3ce1 1337 last-next-selection-coding-system)
12504f57 1338 "Coding system for the next selection: ")
a03b3ce1
KH
1339 last-next-selection-coding-system)))
1340 (if coding-system
1341 (setq last-next-selection-coding-system coding-system)
1342 (setq coding-system last-next-selection-coding-system))
1343 (check-coding-system coding-system)
1344
1345 (setq next-selection-coding-system coding-system))
1346
4ed46869 1347(defun set-coding-priority (arg)
521d4010 1348 "Set priority of coding categories according to ARG.
c1841772
KH
1349ARG is a list of coding categories ordered by priority.
1350
1351This function is provided for backward compatibility.
1352Now we have more convenient function `set-coding-system-priority'."
5d75f46f
KH
1353 (apply 'set-coding-system-priority
1354 (mapcar #'(lambda (x) (symbol-value x)) arg)))
8589dc17 1355(make-obsolete 'set-coding-priority 'set-coding-system-priority "23.1")
4ed46869 1356
835cbadb
EZ
1357;;; X selections
1358
cc926903 1359(defvar ctext-non-standard-encodings-alist
e0bd7bb9 1360 '(("big5-0" big5 2 big5)
6b61353c 1361 ("ISO8859-14" iso-8859-14 1 latin-iso8859-14)
e0bd7bb9
KH
1362 ("ISO8859-15" iso-8859-15 1 latin-iso8859-15)
1363 ("gbk-0" gbk 2 chinese-gbk))
6b61353c
KH
1364 "Alist of non-standard encoding names vs the corresponding usages in CTEXT.
1365
1366It controls how extended segments of a compound text are handled
1367by the coding system `compound-text-with-extensions'.
1368
1369Each element has the form (ENCODING-NAME CODING-SYSTEM N-OCTET CHARSET).
1370
1371ENCODING-NAME is an encoding name of an \"extended segments\".
1372
1373CODING-SYSTEM is the coding-system to encode (or decode) the
1374characters into (or from) the extended segment.
1375
1376N-OCTET is the number of octets (bytes) that encodes a character
1377in the segment. It can be 0 (meaning the number of octets per
1378character is variable), 1, 2, 3, or 4.
1379
1380CHARSET is a charater set containing characters that are encoded
e0bd7bb9 1381in the segment. It can be a list of character sets.
6b61353c
KH
1382
1383On decoding CTEXT, all encoding names listed here are recognized.
1384
1385On encoding CTEXT, encoding names in the variable
1386`ctext-non-standard-encodings' (which see) and in the information
1387listed for the current language environment under the key
1388`ctext-non-standard-encodings' are used.")
1389
e0bd7bb9 1390(defvar ctext-non-standard-encodings nil
6b61353c
KH
1391 "List of non-standard encoding names used in extended segments of CTEXT.
1392Each element must be one of the names listed in the variable
1393`ctext-non-standard-encodings-alist' (which see).")
cc926903
KH
1394
1395(defvar ctext-non-standard-encodings-regexp
1396 (string-to-multibyte
1397 (concat
1398 ;; For non-standard encodings.
1399 "\\(\e%/[0-4][\200-\377][\200-\377]\\([^\002]+\\)\002\\)"
1400 "\\|"
1401 ;; For UTF-8 encoding.
1402 "\\(\e%G[^\e]*\e%@\\)")))
835cbadb
EZ
1403
1404;; Functions to support "Non-Standard Character Set Encodings" defined
6b61353c
KH
1405;; by the COMPOUND-TEXT spec. They also support "The UTF-8 encoding"
1406;; described in the section 7 of the documentation of COMPOUND-TEXT
1407;; distributed with XFree86.
5c88a01e 1408
835cbadb
EZ
1409(defun ctext-post-read-conversion (len)
1410 "Decode LEN characters encoded as Compound Text with Extended Segments."
1894d108
KH
1411 ;; We don't need the following because it is expected that this
1412 ;; function is mainly used for decoding X selection which is not
1413 ;; that big data.
1414 ;;(buffer-disable-undo) ; minimize consing due to insertions and deletions
835cbadb 1415 (save-match-data
cc926903 1416 (save-restriction
1894d108 1417 (narrow-to-region (point) (+ (point) len))
cc926903 1418 (let ((case-fold-search nil)
cc926903
KH
1419 last-coding-system-used
1420 pos bytes)
cc926903 1421 (decode-coding-region (point-min) (point-max) 'ctext)
cc926903
KH
1422 (while (re-search-forward ctext-non-standard-encodings-regexp
1423 nil 'move)
1424 (setq pos (match-beginning 0))
1425 (if (match-beginning 1)
1426 ;; ESC % / [0-4] M L --ENCODING-NAME-- \002 --BYTES--
e0bd7bb9
KH
1427 (let* ((M (multibyte-char-to-unibyte (char-after (+ pos 4))))
1428 (L (multibyte-char-to-unibyte (char-after (+ pos 5))))
cc926903 1429 (encoding (match-string 2))
9857367f 1430 (encoding-info (assoc-string
6b61353c 1431 encoding
c12bc1fb 1432 ctext-non-standard-encodings-alist t))
6b61353c
KH
1433 (coding (if encoding-info
1434 (nth 1 encoding-info)
1435 (setq encoding (intern (downcase encoding)))
1436 (and (coding-system-p encoding)
1437 encoding))))
cc926903
KH
1438 (setq bytes (- (+ (* (- M 128) 128) (- L 128))
1439 (- (point) (+ pos 6))))
1440 (when coding
1441 (delete-region pos (point))
1442 (forward-char bytes)
1443 (decode-coding-region (- (point) bytes) (point) coding)))
1444 ;; ESC % G --UTF-8-BYTES-- ESC % @
6b61353c
KH
1445 (delete-char -3)
1446 (delete-region pos (+ pos 3))
1447 (decode-coding-region pos (point) 'utf-8))))
cc926903
KH
1448 (goto-char (point-min))
1449 (- (point-max) (point)))))
835cbadb 1450
e0bd7bb9
KH
1451;; Return an alist of CHARSET vs CTEXT-USAGE-INFO generated from
1452;; `ctext-non-standard-encodings' and a list specified by the key
1453;; `ctext-non-standard-encodings' for the currrent language
1454;; environment. CTEXT-USAGE-INFO is one of the element of
1455;; `ctext-non-standard-encodings-alist' or nil. In the former case, a
1456;; character in CHARSET is encoded using extended segment. In the
1457;; latter case, a character in CHARSET is encoded using normal ISO2022
1458;; designation sequence. If a character is not in any of CHARSETs, it
1459;; is encoded using UTF-8 encoding extention.
6b61353c
KH
1460
1461(defun ctext-non-standard-encodings-table ()
e0bd7bb9 1462 (let (table)
ff558463
KH
1463 ;; Setup charsets specified by the key
1464 ;; `ctext-non-standard-encodings' for the current language
1465 ;; environment and in `ctext-non-standard-encodings'.
e0bd7bb9 1466 (dolist (encoding (append
6b61353c 1467 (get-language-info current-language-environment
ff558463
KH
1468 'ctext-non-standard-encodings)
1469 ctext-non-standard-encodings))
6b61353c
KH
1470 (let* ((slot (assoc encoding ctext-non-standard-encodings-alist))
1471 (charset (nth 3 slot)))
e0bd7bb9
KH
1472 (if (charsetp charset)
1473 (push (cons charset slot) table)
1474 (dolist (cs charset)
1475 (push (cons cs slot) table)))))
1476
1477 ;; Next prepend charsets for ISO2022 designation sequence.
1478 (dolist (charset charset-list)
1479 (let ((final (plist-get (charset-plist charset) :iso-final-char)))
1480 (if (and (integerp final)
1481 (>= final #x40) (<= final #x7e)
1482 ;; Exclude ascii and chinese-cns11643-X.
1483 (not (eq charset 'ascii))
1484 (not (string-match "cns11643" (symbol-name charset))))
1485 (push (cons charset nil) table))))
ff558463
KH
1486
1487 ;; Returned reversed list so that the charsets specified by the
1488 ;; key `ctext-non-standard-encodings' for the current language
1489 ;; have the highest priority.
1490 (nreverse table)))
835cbadb
EZ
1491
1492(defun ctext-pre-write-conversion (from to)
5dde3c71
EZ
1493 "Encode characters between FROM and TO as Compound Text w/Extended Segments.
1494
1495If FROM is a string, or if the current buffer is not the one set up for us
cc926903 1496by encode-coding-string, generate a new temp buffer, insert the
5dde3c71 1497text, and convert it in the temporary buffer. Otherwise, convert in-place."
835cbadb 1498 (save-match-data
cc926903 1499 ;; Setup a working buffer if necessary.
f1beb0e0
KH
1500 (when (stringp from)
1501 (set-buffer (generate-new-buffer " *temp"))
1502 (set-buffer-multibyte (multibyte-string-p from))
1503 (insert from))
cc926903
KH
1504
1505 ;; Now we can encode the whole buffer.
6b61353c 1506 (let ((encoding-table (ctext-non-standard-encodings-table))
cc926903 1507 last-coding-system-used
6b61353c 1508 last-pos last-encoding-info
e0bd7bb9 1509 encoding-info end-pos ch)
6b61353c
KH
1510 (goto-char (setq last-pos (point-min)))
1511 (setq end-pos (point-marker))
1512 (while (re-search-forward "[^\000-\177]+" nil t)
1513 ;; Found a sequence of non-ASCII characters.
1514 (setq last-pos (match-beginning 0)
e0bd7bb9
KH
1515 ch (char-after last-pos)
1516 last-encoding-info (catch 'tag
1517 (dolist (elt encoding-table)
1518 (if (encode-char ch (car elt))
1519 (throw 'tag (cdr elt))))
1520 'utf-8))
6b61353c
KH
1521 (set-marker end-pos (match-end 0))
1522 (goto-char (1+ last-pos))
1523 (catch 'tag
1524 (while t
1525 (setq encoding-info
1526 (if (< (point) end-pos)
e0bd7bb9
KH
1527 (catch 'tag
1528 (setq ch (following-char))
1529 (dolist (elt encoding-table)
1530 (if (encode-char ch (car elt))
1531 (throw 'tag (cdr elt))))
1532 'utf-8)))
6b61353c
KH
1533 (unless (eq last-encoding-info encoding-info)
1534 (cond ((consp last-encoding-info)
1535 ;; Encode the previous range using an extended
1536 ;; segment.
1537 (let ((encoding-name (car last-encoding-info))
1538 (coding-system (nth 1 last-encoding-info))
1539 (noctets (nth 2 last-encoding-info))
1540 len)
1541 (encode-coding-region last-pos (point) coding-system)
1542 (setq len (+ (length encoding-name) 1
1543 (- (point) last-pos)))
f04781a9 1544 ;; According to the spec of CTEXT, it is not
5503f67d
KH
1545 ;; necessary to produce this extra designation
1546 ;; sequence, but some buggy application
1547 ;; (e.g. crxvt-gb) requires it.
f04781a9 1548 (insert "\e(B")
6b61353c
KH
1549 (save-excursion
1550 (goto-char last-pos)
e0bd7bb9
KH
1551 (insert (format "\e%%/%d" noctets))
1552 (insert-byte (+ (/ len 128) 128) 1)
1553 (insert-byte (+ (% len 128) 128) 1)
ff558463
KH
1554 (insert encoding-name)
1555 (insert 2))))
6b61353c
KH
1556 ((eq last-encoding-info 'utf-8)
1557 ;; Encode the previous range using UTF-8 encoding
1558 ;; extention.
1559 (encode-coding-region last-pos (point) 'mule-utf-8)
1560 (save-excursion
1561 (goto-char last-pos)
1562 (insert "\e%G"))
1563 (insert "\e%@")))
1564 (setq last-pos (point)
1565 last-encoding-info encoding-info))
1566 (if (< (point) end-pos)
1567 (forward-char 1)
1568 (throw 'tag nil)))))
1569 (set-marker end-pos nil)
cc926903 1570 (goto-char (point-min))))
5dde3c71 1571 ;; Must return nil, as build_annotations_2 expects that.
835cbadb
EZ
1572 nil)
1573
4ed46869
KH
1574;;; FILE I/O
1575
e76938e7 1576(defcustom auto-coding-alist
3a6a5981
CY
1577 ;; .exe and .EXE are added to support archive-mode looking at DOS
1578 ;; self-extracting exe archives.
a3862583
SM
1579 '(("\\.\\(\
1580arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|exe\\|rar\\|\
1581ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|EXE\\|RAR\\)\\'" . 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
1642should take one argument, SIZE, which says how many
1643characters (starting from point) it should look at.
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)
c60ee5e7 1662 (case-fold-search (memq system-type '(vax-vms 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
e9b01d1f
KH
1688If a coding system is specifed, the return value is a
1689cons (CODING . SOURCE), where CODING is the specified coding
1690system and SOURCE is a symbol `auto-coding-alist',
1691`auto-coding-regexp-alist', `coding:', or `auto-coding-functions'
1692indicating by what CODING is specified. Note that the validity
382f8b5c 1693of CODING is not checked; it'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
8c453b46
RS
1945operation, or a cons cell (DECODING . ENCODING) specifying the coding systems
1946for decoding and encoding respectively,
1947or a function symbol which, 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)
2049 (decode-coding-region (point-min) (point-max) new-coding)))
f29387e8 2050
b25eef20 2051(defun make-translation-table (&rest args)
a284eea3 2052 "Make a translation table from arguments.
d38b07f9 2053A translation table is a char table intended for character
a284eea3
DL
2054translation in CCL programs.
2055
d38b07f9 2056Each argument is a list of elements of the form (FROM . TO), where FROM
a284eea3 2057is a character to be translated to TO.
13d5617d 2058
4e003d37
KH
2059The arguments and forms in each argument are processed in the given
2060order, and if a previous form already translates TO to some other
2061character, say TO-ALT, FROM is also translated to TO-ALT."
f967223b 2062 (let ((table (make-char-table 'translation-table))
a73a8c89 2063 revlist)
5d75f46f
KH
2064 (dolist (elts args)
2065 (dolist (elt elts)
2066 (let ((from (car elt))
2067 (to (cdr elt))
2068 to-alt rev-from rev-to)
2069 ;; If we have already translated TO to TO-ALT, FROM should
2070 ;; also be translated to TO-ALT.
2071 (if (setq to-alt (aref table to))
2072 (setq to to-alt))
2073 (aset table from to)
2074 ;; If we have already translated some chars to FROM, they
2075 ;; should also be translated to TO.
2076 (when (setq rev-from (assq from revlist))
2077 (dolist (elt (cdr rev-from))
2078 (aset table elt to))
2079 (setq revlist (delq rev-from revlist)
2080 rev-from (cdr rev-from)))
2081 ;; Now update REVLIST.
2082 (setq rev-to (assq to revlist))
2083 (if rev-to
2084 (setcdr rev-to (cons from (cdr rev-to)))
2085 (setq rev-to (list to from)
2086 revlist (cons rev-to revlist)))
2087 (if rev-from
2088 (setcdr rev-to (append rev-from (cdr rev-to)))))))
a73a8c89 2089 ;; Return TABLE just created.
350cd166 2090 (set-char-table-extra-slot table 1 1)
a73a8c89
KH
2091 table))
2092
c76b5c99
KH
2093(defun make-translation-table-from-vector (vec)
2094 "Make translation table from decoding vector VEC.
9e3b6057
DL
2095VEC is an array of 256 elements to map unibyte codes to multibyte
2096characters. Elements may be nil for undefined code points.
c76b5c99
KH
2097See also the variable `nonascii-translation-table'."
2098 (let ((table (make-char-table 'translation-table))
2099 (rev-table (make-char-table 'translation-table))
c76b5c99 2100 ch)
9e3b6057 2101 (dotimes (i 256)
c76b5c99 2102 (setq ch (aref vec i))
9e3b6057
DL
2103 (when ch
2104 (aset table i ch)
2105 (if (>= ch 256)
2106 (aset rev-table ch i))))
c76b5c99 2107 (set-char-table-extra-slot table 0 rev-table)
350cd166
KH
2108 (set-char-table-extra-slot table 1 1)
2109 (set-char-table-extra-slot rev-table 1 1)
c76b5c99
KH
2110 table))
2111
a6d1872e
KH
2112(defun make-translation-table-from-alist (alist)
2113 "Make translation table from N<->M mapping in ALIST.
2114ALIST is an alist, each element has the form (FROM . TO).
2115FROM and TO are a character or a vector of characters.
2116If FROM is a character, that character is translated to TO.
2117If FROM is a vector of characters, that sequence is translated to TO.
350cd166
KH
2118The first extra-slot of the value is a translation table for reverse mapping."
2119 (let ((tables (vector (make-char-table 'translation-table)
2120 (make-char-table 'translation-table)))
2121 table max-lookup from to idx val)
2122 (dotimes (i 2)
2123 (setq table (aref tables i))
2124 (setq max-lookup 1)
2125 (dolist (elt alist)
2126 (if (= i 0)
2127 (setq from (car elt) to (cdr elt))
2128 (setq from (cdr elt) to (car elt)))
2129 (if (characterp from)
2130 (setq idx from)
2131 (setq idx (aref from 0)
2132 max-lookup (max max-lookup (length from))))
2133 (setq val (aref table idx))
2134 (if val
2135 (progn
2136 (or (consp val)
2137 (setq val (list (cons (vector idx) val))))
2138 (if (characterp from)
2139 (setq from (vector from)))
2140 (setq val (nconc val (list (cons from to)))))
2141 (if (characterp from)
2142 (setq val to)
2143 (setq val (list (cons from to)))))
2144 (aset table idx val))
2145 (set-char-table-extra-slot table 1 max-lookup))
2146 (set-char-table-extra-slot (aref tables 0) 0 (aref tables 1))
2147 (aref tables 0)))
a6d1872e 2148
f967223b 2149(defun define-translation-table (symbol &rest args)
a284eea3
DL
2150 "Define SYMBOL as the name of translation table made by ARGS.
2151This sets up information so that the table can be used for
2152translations in a CCL program.
b25eef20 2153
a284eea3
DL
2154If the first element of ARGS is a char-table whose purpose is
2155`translation-table', just define SYMBOL to name it. (Note that this
2156function does not bind SYMBOL.)
007c79c8 2157
a284eea3 2158Any other ARGS should be suitable as arguments of the function
007c79c8 2159`make-translation-table' (which see).
b25eef20 2160
452fdb31 2161This function sets properties `translation-table' and
521d4010
DL
2162`translation-table-id' of SYMBOL to the created table itself and the
2163identification number of the table respectively. It also registers
2164the table in `translation-table-vector'."
007c79c8
KH
2165 (let ((table (if (and (char-table-p (car args))
2166 (eq (char-table-subtype (car args))
2167 'translation-table))
2168 (car args)
2169 (apply 'make-translation-table args)))
f967223b 2170 (len (length translation-table-vector))
d9e3229d 2171 (id 0)
b25eef20 2172 (done nil))
f967223b 2173 (put symbol 'translation-table table)
b25eef20
KH
2174 (while (not done)
2175 (if (>= id len)
f967223b
KH
2176 (setq translation-table-vector
2177 (vconcat translation-table-vector (make-vector len nil))))
2178 (let ((slot (aref translation-table-vector id)))
b25eef20
KH
2179 (if (or (not slot)
2180 (eq (car slot) symbol))
2181 (progn
f967223b 2182 (aset translation-table-vector id (cons symbol table))
007c79c8
KH
2183 (setq done t))
2184 (setq id (1+ id)))))
f967223b 2185 (put symbol 'translation-table-id id)
d9e3229d
KH
2186 id))
2187
16431d3c
KH
2188(defun translate-region (start end table)
2189 "From START to END, translate characters according to TABLE.
2190TABLE is a string or a char-table.
2191If TABLE is a string, the Nth character in it is the mapping
2192for the character with code N.
2193If TABLE is a char-table, the element for character N is the mapping
2194for the character with code N.
2195It returns the number of characters changed."
2196 (interactive
2197 (list (region-beginning)
2198 (region-end)
2199 (let (table l)
2200 (dotimes (i (length translation-table-vector))
2201 (if (consp (aref translation-table-vector i))
2202 (push (list (symbol-name
2203 (car (aref translation-table-vector i)))) l)))
2204 (if (not l)
2205 (error "No translation table defined"))
2206 (while (not table)
2207 (setq table (completing-read "Translation table: " l nil t)))
2208 (intern table))))
2209 (if (symbolp table)
2210 (let ((val (get table 'translation-table)))
2211 (or (char-table-p val)
2212 (error "Invalid translation table name: %s" table))
2213 (setq table val)))
2214 (translate-region-internal start end table))
2215
35554641
KH
2216(put 'with-category-table 'lisp-indent-function 1)
2217
ef6e365d 2218(defmacro with-category-table (table &rest body)
8f924df7 2219 "Execute BODY like `progn' with CATEGORY-TABLE the current category table.
ef6e365d
JPW
2220The category table of the current buffer is saved, BODY is evaluated,
2221then the saved table is restored, even in case of an abnormal exit.
2222Value is what BODY returns."
2223 (let ((old-table (make-symbol "old-table"))
2224 (old-buffer (make-symbol "old-buffer")))
2225 `(let ((,old-table (category-table))
2226 (,old-buffer (current-buffer)))
2227 (unwind-protect
2228 (progn
2229 (set-category-table ,table)
2230 ,@body)
053f45dd 2231 (with-current-buffer ,old-buffer
ef6e365d 2232 (set-category-table ,old-table))))))
35554641 2233
394e4eb0
DL
2234(defun define-translation-hash-table (symbol table)
2235 "Define SYMBOL as the name of the hash translation TABLE for use in CCL.
2236
2237Analogous to `define-translation-table', but updates
2238`translation-hash-table-vector' and the table is for use in the CCL
2239`lookup-integer' and `lookup-character' functions."
2240 (unless (and (symbolp symbol)
2241 (hash-table-p table))
2242 (error "Bad args to define-translation-hash-table"))
2243 (let ((len (length translation-hash-table-vector))
2244 (id 0)
2245 done)
2246 (put symbol 'translation-hash-table table)
2247 (while (not done)
2248 (if (>= id len)
2249 (setq translation-hash-table-vector
2250 (vconcat translation-hash-table-vector [nil])))
2251 (let ((slot (aref translation-hash-table-vector id)))
2252 (if (or (not slot)
2253 (eq (car slot) symbol))
2254 (progn
2255 (aset translation-hash-table-vector id (cons symbol table))
2256 (setq done t))
2257 (setq id (1+ id)))))
2258 (put symbol 'translation-hash-table-id id)
2259 id))
2260
69eba008
KH
2261;;; Initialize some variables.
2262
2263(put 'use-default-ascent 'char-table-extra-slots 0)
2264(setq use-default-ascent (make-char-table 'use-default-ascent))
d6d6d592
KH
2265(put 'ignore-relative-composition 'char-table-extra-slots 0)
2266(setq ignore-relative-composition
2267 (make-char-table 'ignore-relative-composition))
69eba008 2268
256d0fef 2269(make-obsolete 'set-char-table-default
8589dc17 2270 "Generic characters no longer exist" "23.1")
d9f6dfe6
CW
2271
2272;;; Built-in auto-coding-functions:
2273
2274(defun sgml-xml-auto-coding-function (size)
2275 "Determine whether the buffer is XML, and if so, its encoding.
2276This function is intended to be added to `auto-coding-functions'."
c069d3ac
SM
2277 (setq size (+ (point) size))
2278 (when (re-search-forward "\\`[[:space:]\n]*<\\?xml" size t)
d9f6dfe6
CW
2279 (let ((end (save-excursion
2280 ;; This is a hack.
c2c51a11 2281 (re-search-forward "[\"']\\s-*\\?>" size t))))
d9f6dfe6 2282 (when end
c2c51a11 2283 (if (re-search-forward "encoding=[\"']\\(.+?\\)[\"']" end t)
447404a3
CW
2284 (let* ((match (match-string 1))
2285 (sym (intern (downcase match))))
2286 (if (coding-system-p sym)
2287 sym
2288 (message "Warning: unknown coding system \"%s\"" match)
2289 nil))
d9f6dfe6
CW
2290 'utf-8)))))
2291
447404a3
CW
2292(defun sgml-html-meta-auto-coding-function (size)
2293 "If the buffer has an HTML meta tag, use it to determine encoding.
2294This function is intended to be added to `auto-coding-functions'."
df3c9fe7
GM
2295 (let ((case-fold-search t))
2296 (setq size (min (+ (point) size)
2297 (save-excursion
2298 ;; Limit the search by the end of the HTML header.
2299 (or (search-forward "</head>" size t)
2300 ;; In case of no header, search only 10 lines.
2301 (forward-line 10))
2302 (point))))
2303 ;; Make sure that the buffer really contains an HTML document, by
2304 ;; checking that it starts with a doctype or a <HTML> start tag
2305 ;; (allowing for whitespace at bob). Note: 'DOCTYPE NETSCAPE' is
2306 ;; useful for Mozilla bookmark files.
2307 (when (and (re-search-forward "\\`[[:space:]\n]*\\(<!doctype[[:space:]\n]+\\(html\\|netscape\\)\\|<html\\)" size t)
2308 (re-search-forward "<meta\\s-+http-equiv=[\"']?content-type[\"']?\\s-+content=[\"']text/\\sw+;\\s-*charset=\\(.+?\\)[\"']" size t))
2309 (let* ((match (match-string 1))
2310 (sym (intern (downcase match))))
2311 (if (coding-system-p sym)
2312 sym
2313 (message "Warning: unknown coding system \"%s\"" match)
2314 nil)))))
0bca779a 2315
69eba008 2316;;;
4ed46869
KH
2317(provide 'mule)
2318
2850984d 2319;; arch-tag: 9aebaa6e-0e8a-40a9-b857-cb5d04a39e7c
4ed46869 2320;;; mule.el ends here