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