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