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