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