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