]> code.delx.au - gnu-emacs/blob - lisp/international/mule.el
Merge from emacs--devo--0
[gnu-emacs] / lisp / international / mule.el
1 ;;; mule.el --- basic commands for multilingual environment
2
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
8 ;; Copyright (C) 2003
9 ;; National Institute of Advanced Industrial Science and Technology (AIST)
10 ;; Registration Number H13PRO009
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
27 ;; along with GNU Emacs; see the file COPYING. If not, write to the
28 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
29 ;; Boston, MA 02110-1301, USA.
30
31 ;;; Commentary:
32
33 ;;; Code:
34
35 (defconst mule-version "6.0 (HANACHIRUSATO)" "\
36 Version number and name of this version of MULE (multilingual environment).")
37
38 (defconst mule-version-date "2003.9.1" "\
39 Distribution date of this version of MULE (multilingual environment).")
40
41 \f
42 ;;; CHARSET
43
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
93 (defun define-charset (name docstring &rest props)
94 "Define NAME (symbol) as a charset with DOCSTRING.
95 The remaining arguments must come in pairs ATTRIBUTE VALUE. ATTRIBUTE
96 may be any symbol. The following have special meanings, and one of
97 `:code-offset', `:map', `:subset', `:superset' must be specified.
98
99 `:short-name'
100
101 VALUE must be a short string to identify the charset. If omitted,
102 NAME is used.
103
104 `:long-name'
105
106 VALUE must be a string longer than `:short-name' to identify the
107 charset. If omitted, the value of the `:short-name' attribute is used.
108
109 `:dimension'
110
111 VALUE must be an integer 0, 1, 2, or 3, specifying the dimension of
112 code-points of the charsets. If omitted, it is calculated from the
113 value of the `:code-space' attribute.
114
115 `:code-space'
116
117 VALUE must be a vector of length at most 8 specifying the byte code
118 range of each dimension in this format:
119 [ MIN-1 MAX-1 MIN-2 MAX-2 ... ]
120 where MIN-N is the minimum byte value of Nth dimension of code-point,
121 MAX-N is the maximum byte value of that.
122
123 `:min-code'
124
125 VALUE must be an integer specifying the mininum code point of the
126 charset. If omitted, it is calculated from `:code-space'. VALUE may
127 be a cons (HIGH . LOW), where HIGH is the most significant 16 bits of
128 the code point and LOW is the least significant 16 bits.
129
130 `:max-code'
131
132 VALUE must be an integer specifying the maxinum code point of the
133 charset. If omitted, it is calculated from `:code-space'. VALUE may
134 be a cons (HIGH . LOW), where HIGH is the most significant 16 bits of
135 the code point and LOW is the least significant 16 bits.
136
137 `:iso-final-char'
138
139 VALUE must be a character in the range 32 to 127 (inclusive)
140 specifying the final char of the charset for ISO-2022 encoding. If
141 omitted, the charset can't be encoded by ISO-2022 based
142 coding-systems.
143
144 `:iso-revision-number'
145
146 VALUE must be an integer in the range 0..63, specifying the revision
147 number of the charset for ISO-2022 encoding.
148
149 `:emacs-mule-id'
150
151 VALUE must be an integer of 0, 129..255. If omitted, the charset
152 can't be encoded by coding-systems of type `emacs-mule'.
153
154 `:ascii-compatible-p'
155
156 VALUE must be nil or t (default nil). If VALUE is t, the charset is
157 compatible with ASCII, i.e. the first 128 code points map to ASCII.
158
159 `:supplementary-p'
160
161 VALUE must be nil or t. If the VALUE is t, the charset is
162 supplementary, which means it is used only as a parent of some other
163 charset.
164
165 `:invalid-code'
166
167 VALUE must be a nonnegative integer that can be used as an invalid
168 code point of the charset. If the minimum code is 0 and the maximum
169 code is greater than Emacs' maximum integer value, `:invalid-code'
170 should not be omitted.
171
172 `:code-offset'
173
174 VALUE must be an integer added to the index number of a character to
175 get the corresponding character code.
176
177 `:map'
178
179 VALUE must be vector or string.
180
181 If it is a vector, the format is [ CODE-1 CHAR-1 CODE-2 CHAR-2 ... ],
182 where CODE-n is a code-point of the charset, and CHAR-n is the
183 corresponding character code.
184
185 If it is a string, it is a name of file that contains the above
186 information. Each line of the file must be this format:
187 0xXXX 0xYYY
188 where XXX is a hexadecimal representation of CODE-n and YYY is a
189 hexadecimal representation of CHAR-n. A line starting with `#' is a
190 comment line.
191
192 `:subset'
193
194 VALUE must be a list:
195 ( PARENT MIN-CODE MAX-CODE OFFSET )
196 PARENT is a parent charset. MIN-CODE and MAX-CODE specify the range
197 of characters inherited from the parent. OFFSET is an integer value
198 to add to a code point of the parent charset to get the corresponding
199 code point of this charset.
200
201 `:superset'
202
203 VALUE must be a list of parent charsets. The charset inherits
204 characters 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
206 value to add to a code point of PARENT to get the corresponding code
207 point of this charset.
208
209 `:unify-map'
210
211 VALUE must be vector or string.
212
213 If it is a vector, the format is [ CODE-1 CHAR-1 CODE-2 CHAR-2 ... ],
214 where CODE-n is a code-point of the charset, and CHAR-n is the
215 corresponding Unicode character code.
216
217 If it is a string, it is a name of file that contains the above
218 information. The file format is the same as what described for `:map'
219 attribute."
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))))
228 (let ((attrs (mapcar 'list '(:dimension
229 :code-space
230 :min-code
231 :max-code
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
240 :subset
241 :superset
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
248 (let ((code-space (plist-get props :code-space)))
249 (setq dimension (if code-space (/ (length code-space) 2) 4))
250 (setq props (plist-put props :dimension dimension)))))
251
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
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
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)))
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))
291 (setcdr (assq :plist attrs) props)
292
293 (apply 'define-charset-internal name (mapcar 'cdr attrs))))
294
295
296 (defun load-with-code-conversion (fullname file &optional noerror nomessage)
297 "Execute a file of Lisp code named FILE whose absolute name is FULLNAME.
298 The file contents are decoded before evaluation if necessary.
299 If optional second arg NOERROR is non-nil,
300 report no error if FILE doesn't exist.
301 Print messages at start and end of loading unless
302 optional third arg NOMESSAGE is non-nil.
303 Return 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.
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))
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*"))))
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
327 (push file preloaded-file-list))
328 (unwind-protect
329 (let ((load-file-name fullname)
330 (set-auto-coding-for-load t)
331 (inhibit-file-name-operation nil))
332 (save-excursion
333 (set-buffer buffer)
334 ;; Don't let deactivate-mark remain set.
335 (let (deactivate-mark)
336 (insert-file-contents fullname))
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
342 (or (eq (coding-system-type last-coding-system-used)
343 'raw-text)))
344 (set-buffer-multibyte nil))
345 ;; Make `kill-buffer' quiet.
346 (set-buffer-modified-p nil))
347 ;; Have the original buffer current while we eval.
348 (eval-buffer buffer nil
349 ;; This is compatible with what `load' does.
350 (if purify-flag file fullname)
351 ;; If this Emacs is running with --unibyte,
352 ;; convert multibyte strings to unibyte
353 ;; after reading them.
354 ;; (not default-enable-multibyte-characters)
355 nil t
356 ))
357 (let (kill-buffer-hook kill-buffer-query-functions)
358 (kill-buffer buffer)))
359 (unless purify-flag
360 (do-after-load-evaluation fullname))
361
362 (unless (or nomessage noninteractive)
363 (if source
364 (message "Loading %s (source)...done" file)
365 (message "Loading %s...done" file)))
366 t)))
367
368 (defun charset-info (charset)
369 "Return a vector of information of CHARSET.
370 This function is provided for backward compatibility.
371
372 The 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,
377 PLIST.
378 where
379 CHARSET-ID is always 0.
380 BYTES is always 0.
381 DIMENSION is the number of bytes of a code-point of the charset:
382 1, 2, 3, or 4.
383 CHARS is the number of characters in a dimension:
384 94, 96, 128, or 256.
385 WIDTH is always 0.
386 DIRECTION is always 0.
387 LEADING-CODE-BASE is always 0.
388 LEADING-CODE-EXT is always 0.
389 ISO-FINAL-CHAR (character) is the final character of the
390 corresponding ISO 2022 charset. If the charset is not assigned
391 any final character, the value is -1.
392 ISO-GRAPHIC-PLANE is always 0.
393 REVERSE-CHARSET is always -1.
394 SHORT-NAME (string) is the short name to refer to the charset.
395 LONG-NAME (string) is the long name to refer to the charset
396 DESCRIPTION (string) is the description string of the charset.
397 PLIST (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."
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)))
415
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
420 (defun charset-id (charset)
421 "Always return 0. This is provided for backward compatibility."
422 0)
423
424 (defmacro charset-bytes (charset)
425 "Always return 0. This is provided for backward compatibility."
426 0)
427
428 (defun get-charset-property (charset propname)
429 "Return the value of CHARSET's PROPNAME property.
430 This 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)
435 "Set CHARSETS's PROPNAME property to value VALUE.
436 It can be retrieved with `(get-charset-property CHARSET PROPNAME)'."
437 (set-charset-plist charset
438 (plist-put (charset-plist charset) propname value)))
439
440 (defun charset-description (charset)
441 "Return description string of CHARSET."
442 (plist-get (charset-plist charset) :docstring))
443
444 (defun charset-dimension (charset)
445 "Return dimension of CHARSET."
446 (plist-get (charset-plist charset) :dimension))
447
448 (defun charset-chars (charset &optional dimension)
449 "Return number of characters contained in DIMENSION of CHARSET.
450 DIMENSION defaults to the first dimension."
451 (unless dimension (setq dimension 1))
452 (let ((code-space (plist-get (charset-plist charset) :code-space)))
453 (1+ (- (aref code-space (1- (* 2 dimension)))
454 (aref code-space (- (* 2 dimension) 2))))))
455
456 (defun charset-iso-final-char (charset)
457 "Return ISO-2022 final character of CHARSET.
458 Return -1 if charset isn't an ISO 2022 one."
459 (or (plist-get (charset-plist charset) :iso-final-char)
460 -1))
461
462 (defmacro charset-short-name (charset)
463 "Return short name of CHARSET."
464 (plist-get (charset-plist charset) :short-name))
465
466 (defmacro charset-long-name (charset)
467 "Return long name of CHARSET."
468 (plist-get (charset-plist charset) :long-name))
469
470 (defun charset-list ()
471 "Return list of all charsets ever defined.
472
473 This function is provided for backward compatibility.
474 Now we have the variable `charset-list'."
475 charset-list)
476 (make-obsolete 'charset-list "Use variable `charset-list'" "23.1")
477
478 \f
479 ;;; CHARACTER
480 (defalias 'char-valid-p 'characterp)
481 (make-obsolete 'char-valid-p 'characterp "23.1")
482
483 (defun generic-char-p (char)
484 "Always return nil. This is provided for backward compatibility."
485 nil)
486 (make-obsolete 'generic-char-p "Generic characters no longer exist" "23.1")
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)))
493 \f
494 ;; Coding system stuff
495
496 ;; Coding system is a symbol that has been defined by the function
497 ;; `define-coding-system'.
498
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
514 euc-tw-shift
515 use-roman
516 use-oldjis)
517 "List of symbols that control ISO-2022 encoder/decoder.
518
519 The value of the `:flags' attribute in the argument of the function
520 `define-coding-system' must be one of them.
521
522 If `long-form' is specified, use a long designation sequence on
523 encoding for the charsets `japanese-jisx0208-1978', `chinese-gb2312',
524 and `japanese-jisx0208'. The long designation sequence doesn't
525 conform to ISO 2022, but is used by such coding systems as
526 `compound-text'.
527
528 If `ascii-at-eol' is specified, designate ASCII to g0 at end of line
529 on encoding.
530
531 If `ascii-at-cntl' is specified, designate ASCII to g0 before control
532 codes and SPC on encoding.
533
534 If `7-bit' is specified, use 7-bit code only on encoding.
535
536 If `locking-shift' is specified, decode locking-shift code correctly
537 on decoding, and use locking-shift to invoke a graphic element on
538 encoding.
539
540 If `single-shift' is specified, decode single-shift code correctly on
541 decoding, and use single-shift to invoke a graphic element on encoding.
542
543 If `designation' is specified, decode designation code correctly on
544 decoding, and use designation to designate a charset to a graphic
545 element on encoding.
546
547 If `revision' is specified, produce an escape sequence to specify
548 revision number of a charset on encoding. Such an escape sequence is
549 always correctly decoded on decoding.
550
551 If `direction' is specified, decode ISO6429's code for specifying
552 direction correctly, and produce the code on encoding.
553
554 If `init-at-bol' is specified, on encoding, it is assumed that
555 invocation and designation statuses are reset at each beginning of
556 line even if `ascii-at-eol' is not specified; thus no codes for
557 resetting them are produced.
558
559 If `safe' is specified, on encoding, characters not supported by a
560 coding are replaced with `?'.
561
562 If `latin-extra' is specified, the code-detection routine assumes that a
563 code specified in `latin-extra-code-table' (which see) is valid.
564
565 If `composition' is specified, an escape sequence to specify
566 composition sequence is correctly decoded on decoding, and is produced
567 on encoding.
568
569 If `euc-tw-shift' is specified, the EUC-TW specific shifting code is
570 correctly decoded on decoding, and is produced on encoding.
571
572 If `use-roman' is specified, JIS0201-1976-Roman is designated instead
573 of ASCII.
574
575 If `use-oldjis' is specified, JIS0208-1976 is designated instead of
576 JIS0208-1983.")
577
578 (defun define-coding-system (name docstring &rest props)
579 "Define NAME (a symbol) as a coding system with DOCSTRING and attributes.
580 The remaining arguments must come in pairs ATTRIBUTE VALUE. ATTRIBUTE
581 may be any symbol.
582
583 The following attributes have special meanings. Those labeled as
584 \"(required)\", should not be omitted.
585
586 `:mnemonic' (required)
587
588 VALUE is a character to display on mode line for the coding system.
589
590 `:coding-type' (required)
591
592 VALUE must be one of `charset', `utf-8', `utf-16', `iso-2022',
593 `emacs-mule', `shift-jis', `ccl', `raw-text', `undecided'.
594
595 `:eol-type'
596
597 VALUE is the EOL (end-of-line) format of the coding system. It must be
598 one 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),
600 and `mac' means MAC-like EOL \(i.e. single CR). If omitted, on
601 decoding by the coding system, Emacs automatically detects the EOL
602 format of the source text.
603
604 `:charset-list'
605
606 VALUE must be a list of charsets supported by the coding system. On
607 encoding by the coding system, if a character belongs to multiple
608 charsets in the list, a charset that comes earlier in the list is
609 selected. If `:coding-type' is `iso-2022', VALUE may be `iso-2022',
610 which indicates that the coding system supports all ISO-2022 based
611 charsets. If `:coding-type' is `emacs-mule', VALUE may be
612 `emacs-mule', which indicates that the coding system supports all
613 charsets that have the `:emacs-mule-id' property.
614
615 `:ascii-compatible-p'
616
617 If VALUE is non-nil, the coding system decodes all 7-bit bytes into
618 the corresponding ASCII characters, and encodes all ASCII characters
619 back to the corresponding 7-bit bytes. VALUE defaults to nil.
620
621 `:decode-translation-table'
622
623 VALUE must be a translation table to use on decoding.
624
625 `:encode-translation-table'
626
627 VALUE must be a translation table to use on encoding.
628
629 `:post-read-conversion'
630
631 VALUE must be a function to call after some text is inserted and
632 decoded by the coding system itself and before any functions in
633 `after-insert-functions' are called. The arguments to this function
634 are the same as those of a function in `after-insert-file-functions',
635 i.e. LENGTH of the text to be decoded with point at the head of it,
636 and the function should leave point unchanged.
637
638 `:pre-write-conversion'
639
640 VALUE must be a function to call after all functions in
641 `write-region-annotate-functions' and `buffer-file-format' are called,
642 and before the text is encoded by the coding system itself. The
643 arguments to this function are the same as those of a function in
644 `write-region-annotate-functions'.
645
646 `:default-char'
647
648 VALUE must be a character. On encoding, a character not supported by
649 the coding system is replaced with VALUE.
650
651 `:for-unibyte'
652
653 VALUE non-nil means that visiting a file with the coding system
654 results in a unibyte buffer.
655
656 `:eol-type'
657
658 VALUE must be `unix', `dos', `mac'. The symbol `unix' means Unix-like
659 EOL (LF), `dos' means DOS-like EOL (CRLF), and `mac' means MAC-like
660 EOL (CR). If omitted, on decoding, the coding system detects EOL
661 format automatically, and on encoding, uses Unix-like EOL.
662
663 `:mime-charset'
664
665 VALUE must be a symbol whose name is that of a MIME charset converted
666 to lower case.
667
668 `:mime-text-unsuitable'
669
670 VALUE non-nil means the `:mime-charset' property names a charset which
671 is unsuitable for the top-level media type \"text\".
672
673 `:flags'
674
675 VALUE must be a list of symbols that control the ISO-2022 converter.
676 Each must be a member of the list `coding-system-iso-2022-flags'
677 \(which see). This attribute has a meaning only when `:coding-type'
678 is `iso-2022'.
679
680 `:designation'
681
682 VALUE must be a vector [G0-USAGE G1-USAGE G2-USAGE G3-USAGE].
683 GN-USAGE specifies the usage of graphic register GN as follows.
684
685 If it is nil, no charset can be designated to GN.
686
687 If it is a charset, the charset is initially designated to GN, and
688 never used by the other charsets.
689
690 If it is a list, the elements must be charsets, nil, 94, or 96. GN
691 can be used by all the listed charsets. If the list contains 94, any
692 iso-2022 charset whose code-space ranges are 94 long can be designated
693 to GN. If the list contains 96, any charsets whose whose ranges are
694 96 long can be designated to GN. If the first element is a charset,
695 that charset is initially designated to GN.
696
697 This attribute has a meaning only when `:coding-type' is `iso-2022'.
698
699 `:bom'
700
701 This attributes specifies whether the coding system uses a `byte order
702 mark'. VALUE must nil, t, or cons of coding systems whose
703 `:coding-type' is `utf-16'.
704
705 If the value is nil, on decoding, don't treat the first two-byte as
706 BOM, and on encoding, don't produce BOM bytes.
707
708 If the value is t, on decoding, skip the first two-byte as BOM, and on
709 encoding, produce BOM bytes accoding to the value of `:endian'.
710
711 If the value is cons, on decoding, check the first two-byte. If theyq
712 are 0xFE 0xFF, use the car part coding system of the value. If they
713 are 0xFF 0xFE, use the car part coding system of the value.
714 Otherwise, treat them as bytes for a normal character. On encoding,
715 produce BOM bytes accoding to the value of `:endian'.
716
717 This attribute has a meaning only when `:coding-type' is `utf-16'.
718
719 `:endian'
720
721 VALUE must be `big' or `little' specifying big-endian and
722 little-endian respectively. The default value is `big'.
723
724 This attribute has a meaning only when `:coding-type' is `utf-16'.
725
726 `:ccl-decoder'
727
728 VALUE is a symbol representing the registered CCL program used for
729 decoding. This attribute has a meaning only when `:coding-type' is
730 `ccl'.
731
732 `:ccl-encoder'
733
734 VALUE is a symbol representing the registered CCL program used for
735 encoding. This attribute has a meaning only when `:coding-type' is
736 `ccl'."
737 (let* ((common-attrs (mapcar 'list
738 '(:mnemonic
739 :coding-type
740 :charset-list
741 :ascii-compatible-p
742 :decode-translation-table
743 :encode-translation-table
744 :post-read-conversion
745 :pre-write-conversion
746 :default-char
747 :for-unibyte
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
811 (cons :name (cons name (cons :docstring (cons (purecopy docstring)
812 props)))))
813 (setcdr (assq :plist common-attrs) props)
814 (apply 'define-coding-system-internal
815 name (mapcar 'cdr (append common-attrs spec-attrs)))))
816
817 (defun coding-system-doc-string (coding-system)
818 "Return the documentation string for CODING-SYSTEM."
819 (plist-get (coding-system-plist coding-system) :docstring))
820
821 (defun coding-system-mnemonic (coding-system)
822 "Return the mnemonic character of CODING-SYSTEM.
823 The mnemonic character of a coding system is used in mode line to
824 indicate the coding system. If CODING-SYSTEM. is nil, return ?=."
825 (plist-get (coding-system-plist coding-system) :mnemonic))
826
827 (defun coding-system-type (coding-system)
828 "Return the coding type of CODING-SYSTEM.
829 A coding type is a symbol indicating the encoding method of CODING-SYSTEM.
830 See the function `define-coding-system' for more detail."
831 (plist-get (coding-system-plist coding-system) :coding-type))
832
833 (defun coding-system-charset-list (coding-system)
834 "Return list of charsets supported by CODING-SYSTEM.
835 If CODING-SYSTEM supports all ISO-2022 charsets, return `iso-2022'.
836 If CODING-SYSTEM supports all emacs-mule charsets, return `emacs-mule'."
837 (plist-get (coding-system-plist coding-system) :charset-list))
838
839 (defun coding-system-category (coding-system)
840 "Return a category symbol of CODING-SYSTEM."
841 (plist-get (coding-system-plist coding-system) :category))
842
843 (defun coding-system-get (coding-system prop)
844 "Extract a value from CODING-SYSTEM's property list for property PROP.
845 For compatibility with Emacs 20/21, this accepts old-style symbols
846 like `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))
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))))))))
855
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))
859 (val (cond ((eq eol-type 0) eol-mnemonic-unix)
860 ((eq eol-type 1) eol-mnemonic-dos)
861 ((eq eol-type 2) eol-mnemonic-mac)
862 (t eol-mnemonic-undecided))))
863 (if (stringp val)
864 val
865 (char-to-string val))))
866
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
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.
882 Two coding systems are identical if two symbols are equal
883 or one is an alias of the other."
884 (or (eq coding-system-1 coding-system-2)
885 (and (equal (coding-system-plist coding-system-1)
886 (coding-system-plist coding-system-2))
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
892 (defun add-to-coding-system-list (coding-system)
893 "Add CODING-SYSTEM to `coding-system-list' while keeping it sorted."
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
907 (defun coding-system-list (&optional base-only)
908 "Return a list of all existing non-subsidiary coding systems.
909 If optional arg BASE-ONLY is non-nil, only base coding systems are
910 listed. The value doesn't include subsidiary coding systems which are
911 made from bases and aliases automatically for various end-of-line
912 formats (e.g. iso-latin-1-unix, koi8-r-dos)."
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)))
919 (aliases (coding-system-aliases coding)))
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
929 (defconst char-coding-system-table nil
930 "This is an obsolete variable.
931 It exists just for backward compatibility, and the value is always nil.")
932
933 (defun transform-make-coding-system-args (name type &optional doc-string props)
934 "For internal use only.
935 Transform XEmacs style args for `make-coding-system' to Emacs style.
936 Value 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
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))
1006 ((eq type 'ccl)
1007 `(,name 4 ,mnemonic ,doc-string
1008 (,(plist-get props 'decode) . ,(plist-get props 'encode))
1009 ,properties ,eol-type))
1010 (t
1011 (error "unsupported XEmacs style make-coding-style arguments: %S"
1012 `(,name ,type ,doc-string ,props))))))
1013
1014 (defun make-coding-system (coding-system type mnemonic doc-string
1015 &optional
1016 flags
1017 properties
1018 eol-type)
1019 "Define a new coding system CODING-SYSTEM (symbol).
1020 This function is provided for backward compatibility.
1021 Use `define-coding-system' instead."
1022 ;; For compatiblity with XEmacs, we check the type of TYPE. If it
1023 ;; is a symbol, perhaps, this function is called with XEmacs-style
1024 ;; arguments. Here, try to transform that kind of arguments to
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)
1030 type (nth 1 args)
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
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)
1044 (t
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))
1067 (setq properties (plist-put properties :mnemonic mnemonic))
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))
1113
1114 (defun merge-coding-systems (first second)
1115 "Fill in any unspecified aspects of coding system FIRST from SECOND.
1116 Return 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
1129 (defun autoload-coding-system (symbol form)
1130 "Define SYMBOL as a coding-system that is defined on demand.
1131
1132 FROM is a form to evaluate to define the coding-system."
1133 (put symbol 'coding-system-define-form form)
1134 (setq coding-system-alist (cons (list (symbol-name symbol))
1135 coding-system-alist))
1136 (dolist (elt '("-unix" "-dos" "-mac"))
1137 (let ((name (concat (symbol-name symbol) elt)))
1138 (put (intern name) 'coding-system-define-form form)
1139 (setq coding-system-alist (cons (list name) coding-system-alist)))))
1140
1141 (defun set-buffer-file-coding-system (coding-system &optional force nomodify)
1142 "Set the file coding-system of the current buffer to CODING-SYSTEM.
1143 This means that when you save the buffer, it will be converted
1144 according to CODING-SYSTEM. For a list of possible values of CODING-SYSTEM,
1145 use \\[list-coding-systems].
1146
1147 If CODING-SYSTEM leaves the text conversion unspecified, or if it
1148 leaves the end-of-line conversion unspecified, FORCE controls what to
1149 do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1150 buffer's previous `buffer-file-coding-system' value (if it is
1151 specified there). Otherwise, leave it unspecified.
1152
1153 This marks the buffer modified so that the succeeding \\[save-buffer]
1154 surely saves the buffer with CODING-SYSTEM. From a program, if you
1155 don't want to mark the buffer modified, specify t for NOMODIFY.
1156 If you know exactly what coding system you want to use,
1157 just set the variable `buffer-file-coding-system' directly."
1158 (interactive "zCoding system for saving file (default nil): \nP")
1159 (check-coding-system coding-system)
1160 (if (and coding-system buffer-file-coding-system (null force))
1161 (setq coding-system
1162 (merge-coding-systems coding-system buffer-file-coding-system)))
1163 (setq buffer-file-coding-system coding-system)
1164 ;; This is in case of an explicit call. Normally, `normal-mode' and
1165 ;; `set-buffer-major-mode-hook' take care of setting the table.
1166 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1167 (ucs-set-table-for-input))
1168 (unless nomodify
1169 (set-buffer-modified-p t))
1170 (force-mode-line-update))
1171
1172 (defun revert-buffer-with-coding-system (coding-system &optional force)
1173 "Visit the current buffer's file again using coding system CODING-SYSTEM.
1174 For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1175
1176 If CODING-SYSTEM leaves the text conversion unspecified, or if it
1177 leaves the end-of-line conversion unspecified, FORCE controls what to
1178 do. If FORCE is nil, get the unspecified aspect (or aspects) from the
1179 buffer's previous `buffer-file-coding-system' value (if it is
1180 specified there). Otherwise, determine it from the file contents as
1181 usual for visiting a file."
1182 (interactive "zCoding system for visited file (default nil): \nP")
1183 (check-coding-system coding-system)
1184 (if (and coding-system buffer-file-coding-system (null force))
1185 (setq coding-system
1186 (merge-coding-systems coding-system buffer-file-coding-system)))
1187 (let ((coding-system-for-read coding-system))
1188 (revert-buffer)))
1189
1190 (defun set-file-name-coding-system (coding-system)
1191 "Set coding system for decoding and encoding file names to CODING-SYSTEM.
1192 It actually just set the variable `file-name-coding-system' (which
1193 see) to CODING-SYSTEM."
1194 (interactive "zCoding system for file names (default nil): ")
1195 (check-coding-system coding-system)
1196 (if (and coding-system
1197 (not (coding-system-get coding-system :ascii-compatible-p))
1198 (not (coding-system-get coding-system :suitable-for-file-name)))
1199 (error "%s is not suitable for file names" coding-system))
1200 (setq file-name-coding-system coding-system))
1201
1202 (defvar default-terminal-coding-system nil
1203 "Default value for the terminal coding system.
1204 This is normally set according to the selected language environment.
1205 See also the command `set-terminal-coding-system'.")
1206
1207 (defun set-terminal-coding-system (coding-system)
1208 "Set coding system of your terminal to CODING-SYSTEM.
1209 All text output to the terminal will be encoded
1210 with the specified coding system.
1211 For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1212 The default is determined by the selected language environment
1213 or by the previous use of this command."
1214 (interactive
1215 (list (let ((default (if (and (not (terminal-coding-system))
1216 default-terminal-coding-system)
1217 default-terminal-coding-system)))
1218 (read-coding-system
1219 (format "Coding system for terminal display (default %s): "
1220 default)
1221 default))))
1222 (if (and (not coding-system)
1223 (not (terminal-coding-system)))
1224 (setq coding-system default-terminal-coding-system))
1225 (if coding-system
1226 (setq default-terminal-coding-system coding-system))
1227 (set-terminal-coding-system-internal coding-system)
1228 (redraw-frame (selected-frame)))
1229
1230 (defvar default-keyboard-coding-system nil
1231 "Default value of the keyboard coding system.
1232 This is normally set according to the selected language environment.
1233 See also the command `set-keyboard-coding-system'.")
1234
1235 (defun set-keyboard-coding-system (coding-system)
1236 "Set coding system for keyboard input to CODING-SYSTEM.
1237 In addition, this command enables Encoded-kbd minor mode.
1238 \(If CODING-SYSTEM is nil, Encoded-kbd mode is turned off -- see
1239 `encoded-kbd-mode'.)
1240 For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems].
1241 The default is determined by the selected language environment
1242 or by the previous use of this command."
1243 (interactive
1244 (list (let ((default (if (and (not (keyboard-coding-system))
1245 default-keyboard-coding-system)
1246 default-keyboard-coding-system)))
1247 (read-coding-system
1248 (format "Coding system for keyboard input (default %s): "
1249 default)
1250 default))))
1251 (if (and (not coding-system)
1252 (not (keyboard-coding-system)))
1253 (setq coding-system default-keyboard-coding-system))
1254 (if coding-system
1255 (setq default-keyboard-coding-system coding-system))
1256 (if (and coding-system
1257 (not (coding-system-get coding-system :ascii-compatible-p))
1258 (not (coding-system-get coding-system :suitable-for-keyboard)))
1259 (error "%s is not suitable for keyboard" coding-system))
1260 (set-keyboard-coding-system-internal coding-system)
1261 (setq keyboard-coding-system coding-system)
1262 (encoded-kbd-mode (if coding-system 1 0)))
1263
1264 (defcustom keyboard-coding-system nil
1265 "Specify coding system for keyboard input.
1266 If you set this on a terminal which can't distinguish Meta keys from
1267 8-bit characters, you will have to use ESC to type Meta characters.
1268 See Info node `Terminal Coding' and Info node `Unibyte Mode'.
1269
1270 On non-windowing terminals, this is set from the locale by default.
1271
1272 Setting this variable directly does not take effect;
1273 use either \\[customize] or \\[set-keyboard-coding-system]."
1274 :type '(coding-system :tag "Coding system")
1275 :link '(info-link "(emacs)Terminal Coding")
1276 :link '(info-link "(emacs)Unibyte Mode")
1277 :set (lambda (symbol value)
1278 ;; Don't load encoded-kbd-mode unnecessarily.
1279 (if (or value (boundp 'encoded-kbd-mode))
1280 (set-keyboard-coding-system value)
1281 (set-default 'keyboard-coding-system nil))) ; must initialize
1282 :version "22.1"
1283 :group 'keyboard
1284 :group 'mule)
1285
1286 (defun set-buffer-process-coding-system (decoding encoding)
1287 "Set coding systems for the process associated with the current buffer.
1288 DECODING is the coding system to be used to decode input from the process,
1289 ENCODING is the coding system to be used to encode output to the process.
1290
1291 For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
1292 (interactive
1293 "zCoding-system for output from the process: \nzCoding-system for input to the process: ")
1294 (let ((proc (get-buffer-process (current-buffer))))
1295 (if (null proc)
1296 (error "No process")
1297 (check-coding-system decoding)
1298 (check-coding-system encoding)
1299 (set-process-coding-system proc decoding encoding)))
1300 (force-mode-line-update))
1301
1302 (defalias 'set-clipboard-coding-system 'set-selection-coding-system)
1303
1304 (defun set-selection-coding-system (coding-system)
1305 "Make CODING-SYSTEM used for communicating with other X clients.
1306 When sending or receiving text via cut_buffer, selection, and clipboard,
1307 the text is encoded or decoded by CODING-SYSTEM."
1308 (interactive "zCoding system for X selection: ")
1309 (check-coding-system coding-system)
1310 (setq selection-coding-system coding-system))
1311
1312 ;; Coding system lastly specified by the command
1313 ;; set-next-selection-coding-system.
1314 (defvar last-next-selection-coding-system nil)
1315
1316 (defun set-next-selection-coding-system (coding-system)
1317 "Use CODING-SYSTEM for next communication with other window system clients.
1318 This setting is effective for the next communication only."
1319 (interactive
1320 (list (read-coding-system
1321 (if last-next-selection-coding-system
1322 (format "Coding system for the next selection (default %S): "
1323 last-next-selection-coding-system)
1324 "Coding system for the next selection: ")
1325 last-next-selection-coding-system)))
1326 (if coding-system
1327 (setq last-next-selection-coding-system coding-system)
1328 (setq coding-system last-next-selection-coding-system))
1329 (check-coding-system coding-system)
1330
1331 (setq next-selection-coding-system coding-system))
1332
1333 (defun set-coding-priority (arg)
1334 "Set priority of coding categories according to ARG.
1335 ARG is a list of coding categories ordered by priority.
1336
1337 This function is provided for backward compatibility.
1338 Now we have more convenient function `set-coding-system-priority'."
1339 (apply 'set-coding-system-priority
1340 (mapcar #'(lambda (x) (symbol-value x)) arg)))
1341 (make-obsolete 'set-coding-priority 'set-coding-system-priority "23.1")
1342
1343 ;;; X selections
1344
1345 (defvar ctext-non-standard-encodings-alist
1346 '(("big5-0" big5 2 big5)
1347 ("ISO8859-14" iso-8859-14 1 latin-iso8859-14)
1348 ("ISO8859-15" iso-8859-15 1 latin-iso8859-15)
1349 ("gbk-0" gbk 2 chinese-gbk))
1350 "Alist of non-standard encoding names vs the corresponding usages in CTEXT.
1351
1352 It controls how extended segments of a compound text are handled
1353 by the coding system `compound-text-with-extensions'.
1354
1355 Each element has the form (ENCODING-NAME CODING-SYSTEM N-OCTET CHARSET).
1356
1357 ENCODING-NAME is an encoding name of an \"extended segments\".
1358
1359 CODING-SYSTEM is the coding-system to encode (or decode) the
1360 characters into (or from) the extended segment.
1361
1362 N-OCTET is the number of octets (bytes) that encodes a character
1363 in the segment. It can be 0 (meaning the number of octets per
1364 character is variable), 1, 2, 3, or 4.
1365
1366 CHARSET is a charater set containing characters that are encoded
1367 in the segment. It can be a list of character sets.
1368
1369 On decoding CTEXT, all encoding names listed here are recognized.
1370
1371 On encoding CTEXT, encoding names in the variable
1372 `ctext-non-standard-encodings' (which see) and in the information
1373 listed for the current language environment under the key
1374 `ctext-non-standard-encodings' are used.")
1375
1376 (defvar ctext-non-standard-encodings nil
1377 "List of non-standard encoding names used in extended segments of CTEXT.
1378 Each element must be one of the names listed in the variable
1379 `ctext-non-standard-encodings-alist' (which see).")
1380
1381 (defvar ctext-non-standard-encodings-regexp
1382 (string-to-multibyte
1383 (concat
1384 ;; For non-standard encodings.
1385 "\\(\e%/[0-4][\200-\377][\200-\377]\\([^\002]+\\)\002\\)"
1386 "\\|"
1387 ;; For UTF-8 encoding.
1388 "\\(\e%G[^\e]*\e%@\\)")))
1389
1390 ;; Functions to support "Non-Standard Character Set Encodings" defined
1391 ;; by the COMPOUND-TEXT spec. They also support "The UTF-8 encoding"
1392 ;; described in the section 7 of the documentation of COMPOUND-TEXT
1393 ;; distributed with XFree86.
1394
1395 (defun ctext-post-read-conversion (len)
1396 "Decode LEN characters encoded as Compound Text with Extended Segments."
1397 ;; We don't need the following because it is expected that this
1398 ;; function is mainly used for decoding X selection which is not
1399 ;; that big data.
1400 ;;(buffer-disable-undo) ; minimize consing due to insertions and deletions
1401 (save-match-data
1402 (save-restriction
1403 (narrow-to-region (point) (+ (point) len))
1404 (let ((case-fold-search nil)
1405 last-coding-system-used
1406 pos bytes)
1407 (decode-coding-region (point-min) (point-max) 'ctext)
1408 (while (re-search-forward ctext-non-standard-encodings-regexp
1409 nil 'move)
1410 (setq pos (match-beginning 0))
1411 (if (match-beginning 1)
1412 ;; ESC % / [0-4] M L --ENCODING-NAME-- \002 --BYTES--
1413 (let* ((M (multibyte-char-to-unibyte (char-after (+ pos 4))))
1414 (L (multibyte-char-to-unibyte (char-after (+ pos 5))))
1415 (encoding (match-string 2))
1416 (encoding-info (assoc-string
1417 encoding
1418 ctext-non-standard-encodings-alist t))
1419 (coding (if encoding-info
1420 (nth 1 encoding-info)
1421 (setq encoding (intern (downcase encoding)))
1422 (and (coding-system-p encoding)
1423 encoding))))
1424 (setq bytes (- (+ (* (- M 128) 128) (- L 128))
1425 (- (point) (+ pos 6))))
1426 (when coding
1427 (delete-region pos (point))
1428 (forward-char bytes)
1429 (decode-coding-region (- (point) bytes) (point) coding)))
1430 ;; ESC % G --UTF-8-BYTES-- ESC % @
1431 (delete-char -3)
1432 (delete-region pos (+ pos 3))
1433 (decode-coding-region pos (point) 'utf-8))))
1434 (goto-char (point-min))
1435 (- (point-max) (point)))))
1436
1437 ;; Return an alist of CHARSET vs CTEXT-USAGE-INFO generated from
1438 ;; `ctext-non-standard-encodings' and a list specified by the key
1439 ;; `ctext-non-standard-encodings' for the currrent language
1440 ;; environment. CTEXT-USAGE-INFO is one of the element of
1441 ;; `ctext-non-standard-encodings-alist' or nil. In the former case, a
1442 ;; character in CHARSET is encoded using extended segment. In the
1443 ;; latter case, a character in CHARSET is encoded using normal ISO2022
1444 ;; designation sequence. If a character is not in any of CHARSETs, it
1445 ;; is encoded using UTF-8 encoding extention.
1446
1447 (defun ctext-non-standard-encodings-table ()
1448 (let (table)
1449 ;; Setup charsets specified by the key
1450 ;; `ctext-non-standard-encodings' for the current language
1451 ;; environment and in `ctext-non-standard-encodings'.
1452 (dolist (encoding (append
1453 (get-language-info current-language-environment
1454 'ctext-non-standard-encodings)
1455 ctext-non-standard-encodings))
1456 (let* ((slot (assoc encoding ctext-non-standard-encodings-alist))
1457 (charset (nth 3 slot)))
1458 (if (charsetp charset)
1459 (push (cons charset slot) table)
1460 (dolist (cs charset)
1461 (push (cons cs slot) table)))))
1462
1463 ;; Next prepend charsets for ISO2022 designation sequence.
1464 (dolist (charset charset-list)
1465 (let ((final (plist-get (charset-plist charset) :iso-final-char)))
1466 (if (and (integerp final)
1467 (>= final #x40) (<= final #x7e)
1468 ;; Exclude ascii and chinese-cns11643-X.
1469 (not (eq charset 'ascii))
1470 (not (string-match "cns11643" (symbol-name charset))))
1471 (push (cons charset nil) table))))
1472
1473 ;; Returned reversed list so that the charsets specified by the
1474 ;; key `ctext-non-standard-encodings' for the current language
1475 ;; have the highest priority.
1476 (nreverse table)))
1477
1478 (defun ctext-pre-write-conversion (from to)
1479 "Encode characters between FROM and TO as Compound Text w/Extended Segments.
1480
1481 If FROM is a string, or if the current buffer is not the one set up for us
1482 by encode-coding-string, generate a new temp buffer, insert the
1483 text, and convert it in the temporary buffer. Otherwise, convert in-place."
1484 (save-match-data
1485 ;; Setup a working buffer if necessary.
1486 (when (stringp from)
1487 (set-buffer (generate-new-buffer " *temp"))
1488 (set-buffer-multibyte (multibyte-string-p from))
1489 (insert from))
1490
1491 ;; Now we can encode the whole buffer.
1492 (let ((encoding-table (ctext-non-standard-encodings-table))
1493 last-coding-system-used
1494 last-pos last-encoding-info
1495 encoding-info end-pos ch)
1496 (goto-char (setq last-pos (point-min)))
1497 (setq end-pos (point-marker))
1498 (while (re-search-forward "[^\000-\177]+" nil t)
1499 ;; Found a sequence of non-ASCII characters.
1500 (setq last-pos (match-beginning 0)
1501 ch (char-after last-pos)
1502 last-encoding-info (catch 'tag
1503 (dolist (elt encoding-table)
1504 (if (encode-char ch (car elt))
1505 (throw 'tag (cdr elt))))
1506 'utf-8))
1507 (set-marker end-pos (match-end 0))
1508 (goto-char (1+ last-pos))
1509 (catch 'tag
1510 (while t
1511 (setq encoding-info
1512 (if (< (point) end-pos)
1513 (catch 'tag
1514 (setq ch (following-char))
1515 (dolist (elt encoding-table)
1516 (if (encode-char ch (car elt))
1517 (throw 'tag (cdr elt))))
1518 'utf-8)))
1519 (unless (eq last-encoding-info encoding-info)
1520 (cond ((consp last-encoding-info)
1521 ;; Encode the previous range using an extended
1522 ;; segment.
1523 (let ((encoding-name (car last-encoding-info))
1524 (coding-system (nth 1 last-encoding-info))
1525 (noctets (nth 2 last-encoding-info))
1526 len)
1527 (encode-coding-region last-pos (point) coding-system)
1528 (setq len (+ (length encoding-name) 1
1529 (- (point) last-pos)))
1530 ;; According to the spec of CTEXT, it is not
1531 ;; necessary to produce this extra designation
1532 ;; sequence, but some buggy application
1533 ;; (e.g. crxvt-gb) requires it.
1534 (insert "\e(B")
1535 (save-excursion
1536 (goto-char last-pos)
1537 (insert (format "\e%%/%d" noctets))
1538 (insert-byte (+ (/ len 128) 128) 1)
1539 (insert-byte (+ (% len 128) 128) 1)
1540 (insert encoding-name)
1541 (insert 2))))
1542 ((eq last-encoding-info 'utf-8)
1543 ;; Encode the previous range using UTF-8 encoding
1544 ;; extention.
1545 (encode-coding-region last-pos (point) 'mule-utf-8)
1546 (save-excursion
1547 (goto-char last-pos)
1548 (insert "\e%G"))
1549 (insert "\e%@")))
1550 (setq last-pos (point)
1551 last-encoding-info encoding-info))
1552 (if (< (point) end-pos)
1553 (forward-char 1)
1554 (throw 'tag nil)))))
1555 (set-marker end-pos nil)
1556 (goto-char (point-min))))
1557 ;; Must return nil, as build_annotations_2 expects that.
1558 nil)
1559
1560 ;;; FILE I/O
1561
1562 (defcustom auto-coding-alist
1563 '(("\\.\\(arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\)\\'" . no-conversion)
1564 ("\\.\\(ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . no-conversion)
1565 ("\\.\\(sx[dmicw]\\|odt\\|tar\\|tgz\\)\\'" . no-conversion)
1566 ("\\.\\(gz\\|Z\\|bz\\|bz2\\|gpg\\)\\'" . no-conversion)
1567 ("\\.\\(jpe?g\\|png\\|gif\\|tiff?\\|p[bpgn]m\\)\\'" . no-conversion)
1568 ("/#[^/]+#\\'" . emacs-mule))
1569 "Alist of filename patterns vs corresponding coding systems.
1570 Each element looks like (REGEXP . CODING-SYSTEM).
1571 A file whose name matches REGEXP is decoded by CODING-SYSTEM on reading.
1572
1573 The settings in this alist take priority over `coding:' tags
1574 in the file (see the function `set-auto-coding')
1575 and the contents of `file-coding-system-alist'."
1576 :group 'files
1577 :group 'mule
1578 :type '(repeat (cons (regexp :tag "File name regexp")
1579 (symbol :tag "Coding system"))))
1580
1581 (defcustom auto-coding-regexp-alist
1582 '(("^BABYL OPTIONS:[ \t]*-\\*-[ \t]*rmail[ \t]*-\\*-" . no-conversion)
1583 ("\\`\xFE\xFF" . utf-16be-with-signature)
1584 ("\\`\xFF\xFE" . utf-16le-with-signature)
1585 ("\\`\xEF\xBB\xBF" . utf-8)
1586 ("\\`;ELC\024\0\0\0" . emacs-mule)) ; Emacs 20-compiled
1587 "Alist of patterns vs corresponding coding systems.
1588 Each element looks like (REGEXP . CODING-SYSTEM).
1589 A file whose first bytes match REGEXP is decoded by CODING-SYSTEM on reading.
1590
1591 The settings in this alist take priority over `coding:' tags
1592 in the file (see the function `set-auto-coding')
1593 and the contents of `file-coding-system-alist'."
1594 :group 'files
1595 :group 'mule
1596 :type '(repeat (cons (regexp :tag "Regexp")
1597 (symbol :tag "Coding system"))))
1598
1599 (defun auto-coding-regexp-alist-lookup (from to)
1600 "Lookup `auto-coding-regexp-alist' for the contents of the current buffer.
1601 The value is a coding system is specified for the region FROM and TO,
1602 or nil."
1603 (save-excursion
1604 (goto-char from)
1605 (let ((alist auto-coding-regexp-alist)
1606 coding-system)
1607 (while (and alist (not coding-system))
1608 (let ((regexp (car (car alist))))
1609 (if enable-multibyte-characters
1610 (setq regexp (string-to-multibyte regexp)))
1611 (if (re-search-forward regexp to t)
1612 (setq coding-system (cdr (car alist)))
1613 (setq alist (cdr alist)))))
1614 coding-system)))
1615
1616 ;; See the bottom of this file for built-in auto coding functions.
1617 (defcustom auto-coding-functions '(sgml-xml-auto-coding-function
1618 sgml-html-meta-auto-coding-function)
1619 "A list of functions which attempt to determine a coding system.
1620
1621 Each function in this list should be written to operate on the
1622 current buffer, but should not modify it in any way. The buffer
1623 will contain undecoded text of parts of the file. Each function
1624 should take one argument, SIZE, which says how many
1625 characters (starting from point) it should look at.
1626
1627 If one of these functions succeeds in determining a coding
1628 system, it should return that coding system. Otherwise, it
1629 should return nil.
1630
1631 If a file has a `coding:' tag, that takes precedence over these
1632 functions, so they won't be called at all."
1633 :group 'files
1634 :group 'mule
1635 :type '(repeat function))
1636
1637 (defvar set-auto-coding-for-load nil
1638 "Non-nil means look for `load-coding' property instead of `coding'.
1639 This is used for loading and byte-compiling Emacs Lisp files.")
1640
1641 (defun auto-coding-alist-lookup (filename)
1642 "Return the coding system specified by `auto-coding-alist' for FILENAME."
1643 (let ((alist auto-coding-alist)
1644 (case-fold-search (memq system-type '(vax-vms windows-nt ms-dos cygwin)))
1645 coding-system)
1646 (while (and alist (not coding-system))
1647 (if (string-match (car (car alist)) filename)
1648 (setq coding-system (cdr (car alist)))
1649 (setq alist (cdr alist))))
1650 coding-system))
1651
1652 (put 'enable-character-translation 'permanent-local t)
1653 (put 'enable-character-translation 'safe-local-variable 'booleanp)
1654
1655 (defun find-auto-coding (filename size)
1656 "Find a coding system for a file FILENAME of which SIZE bytes follow point.
1657 These bytes should include at least the first 1k of the file
1658 and the last 3k of the file, but the middle may be omitted.
1659
1660 The function checks FILENAME against the variable `auto-coding-alist'.
1661 If FILENAME doesn't match any entries in the variable, it checks the
1662 contents of the current buffer following point against
1663 `auto-coding-regexp-alist'. If no match is found, it checks for a
1664 `coding:' tag in the first one or two lines following point. If no
1665 `coding:' tag is found, it checks any local variables list in the last
1666 3K bytes out of the SIZE bytes. Finally, if none of these methods
1667 succeed, it checks to see if any function in `auto-coding-functions'
1668 gives a match.
1669
1670 If a coding system is specifed, the return value is a
1671 cons (CODING . SOURCE), where CODING is the specified coding
1672 system and SOURCE is a symbol `auto-coding-alist',
1673 `auto-coding-regexp-alist', `coding:', or `auto-coding-functions'
1674 indicating by what CODING is specified. Note that the validity
1675 of CODING is not checked; it's callers responsibility to check
1676 it.
1677
1678 If nothing is specified, the return value is nil."
1679 (or (let ((coding-system (auto-coding-alist-lookup filename)))
1680 (if coding-system
1681 (cons coding-system 'auto-coding-alist)))
1682 ;; Try using `auto-coding-regexp-alist'.
1683 (let ((coding-system (auto-coding-regexp-alist-lookup (point)
1684 (+ (point) size))))
1685 (if coding-system
1686 (cons coding-system 'auto-coding-regexp-alist)))
1687 (let* ((case-fold-search t)
1688 (head-start (point))
1689 (head-end (+ head-start (min size 1024)))
1690 (tail-start (+ head-start (max (- size 3072) 0)))
1691 (tail-end (+ head-start size))
1692 coding-system head-found tail-found pos char-trans)
1693 ;; Try a short cut by searching for the string "coding:"
1694 ;; and for "unibyte:" at the head and tail of SIZE bytes.
1695 (setq head-found (or (search-forward "coding:" head-end t)
1696 (search-forward "unibyte:" head-end t)
1697 (search-forward "enable-character-translation:"
1698 head-end t)))
1699 (if (and head-found (> head-found tail-start))
1700 ;; Head and tail are overlapped.
1701 (setq tail-found head-found)
1702 (goto-char tail-start)
1703 (setq tail-found (or (search-forward "coding:" tail-end t)
1704 (search-forward "unibyte:" tail-end t)
1705 (search-forward "enable-character-translation:"
1706 tail-end t))))
1707
1708 ;; At first check the head.
1709 (when head-found
1710 (goto-char head-start)
1711 (setq head-end (set-auto-mode-1))
1712 (setq head-start (point))
1713 (when (and head-end (< head-found head-end))
1714 (goto-char head-start)
1715 (when (and set-auto-coding-for-load
1716 (re-search-forward
1717 "\\(.*;\\)?[ \t]*unibyte:[ \t]*\\([^ ;]+\\)"
1718 head-end t))
1719 (setq coding-system 'raw-text))
1720 (when (and (not coding-system)
1721 (re-search-forward
1722 "\\(.*;\\)?[ \t]*coding:[ \t]*\\([^ ;]+\\)"
1723 head-end t))
1724 (setq coding-system (intern (match-string 2))))
1725 (when (re-search-forward
1726 "\\(.*;\\)?[ \t]*enable-character-translation:[ \t]*\\([^ ;]+\\)"
1727 head-end t)
1728 (setq char-trans (match-string 2)))))
1729
1730 ;; If no coding: tag in the head, check the tail.
1731 ;; Here we must pay attention to the case that the end-of-line
1732 ;; is just "\r" and we can't use "^" nor "$" in regexp.
1733 (when (and tail-found (or (not coding-system) (not char-trans)))
1734 (goto-char tail-start)
1735 (re-search-forward "[\r\n]\^L" nil t)
1736 (if (re-search-forward
1737 "[\r\n]\\([^[\r\n]*\\)[ \t]*Local Variables:[ \t]*\\([^\r\n]*\\)[\r\n]"
1738 tail-end t)
1739 ;; The prefix is what comes before "local variables:" in its
1740 ;; line. The suffix is what comes after "local variables:"
1741 ;; in its line.
1742 (let* ((prefix (regexp-quote (match-string 1)))
1743 (suffix (regexp-quote (match-string 2)))
1744 (re-coding
1745 (concat
1746 "[\r\n]" prefix
1747 ;; N.B. without the \n below, the regexp can
1748 ;; eat newlines.
1749 "[ \t]*coding[ \t]*:[ \t]*\\([^ \t\r\n]+\\)[ \t]*"
1750 suffix "[\r\n]"))
1751 (re-unibyte
1752 (concat
1753 "[\r\n]" prefix
1754 "[ \t]*unibyte[ \t]*:[ \t]*\\([^ \t\r\n]+\\)[ \t]*"
1755 suffix "[\r\n]"))
1756 (re-char-trans
1757 (concat
1758 "[\r\n]" prefix
1759 "[ \t]*enable-character-translation[ \t]*:[ \t]*\\([^ \t\r\n]+\\)[ \t]*"
1760 suffix "[\r\n]"))
1761 (re-end
1762 (concat "[\r\n]" prefix "[ \t]*End *:[ \t]*" suffix
1763 "[\r\n]?"))
1764 (pos (1- (point))))
1765 (forward-char -1) ; skip back \r or \n.
1766 (re-search-forward re-end tail-end 'move)
1767 (setq tail-end (point))
1768 (goto-char pos)
1769 (when (and set-auto-coding-for-load
1770 (re-search-forward re-unibyte tail-end t))
1771 (setq coding-system 'raw-text))
1772 (when (and (not coding-system)
1773 (re-search-forward re-coding tail-end t))
1774 (setq coding-system (intern (match-string 1))))
1775 (when (and (not char-trans)
1776 (re-search-forward re-char-trans tail-end t))
1777 (setq char-trans (match-string 1))))))
1778 (if coding-system
1779 ;; If the coding-system name ends with "!", remove it and
1780 ;; set char-trans to "nil".
1781 (let ((name (symbol-name coding-system)))
1782 (if (= (aref name (1- (length name))) ?!)
1783 (setq coding-system (intern (substring name 0 -1))
1784 char-trans "nil"))))
1785 (when (and char-trans
1786 (not (setq char-trans (intern char-trans))))
1787 (make-local-variable 'enable-character-translation)
1788 (setq enable-character-translation nil))
1789 (if coding-system
1790 (cons coding-system :coding)))
1791 ;; Finally, try all the `auto-coding-functions'.
1792 (let ((funcs auto-coding-functions)
1793 (coding-system nil))
1794 (while (and funcs (not coding-system))
1795 (setq coding-system (condition-case e
1796 (save-excursion
1797 (goto-char (point-min))
1798 (funcall (pop funcs) size))
1799 (error nil))))
1800 (if coding-system
1801 (cons coding-system 'auto-coding-functions)))))
1802
1803 (defun set-auto-coding (filename size)
1804 "Return coding system for a file FILENAME of which SIZE bytes follow point.
1805 See `find-auto-coding' for how the coding system is found.
1806 Return nil if an invalid coding system is found.
1807
1808 The variable `set-auto-coding-function' (which see) is set to this
1809 function by default."
1810 (let ((found (find-auto-coding filename size)))
1811 (if (and found (coding-system-p (car found)))
1812 (car found))))
1813
1814 (setq set-auto-coding-function 'set-auto-coding)
1815
1816 ;; This variable is set in these two cases:
1817 ;; (1) A file is read by a coding system specified explicitly.
1818 ;; after-insert-file-set-coding sets this value to
1819 ;; coding-system-for-read.
1820 ;; (2) A buffer is saved.
1821 ;; After writing, basic-save-buffer-1 sets this value to
1822 ;; last-coding-system-used.
1823 ;; This variable is used for decoding in revert-buffer.
1824 (defvar buffer-file-coding-system-explicit nil
1825 "The file coding system explicitly specified for the current buffer.
1826 Internal use only.")
1827 (make-variable-buffer-local 'buffer-file-coding-system-explicit)
1828 (put 'buffer-file-coding-system-explicit 'permanent-local t)
1829
1830 (defun after-insert-file-set-coding (inserted &optional visit)
1831 "Set `buffer-file-coding-system' of current buffer after text is inserted.
1832 INSERTED is the number of characters that were inserted, as figured
1833 in the situation before this function. Return the number of characters
1834 inserted, as figured in the situation after. The two numbers can be
1835 different if the buffer has become unibyte.
1836 The optional second arg VISIT non-nil means that we are visiting a file."
1837 (if (and visit
1838 coding-system-for-read
1839 (not (eq coding-system-for-read 'auto-save-coding)))
1840 (setq buffer-file-coding-system-explicit coding-system-for-read))
1841 (if last-coding-system-used
1842 (let ((coding-system
1843 (find-new-buffer-file-coding-system last-coding-system-used)))
1844 (when coding-system
1845 ;; Tell set-buffer-file-coding-system not to mark the file
1846 ;; as modified; we just read it, and it's supposed to be unmodified.
1847 ;; Marking it modified would try to lock it, which would
1848 ;; check the modtime, and we don't want to do that again now.
1849 (set-buffer-file-coding-system coding-system t t))))
1850 inserted)
1851
1852 ;; The coding-spec and eol-type of coding-system returned is decided
1853 ;; independently in the following order.
1854 ;; 1. That of buffer-file-coding-system locally bound.
1855 ;; 2. That of CODING.
1856
1857 (defun find-new-buffer-file-coding-system (coding)
1858 "Return a coding system for a buffer when a file of CODING is inserted.
1859 The local variable `buffer-file-coding-system' of the current buffer
1860 is set to the returned value.
1861 Return nil if there's no need to set `buffer-file-coding-system'."
1862 (let (local-coding local-eol
1863 found-coding found-eol
1864 new-coding new-eol)
1865 (if (null coding)
1866 ;; Nothing found about coding.
1867 nil
1868
1869 ;; Get information of `buffer-file-coding-system' in LOCAL-EOL
1870 ;; and LOCAL-CODING.
1871 (setq local-eol (coding-system-eol-type buffer-file-coding-system))
1872 (if (null (numberp local-eol))
1873 ;; But eol-type is not yet set.
1874 (setq local-eol nil))
1875 (if (and buffer-file-coding-system
1876 (not (eq (coding-system-type buffer-file-coding-system)
1877 'undecided)))
1878 (setq local-coding (coding-system-base buffer-file-coding-system)))
1879
1880 (if (and (local-variable-p 'buffer-file-coding-system)
1881 local-eol local-coding)
1882 ;; The current buffer has already set full coding-system, we
1883 ;; had better not change it.
1884 nil
1885
1886 (setq found-eol (coding-system-eol-type coding))
1887 (if (null (numberp found-eol))
1888 ;; But eol-type is not found.
1889 ;; If EOL conversions are inhibited, force unix eol-type.
1890 (setq found-eol (if inhibit-eol-conversion 0)))
1891 (setq found-coding (coding-system-base coding))
1892
1893 (if (and (not found-eol) (eq found-coding 'undecided))
1894 ;; No valid coding information found.
1895 nil
1896
1897 ;; Some coding information (eol or text) found.
1898
1899 ;; The local setting takes precedence over the found one.
1900 (setq new-coding (if (local-variable-p 'buffer-file-coding-system)
1901 (or local-coding found-coding)
1902 (or found-coding local-coding)))
1903 (setq new-eol (if (local-variable-p 'buffer-file-coding-system)
1904 (or local-eol found-eol)
1905 (or found-eol local-eol)))
1906
1907 (let ((eol-type (coding-system-eol-type new-coding)))
1908 (if (and (numberp new-eol) (vectorp eol-type))
1909 (aref eol-type new-eol)
1910 new-coding)))))))
1911
1912 (defun modify-coding-system-alist (target-type regexp coding-system)
1913 "Modify one of look up tables for finding a coding system on I/O operation.
1914 There are three of such tables, `file-coding-system-alist',
1915 `process-coding-system-alist', and `network-coding-system-alist'.
1916
1917 TARGET-TYPE specifies which of them to modify.
1918 If it is `file', it affects `file-coding-system-alist' (which see).
1919 If it is `process', it affects `process-coding-system-alist' (which see).
1920 If it is `network', it affects `network-coding-system-alist' (which see).
1921
1922 REGEXP is a regular expression matching a target of I/O operation.
1923 The target is a file name if TARGET-TYPE is `file', a program name if
1924 TARGET-TYPE is `process', or a network service name or a port number
1925 to connect to if TARGET-TYPE is `network'.
1926
1927 CODING-SYSTEM is a coding system to perform code conversion on the I/O
1928 operation, or a cons cell (DECODING . ENCODING) specifying the coding systems
1929 for decoding and encoding respectively,
1930 or a function symbol which, when called, returns such a cons cell."
1931 (or (memq target-type '(file process network))
1932 (error "Invalid target type: %s" target-type))
1933 (or (stringp regexp)
1934 (and (eq target-type 'network) (integerp regexp))
1935 (error "Invalid regular expression: %s" regexp))
1936 (if (symbolp coding-system)
1937 (if (not (fboundp coding-system))
1938 (progn
1939 (check-coding-system coding-system)
1940 (setq coding-system (cons coding-system coding-system))))
1941 (check-coding-system (car coding-system))
1942 (check-coding-system (cdr coding-system)))
1943 (cond ((eq target-type 'file)
1944 (let ((slot (assoc regexp file-coding-system-alist)))
1945 (if slot
1946 (setcdr slot coding-system)
1947 (setq file-coding-system-alist
1948 (cons (cons regexp coding-system)
1949 file-coding-system-alist)))))
1950 ((eq target-type 'process)
1951 (let ((slot (assoc regexp process-coding-system-alist)))
1952 (if slot
1953 (setcdr slot coding-system)
1954 (setq process-coding-system-alist
1955 (cons (cons regexp coding-system)
1956 process-coding-system-alist)))))
1957 (t
1958 (let ((slot (assoc regexp network-coding-system-alist)))
1959 (if slot
1960 (setcdr slot coding-system)
1961 (setq network-coding-system-alist
1962 (cons (cons regexp coding-system)
1963 network-coding-system-alist)))))))
1964
1965 (defun decode-coding-inserted-region (from to filename
1966 &optional visit beg end replace)
1967 "Decode the region between FROM and TO as if it is read from file FILENAME.
1968 The idea is that the text between FROM and TO was just inserted somehow.
1969 Optional arguments VISIT, BEG, END, and REPLACE are the same as those
1970 of the function `insert-file-contents'.
1971 Part of the job of this function is setting `buffer-undo-list' appropriately."
1972 (save-excursion
1973 (save-restriction
1974 (let ((coding coding-system-for-read)
1975 undo-list-saved)
1976 (if visit
1977 ;; Temporarily turn off undo recording, if we're decoding the
1978 ;; text of a visited file.
1979 (setq buffer-undo-list t)
1980 ;; Otherwise, if we can recognize the undo elt for the insertion,
1981 ;; remove it and get ready to replace it later.
1982 ;; In the mean time, turn off undo recording.
1983 (let ((last (car-safe buffer-undo-list)))
1984 (if (and (consp last) (eql (car last) from) (eql (cdr last) to))
1985 (setq undo-list-saved (cdr buffer-undo-list)
1986 buffer-undo-list t))))
1987 (narrow-to-region from to)
1988 (goto-char (point-min))
1989 (or coding
1990 (setq coding (funcall set-auto-coding-function
1991 filename (- (point-max) (point-min)))))
1992 (or coding
1993 (setq coding (car (find-operation-coding-system
1994 'insert-file-contents
1995 (cons filename (current-buffer))
1996 visit beg end replace))))
1997 (if (coding-system-p coding)
1998 (or enable-multibyte-characters
1999 (setq coding
2000 (coding-system-change-text-conversion coding 'raw-text)))
2001 (setq coding nil))
2002 (if coding
2003 (decode-coding-region (point-min) (point-max) coding)
2004 (setq last-coding-system-used coding))
2005 ;; If we're decoding the text of a visited file,
2006 ;; the undo list should start out empty.
2007 (if visit
2008 (setq buffer-undo-list nil)
2009 ;; If we decided to replace the undo entry for the insertion,
2010 ;; do so now.
2011 (if undo-list-saved
2012 (setq buffer-undo-list
2013 (cons (cons from (point-max)) undo-list-saved))))))))
2014
2015 (defun recode-region (start end new-coding coding)
2016 "Re-decode the region (previously decoded by CODING) by NEW-CODING."
2017 (interactive
2018 (list (region-beginning) (region-end)
2019 (read-coding-system "Text was really in: ")
2020 (let ((coding (or buffer-file-coding-system last-coding-system-used)))
2021 (read-coding-system
2022 (concat "But was interpreted as"
2023 (if coding (format " (default %S): " coding) ": "))
2024 coding))))
2025 (or (and new-coding coding)
2026 (error "Coding system not specified"))
2027 ;; Check it before we encode the region.
2028 (check-coding-system new-coding)
2029 (save-restriction
2030 (narrow-to-region start end)
2031 (encode-coding-region (point-min) (point-max) coding)
2032 (decode-coding-region (point-min) (point-max) new-coding)))
2033
2034 (defun make-translation-table (&rest args)
2035 "Make a translation table from arguments.
2036 A translation table is a char table intended for character
2037 translation in CCL programs.
2038
2039 Each argument is a list of elements of the form (FROM . TO), where FROM
2040 is a character to be translated to TO.
2041
2042 The arguments and forms in each argument are processed in the given
2043 order, and if a previous form already translates TO to some other
2044 character, say TO-ALT, FROM is also translated to TO-ALT."
2045 (let ((table (make-char-table 'translation-table))
2046 revlist)
2047 (dolist (elts args)
2048 (dolist (elt elts)
2049 (let ((from (car elt))
2050 (to (cdr elt))
2051 to-alt rev-from rev-to)
2052 ;; If we have already translated TO to TO-ALT, FROM should
2053 ;; also be translated to TO-ALT.
2054 (if (setq to-alt (aref table to))
2055 (setq to to-alt))
2056 (aset table from to)
2057 ;; If we have already translated some chars to FROM, they
2058 ;; should also be translated to TO.
2059 (when (setq rev-from (assq from revlist))
2060 (dolist (elt (cdr rev-from))
2061 (aset table elt to))
2062 (setq revlist (delq rev-from revlist)
2063 rev-from (cdr rev-from)))
2064 ;; Now update REVLIST.
2065 (setq rev-to (assq to revlist))
2066 (if rev-to
2067 (setcdr rev-to (cons from (cdr rev-to)))
2068 (setq rev-to (list to from)
2069 revlist (cons rev-to revlist)))
2070 (if rev-from
2071 (setcdr rev-to (append rev-from (cdr rev-to)))))))
2072 ;; Return TABLE just created.
2073 (set-char-table-extra-slot table 1 1)
2074 table))
2075
2076 (defun make-translation-table-from-vector (vec)
2077 "Make translation table from decoding vector VEC.
2078 VEC is an array of 256 elements to map unibyte codes to multibyte
2079 characters. Elements may be nil for undefined code points.
2080 See also the variable `nonascii-translation-table'."
2081 (let ((table (make-char-table 'translation-table))
2082 (rev-table (make-char-table 'translation-table))
2083 ch)
2084 (dotimes (i 256)
2085 (setq ch (aref vec i))
2086 (when ch
2087 (aset table i ch)
2088 (if (>= ch 256)
2089 (aset rev-table ch i))))
2090 (set-char-table-extra-slot table 0 rev-table)
2091 (set-char-table-extra-slot table 1 1)
2092 (set-char-table-extra-slot rev-table 1 1)
2093 table))
2094
2095 (defun make-translation-table-from-alist (alist)
2096 "Make translation table from N<->M mapping in ALIST.
2097 ALIST is an alist, each element has the form (FROM . TO).
2098 FROM and TO are a character or a vector of characters.
2099 If FROM is a character, that character is translated to TO.
2100 If FROM is a vector of characters, that sequence is translated to TO.
2101 The first extra-slot of the value is a translation table for reverse mapping."
2102 (let ((tables (vector (make-char-table 'translation-table)
2103 (make-char-table 'translation-table)))
2104 table max-lookup from to idx val)
2105 (dotimes (i 2)
2106 (setq table (aref tables i))
2107 (setq max-lookup 1)
2108 (dolist (elt alist)
2109 (if (= i 0)
2110 (setq from (car elt) to (cdr elt))
2111 (setq from (cdr elt) to (car elt)))
2112 (if (characterp from)
2113 (setq idx from)
2114 (setq idx (aref from 0)
2115 max-lookup (max max-lookup (length from))))
2116 (setq val (aref table idx))
2117 (if val
2118 (progn
2119 (or (consp val)
2120 (setq val (list (cons (vector idx) val))))
2121 (if (characterp from)
2122 (setq from (vector from)))
2123 (setq val (nconc val (list (cons from to)))))
2124 (if (characterp from)
2125 (setq val to)
2126 (setq val (list (cons from to)))))
2127 (aset table idx val))
2128 (set-char-table-extra-slot table 1 max-lookup))
2129 (set-char-table-extra-slot (aref tables 0) 0 (aref tables 1))
2130 (aref tables 0)))
2131
2132 (defun define-translation-table (symbol &rest args)
2133 "Define SYMBOL as the name of translation table made by ARGS.
2134 This sets up information so that the table can be used for
2135 translations in a CCL program.
2136
2137 If the first element of ARGS is a char-table whose purpose is
2138 `translation-table', just define SYMBOL to name it. (Note that this
2139 function does not bind SYMBOL.)
2140
2141 Any other ARGS should be suitable as arguments of the function
2142 `make-translation-table' (which see).
2143
2144 This function sets properties `translation-table' and
2145 `translation-table-id' of SYMBOL to the created table itself and the
2146 identification number of the table respectively. It also registers
2147 the table in `translation-table-vector'."
2148 (let ((table (if (and (char-table-p (car args))
2149 (eq (char-table-subtype (car args))
2150 'translation-table))
2151 (car args)
2152 (apply 'make-translation-table args)))
2153 (len (length translation-table-vector))
2154 (id 0)
2155 (done nil))
2156 (put symbol 'translation-table table)
2157 (while (not done)
2158 (if (>= id len)
2159 (setq translation-table-vector
2160 (vconcat translation-table-vector (make-vector len nil))))
2161 (let ((slot (aref translation-table-vector id)))
2162 (if (or (not slot)
2163 (eq (car slot) symbol))
2164 (progn
2165 (aset translation-table-vector id (cons symbol table))
2166 (setq done t))
2167 (setq id (1+ id)))))
2168 (put symbol 'translation-table-id id)
2169 id))
2170
2171 (defun translate-region (start end table)
2172 "From START to END, translate characters according to TABLE.
2173 TABLE is a string or a char-table.
2174 If TABLE is a string, the Nth character in it is the mapping
2175 for the character with code N.
2176 If TABLE is a char-table, the element for character N is the mapping
2177 for the character with code N.
2178 It returns the number of characters changed."
2179 (interactive
2180 (list (region-beginning)
2181 (region-end)
2182 (let (table l)
2183 (dotimes (i (length translation-table-vector))
2184 (if (consp (aref translation-table-vector i))
2185 (push (list (symbol-name
2186 (car (aref translation-table-vector i)))) l)))
2187 (if (not l)
2188 (error "No translation table defined"))
2189 (while (not table)
2190 (setq table (completing-read "Translation table: " l nil t)))
2191 (intern table))))
2192 (if (symbolp table)
2193 (let ((val (get table 'translation-table)))
2194 (or (char-table-p val)
2195 (error "Invalid translation table name: %s" table))
2196 (setq table val)))
2197 (translate-region-internal start end table))
2198
2199 (put 'with-category-table 'lisp-indent-function 1)
2200
2201 (defmacro with-category-table (table &rest body)
2202 "Execute BODY like `progn' with CATEGORY-TABLE the current category table.
2203 The category table of the current buffer is saved, BODY is evaluated,
2204 then the saved table is restored, even in case of an abnormal exit.
2205 Value is what BODY returns."
2206 (let ((old-table (make-symbol "old-table"))
2207 (old-buffer (make-symbol "old-buffer")))
2208 `(let ((,old-table (category-table))
2209 (,old-buffer (current-buffer)))
2210 (unwind-protect
2211 (progn
2212 (set-category-table ,table)
2213 ,@body)
2214 (save-current-buffer
2215 (set-buffer ,old-buffer)
2216 (set-category-table ,old-table))))))
2217
2218 (defun define-translation-hash-table (symbol table)
2219 "Define SYMBOL as the name of the hash translation TABLE for use in CCL.
2220
2221 Analogous to `define-translation-table', but updates
2222 `translation-hash-table-vector' and the table is for use in the CCL
2223 `lookup-integer' and `lookup-character' functions."
2224 (unless (and (symbolp symbol)
2225 (hash-table-p table))
2226 (error "Bad args to define-translation-hash-table"))
2227 (let ((len (length translation-hash-table-vector))
2228 (id 0)
2229 done)
2230 (put symbol 'translation-hash-table table)
2231 (while (not done)
2232 (if (>= id len)
2233 (setq translation-hash-table-vector
2234 (vconcat translation-hash-table-vector [nil])))
2235 (let ((slot (aref translation-hash-table-vector id)))
2236 (if (or (not slot)
2237 (eq (car slot) symbol))
2238 (progn
2239 (aset translation-hash-table-vector id (cons symbol table))
2240 (setq done t))
2241 (setq id (1+ id)))))
2242 (put symbol 'translation-hash-table-id id)
2243 id))
2244
2245 ;;; Initialize some variables.
2246
2247 (put 'use-default-ascent 'char-table-extra-slots 0)
2248 (setq use-default-ascent (make-char-table 'use-default-ascent))
2249 (put 'ignore-relative-composition 'char-table-extra-slots 0)
2250 (setq ignore-relative-composition
2251 (make-char-table 'ignore-relative-composition))
2252
2253 (make-obsolete 'set-char-table-default
2254 "Generic characters no longer exist" "23.1")
2255
2256 ;;; Built-in auto-coding-functions:
2257
2258 (defun sgml-xml-auto-coding-function (size)
2259 "Determine whether the buffer is XML, and if so, its encoding.
2260 This function is intended to be added to `auto-coding-functions'."
2261 (setq size (+ (point) size))
2262 (when (re-search-forward "\\`[[:space:]\n]*<\\?xml" size t)
2263 (let ((end (save-excursion
2264 ;; This is a hack.
2265 (re-search-forward "[\"']\\s-*\\?>" size t))))
2266 (when end
2267 (if (re-search-forward "encoding=[\"']\\(.+?\\)[\"']" end t)
2268 (let* ((match (match-string 1))
2269 (sym (intern (downcase match))))
2270 (if (coding-system-p sym)
2271 sym
2272 (message "Warning: unknown coding system \"%s\"" match)
2273 nil))
2274 'utf-8)))))
2275
2276 (defun sgml-html-meta-auto-coding-function (size)
2277 "If the buffer has an HTML meta tag, use it to determine encoding.
2278 This function is intended to be added to `auto-coding-functions'."
2279 (setq size (min (+ (point) size)
2280 (save-excursion
2281 ;; Limit the search by the end of the HTML header.
2282 (or (search-forward "</head>" size t)
2283 ;; In case of no header, search only 10 lines.
2284 (forward-line 10))
2285 (point))))
2286 (when (re-search-forward "<meta\\s-+http-equiv=[\"']?content-type[\"']?\\s-+content=[\"']text/\\sw+;\\s-*charset=\\(.+?\\)[\"']" size t)
2287 (let* ((match (match-string 1))
2288 (sym (intern (downcase match))))
2289 (if (coding-system-p sym)
2290 sym
2291 (message "Warning: unknown coding system \"%s\"" match)
2292 nil))))
2293
2294 ;;;
2295 (provide 'mule)
2296
2297 ;;; arch-tag: 9aebaa6e-0e8a-40a9-b857-cb5d04a39e7c
2298 ;;; mule.el ends here