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