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