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