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