Merge from emacs--devo--0
[emacs.git] / lisp / international / mule-cmds.el
blob164c3d7ca9902920982d42b0a0545c379a1596e8
1 ;;; mule-cmds.el --- commands for multilingual environment -*-coding: iso-2022-7bit -*-
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007 Free Software Foundation, Inc.
5 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6 ;; 2005, 2006, 2007
7 ;; National Institute of Advanced Industrial Science and Technology (AIST)
8 ;; Registration Number H14PRO021
9 ;; Copyright (C) 2003
10 ;; National Institute of Advanced Industrial Science and Technology (AIST)
11 ;; Registration Number H13PRO009
13 ;; Keywords: mule, i18n
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 3, or (at your option)
20 ;; any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, USA.
32 ;;; Commentary:
34 ;;; Code:
36 (eval-when-compile
37 (defvar dos-codepage)
38 (autoload 'widget-value "wid-edit"))
40 (defvar mac-system-coding-system)
41 (defvar mac-system-locale)
43 ;;; MULE related key bindings and menus.
45 (defvar mule-keymap (make-sparse-keymap)
46 "Keymap for Mule (Multilingual environment) specific commands.")
48 ;; Keep "C-x C-m ..." for mule specific commands.
49 (define-key ctl-x-map "\C-m" mule-keymap)
51 (define-key mule-keymap "f" 'set-buffer-file-coding-system)
52 (define-key mule-keymap "r" 'revert-buffer-with-coding-system)
53 (define-key mule-keymap "F" 'set-file-name-coding-system)
54 (define-key mule-keymap "t" 'set-terminal-coding-system)
55 (define-key mule-keymap "k" 'set-keyboard-coding-system)
56 (define-key mule-keymap "p" 'set-buffer-process-coding-system)
57 (define-key mule-keymap "x" 'set-selection-coding-system)
58 (define-key mule-keymap "X" 'set-next-selection-coding-system)
59 (define-key mule-keymap "\C-\\" 'set-input-method)
60 (define-key mule-keymap "c" 'universal-coding-system-argument)
61 (define-key mule-keymap "l" 'set-language-environment)
63 (defvar mule-menu-keymap
64 (make-sparse-keymap "Mule (Multilingual Environment)")
65 "Keymap for Mule (Multilingual environment) menu specific commands.")
67 (defvar describe-language-environment-map
68 (make-sparse-keymap "Describe Language Environment"))
70 (defvar setup-language-environment-map
71 (make-sparse-keymap "Set Language Environment"))
73 (defvar set-coding-system-map
74 (make-sparse-keymap "Set Coding System"))
76 (define-key-after mule-menu-keymap [set-language-environment]
77 (list 'menu-item "Set Language Environment" setup-language-environment-map))
78 (define-key-after mule-menu-keymap [separator-mule]
79 '("--")
81 (define-key-after mule-menu-keymap [toggle-input-method]
82 '(menu-item "Toggle Input Method" toggle-input-method)
84 (define-key-after mule-menu-keymap [set-input-method]
85 '(menu-item "Select Input Method..." set-input-method)
87 (define-key-after mule-menu-keymap [describe-input-method]
88 '(menu-item "Describe Input Method" describe-input-method))
89 (define-key-after mule-menu-keymap [separator-input-method]
90 '("--")
92 (define-key-after mule-menu-keymap [set-various-coding-system]
93 (list 'menu-item "Set Coding Systems" set-coding-system-map
94 :enable 'default-enable-multibyte-characters))
95 (define-key-after mule-menu-keymap [view-hello-file]
96 '(menu-item "Show Multi-lingual Text" view-hello-file
97 :enable (file-readable-p
98 (expand-file-name "HELLO" data-directory))
99 :help "Display file which says HELLO in many languages")
101 (define-key-after mule-menu-keymap [separator-coding-system]
102 '("--")
104 (define-key-after mule-menu-keymap [describe-language-environment]
105 (list 'menu-item "Describe Language Environment"
106 describe-language-environment-map
107 :help "Show multilingual settings for a specific language")
109 (define-key-after mule-menu-keymap [describe-input-method]
110 '(menu-item "Describe Input Method..." describe-input-method
111 :help "Keyboard layout for a specific input method")
113 (define-key-after mule-menu-keymap [describe-coding-system]
114 '(menu-item "Describe Coding System..." describe-coding-system)
116 (define-key-after mule-menu-keymap [list-character-sets]
117 '(menu-item "List Character Sets" list-character-sets
118 :help "Show table of available character sets"))
119 (define-key-after mule-menu-keymap [mule-diag]
120 '(menu-item "Show All of Mule Status" mule-diag
121 :help "Display multilingual environment settings")
124 (define-key-after set-coding-system-map [universal-coding-system-argument]
125 '(menu-item "For Next Command" universal-coding-system-argument
126 :help "Coding system to be used by next command")
128 (define-key-after set-coding-system-map [separator-1]
129 '("--")
131 (define-key-after set-coding-system-map [set-buffer-file-coding-system]
132 '(menu-item "For Saving This Buffer" set-buffer-file-coding-system
133 :help "How to encode this buffer when saved")
135 (define-key-after set-coding-system-map [revert-buffer-with-coding-system]
136 '(menu-item "For Reverting This File Now" revert-buffer-with-coding-system
137 :enable buffer-file-name
138 :help "Revisit this file immediately using specified coding system")
140 (define-key-after set-coding-system-map [set-file-name-coding-system]
141 '(menu-item "For File Name" set-file-name-coding-system
142 :help "How to decode/encode file names")
144 (define-key-after set-coding-system-map [separator-2]
145 '("--")
148 (define-key-after set-coding-system-map [set-keyboard-coding-system]
149 '(menu-item "For Keyboard" set-keyboard-coding-system
150 :help "How to decode keyboard input")
152 (define-key-after set-coding-system-map [set-terminal-coding-system]
153 '(menu-item "For Terminal" set-terminal-coding-system
154 :enable (null (memq initial-window-system '(x w32 mac)))
155 :help "How to encode terminal output")
157 (define-key-after set-coding-system-map [separator-3]
158 '("--")
160 (define-key-after set-coding-system-map [set-selection-coding-system]
161 '(menu-item "For X Selections/Clipboard" set-selection-coding-system
162 :visible (display-selections-p)
163 :help "How to en/decode data to/from selection/clipboard")
165 (define-key-after set-coding-system-map [set-next-selection-coding-system]
166 '(menu-item "For Next X Selection" set-next-selection-coding-system
167 :visible (display-selections-p)
168 :help "How to en/decode next selection/clipboard operation")
170 (define-key-after set-coding-system-map [set-buffer-process-coding-system]
171 '(menu-item "For I/O with Subprocess" set-buffer-process-coding-system
172 :visible (fboundp 'start-process)
173 :enable (get-buffer-process (current-buffer))
174 :help "How to en/decode I/O from/to subprocess connected to this buffer")
178 (define-key setup-language-environment-map
179 [Default] '(menu-item "Default" setup-specified-language-environment))
181 (define-key describe-language-environment-map
182 [Default] '(menu-item "Default" describe-specified-language-support))
184 ;; This should be a single character key binding because users use it
185 ;; very frequently while editing multilingual text. Now we can use
186 ;; only two such keys: "\C-\\" and "\C-^", but the latter is not
187 ;; convenient because it requires shifting on most keyboards. An
188 ;; alternative is "\C-\]" which is now bound to `abort-recursive-edit'
189 ;; but it won't be used that frequently.
190 (define-key global-map "\C-\\" 'toggle-input-method)
192 ;; This is no good because people often type Shift-SPC
193 ;; meaning to type SPC. -- rms.
194 ;; ;; Here's an alternative key binding for X users (Shift-SPACE).
195 ;; (define-key global-map [?\S- ] 'toggle-input-method)
197 ;;; Mule related hyperlinks.
198 (defconst help-xref-mule-regexp-template
199 (purecopy (concat "\\(\\<\\("
200 "\\(coding system\\)\\|"
201 "\\(input method\\)\\|"
202 "\\(character set\\)\\|"
203 "\\(charset\\)"
204 "\\)\\s-+\\)?"
205 ;; Note starting with word-syntax character:
206 "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'")))
208 (defun coding-system-change-eol-conversion (coding-system eol-type)
209 "Return a coding system which differs from CODING-SYSTEM in EOL conversion.
210 The returned coding system converts end-of-line by EOL-TYPE
211 but text as the same way as CODING-SYSTEM.
212 EOL-TYPE should be `unix', `dos', `mac', or nil.
213 If EOL-TYPE is nil, the returned coding system detects
214 how end-of-line is formatted automatically while decoding.
216 EOL-TYPE can be specified by an integer 0, 1, or 2.
217 They means `unix', `dos', and `mac' respectively."
218 (if (symbolp eol-type)
219 (setq eol-type (cond ((eq eol-type 'unix) 0)
220 ((eq eol-type 'dos) 1)
221 ((eq eol-type 'mac) 2)
222 (t eol-type))))
223 ;; We call `coding-system-base' before `coding-system-eol-type',
224 ;; because the coding-system may not be initialized until then.
225 (let* ((base (coding-system-base coding-system))
226 (orig-eol-type (coding-system-eol-type coding-system)))
227 (cond ((vectorp orig-eol-type)
228 (if (not eol-type)
229 coding-system
230 (aref orig-eol-type eol-type)))
231 ((not eol-type)
232 base)
233 ((= eol-type orig-eol-type)
234 coding-system)
235 ((progn (setq orig-eol-type (coding-system-eol-type base))
236 (vectorp orig-eol-type))
237 (aref orig-eol-type eol-type)))))
239 (defun coding-system-change-text-conversion (coding-system coding)
240 "Return a coding system which differs from CODING-SYSTEM in text conversion.
241 The returned coding system converts text by CODING
242 but end-of-line as the same way as CODING-SYSTEM.
243 If CODING is nil, the returned coding system detects
244 how text is formatted automatically while decoding."
245 (let ((eol-type (coding-system-eol-type coding-system)))
246 (coding-system-change-eol-conversion
247 (if coding coding 'undecided)
248 (if (numberp eol-type) (aref [unix dos mac] eol-type)))))
250 (defun toggle-enable-multibyte-characters (&optional arg)
251 "Change whether this buffer uses multibyte characters.
252 With arg, use multibyte characters if the arg is positive.
254 Note that this command does not convert the byte contents of
255 the buffer; it only changes the way those bytes are interpreted.
256 In general, therefore, this command *changes* the sequence of
257 characters that the current buffer contains.
259 We suggest you avoid using this command unless you know what you are
260 doing. If you use it by mistake, and the buffer is now displayed
261 wrong, use this command again to toggle back to the right mode."
262 (interactive "P")
263 (let ((new-flag
264 (if (null arg) (null enable-multibyte-characters)
265 (> (prefix-numeric-value arg) 0))))
266 (set-buffer-multibyte new-flag))
267 (force-mode-line-update))
269 (defun view-hello-file ()
270 "Display the HELLO file which list up many languages and characters."
271 (interactive)
272 ;; We have to decode the file in any environment.
273 (let ((default-enable-multibyte-characters t)
274 (coding-system-for-read 'iso-2022-7bit))
275 (view-file (expand-file-name "HELLO" data-directory))))
277 (defun universal-coding-system-argument (coding-system)
278 "Execute an I/O command using the specified coding system."
279 (interactive
280 (let ((default (and buffer-file-coding-system
281 (not (eq (coding-system-type buffer-file-coding-system)
282 'undecided))
283 buffer-file-coding-system)))
284 (list (read-coding-system
285 (if default
286 (format "Coding system for following command (default %s): " default)
287 "Coding system for following command: ")
288 default))))
289 (let* ((keyseq (read-key-sequence
290 (format "Command to execute with %s:" coding-system)))
291 (cmd (key-binding keyseq))
292 prefix)
294 (when (eq cmd 'universal-argument)
295 (call-interactively cmd)
297 ;; Process keys bound in `universal-argument-map'.
298 (while (progn
299 (setq keyseq (read-key-sequence nil t)
300 cmd (key-binding keyseq t))
301 (not (eq cmd 'universal-argument-other-key)))
302 (let ((current-prefix-arg prefix-arg)
303 ;; Have to bind `last-command-char' here so that
304 ;; `digit-argument', for instance, can compute the
305 ;; prefix arg.
306 (last-command-char (aref keyseq 0)))
307 (call-interactively cmd)))
309 ;; This is the final call to `universal-argument-other-key', which
310 ;; set's the final `prefix-arg.
311 (let ((current-prefix-arg prefix-arg))
312 (call-interactively cmd))
314 ;; Read the command to execute with the given prefix arg.
315 (setq prefix prefix-arg
316 keyseq (read-key-sequence nil t)
317 cmd (key-binding keyseq)))
319 (let ((coding-system-for-read coding-system)
320 (coding-system-for-write coding-system)
321 (coding-system-require-warning t)
322 (current-prefix-arg prefix))
323 (message "")
324 (call-interactively cmd))))
326 (defun set-default-coding-systems (coding-system)
327 "Set default value of various coding systems to CODING-SYSTEM.
328 This sets the following coding systems:
329 o coding system of a newly created buffer
330 o default coding system for subprocess I/O
331 This also sets the following values:
332 o default value used as `file-name-coding-system' for converting file names
333 if CODING-SYSTEM is ASCII-compatible
334 o default value for the command `set-terminal-coding-system' (not on MSDOS)
335 o default value for the command `set-keyboard-coding-system'
336 if CODING-SYSTEM is ASCII-compatible"
337 (check-coding-system coding-system)
338 (setq-default buffer-file-coding-system coding-system)
339 (if (fboundp 'ucs-set-table-for-input)
340 (dolist (buffer (buffer-list))
341 (or (local-variable-p 'buffer-file-coding-system buffer)
342 (ucs-set-table-for-input buffer))))
344 (if (eq system-type 'darwin)
345 ;; The file-name coding system on Darwin systems is always utf-8.
346 (setq default-file-name-coding-system 'utf-8)
347 (if (and default-enable-multibyte-characters
348 (or (not coding-system)
349 (coding-system-get coding-system 'ascii-compatible-p)))
350 (setq default-file-name-coding-system coding-system)))
351 ;; If coding-system is nil, honor that on MS-DOS as well, so
352 ;; that they could reset the terminal coding system.
353 (unless (and (eq window-system 'pc) coding-system)
354 (setq default-terminal-coding-system coding-system))
355 (setq default-keyboard-coding-system coding-system)
356 ;; Preserve eol-type from existing default-process-coding-systems.
357 ;; On non-unix-like systems in particular, these may have been set
358 ;; carefully by the user, or by the startup code, to deal with the
359 ;; users shell appropriately, so should not be altered by changing
360 ;; language environment.
361 (let ((output-coding
362 (coding-system-change-text-conversion
363 (car default-process-coding-system) coding-system))
364 (input-coding
365 (coding-system-change-text-conversion
366 (cdr default-process-coding-system) coding-system)))
367 (setq default-process-coding-system
368 (cons output-coding input-coding))))
370 (defun prefer-coding-system (coding-system)
371 "Add CODING-SYSTEM at the front of the priority list for automatic detection.
372 This also sets the following coding systems:
373 o coding system of a newly created buffer
374 o default coding system for subprocess I/O
375 This also sets the following values:
376 o default value used as `file-name-coding-system' for converting file names
377 o default value for the command `set-terminal-coding-system' (not on MSDOS)
378 o default value for the command `set-keyboard-coding-system'
380 If CODING-SYSTEM specifies a certain type of EOL conversion, the coding
381 systems set by this function will use that type of EOL conversion.
383 This command does not change the default value of terminal coding system
384 for MS-DOS terminal, because DOS terminals only support a single coding
385 system, and Emacs automatically sets the default to that coding system at
386 startup.
388 A coding system that requires automatic detection of text
389 +encoding (e.g. undecided, unix) can't be preferred.."
390 (interactive "zPrefer coding system: ")
391 (if (not (and coding-system (coding-system-p coding-system)))
392 (error "Invalid coding system `%s'" coding-system))
393 (if (memq (coding-system-type coding-system) '(raw-text undecided))
394 (error "Can't prefer the coding system `%s'" coding-system))
395 (let ((base (coding-system-base coding-system))
396 (eol-type (coding-system-eol-type coding-system)))
397 (set-coding-system-priority base)
398 (and (interactive-p)
399 (or (eq base coding-system)
400 (message "Highest priority is set to %s (base of %s)"
401 base coding-system)))
402 ;; If they asked for specific EOL conversion, honor that.
403 (if (memq eol-type '(0 1 2))
404 (setq base
405 (coding-system-change-eol-conversion base eol-type)))
406 (set-default-coding-systems base)))
408 (defvar sort-coding-systems-predicate nil
409 "If non-nil, a predicate function to sort coding systems.
411 It is called with two coding systems, and should return t if the first
412 one is \"less\" than the second.
414 The function `sort-coding-systems' use it.")
416 (defun sort-coding-systems (codings)
417 "Sort coding system list CODINGS by a priority of each coding system.
418 Return the sorted list. CODINGS is modified by side effects.
420 If a coding system is most preferred, it has the highest priority.
421 Otherwise, coding systems that correspond to MIME charsets have
422 higher priorities. Among them, a coding system included in the
423 `coding-system' key of the current language environment has higher
424 priority. See also the documentation of `language-info-alist'.
426 If the variable `sort-coding-systems-predicate' (which see) is
427 non-nil, it is used to sort CODINGS instead."
428 (if sort-coding-systems-predicate
429 (sort codings sort-coding-systems-predicate)
430 (let* ((from-priority (coding-system-priority-list))
431 (most-preferred (car from-priority))
432 (lang-preferred (get-language-info current-language-environment
433 'coding-system))
434 (func (function
435 (lambda (x)
436 (let ((base (coding-system-base x)))
437 ;; We calculate the priority number 0..255 by
438 ;; using the 8 bits PMMLCEII as this:
439 ;; P: 1 if most preferred.
440 ;; MM: greater than 0 if mime-charset.
441 ;; L: 1 if one of the current lang. env.'s codings.
442 ;; C: 1 if one of codings listed in the category list.
443 ;; E: 1 if not XXX-with-esc
444 ;; II: if iso-2022 based, 0..3, else 1.
445 (logior
446 (lsh (if (eq base most-preferred) 1 0) 7)
447 (lsh
448 (let ((mime (coding-system-get base :mime-charset)))
449 ;; Prefer coding systems corresponding to a
450 ;; MIME charset.
451 (if mime
452 ;; Lower utf-16 priority so that we
453 ;; normally prefer utf-8 to it, and put
454 ;; x-ctext below that.
455 (cond ((string-match "utf-16"
456 (symbol-name mime))
458 ((string-match "^x-" (symbol-name mime))
460 (t 3))
463 (lsh (if (memq base lang-preferred) 1 0) 4)
464 (lsh (if (memq base from-priority) 1 0) 3)
465 (lsh (if (string-match "-with-esc\\'"
466 (symbol-name base))
467 0 1) 2)
468 (if (eq (coding-system-type base) 'iso-2022)
469 (let ((category (coding-system-category base)))
470 ;; For ISO based coding systems, prefer
471 ;; one that doesn't use designation nor
472 ;; locking/single shifting.
473 (cond
474 ((or (eq category 'coding-category-iso-8-1)
475 (eq category 'coding-category-iso-8-2))
477 ((or (eq category 'coding-category-iso-7-tight)
478 (eq category 'coding-category-iso-7))
481 0)))
483 ))))))
484 (sort codings (function (lambda (x y)
485 (> (funcall func x) (funcall func y))))))))
487 (defun find-coding-systems-region (from to)
488 "Return a list of proper coding systems to encode a text between FROM and TO.
490 If FROM is a string, find coding systems in that instead of the buffer.
491 All coding systems in the list can safely encode any multibyte characters
492 in the text.
494 If the text contains no multibyte characters, return a list of a single
495 element `undecided'."
496 (let ((codings (find-coding-systems-region-internal from to)))
497 (if (eq codings t)
498 ;; The text contains only ASCII characters. Any coding
499 ;; systems are safe.
500 '(undecided)
501 ;; We need copy-sequence because sorting will alter the argument.
502 (sort-coding-systems (copy-sequence codings)))))
504 (defun find-coding-systems-string (string)
505 "Return a list of proper coding systems to encode STRING.
506 All coding systems in the list can safely encode any multibyte characters
507 in STRING.
509 If STRING contains no multibyte characters, return a list of a single
510 element `undecided'."
511 (find-coding-systems-region string nil))
513 (defun find-coding-systems-for-charsets (charsets)
514 "Return a list of proper coding systems to encode characters of CHARSETS.
515 CHARSETS is a list of character sets.
517 This only finds coding systems of type `charset', whose
518 `:charset-list' property includes all of CHARSETS (plus `ascii' for
519 ascii-compatible coding systems). It was used in older versions of
520 Emacs, but is unlikely to be what you really want now."
521 ;; Deal with aliases.
522 (setq charsets (mapcar (lambda (c)
523 (get-charset-property c :name))
524 charsets))
525 (cond ((or (null charsets)
526 (and (= (length charsets) 1)
527 (eq 'ascii (car charsets))))
528 '(undecided))
529 ((or (memq 'eight-bit-control charsets)
530 (memq 'eight-bit-graphic charsets))
531 '(raw-text utf-8-emacs))
533 (let (codings)
534 (dolist (cs (coding-system-list t))
535 (let ((cs-charsets (and (eq (coding-system-type cs) 'charset)
536 (coding-system-charset-list cs)))
537 (charsets charsets))
538 (if (coding-system-get cs :ascii-compatible-p)
539 (add-to-list 'cs-charsets 'ascii))
540 (if (catch 'ok
541 (when cs-charsets
542 (while charsets
543 (unless (memq (pop charsets) cs-charsets)
544 (throw 'ok nil)))
546 (push cs codings))))
547 (nreverse codings)))))
549 (defun find-multibyte-characters (from to &optional maxcount excludes)
550 "Find multibyte characters in the region specified by FROM and TO.
551 If FROM is a string, find multibyte characters in the string.
552 The return value is an alist of the following format:
553 ((CHARSET COUNT CHAR ...) ...)
554 where
555 CHARSET is a character set,
556 COUNT is a number of characters,
557 CHARs are the characters found from the character set.
558 Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list.
559 Optional 4th arg EXCLUDES is a list of character sets to be ignored."
560 (let ((chars nil)
561 charset char)
562 (if (stringp from)
563 (if (multibyte-string-p from)
564 (let ((idx 0))
565 (while (setq idx (string-match "[^\000-\177]" from idx))
566 (setq char (aref from idx)
567 charset (char-charset char))
568 (unless (memq charset excludes)
569 (let ((slot (assq charset chars)))
570 (if slot
571 (if (not (memq char (nthcdr 2 slot)))
572 (let ((count (nth 1 slot)))
573 (setcar (cdr slot) (1+ count))
574 (if (or (not maxcount) (< count maxcount))
575 (nconc slot (list char)))))
576 (setq chars (cons (list charset 1 char) chars)))))
577 (setq idx (1+ idx)))))
578 (if enable-multibyte-characters
579 (save-excursion
580 (goto-char from)
581 (while (re-search-forward "[^\000-\177]" to t)
582 (setq char (preceding-char)
583 charset (char-charset char))
584 (unless (memq charset excludes)
585 (let ((slot (assq charset chars)))
586 (if slot
587 (if (not (member char (nthcdr 2 slot)))
588 (let ((count (nth 1 slot)))
589 (setcar (cdr slot) (1+ count))
590 (if (or (not maxcount) (< count maxcount))
591 (nconc slot (list char)))))
592 (setq chars (cons (list charset 1 char) chars)))))))))
593 (nreverse chars)))
595 (defun search-unencodable-char (coding-system)
596 "Search forward from point for a character that is not encodable.
597 It asks which coding system to check.
598 If such a character is found, set point after that character.
599 Otherwise, don't move point.
601 When called from a program, the value is the position of the unencodable
602 character found, or nil if all characters are encodable."
603 (interactive
604 (list (let ((default (or buffer-file-coding-system 'us-ascii)))
605 (read-coding-system
606 (format "Coding-system (default %s): " default)
607 default))))
608 (let ((pos (unencodable-char-position (point) (point-max) coding-system)))
609 (if pos
610 (goto-char (1+ pos))
611 (message "All following characters are encodable by %s" coding-system))
612 pos))
614 (defvar last-coding-system-specified nil
615 "Most recent coding system explicitly specified by the user when asked.
616 This variable is set whenever Emacs asks the user which coding system
617 to use in order to write a file. If you set it to nil explicitly,
618 then call `write-region', then afterward this variable will be non-nil
619 only if the user was explicitly asked and specified a coding system.")
621 (defvar select-safe-coding-system-accept-default-p nil
622 "If non-nil, a function to control the behavior of coding system selection.
623 The meaning is the same as the argument ACCEPT-DEFAULT-P of the
624 function `select-safe-coding-system' (which see). This variable
625 overrides that argument.")
627 (defun select-safe-coding-system-interactively (from to codings unsafe
628 &optional rejected default)
629 "Select interactively a coding system for the region FROM ... TO.
630 FROM can be a string, as in `write-region'.
631 CODINGS is the list of base coding systems known to be safe for this region,
632 typically obtained with `find-coding-systems-region'.
633 UNSAFE is a list of coding systems known to be unsafe for this region.
634 REJECTED is a list of coding systems which were safe but for some reason
635 were not recommended in the particular context.
636 DEFAULT is the coding system to use by default in the query."
637 ;; At first, if some defaults are unsafe, record at most 11
638 ;; problematic characters and their positions for them by turning
639 ;; (CODING ...)
640 ;; into
641 ;; ((CODING (POS . CHAR) (POS . CHAR) ...) ...)
642 (if unsafe
643 (setq unsafe
644 (mapcar #'(lambda (coding)
645 (cons coding
646 (if (stringp from)
647 (mapcar #'(lambda (pos)
648 (cons pos (aref from pos)))
649 (unencodable-char-position
650 0 (length from) coding
651 11 from))
652 (mapcar #'(lambda (pos)
653 (cons pos (char-after pos)))
654 (unencodable-char-position
655 from to coding 11)))))
656 unsafe)))
658 ;; Change each safe coding system to the corresponding
659 ;; mime-charset name if it is also a coding system. Such a name
660 ;; is more friendly to users.
661 (let ((l codings)
662 mime-charset)
663 (while l
664 (setq mime-charset (coding-system-get (car l) :mime-charset))
665 (if (and mime-charset (coding-system-p mime-charset)
666 (coding-system-equal (car l) mime-charset))
667 (setcar l mime-charset))
668 (setq l (cdr l))))
670 ;; Don't offer variations with locking shift, which you
671 ;; basically never want.
672 (let (l)
673 (dolist (elt codings (setq codings (nreverse l)))
674 (unless (or (eq 'coding-category-iso-7-else
675 (coding-system-category elt))
676 (eq 'coding-category-iso-8-else
677 (coding-system-category elt)))
678 (push elt l))))
680 ;; Remove raw-text, emacs-mule and no-conversion unless nothing
681 ;; else is available.
682 (setq codings
683 (or (delq 'raw-text
684 (delq 'emacs-mule
685 (delq 'no-conversion codings)))
686 '(raw-text emacs-mule no-conversion)))
688 (let ((window-configuration (current-window-configuration))
689 (bufname (buffer-name))
690 coding-system)
691 (save-excursion
692 ;; If some defaults are unsafe, make sure the offending
693 ;; buffer is displayed.
694 (when (and unsafe (not (stringp from)))
695 (pop-to-buffer bufname)
696 (goto-char (apply 'min (mapcar #'(lambda (x) (car (cadr x)))
697 unsafe))))
698 ;; Then ask users to select one from CODINGS while showing
699 ;; the reason why none of the defaults are not used.
700 (with-output-to-temp-buffer "*Warning*"
701 (with-current-buffer standard-output
702 (if (and (null rejected) (null unsafe))
703 (insert "No default coding systems to try for "
704 (if (stringp from)
705 (format "string \"%s\"." from)
706 (format "buffer `%s'." bufname)))
707 (insert
708 "These default coding systems were tried to encode"
709 (if (stringp from)
710 (concat " \"" (if (> (length from) 10)
711 (concat (substring from 0 10) "...\"")
712 (concat from "\"")))
713 (format " text\nin the buffer `%s'" bufname))
714 ":\n")
715 (let ((pos (point))
716 (fill-prefix " "))
717 (dolist (x (append rejected unsafe))
718 (princ " ") (princ x))
719 (insert "\n")
720 (fill-region-as-paragraph pos (point)))
721 (when rejected
722 (insert "These safely encode the text in the buffer,
723 but are not recommended for encoding text in this context,
724 e.g., for sending an email message.\n ")
725 (dolist (x rejected)
726 (princ " ") (princ x))
727 (insert "\n"))
728 (when unsafe
729 (insert (if rejected "The other coding systems"
730 "However, each of them")
731 " encountered characters it couldn't encode:\n")
732 (dolist (coding unsafe)
733 (insert (format " %s cannot encode these:" (car coding)))
734 (let ((i 0)
735 (func1
736 #'(lambda (bufname pos)
737 (when (buffer-live-p (get-buffer bufname))
738 (pop-to-buffer bufname)
739 (goto-char pos))))
740 (func2
741 #'(lambda (bufname pos coding)
742 (when (buffer-live-p (get-buffer bufname))
743 (pop-to-buffer bufname)
744 (if (< (point) pos)
745 (goto-char pos)
746 (forward-char 1)
747 (search-unencodable-char coding)
748 (forward-char -1))))))
749 (dolist (elt (cdr coding))
750 (insert " ")
751 (if (stringp from)
752 (insert (if (< i 10) (cdr elt) "..."))
753 (if (< i 10)
754 (insert-text-button
755 (cdr elt)
756 :type 'help-xref
757 'face 'link
758 'help-echo
759 "mouse-2, RET: jump to this character"
760 'help-function func1
761 'help-args (list bufname (car elt)))
762 (insert-text-button
763 "..."
764 :type 'help-xref
765 'face 'link
766 'help-echo
767 "mouse-2, RET: next unencodable character"
768 'help-function func2
769 'help-args (list bufname (car elt)
770 (car coding)))))
771 (setq i (1+ i))))
772 (insert "\n"))
773 (insert (substitute-command-keys "\
775 Click on a character (or switch to this window by `\\[other-window]'\n\
776 and select the characters by RET) to jump to the place it appears,\n\
777 where `\\[universal-argument] \\[what-cursor-position]' will give information about it.\n"))))
778 (insert (substitute-command-keys "\nSelect \
779 one of the safe coding systems listed below,\n\
780 or cancel the writing with \\[keyboard-quit] and edit the buffer\n\
781 to remove or modify the problematic characters,\n\
782 or specify any other coding system (and risk losing\n\
783 the problematic characters).\n\n"))
784 (let ((pos (point))
785 (fill-prefix " "))
786 (dolist (x codings)
787 (princ " ") (princ x))
788 (insert "\n")
789 (fill-region-as-paragraph pos (point)))))
791 ;; Read a coding system.
792 (setq coding-system
793 (read-coding-system
794 (format "Select coding system (default %s): " default)
795 default))
796 (setq last-coding-system-specified coding-system))
798 (kill-buffer "*Warning*")
799 (set-window-configuration window-configuration)
800 coding-system))
802 (defun select-safe-coding-system (from to &optional default-coding-system
803 accept-default-p file)
804 "Ask a user to select a safe coding system from candidates.
805 The candidates of coding systems which can safely encode a text
806 between FROM and TO are shown in a popup window. Among them, the most
807 proper one is suggested as the default.
809 The list of `buffer-file-coding-system' of the current buffer,
810 the `default-buffer-file-coding-system', and the
811 most preferred coding system (if it corresponds to a MIME charset) is
812 treated as the default coding system list. Among them, the first one
813 that safely encodes the text is normally selected silently and
814 returned without any user interaction. See also the command
815 `prefer-coding-system'.
817 However, the user is queried if the chosen coding system is
818 inconsistent with what would be selected by `find-auto-coding' from
819 coding cookies &c. if the contents of the region were read from a
820 file. (That could lead to data corruption in a file subsequently
821 re-visited and edited.)
823 Optional 3rd arg DEFAULT-CODING-SYSTEM specifies a coding system or a
824 list of coding systems to be prepended to the default coding system
825 list. However, if DEFAULT-CODING-SYSTEM is a list and the first
826 element is t, the cdr part is used as the default coding system list,
827 i.e. `buffer-file-coding-system', `default-buffer-file-coding-system',
828 and the most preferred coding system are not used.
830 Optional 4th arg ACCEPT-DEFAULT-P, if non-nil, is a function to
831 determine the acceptability of the silently selected coding system.
832 It is called with that coding system, and should return nil if it
833 should not be silently selected and thus user interaction is required.
835 Optional 5th arg FILE is the file name to use for this purpose.
836 That is different from `buffer-file-name' when handling `write-region'
837 \(for example).
839 The variable `select-safe-coding-system-accept-default-p', if
840 non-nil, overrides ACCEPT-DEFAULT-P.
842 Kludgy feature: if FROM is a string, the string is the target text,
843 and TO is ignored."
844 (if (and default-coding-system
845 (not (listp default-coding-system)))
846 (setq default-coding-system (list default-coding-system)))
848 (let ((no-other-defaults nil)
849 auto-cs)
850 (unless (or (stringp from) find-file-literally)
851 ;; Find an auto-coding that is specified for the the current
852 ;; buffer and file from the region FROM and TO.
853 (save-excursion
854 (save-restriction
855 (widen)
856 (goto-char from)
857 (setq auto-cs (find-auto-coding (or file buffer-file-name "")
858 (- to from)))
859 (if auto-cs
860 (if (coding-system-p (car auto-cs))
861 (setq auto-cs (car auto-cs))
862 (display-warning
863 :warning
864 (format "\
865 Invalid coding system `%s' is specified
866 for the current buffer/file by the %s.
867 It is highly recommended to fix it before writing to a file."
868 (car auto-cs)
869 (if (eq (cdr auto-cs) :coding) ":coding tag"
870 (format "variable `%s'" (cdr auto-cs)))))
871 (or (yes-or-no-p "Really proceed with writing? ")
872 (error "Save aborted"))
873 (setq auto-cs nil))))))
875 (if (eq (car default-coding-system) t)
876 (setq no-other-defaults t
877 default-coding-system (cdr default-coding-system)))
879 ;; Change elements of the list to (coding . base-coding).
880 (setq default-coding-system
881 (mapcar (function (lambda (x) (cons x (coding-system-base x))))
882 default-coding-system))
884 (if (and auto-cs (not no-other-defaults))
885 ;; If the file has a coding cookie, try to use it before anything
886 ;; else (i.e. before default-coding-system which will typically come
887 ;; from file-coding-system-alist).
888 (let ((base (coding-system-base auto-cs)))
889 (or (memq base '(nil undecided))
890 (rassq base default-coding-system)
891 (push (cons auto-cs base) default-coding-system))))
893 (unless no-other-defaults
894 ;; If buffer-file-coding-system is not nil nor undecided, append it
895 ;; to the defaults.
896 (if buffer-file-coding-system
897 (let ((base (coding-system-base buffer-file-coding-system)))
898 (or (eq base 'undecided)
899 (rassq base default-coding-system)
900 (setq default-coding-system
901 (append default-coding-system
902 (list (cons buffer-file-coding-system base)))))))
904 ;; If default-buffer-file-coding-system is not nil nor undecided,
905 ;; append it to the defaults.
906 (if default-buffer-file-coding-system
907 (let ((base (coding-system-base default-buffer-file-coding-system)))
908 (or (eq base 'undecided)
909 (rassq base default-coding-system)
910 (setq default-coding-system
911 (append default-coding-system
912 (list (cons default-buffer-file-coding-system
913 base)))))))
915 ;; If the most preferred coding system has the property mime-charset,
916 ;; append it to the defaults.
917 (let ((preferred (coding-system-priority-list t))
918 base)
919 (and (coding-system-p preferred)
920 (setq base (coding-system-base preferred))
921 (coding-system-get preferred :mime-charset)
922 (not (rassq base default-coding-system))
923 (setq default-coding-system
924 (append default-coding-system
925 (list (cons preferred base)))))))
927 (if select-safe-coding-system-accept-default-p
928 (setq accept-default-p select-safe-coding-system-accept-default-p))
930 ;; Decide the eol-type from the top of the default codings,
931 ;; buffer-file-coding-system, or
932 ;; default-buffer-file-coding-system.
933 (if default-coding-system
934 (let ((default-eol-type (coding-system-eol-type
935 (caar default-coding-system))))
936 (if (and (vectorp default-eol-type) buffer-file-coding-system)
937 (setq default-eol-type (coding-system-eol-type
938 buffer-file-coding-system)))
939 (if (and (vectorp default-eol-type) default-buffer-file-coding-system)
940 (setq default-eol-type (coding-system-eol-type
941 default-buffer-file-coding-system)))
942 (if (and default-eol-type (not (vectorp default-eol-type)))
943 (dolist (elt default-coding-system)
944 (setcar elt (coding-system-change-eol-conversion
945 (car elt) default-eol-type))))))
947 (let ((codings (find-coding-systems-region from to))
948 (coding-system nil)
949 safe rejected unsafe)
950 (if (eq (car codings) 'undecided)
951 ;; Any coding system is ok.
952 (setq coding-system (caar default-coding-system))
953 ;; Reverse the list so that elements are accumulated in safe,
954 ;; rejected, and unsafe in the correct order.
955 (setq default-coding-system (nreverse default-coding-system))
957 ;; Classify the defaults into safe, rejected, and unsafe.
958 (dolist (elt default-coding-system)
959 (if (or (eq (car codings) 'undecided)
960 (memq (cdr elt) codings))
961 (if (and (functionp accept-default-p)
962 (not (funcall accept-default-p (cdr elt))))
963 (push (car elt) rejected)
964 (push (car elt) safe))
965 (push (car elt) unsafe)))
966 (if safe
967 (setq coding-system (car safe))))
969 ;; If all the defaults failed, ask a user.
970 (when (not coding-system)
971 (setq coding-system (select-safe-coding-system-interactively
972 from to codings unsafe rejected (car codings))))
974 ;; Check we're not inconsistent with what `coding:' spec &c would
975 ;; give when file is re-read.
976 ;; But don't do this if we explicitly ignored the cookie
977 ;; by using `find-file-literally'.
978 (when (and auto-cs
979 (not (and
980 coding-system
981 (memq (coding-system-type coding-system) '(0 5)))))
982 ;; Merge coding-system and auto-cs as far as possible.
983 (if (not coding-system)
984 (setq coding-system auto-cs)
985 (if (not auto-cs)
986 (setq auto-cs coding-system)
987 (let ((eol-type-1 (coding-system-eol-type coding-system))
988 (eol-type-2 (coding-system-eol-type auto-cs)))
989 (if (eq (coding-system-base coding-system) 'undecided)
990 (setq coding-system (coding-system-change-text-conversion
991 coding-system auto-cs))
992 (if (eq (coding-system-base auto-cs) 'undecided)
993 (setq auto-cs (coding-system-change-text-conversion
994 auto-cs coding-system))))
995 (if (vectorp eol-type-1)
996 (or (vectorp eol-type-2)
997 (setq coding-system (coding-system-change-eol-conversion
998 coding-system eol-type-2)))
999 (if (vectorp eol-type-2)
1000 (setq auto-cs (coding-system-change-eol-conversion
1001 auto-cs eol-type-1)))))))
1003 (if (and auto-cs
1004 ;; Don't barf if writing a compressed file, say.
1005 ;; This check perhaps isn't ideal, but is probably
1006 ;; the best thing to do.
1007 (not (auto-coding-alist-lookup (or file buffer-file-name "")))
1008 (not (coding-system-equal coding-system auto-cs)))
1009 (unless (yes-or-no-p
1010 (format "Selected encoding %s disagrees with \
1011 %s specified by file contents. Really save (else edit coding cookies \
1012 and try again)? " coding-system auto-cs))
1013 (error "Save aborted"))))
1014 coding-system)))
1016 (setq select-safe-coding-system-function 'select-safe-coding-system)
1018 (defun select-message-coding-system ()
1019 "Return a coding system to encode the outgoing message of the current buffer.
1020 It at first tries the first coding system found in these variables
1021 in this order:
1022 (1) local value of `buffer-file-coding-system'
1023 (2) value of `sendmail-coding-system'
1024 (3) value of `default-sendmail-coding-system'
1025 (4) value of `default-buffer-file-coding-system'
1026 If the found coding system can't encode the current buffer,
1027 or none of them are bound to a coding system,
1028 it asks the user to select a proper coding system."
1029 (let ((coding (or (and (local-variable-p 'buffer-file-coding-system)
1030 buffer-file-coding-system)
1031 sendmail-coding-system
1032 default-sendmail-coding-system
1033 default-buffer-file-coding-system)))
1034 (if (eq coding 'no-conversion)
1035 ;; We should never use no-conversion for outgoing mail.
1036 (setq coding nil))
1037 (if (fboundp select-safe-coding-system-function)
1038 (funcall select-safe-coding-system-function
1039 (point-min) (point-max) coding
1040 (function (lambda (x) (coding-system-get x :mime-charset))))
1041 coding)))
1043 ;;; Language support stuff.
1045 (defvar language-info-alist nil
1046 "Alist of language environment definitions.
1047 Each element looks like:
1048 (LANGUAGE-NAME . ((KEY . INFO) ...))
1049 where LANGUAGE-NAME is a string, the name of the language environment,
1050 KEY is a symbol denoting the kind of information, and
1051 INFO is the data associated with KEY.
1052 Meaningful values for KEY include
1054 documentation value is documentation of what this language environment
1055 is meant for, and how to use it.
1056 charset value is a list of the character sets mainly used
1057 by this language environment.
1058 sample-text value is an expression which is evalled to generate
1059 a line of text written using characters appropriate
1060 for this language environment.
1061 setup-function value is a function to call to switch to this
1062 language environment.
1063 exit-function value is a function to call to leave this
1064 language environment.
1065 coding-system value is a list of coding systems that are good
1066 for saving text written in this language environment.
1067 This list serves as suggestions to the user;
1068 in effect, as a kind of documentation.
1069 coding-priority value is a list of coding systems for this language
1070 environment, in order of decreasing priority.
1071 This is used to set up the coding system priority
1072 list when you switch to this language environment.
1073 nonascii-translation
1074 value is a charset of dimension one to use for
1075 converting a unibyte character to multibyte
1076 and vice versa.
1077 input-method value is a default input method for this language
1078 environment.
1079 features value is a list of features requested in this
1080 language environment.
1081 ctext-non-standard-encodings
1082 value is a list of non-standard encoding
1083 names used in extended segments of CTEXT.
1084 See the variable
1085 `ctext-non-standard-encodings' for more
1086 detail.
1088 The following keys take effect only when multibyte characters are
1089 globally disabled, i.e. the value of `default-enable-multibyte-characters'
1090 is nil.
1092 unibyte-display value is a coding system to encode characters
1093 for the terminal. Characters in the range
1094 of 160 to 255 display not as octal escapes,
1095 but as non-ASCII characters in this language
1096 environment.")
1098 (defun get-language-info (lang-env key)
1099 "Return information listed under KEY for language environment LANG-ENV.
1100 KEY is a symbol denoting the kind of information.
1101 For a list of useful values for KEY and their meanings,
1102 see `language-info-alist'."
1103 (if (symbolp lang-env)
1104 (setq lang-env (symbol-name lang-env)))
1105 (let ((lang-slot (assoc-string lang-env language-info-alist t)))
1106 (if lang-slot
1107 (cdr (assq key (cdr lang-slot))))))
1109 (defun set-language-info (lang-env key info)
1110 "Modify part of the definition of language environment LANG-ENV.
1111 Specifically, this stores the information INFO under KEY
1112 in the definition of this language environment.
1113 KEY is a symbol denoting the kind of information.
1114 INFO is the value for that information.
1116 For a list of useful values for KEY and their meanings,
1117 see `language-info-alist'."
1118 (if (symbolp lang-env)
1119 (setq lang-env (symbol-name lang-env)))
1120 (set-language-info-internal lang-env key info)
1121 (if (equal lang-env current-language-environment)
1122 (cond ((eq key 'coding-priority)
1123 (set-language-environment-coding-systems lang-env)
1124 (set-language-environment-charset lang-env))
1125 ((eq key 'input-method)
1126 (set-language-environment-input-method lang-env))
1127 ((eq key 'nonascii-translation)
1128 (set-language-environment-nonascii-translation lang-env))
1129 ((eq key 'charset)
1130 (set-language-environment-charset lang-env))
1131 ((and (not default-enable-multibyte-characters)
1132 (or (eq key 'unibyte-syntax) (eq key 'unibyte-display)))
1133 (set-language-environment-unibyte lang-env)))))
1135 (defun set-language-info-internal (lang-env key info)
1136 "Internal use only.
1137 Arguments are the same as `set-language-info'."
1138 (let (lang-slot key-slot)
1139 (setq lang-slot (assoc lang-env language-info-alist))
1140 (if (null lang-slot) ; If no slot for the language, add it.
1141 (setq lang-slot (list lang-env)
1142 language-info-alist (cons lang-slot language-info-alist)))
1143 (setq key-slot (assq key lang-slot))
1144 (if (null key-slot) ; If no slot for the key, add it.
1145 (progn
1146 (setq key-slot (list key))
1147 (setcdr lang-slot (cons key-slot (cdr lang-slot)))))
1148 (setcdr key-slot (purecopy info))
1149 ;; Update the custom-type of `current-language-environment'.
1150 (put 'current-language-environment 'custom-type
1151 (cons 'choice (mapcar
1152 (lambda (lang)
1153 (list 'const lang))
1154 (sort (mapcar 'car language-info-alist) 'string<))))))
1156 (defun set-language-info-alist (lang-env alist &optional parents)
1157 "Store ALIST as the definition of language environment LANG-ENV.
1158 ALIST is an alist of KEY and INFO values. See the documentation of
1159 `language-info-alist' for the meanings of KEY and INFO.
1161 Optional arg PARENTS is a list of parent menu names; it specifies
1162 where to put this language environment in the
1163 Describe Language Environment and Set Language Environment menus.
1164 For example, (\"European\") means to put this language environment
1165 in the European submenu in each of those two menus."
1166 (if (symbolp lang-env)
1167 (setq lang-env (symbol-name lang-env)))
1168 (let ((describe-map describe-language-environment-map)
1169 (setup-map setup-language-environment-map))
1170 (if parents
1171 (let ((l parents)
1172 map parent-symbol parent prompt)
1173 (while l
1174 (if (symbolp (setq parent-symbol (car l)))
1175 (setq parent (symbol-name parent))
1176 (setq parent parent-symbol parent-symbol (intern parent)))
1177 (setq map (lookup-key describe-map (vector parent-symbol)))
1178 ;; This prompt string is for define-prefix-command, so
1179 ;; that the map it creates will be suitable for a menu.
1180 (or map (setq prompt (format "%s Environment" parent)))
1181 (if (not map)
1182 (progn
1183 (setq map (intern (format "describe-%s-environment-map"
1184 (downcase parent))))
1185 (define-prefix-command map nil prompt)
1186 (define-key-after describe-map (vector parent-symbol)
1187 (cons parent map) t)))
1188 (setq describe-map (symbol-value map))
1189 (setq map (lookup-key setup-map (vector parent-symbol)))
1190 (if (not map)
1191 (progn
1192 (setq map (intern (format "setup-%s-environment-map"
1193 (downcase parent))))
1194 (define-prefix-command map nil prompt)
1195 (define-key-after setup-map (vector parent-symbol)
1196 (cons parent map) t)))
1197 (setq setup-map (symbol-value map))
1198 (setq l (cdr l)))))
1200 ;; Set up menu items for this language env.
1201 (let ((doc (assq 'documentation alist)))
1202 (when doc
1203 (define-key-after describe-map (vector (intern lang-env))
1204 (cons lang-env 'describe-specified-language-support) t)))
1205 (define-key-after setup-map (vector (intern lang-env))
1206 (cons lang-env 'setup-specified-language-environment) t)
1208 (dolist (elt alist)
1209 (set-language-info-internal lang-env (car elt) (cdr elt)))
1211 (if (equal lang-env current-language-environment)
1212 (set-language-environment lang-env))))
1214 (defun read-language-name (key prompt &optional default)
1215 "Read a language environment name which has information for KEY.
1216 If KEY is nil, read any language environment.
1217 Prompt with PROMPT. DEFAULT is the default choice of language environment.
1218 This returns a language environment name as a string."
1219 (let* ((completion-ignore-case t)
1220 (name (completing-read prompt
1221 language-info-alist
1222 (and key
1223 (function (lambda (elm) (and (listp elm) (assq key elm)))))
1224 t nil nil default)))
1225 (if (and (> (length name) 0)
1226 (or (not key)
1227 (get-language-info name key)))
1228 name)))
1230 ;;; Multilingual input methods.
1231 (defgroup leim nil
1232 "LEIM: Libraries of Emacs Input Methods."
1233 :group 'mule)
1235 (defconst leim-list-file-name "leim-list.el"
1236 "Name of LEIM list file.
1237 This file contains a list of libraries of Emacs input methods (LEIM)
1238 in the format of Lisp expression for registering each input method.
1239 Emacs loads this file at startup time.")
1241 (defvar leim-list-header (format
1242 ";;; %s -- list of LEIM (Library of Emacs Input Method) -*-coding: iso-2022-7bit;-*-
1244 ;; This file contains a list of LEIM (Library of Emacs Input Method)
1245 ;; methods in the same directory as this file. Loading this file
1246 ;; registers all the input methods in Emacs.
1248 ;; Each entry has the form:
1249 ;; (register-input-method
1250 ;; INPUT-METHOD LANGUAGE-NAME ACTIVATE-FUNC
1251 ;; TITLE DESCRIPTION
1252 ;; ARG ...)
1253 ;; See the function `register-input-method' for the meanings of the arguments.
1255 ;; If this directory is included in load-path, Emacs automatically
1256 ;; loads this file at startup time.
1259 leim-list-file-name)
1260 "Header to be inserted in LEIM list file.")
1262 (defvar leim-list-entry-regexp "^(register-input-method"
1263 "Regexp matching head of each entry in LEIM list file.
1264 See also the variable `leim-list-header'.")
1266 (defvar update-leim-list-functions
1267 '(quail-update-leim-list-file)
1268 "List of functions to call to update LEIM list file.
1269 Each function is called with one arg, LEIM directory name.")
1271 (defun update-leim-list-file (&rest dirs)
1272 "Update LEIM list file in directories DIRS."
1273 (let ((functions update-leim-list-functions))
1274 (while functions
1275 (apply (car functions) dirs)
1276 (setq functions (cdr functions)))))
1278 (defvar current-input-method nil
1279 "The current input method for multilingual text.
1280 If nil, that means no input method is activated now.")
1281 (make-variable-buffer-local 'current-input-method)
1282 (put 'current-input-method 'permanent-local t)
1284 (defvar current-input-method-title nil
1285 "Title string of the current input method shown in mode line.")
1286 (make-variable-buffer-local 'current-input-method-title)
1287 (put 'current-input-method-title 'permanent-local t)
1289 (defcustom default-input-method nil
1290 "Default input method for multilingual text (a string).
1291 This is the input method activated automatically by the command
1292 `toggle-input-method' (\\[toggle-input-method])."
1293 :link '(custom-manual "(emacs)Input Methods")
1294 :group 'mule
1295 :type '(choice (const nil) (string
1296 :completion-ignore-case t
1297 :complete-function widget-string-complete
1298 :completion-alist input-method-alist
1299 :prompt-history input-method-history))
1300 :set-after '(current-language-environment))
1302 (put 'input-method-function 'permanent-local t)
1304 (defvar input-method-history nil
1305 "History list for some commands that read input methods.")
1306 (make-variable-buffer-local 'input-method-history)
1307 (put 'input-method-history 'permanent-local t)
1309 (defvar inactivate-current-input-method-function nil
1310 "Function to call for inactivating the current input method.
1311 Every input method should set this to an appropriate value when activated.
1312 This function is called with no argument.
1314 This function should never change the value of `current-input-method'.
1315 It is set to nil by the function `inactivate-input-method'.")
1316 (make-variable-buffer-local 'inactivate-current-input-method-function)
1317 (put 'inactivate-current-input-method-function 'permanent-local t)
1319 (defvar describe-current-input-method-function nil
1320 "Function to call for describing the current input method.
1321 This function is called with no argument.")
1322 (make-variable-buffer-local 'describe-current-input-method-function)
1323 (put 'describe-current-input-method-function 'permanent-local t)
1325 (defvar input-method-alist nil
1326 "Alist of input method names vs how to use them.
1327 Each element has the form:
1328 (INPUT-METHOD LANGUAGE-ENV ACTIVATE-FUNC TITLE DESCRIPTION ARGS...)
1329 See the function `register-input-method' for the meanings of the elements.")
1331 (defun register-input-method (input-method lang-env &rest args)
1332 "Register INPUT-METHOD as an input method for language environment LANG-ENV.
1334 INPUT-METHOD and LANG-ENV are symbols or strings.
1335 ACTIVATE-FUNC is a function to call to activate this method.
1336 TITLE is a string to show in the mode line when this method is active.
1337 DESCRIPTION is a string describing this method and what it is good for.
1338 The ARGS, if any, are passed as arguments to ACTIVATE-FUNC.
1339 All told, the arguments to ACTIVATE-FUNC are INPUT-METHOD and the ARGS.
1341 This function is mainly used in the file \"leim-list.el\" which is
1342 created at Emacs build time, registering all Quail input methods
1343 contained in the Emacs distribution.
1345 In case you want to register a new Quail input method by yourself, be
1346 careful to use the same input method title as given in the third
1347 parameter of `quail-define-package'. (If the values are different, the
1348 string specified in this function takes precedence.)
1350 The commands `describe-input-method' and `list-input-methods' need
1351 these duplicated values to show some information about input methods
1352 without loading the relevant Quail packages.
1353 \n(fn INPUT-METHOD LANG-ENV ACTIVATE-FUNC TITLE DESCRIPTION &rest ARGS)"
1354 (if (symbolp lang-env)
1355 (setq lang-env (symbol-name lang-env)))
1356 (if (symbolp input-method)
1357 (setq input-method (symbol-name input-method)))
1358 (let ((info (cons lang-env args))
1359 (slot (assoc input-method input-method-alist)))
1360 (if slot
1361 (setcdr slot info)
1362 (setq slot (cons input-method info))
1363 (setq input-method-alist (cons slot input-method-alist)))))
1365 (defun read-input-method-name (prompt &optional default inhibit-null)
1366 "Read a name of input method from a minibuffer prompting with PROMPT.
1367 If DEFAULT is non-nil, use that as the default,
1368 and substitute it into PROMPT at the first `%s'.
1369 If INHIBIT-NULL is non-nil, null input signals an error.
1371 The return value is a string."
1372 (if default
1373 (setq prompt (format prompt default)))
1374 (let* ((completion-ignore-case t)
1375 ;; As it is quite normal to change input method in the
1376 ;; minibuffer, we must enable it even if
1377 ;; enable-recursive-minibuffers is currently nil.
1378 (enable-recursive-minibuffers t)
1379 ;; This binding is necessary because input-method-history is
1380 ;; buffer local.
1381 (input-method (completing-read prompt input-method-alist
1382 nil t nil 'input-method-history
1383 default)))
1384 (if (and input-method (symbolp input-method))
1385 (setq input-method (symbol-name input-method)))
1386 (if (> (length input-method) 0)
1387 input-method
1388 (if inhibit-null
1389 (error "No valid input method is specified")))))
1391 (defun activate-input-method (input-method)
1392 "Switch to input method INPUT-METHOD for the current buffer.
1393 If some other input method is already active, turn it off first.
1394 If INPUT-METHOD is nil, deactivate any current input method."
1395 (if (and input-method (symbolp input-method))
1396 (setq input-method (symbol-name input-method)))
1397 (if (and current-input-method
1398 (not (string= current-input-method input-method)))
1399 (inactivate-input-method))
1400 (unless (or current-input-method (null input-method))
1401 (let ((slot (assoc input-method input-method-alist)))
1402 (if (null slot)
1403 (error "Can't activate input method `%s'" input-method))
1404 (setq current-input-method-title nil)
1405 (let ((func (nth 2 slot)))
1406 (if (functionp func)
1407 (apply (nth 2 slot) input-method (nthcdr 5 slot))
1408 (if (and (consp func) (symbolp (car func)) (symbolp (cdr func)))
1409 (progn
1410 (require (cdr func))
1411 (apply (car func) input-method (nthcdr 5 slot)))
1412 (error "Can't activate input method `%s'" input-method))))
1413 (setq current-input-method input-method)
1414 (or (stringp current-input-method-title)
1415 (setq current-input-method-title (nth 3 slot)))
1416 (unwind-protect
1417 (run-hooks 'input-method-activate-hook)
1418 (force-mode-line-update)))))
1420 (defun inactivate-input-method ()
1421 "Turn off the current input method."
1422 (when current-input-method
1423 (if input-method-history
1424 (unless (string= current-input-method (car input-method-history))
1425 (setq input-method-history
1426 (cons current-input-method
1427 (delete current-input-method input-method-history))))
1428 (setq input-method-history (list current-input-method)))
1429 (unwind-protect
1430 (progn
1431 (setq input-method-function nil
1432 current-input-method-title nil)
1433 (funcall inactivate-current-input-method-function))
1434 (unwind-protect
1435 (run-hooks 'input-method-inactivate-hook)
1436 (setq current-input-method nil)
1437 (force-mode-line-update)))))
1439 (defun set-input-method (input-method &optional interactive)
1440 "Select and activate input method INPUT-METHOD for the current buffer.
1441 This also sets the default input method to the one you specify.
1442 If INPUT-METHOD is nil, this function turns off the input method, and
1443 also causes you to be prompted for a name of an input method the next
1444 time you invoke \\[toggle-input-method].
1445 When called interactively, the optional arg INTERACTIVE is non-nil,
1446 which marks the variable `default-input-method' as set for Custom buffers.
1448 To deactivate the input method interactively, use \\[toggle-input-method].
1449 To deactivate it programmatically, use `inactivate-input-method'."
1450 (interactive
1451 (let* ((default (or (car input-method-history) default-input-method)))
1452 (list (read-input-method-name
1453 (if default "Select input method (default %s): " "Select input method: ")
1454 default t)
1455 t)))
1456 (activate-input-method input-method)
1457 (setq default-input-method input-method)
1458 (when interactive
1459 (customize-mark-as-set 'default-input-method))
1460 default-input-method)
1462 (defun toggle-input-method (&optional arg interactive)
1463 "Enable or disable multilingual text input method for the current buffer.
1464 Only one input method can be enabled at any time in a given buffer.
1466 The normal action is to enable an input method if none was
1467 enabled, and disable the current one otherwise. Which input method
1468 to enable can be determined in various ways--either the one most
1469 recently used, or the one specified by `default-input-method', or
1470 as a last resort by reading the name of an input method in the
1471 minibuffer.
1473 With a prefix argument, read an input method name with the minibuffer
1474 and enable that one. The default is the most recent input method specified
1475 \(not including the currently active input method, if any).
1477 When called interactively, the optional arg INTERACTIVE is non-nil,
1478 which marks the variable `default-input-method' as set for Custom buffers."
1480 (interactive "P\np")
1481 (if (and current-input-method (not arg))
1482 (inactivate-input-method)
1483 (let ((default (or (car input-method-history) default-input-method)))
1484 (if (and arg default (equal current-input-method default)
1485 (> (length input-method-history) 1))
1486 (setq default (nth 1 input-method-history)))
1487 (activate-input-method
1488 (if (or arg (not default))
1489 (progn
1490 (read-input-method-name
1491 (if default "Input method (default %s): " "Input method: " )
1492 default t))
1493 default))
1494 (unless default-input-method
1495 (prog1
1496 (setq default-input-method current-input-method)
1497 (when interactive
1498 (customize-mark-as-set 'default-input-method)))))))
1500 (eval-when-compile (autoload 'help-buffer "help-mode"))
1502 (defun describe-input-method (input-method)
1503 "Describe input method INPUT-METHOD."
1504 (interactive
1505 (list (read-input-method-name
1506 "Describe input method (default current choice): ")))
1507 (if (and input-method (symbolp input-method))
1508 (setq input-method (symbol-name input-method)))
1509 (help-setup-xref (list #'describe-input-method
1510 (or input-method current-input-method))
1511 (interactive-p))
1513 (if (null input-method)
1514 (describe-current-input-method)
1515 (let ((current current-input-method))
1516 (condition-case nil
1517 (progn
1518 (save-excursion
1519 (activate-input-method input-method)
1520 (describe-current-input-method))
1521 (activate-input-method current))
1522 (error
1523 (activate-input-method current)
1524 (help-setup-xref (list #'describe-input-method input-method)
1525 (interactive-p))
1526 (with-output-to-temp-buffer (help-buffer)
1527 (let ((elt (assoc input-method input-method-alist)))
1528 (princ (format
1529 "Input method: %s (`%s' in mode line) for %s\n %s\n"
1530 input-method (nth 3 elt) (nth 1 elt) (nth 4 elt))))))))))
1532 (defun describe-current-input-method ()
1533 "Describe the input method currently in use.
1534 This is a subroutine for `describe-input-method'."
1535 (if current-input-method
1536 (if (and (symbolp describe-current-input-method-function)
1537 (fboundp describe-current-input-method-function))
1538 (funcall describe-current-input-method-function)
1539 (message "No way to describe the current input method `%s'"
1540 current-input-method)
1541 (ding))
1542 (error "No input method is activated now")))
1544 (defun read-multilingual-string (prompt &optional initial-input input-method)
1545 "Read a multilingual string from minibuffer, prompting with string PROMPT.
1546 The input method selected last time is activated in minibuffer.
1547 If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
1548 initially.
1549 Optional 3rd argument INPUT-METHOD specifies the input method
1550 to be activated instead of the one selected last time. It is a symbol
1551 or a string."
1552 (setq input-method
1553 (or input-method
1554 current-input-method
1555 default-input-method
1556 (read-input-method-name "Input method: " nil t)))
1557 (if (and input-method (symbolp input-method))
1558 (setq input-method (symbol-name input-method)))
1559 (let ((prev-input-method current-input-method))
1560 (unwind-protect
1561 (progn
1562 (activate-input-method input-method)
1563 (read-string prompt initial-input nil nil t))
1564 (activate-input-method prev-input-method))))
1566 ;; Variables to control behavior of input methods. All input methods
1567 ;; should react to these variables.
1569 (defcustom input-method-verbose-flag 'default
1570 "A flag to control extra guidance given by input methods.
1571 The value should be nil, t, `complex-only', or `default'.
1573 The extra guidance is done by showing list of available keys in echo
1574 area. When you use the input method in the minibuffer, the guidance
1575 is shown at the bottom short window (split from the existing window).
1577 If the value is t, extra guidance is always given, if the value is
1578 nil, extra guidance is always suppressed.
1580 If the value is `complex-only', only complex input methods such as
1581 `chinese-py' and `japanese' give extra guidance.
1583 If the value is `default', complex input methods always give extra
1584 guidance, but simple input methods give it only when you are not in
1585 the minibuffer.
1587 See also the variable `input-method-highlight-flag'."
1588 :type '(choice (const :tag "Always" t) (const :tag "Never" nil)
1589 (const complex-only) (const default))
1590 :group 'mule)
1592 (defcustom input-method-highlight-flag t
1593 "If this flag is non-nil, input methods highlight partially-entered text.
1594 For instance, while you are in the middle of a Quail input method sequence,
1595 the text inserted so far is temporarily underlined.
1596 The underlining goes away when you finish or abort the input method sequence.
1597 See also the variable `input-method-verbose-flag'."
1598 :type 'boolean
1599 :group 'mule)
1601 (defcustom input-method-activate-hook nil
1602 "Normal hook run just after an input method is activated.
1604 The variable `current-input-method' keeps the input method name
1605 just activated."
1606 :type 'hook
1607 :group 'mule)
1609 (defcustom input-method-inactivate-hook nil
1610 "Normal hook run just after an input method is inactivated.
1612 The variable `current-input-method' still keeps the input method name
1613 just inactivated."
1614 :type 'hook
1615 :group 'mule)
1617 (defcustom input-method-after-insert-chunk-hook nil
1618 "Normal hook run just after an input method insert some chunk of text."
1619 :type 'hook
1620 :group 'mule)
1622 (defvar input-method-exit-on-first-char nil
1623 "This flag controls when an input method returns.
1624 Usually, the input method does not return while there's a possibility
1625 that it may find a different translation if a user types another key.
1626 But, if this flag is non-nil, the input method returns as soon as
1627 the current key sequence gets long enough to have some valid translation.")
1629 (defcustom input-method-use-echo-area nil
1630 "This flag controls how an input method shows an intermediate key sequence.
1631 Usually, the input method inserts the intermediate key sequence,
1632 or candidate translations corresponding to the sequence,
1633 at point in the current buffer.
1634 But, if this flag is non-nil, it displays them in echo area instead."
1635 :type 'hook
1636 :group 'mule)
1638 (defvar input-method-exit-on-invalid-key nil
1639 "This flag controls the behavior of an input method on invalid key input.
1640 Usually, when a user types a key which doesn't start any character
1641 handled by the input method, the key is handled by turning off the
1642 input method temporarily. After that key, the input method is re-enabled.
1643 But, if this flag is non-nil, the input method is never back on.")
1646 (defcustom set-language-environment-hook nil
1647 "Normal hook run after some language environment is set.
1649 When you set some hook function here, that effect usually should not
1650 be inherited to another language environment. So, you had better set
1651 another function in `exit-language-environment-hook' (which see) to
1652 cancel the effect."
1653 :type 'hook
1654 :group 'mule)
1656 (defcustom exit-language-environment-hook nil
1657 "Normal hook run after exiting from some language environment.
1658 When this hook is run, the variable `current-language-environment'
1659 is still bound to the language environment being exited.
1661 This hook is mainly used for canceling the effect of
1662 `set-language-environment-hook' (which see)."
1663 :type 'hook
1664 :group 'mule)
1666 (put 'setup-specified-language-environment 'apropos-inhibit t)
1668 (defun setup-specified-language-environment ()
1669 "Switch to a specified language environment."
1670 (interactive)
1671 (let (language-name)
1672 (if (and (symbolp last-command-event)
1673 (or (not (eq last-command-event 'Default))
1674 (setq last-command-event 'English))
1675 (setq language-name (symbol-name last-command-event)))
1676 (prog1
1677 (set-language-environment language-name)
1678 (customize-mark-as-set 'current-language-environment))
1679 (error "Bogus calling sequence"))))
1681 (defcustom current-language-environment "English"
1682 "The last language environment specified with `set-language-environment'.
1683 This variable should be set only with \\[customize], which is equivalent
1684 to using the function `set-language-environment'."
1685 :link '(custom-manual "(emacs)Language Environments")
1686 :set (lambda (symbol value) (set-language-environment value))
1687 :get (lambda (x)
1688 (or (car-safe (assoc-string
1689 (if (symbolp current-language-environment)
1690 (symbol-name current-language-environment)
1691 current-language-environment)
1692 language-info-alist t))
1693 "English"))
1694 ;; custom type will be updated with `set-language-info'.
1695 :type (if language-info-alist
1696 (cons 'choice (mapcar
1697 (lambda (lang)
1698 (list 'const lang))
1699 (sort (mapcar 'car language-info-alist) 'string<)))
1700 'string)
1701 :initialize 'custom-initialize-default
1702 :group 'mule)
1704 (defun reset-language-environment ()
1705 "Reset multilingual environment of Emacs to the default status.
1707 The default status is as follows:
1709 The default value of `buffer-file-coding-system' is nil.
1710 The default coding system for process I/O is nil.
1711 The default value for the command `set-terminal-coding-system' is nil.
1712 The default value for the command `set-keyboard-coding-system' is nil.
1714 The order of priorities of coding systems are as follows:
1715 utf-8
1716 iso-2022-7bit
1717 iso-latin-1
1718 iso-2022-7bit-lock
1719 iso-2022-8bit-ss2
1720 emacs-mule
1721 raw-text"
1722 (interactive)
1723 ;; This function formerly set default-enable-multibyte-characters to t,
1724 ;; but that is incorrect. It should not alter the unibyte/multibyte choice.
1726 (set-coding-system-priority
1727 'utf-8
1728 'iso-2022-7bit
1729 'iso-latin-1
1730 'iso-2022-7bit-lock
1731 'iso-2022-8bit-ss2
1732 'emacs-mule
1733 'raw-text)
1735 (set-default-coding-systems nil)
1736 (setq default-sendmail-coding-system 'iso-latin-1)
1737 ;; On Darwin systems, this should be utf-8, but when this file is loaded
1738 ;; utf-8 is not yet defined, so we set it in set-locale-environment instead.
1739 (setq default-file-name-coding-system 'iso-latin-1)
1740 ;; Preserve eol-type from existing default-process-coding-systems.
1741 ;; On non-unix-like systems in particular, these may have been set
1742 ;; carefully by the user, or by the startup code, to deal with the
1743 ;; users shell appropriately, so should not be altered by changing
1744 ;; language environment.
1745 (let ((output-coding
1746 ;; When bootstrapping, coding-systems are not defined yet, so
1747 ;; we need to catch the error from check-coding-system.
1748 (condition-case nil
1749 (coding-system-change-text-conversion
1750 (car default-process-coding-system) 'undecided)
1751 (coding-system-error 'undecided)))
1752 (input-coding
1753 (condition-case nil
1754 (coding-system-change-text-conversion
1755 (cdr default-process-coding-system) 'iso-latin-1)
1756 (coding-system-error 'iso-latin-1))))
1757 (setq default-process-coding-system
1758 (cons output-coding input-coding)))
1760 ;; Don't alter the terminal and keyboard coding systems here.
1761 ;; The terminal still supports the same coding system
1762 ;; that it supported a minute ago.
1763 ;; (set-terminal-coding-system-internal nil)
1764 ;; (set-keyboard-coding-system-internal nil)
1766 (set-unibyte-charset 'iso-8859-1))
1768 (reset-language-environment)
1770 (defun set-display-table-and-terminal-coding-system (language-name &optional coding-system display)
1771 "Set up the display table and terminal coding system for LANGUAGE-NAME."
1772 (let ((coding (get-language-info language-name 'unibyte-display)))
1773 (if (and coding
1774 (or (not coding-system)
1775 (coding-system-equal coding coding-system)))
1776 (standard-display-european-internal)
1777 ;; The following 2 lines undo the 8-bit display that we set up
1778 ;; in standard-display-european-internal, which see. This is in
1779 ;; case the user has used standard-display-european earlier in
1780 ;; this session. (The MS-DOS port doesn't use that setup, so it
1781 ;; doesn't need to undo it.)
1782 (when standard-display-table
1783 (dotimes (i 128)
1784 (aset standard-display-table (+ i 128) nil))))
1785 (or (eq window-system 'pc)
1786 (set-terminal-coding-system (or coding-system coding) display))))
1788 (defun set-language-environment (language-name)
1789 "Set up multi-lingual environment for using LANGUAGE-NAME.
1790 This sets the coding system priority and the default input method
1791 and sometimes other things. LANGUAGE-NAME should be a string
1792 which is the name of a language environment. For example, \"Latin-1\"
1793 specifies the character set for the major languages of Western Europe."
1794 (interactive (list (read-language-name
1796 "Set language environment (default English): ")))
1797 (if language-name
1798 (if (symbolp language-name)
1799 (setq language-name (symbol-name language-name)))
1800 (setq language-name "English"))
1801 (let ((slot (assoc-string language-name language-info-alist t)))
1802 (unless slot
1803 (error "Language environment not defined: %S" language-name))
1804 (setq language-name (car slot)))
1805 (if current-language-environment
1806 (let ((func (get-language-info current-language-environment
1807 'exit-function)))
1808 (run-hooks 'exit-language-environment-hook)
1809 (if (functionp func) (funcall func))))
1811 (reset-language-environment)
1812 ;; The features might set up coding systems.
1813 (let ((required-features (get-language-info language-name 'features)))
1814 (while required-features
1815 (require (car required-features))
1816 (setq required-features (cdr required-features))))
1818 (setq current-language-environment language-name)
1820 (set-language-environment-coding-systems language-name)
1821 (set-language-environment-input-method language-name)
1822 (set-language-environment-nonascii-translation language-name)
1823 (set-language-environment-charset language-name)
1824 ;; Unibyte setups if necessary.
1825 (unless default-enable-multibyte-characters
1826 (set-language-environment-unibyte language-name))
1828 (let ((func (get-language-info language-name 'setup-function)))
1829 (if (functionp func)
1830 (funcall func)))
1832 (run-hooks 'set-language-environment-hook)
1833 (force-mode-line-update t))
1835 (define-widget 'charset 'symbol
1836 "An Emacs charset."
1837 :tag "Charset"
1838 :complete-function (lambda ()
1839 (interactive)
1840 (lisp-complete-symbol 'charsetp))
1841 :completion-ignore-case t
1842 :value 'ascii
1843 :validate (lambda (widget)
1844 (unless (charsetp (widget-value widget))
1845 (widget-put widget :error (format "Invalid charset: %S"
1846 (widget-value widget)))
1847 widget))
1848 :prompt-history 'charset-history)
1850 (defcustom language-info-custom-alist nil
1851 "Customizations of language environment parameters.
1852 Value is an alist with elements like those of `language-info-alist'.
1853 These are used to set values in `language-info-alist' which replace
1854 the defaults. A typical use is replacing the default input method for
1855 the environment. Use \\[describe-language-environment] to find the environment's settings.
1857 This option is intended for use at startup. Removing items doesn't
1858 remove them from the language info until you next restart Emacs.
1860 Setting this variable directly does not take effect. See
1861 `set-language-info-alist' for use in programs."
1862 :group 'mule
1863 :version "23.1"
1864 :set (lambda (s v)
1865 (custom-set-default s v)
1866 ;; Can't do this before language environments are set up.
1867 (when v
1868 ;; modify language-info-alist
1869 (dolist (elt v)
1870 (set-language-info-alist (car elt) (cdr elt)))
1871 ;; re-set the environment in case its parameters changed
1872 (set-language-environment current-language-environment)))
1873 :type `(alist
1874 :key-type (string :tag "Language environment"
1875 :completion-ignore-case t
1876 :complete-function widget-string-complete
1877 :completion-alist language-info-alist)
1878 :value-type
1879 (alist :key-type symbol
1880 :options ((documentation string)
1881 (charset (repeat charset))
1882 (sample-text string)
1883 (setup-function function)
1884 (exit-function function)
1885 (coding-system (repeat coding-system))
1886 (coding-priority (repeat coding-system))
1887 (nonascii-translation charset)
1888 (input-method
1889 (string
1890 :completion-ignore-case t
1891 :complete-function widget-string-complete
1892 :completion-alist input-method-alist
1893 :prompt-history input-method-history))
1894 (features (repeat symbol))
1895 (unibyte-display coding-system)))))
1897 (defun standard-display-european-internal ()
1898 ;; Actually set up direct output of non-ASCII characters.
1899 (standard-display-8bit (if (eq window-system 'pc) 128 160) 255)
1900 ;; Unibyte Emacs on MS-DOS wants to display all 8-bit characters with
1901 ;; the native font, and codes 160 and 146 stand for something very
1902 ;; different there.
1903 (or (and (eq window-system 'pc) (not default-enable-multibyte-characters))
1904 (progn
1905 ;; Most X fonts used to do the wrong thing for latin-1 code 160.
1906 (unless (and (eq window-system 'x)
1907 ;; XFree86 4 has fixed the fonts.
1908 (string= "The XFree86 Project, Inc" (x-server-vendor))
1909 (> (aref (number-to-string (nth 2 (x-server-version))) 0)
1910 ?3))
1911 ;; Make non-line-break space display as a plain space.
1912 (aset standard-display-table 160 [32]))
1913 ;; Most Windows programs send out apostrophes as \222. Most X fonts
1914 ;; don't contain a character at that position. Map it to the ASCII
1915 ;; apostrophe. [This is actually RIGHT SINGLE QUOTATION MARK,
1916 ;; U+2019, normally from the windows-1252 character set. XFree 4
1917 ;; fonts probably have the appropriate glyph at this position,
1918 ;; so they could use standard-display-8bit. It's better to use a
1919 ;; proper windows-1252 coding system. --fx]
1920 (aset standard-display-table 146 [39]))))
1922 (defun set-language-environment-coding-systems (language-name)
1923 "Do various coding system setups for language environment LANGUAGE-NAME."
1924 (let* ((priority (get-language-info language-name 'coding-priority))
1925 (default-coding (car priority))
1926 (eol-type (coding-system-eol-type default-buffer-file-coding-system)))
1927 (when priority
1928 (set-default-coding-systems
1929 (if (memq eol-type '(0 1 2 unix dos mac))
1930 (coding-system-change-eol-conversion default-coding eol-type)
1931 default-coding))
1932 (setq default-sendmail-coding-system default-coding)
1933 (apply 'set-coding-system-priority priority))))
1935 (defun set-language-environment-input-method (language-name)
1936 "Do various input method setups for language environment LANGUAGE-NAME."
1937 (let ((input-method (get-language-info language-name 'input-method)))
1938 (when input-method
1939 (setq default-input-method input-method)
1940 (if input-method-history
1941 (setq input-method-history
1942 (cons input-method
1943 (delete input-method input-method-history)))))))
1945 (defun set-language-environment-nonascii-translation (language-name)
1946 "Do unibyte/multibyte translation setup for language environment LANGUAGE-NAME."
1947 ;; Note: For DOS, we assumed that the charset cpXXX is already
1948 ;; defined.
1949 (let ((nonascii (get-language-info language-name 'nonascii-translation)))
1950 (if (eq window-system 'pc)
1951 (setq nonascii (intern "cp%d" dos-codepage)))
1952 (or (and (charsetp nonascii)
1953 (get-charset-property nonascii :ascii-compatible-p))
1954 (setq nonascii 'iso-8859-1))
1955 (set-unibyte-charset nonascii)))
1957 (defun set-language-environment-charset (language-name)
1958 "Do various charset setups for language environment LANGUAGE-NAME."
1959 ;; Put higher priorities to such charsets that are supported by the
1960 ;; coding systems of higher priorities in this environment.
1961 (let ((charsets (get-language-info language-name 'charset)))
1962 (dolist (coding (get-language-info language-name 'coding-priority))
1963 (setq charsets (append charsets (coding-system-charset-list coding))))
1964 (if charsets
1965 (apply 'set-charset-priority charsets))))
1967 (defun set-language-environment-unibyte (language-name)
1968 "Do various unibyte-mode setups for language environment LANGUAGE-NAME."
1969 (set-display-table-and-terminal-coding-system language-name))
1971 (defsubst princ-list (&rest args)
1972 "Print all arguments with `princ', then print \"\\n\"."
1973 (while args (princ (car args)) (setq args (cdr args)))
1974 (princ "\n"))
1976 (put 'describe-specified-language-support 'apropos-inhibit t)
1978 ;; Print language-specific information such as input methods,
1979 ;; charsets, and coding systems. This function is intended to be
1980 ;; called from the menu:
1981 ;; [menu-bar mule describe-language-environment LANGUAGE]
1982 ;; and should not run it by `M-x describe-current-input-method-function'.
1983 (defun describe-specified-language-support ()
1984 "Describe how Emacs supports the specified language environment."
1985 (interactive)
1986 (let (language-name)
1987 (if (not (and (symbolp last-command-event)
1988 (or (not (eq last-command-event 'Default))
1989 (setq last-command-event 'English))
1990 (setq language-name (symbol-name last-command-event))))
1991 (error "Bogus calling sequence"))
1992 (describe-language-environment language-name)))
1994 (defun describe-language-environment (language-name)
1995 "Describe how Emacs supports language environment LANGUAGE-NAME."
1996 (interactive
1997 (list (read-language-name
1998 'documentation
1999 "Describe language environment (default current choice): ")))
2000 (if (null language-name)
2001 (setq language-name current-language-environment))
2002 (if (or (null language-name)
2003 (null (get-language-info language-name 'documentation)))
2004 (error "No documentation for the specified language"))
2005 (if (symbolp language-name)
2006 (setq language-name (symbol-name language-name)))
2007 (dolist (feature (get-language-info language-name 'features))
2008 (require feature))
2009 (let ((doc (get-language-info language-name 'documentation)))
2010 (help-setup-xref (list #'describe-language-environment language-name)
2011 (interactive-p))
2012 (with-output-to-temp-buffer (help-buffer)
2013 (save-excursion
2014 (set-buffer standard-output)
2015 (insert language-name " language environment\n\n")
2016 (if (stringp doc)
2017 (insert doc "\n\n"))
2018 (condition-case nil
2019 (let ((str (eval (get-language-info language-name 'sample-text))))
2020 (if (stringp str)
2021 (insert "Sample text:\n " str "\n\n")))
2022 (error nil))
2023 (let ((input-method (get-language-info language-name 'input-method))
2024 (l (copy-sequence input-method-alist))
2025 (first t))
2026 (when (and input-method
2027 (setq input-method (assoc input-method l)))
2028 (insert "Input methods (default " (car input-method) ")\n")
2029 (setq l (cons input-method (delete input-method l))
2030 first nil))
2031 (dolist (elt l)
2032 (when (or (eq input-method elt)
2033 (eq t (compare-strings language-name nil nil
2034 (nth 1 elt) nil nil t)))
2035 (when first
2036 (insert "Input methods:\n")
2037 (setq first nil))
2038 (insert " " (car elt))
2039 (search-backward (car elt))
2040 (help-xref-button 0 'help-input-method (car elt))
2041 (goto-char (point-max))
2042 (insert " (\""
2043 (if (stringp (nth 3 elt)) (nth 3 elt) (car (nth 3 elt)))
2044 "\" in mode line)\n")))
2045 (or first
2046 (insert "\n")))
2047 (insert "Character sets:\n")
2048 (let ((l (get-language-info language-name 'charset)))
2049 (if (null l)
2050 (insert " nothing specific to " language-name "\n")
2051 (while l
2052 (insert " " (symbol-name (car l)))
2053 (search-backward (symbol-name (car l)))
2054 (help-xref-button 0 'help-character-set (car l))
2055 (goto-char (point-max))
2056 (insert ": " (charset-description (car l)) "\n")
2057 (setq l (cdr l)))))
2058 (insert "\n")
2059 (insert "Coding systems:\n")
2060 (let ((l (get-language-info language-name 'coding-system)))
2061 (if (null l)
2062 (insert " nothing specific to " language-name "\n")
2063 (while l
2064 (insert " " (symbol-name (car l)))
2065 (search-backward (symbol-name (car l)))
2066 (help-xref-button 0 'help-coding-system (car l))
2067 (goto-char (point-max))
2068 (insert " (`"
2069 (coding-system-mnemonic (car l))
2070 "' in mode line):\n\t"
2071 (coding-system-doc-string (car l))
2072 "\n")
2073 (let ((aliases (coding-system-aliases (car l))))
2074 (when aliases
2075 (insert "\t(alias:")
2076 (while aliases
2077 (insert " " (symbol-name (car aliases)))
2078 (setq aliases (cdr aliases)))
2079 (insert ")\n")))
2080 (setq l (cdr l)))))))))
2082 ;;; Locales.
2084 (defvar locale-translation-file-name nil
2085 "File name for the system's file of locale-name aliases, or nil if none.")
2087 ;; The following definitions might as well be marked as constants and
2088 ;; purecopied, since they're normally used on startup, and probably
2089 ;; should reflect the facilities of the base Emacs.
2090 (defconst locale-language-names
2091 (purecopy
2093 ;; Locale names of the form LANGUAGE[_TERRITORY][.CODESET][@MODIFIER]
2094 ;; as specified in the Single Unix Spec, Version 2.
2095 ;; LANGUAGE is a language code taken from ISO 639:1988 (E/F)
2096 ;; with additions from ISO 639/RA Newsletter No.1/1989;
2097 ;; see Internet RFC 2165 (1997-06) and
2098 ;; http://www.evertype.com/standards/iso639/iso639-en.html
2099 ;; TERRITORY is a country code taken from ISO 3166
2100 ;; http://www.din.de/gremien/nas/nabd/iso3166ma/codlstp1/en_listp1.html.
2101 ;; CODESET and MODIFIER are implementation-dependent.
2103 ;; jasonr comments: MS Windows uses three letter codes for
2104 ;; languages instead of the two letter ISO codes that POSIX
2105 ;; uses. In most cases the first two letters are the same, so
2106 ;; most of the regexps in locale-language-names work. Japanese
2107 ;; and Chinese are exceptions, which are listed in the
2108 ;; non-standard section at the bottom of locale-language-names.
2110 ("aa_DJ" . "Latin-1") ; Afar
2111 ("aa" . "UTF-8")
2112 ;; ab Abkhazian
2113 ("af" . "Latin-1") ; Afrikaans
2114 ("am" "Ethiopic" utf-8) ; Amharic
2115 ("an" . "Latin-9") ; Aragonese
2116 ; ar Arabic glibc uses 8859-6
2117 ; as Assamese
2118 ; ay Aymara
2119 ("az" . "UTF-8") ; Azerbaijani
2120 ; ba Bashkir
2121 ("be" "Belarusian" cp1251) ; Belarusian [Byelorussian until early 1990s]
2122 ("bg" "Bulgarian" cp1251) ; Bulgarian
2123 ; bh Bihari
2124 ; bi Bislama
2125 ("bn" . "UTF-8") ; Bengali, Bangla
2126 ("bo" . "Tibetan")
2127 ("br" . "Latin-1") ; Breton
2128 ("bs" . "Latin-2") ; Bosnian
2129 ("byn" . "UTF-8") ; Bilin; Blin
2130 ("ca" . "Latin-1") ; Catalan
2131 ; co Corsican
2132 ("cs" "Czech" iso-8859-2)
2133 ("cy" "Welsh" iso-8859-14)
2134 ("da" . "Latin-1") ; Danish
2135 ("de" "German" iso-8859-1)
2136 ; dv Divehi
2137 ; dz Bhutani
2138 ("el" "Greek" iso-8859-7)
2139 ;; Users who specify "en" explicitly typically want Latin-1, not ASCII.
2140 ;; That's actually what the GNU locales define, modulo things like
2141 ;; en_IN -- fx.
2142 ("en_IN" "English" utf-8) ; glibc uses utf-8 for English in India
2143 ("en" "English" iso-8859-1) ; English
2144 ("eo" . "Esperanto") ; Esperanto
2145 ("es" "Spanish" iso-8859-1)
2146 ("et" . "Latin-1") ; Estonian
2147 ("eu" . "Latin-1") ; Basque
2148 ("fa" . "UTF-8") ; Persian
2149 ("fi" . "Latin-1") ; Finnish
2150 ("fj" . "Latin-1") ; Fiji
2151 ("fo" . "Latin-1") ; Faroese
2152 ("fr" "French" iso-8859-1) ; French
2153 ("fy" . "Latin-1") ; Frisian
2154 ("ga" . "Latin-1") ; Irish Gaelic (new orthography)
2155 ("gd" . "Latin-9") ; Scots Gaelic
2156 ("gez" "Ethiopic" utf-8) ; Geez
2157 ("gl" . "Latin-1") ; Gallegan; Galician
2158 ; gn Guarani
2159 ("gu" . "UTF-8") ; Gujarati
2160 ("gv" . "Latin-1") ; Manx Gaelic
2161 ; ha Hausa
2162 ("he" "Hebrew" iso-8859-8)
2163 ("hi" "Devanagari" utf-8) ; Hindi
2164 ("hr" "Croatian" iso-8859-2) ; Croatian
2165 ("hu" . "Latin-2") ; Hungarian
2166 ; hy Armenian
2167 ; ia Interlingua
2168 ("id" . "Latin-1") ; Indonesian
2169 ; ie Interlingue
2170 ; ik Inupiak
2171 ("is" . "Latin-1") ; Icelandic
2172 ("it" "Italian" iso-8859-1) ; Italian
2173 ; iu Inuktitut
2174 ("iw" "Hebrew" iso-8859-8)
2175 ("ja" "Japanese" euc-jp)
2176 ; jw Javanese
2177 ("ka" "Georgian" georgian-ps) ; Georgian
2178 ; kk Kazakh
2179 ("kl" . "Latin-1") ; Greenlandic
2180 ; km Cambodian
2181 ("kn" "Kannada" utf-8)
2182 ("ko" "Korean" euc-kr)
2183 ; ks Kashmiri
2184 ; ku Kurdish
2185 ("kw" . "Latin-1") ; Cornish
2186 ; ky Kirghiz
2187 ("la" . "Latin-1") ; Latin
2188 ("lb" . "Latin-1") ; Luxemburgish
2189 ("lg" . "Laint-6") ; Ganda
2190 ; ln Lingala
2191 ("lo" "Lao" utf-8) ; Laothian
2192 ("lt" "Lithuanian" iso-8859-13)
2193 ("lv" . "Latvian") ; Latvian, Lettish
2194 ; mg Malagasy
2195 ("mi" . "Latin-7") ; Maori
2196 ("mk" "Cyrillic-ISO" iso-8859-5) ; Macedonian
2197 ("ml" "Malayalam" utf-8)
2198 ("mn" . "UTF-8") ; Mongolian
2199 ; mo Moldavian
2200 ("mr" "Devanagari" utf-8) ; Marathi
2201 ("ms" . "Latin-1") ; Malay
2202 ("mt" . "Latin-3") ; Maltese
2203 ; my Burmese
2204 ; na Nauru
2205 ("nb" . "Latin-1") ; Norwegian
2206 ("ne" "Devanagari" utf-8) ; Nepali
2207 ("nl" "Dutch" iso-8859-1)
2208 ("no" . "Latin-1") ; Norwegian
2209 ("oc" . "Latin-1") ; Occitan
2210 ("om_ET" . "UTF-8") ; (Afan) Oromo
2211 ("om" . "Latin-1") ; (Afan) Oromo
2212 ; or Oriya
2213 ("pa" . "UTF-8") ; Punjabi
2214 ("pl" . "Latin-2") ; Polish
2215 ; ps Pashto, Pushto
2216 ("pt" . "Latin-1") ; Portuguese
2217 ; qu Quechua
2218 ("rm" . "Latin-1") ; Rhaeto-Romanic
2219 ; rn Kirundi
2220 ("ro" "Romanian" iso-8859-2)
2221 ("ru_RU" "Russian" iso-8859-5)
2222 ("ru_UA" "Russian" koi8-u)
2223 ; rw Kinyarwanda
2224 ("sa" . "Devanagari") ; Sanskrit
2225 ; sd Sindhi
2226 ("se" . "UTF-8") ; Northern Sami
2227 ; sg Sangho
2228 ("sh" . "Latin-2") ; Serbo-Croatian
2229 ; si Sinhalese
2230 ("sid" . "UTF-8") ; Sidamo
2231 ("sk" "Slovak" iso-8859-2)
2232 ("sl" "Slovenian" iso-8859-2)
2233 ; sm Samoan
2234 ; sn Shona
2235 ("so_ET" "UTF-8") ; Somali
2236 ("so" "Latin-1") ; Somali
2237 ("sq" . "Latin-1") ; Albanian
2238 ("sr" . "Latin-2") ; Serbian (Latin alphabet)
2239 ; ss Siswati
2240 ("st" . "Latin-1") ; Sesotho
2241 ; su Sundanese
2242 ("sv" "Swedish" iso-8859-1) ; Swedish
2243 ("sw" . "Latin-1") ; Swahili
2244 ("ta" "Tamil" utf-8)
2245 ("te" . "UTF-8") ; Telugu
2246 ("tg" "Tajik" koi8-t)
2247 ("th" "Thai" tis-620)
2248 ("ti" "Ethiopic" utf-8) ; Tigrinya
2249 ("tig_ER" . "UTF-8") ; Tigre
2250 ; tk Turkmen
2251 ("tl" . "Latin-1") ; Tagalog
2252 ; tn Setswana
2253 ; to Tonga
2254 ("tr" "Turkish" iso-8859-9)
2255 ; ts Tsonga
2256 ("tt" . "UTF-8") ; Tatar
2257 ; tw Twi
2258 ; ug Uighur
2259 ("uk" "Ukrainian" koi8-u)
2260 ("ur" . "UTF-8") ; Urdu
2261 ("uz_UZ@cyrillic" . "UTF-8"); Uzbek
2262 ("uz" . "Latin-1") ; Uzbek
2263 ("vi" "Vietnamese" utf-8)
2264 ; vo Volapuk
2265 ("wa" . "Latin-1") ; Walloon
2266 ; wo Wolof
2267 ("xh" . "Latin-1") ; Xhosa
2268 ("yi" . "Windows-1255") ; Yiddish
2269 ; yo Yoruba
2270 ; za Zhuang
2271 ("zh_HK" . "Chinese-Big5")
2272 ; zh_HK/BIG5-HKSCS \
2273 ("zh_TW" . "Chinese-Big5")
2274 ("zh_CN.GB2312" "Chinese-GB")
2275 ("zh_CN.GBK" "Chinese-GBK")
2276 ("zh_CN.GB18030" "Chinese-GB18030")
2277 ("zh_CN.UTF-8" . "Chinese-GBK")
2278 ("zh_CN" . "Chinese-GB")
2279 ("zh" . "Chinese-GB")
2280 ("zu" . "Latin-1") ; Zulu
2282 ;; ISO standard locales
2283 ("c$" . "ASCII")
2284 ("posix$" . "ASCII")
2286 ;; The "IPA" Emacs language environment does not correspond
2287 ;; to any ISO 639 code, so let it stand for itself.
2288 ("ipa$" . "IPA")
2290 ;; Nonstandard or obsolete language codes
2291 ("cz" . "Czech") ; e.g. Solaris 2.6
2292 ("ee" . "Latin-4") ; Estonian, e.g. X11R6.4
2293 ("iw" . "Hebrew") ; e.g. X11R6.4
2294 ("sp" . "Cyrillic-ISO") ; Serbian (Cyrillic alphabet), e.g. X11R6.4
2295 ("su" . "Latin-1") ; Finnish, e.g. Solaris 2.6
2296 ("jp" . "Japanese") ; e.g. MS Windows
2297 ("chs" . "Chinese-GBK") ; MS Windows Chinese Simplified
2298 ("cht" . "Chinese-BIG5") ; MS Windows Chinese Traditional
2299 ("gbz" . "UTF-8") ; MS Windows Dari Persian
2300 ("div" . "UTF-8") ; MS Windows Divehi (Maldives)
2301 ("wee" . "Latin-2") ; MS Windows Lower Sorbian
2302 ("wen" . "Latin-2") ; MS Windows Upper Sorbian
2304 "Alist of locale regexps vs the corresponding languages and coding systems.
2305 Each element has this form:
2306 \(LOCALE-REGEXP LANG-ENV CODING-SYSTEM)
2307 The first element whose LOCALE-REGEXP matches the start of a
2308 downcased locale specifies the LANG-ENV \(language environment)
2309 and CODING-SYSTEM corresponding to that locale. If there is no
2310 appropriate language environment, the element may have this form:
2311 \(LOCALE-REGEXP . LANG-ENV)
2312 In this case, LANG-ENV is one of generic language environments for an
2313 specific encoding such as \"Latin-1\" and \"UTF-8\".")
2315 (defconst locale-charset-language-names
2316 (purecopy
2317 '((".*8859[-_]?1\\>" . "Latin-1")
2318 (".*8859[-_]?2\\>" . "Latin-2")
2319 (".*8859[-_]?3\\>" . "Latin-3")
2320 (".*8859[-_]?4\\>" . "Latin-4")
2321 (".*8859[-_]?9\\>" . "Latin-5")
2322 (".*8859[-_]?14\\>" . "Latin-8")
2323 (".*8859[-_]?15\\>" . "Latin-9")
2324 (".*utf\\(?:-?8\\)?\\>" . "UTF-8")
2325 ;; utf-8@euro exists, so put this last. (@euro really specifies
2326 ;; the currency, rather than the charset.)
2327 (".*@euro\\>" . "Latin-9")))
2328 "List of pairs of locale regexps and charset language names.
2329 The first element whose locale regexp matches the start of a downcased locale
2330 specifies the language name whose charset corresponds to that locale.
2331 This language name is used if the locale is not listed in
2332 `locale-language-names'.")
2334 (defconst locale-preferred-coding-systems
2335 (purecopy
2336 '((".*8859[-_]?1\\>" . iso-8859-1)
2337 (".*8859[-_]?2\\>" . iso-8859-2)
2338 (".*8859[-_]?3\\>" . iso-8859-3)
2339 (".*8859[-_]?4\\>" . iso-8859-4)
2340 (".*8859[-_]?9\\>" . iso-8859-9)
2341 (".*8859[-_]?14\\>" . iso-8859-14)
2342 (".*8859[-_]?15\\>" . iso-8859-15)
2343 (".*utf\\(?:-?8\\)?" . utf-8)
2344 ;; utf-8@euro exists, so put this after utf-8. (@euro really
2345 ;; specifies the currency, rather than the charset.)
2346 (".*@euro" . iso-8859-15)
2347 ("koi8-?r" . koi8-r)
2348 ("koi8-?u" . koi8-u)
2349 ("tcvn" . tcvn)
2350 ("big5[-_]?hkscs" . big5-hkscs)
2351 ("big5" . big5)
2352 ("euc-?tw" . euc-tw)
2353 ("euc-?cn" .euc-cn)
2354 ("gb2312" . gb2312)
2355 ("gbk" . gbk)
2356 ("gb18030" . gb18030)
2357 ("ja.*[._]euc" . japanese-iso-8bit)
2358 ("ja.*[._]jis7" . iso-2022-jp)
2359 ("ja.*[._]pck" . japanese-shift-jis)
2360 ("ja.*[._]sjis" . japanese-shift-jis)
2361 ("jpn" . japanese-shift-jis) ; MS-Windows uses this.
2363 "List of pairs of locale regexps and preferred coding systems.
2364 The first element whose locale regexp matches the start of a downcased locale
2365 specifies the coding system to prefer when using that locale.
2366 This coding system is used if the locale specifies a specific charset.")
2368 (defun locale-name-match (key alist)
2369 "Search for KEY in ALIST, which should be a list of regexp-value pairs.
2370 Return the value corresponding to the first regexp that matches the
2371 start of KEY, or nil if there is no match."
2372 (let (element)
2373 (while (and alist (not element))
2374 (if (string-match (concat "\\`\\(?:" (car (car alist)) "\\)") key)
2375 (setq element (car alist)))
2376 (setq alist (cdr alist)))
2377 (cdr element)))
2379 (defun locale-charset-match-p (charset1 charset2)
2380 "Whether charset names (strings) CHARSET1 and CHARSET2 are equivalent.
2381 Matching is done ignoring case and any hyphens and underscores in the
2382 names. E.g. `ISO_8859-1' and `iso88591' both match `iso-8859-1'."
2383 (setq charset1 (replace-regexp-in-string "[-_]" "" charset1))
2384 (setq charset2 (replace-regexp-in-string "[-_]" "" charset2))
2385 (eq t (compare-strings charset1 nil nil charset2 nil nil t)))
2387 (defvar locale-charset-alist nil
2388 "Coding system alist keyed on locale-style charset name.
2389 Used by `locale-charset-to-coding-system'.")
2391 (defun locale-charset-to-coding-system (charset)
2392 "Find coding system corresponding to CHARSET.
2393 CHARSET is any sort of non-Emacs charset name, such as might be used
2394 in a locale codeset, or elsewhere. It is matched to a coding system
2395 first by case-insensitive lookup in `locale-charset-alist'. Then
2396 matches are looked for in the coding system list, treating case and
2397 the characters `-' and `_' as insignificant. The coding system base
2398 is returned. Thus, for instance, if charset \"ISO8859-2\",
2399 `iso-latin-2' is returned."
2400 (or (car (assoc-string charset locale-charset-alist t))
2401 (let ((cs coding-system-alist)
2403 (while (and (not c) cs)
2404 (if (locale-charset-match-p charset (caar cs))
2405 (setq c (intern (caar cs)))
2406 (pop cs)))
2407 (if c (coding-system-base c)))))
2409 ;; Fixme: This ought to deal with the territory part of the locale
2410 ;; too, for setting things such as calendar holidays, ps-print paper
2411 ;; size, spelling dictionary.
2413 (defun set-locale-environment (&optional locale-name frame)
2414 "Set up multi-lingual environment for using LOCALE-NAME.
2415 This sets the language environment, the coding system priority,
2416 the default input method and sometimes other things.
2418 LOCALE-NAME should be a string which is the name of a locale supported
2419 by the system. Often it is of the form xx_XX.CODE, where xx is a
2420 language, XX is a country, and CODE specifies a character set and
2421 coding system. For example, the locale name \"ja_JP.EUC\" might name
2422 a locale for Japanese in Japan using the `japanese-iso-8bit'
2423 coding-system. The name may also have a modifier suffix, e.g. `@euro'
2424 or `@cyrillic'.
2426 If LOCALE-NAME is nil, its value is taken from the environment
2427 variables LC_ALL, LC_CTYPE and LANG (the first one that is set).
2429 The locale names supported by your system can typically be found in a
2430 directory named `/usr/share/locale' or `/usr/lib/locale'. LOCALE-NAME
2431 will be translated according to the table specified by
2432 `locale-translation-file-name'.
2434 If FRAME is non-nil, only set the keyboard coding system and the
2435 terminal coding system for the terminal of that frame, and don't
2436 touch session-global parameters like the language environment.
2438 See also `locale-charset-language-names', `locale-language-names',
2439 `locale-preferred-coding-systems' and `locale-coding-system'."
2440 (interactive "sSet environment for locale: ")
2442 ;; Do this at runtime for the sake of binaries possibly transported
2443 ;; to a system without X.
2444 (setq locale-translation-file-name
2445 (let ((files
2446 '("/usr/share/X11/locale/locale.alias" ; e.g. X11R7
2447 "/usr/lib/X11/locale/locale.alias" ; e.g. X11R6.4
2448 "/usr/X11R6/lib/X11/locale/locale.alias" ; XFree86, e.g. RedHat 4.2
2449 "/usr/openwin/lib/locale/locale.alias" ; e.g. Solaris 2.6
2451 ;; The following name appears after the X-related names above,
2452 ;; since the X-related names are what X actually uses.
2453 "/usr/share/locale/locale.alias" ; GNU/Linux sans X
2455 (while (and files (not (file-exists-p (car files))))
2456 (setq files (cdr files)))
2457 (car files)))
2459 (let ((locale locale-name))
2461 (unless locale
2462 ;; Use the first of these three environment variables
2463 ;; that has a nonempty value.
2464 (let ((vars '("LC_ALL" "LC_CTYPE" "LANG")))
2465 (while (and vars
2466 (= 0 (length locale))) ; nil or empty string
2467 (setq locale (getenv (pop vars) frame)))))
2469 (unless locale
2470 ;; The two tests are kept separate so the byte-compiler sees
2471 ;; that mac-get-preference is only called after checking its existence.
2472 (when (fboundp 'mac-get-preference)
2473 (setq locale (mac-get-preference "AppleLocale"))
2474 (unless locale
2475 (let ((languages (mac-get-preference "AppleLanguages")))
2476 (unless (= (length languages) 0) ; nil or empty vector
2477 (setq locale (aref languages 0)))))))
2478 (unless (or locale (not (boundp 'mac-system-locale)))
2479 (setq locale mac-system-locale))
2481 (when locale
2483 ;; Translate "swedish" into "sv_SE.ISO8859-1", and so on,
2484 ;; using the translation file that many systems have.
2485 (when locale-translation-file-name
2486 (with-temp-buffer
2487 (set-buffer-multibyte nil)
2488 (insert-file-contents locale-translation-file-name)
2489 (when (re-search-forward
2490 (concat "^" (regexp-quote locale) ":?[ \t]+") nil t)
2491 (setq locale (buffer-substring (point) (line-end-position))))))
2493 ;; Leave the system locales alone if the caller did not specify
2494 ;; an explicit locale name, as their defaults are set from
2495 ;; LC_MESSAGES and LC_TIME, not LC_CTYPE, and the user might not
2496 ;; want to set them to the same value as LC_CTYPE.
2497 (when locale-name
2498 (setq system-messages-locale locale)
2499 (setq system-time-locale locale))
2501 (setq locale (downcase locale))
2503 (let ((language-name
2504 (locale-name-match locale locale-language-names))
2505 (charset-language-name
2506 (locale-name-match locale locale-charset-language-names))
2507 (default-eol-type (coding-system-eol-type
2508 default-buffer-file-coding-system))
2509 (coding-system
2510 (or (locale-name-match locale locale-preferred-coding-systems)
2511 (when locale
2512 (if (string-match "\\.\\([^@]+\\)" locale)
2513 (locale-charset-to-coding-system
2514 (match-string 1 locale))))
2515 (and (eq system-type 'macos) mac-system-coding-system))))
2517 (if (consp language-name)
2518 ;; locale-language-names specify both lang-env and coding.
2519 ;; But, what specified in locale-preferred-coding-systems
2520 ;; has higher priority.
2521 (setq coding-system (or coding-system
2522 (nth 1 language-name))
2523 language-name (car language-name))
2524 ;; Otherwise, if locale is not listed in locale-language-names,
2525 ;; use what listed in locale-charset-language-names.
2526 (if (not language-name)
2527 (setq language-name charset-language-name)))
2529 ;; If a specific EOL conversion was specified in the default
2530 ;; buffer-file-coding-system, preserve it in the coding system
2531 ;; we will be using from now on.
2532 (if (and (memq default-eol-type '(0 1 2 unix dos mac))
2533 coding-system
2534 (coding-system-p coding-system))
2535 (setq coding-system (coding-system-change-eol-conversion
2536 coding-system default-eol-type)))
2538 (when language-name
2540 ;; Set up for this character set. This is now the right way
2541 ;; to do it for both unibyte and multibyte modes.
2542 (unless frame
2543 (set-language-environment language-name))
2545 ;; If default-enable-multibyte-characters is nil,
2546 ;; we are using single-byte characters,
2547 ;; so the display table and terminal coding system are irrelevant.
2548 (when default-enable-multibyte-characters
2549 (set-display-table-and-terminal-coding-system
2550 language-name coding-system frame))
2552 ;; Set the `keyboard-coding-system' if appropriate (tty
2553 ;; only). At least X and MS Windows can generate
2554 ;; multilingual input.
2555 ;; XXX This was disabled unless `window-system', but that
2556 ;; leads to buggy behaviour when a tty frame is opened
2557 ;; later. Setting the keyboard coding system has no adverse
2558 ;; effect on X, so let's do it anyway. -- Lorentey
2559 (let ((kcs (or coding-system
2560 (car (get-language-info language-name
2561 'coding-system)))))
2562 (if kcs (set-keyboard-coding-system kcs frame)))
2564 (unless frame
2565 (setq locale-coding-system
2566 (car (get-language-info language-name 'coding-priority)))))
2568 (when (and (not frame)
2569 coding-system
2570 (not (coding-system-equal coding-system
2571 locale-coding-system)))
2572 (prefer-coding-system coding-system)
2573 ;; Fixme: perhaps prefer-coding-system should set this too.
2574 ;; But it's not the time to do such a fundamental change.
2575 (setq default-sendmail-coding-system coding-system)
2576 (setq locale-coding-system coding-system))
2578 (when (get-language-info current-language-environment 'coding-priority)
2579 (let ((codeset (locale-info 'codeset))
2580 (coding-system (car (coding-system-priority-list))))
2581 (when codeset
2582 (let ((cs (coding-system-aliases coding-system))
2583 result)
2584 (while (and cs (not result))
2585 (setq result
2586 (locale-charset-match-p (symbol-name (pop cs))
2587 (locale-info 'codeset))))
2588 (unless result
2589 (message "Warning: Default coding system `%s' disagrees with
2590 system codeset `%s' for this locale." coding-system codeset))))))))
2592 ;; On Windows, override locale-coding-system,
2593 ;; keyboard-coding-system with system codepage. Note:
2594 ;; selection-coding-system is already set in w32select.c.
2595 (when (boundp 'w32-ansi-code-page)
2596 (let ((code-page-coding (intern (format "cp%d" w32-ansi-code-page))))
2597 (when (coding-system-p code-page-coding)
2598 (unless frame (setq locale-coding-system code-page-coding))
2599 (set-keyboard-coding-system code-page-coding frame)
2600 (set-terminal-coding-system code-page-coding frame))))
2602 (when (eq system-type 'darwin)
2603 ;; On Darwin, file names are always encoded in utf-8, no matter
2604 ;; the locale.
2605 (setq default-file-name-coding-system 'utf-8)
2606 ;; Mac OS X's Terminal.app by default uses utf-8 regardless of
2607 ;; the locale.
2608 (when (and (null window-system)
2609 (equal (getenv "TERM_PROGRAM" frame) "Apple_Terminal"))
2610 (set-terminal-coding-system 'utf-8)
2611 (set-keyboard-coding-system 'utf-8)))
2613 ;; Default to A4 paper if we're not in a C, POSIX or US locale.
2614 ;; (See comments in Flocale_info.)
2615 (unless frame
2616 (let ((locale locale)
2617 (paper (locale-info 'paper)))
2618 (if paper
2619 ;; This will always be null at the time of writing.
2620 (cond
2621 ((equal paper '(216 279))
2622 (setq ps-paper-type 'letter))
2623 ((equal paper '(210 297))
2624 (setq ps-paper-type 'a4)))
2625 (let ((vars '("LC_ALL" "LC_PAPER" "LANG")))
2626 (while (and vars (= 0 (length locale)))
2627 (setq locale (getenv (pop vars) frame))))
2628 (when locale
2629 ;; As of glibc 2.2.5, these are the only US Letter locales,
2630 ;; and the rest are A4.
2631 (setq ps-paper-type
2632 (or (locale-name-match locale '(("c$" . letter)
2633 ("posix$" . letter)
2634 (".._us" . letter)
2635 (".._pr" . letter)
2636 (".._ca" . letter)
2637 ("enu$" . letter) ; Windows
2638 ("esu$" . letter)
2639 ("enc$" . letter)
2640 ("frc$" . letter)))
2641 'a4)))))))
2642 nil)
2644 ;;; Character property
2646 ;; Each element has the form (PROP . TABLE).
2647 ;; PROP is a symbol representing a character property.
2648 ;; TABLE is a char-table containing the property value for each character.
2649 ;; TABLE may be a name of file to load to build a char-table.
2650 ;; Don't modify this variable directly but use `define-char-code-property'.
2652 (defvar char-code-property-alist nil
2653 "Alist of character property name vs char-table containing property values.
2654 Internal use only.")
2656 (put 'char-code-property-table 'char-table-extra-slots 5)
2658 (defun define-char-code-property (name table &optional docstring)
2659 "Define NAME as a character code property given by TABLE.
2660 TABLE is a char-table of purpose `char-code-property-table' with
2661 these extra slots:
2662 1st: NAME.
2663 2nd: Function to call to get a property value of a character.
2664 It is called with three arguments CHAR, VAL, and TABLE, where
2665 CHAR is a character, VAL is the value of (aref TABLE CHAR).
2666 3rd: Function to call to put a property value of a character.
2667 It is called with the same arguments as above.
2668 4th: Function to call to get a description string of a property value.
2669 It is called with one argument VALUE, a property value.
2670 5th: Data used by the above functions.
2672 TABLE may be a name of file to load to build a char-table. The
2673 file should contain a call of `define-char-code-property' with a
2674 char-table of the above format as the argument TABLE.
2676 TABLE may also be nil, in which case no property value is pre-assigned.
2678 Optional 3rd argment DOCSTRING is a documentation string of the property.
2680 See also the documentation of `get-char-code-property' and
2681 `put-char-code-property'."
2682 (or (symbolp name)
2683 (error "Not a symbol: %s" name))
2684 (if (char-table-p table)
2685 (or (and (eq (char-table-subtype table) 'char-code-property-table)
2686 (eq (char-table-extra-slot table 0) name))
2687 (error "Invalid char-table: %s" table))
2688 (or (stringp table)
2689 (error "Not a char-table nor a file name: %s" table)))
2690 (let ((slot (assq name char-code-property-alist)))
2691 (if slot
2692 (setcdr slot table)
2693 (setq char-code-property-alist
2694 (cons (cons name table) char-code-property-alist))))
2695 (put name 'char-code-property-documentation docstring))
2697 (defvar char-code-property-table
2698 (make-char-table 'char-code-property-table)
2699 "Char-table containing a property list of each character code.
2700 This table is used for properties not listed in `char-code-property-alist'.
2701 See also the documentation of `get-char-code-property' and
2702 `put-char-code-property'.")
2704 (defun get-char-code-property (char propname)
2705 "Return the value of CHAR's PROPNAME property."
2706 (let ((slot (assq propname char-code-property-alist)))
2707 (if slot
2708 (let (table value func)
2709 (if (stringp (cdr slot))
2710 (load (cdr slot)))
2711 (setq table (cdr slot)
2712 value (aref table char)
2713 func (char-table-extra-slot table 1))
2714 (if (functionp func)
2715 (setq value (funcall func char value table)))
2716 value)
2717 (plist-get (aref char-code-property-table char) propname))))
2719 (defun put-char-code-property (char propname value)
2720 "Store CHAR's PROPNAME property with VALUE.
2721 It can be retrieved with `(get-char-code-property CHAR PROPNAME)'."
2722 (let ((slot (assq propname char-code-property-alist)))
2723 (if slot
2724 (let (table func)
2725 (if (stringp (cdr slot))
2726 (load (cdr slot)))
2727 (setq table (cdr slot)
2728 func (char-table-extra-slot table 2))
2729 (if (functionp func)
2730 (funcall func char value table)
2731 (aset table char value)))
2732 (let* ((plist (aref char-code-property-table char))
2733 (x (plist-put plist propname value)))
2734 (or (eq x plist)
2735 (aset char-code-property-table char x))))
2736 value))
2738 (defun char-code-property-description (prop value)
2739 "Return a description string of character property PROP's value VALUE.
2740 If there's no description string for VALUE, return nil."
2741 (let ((slot (assq prop char-code-property-alist)))
2742 (if slot
2743 (let (table func)
2744 (if (stringp (cdr slot))
2745 (load (cdr slot)))
2746 (setq table (cdr slot)
2747 func (char-table-extra-slot table 3))
2748 (if (functionp func)
2749 (funcall func value))))))
2752 ;; Pretty description of encoded string
2754 ;; Alist of ISO 2022 control code vs the corresponding mnemonic string.
2755 (defvar iso-2022-control-alist
2756 '((?\x1b . "ESC")
2757 (?\x0e . "SO")
2758 (?\x0f . "SI")
2759 (?\x8e . "SS2")
2760 (?\x8f . "SS3")
2761 (?\x9b . "CSI")))
2763 (defun encoded-string-description (str coding-system)
2764 "Return a pretty description of STR that is encoded by CODING-SYSTEM."
2765 (setq str (string-as-unibyte str))
2766 (mapconcat
2767 (if (and coding-system (eq (coding-system-type coding-system) 'iso-2022))
2768 ;; Try to get a pretty description for ISO 2022 escape sequences.
2769 (function (lambda (x) (or (cdr (assq x iso-2022-control-alist))
2770 (format "#x%02X" x))))
2771 (function (lambda (x) (format "#x%02X" x))))
2772 str " "))
2774 (defun encode-coding-char (char coding-system)
2775 "Encode CHAR by CODING-SYSTEM and return the resulting string.
2776 If CODING-SYSTEM can't safely encode CHAR, return nil."
2777 (let ((str1 (string-as-multibyte (string char)))
2778 (str2 (string-as-multibyte (string char char)))
2779 enc1 enc2 i1 i2)
2780 (when (memq (coding-system-base coding-system)
2781 (find-coding-systems-string str1))
2782 ;; We must find the encoded string of CHAR. But, just encoding
2783 ;; CHAR will put extra control sequences (usually to designate
2784 ;; ASCII charset) at the tail if type of CODING is ISO 2022.
2785 ;; To exclude such tailing bytes, we at first encode one-char
2786 ;; string and two-char string, then check how many bytes at the
2787 ;; tail of both encoded strings are the same.
2789 (setq enc1 (encode-coding-string str1 coding-system)
2790 i1 (length enc1)
2791 enc2 (encode-coding-string str2 coding-system)
2792 i2 (length enc2))
2793 (while (and (> i1 0) (= (aref enc1 (1- i1)) (aref enc2 (1- i2))))
2794 (setq i1 (1- i1) i2 (1- i2)))
2796 ;; Now (substring enc1 i1) and (substring enc2 i2) are the same,
2797 ;; and they are the extra control sequences at the tail to
2798 ;; exclude.
2799 (substring enc2 0 i2))))
2801 ;; Backwards compatibility. These might be better with :init-value t,
2802 ;; but that breaks loadup.
2803 (define-minor-mode unify-8859-on-encoding-mode
2804 "Obsolete."
2805 :group 'mule
2806 :global t)
2807 (define-minor-mode unify-8859-on-decoding-mode
2808 "Obsolete."
2809 :group 'mule
2810 :global t)
2812 (defvar nonascii-insert-offset 0 "This variable is obsolete.")
2813 (defvar nonascii-translation-table nil "This variable is obsolete.")
2815 (defun ucs-insert (arg)
2816 "Insert a character of the given Unicode code point.
2817 Interactively, prompts for a hex string giving the code."
2818 (interactive "sUnicode (hex): ")
2819 (or (integerp arg)
2820 (setq arg (string-to-number arg 16)))
2821 (if (or (< arg 0) (> arg #x10FFFF))
2822 (error "Not a Unicode character code: 0x%X" arg))
2823 (insert arg))
2826 ;; arch-tag: b382c432-4b36-460e-bf4c-05efd0bb18dc
2827 ;;; mule-cmds.el ends here