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