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