Nuke arch-tags.
[emacs.git] / lisp / international / mule-cmds.el
blob73542feeaa57944a8e54a95425f6a612cbbd81c9
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, 2011 Free Software Foundation, Inc.
5 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6 ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011
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 ((coding-system-for-read 'iso-2022-7bit))
290 (view-file (expand-file-name "HELLO" data-directory))))
292 (defun universal-coding-system-argument (coding-system)
293 "Execute an I/O command using the specified coding system."
294 (interactive
295 (let ((default (and buffer-file-coding-system
296 (not (eq (coding-system-type buffer-file-coding-system)
297 'undecided))
298 buffer-file-coding-system)))
299 (list (read-coding-system
300 (if default
301 (format "Coding system for following command (default %s): " default)
302 "Coding system for following command: ")
303 default))))
304 (let* ((keyseq (read-key-sequence
305 (format "Command to execute with %s:" coding-system)))
306 (cmd (key-binding keyseq))
307 prefix)
308 ;; read-key-sequence ignores quit, so make an explicit check.
309 ;; Like many places, this assumes quit == C-g, but it need not be.
310 (if (equal last-input-event ?\C-g)
311 (keyboard-quit))
312 (when (memq cmd '(universal-argument digit-argument))
313 (call-interactively cmd)
315 ;; Process keys bound in `universal-argument-map'.
316 (while (progn
317 (setq keyseq (read-key-sequence nil t)
318 cmd (key-binding keyseq t))
319 (not (eq cmd 'universal-argument-other-key)))
320 (let ((current-prefix-arg prefix-arg)
321 ;; Have to bind `last-command-event' here so that
322 ;; `digit-argument', for instance, can compute the
323 ;; prefix arg.
324 (last-command-event (aref keyseq 0)))
325 (call-interactively cmd)))
327 ;; This is the final call to `universal-argument-other-key', which
328 ;; set's the final `prefix-arg.
329 (let ((current-prefix-arg prefix-arg))
330 (call-interactively cmd))
332 ;; Read the command to execute with the given prefix arg.
333 (setq prefix prefix-arg
334 keyseq (read-key-sequence nil t)
335 cmd (key-binding keyseq)))
337 (let ((coding-system-for-read coding-system)
338 (coding-system-for-write coding-system)
339 (coding-system-require-warning t)
340 (current-prefix-arg prefix))
341 (message "")
342 (call-interactively cmd))))
344 (defun set-default-coding-systems (coding-system)
345 "Set default value of various coding systems to CODING-SYSTEM.
346 This sets the following coding systems:
347 o coding system of a newly created buffer
348 o default coding system for subprocess I/O
349 This also sets the following values:
350 o default value used as `file-name-coding-system' for converting file names
351 if CODING-SYSTEM is ASCII-compatible
352 o default value for the command `set-terminal-coding-system'
353 o default value for the command `set-keyboard-coding-system'
354 if CODING-SYSTEM is ASCII-compatible"
355 (check-coding-system coding-system)
356 (setq-default buffer-file-coding-system coding-system)
357 (if (fboundp 'ucs-set-table-for-input)
358 (dolist (buffer (buffer-list))
359 (or (local-variable-p 'buffer-file-coding-system buffer)
360 (ucs-set-table-for-input buffer))))
362 (if (eq system-type 'darwin)
363 ;; The file-name coding system on Darwin systems is always utf-8.
364 (setq default-file-name-coding-system 'utf-8)
365 (if (and (default-value 'enable-multibyte-characters)
366 (or (not coding-system)
367 (coding-system-get coding-system 'ascii-compatible-p)))
368 (setq default-file-name-coding-system coding-system)))
369 (setq default-terminal-coding-system coding-system)
370 (setq default-keyboard-coding-system coding-system)
371 ;; Preserve eol-type from existing default-process-coding-systems.
372 ;; On non-unix-like systems in particular, these may have been set
373 ;; carefully by the user, or by the startup code, to deal with the
374 ;; users shell appropriately, so should not be altered by changing
375 ;; language environment.
376 (let ((output-coding
377 (coding-system-change-text-conversion
378 (car default-process-coding-system) coding-system))
379 (input-coding
380 (coding-system-change-text-conversion
381 (cdr default-process-coding-system) coding-system)))
382 (setq default-process-coding-system
383 (cons output-coding input-coding))))
385 (defun prefer-coding-system (coding-system)
386 "Add CODING-SYSTEM at the front of the priority list for automatic detection.
387 This also sets the following coding systems:
388 o coding system of a newly created buffer
389 o default coding system for subprocess I/O
390 This also sets the following values:
391 o default value used as `file-name-coding-system' for converting file names
392 o default value for the command `set-terminal-coding-system'
393 o default value for the command `set-keyboard-coding-system'
395 If CODING-SYSTEM specifies a certain type of EOL conversion, the coding
396 systems set by this function will use that type of EOL conversion.
398 A coding system that requires automatic detection of text+encoding
399 \(e.g. undecided, unix) can't be preferred."
400 (interactive "zPrefer coding system: ")
401 (if (not (and coding-system (coding-system-p coding-system)))
402 (error "Invalid coding system `%s'" coding-system))
403 (if (memq (coding-system-type coding-system) '(raw-text undecided))
404 (error "Can't prefer the coding system `%s'" coding-system))
405 (let ((base (coding-system-base coding-system))
406 (eol-type (coding-system-eol-type coding-system)))
407 (set-coding-system-priority base)
408 (and (called-interactively-p 'interactive)
409 (or (eq base coding-system)
410 (message "Highest priority is set to %s (base of %s)"
411 base coding-system)))
412 ;; If they asked for specific EOL conversion, honor that.
413 (if (memq eol-type '(0 1 2))
414 (setq base
415 (coding-system-change-eol-conversion base eol-type)))
416 (set-default-coding-systems base)))
418 (defvar sort-coding-systems-predicate nil
419 "If non-nil, a predicate function to sort coding systems.
421 It is called with two coding systems, and should return t if the first
422 one is \"less\" than the second.
424 The function `sort-coding-systems' use it.")
426 (defun sort-coding-systems (codings)
427 "Sort coding system list CODINGS by a priority of each coding system.
428 Return the sorted list. CODINGS is modified by side effects.
430 If a coding system is most preferred, it has the highest priority.
431 Otherwise, coding systems that correspond to MIME charsets have
432 higher priorities. Among them, a coding system included in the
433 `coding-system' key of the current language environment has higher
434 priority. See also the documentation of `language-info-alist'.
436 If the variable `sort-coding-systems-predicate' (which see) is
437 non-nil, it is used to sort CODINGS instead."
438 (if sort-coding-systems-predicate
439 (sort codings sort-coding-systems-predicate)
440 (let* ((from-priority (coding-system-priority-list))
441 (most-preferred (car from-priority))
442 (lang-preferred (get-language-info current-language-environment
443 'coding-system))
444 (func (function
445 (lambda (x)
446 (let ((base (coding-system-base x)))
447 ;; We calculate the priority number 0..255 by
448 ;; using the 8 bits PMMLCEII as this:
449 ;; P: 1 if most preferred.
450 ;; MM: greater than 0 if mime-charset.
451 ;; L: 1 if one of the current lang. env.'s codings.
452 ;; C: 1 if one of codings listed in the category list.
453 ;; E: 1 if not XXX-with-esc
454 ;; II: if iso-2022 based, 0..3, else 1.
455 (logior
456 (lsh (if (eq base most-preferred) 1 0) 7)
457 (lsh
458 (let ((mime (coding-system-get base :mime-charset)))
459 ;; Prefer coding systems corresponding to a
460 ;; MIME charset.
461 (if mime
462 ;; Lower utf-16 priority so that we
463 ;; normally prefer utf-8 to it, and put
464 ;; x-ctext below that.
465 (cond ((string-match-p "utf-16"
466 (symbol-name mime))
468 ((string-match-p "^x-" (symbol-name mime))
470 (t 3))
473 (lsh (if (memq base lang-preferred) 1 0) 4)
474 (lsh (if (memq base from-priority) 1 0) 3)
475 (lsh (if (string-match-p "-with-esc\\'"
476 (symbol-name base))
477 0 1) 2)
478 (if (eq (coding-system-type base) 'iso-2022)
479 (let ((category (coding-system-category base)))
480 ;; For ISO based coding systems, prefer
481 ;; one that doesn't use designation nor
482 ;; locking/single shifting.
483 (cond
484 ((or (eq category 'coding-category-iso-8-1)
485 (eq category 'coding-category-iso-8-2))
487 ((or (eq category 'coding-category-iso-7-tight)
488 (eq category 'coding-category-iso-7))
491 0)))
493 ))))))
494 (sort codings (function (lambda (x y)
495 (> (funcall func x) (funcall func y))))))))
497 (defun find-coding-systems-region (from to)
498 "Return a list of proper coding systems to encode a text between FROM and TO.
500 If FROM is a string, find coding systems in that instead of the buffer.
501 All coding systems in the list can safely encode any multibyte characters
502 in the text.
504 If the text contains no multibyte characters, return a list of a single
505 element `undecided'."
506 (let ((codings (find-coding-systems-region-internal from to)))
507 (if (eq codings t)
508 ;; The text contains only ASCII characters. Any coding
509 ;; systems are safe.
510 '(undecided)
511 ;; We need copy-sequence because sorting will alter the argument.
512 (sort-coding-systems (copy-sequence codings)))))
514 (defun find-coding-systems-string (string)
515 "Return a list of proper coding systems to encode STRING.
516 All coding systems in the list can safely encode any multibyte characters
517 in STRING.
519 If STRING contains no multibyte characters, return a list of a single
520 element `undecided'."
521 (find-coding-systems-region string nil))
523 (defun find-coding-systems-for-charsets (charsets)
524 "Return a list of proper coding systems to encode characters of CHARSETS.
525 CHARSETS is a list of character sets.
527 This only finds coding systems of type `charset', whose
528 `:charset-list' property includes all of CHARSETS (plus `ascii' for
529 ASCII-compatible coding systems). It was used in older versions of
530 Emacs, but is unlikely to be what you really want now."
531 ;; Deal with aliases.
532 (setq charsets (mapcar (lambda (c)
533 (get-charset-property c :name))
534 charsets))
535 (cond ((or (null charsets)
536 (and (= (length charsets) 1)
537 (eq 'ascii (car charsets))))
538 '(undecided))
539 ((or (memq 'eight-bit-control charsets)
540 (memq 'eight-bit-graphic charsets))
541 '(raw-text utf-8-emacs))
543 (let (codings)
544 (dolist (cs (coding-system-list t))
545 (let ((cs-charsets (and (eq (coding-system-type cs) 'charset)
546 (coding-system-charset-list cs)))
547 (charsets charsets))
548 (if (coding-system-get cs :ascii-compatible-p)
549 (add-to-list 'cs-charsets 'ascii))
550 (if (catch 'ok
551 (when cs-charsets
552 (while charsets
553 (unless (memq (pop charsets) cs-charsets)
554 (throw 'ok nil)))
556 (push cs codings))))
557 (nreverse codings)))))
559 (defun find-multibyte-characters (from to &optional maxcount excludes)
560 "Find multibyte characters in the region specified by FROM and TO.
561 If FROM is a string, find multibyte characters in the string.
562 The return value is an alist of the following format:
563 ((CHARSET COUNT CHAR ...) ...)
564 where
565 CHARSET is a character set,
566 COUNT is a number of characters,
567 CHARs are the characters found from the character set.
568 Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list.
569 Optional 4th arg EXCLUDES is a list of character sets to be ignored."
570 (let ((chars nil)
571 charset char)
572 (if (stringp from)
573 (if (multibyte-string-p from)
574 (let ((idx 0))
575 (while (setq idx (string-match-p "[^\000-\177]" from idx))
576 (setq char (aref from idx)
577 charset (char-charset char))
578 (unless (memq charset excludes)
579 (let ((slot (assq charset chars)))
580 (if slot
581 (if (not (memq char (nthcdr 2 slot)))
582 (let ((count (nth 1 slot)))
583 (setcar (cdr slot) (1+ count))
584 (if (or (not maxcount) (< count maxcount))
585 (nconc slot (list char)))))
586 (setq chars (cons (list charset 1 char) chars)))))
587 (setq idx (1+ idx)))))
588 (if enable-multibyte-characters
589 (save-excursion
590 (goto-char from)
591 (while (re-search-forward "[^\000-\177]" to t)
592 (setq char (preceding-char)
593 charset (char-charset char))
594 (unless (memq charset excludes)
595 (let ((slot (assq charset chars)))
596 (if slot
597 (if (not (member char (nthcdr 2 slot)))
598 (let ((count (nth 1 slot)))
599 (setcar (cdr slot) (1+ count))
600 (if (or (not maxcount) (< count maxcount))
601 (nconc slot (list char)))))
602 (setq chars (cons (list charset 1 char) chars)))))))))
603 (nreverse chars)))
605 (defun search-unencodable-char (coding-system)
606 "Search forward from point for a character that is not encodable.
607 It asks which coding system to check.
608 If such a character is found, set point after that character.
609 Otherwise, don't move point.
611 When called from a program, the value is the position of the unencodable
612 character found, or nil if all characters are encodable."
613 (interactive
614 (list (let ((default (or buffer-file-coding-system 'us-ascii)))
615 (read-coding-system
616 (format "Coding-system (default %s): " default)
617 default))))
618 (let ((pos (unencodable-char-position (point) (point-max) coding-system)))
619 (if pos
620 (goto-char (1+ pos))
621 (message "All following characters are encodable by %s" coding-system))
622 pos))
624 (defvar last-coding-system-specified nil
625 "Most recent coding system explicitly specified by the user when asked.
626 This variable is set whenever Emacs asks the user which coding system
627 to use in order to write a file. If you set it to nil explicitly,
628 then call `write-region', then afterward this variable will be non-nil
629 only if the user was explicitly asked and specified a coding system.")
631 (defvar select-safe-coding-system-accept-default-p nil
632 "If non-nil, a function to control the behavior of coding system selection.
633 The meaning is the same as the argument ACCEPT-DEFAULT-P of the
634 function `select-safe-coding-system' (which see). This variable
635 overrides that argument.")
637 (defun select-safe-coding-system-interactively (from to codings unsafe
638 &optional rejected default)
639 "Select interactively a coding system for the region FROM ... TO.
640 FROM can be a string, as in `write-region'.
641 CODINGS is the list of base coding systems known to be safe for this region,
642 typically obtained with `find-coding-systems-region'.
643 UNSAFE is a list of coding systems known to be unsafe for this region.
644 REJECTED is a list of coding systems which were safe but for some reason
645 were not recommended in the particular context.
646 DEFAULT is the coding system to use by default in the query."
647 ;; At first, if some defaults are unsafe, record at most 11
648 ;; problematic characters and their positions for them by turning
649 ;; (CODING ...)
650 ;; into
651 ;; ((CODING (POS . CHAR) (POS . CHAR) ...) ...)
652 (if unsafe
653 (setq unsafe
654 (mapcar #'(lambda (coding)
655 (cons coding
656 (if (stringp from)
657 (mapcar #'(lambda (pos)
658 (cons pos (aref from pos)))
659 (unencodable-char-position
660 0 (length from) coding
661 11 from))
662 (mapcar #'(lambda (pos)
663 (cons pos (char-after pos)))
664 (unencodable-char-position
665 from to coding 11)))))
666 unsafe)))
668 ;; Change each safe coding system to the corresponding
669 ;; mime-charset name if it is also a coding system. Such a name
670 ;; is more friendly to users.
671 (let ((l codings)
672 mime-charset)
673 (while l
674 (setq mime-charset (coding-system-get (car l) :mime-charset))
675 (if (and mime-charset (coding-system-p mime-charset)
676 (coding-system-equal (car l) mime-charset))
677 (setcar l mime-charset))
678 (setq l (cdr l))))
680 ;; Don't offer variations with locking shift, which you
681 ;; basically never want.
682 (let (l)
683 (dolist (elt codings (setq codings (nreverse l)))
684 (unless (or (eq 'coding-category-iso-7-else
685 (coding-system-category elt))
686 (eq 'coding-category-iso-8-else
687 (coding-system-category elt)))
688 (push elt l))))
690 ;; Remove raw-text, emacs-mule and no-conversion unless nothing
691 ;; else is available.
692 (setq codings
693 (or (delq 'raw-text
694 (delq 'emacs-mule
695 (delq 'no-conversion codings)))
696 '(raw-text emacs-mule no-conversion)))
698 (let ((window-configuration (current-window-configuration))
699 (bufname (buffer-name))
700 coding-system)
701 (save-excursion
702 ;; If some defaults are unsafe, make sure the offending
703 ;; buffer is displayed.
704 (when (and unsafe (not (stringp from)))
705 (pop-to-buffer bufname)
706 (goto-char (apply 'min (mapcar #'(lambda (x) (car (cadr x)))
707 unsafe))))
708 ;; Then ask users to select one from CODINGS while showing
709 ;; the reason why none of the defaults are not used.
710 (with-output-to-temp-buffer "*Warning*"
711 (with-current-buffer standard-output
712 (if (and (null rejected) (null unsafe))
713 (insert "No default coding systems to try for "
714 (if (stringp from)
715 (format "string \"%s\"." from)
716 (format "buffer `%s'." bufname)))
717 (insert
718 "These default coding systems were tried to encode"
719 (if (stringp from)
720 (concat " \"" (if (> (length from) 10)
721 (concat (substring from 0 10) "...\"")
722 (concat from "\"")))
723 (format " text\nin the buffer `%s'" bufname))
724 ":\n")
725 (let ((pos (point))
726 (fill-prefix " "))
727 (dolist (x (append rejected unsafe))
728 (princ " ") (princ x))
729 (insert "\n")
730 (fill-region-as-paragraph pos (point)))
731 (when rejected
732 (insert "These safely encode the text in the buffer,
733 but are not recommended for encoding text in this context,
734 e.g., for sending an email message.\n ")
735 (dolist (x rejected)
736 (princ " ") (princ x))
737 (insert "\n"))
738 (when unsafe
739 (insert (if rejected "The other coding systems"
740 "However, each of them")
741 " encountered characters it couldn't encode:\n")
742 (dolist (coding unsafe)
743 (insert (format " %s cannot encode these:" (car coding)))
744 (let ((i 0)
745 (func1
746 #'(lambda (bufname pos)
747 (when (buffer-live-p (get-buffer bufname))
748 (pop-to-buffer bufname)
749 (goto-char pos))))
750 (func2
751 #'(lambda (bufname pos coding)
752 (when (buffer-live-p (get-buffer bufname))
753 (pop-to-buffer bufname)
754 (if (< (point) pos)
755 (goto-char pos)
756 (forward-char 1)
757 (search-unencodable-char coding)
758 (forward-char -1))))))
759 (dolist (elt (cdr coding))
760 (insert " ")
761 (if (stringp from)
762 (insert (if (< i 10) (cdr elt) "..."))
763 (if (< i 10)
764 (insert-text-button
765 (cdr elt)
766 :type 'help-xref
767 'face 'link
768 'help-echo
769 "mouse-2, RET: jump to this character"
770 'help-function func1
771 'help-args (list bufname (car elt)))
772 (insert-text-button
773 "..."
774 :type 'help-xref
775 'face 'link
776 'help-echo
777 "mouse-2, RET: next unencodable character"
778 'help-function func2
779 'help-args (list bufname (car elt)
780 (car coding)))))
781 (setq i (1+ i))))
782 (insert "\n"))
783 (insert (substitute-command-keys "\
785 Click on a character (or switch to this window by `\\[other-window]'\n\
786 and select the characters by RET) to jump to the place it appears,\n\
787 where `\\[universal-argument] \\[what-cursor-position]' will give information about it.\n"))))
788 (insert (substitute-command-keys "\nSelect \
789 one of the safe coding systems listed below,\n\
790 or cancel the writing with \\[keyboard-quit] and edit the buffer\n\
791 to remove or modify the problematic characters,\n\
792 or specify any other coding system (and risk losing\n\
793 the problematic characters).\n\n"))
794 (let ((pos (point))
795 (fill-prefix " "))
796 (dolist (x codings)
797 (princ " ") (princ x))
798 (insert "\n")
799 (fill-region-as-paragraph pos (point)))))
801 ;; Read a coding system.
802 (setq coding-system
803 (read-coding-system
804 (format "Select coding system (default %s): " default)
805 default))
806 (setq last-coding-system-specified coding-system))
808 (kill-buffer "*Warning*")
809 (set-window-configuration window-configuration)
810 coding-system))
812 (defun select-safe-coding-system (from to &optional default-coding-system
813 accept-default-p file)
814 "Ask a user to select a safe coding system from candidates.
815 The candidates of coding systems which can safely encode a text
816 between FROM and TO are shown in a popup window. Among them, the most
817 proper one is suggested as the default.
819 The list of `buffer-file-coding-system' of the current buffer, the
820 default `buffer-file-coding-system', and the most preferred coding
821 system (if it corresponds to a MIME charset) is treated as the
822 default coding system list. Among them, the first one that safely
823 encodes the text is normally selected silently and returned without
824 any user interaction. See also the command `prefer-coding-system'.
826 However, the user is queried if the chosen coding system is
827 inconsistent with what would be selected by `find-auto-coding' from
828 coding cookies &c. if the contents of the region were read from a
829 file. (That could lead to data corruption in a file subsequently
830 re-visited and edited.)
832 Optional 3rd arg DEFAULT-CODING-SYSTEM specifies a coding system or a
833 list of coding systems to be prepended to the default coding system
834 list. However, if DEFAULT-CODING-SYSTEM is a list and the first
835 element is t, the cdr part is used as the default coding system list,
836 i.e. current `buffer-file-coding-system', default `buffer-file-coding-system',
837 and the most preferred coding system are not used.
839 Optional 4th arg ACCEPT-DEFAULT-P, if non-nil, is a function to
840 determine the acceptability of the silently selected coding system.
841 It is called with that coding system, and should return nil if it
842 should not be silently selected and thus user interaction is required.
844 Optional 5th arg FILE is the file name to use for this purpose.
845 That is different from `buffer-file-name' when handling `write-region'
846 \(for example).
848 The variable `select-safe-coding-system-accept-default-p', if non-nil,
849 overrides ACCEPT-DEFAULT-P.
851 Kludgy feature: if FROM is a string, the string is the target text,
852 and TO is ignored."
853 (if (not (listp default-coding-system))
854 (setq default-coding-system (list default-coding-system)))
856 (let ((no-other-defaults nil)
857 auto-cs)
858 (unless (or (stringp from) find-file-literally)
859 ;; Find an auto-coding that is specified for the current
860 ;; buffer and file from the region FROM and TO.
861 (save-excursion
862 (save-restriction
863 (widen)
864 (goto-char from)
865 (setq auto-cs (find-auto-coding (or file buffer-file-name "")
866 (- to from)))
867 (if auto-cs
868 (if (coding-system-p (car auto-cs))
869 (setq auto-cs (car auto-cs))
870 (display-warning
871 'mule
872 (format "\
873 Invalid coding system `%s' is specified
874 for the current buffer/file by the %s.
875 It is highly recommended to fix it before writing to a file."
876 (car auto-cs)
877 (if (eq (cdr auto-cs) :coding) ":coding tag"
878 (format "variable `%s'" (cdr auto-cs))))
879 :warning)
880 (or (yes-or-no-p "Really proceed with writing? ")
881 (error "Save aborted"))
882 (setq auto-cs nil))))))
884 (if (eq (car default-coding-system) t)
885 (setq no-other-defaults t
886 default-coding-system (cdr default-coding-system)))
888 ;; Change elements of the list to (coding . base-coding).
889 (setq default-coding-system
890 (mapcar (function (lambda (x) (cons x (coding-system-base x))))
891 default-coding-system))
893 (if (and auto-cs (not no-other-defaults))
894 ;; If the file has a coding cookie, use it regardless of any
895 ;; other setting.
896 (let ((base (coding-system-base auto-cs)))
897 (unless (memq base '(nil undecided))
898 (setq default-coding-system (list (cons auto-cs base)))
899 (setq no-other-defaults t))))
901 (unless no-other-defaults
902 ;; If buffer-file-coding-system is not nil nor undecided, append it
903 ;; to the defaults.
904 (if buffer-file-coding-system
905 (let ((base (coding-system-base buffer-file-coding-system)))
906 (or (eq base 'undecided)
907 (rassq base default-coding-system)
908 (setq default-coding-system
909 (append default-coding-system
910 (list (cons buffer-file-coding-system base)))))))
912 (unless (and buffer-file-coding-system-explicit
913 (cdr buffer-file-coding-system-explicit))
914 ;; If default buffer-file-coding-system is not nil nor undecided,
915 ;; append it to the defaults.
916 (when (default-value 'buffer-file-coding-system)
917 (let ((base (coding-system-base
918 (default-value 'buffer-file-coding-system))))
919 (or (eq base 'undecided)
920 (rassq base default-coding-system)
921 (setq default-coding-system
922 (append default-coding-system
923 (list (cons (default-value
924 'buffer-file-coding-system)
925 base)))))))
927 ;; If the most preferred coding system has the property mime-charset,
928 ;; append it to the defaults.
929 (let ((preferred (coding-system-priority-list t))
930 base)
931 (and (coding-system-p preferred)
932 (setq base (coding-system-base preferred))
933 (coding-system-get preferred :mime-charset)
934 (not (rassq base default-coding-system))
935 (setq default-coding-system
936 (append default-coding-system
937 (list (cons preferred base))))))))
939 (if select-safe-coding-system-accept-default-p
940 (setq accept-default-p select-safe-coding-system-accept-default-p))
942 ;; Decide the eol-type from the top of the default codings,
943 ;; current buffer-file-coding-system, or default buffer-file-coding-system.
944 (if default-coding-system
945 (let ((default-eol-type (coding-system-eol-type
946 (caar default-coding-system))))
947 (if (and (vectorp default-eol-type) buffer-file-coding-system)
948 (setq default-eol-type (coding-system-eol-type
949 buffer-file-coding-system)))
950 (if (and (vectorp default-eol-type)
951 (default-value 'buffer-file-coding-system))
952 (setq default-eol-type
953 (coding-system-eol-type
954 (default-value 'buffer-file-coding-system))))
955 (if (and default-eol-type (not (vectorp default-eol-type)))
956 (dolist (elt default-coding-system)
957 (setcar elt (coding-system-change-eol-conversion
958 (car elt) default-eol-type))))))
960 (let ((codings (find-coding-systems-region from to))
961 (coding-system nil)
962 (tick (if (not (stringp from)) (buffer-chars-modified-tick)))
963 safe rejected unsafe)
964 (if (eq (car codings) 'undecided)
965 ;; Any coding system is ok.
966 (setq coding-system (caar default-coding-system))
967 ;; Reverse the list so that elements are accumulated in safe,
968 ;; rejected, and unsafe in the correct order.
969 (setq default-coding-system (nreverse default-coding-system))
971 ;; Classify the defaults into safe, rejected, and unsafe.
972 (dolist (elt default-coding-system)
973 (if (or (eq (car codings) 'undecided)
974 (memq (cdr elt) codings))
975 (if (and (functionp accept-default-p)
976 (not (funcall accept-default-p (cdr elt))))
977 (push (car elt) rejected)
978 (push (car elt) safe))
979 (push (car elt) unsafe)))
980 (if safe
981 (setq coding-system (car safe))))
983 ;; If all the defaults failed, ask a user.
984 (when (not coding-system)
985 (setq coding-system (select-safe-coding-system-interactively
986 from to codings unsafe rejected (car codings))))
988 ;; Check we're not inconsistent with what `coding:' spec &c would
989 ;; give when file is re-read.
990 ;; But don't do this if we explicitly ignored the cookie
991 ;; by using `find-file-literally'.
992 (when (and auto-cs
993 (not (and
994 coding-system
995 (memq (coding-system-type coding-system) '(0 5)))))
996 ;; Merge coding-system and auto-cs as far as possible.
997 (if (not coding-system)
998 (setq coding-system auto-cs)
999 (if (not auto-cs)
1000 (setq auto-cs coding-system)
1001 (let ((eol-type-1 (coding-system-eol-type coding-system))
1002 (eol-type-2 (coding-system-eol-type auto-cs)))
1003 (if (eq (coding-system-base coding-system) 'undecided)
1004 (setq coding-system (coding-system-change-text-conversion
1005 coding-system auto-cs))
1006 (if (eq (coding-system-base auto-cs) 'undecided)
1007 (setq auto-cs (coding-system-change-text-conversion
1008 auto-cs coding-system))))
1009 (if (vectorp eol-type-1)
1010 (or (vectorp eol-type-2)
1011 (setq coding-system (coding-system-change-eol-conversion
1012 coding-system eol-type-2)))
1013 (if (vectorp eol-type-2)
1014 (setq auto-cs (coding-system-change-eol-conversion
1015 auto-cs eol-type-1)))))))
1017 (if (and auto-cs
1018 ;; Don't barf if writing a compressed file, say.
1019 ;; This check perhaps isn't ideal, but is probably
1020 ;; the best thing to do.
1021 (not (auto-coding-alist-lookup (or file buffer-file-name "")))
1022 (not (coding-system-equal coding-system auto-cs)))
1023 (unless (yes-or-no-p
1024 (format "Selected encoding %s disagrees with \
1025 %s specified by file contents. Really save (else edit coding cookies \
1026 and try again)? " coding-system auto-cs))
1027 (error "Save aborted"))))
1028 (when (and tick (/= tick (buffer-chars-modified-tick)))
1029 (error "Cancelled because the buffer was modified"))
1030 coding-system)))
1032 (setq select-safe-coding-system-function 'select-safe-coding-system)
1034 (defun select-message-coding-system ()
1035 "Return a coding system to encode the outgoing message of the current buffer.
1036 It at first tries the first coding system found in these variables
1037 in this order:
1038 (1) local value of `buffer-file-coding-system'
1039 (2) value of `sendmail-coding-system'
1040 (3) value of `default-sendmail-coding-system'
1041 (4) default value of `buffer-file-coding-system'
1042 If the found coding system can't encode the current buffer,
1043 or none of them are bound to a coding system,
1044 it asks the user to select a proper coding system."
1045 (let ((coding (or (and (local-variable-p 'buffer-file-coding-system)
1046 buffer-file-coding-system)
1047 sendmail-coding-system
1048 default-sendmail-coding-system
1049 (default-value 'buffer-file-coding-system))))
1050 (if (eq coding 'no-conversion)
1051 ;; We should never use no-conversion for outgoing mail.
1052 (setq coding nil))
1053 (if (fboundp select-safe-coding-system-function)
1054 (funcall select-safe-coding-system-function
1055 (point-min) (point-max) coding
1056 (function (lambda (x) (coding-system-get x :mime-charset))))
1057 coding)))
1059 ;;; Language support stuff.
1061 (defvar language-info-alist nil
1062 "Alist of language environment definitions.
1063 Each element looks like:
1064 (LANGUAGE-NAME . ((KEY . INFO) ...))
1065 where LANGUAGE-NAME is a string, the name of the language environment,
1066 KEY is a symbol denoting the kind of information, and
1067 INFO is the data associated with KEY.
1068 Meaningful values for KEY include
1070 documentation value is documentation of what this language environment
1071 is meant for, and how to use it.
1072 charset value is a list of the character sets mainly used
1073 by this language environment.
1074 sample-text value is an expression which is evalled to generate
1075 a line of text written using characters appropriate
1076 for this language environment.
1077 setup-function value is a function to call to switch to this
1078 language environment.
1079 exit-function value is a function to call to leave this
1080 language environment.
1081 coding-system value is a list of coding systems that are good for
1082 saving text written in this language environment.
1083 This list serves as suggestions to the user;
1084 in effect, as a kind of documentation.
1085 coding-priority value is a list of coding systems for this language
1086 environment, in order of decreasing priority.
1087 This is used to set up the coding system priority
1088 list when you switch to this language environment.
1089 nonascii-translation
1090 value is a charset of dimension one to use for
1091 converting a unibyte character to multibyte
1092 and vice versa.
1093 input-method value is a default input method for this language
1094 environment.
1095 features value is a list of features requested in this
1096 language environment.
1097 ctext-non-standard-encodings
1098 value is a list of non-standard encoding names used
1099 in extended segments of CTEXT. See the variable
1100 `ctext-non-standard-encodings' for more detail.
1102 The following key takes effect only when multibyte characters are
1103 globally disabled, i.e. the default value of `enable-multibyte-characters'
1104 is nil (which is an obsolete and deprecated use):
1106 unibyte-display value is a coding system to encode characters for
1107 the terminal. Characters in the range of 160 to
1108 255 display not as octal escapes, but as non-ASCII
1109 characters in this language environment.")
1111 (defun get-language-info (lang-env key)
1112 "Return information listed under KEY for language environment LANG-ENV.
1113 KEY is a symbol denoting the kind of information.
1114 For a list of useful values for KEY and their meanings,
1115 see `language-info-alist'."
1116 (if (symbolp lang-env)
1117 (setq lang-env (symbol-name lang-env)))
1118 (let ((lang-slot (assoc-string lang-env language-info-alist t)))
1119 (if lang-slot
1120 (cdr (assq key (cdr lang-slot))))))
1122 (defun set-language-info (lang-env key info)
1123 "Modify part of the definition of language environment LANG-ENV.
1124 Specifically, this stores the information INFO under KEY
1125 in the definition of this language environment.
1126 KEY is a symbol denoting the kind of information.
1127 INFO is the value for that information.
1129 For a list of useful values for KEY and their meanings,
1130 see `language-info-alist'."
1131 (if (symbolp lang-env)
1132 (setq lang-env (symbol-name lang-env)))
1133 (set-language-info-internal lang-env key info)
1134 (if (equal lang-env current-language-environment)
1135 (cond ((eq key 'coding-priority)
1136 (set-language-environment-coding-systems lang-env)
1137 (set-language-environment-charset lang-env))
1138 ((eq key 'input-method)
1139 (set-language-environment-input-method lang-env))
1140 ((eq key 'nonascii-translation)
1141 (set-language-environment-nonascii-translation lang-env))
1142 ((eq key 'charset)
1143 (set-language-environment-charset lang-env))
1144 ((and (not (default-value 'enable-multibyte-characters))
1145 (or (eq key 'unibyte-syntax) (eq key 'unibyte-display)))
1146 (set-language-environment-unibyte lang-env)))))
1148 (defun set-language-info-internal (lang-env key info)
1149 "Internal use only.
1150 Arguments are the same as `set-language-info'."
1151 (let (lang-slot key-slot)
1152 (setq lang-slot (assoc lang-env language-info-alist))
1153 (if (null lang-slot) ; If no slot for the language, add it.
1154 (setq lang-slot (list lang-env)
1155 language-info-alist (cons lang-slot language-info-alist)))
1156 (setq key-slot (assq key lang-slot))
1157 (if (null key-slot) ; If no slot for the key, add it.
1158 (progn
1159 (setq key-slot (list key))
1160 (setcdr lang-slot (cons key-slot (cdr lang-slot)))))
1161 (setcdr key-slot (purecopy info))
1162 ;; Update the custom-type of `current-language-environment'.
1163 (put 'current-language-environment 'custom-type
1164 (cons 'choice (mapcar
1165 (lambda (lang)
1166 (list 'const lang))
1167 (sort (mapcar 'car language-info-alist) 'string<))))))
1169 (defun set-language-info-alist (lang-env alist &optional parents)
1170 "Store ALIST as the definition of language environment LANG-ENV.
1171 ALIST is an alist of KEY and INFO values. See the documentation of
1172 `language-info-alist' for the meanings of KEY and INFO.
1174 Optional arg PARENTS is a list of parent menu names; it specifies
1175 where to put this language environment in the
1176 Describe Language Environment and Set Language Environment menus.
1177 For example, (\"European\") means to put this language environment
1178 in the European submenu in each of those two menus."
1179 (cond ((symbolp lang-env)
1180 (setq lang-env (symbol-name lang-env)))
1181 ((stringp lang-env)
1182 (setq lang-env (purecopy lang-env))))
1183 (let ((describe-map describe-language-environment-map)
1184 (setup-map setup-language-environment-map))
1185 (if parents
1186 (let ((l parents)
1187 map parent-symbol parent prompt)
1188 (while l
1189 (if (symbolp (setq parent-symbol (car l)))
1190 (setq parent (symbol-name parent))
1191 (setq parent parent-symbol parent-symbol (intern parent)))
1192 (setq map (lookup-key describe-map (vector parent-symbol)))
1193 ;; This prompt string is for define-prefix-command, so
1194 ;; that the map it creates will be suitable for a menu.
1195 (or map (setq prompt (format "%s Environment" parent)))
1196 (if (not map)
1197 (progn
1198 (setq map (intern (format "describe-%s-environment-map"
1199 (downcase parent))))
1200 (define-prefix-command map nil prompt)
1201 (define-key-after describe-map (vector parent-symbol)
1202 (cons parent map))))
1203 (setq describe-map (symbol-value map))
1204 (setq map (lookup-key setup-map (vector parent-symbol)))
1205 (if (not map)
1206 (progn
1207 (setq map (intern (format "setup-%s-environment-map"
1208 (downcase parent))))
1209 (define-prefix-command map nil prompt)
1210 (define-key-after setup-map (vector parent-symbol)
1211 (cons parent map))))
1212 (setq setup-map (symbol-value map))
1213 (setq l (cdr l)))))
1215 ;; Set up menu items for this language env.
1216 (let ((doc (assq 'documentation alist)))
1217 (when doc
1218 (define-key-after describe-map (vector (intern lang-env))
1219 (cons lang-env 'describe-specified-language-support))))
1220 (define-key-after setup-map (vector (intern lang-env))
1221 (cons lang-env 'setup-specified-language-environment))
1223 (dolist (elt alist)
1224 (set-language-info-internal lang-env (car elt) (cdr elt)))
1226 (if (equal lang-env current-language-environment)
1227 (set-language-environment lang-env))))
1229 (defun read-language-name (key prompt &optional default)
1230 "Read a language environment name which has information for KEY.
1231 If KEY is nil, read any language environment.
1232 Prompt with PROMPT. DEFAULT is the default choice of language environment.
1233 This returns a language environment name as a string."
1234 (let* ((completion-ignore-case t)
1235 (name (completing-read prompt
1236 language-info-alist
1237 (and key
1238 (function (lambda (elm) (and (listp elm) (assq key elm)))))
1239 t nil nil default)))
1240 (if (and (> (length name) 0)
1241 (or (not key)
1242 (get-language-info name key)))
1243 name)))
1245 ;;; Multilingual input methods.
1246 (defgroup leim nil
1247 "LEIM: Libraries of Emacs Input Methods."
1248 :group 'mule)
1250 (defconst leim-list-file-name "leim-list.el"
1251 "Name of LEIM list file.
1252 This file contains a list of libraries of Emacs input methods (LEIM)
1253 in the format of Lisp expression for registering each input method.
1254 Emacs loads this file at startup time.")
1256 (defconst leim-list-header (format
1257 ";;; %s -- list of LEIM (Library of Emacs Input Method) -*-coding: utf-8;-*-
1259 ;; This file is automatically generated.
1261 ;; This file contains a list of LEIM (Library of Emacs Input Method)
1262 ;; methods in the same directory as this file. Loading this file
1263 ;; registers all the input methods in Emacs.
1265 ;; Each entry has the form:
1266 ;; (register-input-method
1267 ;; INPUT-METHOD LANGUAGE-NAME ACTIVATE-FUNC
1268 ;; TITLE DESCRIPTION
1269 ;; ARG ...)
1270 ;; See the function `register-input-method' for the meanings of the arguments.
1272 ;; If this directory is included in `load-path', Emacs automatically
1273 ;; loads this file at startup time.
1276 leim-list-file-name)
1277 "Header to be inserted in LEIM list file.")
1279 (defconst leim-list-entry-regexp "^(register-input-method"
1280 "Regexp matching head of each entry in LEIM list file.
1281 See also the variable `leim-list-header'.")
1283 (defvar update-leim-list-functions
1284 '(quail-update-leim-list-file)
1285 "List of functions to call to update LEIM list file.
1286 Each function is called with one arg, LEIM directory name.")
1288 (defun update-leim-list-file (&rest dirs)
1289 "Update LEIM list file in directories DIRS."
1290 (dolist (function update-leim-list-functions)
1291 (apply function dirs)))
1293 (defvar current-input-method nil
1294 "The current input method for multilingual text.
1295 If nil, that means no input method is activated now.")
1296 (make-variable-buffer-local 'current-input-method)
1297 (put 'current-input-method 'permanent-local t)
1299 (defvar current-input-method-title nil
1300 "Title string of the current input method shown in mode line.")
1301 (make-variable-buffer-local 'current-input-method-title)
1302 (put 'current-input-method-title 'permanent-local t)
1304 (defcustom default-input-method nil
1305 "Default input method for multilingual text (a string).
1306 This is the input method activated automatically by the command
1307 `toggle-input-method' (\\[toggle-input-method])."
1308 :link '(custom-manual "(emacs)Input Methods")
1309 :group 'mule
1310 :type '(choice (const nil) (string
1311 :completion-ignore-case t
1312 :complete-function widget-string-complete
1313 :completion-alist input-method-alist
1314 :prompt-history input-method-history))
1315 :set-after '(current-language-environment))
1317 (put 'input-method-function 'permanent-local t)
1319 (defvar input-method-history nil
1320 "History list of input methods read from the minibuffer.
1322 Maximum length of the history list is determined by the value
1323 of `history-length', which see.")
1324 (make-variable-buffer-local 'input-method-history)
1325 (put 'input-method-history 'permanent-local t)
1327 (defvar inactivate-current-input-method-function nil
1328 "Function to call for inactivating the current input method.
1329 Every input method should set this to an appropriate value when activated.
1330 This function is called with no argument.
1332 This function should never change the value of `current-input-method'.
1333 It is set to nil by the function `inactivate-input-method'.")
1334 (make-variable-buffer-local 'inactivate-current-input-method-function)
1335 (put 'inactivate-current-input-method-function 'permanent-local t)
1337 (defvar describe-current-input-method-function nil
1338 "Function to call for describing the current input method.
1339 This function is called with no argument.")
1340 (make-variable-buffer-local 'describe-current-input-method-function)
1341 (put 'describe-current-input-method-function 'permanent-local t)
1343 (defvar input-method-alist nil
1344 "Alist of input method names vs how to use them.
1345 Each element has the form:
1346 (INPUT-METHOD LANGUAGE-ENV ACTIVATE-FUNC TITLE DESCRIPTION ARGS...)
1347 See the function `register-input-method' for the meanings of the elements.")
1348 ;;;###autoload
1349 (put 'input-method-alist 'risky-local-variable t)
1351 (defun register-input-method (input-method lang-env &rest args)
1352 "Register INPUT-METHOD as an input method for language environment LANG-ENV.
1354 INPUT-METHOD and LANG-ENV are symbols or strings.
1355 ACTIVATE-FUNC is a function to call to activate this method.
1356 TITLE is a string to show in the mode line when this method is active.
1357 DESCRIPTION is a string describing this method and what it is good for.
1358 The ARGS, if any, are passed as arguments to ACTIVATE-FUNC.
1359 All told, the arguments to ACTIVATE-FUNC are INPUT-METHOD and the ARGS.
1361 This function is mainly used in the file \"leim-list.el\" which is
1362 created at Emacs build time, registering all Quail input methods
1363 contained in the Emacs distribution.
1365 In case you want to register a new Quail input method by yourself, be
1366 careful to use the same input method title as given in the third
1367 parameter of `quail-define-package'. (If the values are different, the
1368 string specified in this function takes precedence.)
1370 The commands `describe-input-method' and `list-input-methods' need
1371 these duplicated values to show some information about input methods
1372 without loading the relevant Quail packages.
1373 \n(fn INPUT-METHOD LANG-ENV ACTIVATE-FUNC TITLE DESCRIPTION &rest ARGS)"
1374 (if (symbolp lang-env)
1375 (setq lang-env (symbol-name lang-env))
1376 (setq lang-env (purecopy lang-env)))
1377 (if (symbolp input-method)
1378 (setq input-method (symbol-name input-method))
1379 (setq input-method (purecopy input-method)))
1380 (setq args (mapcar 'purecopy args))
1381 (let ((info (cons lang-env args))
1382 (slot (assoc input-method input-method-alist)))
1383 (if slot
1384 (setcdr slot info)
1385 (setq slot (cons input-method info))
1386 (setq input-method-alist (cons slot input-method-alist)))))
1388 (defun read-input-method-name (prompt &optional default inhibit-null)
1389 "Read a name of input method from a minibuffer prompting with PROMPT.
1390 If DEFAULT is non-nil, use that as the default,
1391 and substitute it into PROMPT at the first `%s'.
1392 If INHIBIT-NULL is non-nil, null input signals an error.
1394 The return value is a string."
1395 (if default
1396 (setq prompt (format prompt default)))
1397 (let* ((completion-ignore-case t)
1398 ;; As it is quite normal to change input method in the
1399 ;; minibuffer, we must enable it even if
1400 ;; enable-recursive-minibuffers is currently nil.
1401 (enable-recursive-minibuffers t)
1402 ;; This binding is necessary because input-method-history is
1403 ;; buffer local.
1404 (input-method (completing-read prompt input-method-alist
1405 nil t nil 'input-method-history
1406 default)))
1407 (if (and input-method (symbolp input-method))
1408 (setq input-method (symbol-name input-method)))
1409 (if (> (length input-method) 0)
1410 input-method
1411 (if inhibit-null
1412 (error "No valid input method is specified")))))
1414 (defun activate-input-method (input-method)
1415 "Switch to input method INPUT-METHOD for the current buffer.
1416 If some other input method is already active, turn it off first.
1417 If INPUT-METHOD is nil, deactivate any current input method."
1418 (if (and input-method (symbolp input-method))
1419 (setq input-method (symbol-name input-method)))
1420 (if (and current-input-method
1421 (not (string= current-input-method input-method)))
1422 (inactivate-input-method))
1423 (unless (or current-input-method (null input-method))
1424 (let ((slot (assoc input-method input-method-alist)))
1425 (if (null slot)
1426 (error "Can't activate input method `%s'" input-method))
1427 (setq current-input-method-title nil)
1428 (let ((func (nth 2 slot)))
1429 (if (functionp func)
1430 (apply (nth 2 slot) input-method (nthcdr 5 slot))
1431 (if (and (consp func) (symbolp (car func)) (symbolp (cdr func)))
1432 (progn
1433 (require (cdr func))
1434 (apply (car func) input-method (nthcdr 5 slot)))
1435 (error "Can't activate input method `%s'" input-method))))
1436 (setq current-input-method input-method)
1437 (or (stringp current-input-method-title)
1438 (setq current-input-method-title (nth 3 slot)))
1439 (unwind-protect
1440 (run-hooks 'input-method-activate-hook)
1441 (force-mode-line-update)))))
1443 (defun inactivate-input-method ()
1444 "Turn off the current input method."
1445 (when current-input-method
1446 (if input-method-history
1447 (unless (string= current-input-method (car input-method-history))
1448 (setq input-method-history
1449 (cons current-input-method
1450 (delete current-input-method input-method-history))))
1451 (setq input-method-history (list current-input-method)))
1452 (unwind-protect
1453 (progn
1454 (setq input-method-function nil
1455 current-input-method-title nil)
1456 (funcall inactivate-current-input-method-function))
1457 (unwind-protect
1458 (run-hooks 'input-method-inactivate-hook)
1459 (setq current-input-method nil)
1460 (force-mode-line-update)))))
1462 (defun set-input-method (input-method &optional interactive)
1463 "Select and activate input method INPUT-METHOD for the current buffer.
1464 This also sets the default input method to the one you specify.
1465 If INPUT-METHOD is nil, this function turns off the input method, and
1466 also causes you to be prompted for a name of an input method the next
1467 time you invoke \\[toggle-input-method].
1468 When called interactively, the optional arg INTERACTIVE is non-nil,
1469 which marks the variable `default-input-method' as set for Custom buffers.
1471 To deactivate the input method interactively, use \\[toggle-input-method].
1472 To deactivate it programmatically, use `inactivate-input-method'."
1473 (interactive
1474 (let* ((default (or (car input-method-history) default-input-method)))
1475 (list (read-input-method-name
1476 (if default "Select input method (default %s): " "Select input method: ")
1477 default t)
1478 t)))
1479 (activate-input-method input-method)
1480 (setq default-input-method input-method)
1481 (when interactive
1482 (customize-mark-as-set 'default-input-method))
1483 default-input-method)
1485 (defvar toggle-input-method-active nil
1486 "Non-nil inside `toggle-input-method'.")
1488 (defun toggle-input-method (&optional arg interactive)
1489 "Enable or disable multilingual text input method for the current buffer.
1490 Only one input method can be enabled at any time in a given buffer.
1492 The normal action is to enable an input method if none was enabled,
1493 and disable the current one otherwise. Which input method to enable
1494 can be determined in various ways--either the one most recently used,
1495 or the one specified by `default-input-method', or as a last resort
1496 by reading the name of an input method in the minibuffer.
1498 With a prefix argument ARG, read an input method name with the minibuffer
1499 and enable that one. The default is the most recent input method specified
1500 \(not including the currently active input method, if any).
1502 When called interactively, the optional argument INTERACTIVE is non-nil,
1503 which marks the variable `default-input-method' as set for Custom buffers."
1505 (interactive "P\np")
1506 (if toggle-input-method-active
1507 (error "Recursive use of `toggle-input-method'"))
1508 (if (and current-input-method (not arg))
1509 (inactivate-input-method)
1510 (let ((toggle-input-method-active t)
1511 (default (or (car input-method-history) default-input-method)))
1512 (if (and arg default (equal current-input-method default)
1513 (> (length input-method-history) 1))
1514 (setq default (nth 1 input-method-history)))
1515 (activate-input-method
1516 (if (or arg (not default))
1517 (progn
1518 (read-input-method-name
1519 (if default "Input method (default %s): " "Input method: " )
1520 default t))
1521 default))
1522 (unless default-input-method
1523 (prog1
1524 (setq default-input-method current-input-method)
1525 (when interactive
1526 (customize-mark-as-set 'default-input-method)))))))
1528 (autoload 'help-buffer "help-mode")
1530 (defun describe-input-method (input-method)
1531 "Describe input method INPUT-METHOD."
1532 (interactive
1533 (list (read-input-method-name
1534 "Describe input method (default current choice): ")))
1535 (if (and input-method (symbolp input-method))
1536 (setq input-method (symbol-name input-method)))
1537 (help-setup-xref (list #'describe-input-method
1538 (or input-method current-input-method))
1539 (called-interactively-p 'interactive))
1541 (if (null input-method)
1542 (describe-current-input-method)
1543 (let ((current current-input-method))
1544 (condition-case nil
1545 (progn
1546 (save-excursion
1547 (activate-input-method input-method)
1548 (describe-current-input-method))
1549 (activate-input-method current))
1550 (error
1551 (activate-input-method current)
1552 (help-setup-xref (list #'describe-input-method input-method)
1553 (called-interactively-p 'interactive))
1554 (with-output-to-temp-buffer (help-buffer)
1555 (let ((elt (assoc input-method input-method-alist)))
1556 (princ (format
1557 "Input method: %s (`%s' in mode line) for %s\n %s\n"
1558 input-method (nth 3 elt) (nth 1 elt) (nth 4 elt))))))))))
1560 (defun describe-current-input-method ()
1561 "Describe the input method currently in use.
1562 This is a subroutine for `describe-input-method'."
1563 (if current-input-method
1564 (if (and (symbolp describe-current-input-method-function)
1565 (fboundp describe-current-input-method-function))
1566 (funcall describe-current-input-method-function)
1567 (message "No way to describe the current input method `%s'"
1568 current-input-method)
1569 (ding))
1570 (error "No input method is activated now")))
1572 (defun read-multilingual-string (prompt &optional initial-input input-method)
1573 "Read a multilingual string from minibuffer, prompting with string PROMPT.
1574 The input method selected last time is activated in minibuffer.
1575 If optional second argument INITIAL-INPUT is non-nil, insert it in the
1576 minibuffer initially.
1577 Optional 3rd argument INPUT-METHOD specifies the input method to be activated
1578 instead of the one selected last time. It is a symbol or a string."
1579 (setq input-method
1580 (or input-method
1581 current-input-method
1582 default-input-method
1583 (read-input-method-name "Input method: " nil t)))
1584 (if (and input-method (symbolp input-method))
1585 (setq input-method (symbol-name input-method)))
1586 (let ((prev-input-method current-input-method))
1587 (unwind-protect
1588 (progn
1589 (activate-input-method input-method)
1590 (read-string prompt initial-input nil nil t))
1591 (activate-input-method prev-input-method))))
1593 ;; Variables to control behavior of input methods. All input methods
1594 ;; should react to these variables.
1596 (defcustom input-method-verbose-flag 'default
1597 "A flag to control extra guidance given by input methods.
1598 The value should be nil, t, `complex-only', or `default'.
1600 The extra guidance is done by showing list of available keys in echo
1601 area. When you use the input method in the minibuffer, the guidance
1602 is shown at the bottom short window (split from the existing window).
1604 If the value is t, extra guidance is always given, if the value is
1605 nil, extra guidance is always suppressed.
1607 If the value is `complex-only', only complex input methods such as
1608 `chinese-py' and `japanese' give extra guidance.
1610 If the value is `default', complex input methods always give extra
1611 guidance, but simple input methods give it only when you are not in
1612 the minibuffer.
1614 See also the variable `input-method-highlight-flag'."
1615 :type '(choice (const :tag "Always" t) (const :tag "Never" nil)
1616 (const complex-only) (const default))
1617 :group 'mule)
1619 (defcustom input-method-highlight-flag t
1620 "If this flag is non-nil, input methods highlight partially-entered text.
1621 For instance, while you are in the middle of a Quail input method sequence,
1622 the text inserted so far is temporarily underlined.
1623 The underlining goes away when you finish or abort the input method sequence.
1624 See also the variable `input-method-verbose-flag'."
1625 :type 'boolean
1626 :group 'mule)
1628 (defcustom input-method-activate-hook nil
1629 "Normal hook run just after an input method is activated.
1631 The variable `current-input-method' keeps the input method name
1632 just activated."
1633 :type 'hook
1634 :group 'mule)
1636 (defcustom input-method-inactivate-hook nil
1637 "Normal hook run just after an input method is inactivated.
1639 The variable `current-input-method' still keeps the input method name
1640 just inactivated."
1641 :type 'hook
1642 :group 'mule)
1644 (defcustom input-method-after-insert-chunk-hook nil
1645 "Normal hook run just after an input method insert some chunk of text."
1646 :type 'hook
1647 :group 'mule)
1649 (defvar input-method-exit-on-first-char nil
1650 "This flag controls when an input method returns.
1651 Usually, the input method does not return while there's a possibility
1652 that it may find a different translation if a user types another key.
1653 But, if this flag is non-nil, the input method returns as soon as the
1654 current key sequence gets long enough to have some valid translation.")
1656 (defcustom input-method-use-echo-area nil
1657 "This flag controls how an input method shows an intermediate key sequence.
1658 Usually, the input method inserts the intermediate key sequence,
1659 or candidate translations corresponding to the sequence,
1660 at point in the current buffer.
1661 But, if this flag is non-nil, it displays them in echo area instead."
1662 :type 'hook
1663 :group 'mule)
1665 (defvar input-method-exit-on-invalid-key nil
1666 "This flag controls the behavior of an input method on invalid key input.
1667 Usually, when a user types a key which doesn't start any character
1668 handled by the input method, the key is handled by turning off the
1669 input method temporarily. After that key, the input method is re-enabled.
1670 But, if this flag is non-nil, the input method is never back on.")
1673 (defcustom set-language-environment-hook nil
1674 "Normal hook run after some language environment is set.
1676 When you set some hook function here, that effect usually should not
1677 be inherited to another language environment. So, you had better set
1678 another function in `exit-language-environment-hook' (which see) to
1679 cancel the effect."
1680 :type 'hook
1681 :group 'mule)
1683 (defcustom exit-language-environment-hook nil
1684 "Normal hook run after exiting from some language environment.
1685 When this hook is run, the variable `current-language-environment'
1686 is still bound to the language environment being exited.
1688 This hook is mainly used for canceling the effect of
1689 `set-language-environment-hook' (which see)."
1690 :type 'hook
1691 :group 'mule)
1693 (put 'setup-specified-language-environment 'apropos-inhibit t)
1695 (defun setup-specified-language-environment ()
1696 "Switch to a specified language environment."
1697 (interactive)
1698 (let (language-name)
1699 (if (and (symbolp last-command-event)
1700 (or (not (eq last-command-event 'Default))
1701 (setq last-command-event 'English))
1702 (setq language-name (symbol-name last-command-event)))
1703 (prog1
1704 (set-language-environment language-name)
1705 (customize-mark-as-set 'current-language-environment))
1706 (error "Bogus calling sequence"))))
1708 (defcustom current-language-environment "English"
1709 "The last language environment specified with `set-language-environment'.
1710 This variable should be set only with \\[customize], which is equivalent
1711 to using the function `set-language-environment'."
1712 :link '(custom-manual "(emacs)Language Environments")
1713 :set (lambda (symbol value) (set-language-environment value))
1714 :get (lambda (x)
1715 (or (car-safe (assoc-string
1716 (if (symbolp current-language-environment)
1717 (symbol-name current-language-environment)
1718 current-language-environment)
1719 language-info-alist t))
1720 "English"))
1721 ;; custom type will be updated with `set-language-info'.
1722 :type (if language-info-alist
1723 (cons 'choice (mapcar
1724 (lambda (lang)
1725 (list 'const lang))
1726 (sort (mapcar 'car language-info-alist) 'string<)))
1727 'string)
1728 :initialize 'custom-initialize-default
1729 :group 'mule)
1731 (defun reset-language-environment ()
1732 "Reset multilingual environment of Emacs to the default status.
1734 The default status is as follows:
1736 The default value of `buffer-file-coding-system' is nil.
1737 The default coding system for process I/O is nil.
1738 The default value for the command `set-terminal-coding-system' is nil.
1739 The default value for the command `set-keyboard-coding-system' is nil.
1741 The order of priorities of coding systems are as follows:
1742 utf-8
1743 iso-2022-7bit
1744 iso-latin-1
1745 iso-2022-7bit-lock
1746 iso-2022-8bit-ss2
1747 emacs-mule
1748 raw-text"
1749 (interactive)
1750 ;; This function formerly set default-enable-multibyte-characters to t,
1751 ;; but that is incorrect. It should not alter the unibyte/multibyte choice.
1753 (set-coding-system-priority
1754 'utf-8
1755 'iso-2022-7bit
1756 'iso-latin-1
1757 'iso-2022-7bit-lock
1758 'iso-2022-8bit-ss2
1759 'emacs-mule
1760 'raw-text)
1762 (set-default-coding-systems nil)
1763 (setq default-sendmail-coding-system 'iso-latin-1)
1764 ;; On Darwin systems, this should be utf-8, but when this file is loaded
1765 ;; utf-8 is not yet defined, so we set it in set-locale-environment instead.
1766 (setq default-file-name-coding-system 'iso-latin-1)
1767 ;; Preserve eol-type from existing default-process-coding-systems.
1768 ;; On non-unix-like systems in particular, these may have been set
1769 ;; carefully by the user, or by the startup code, to deal with the
1770 ;; users shell appropriately, so should not be altered by changing
1771 ;; language environment.
1772 (let ((output-coding
1773 ;; When bootstrapping, coding-systems are not defined yet, so
1774 ;; we need to catch the error from check-coding-system.
1775 (condition-case nil
1776 (coding-system-change-text-conversion
1777 (car default-process-coding-system) 'undecided)
1778 (coding-system-error 'undecided)))
1779 (input-coding
1780 (condition-case nil
1781 (coding-system-change-text-conversion
1782 (cdr default-process-coding-system) 'iso-latin-1)
1783 (coding-system-error 'iso-latin-1))))
1784 (setq default-process-coding-system
1785 (cons output-coding input-coding)))
1787 ;; Put the highest priority to the charset iso-8859-1 to prefer the
1788 ;; registry iso8859-1 over iso8859-2 in font selection. It also
1789 ;; makes unibyte-display-via-language-environment to use iso-8859-1
1790 ;; as the unibyte charset.
1791 (set-charset-priority 'iso-8859-1)
1793 ;; Don't alter the terminal and keyboard coding systems here.
1794 ;; The terminal still supports the same coding system
1795 ;; that it supported a minute ago.
1796 ;; (set-terminal-coding-system-internal nil)
1797 ;; (set-keyboard-coding-system-internal nil)
1799 ;; Back in Emacs-20, it was necessary to provide some fallback implicit
1800 ;; conversion, because almost no packages handled coding-system issues.
1801 ;; Nowadays it'd just paper over bugs.
1802 ;; (set-unibyte-charset 'iso-8859-1)
1805 (reset-language-environment)
1807 (defun set-display-table-and-terminal-coding-system (language-name &optional coding-system display)
1808 "Set up the display table and terminal coding system for LANGUAGE-NAME."
1809 (let ((coding (get-language-info language-name 'unibyte-display)))
1810 (if (and coding
1811 (or (not coding-system)
1812 (coding-system-equal coding coding-system)))
1813 (standard-display-european-internal)
1814 ;; The following 2 lines undo the 8-bit display that we set up
1815 ;; in standard-display-european-internal, which see. This is in
1816 ;; case the user has used standard-display-european earlier in
1817 ;; this session.
1818 (when standard-display-table
1819 (dotimes (i 128)
1820 (aset standard-display-table (+ i 128) nil))))
1821 (set-terminal-coding-system (or coding-system coding) display)))
1823 (defun set-language-environment (language-name)
1824 "Set up multi-lingual environment for using LANGUAGE-NAME.
1825 This sets the coding system priority and the default input method
1826 and sometimes other things. LANGUAGE-NAME should be a string
1827 which is the name of a language environment. For example, \"Latin-1\"
1828 specifies the character set for the major languages of Western Europe."
1829 (interactive (list (read-language-name
1831 "Set language environment (default English): ")))
1832 (if language-name
1833 (if (symbolp language-name)
1834 (setq language-name (symbol-name language-name)))
1835 (setq language-name "English"))
1836 (let ((slot (assoc-string language-name language-info-alist t)))
1837 (unless slot
1838 (error "Language environment not defined: %S" language-name))
1839 (setq language-name (car slot)))
1840 (if current-language-environment
1841 (let ((func (get-language-info current-language-environment
1842 'exit-function)))
1843 (run-hooks 'exit-language-environment-hook)
1844 (if (functionp func) (funcall func))))
1846 (reset-language-environment)
1847 ;; The features might set up coding systems.
1848 (let ((required-features (get-language-info language-name 'features)))
1849 (while required-features
1850 (require (car required-features))
1851 (setq required-features (cdr required-features))))
1853 (setq current-language-environment language-name)
1855 (set-language-environment-coding-systems language-name)
1856 (set-language-environment-input-method language-name)
1857 (set-language-environment-nonascii-translation language-name)
1858 (set-language-environment-charset language-name)
1859 ;; Unibyte setups if necessary.
1860 (unless (default-value 'enable-multibyte-characters)
1861 (set-language-environment-unibyte language-name))
1863 (let ((func (get-language-info language-name 'setup-function)))
1864 (if (functionp func)
1865 (funcall func)))
1867 (setq current-iso639-language
1868 (or (get-language-info language-name 'iso639-language)
1869 current-iso639-language))
1871 (run-hooks 'set-language-environment-hook)
1872 (force-mode-line-update t))
1874 (define-widget 'charset 'symbol
1875 "An Emacs charset."
1876 :tag "Charset"
1877 :complete-function (lambda ()
1878 (interactive)
1879 (lisp-complete-symbol 'charsetp))
1880 :completion-ignore-case t
1881 :value 'ascii
1882 :validate (lambda (widget)
1883 (unless (charsetp (widget-value widget))
1884 (widget-put widget :error (format "Invalid charset: %S"
1885 (widget-value widget)))
1886 widget))
1887 :prompt-history 'charset-history)
1889 (defcustom language-info-custom-alist nil
1890 "Customizations of language environment parameters.
1891 Value is an alist with elements like those of `language-info-alist'.
1892 These are used to set values in `language-info-alist' which replace
1893 the defaults. A typical use is replacing the default input method for
1894 the environment. Use \\[describe-language-environment] to find the environment's settings.
1896 This option is intended for use at startup. Removing items doesn't
1897 remove them from the language info until you next restart Emacs.
1899 Setting this variable directly does not take effect.
1900 See `set-language-info-alist' for use in programs."
1901 :group 'mule
1902 :version "23.1"
1903 :set (lambda (s v)
1904 (custom-set-default s v)
1905 ;; Can't do this before language environments are set up.
1906 (when v
1907 ;; modify language-info-alist
1908 (dolist (elt v)
1909 (set-language-info-alist (car elt) (cdr elt)))
1910 ;; re-set the environment in case its parameters changed
1911 (set-language-environment current-language-environment)))
1912 :type `(alist
1913 :key-type (string :tag "Language environment"
1914 :completion-ignore-case t
1915 :complete-function widget-string-complete
1916 :completion-alist language-info-alist)
1917 :value-type
1918 (alist :key-type symbol
1919 :options ((documentation string)
1920 (charset (repeat charset))
1921 (sample-text string)
1922 (setup-function function)
1923 (exit-function function)
1924 (coding-system (repeat coding-system))
1925 (coding-priority (repeat coding-system))
1926 (nonascii-translation charset)
1927 (input-method
1928 (string
1929 :completion-ignore-case t
1930 :complete-function widget-string-complete
1931 :completion-alist input-method-alist
1932 :prompt-history input-method-history))
1933 (features (repeat symbol))
1934 (unibyte-display coding-system)))))
1936 (declare-function x-server-vendor "xfns.c" (&optional terminal))
1937 (declare-function x-server-version "xfns.c" (&optional terminal))
1939 (defun standard-display-european-internal ()
1940 ;; Actually set up direct output of non-ASCII characters.
1941 (standard-display-8bit (if (eq window-system 'pc) 128 160) 255)
1942 ;; Unibyte Emacs on MS-DOS wants to display all 8-bit characters with
1943 ;; the native font, and codes 160 and 146 stand for something very
1944 ;; different there.
1945 (or (and (eq window-system 'pc) (not (default-value
1946 'enable-multibyte-characters)))
1947 (progn
1948 ;; Most X fonts used to do the wrong thing for latin-1 code 160.
1949 (unless (and (eq window-system 'x)
1950 ;; XFree86 4 has fixed the fonts.
1951 (string= "The XFree86 Project, Inc" (x-server-vendor))
1952 (> (aref (number-to-string (nth 2 (x-server-version))) 0)
1953 ?3))
1954 ;; Make non-line-break space display as a plain space.
1955 (aset standard-display-table (unibyte-char-to-multibyte 160) [32]))
1956 ;; Most Windows programs send out apostrophes as \222. Most X fonts
1957 ;; don't contain a character at that position. Map it to the ASCII
1958 ;; apostrophe. [This is actually RIGHT SINGLE QUOTATION MARK,
1959 ;; U+2019, normally from the windows-1252 character set. XFree 4
1960 ;; fonts probably have the appropriate glyph at this position,
1961 ;; so they could use standard-display-8bit. It's better to use a
1962 ;; proper windows-1252 coding system. --fx]
1963 (aset standard-display-table (unibyte-char-to-multibyte 146) [39]))))
1965 (defun set-language-environment-coding-systems (language-name)
1966 "Do various coding system setups for language environment LANGUAGE-NAME."
1967 (let* ((priority (get-language-info language-name 'coding-priority))
1968 (default-coding (car priority))
1969 ;; If the default buffer-file-coding-system is nil, don't use
1970 ;; coding-system-eol-type, because it treats nil as
1971 ;; `no-conversion'. The default buffer-file-coding-system is set
1972 ;; to nil by reset-language-environment, and in that case we
1973 ;; want to have here the native EOL type for each platform.
1974 ;; FIXME: there should be a common code that runs both on
1975 ;; startup and here to set the default EOL type correctly.
1976 ;; Right now, DOS/Windows platforms set this on dos-w32.el,
1977 ;; which works only as long as the order of loading files at
1978 ;; dump time and calling functions at startup is not modified
1979 ;; significantly, i.e. as long as this function is called
1980 ;; _after_ the default buffer-file-coding-system was set by
1981 ;; dos-w32.el.
1982 (eol-type
1983 (coding-system-eol-type
1984 (or (default-value 'buffer-file-coding-system)
1985 (if (memq system-type '(windows-nt ms-dos)) 'dos 'unix)))))
1986 (when priority
1987 (set-default-coding-systems
1988 (if (memq eol-type '(0 1 2 unix dos mac))
1989 (coding-system-change-eol-conversion default-coding eol-type)
1990 default-coding))
1991 (setq default-sendmail-coding-system default-coding)
1992 (apply 'set-coding-system-priority priority))))
1994 (defun set-language-environment-input-method (language-name)
1995 "Do various input method setups for language environment LANGUAGE-NAME."
1996 (let ((input-method (get-language-info language-name 'input-method)))
1997 (when input-method
1998 (setq default-input-method input-method)
1999 (if input-method-history
2000 (setq input-method-history
2001 (cons input-method
2002 (delete input-method input-method-history)))))))
2004 (defun set-language-environment-nonascii-translation (language-name)
2005 "Do unibyte/multibyte translation setup for language environment LANGUAGE-NAME."
2006 ;; Note: For DOS, we assumed that the charset cpXXX is already
2007 ;; defined.
2008 (let ((nonascii (get-language-info language-name 'nonascii-translation)))
2009 (if (eq window-system 'pc)
2010 (setq nonascii (intern (format "cp%d" dos-codepage))))
2011 (or (and (charsetp nonascii)
2012 (get-charset-property nonascii :ascii-compatible-p))
2013 (setq nonascii 'iso-8859-1))
2014 ;; Back in Emacs-20, it was necessary to provide some fallback implicit
2015 ;; conversion, because almost no packages handled coding-system issues.
2016 ;; Nowadays it'd just paper over bugs.
2017 ;; (set-unibyte-charset nonascii)
2020 (defun set-language-environment-charset (language-name)
2021 "Do various charset setups for language environment LANGUAGE-NAME."
2022 ;; Put higher priorities to such charsets that are supported by the
2023 ;; coding systems of higher priorities in this environment.
2024 (let ((charsets (get-language-info language-name 'charset)))
2025 (dolist (coding (get-language-info language-name 'coding-priority))
2026 (let ((list (coding-system-charset-list coding)))
2027 (if (consp list)
2028 (setq charsets (append charsets list)))))
2029 (if charsets
2030 (apply 'set-charset-priority charsets))))
2032 (defun set-language-environment-unibyte (language-name)
2033 "Do various unibyte-mode setups for language environment LANGUAGE-NAME."
2034 (set-display-table-and-terminal-coding-system language-name))
2036 (defun princ-list (&rest args)
2037 "Print all arguments with `princ', then print \"\\n\"."
2038 (mapc #'princ args)
2039 (princ "\n"))
2040 (make-obsolete 'princ-list "use mapc and princ instead" "23.3")
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")
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)
2887 (make-obsolete-variable 'nonascii-insert-offset "do not use it." "23.1")
2888 (defvar nonascii-translation-table nil)
2889 (make-obsolete-variable 'nonascii-translation-table "do not use it." "23.1")
2891 (defvar ucs-names nil
2892 "Alist of cached (CHAR-NAME . CHAR-CODE) pairs.")
2894 (defun ucs-names ()
2895 "Return alist of (CHAR-NAME . CHAR-CODE) pairs cached in `ucs-names'."
2896 (or ucs-names
2897 (let ((bmp-ranges
2898 '((#x0000 . #x33FF)
2899 ;; (#x3400 . #x4DBF) CJK Ideographs Extension A
2900 (#x4DC0 . #x4DFF)
2901 ;; (#x4E00 . #x9FFF) CJK Unified Ideographs
2902 (#xA000 . #xD7FF)
2903 ;; (#xD800 . #xFAFF) Surrogate/Private
2904 (#xFB00 . #xFFFD)))
2905 (upper-ranges
2906 '((#x10000 . #x134FF)
2907 ;; (#x13500 . #x167FF) unused
2908 (#x16800 . #x16A3F)
2909 ;; (#x16A40 . #x1AFFF) unused
2910 (#x1B000 . #x1B0FF)
2911 ;; (#x1B100 . #x1CFFF) unused
2912 (#x1D000 . #x1FFFF)
2913 ;; (#x20000 . #xDFFFF) CJK Ideograph Extension A, B, etc, unused
2914 (#xE0000 . #xE01FF)))
2915 (gc-cons-threshold 10000000)
2916 c end name names)
2917 (dolist (range bmp-ranges)
2918 (setq c (car range)
2919 end (cdr range))
2920 (while (<= c end)
2921 (if (setq name (get-char-code-property c 'name))
2922 (push (cons name c) names))
2923 (if (setq name (get-char-code-property c 'old-name))
2924 (push (cons name c) names))
2925 (setq c (1+ c))))
2926 (dolist (range upper-ranges)
2927 (setq c (car range)
2928 end (cdr range))
2929 (while (<= c end)
2930 (if (setq name (get-char-code-property c 'name))
2931 (push (cons name c) names))
2932 (setq c (1+ c))))
2933 (setq ucs-names names))))
2935 (defvar ucs-completions (lazy-completion-table ucs-completions ucs-names)
2936 "Lazy completion table for completing on Unicode character names.")
2937 (put 'ucs-completions 'risky-local-variable t)
2939 (defun read-char-by-name (prompt)
2940 "Read a character by its Unicode name or hex number string.
2941 Display PROMPT and read a string that represents a character by its
2942 Unicode property `name' or `old-name'. You can type a few of first
2943 letters of the Unicode name and use completion. This function also
2944 accepts a hexadecimal number of Unicode code point or a number in
2945 hash notation, e.g. #o21430 for octal, #x2318 for hex, or #10r8984
2946 for decimal. Returns a character as a number."
2947 (let* ((completion-ignore-case t)
2948 (input (completing-read prompt ucs-completions)))
2949 (cond
2950 ((string-match-p "^[0-9a-fA-F]+$" input)
2951 (string-to-number input 16))
2952 ((string-match-p "^#" input)
2953 (read input))
2955 (cdr (assoc-string input (ucs-names) t))))))
2957 (defun ucs-insert (character &optional count inherit)
2958 "Insert COUNT copies of CHARACTER of the given Unicode code point.
2959 Interactively, prompts for a Unicode character name or a hex number
2960 using `read-char-by-name'.
2961 The optional third arg INHERIT (non-nil when called interactively),
2962 says to inherit text properties from adjoining text, if those
2963 properties are sticky."
2964 (interactive
2965 (list (read-char-by-name "Unicode (name or hex): ")
2966 (prefix-numeric-value current-prefix-arg)
2968 (unless count (setq count 1))
2969 (if (stringp character)
2970 (setq character (string-to-number character 16)))
2971 (cond
2972 ((not (integerp character))
2973 (error "Not a Unicode character code: %S" character))
2974 ((or (< character 0) (> character #x10FFFF))
2975 (error "Not a Unicode character code: 0x%X" character)))
2976 (if inherit
2977 (dotimes (i count) (insert-and-inherit character))
2978 (dotimes (i count) (insert character))))
2980 (define-key ctl-x-map "8\r" 'ucs-insert)
2982 ;;; mule-cmds.el ends here