mule-cmds.el 78.3 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1 2 3
;;; mule-cmds.el --- Commands for mulitilingual environment

;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
Richard M. Stallman's avatar
Richard M. Stallman committed
4
;; Licensed to the Free Software Foundation.
Dave Love's avatar
Dave Love committed
5
;; Copyright (C) 2000 Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

;; Keywords: mule, multilingual

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Karl Heuer's avatar
Karl Heuer committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Karl Heuer's avatar
Karl Heuer committed
25 26 27

;;; Code:

Dave Love's avatar
Dave Love committed
28 29
(eval-when-compile (defvar dos-codepage))

Karl Heuer's avatar
Karl Heuer committed
30 31
;;; MULE related key bindings and menus.

Richard M. Stallman's avatar
Richard M. Stallman committed
32
(defvar mule-keymap (make-sparse-keymap)
33
  "Keymap for Mule (Multilingual environment) specific commands.")
Karl Heuer's avatar
Karl Heuer committed
34

35
;; Keep "C-x C-m ..." for mule specific commands.
Richard M. Stallman's avatar
Richard M. Stallman committed
36
(define-key ctl-x-map "\C-m" mule-keymap)
Kenichi Handa's avatar
Kenichi Handa committed
37

Karl Heuer's avatar
Karl Heuer committed
38 39
(define-key mule-keymap "f" 'set-buffer-file-coding-system)
(define-key mule-keymap "t" 'set-terminal-coding-system)
40 41
(define-key mule-keymap "k" 'set-keyboard-coding-system)
(define-key mule-keymap "p" 'set-buffer-process-coding-system)
42 43
(define-key mule-keymap "x" 'set-selection-coding-system)
(define-key mule-keymap "X" 'set-next-selection-coding-system)
44
(define-key mule-keymap "\C-\\" 'set-input-method)
45
(define-key mule-keymap "c" 'universal-coding-system-argument)
46
(define-key mule-keymap "l" 'set-language-environment)
Karl Heuer's avatar
Karl Heuer committed
47

48
(define-key help-map "\C-L" 'describe-language-environment)
49
(define-key help-map "L" 'describe-language-environment)
Karl Heuer's avatar
Karl Heuer committed
50
(define-key help-map "\C-\\" 'describe-input-method)
51
(define-key help-map "I" 'describe-input-method)
52
(define-key help-map "C" 'describe-coding-system)
Karl Heuer's avatar
Karl Heuer committed
53 54
(define-key help-map "h" 'view-hello-file)

Eli Zaretskii's avatar
Eli Zaretskii committed
55 56
(defvar mule-menu-keymap
  (make-sparse-keymap "Mule (Multilingual Environment)")
57
  "Keymap for Mule (Multilingual environment) menu specific commands.")
58

59 60
(defvar describe-language-environment-map
  (make-sparse-keymap "Describe Language Environment"))
61

62 63
(defvar setup-language-environment-map
  (make-sparse-keymap "Set Language Environment"))
64

65 66
(defvar set-coding-system-map
  (make-sparse-keymap "Set Coding System"))
67 68

(define-key-after mule-menu-keymap [set-language-environment]
Dave Love's avatar
Dave Love committed
69 70
  (list 'menu-item  "Set Language Environment" setup-language-environment-map
	:help "Multilingual environment suitable for a specific language"))
71
(define-key-after mule-menu-keymap [mouse-set-font]
Eli Zaretskii's avatar
Eli Zaretskii committed
72
  '(menu-item "Set Font/Fontset" mouse-set-font
Dave Love's avatar
Dave Love committed
73 74
	       :visible (fboundp 'generate-fontset-menu)
	       :help "Select a font from list of known fonts/fontsets"))
75 76 77 78
(define-key-after mule-menu-keymap [separator-mule]
  '("--")
  t)
(define-key-after mule-menu-keymap [toggle-input-method]
Eli Zaretskii's avatar
Eli Zaretskii committed
79
  '(menu-item "Toggle Input Method" toggle-input-method)
80
  t)
81
(define-key-after mule-menu-keymap [set-input-method]
Eli Zaretskii's avatar
Eli Zaretskii committed
82
  '(menu-item "Select Input Method..." set-input-method)
83
  t)
Dave Love's avatar
Dave Love committed
84 85
(define-key-after mule-menu-keymap [describe-input-method]
  '(menu-item "Describe Input Method"  describe-input-method))
86 87 88 89
(define-key-after mule-menu-keymap [separator-input-method]
  '("--")
  t)
(define-key-after mule-menu-keymap [set-various-coding-system]
Dave Love's avatar
Dave Love committed
90 91
  (list 'menu-item "Set Coding Systems" set-coding-system-map
	:enable 'enable-multibyte-characters))
Eli Zaretskii's avatar
Eli Zaretskii committed
92 93 94 95 96
(define-key-after mule-menu-keymap [view-hello-file]
  '(menu-item "Show Multi-lingual Text" view-hello-file
	      :enable (file-readable-p
		       (expand-file-name "HELLO" data-directory))
	      :help "Display file which says HELLO in many languages")
97 98 99 100
  t)
(define-key-after mule-menu-keymap [separator-coding-system]
  '("--")
  t)
Eli Zaretskii's avatar
Eli Zaretskii committed
101 102 103
(define-key-after mule-menu-keymap [describe-language-environment]
  (list 'menu-item "Describe Language Environment"
	describe-language-environment-map
Dave Love's avatar
Dave Love committed
104
	:help "Show multilingual settings for a specific language")
105
  t)
Eli Zaretskii's avatar
Eli Zaretskii committed
106 107
(define-key-after mule-menu-keymap [describe-input-method]
  '(menu-item "Describe Input Method..." describe-input-method
Dave Love's avatar
Dave Love committed
108
	      :help "Keyboard layout for a specific input method")
Eli Zaretskii's avatar
Eli Zaretskii committed
109 110 111 112
  t)
(define-key-after mule-menu-keymap [describe-coding-system]
  '(menu-item "Describe Coding System..." describe-coding-system)
  t)
Dave Love's avatar
Dave Love committed
113 114 115
(define-key-after mule-menu-keymap [list-character-sets]
  '(menu-item "List Character Sets" list-character-sets
	      :help "Show table of available character sets"))
Eli Zaretskii's avatar
Eli Zaretskii committed
116 117 118
(define-key-after mule-menu-keymap [mule-diag]
  '(menu-item "Show All of Mule Status" mule-diag
	      :help "Display multilingual environment settings")
119 120 121
  t)

(define-key-after set-coding-system-map [set-buffer-file-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
122 123
  '(menu-item "For Saving this Buffer" set-buffer-file-coding-system
	      :help "How to encode this buffer on disk")
124
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
125
(define-key-after set-coding-system-map [universal-coding-system-argument]
Eli Zaretskii's avatar
Eli Zaretskii committed
126 127
  '(menu-item "For Next Command" universal-coding-system-argument
	      :help "Coding system to be used by next command")
Richard M. Stallman's avatar
Richard M. Stallman committed
128
  t)
129
(define-key-after set-coding-system-map [set-terminal-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
130 131 132
  '(menu-item "For Terminal" set-terminal-coding-system
	      :enable (null (memq window-system '(x w32 mac)))
	      :help "How to encode terminal output")
133 134
  t)
(define-key-after set-coding-system-map [set-keyboard-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
135 136
  '(menu-item "For Keyboard" set-keyboard-coding-system
	      :help "How to decode keyboard input")
137 138
  t)
(define-key-after set-coding-system-map [set-buffer-process-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
139 140 141 142
  '(menu-item "For I/O with Subprocess" set-buffer-process-coding-system
	      :visible (fboundp 'start-process)
	      :enable (get-buffer-process (current-buffer))
	      :help "How to en/decode I/O from/to subprocess connected to this buffer")
143
  t)
144
(define-key-after set-coding-system-map [set-selection-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
145 146 147
  '(menu-item "For X Selections/Clipboard" set-selection-coding-system
	      :visible (display-selections-p)
	      :help "How to en/decode data to/from selection/clipboard")
148 149
  t)
(define-key-after set-coding-system-map [set-next-selection-coding-system]
Eli Zaretskii's avatar
Eli Zaretskii committed
150 151 152
  '(menu-item "For Next X Selection" set-next-selection-coding-system
	      :visible (display-selections-p)
	      :help "How to en/decode next selection/clipboard operation")
153
  t)
154
(define-key setup-language-environment-map
Eli Zaretskii's avatar
Eli Zaretskii committed
155
  [Default] '(menu-item "Default" setup-specified-language-environment))
Karl Heuer's avatar
Karl Heuer committed
156

Dave Love's avatar
Dave Love committed
157 158 159
(define-key describe-language-environment-map
  [Default] '(menu-item "Default" describe-specified-language-support))

Karl Heuer's avatar
Karl Heuer committed
160 161 162 163 164 165 166 167
;; This should be a single character key binding because users use it
;; very frequently while editing multilingual text.  Now we can use
;; only two such keys: "\C-\\" and "\C-^", but the latter is not
;; convenient because it requires shifting on most keyboards.  An
;; alternative is "\C-\]" which is now bound to `abort-recursive-edit'
;; but it won't be used that frequently.
(define-key global-map "\C-\\" 'toggle-input-method)

168 169 170 171
;;; This is no good because people often type Shift-SPC
;;; meaning to type SPC.  -- rms.
;;; ;; Here's an alternative key binding for X users (Shift-SPACE).
;;; (define-key global-map [?\S- ] 'toggle-input-method)
172

173 174 175 176
;;; Mule related hyperlinks.
(defconst help-xref-mule-regexp-template
  (purecopy (concat "\\(\\<\\("
		    "\\(coding system\\)\\|"
177 178 179
		    "\\(input method\\)\\|"
		    "\\(character set\\)\\|"
		    "\\(charset\\)"
180 181 182 183
		    "\\)\\s-+\\)?"
		    ;; Note starting with word-syntax character:
		    "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'")))

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
(defun coding-system-change-eol-conversion (coding-system eol-type)
  "Return a coding system which differs from CODING-SYSTEM in eol conversion.
The returned coding system converts end-of-line by EOL-TYPE
but text as the same way as CODING-SYSTEM.
EOL-TYPE should be `unix', `dos', `mac', or nil.
If EOL-TYPE is nil, the returned coding system detects
how end-of-line is formatted automatically while decoding.

EOL-TYPE can be specified by an integer 0, 1, or 2.
They means `unix', `dos', and `mac' respectively."
  (if (symbolp eol-type)
      (setq eol-type (cond ((eq eol-type 'unix) 0)
			   ((eq eol-type 'dos) 1)
			   ((eq eol-type 'mac) 2)
			   (t eol-type))))
  (let ((orig-eol-type (coding-system-eol-type coding-system)))
    (if (vectorp orig-eol-type)
	(if (not eol-type)
	    coding-system
	  (aref orig-eol-type eol-type))
      (let ((base (coding-system-base coding-system)))
	(if (not eol-type)
	    base
	  (if (= eol-type orig-eol-type)
	      coding-system
	    (setq orig-eol-type (coding-system-eol-type base))
	    (if (vectorp orig-eol-type)
		(aref orig-eol-type eol-type))))))))

(defun coding-system-change-text-conversion (coding-system coding)
  "Return a coding system which differs from CODING-SYSTEM in text conversion.
The returned coding system converts text by CODING
but end-of-line as the same way as CODING-SYSTEM.
If CODING is nil, the returned coding system detects
how text is formatted automatically while decoding."
  (if (not coding)
      (coding-system-base coding-system)
    (let ((eol-type (coding-system-eol-type coding-system)))
      (coding-system-change-eol-conversion
       coding
       (if (numberp eol-type) (aref [unix dos mac] eol-type))))))

Karl Heuer's avatar
Karl Heuer committed
226
(defun toggle-enable-multibyte-characters (&optional arg)
227 228 229 230 231 232 233 234 235 236 237
  "Change whether this buffer uses multibyte characters.
With arg, use multibyte characters if the arg is positive.

Note that this command does not convert the byte contents of
the buffer; it only changes the way those bytes are interpreted.
In general, therefore, this command *changes* the sequence of
characters that the current buffer contains.

We suggest you avoid using use this command unless you know what you
are doing.  If you use it by mistake, and the buffer is now displayed
wrong, use this command again to toggle back to the right mode."
Karl Heuer's avatar
Karl Heuer committed
238
  (interactive "P")
239 240 241 242
  (let ((new-flag
	 (if (null arg) (null enable-multibyte-characters)
	   (> (prefix-numeric-value arg) 0))))
    (set-buffer-multibyte new-flag))
Karl Heuer's avatar
Karl Heuer committed
243 244 245 246 247
  (force-mode-line-update))

(defun view-hello-file ()
  "Display the HELLO file which list up many languages and characters."
  (interactive)
248 249
  ;; We have to decode the file in any environment.
  (let ((default-enable-multibyte-characters t)
250
	(coding-system-for-read 'iso-2022-7bit))
251
    (find-file-read-only (expand-file-name "HELLO" data-directory))))
Karl Heuer's avatar
Karl Heuer committed
252

253 254 255
(defun universal-coding-system-argument ()
  "Execute an I/O command using the specified coding system."
  (interactive)
256 257 258 259 260 261 262 263 264
  (let* ((default (and buffer-file-coding-system
		       (not (eq (coding-system-type buffer-file-coding-system)
				t))
		       buffer-file-coding-system))
	 (coding-system (read-coding-system
			 (if default
			     (format "Coding system for following command (default, %s): " default)
			   "Coding system for following command: ")
			 default))
265
	 (keyseq (read-key-sequence
266
		  (format "Command to execute with %s:" coding-system)))
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
	 (cmd (key-binding keyseq))
	 prefix)

    (when (eq cmd 'universal-argument)
      (call-interactively cmd)
      
      ;; Process keys bound in `universal-argument-map'.
      (while (progn
	       (setq keyseq (read-key-sequence nil t)
		     cmd (key-binding keyseq t))
	       (not (eq cmd 'universal-argument-other-key)))
	(let ((current-prefix-arg prefix-arg)
	      ;; Have to bind `last-command-char' here so that 
	      ;; `digit-argument', for isntance, can compute the
	      ;; prefix arg.
	      (last-command-char (aref keyseq 0)))
	  (call-interactively cmd)))

      ;; This is the final call to `univeral-argument-other-key', which
      ;; set's the final `prefix-arg.
      (let ((current-prefix-arg prefix-arg))
	(call-interactively cmd))
	
      ;; Read the command to execute with the given prefix arg.
      (setq prefix prefix-arg
	    keyseq (read-key-sequence nil t)
	    cmd (key-binding keyseq)))

295
    (let ((coding-system-for-read coding-system)
296 297
	  (coding-system-for-write coding-system)
	  (current-prefix-arg prefix))
298 299 300
      (message "")
      (call-interactively cmd))))

301
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
302
  "Set default value of various coding systems to CODING-SYSTEM.
303
This sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
304
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
305 306
  o default coding system for subprocess I/O
This also sets the following values:
307
  o default value used as file-name-coding-system for converting file names.
308 309
  o default value for the command `set-terminal-coding-system' (not on MSDOS)
  o default value for the command `set-keyboard-coding-system'."
310 311
  (check-coding-system coding-system)
  (setq-default buffer-file-coding-system coding-system)
312 313
  (if default-enable-multibyte-characters
      (setq default-file-name-coding-system coding-system))
314 315 316 317
  ;; If coding-system is nil, honor that on MS-DOS as well, so
  ;; that they could reset the terminal coding system.
  (unless (and (eq window-system 'pc) coding-system)
    (setq default-terminal-coding-system coding-system))
318 319 320
  (setq default-keyboard-coding-system coding-system)
  (setq default-process-coding-system (cons coding-system coding-system)))

321
(defalias 'update-iso-coding-systems 'update-coding-systems-internal)
322
(make-obsolete 'update-iso-coding-systems 'update-coding-systems-internal "20.3")
323

Kenichi Handa's avatar
Kenichi Handa committed
324 325
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
326
This also sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
327
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
328 329
  o default coding system for subprocess I/O
This also sets the following values:
Dave Love's avatar
Dave Love committed
330
  o default value used as `file-name-coding-system' for converting file names.
331 332 333
  o default value for the command `set-terminal-coding-system' (not on MSDOS)
  o default value for the command `set-keyboard-coding-system'

334 335 336
If CODING-SYSTEM specifies a certain type of EOL conversion, the coding
systems set by this function will use that type of EOL conversion.

337 338 339
This command does not change the default value of terminal coding system
for MS-DOS terminal, because DOS terminals only support a single coding
system, and Emacs automatically sets the default to that coding system at
340 341
startup.

Dave Love's avatar
Dave Love committed
342 343 344 345
A coding system that requires automatic detection of text
encoding (e.g. undecided, unix) can't be preferred.

See also `coding-category-list' and `coding-system-category'."
Kenichi Handa's avatar
Kenichi Handa committed
346 347 348 349
  (interactive "zPrefer coding system: ")
  (if (not (and coding-system (coding-system-p coding-system)))
      (error "Invalid coding system `%s'" coding-system))
  (let ((coding-category (coding-system-category coding-system))
350 351
	(base (coding-system-base coding-system))
	(eol-type (coding-system-eol-type coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
352 353 354
    (if (not coding-category)
	;; CODING-SYSTEM is no-conversion or undecided.
	(error "Can't prefer the coding system `%s'" coding-system))
Kenichi Handa's avatar
Kenichi Handa committed
355
    (set coding-category (or base coding-system))
356
    (update-coding-systems-internal)
357
    (or (eq coding-category (car coding-category-list))
Kenichi Handa's avatar
Kenichi Handa committed
358
	;; We must change the order.
359
	(set-coding-priority (list coding-category)))
Kenichi Handa's avatar
Kenichi Handa committed
360 361 362
    (if (and base (interactive-p))
	(message "Highest priority is set to %s (base of %s)"
		 base coding-system))
363
    ;; If they asked for specific EOL conversion, honor that.
364
    (if (memq eol-type '(0 1 2))
365 366 367 368
	(setq coding-system
	      (coding-system-change-eol-conversion base eol-type))
      (setq coding-system base))
    (set-default-coding-systems coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
(defvar sort-coding-systems-predicate nil
  "If non-nil, a predicate function to sort coding systems.

It is called with two coding systems, and should return t if the first
one is \"less\" than the second.

The function `sort-coding-systems' use it.")

(defun sort-coding-systems (codings)
  "Sort coding system list CODINGS by a priority of each coding system.

If a coding system is most preferred, it has the highest priority.
Otherwise, a coding system corresponds to some MIME charset has higher
priorities.  Among them, a coding system included in `coding-system'
key of the current language environment has higher priorities.  See
also the documentation of `language-info-alist'.

If the variable `sort-coding-systems-predicate' (which see) is
non-nil, it is used to sort CODINGS in the different way than above."
  (if sort-coding-systems-predicate
      (sort codings sort-coding-systems-predicate)
    (let* ((most-preferred (symbol-value (car coding-category-list)))
	   (lang-preferred (get-language-info current-language-environment
					      'coding-system))
	   (func (function
		  (lambda (x)
		    (let ((base (coding-system-base x)))
		      (+ (if (eq base most-preferred) 64 0)
			 (let ((mime (coding-system-get base 'mime-charset)))
			   (if mime
			       (if (string-match "^x-" (symbol-name mime))
				   16 32)
			     0))
			 (if (memq base lang-preferred) 8 0)
			 (if (string-match "-with-esc$" (symbol-name base))
			     0 4)
			 (if (eq (coding-system-type base) 2)
			     ;; For ISO based coding systems, prefer
			     ;; one that doesn't use escape sequences.
			     (let ((flags (coding-system-flags base)))
			       (if (or (consp (aref flags 0))
				       (consp (aref flags 1))
				       (consp (aref flags 2))
				       (consp (aref flags 3)))
				   (if (or (aref flags 8) (aref flags 9))
				       0
				     1)
				 2))
			   1)))))))
      (sort codings (function (lambda (x y)
				(> (funcall func x) (funcall func y))))))))
421

Kenichi Handa's avatar
Kenichi Handa committed
422
(defun find-coding-systems-region (from to)
423 424 425 426
  "Return a list of proper coding systems to encode a text between FROM and TO.
All coding systems in the list can safely encode any multibyte characters
in the text.

Karl Heuer's avatar
Karl Heuer committed
427
If the text contains no multibyte characters, return a list of a single
Kenichi Handa's avatar
Kenichi Handa committed
428
element `undecided'."
429 430 431 432 433 434 435
  (let ((codings (find-coding-systems-region-internal from to)))
    (if (eq codings t)
	;; The text contains only ASCII characters.  Any coding
	;; systems are safe.
	'(undecided)
      ;; We need copy-sequence because sorting will alter the argument.
      (sort-coding-systems (copy-sequence codings)))))
436

Kenichi Handa's avatar
Kenichi Handa committed
437 438 439 440 441
(defun find-coding-systems-string (string)
  "Return a list of proper coding systems to encode STRING.
All coding systems in the list can safely encode any multibyte characters
in STRING.

Karl Heuer's avatar
Karl Heuer committed
442
If STRING contains no multibyte characters, return a list of a single
Kenichi Handa's avatar
Kenichi Handa committed
443
element `undecided'."
444
  (find-coding-systems-region string nil))
Kenichi Handa's avatar
Kenichi Handa committed
445 446 447 448

(defun find-coding-systems-for-charsets (charsets)
  "Return a list of proper coding systems to encode characters of CHARSETS.
CHARSETS is a list of character sets."
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
  (cond ((or (null charsets)
	     (and (= (length charsets) 1)
		  (eq 'ascii (car charsets))))
	 '(undecided))
	((or (memq 'eight-bit-control charsets)
	     (memq 'eight-bit-graphic charsets))
	 '(raw-text emacs-mule))
	(t
	 (let ((codings t)
	       charset l ll)
	   (while (and codings charsets)
	     (setq charset (car charsets) charsets (cdr charsets))
	     (unless (eq charset 'ascii)
	       (setq l (aref char-coding-system-table (make-char charset)))
	       (if (eq codings t)
		   (setq codings l)
		 (let ((ll nil))
		   (while codings
		     (if (memq (car codings) l)
			 (setq ll (cons (car codings) ll)))
		     (setq codings (cdr codings)))
		   (setq codings ll)))))
	   (append codings
		   (char-table-extra-slot char-coding-system-table 0))))))
473

474 475 476 477 478 479 480 481 482 483
(defun find-multibyte-characters (from to &optional maxcount excludes)
  "Find multibyte characters in the region specified by FROM and TO.
If FROM is a string, find multibyte characters in the string.
The return value is an alist of the following format:
  ((CHARSET COUNT CHAR ...) ...)
where
  CHARSET is a character set,
  COUNT is a number of characters,
  CHARs are found characters of the character set.
Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list.
484 485 486
Optional 4th arg EXCLUDE is a list of character sets to be ignored.

For invalid characters, CHARs are actually strings."
487 488 489 490 491 492 493
  (let ((chars nil)
	charset char)
    (if (stringp from)
	(let ((idx 0))
	  (while (setq idx (string-match "[^\000-\177]" from idx))
	    (setq char (aref from idx)
		  charset (char-charset char))
494 495
	    (if (eq charset 'unknown)
		(setq char (match-string 0)))
496 497
	    (if (or (memq charset '(unknown
				    eight-bit-control eight-bit-graphic))
498
		    (not (or (eq excludes t) (memq charset excludes))))
499 500 501 502 503 504 505 506 507 508 509 510 511 512
		(let ((slot (assq charset chars)))
		  (if slot
		      (if (not (memq char (nthcdr 2 slot)))
			  (let ((count (nth 1 slot)))
			    (setcar (cdr slot) (1+ count))
			    (if (or (not maxcount) (< count maxcount))
				(nconc slot (list char)))))
		    (setq chars (cons (list charset 1 char) chars)))))
	    (setq idx (1+ idx))))
      (save-excursion
	(goto-char from)
	(while (re-search-forward "[^\000-\177]" to t)
	  (setq char (preceding-char)
		charset (char-charset char))
513 514
	  (if (eq charset 'unknown)
	      (setq char (match-string 0)))
515
	  (if (or (memq charset '(unknown eight-bit-control eight-bit-graphic))
516
		  (not (or (eq excludes t) (memq charset excludes))))
517 518
	      (let ((slot (assq charset chars)))
		(if slot
519
		    (if (not (member char (nthcdr 2 slot)))
520 521 522 523 524 525 526
			(let ((count (nth 1 slot)))
			  (setcar (cdr slot) (1+ count))
			  (if (or (not maxcount) (< count maxcount))
			      (nconc slot (list char)))))
		  (setq chars (cons (list charset 1 char) chars))))))))
    (nreverse chars)))

527 528 529 530 531 532 533
(defvar last-coding-system-specified nil
  "Most recent coding system explicitly specified by the user when asked.
This variable is set whenever Emacs asks the user which coding system
to use in order to write a file.  If you set it to nil explicitly,
then call `write-region', then afterward this variable will be non-nil
only if the user was explicitly asked and specified a coding system.")

534 535 536 537 538 539 540 541
(defvar select-safe-coding-system-accept-default-p nil
  "If non-nil, a function to control the behaviour of coding system selection.
The meaning is the same as the argument ACCEPT-DEFAULT-P of the
function `select-safe-coding-system' (which see).  This variable
overrides that argument.")

(defun select-safe-coding-system (from to &optional default-coding-system
				       accept-default-p)
542 543
  "Ask a user to select a safe coding system from candidates.
The candidates of coding systems which can safely encode a text
544 545 546 547 548 549 550 551
between FROM and TO are shown in a popup window.  Among them, the most
proper one is suggested as the default.

The list of `buffer-file-coding-system' of the current buffer and the
most preferred coding system (if it corresponds to a MIME charset) is
treated as the default coding system list.  Among them, the first one
that safely encodes the text is silently selected and returned without
any user interaction.  See also the command `prefer-coding-system'.
552

553 554 555
Optional 3rd arg DEFAULT-CODING-SYSTEM specifies a coding system or a
list of coding systems to be prepended to the default coding system
list.
556

557 558 559 560 561 562 563
Optional 4th arg ACCEPT-DEFAULT-P, if non-nil, is a function to
determine the acceptability of the silently selected coding system.
It is called with that coding system, and should return nil if it
should not be silently selected and thus user interaction is required.

The variable `select-safe-coding-system-accept-default-p', if
non-nil, overrides ACCEPT-DEFAULT-P.
564 565 566

Kludgy feature: if FROM is a string, the string is the target text,
and TO is ignored."
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
  (if (and default-coding-system
	   (not (listp default-coding-system)))
      (setq default-coding-system (list default-coding-system)))

  ;; Change elements of the list to (coding . base-coding).
  (setq default-coding-system
	(mapcar (function (lambda (x) (cons x (coding-system-base x))))
		default-coding-system))

  ;; If buffer-file-coding-system is not nil nor undecided, append it
  ;; to the defaults.
  (if buffer-file-coding-system
      (let ((base (coding-system-base buffer-file-coding-system)))
	(or (eq base 'undecided)
	    (assq buffer-file-coding-system default-coding-system)
	    (rassq base default-coding-system)
Dave Love's avatar
Dave Love committed
583
	    (setq default-coding-system
584 585 586 587 588
		  (append default-coding-system
			  (list (cons buffer-file-coding-system base)))))))

  ;; If the most preferred coding system has the property mime-charset,
  ;; append it to the defaults.
589 590 591 592 593 594 595 596
  (let ((tail coding-category-list)
	preferred base)
    (while (and tail
		(not (setq preferred (symbol-name (car tail)))))
      (setq tail (cdr tail)))
    (and (coding-system-p preferred)
	 (setq base (coding-system-base preferred))
	 (coding-system-get preferred 'mime-charset)
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
	 (not (assq preferred default-coding-system))
	 (not (rassq base default-coding-system))
	 (setq default-coding-system
	       (append default-coding-system (list (cons preferred base))))))

  (if select-safe-coding-system-accept-default-p
      (setq accept-default-p select-safe-coding-system-accept-default-p))

  (let ((codings (find-coding-systems-region from to))
	(coding-system nil)
	(l default-coding-system))
    (if (eq (car codings) 'undecided)
	;; Any coding system is ok.
	(setq coding-system t)
      ;; Try the defaults.
      (while (and l (not coding-system))
	(if (memq (cdr (car l)) codings)
	    (setq coding-system (car (car l)))
	  (setq l (cdr l))))
      (if (and coding-system accept-default-p)
	  (or (funcall accept-default-p coding-system)
	      (setq coding-system (list coding-system)))))

    ;; If all the defaults failed, ask a user.
    (when (or (not coding-system) (consp coding-system))
622
      ;; At first, change each coding system to the corresponding
623 624 625
      ;; mime-charset name if it is also a coding system.  Such a name
      ;; is more friendly to users.
      (let ((l codings)
626 627 628 629 630 631 632
	    mime-charset)
	(while l
	  (setq mime-charset (coding-system-get (car l) 'mime-charset))
	  (if (and mime-charset (coding-system-p mime-charset))
	      (setcar l mime-charset))
	  (setq l (cdr l))))

633 634 635 636 637 638
      ;; Then ask users to select one form CODINGS.
      (unwind-protect
	  (save-window-excursion
	    (with-output-to-temp-buffer "*Warning*"
	      (save-excursion
		(set-buffer standard-output)
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
		(if (not default-coding-system)
		    (insert "No default coding systems to try.")
		  (insert "These default coding systems were tried")
		  (if (stringp from)
		      (insert " to encode \""
			      (if (> (length from) 10)
				  (substring from 0 10)
				from)
			      "...\""))
		  (insert ":\n")
		  (let ((pos (point))
			(fill-prefix "  "))
		    (mapcar (function (lambda (x)
					(princ "  ") (princ (car x))))
			    default-coding-system)
		    (insert "\n")
		    (fill-region-as-paragraph pos (point)))
		  (insert
		   (if (consp coding-system)
		       (concat (format "%s safely encodes the target text,\n"
				       (car coding-system))
			       "but it is not recommended for encoding text in this context,\n"
			       "e.g., for sending an email message.\n")
		     "However, none of them safely encodes the target text.\n")))
663
		(insert (if (consp coding-system)
664 665 666
			    "\nSelect the above, or "
			  "\nSelect ")
			"one of the following safe coding systems:\n")
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
		(let ((pos (point))
		      (fill-prefix "  "))
		  (mapcar (function (lambda (x) (princ "  ") (princ x)))
			  codings)
		  (insert "\n")
		  (fill-region-as-paragraph pos (point)))))

	    ;; Read a coding system.
	    (if (consp coding-system)
		(setq codings (cons (car coding-system) codings)))
	    (let* ((safe-names (mapcar (lambda (x) (list (symbol-name x)))
				       codings))
		   (name (completing-read
			  (format "Select coding system (default %s): "
				  (car codings))
			  safe-names nil t nil nil
			  (car (car safe-names)))))
	      (setq last-coding-system-specified (intern name)
		    coding-system last-coding-system-specified)))
	(kill-buffer "*Warning*")))

    (if (vectorp (coding-system-eol-type coding-system))
	(let ((eol (coding-system-eol-type buffer-file-coding-system)))
	  (if (numberp eol)
	      (setq coding-system
		    (coding-system-change-eol-conversion coding-system eol)))))

    (if (eq coding-system t)
	(setq coding-system buffer-file-coding-system))
Dave Love's avatar
Dave Love committed
696
    coding-system))
697 698 699

(setq select-safe-coding-system-function 'select-safe-coding-system)

700 701 702 703 704 705
(defun select-message-coding-system ()
  "Return a coding system to encode the outgoing message of the current buffer.
It at first tries the first coding system found in these variables
in this order:
  (1) local value of `buffer-file-coding-system'
  (2) value of `sendmail-coding-system'
706 707
  (3) value of `default-sendmail-coding-system'
  (4) value of `default-buffer-file-coding-system'
708 709
If the found coding system can't encode the current buffer,
or none of them are bound to a coding system,
710
it asks the user to select a proper coding system."
711
  (let ((coding (or (and (local-variable-p 'buffer-file-coding-system)
712 713 714 715
			  buffer-file-coding-system)
		     sendmail-coding-system
		     default-sendmail-coding-system
		     default-buffer-file-coding-system)))
716 717 718 719 720
    (if (eq coding 'no-conversion)
	;; We should never use no-conversion for outgoing mails.
	(setq coding nil))
    (if (fboundp select-safe-coding-system-function)
	(funcall select-safe-coding-system-function
721 722
		 (point-min) (point-max) coding
		 (function (lambda (x) (coding-system-get x 'mime-charset))))
723
      coding)))
Karl Heuer's avatar
Karl Heuer committed
724

725
;;; Language support stuff.
Karl Heuer's avatar
Karl Heuer committed
726 727

(defvar language-info-alist nil
Richard M. Stallman's avatar
Richard M. Stallman committed
728
  "Alist of language environment definitions.
Karl Heuer's avatar
Karl Heuer committed
729 730
Each element looks like:
	(LANGUAGE-NAME . ((KEY . INFO) ...))
Richard M. Stallman's avatar
Richard M. Stallman committed
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
where LANGUAGE-NAME is a string, the name of the language environment,
KEY is a symbol denoting the kind of information, and
INFO is the data associated with KEY.
Meaningful values for KEY include

  documentation      value is documentation of what this language environment
			is meant for, and how to use it.
  charset	     value is a list of the character sets used by this
			language environment.
  sample-text	     value is one line of text,
			written using those character sets,
			appropriate for this language environment.
  setup-function     value is a function to call to switch to this
			language environment.
  exit-function      value is a function to call to leave this
		        language environment.
  coding-system      value is a list of coding systems that are good
			for saving text written in this language environment.
			This list serves as suggestions to the user;
			in effect, as a kind of documentation.
  coding-priority    value is a list of coding systems for this language
			environment, in order of decreasing priority.
			This is used to set up the coding system priority
754
			list when you switch to this language environment.
755
  nonascii-translation
756
		     value is a translation table to be set in the
757
			variable `nonascii-translation-table' in this
758 759
			language environment, or a character set from
			which `nonascii-insert-offset' is calculated.
760 761
  input-method       value is a default input method for this language
			environment.
762 763
  features           value is a list of features requested in this
			language environment.
764 765 766 767 768 769

The following keys take effect only when multibyte characters are
globally disabled, i.e. the value of `default-enable-multibyte-characters'
is nil.

  unibyte-syntax     value is a library name to load to set
Karl Heuer's avatar
Karl Heuer committed
770
			unibyte 8-bit character syntaxes for this
771 772 773 774 775 776 777
			language environment.

  unibyte-display    value is a coding system to encode characters
			for the terminal.  Characters in the range
			of 160 to 255 display not as octal escapes,
			but as non-ASCII characters in this language
			environment.")
Richard M. Stallman's avatar
Richard M. Stallman committed
778 779 780 781 782 783 784 785 786

(defun get-language-info (lang-env key)
  "Return information listed under KEY for language environment LANG-ENV.
KEY is a symbol denoting the kind of information.
For a list of useful values for KEY and their meanings,
see `language-info-alist'."
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
  (let ((lang-slot (assoc-ignore-case lang-env language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
787 788 789
    (if lang-slot
	(cdr (assq key (cdr lang-slot))))))

790
(defun set-language-info (lang-env key info)
Richard M. Stallman's avatar
Richard M. Stallman committed
791 792 793
  "Modify part of the definition of language environment LANG-ENV.
Specifically, this stores the information INFO under KEY
in the definition of this language environment.
Karl Heuer's avatar
Karl Heuer committed
794
KEY is a symbol denoting the kind of information.
Richard M. Stallman's avatar
Richard M. Stallman committed
795
INFO is the value for that information.
796

Richard M. Stallman's avatar
Richard M. Stallman committed
797
For a list of useful values for KEY and their meanings,
798
see `language-info-alist'."
Richard M. Stallman's avatar
Richard M. Stallman committed
799 800
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
Karl Heuer's avatar
Karl Heuer committed
801
  (let (lang-slot key-slot)
Richard M. Stallman's avatar
Richard M. Stallman committed
802
    (setq lang-slot (assoc lang-env language-info-alist))
Karl Heuer's avatar
Karl Heuer committed
803
    (if (null lang-slot)		; If no slot for the language, add it.
Richard M. Stallman's avatar
Richard M. Stallman committed
804
	(setq lang-slot (list lang-env)
Karl Heuer's avatar
Karl Heuer committed
805 806 807 808 809 810
	      language-info-alist (cons lang-slot language-info-alist)))
    (setq key-slot (assq key lang-slot))
    (if (null key-slot)			; If no slot for the key, add it.
	(progn
	  (setq key-slot (list key))
	  (setcdr lang-slot (cons key-slot (cdr lang-slot)))))
Dave Love's avatar
Dave Love committed
811
    (setcdr key-slot (purecopy info))))
Karl Heuer's avatar
Karl Heuer committed
812

Richard M. Stallman's avatar
Richard M. Stallman committed
813 814 815
(defun set-language-info-alist (lang-env alist &optional parents)
  "Store ALIST as the definition of language environment LANG-ENV.
ALIST is an alist of KEY and INFO values.  See the documentation of
816
`language-info-alist' for the meanings of KEY and INFO.
817

Richard M. Stallman's avatar
Richard M. Stallman committed
818 819 820 821 822 823 824
Optional arg PARENTS is a list of parent menu names; it specifies
where to put this language environment in the 
Describe Language Environment and Set Language Environment menus.
For example, (\"European\") means to put this language environment
in the European submenu in each of those two menus."
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
825 826 827 828
  (let ((describe-map describe-language-environment-map)
	(setup-map setup-language-environment-map))
    (if parents
	(let ((l parents)
829
	      map parent-symbol parent prompt)
830 831 832 833 834
	  (while l
	    (if (symbolp (setq parent-symbol (car l)))
		(setq parent (symbol-name parent))
	      (setq parent parent-symbol parent-symbol (intern parent)))
	    (setq map (lookup-key describe-map (vector parent-symbol)))
835 836 837
	    ;; This prompt string is for define-prefix-command, so
	    ;; that the map it creates will be suitable for a menu.
	    (or map (setq prompt (format "%s Environment" parent)))
838 839 840 841
	    (if (not map)
		(progn
		  (setq map (intern (format "describe-%s-environment-map"
					    (downcase parent))))
842
		  (define-prefix-command map nil prompt)
843 844 845 846 847 848 849 850
		  (define-key-after describe-map (vector parent-symbol)
		    (cons parent map) t)))
	    (setq describe-map (symbol-value map))
	    (setq map (lookup-key setup-map (vector parent-symbol)))
	    (if (not map)
		(progn
		  (setq map (intern (format "setup-%s-environment-map"
					    (downcase parent))))
851
		  (define-prefix-command map nil prompt)
852 853 854 855
		  (define-key-after setup-map (vector parent-symbol)
		    (cons parent map) t)))
	    (setq setup-map (symbol-value map))
	    (setq l (cdr l)))))
856 857

    ;; Set up menu items for this language env.
858
    (let ((doc (assq 'documentation alist)))
859 860
      (when doc
	(define-key-after describe-map (vector (intern lang-env))
861 862 863
	  (cons lang-env 'describe-specified-language-support) t)))
    (define-key-after setup-map (vector (intern lang-env))
      (cons lang-env 'setup-specified-language-environment) t)
864

865
    (while alist
866
      (set-language-info lang-env (car (car alist)) (cdr (car alist)))
867
      (setq alist (cdr alist)))))
Karl Heuer's avatar
Karl Heuer committed
868

869
(defun read-language-name (key prompt &optional default)
Richard M. Stallman's avatar
Richard M. Stallman committed
870
  "Read a language environment name which has information for KEY.
871
If KEY is nil, read any language environment.
Richard M. Stallman's avatar
Richard M. Stallman committed
872 873
Prompt with PROMPT.  DEFAULT is the default choice of language environment.
This returns a language environment name as a string."
Karl Heuer's avatar
Karl Heuer committed
874 875 876
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
877 878
				(and key
				     (function (lambda (elm) (assq key elm))))
879
				t nil nil default)))
880
    (if (and (> (length name) 0)
881 882
	     (or (not key)
		 (get-language-info name key)))
883
	name)))
Karl Heuer's avatar
Karl Heuer committed
884 885

;;; Multilingual input methods.
886 887 888
(defgroup leim nil 
  "LEIM: Libraries of Emacs Input Methods."
  :group 'mule)
Karl Heuer's avatar
Karl Heuer committed
889

890 891 892 893 894 895
(defconst leim-list-file-name "leim-list.el"
  "Name of LEIM list file.
This file contains a list of libraries of Emacs input methods (LEIM)
in the format of Lisp expression for registering each input method.
Emacs loads this file at startup time.")

896 897
(defvar leim-list-header (format
";;; %s -- list of LEIM (Library of Emacs Input Method)
898 899
;;
;; This file contains a list of LEIM (Library of Emacs Input Method)
Dave Love's avatar
Dave Love committed
900 901
;; methods in the same directory as this file.  Loading this file
;; registers all the input methods in Emacs.
902
;;
Kenichi Handa's avatar
Kenichi Handa committed
903
;; Each entry has the form:
904 905 906 907
;;   (register-input-method
;;    INPUT-METHOD LANGUAGE-NAME ACTIVATE-FUNC
;;    TITLE DESCRIPTION
;;    ARG ...)
Dave Love's avatar
Dave Love committed
908
;; See the function `register-input-method' for the meanings of the arguments.
909 910 911 912 913 914 915 916
;;
;; If this directory is included in load-path, Emacs automatically
;; loads this file at startup time.

"
				 leim-list-file-name)
  "Header to be inserted in LEIM list file.")

917
(defvar leim-list-entry-regexp "^(register-input-method"
918 919 920 921 922 923 924 925
  "Regexp matching head of each entry in LEIM list file.
See also the variable `leim-list-header'")

(defvar update-leim-list-functions
  '(quail-update-leim-list-file)
  "List of functions to call to update LEIM list file.
Each function is called with one arg, LEIM directory name.")

926 927
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
928 929
  (let ((functions update-leim-list-functions))
    (while functions
930
      (apply (car functions) dirs)
931 932
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
933 934
(defvar current-input-method nil
  "The current input method for multilingual text.
935
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
936 937 938 939
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

(defvar current-input-method-title nil
940
  "Title string of the current input method shown in mode line.")
Karl Heuer's avatar
Karl Heuer committed
941 942 943
(make-variable-buffer-local 'current-input-method-title)
(put 'current-input-method-title 'permanent-local t)

944
(defcustom default-input-method nil
945
  "*Default input method for multilingual text (a string).
946
This is the input method activated automatically by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
947
`toggle-input-method' (\\[toggle-input-method])."
948
  :group 'mule
949 950
  :type '(choice (const nil) string)
  :set-after '(current-language-environment))
951

952 953
(put 'input-method-function 'permanent-local t)

Kenichi Handa's avatar
Kenichi Handa committed
954 955 956 957
(defvar input-method-history nil
  "History list for some commands that read input methods.")
(make-variable-buffer-local 'input-method-history)
(put 'input-method-history 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
958 959 960 961

(defvar inactivate-current-input-method-function nil
  "Function to call for inactivating the current input method.
Every input method should set this to an appropriate value when activated.
962 963 964 965
This function is called with no argument.

This function should never change the value of `current-input-method'.
It is set to nil by the function `inactivate-input-method'.")
Karl Heuer's avatar
Karl Heuer committed
966 967 968 969 970 971 972 973 974
(make-variable-buffer-local 'inactivate-current-input-method-function)
(put 'inactivate-current-input-method-function 'permanent-local t)

(defvar describe-current-input-method-function nil
  "Function to call for describing the current input method.
This function is called with no argument.")
(make-variable-buffer-local 'describe-current-input-method-function)
(put 'describe-current-input-method-function 'permanent-local t)

975
(defvar input-method-alist nil
Richard M. Stallman's avatar
Richard M. Stallman committed
976
  "Alist of input method names vs how to use them.
977
Each element has the form:
Richard M. Stallman's avatar
Richard M. Stallman committed
978 979 980
   (INPUT-METHOD LANGUAGE-ENV ACTIVATE-FUNC TITLE DESCRIPTION ARGS...)
See the function `register-input-method' for the meanings of the elements.")

981
(defun register-input-method (input-method lang-env &rest args)
982
  "Register INPUT-METHOD as an input method for language environment LANG-ENV.
983
INPUT-METHOD and LANG-ENV are symbols or strings.
984 985

The remaining arguments are:
Richard M. Stallman's avatar
Richard M. Stallman committed
986 987 988 989 990
	ACTIVATE-FUNC, TITLE, DESCRIPTION, and ARGS...
ACTIVATE-FUNC is a function to call to activate this method.
TITLE is a string to show in the mode line when this method is active.
DESCRIPTION is a string describing this method and what it is good for.
The ARGS, if any, are passed as arguments to ACTIVATE-FUNC.
991 992
All told, the arguments to ACTIVATE-FUNC are INPUT-METHOD and the ARGS.

Dave Love's avatar
Dave Love committed
993 994
This function is mainly used in the file \"leim-list.el\" which is
created at Emacs build time, registering all Quail input methods
Dave Love's avatar
Dave Love committed
995
contained in the Emacs distribution.
996

Dave Love's avatar
Dave Love committed
997
In case you want to register a new Quail input method by yourself, be
998
careful to use the same input method title as given in the third
Dave Love's avatar
Dave Love committed
999 1000
parameter of `quail-define-package'.  (If the values are different, the
string specified in this function takes precedence.)
1001 1002

The commands `describe-input-method' and `list-input-methods' need
Dave Love's avatar
Dave Love committed
1003 1004
these duplicated values to show some information about input methods
without loading the relevant Quail packages."
1005 1006
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
1007 1008
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
1009
  (let ((info (cons lang-env args))
1010 1011 1012 1013 1014 1015
	(slot (assoc input-method input-method-alist)))
    (if slot
	(setcdr slot info)
      (setq slot (cons input-method info))
      (setq input-method-alist (cons slot input-method-alist)))))

1016
(defun read-input-method-name (prompt &optional default inhibit-null)
1017
  "Read a name of input method from a minibuffer prompting with PROMPT.
1018
If DEFAULT is non-nil, use that as the default,
Dave Love's avatar
Dave Love committed
1019
and substitute it into PROMPT at the first `%s'.
1020 1021 1022
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
1023 1024
  (if default
      (setq prompt (format prompt default)))
1025
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
1026 1027
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
1028
	 (input-method (completing-read prompt input-method-alist
1029 1030
					nil t nil 'input-method-history
					default)))
1031 1032
    (if (and input-method (symbolp input-method))
	(setq input-method (symbol-name input-method)))
1033 1034 1035
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
1036
	  (error "No valid input method is specified")))))
1037 1038

(defun activate-input-method (input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
1039