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