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