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