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