mule-cmds.el 31.6 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.
Karl Heuer's avatar
Karl Heuer committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

;; 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
21 22 23
;; 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
24 25 26 27 28

;;; Code:

;;; MULE related key bindings and menus.

Richard M. Stallman's avatar
Richard M. Stallman committed
29
(defvar mule-keymap (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
30 31
  "Keymap for MULE (Multilingual environment) specific commands.")

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

Karl Heuer's avatar
Karl Heuer committed
35 36
(define-key mule-keymap "f" 'set-buffer-file-coding-system)
(define-key mule-keymap "t" 'set-terminal-coding-system)
37 38
(define-key mule-keymap "k" 'set-keyboard-coding-system)
(define-key mule-keymap "p" 'set-buffer-process-coding-system)
39
(define-key mule-keymap "\C-\\" 'set-input-method)
40
(define-key mule-keymap "c" 'universal-coding-system-argument)
41
(define-key mule-keymap "l" 'set-language-environment)
Karl Heuer's avatar
Karl Heuer committed
42

43
(define-key help-map "\C-L" 'describe-language-environment)
44
(define-key help-map "L" 'describe-language-environment)
Karl Heuer's avatar
Karl Heuer committed
45
(define-key help-map "\C-\\" 'describe-input-method)
46
(define-key help-map "I" 'describe-input-method)
47
(define-key help-map "C" 'describe-coding-system)
Karl Heuer's avatar
Karl Heuer committed
48 49
(define-key help-map "h" 'view-hello-file)

Richard M. Stallman's avatar
Richard M. Stallman committed
50
(defvar mule-menu-keymap (make-sparse-keymap "Mule")
51 52 53 54 55 56
  "Keymap for MULE (Multilingual environment) menu specific commands.")

(define-key global-map [menu-bar mule] (cons "Mule" mule-menu-keymap))

(setq menu-bar-final-items (cons 'mule menu-bar-final-items))

57 58
(defvar describe-language-environment-map nil)
(define-prefix-command 'describe-language-environment-map)
59 60 61 62 63 64 65

(defvar setup-language-environment-map nil)
(define-prefix-command 'setup-language-environment-map)

(defvar set-coding-system-map nil)
(define-prefix-command 'set-coding-system-map)

66
(define-key-after mule-menu-keymap [describe-language-environment]
67
  '("Describe Language Environment" . describe-language-environment-map)
68 69
  t)
(define-key-after mule-menu-keymap [set-language-environment]
70
  '("Set Language Environment" . setup-language-environment-map)
71
  t)
72
(define-key-after mule-menu-keymap [mouse-set-font]
73
  '("Set Font/Fontset" . mouse-set-font)
74
  t)
75 76 77 78
(define-key-after mule-menu-keymap [separator-mule]
  '("--")
  t)
(define-key-after mule-menu-keymap [toggle-input-method]
79
  '("Toggle Input Method" . toggle-input-method)
80
  t)
81 82
(define-key-after mule-menu-keymap [set-input-method]
  '("Select Input Method" . set-input-method)
83 84
  t)
(define-key-after mule-menu-keymap [describe-input-method]
85
  '("Describe Input Method" . describe-input-method)
86 87 88 89
  t)
(define-key-after mule-menu-keymap [separator-input-method]
  '("--")
  t)
90
(define-key-after mule-menu-keymap [describe-coding-system]
91
  '("Describe Coding Systems" . describe-coding-system)
92 93
  t)
(define-key-after mule-menu-keymap [set-various-coding-system]
94
  '("Set Coding System" . set-coding-system-map)
95 96 97 98 99
  t)
(define-key-after mule-menu-keymap [separator-coding-system]
  '("--")
  t)
(define-key-after mule-menu-keymap [mule-diag]
100
  '("Show All of MULE Status" . mule-diag)
101 102
  t)
(define-key-after mule-menu-keymap [view-hello-file]
103
  '("Show Script Examples" . view-hello-file)
104 105 106
  t)

(define-key-after set-coding-system-map [set-buffer-file-coding-system]
107
  '("Buffer File" . set-buffer-file-coding-system)
108
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
109 110 111
(define-key-after set-coding-system-map [universal-coding-system-argument]
  '("Next Command" . universal-coding-system-argument)
  t)
112 113 114 115 116 117 118
(define-key-after set-coding-system-map [set-terminal-coding-system]
  '("Terminal" . set-terminal-coding-system)
  t)
(define-key-after set-coding-system-map [set-keyboard-coding-system]
  '("Keyboard" . set-keyboard-coding-system)
  t)
(define-key-after set-coding-system-map [set-buffer-process-coding-system]
119
  '("Buffer Process" . set-buffer-process-coding-system)
120 121 122 123
  t)

(define-key setup-language-environment-map
  [Default] '("Default" . setup-specified-language-environment))
Karl Heuer's avatar
Karl Heuer committed
124 125 126

;; These are meaningless when running under X.
(put 'set-terminal-coding-system 'menu-enable
127
     '(not (eq window-system 'x)))
128
(put 'set-keyboard-coding-system 'menu-enable
129
     '(not (eq window-system 'x)))
130 131 132
;; This is meaningless when the current buffer has no process.
(put 'set-buffer-process-coding-system 'menu-enable
     '(get-buffer-process (current-buffer)))
Karl Heuer's avatar
Karl Heuer committed
133 134 135 136 137 138 139 140 141

;; 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)

142 143 144 145
;;; 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)
146

Karl Heuer's avatar
Karl Heuer committed
147
(defun toggle-enable-multibyte-characters (&optional arg)
148 149 150 151 152 153 154 155 156 157 158
  "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
159 160 161 162 163 164 165 166 167
  (interactive "P")
  (setq enable-multibyte-characters
	(if (null arg) (null enable-multibyte-characters)
	  (> (prefix-numeric-value arg) 0)))
  (force-mode-line-update))

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

173 174 175
(defun universal-coding-system-argument ()
  "Execute an I/O command using the specified coding system."
  (interactive)
176
  (let* ((coding-system (read-coding-system "Coding system for following command: "))
177
	 (keyseq (read-key-sequence
178
		  (format "Command to execute with %s:" coding-system)))
179 180 181 182 183 184
	 (cmd (key-binding keyseq)))
    (let ((coding-system-for-read coding-system)
	  (coding-system-for-write coding-system))
      (message "")
      (call-interactively cmd))))

185
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
186
  "Set default value of various coding systems to CODING-SYSTEM.
Kenichi Handa's avatar
Kenichi Handa committed
187
This sets the follwing coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
188
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
189 190 191 192
  o default coding system for subprocess I/O
This also sets the following values:
  o default value for the command `set-terminal-coding-system'
  o default value for the command `set-keyboard-coding-system'"
193 194 195 196 197 198
  (check-coding-system coding-system)
  (setq-default buffer-file-coding-system coding-system)
  (setq default-terminal-coding-system coding-system)
  (setq default-keyboard-coding-system coding-system)
  (setq default-process-coding-system (cons coding-system coding-system)))

Kenichi Handa's avatar
Kenichi Handa committed
199 200
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
Kenichi Handa's avatar
Kenichi Handa committed
201
This also sets the follwing coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
202
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
203 204 205 206
  o default coding system for subprocess I/O
This also sets the following values:
  o default value for the command `set-terminal-coding-system'
  o default value for the command `set-keyboard-coding-system'"
Kenichi Handa's avatar
Kenichi Handa committed
207 208 209 210
  (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))
Kenichi Handa's avatar
Kenichi Handa committed
211
	(base (coding-system-base coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
212 213 214
    (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
215
    (set coding-category (or base coding-system))
Kenichi Handa's avatar
Kenichi Handa committed
216 217 218 219 220
    (if (not (eq coding-category (car coding-category-list)))
	;; We must change the order.
	(setq coding-category-list
	      (cons coding-category
		    (delq coding-category coding-category-list))))
Kenichi Handa's avatar
Kenichi Handa committed
221 222 223 224
    (if (and base (interactive-p))
	(message "Highest priority is set to %s (base of %s)"
		 base coding-system))
    (set-default-coding-systems (or base coding-system))))
Kenichi Handa's avatar
Kenichi Handa committed
225

Karl Heuer's avatar
Karl Heuer committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

;;; Language support staffs.

(defvar language-info-alist nil
  "Alist of language names vs the corresponding information of various kind.
Each element looks like:
	(LANGUAGE-NAME . ((KEY . INFO) ...))
where LANGUAGE-NAME is a string,
KEY is a symbol denoting the kind of information,
INFO is any Lisp object which contains the actual information related
to KEY.")

(defun get-language-info (language-name key)
  "Return the information for LANGUAGE-NAME of the kind KEY.
KEY is a symbol denoting the kind of required information."
241 242
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
243
  (let ((lang-slot (assoc-ignore-case language-name language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
244 245 246 247 248 249 250 251 252
    (if lang-slot
	(cdr (assq key (cdr lang-slot))))))

(defun set-language-info (language-name key info)
  "Set for LANGUAGE-NAME the information INFO under KEY.
KEY is a symbol denoting the kind of information.
INFO is any Lisp object which contains the actual information.

Currently, the following KEYs are used by Emacs:
253

Karl Heuer's avatar
Karl Heuer committed
254
charset: list of symbols whose values are charsets specific to the language.
255

Karl Heuer's avatar
Karl Heuer committed
256
coding-system: list of coding systems specific to the language.
257

Karl Heuer's avatar
Karl Heuer committed
258
tutorial: a tutorial file name written in the language.
259

Karl Heuer's avatar
Karl Heuer committed
260
sample-text: one line short text containing characters of the language.
261

262
documentation: t or a string describing how Emacs supports the language.
263 264 265
      If a string is specified, it is shown before any other information
      of the language by the command `describe-language-environment'.

266
setup-function: a function to call for setting up environment
267
       convenient for a user of the language.
268 269 270 271 272 273 274

If KEY is documentation or setup-function, you can also specify
a cons cell as INFO, in which case, the car part should be
a normal value as INFO for KEY (as described above),
and the cdr part should be a symbol whose value is a menu keymap
in which an entry for the language is defined.  But, only the car part
is actually set as the information.
275

276 277
We will define more KEYs in the future.  To avoid conflict,
if you want to use your own KEY values, make them start with `user-'."
278 279
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
280 281 282 283 284 285 286 287 288 289 290
  (let (lang-slot key-slot)
    (setq lang-slot (assoc language-name language-info-alist))
    (if (null lang-slot)		; If no slot for the language, add it.
	(setq lang-slot (list language-name)
	      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)))))
    ;; Setup menu.
291
    (cond ((eq key 'documentation)
292 293 294 295
	   (define-key-after
	     (if (consp info)
		 (prog1 (symbol-value (cdr info))
		   (setq info (car info)))
296
	       describe-language-environment-map)
Kenichi Handa's avatar
Kenichi Handa committed
297
	     (vector (intern language-name))
298
	     (cons language-name 'describe-specified-language-support)
299
	     t))
Kenichi Handa's avatar
Kenichi Handa committed
300
	  ((eq key 'setup-function)
301 302 303 304 305
	   (define-key-after
	     (if (consp info)
		 (prog1 (symbol-value (cdr info))
		   (setq info (car info)))
	       setup-language-environment-map)
Kenichi Handa's avatar
Kenichi Handa committed
306
	     (vector (intern language-name))
307
	     (cons language-name 'setup-specified-language-environment)
308
	     t)))
309 310

    (setcdr key-slot info)
Karl Heuer's avatar
Karl Heuer committed
311 312 313 314 315 316
    ))

(defun set-language-info-alist (language-name alist)
  "Set for LANGUAGE-NAME the information in ALIST.
ALIST is an alist of KEY and INFO.  See the documentation of
`set-langauge-info' for the meanings of KEY and INFO."
317 318
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
319 320 321 322
  (while alist
    (set-language-info language-name (car (car alist)) (cdr (car alist)))
    (setq alist (cdr alist))))

323
(defun read-language-name (key prompt &optional default)
324
  "Read language name which has information for KEY, prompting with PROMPT.
325
DEFAULT is the default choice of language.
326
This returns a language name as a string."
Karl Heuer's avatar
Karl Heuer committed
327 328 329 330
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
				(function (lambda (elm) (assq key elm)))
331
				t nil nil default)))
332 333 334
    (if (and (> (length name) 0)
	     (get-language-info name key))
	name)))
Karl Heuer's avatar
Karl Heuer committed
335 336 337

;;; Multilingual input methods.

338 339 340 341 342 343 344 345 346 347 348 349 350
(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.")

(defvar leim-list-header (format "\
;;; %s -- list of LEIM (Library of Emacs Input Method)
;;
;; This file contains a list of LEIM (Library of Emacs Input Method)
;; in the same directory as this file.  Loading this file registeres
;; the whole input methods in Emacs.
;;
Kenichi Handa's avatar
Kenichi Handa committed
351
;; Each entry has the form:
352 353 354 355 356 357 358 359 360 361 362 363 364
;;   (register-input-method
;;    INPUT-METHOD LANGUAGE-NAME ACTIVATE-FUNC
;;    TITLE DESCRIPTION
;;    ARG ...)
;; See the function `register-input-method' for the meanings of arguments.
;;
;; 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.")

365
(defvar leim-list-entry-regexp "^(register-input-method"
366 367 368 369 370 371 372 373
  "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.")

374 375
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
376 377
  (let ((functions update-leim-list-functions))
    (while functions
378
      (apply (car functions) dirs)
379 380
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
381 382
(defvar current-input-method nil
  "The current input method for multilingual text.
383
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
384 385 386 387
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

392 393 394
(defcustom default-input-method nil
  "*Default input method for multilingual text.
This is the input method activated automatically by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
395
`toggle-input-method' (\\[toggle-input-method])."
396 397
  :group 'mule)

Kenichi Handa's avatar
Kenichi Handa committed
398 399 400 401
(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
402 403 404 405

(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.
406 407 408 409
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
410 411 412 413 414 415 416 417 418
(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)

419 420 421 422 423 424 425 426
(defvar input-method-alist nil
  "Alist of input method names vs the corresponding information to use it.
Each element has the form:
	(INPUT-METHOD LANGUAGE-NAME ACTIVATE-FUNC TITLE DESCRIPTION ...)
See the function `register-input-method' for the meanings of each elements.")

(defun register-input-method (input-method language-name &rest args)
  "Register INPUT-METHOD as an input method for LANGUAGE-NAME.
427
INPUT-METHOD and LANGUAGE-NAME are symbols or strings.
428 429 430 431 432 433 434
The remaining arguments are:
	ACTIVATE-FUNC, TITLE, DESCRIPTION, and ARG ...
 where,
ACTIVATE-FUNC is a function to call for activating this method.
TITLE is a string shown in mode-line while this method is active,
DESCRIPTION is a string describing about this method,
Arguments to ACTIVATE-FUNC are INPUT-METHOD and ARGs."
435 436 437 438
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
439 440 441 442 443 444 445
  (let ((info (cons language-name args))
	(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)))))

446
(defun read-input-method-name (prompt &optional default inhibit-null)
447
  "Read a name of input method from a minibuffer prompting with PROMPT.
448 449
If DEFAULT is non-nil, use that as the default,
  and substitute it into PROMPT at the first `%s'.
450 451 452
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
453 454
  (if default
      (setq prompt (format prompt default)))
455
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
456 457
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
458
	 (input-method (completing-read prompt input-method-alist
459 460
					nil t nil 'input-method-history
					default)))
461 462 463
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
464
	  (error "No valid input method is specified")))))
465 466

(defun activate-input-method (input-method)
467 468
  "Turn INPUT-METHOD on.
If some input method is already on, turn it off at first."
469 470
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
Kenichi Handa's avatar
Kenichi Handa committed
471 472
  (if (and current-input-method
	   (not (string= current-input-method input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
473 474
    (inactivate-input-method))
  (unless current-input-method
475 476
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
Kenichi Handa's avatar
Kenichi Handa committed
477
	  (error "Can't activate input method `%s'" input-method))
Kenichi Handa's avatar
Kenichi Handa committed
478 479 480 481 482 483 484 485
      (let ((func (nth 2 slot)))
	(if (functionp func)
	    (apply (nth 2 slot) input-method (nthcdr 5 slot))
	  (if (and (consp func) (symbolp (car func)) (symbolp (cdr func)))
	      (progn
		(require (cdr func))
		(apply (car func) input-method (nthcdr 5 slot)))
	    (error "Can't activate input method `%s'" input-method))))
486
      (setq current-input-method input-method)
Kenichi Handa's avatar
Kenichi Handa committed
487 488
      (setq current-input-method-title (nth 3 slot))
      (run-hooks 'input-method-activate-hook))))
489 490

(defun inactivate-input-method ()
491
  "Turn off the current input method."
Kenichi Handa's avatar
Kenichi Handa committed
492 493 494 495 496 497 498 499 500
  (when current-input-method
    (if input-method-history
	(unless (string= current-input-method (car input-method-history))
	  (setq input-method-history
		(cons current-input-method
		      (delete current-input-method input-method-history))))
      (setq input-method-history (list current-input-method)))
    (unwind-protect
	(funcall inactivate-current-input-method-function)
501
      (unwind-protect
Kenichi Handa's avatar
Kenichi Handa committed
502 503 504
	  (run-hooks 'input-method-inactivate-hook)
	(setq current-input-method nil
	      current-input-method-title nil)))))
Karl Heuer's avatar
Karl Heuer committed
505

506
(defun set-input-method (input-method)
Kenichi Handa's avatar
Kenichi Handa committed
507 508 509
  "Select and turn on INPUT-METHOD.
This sets the default input method to what you specify,
and turn it on for the current buffer."
510
  (interactive
Kenichi Handa's avatar
Kenichi Handa committed
511
   (let* ((default (or (car input-method-history) default-input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
512
     (list (read-input-method-name
513
	    (if default "Select input method (default %s): " "Select input method: ")
Richard M. Stallman's avatar
Richard M. Stallman committed
514
	    default t))))
515
  (activate-input-method input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
516
  (setq default-input-method input-method))
Karl Heuer's avatar
Karl Heuer committed
517 518

(defun toggle-input-method (&optional arg)
519
  "Turn on or off a multilingual text input method for the current buffer.
Kenichi Handa's avatar
Kenichi Handa committed
520

521
With arg, read an input method from minibuffer and turn it on.
Kenichi Handa's avatar
Kenichi Handa committed
522

523
Without arg, if some input method is currently activated, turn it off,
Kenichi Handa's avatar
Kenichi Handa committed
524 525 526 527
else turn on an input method selected last time
or the default input method (see `default-input-method').

When there's no input method to turn on, turn on what read from minibuffer."
Karl Heuer's avatar
Karl Heuer committed
528
  (interactive "P")
Kenichi Handa's avatar
Kenichi Handa committed
529
  (let* ((default (or (car input-method-history) default-input-method)))
530 531
    (if (and current-input-method (not arg))
	(inactivate-input-method)
Kenichi Handa's avatar
Kenichi Handa committed
532 533 534 535 536 537 538 539
      (activate-input-method
       (if (or arg (not default))
	   (read-input-method-name
	    (if default "Input method (default %s): " "Input method: " )
	    default t)  
	 default))
      (or default-input-method
	  (setq default-input-method current-input-method)))))
540 541

(defun describe-input-method (input-method)
542
  "Describe  input method INPUT-METHOD."
543 544 545
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
546
  (if (and input-method (symbolp input-method))
547
      (setq input-method (symbol-name input-method)))
548 549 550 551 552 553 554 555
  (if (null input-method)
      (describe-current-input-method)
    (with-output-to-temp-buffer "*Help*"
      (let ((elt (assoc input-method input-method-alist)))
	(princ (format "Input method: %s (`%s' in mode line) for %s\n  %s\n"
		       input-method (nth 3 elt) (nth 1 elt) (nth 4 elt)))))))

(defun describe-current-input-method ()
556
  "Describe the input method currently in use."
Karl Heuer's avatar
Karl Heuer committed
557 558 559 560 561 562 563
  (if current-input-method
      (if (and (symbolp describe-current-input-method-function)
	       (fboundp describe-current-input-method-function))
	  (funcall describe-current-input-method-function)
	(message "No way to describe the current input method `%s'"
		 (cdr current-input-method))
	(ding))
564
    (error "No input method is activated now")))
Karl Heuer's avatar
Karl Heuer committed
565

566
(defun read-multilingual-string (prompt &optional initial-input input-method)
Karl Heuer's avatar
Karl Heuer committed
567 568
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
569
If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
570 571
initially.
Optional 3rd argument INPUT-METHOD specifies the input method
572 573
to be activated instead of the one selected last time.  It is a symbol
or a string."
574 575
  (setq input-method
	(or input-method
576
	    current-input-method
577 578
	    default-input-method
	    (read-input-method-name "Input method: " nil t)))
579
  (if (and input-method (symbolp input-method))
580
      (setq input-method (symbol-name input-method)))
581 582 583 584 585 586 587 588
  (let ((previous-input-method current-input-method))
    (unwind-protect
	(progn
	  (activate-input-method input-method)
	  (read-string prompt initial-input nil nil t))
      (if previous-input-method
	  (activate-input-method previous-input-method)
	(inactivate-input-method)))))
Karl Heuer's avatar
Karl Heuer committed
589 590 591 592

;; Variables to control behavior of input methods.  All input methods
;; should react to these variables.

Kenichi Handa's avatar
Kenichi Handa committed
593 594 595
(defcustom input-method-verbose-flag 'default
  "*A flag to control extra guidance given by input methods.
The value should be nil, t, `complex-only', or `default'.
Karl Heuer's avatar
Karl Heuer committed
596

597
The extra guidance is done by showing list of available keys in echo
Kenichi Handa's avatar
Kenichi Handa committed
598 599
area.  When you use the input method in the minibuffer, the guidance
is shown at the bottom short window (split from the existing window).
Kenichi Handa's avatar
Kenichi Handa committed
600

Kenichi Handa's avatar
Kenichi Handa committed
601 602 603 604 605 606 607 608 609 610 611 612
If the value is t, extra guidance is always given, if the value is
nil, extra guidance is always suppressed.

If the value is `complex-only', only complex input methods such as
`chinese-py' and `japanese' give extra guidance.

If the value is `default', complex input methods always give extra
guidance, but simple input methods give it only when you are not in
the minibuffer.

See also the variable `input-method-highlight-flag'."
  :type '(choice (const t) (const nil) (const complex-only) (const default))
Richard M. Stallman's avatar
Richard M. Stallman committed
613 614 615 616 617 618
  :group 'mule)

(defcustom input-method-highlight-flag t
  "*If this flag is non-nil, input methods highlight partially-entered text.
For instance, while you are in the middle of a Quail input method sequence,
the text inserted so far is temporarily underlined.
Kenichi Handa's avatar
Kenichi Handa committed
619 620
The underlining goes away when you finish or abort the input method sequence.
See also the variable `input-method-verbose-flag'."
Richard M. Stallman's avatar
Richard M. Stallman committed
621 622
  :type 'boolean
  :group 'mule)
Karl Heuer's avatar
Karl Heuer committed
623 624

(defvar input-method-activate-hook nil
625 626 627 628
  "Normal hook run just after an input method is activated.

The variable `current-input-method' keeps the input method name
just activated.")
Karl Heuer's avatar
Karl Heuer committed
629 630

(defvar input-method-inactivate-hook nil
631 632 633
  "Normal hook run just after an input method is inactivated.

The variable `current-input-method' still keeps the input method name
Karl Heuer's avatar
Karl Heuer committed
634
just inactivated.")
Karl Heuer's avatar
Karl Heuer committed
635 636 637 638

(defvar input-method-after-insert-chunk-hook nil
  "Normal hook run just after an input method insert some chunk of text.")

Kenichi Handa's avatar
Kenichi Handa committed
639 640 641 642 643 644 645 646
(defvar input-method-exit-on-invalid-key nil
  "This flag controls the behaviour of an input method on invalid key input.
Usually, when a user types a key which doesn't start any character
handled by the input method, the key is handled by turning off the
input method temporalily.  After the key is handled, the input method is 
back on.
But, if this flag is non-nil, the input method is never back on.")

Karl Heuer's avatar
Karl Heuer committed
647

Kenichi Handa's avatar
Kenichi Handa committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
(defvar set-language-environment-hook nil
  "Normal hook run after some language environment is set.

When you set some hook function here, that effect usually should not
be inherited to another language environment.  So, you had better set
another function in `exit-language-environment-hook' (which see) to
cancel the effect.")

(defvar exit-language-environment-hook nil
  "Normal hook run after exiting from some language environment.
When this hook is run, the variable `current-language-environment'
is still bound to the language environment being exited.

This hook is mainly used for cancelling the effect of
`set-language-environment-hook' (which-see).")

664
(defun setup-specified-language-environment ()
665
  "Set up multi-lingual environment convenient for the specified language."
666
  (interactive)
667
  (let (language-name)
668 669 670
    (if (and (symbolp last-command-event)
	     (or (not (eq last-command-event 'Default))
		 (setq last-command-event 'English))
671 672
	     (setq language-name (symbol-name last-command-event)))
	(set-language-environment language-name)
673
      (error "Bogus calling sequence"))))
Karl Heuer's avatar
Karl Heuer committed
674

675 676 677
(defvar current-language-environment "English"
  "The last language environment specified with `set-language-environment'.")

678
(defun set-language-environment (language-name)
679 680 681
  "Set up multi-lingual environment for using LANGUAGE-NAME.
This sets the coding system priority and the default input method
and sometimes other things."
Kenichi Handa's avatar
Kenichi Handa committed
682 683 684
  (interactive (list (read-language-name
		      'setup-function
		      "Set language environment (default, English): ")))
685 686 687 688
  (if language-name
      (if (symbolp language-name)
	  (setq language-name (symbol-name language-name)))
    (setq language-name "English"))
689
  (if (null (get-language-info language-name 'setup-function))
690
      (error "Language environment not defined: %S" language-name))
Kenichi Handa's avatar
Kenichi Handa committed
691 692 693
  (if current-language-environment
      (let ((func (get-language-info current-language-environment
				     'exit-function)))
694 695
	(run-hooks 'exit-language-environment-hook)
	(if (fboundp func) (funcall func))))
696
  (setq current-language-environment language-name)
Kenichi Handa's avatar
Kenichi Handa committed
697 698
  (funcall (get-language-info language-name 'setup-function))
  (run-hooks 'set-language-environment-hook)
699
  (force-mode-line-update t))
Karl Heuer's avatar
Karl Heuer committed
700 701 702 703 704 705

;; Print all arguments with `princ', then print "\n".
(defsubst princ-list (&rest args)
  (while args (princ (car args)) (setq args (cdr args)))
  (princ "\n"))

706
;; Print a language specific information such as input methods,
707
;; charsets, and coding systems.  This function is intended to be
708
;; called from the menu:
709
;;   [menu-bar mule describe-language-environment LANGUAGE]
710 711
;; and should not run it by `M-x describe-current-input-method-function'.
(defun describe-specified-language-support ()
712
  "Describe how Emacs supports the specified language environment."
713
  (interactive)
714
  (let (language-name)
715
    (if (not (and (symbolp last-command-event)
716
		  (setq language-name (symbol-name last-command-event))))
717
	(error "Bogus calling sequence"))
718 719 720 721
    (describe-language-environment language-name)))

(defun describe-language-environment (language-name)
  "Describe how Emacs supports language environment LANGUAGE-NAME."
722 723 724
  (interactive
   (list (read-language-name
	  'documentation
725
	  "Describe language environment (default, current choice): ")))
726 727
  (if (null language-name)
      (setq language-name current-language-environment))
728 729 730
  (if (or (null language-name)
	  (null (get-language-info language-name 'documentation)))
      (error "No documentation for the specified language"))
731 732
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
733
  (let ((doc (get-language-info language-name 'documentation)))
734
    (with-output-to-temp-buffer "*Help*"
735
      (if (stringp doc)
736 737 738
	  (progn
	    (princ-list doc)
	    (terpri)))
739 740 741
      (let ((str (get-language-info language-name 'sample-text)))
	(if (stringp str)
	    (progn
742
	      (princ "Sample text:\n")
743 744
	      (princ-list "  " str)
	      (terpri))))
745
      (princ "Input methods:\n")
746
      (let ((l input-method-alist))
747
	(while l
748 749 750
	  (if (string= language-name (nth 1 (car l)))
	      (princ-list "  " (car (car l))
			  (format " (`%s' in mode line)" (nth 3 (car l)))))
751
	  (setq l (cdr l))))
752 753
      (terpri)
      (princ "Character sets:\n")
754 755 756 757 758 759 760
      (let ((l (get-language-info language-name 'charset)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)
	  (while l
	    (princ-list "  " (car l) ": "
			(charset-description (car l)))
	    (setq l (cdr l)))))
761 762
      (terpri)
      (princ "Coding systems:\n")
763 764 765
      (let ((l (get-language-info language-name 'coding-system)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)
766
	  (while l
767 768 769
	    (princ (format "  %s (`%c' in mode line):\n\t%s\n"
			   (car l)
			   (coding-system-mnemonic (car l))
770
			   (coding-system-doc-string (car l))))
Kenichi Handa's avatar
Kenichi Handa committed
771 772 773 774 775
	    (let ((aliases (coding-system-get (car l) 'alias-coding-systems)))
	      (when aliases
		(princ "\t")
		(princ (cons 'alias: (cdr aliases)))
		(terpri)))
776
	    (setq l (cdr l))))))))
Karl Heuer's avatar
Karl Heuer committed
777 778 779 780 781 782

;;; Charset property

(defsubst get-charset-property (charset propname)
  "Return the value of CHARSET's PROPNAME property.
This is the last value stored with
783
 (put-charset-property CHARSET PROPNAME VALUE)."
Karl Heuer's avatar
Karl Heuer committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
  (plist-get (charset-plist charset) propname))

(defsubst put-charset-property (charset propname value)
  "Store CHARSETS's PROPNAME property with value VALUE.
It can be retrieved with `(get-charset-property CHARSET PROPNAME)'."
  (set-charset-plist charset
		     (plist-put (charset-plist charset) propname value)))

;;; Character code property
(put 'char-code-property-table 'char-table-extra-slots 0)

(defvar char-code-property-table
  (make-char-table 'char-code-property-table)
  "Char-table containing a property list of each character code.

See also the documentation of `get-char-code-property' and
800
`put-char-code-property'.")
Karl Heuer's avatar
Karl Heuer committed
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819

(defun get-char-code-property (char propname)
  "Return the value of CHAR's PROPNAME property in `char-code-property-table'."
  (let ((plist (aref char-code-property-table char)))
    (if (listp plist)
	(car (cdr (memq propname plist))))))

(defun put-char-code-property (char propname value)
  "Store CHAR's PROPNAME property with VALUE in `char-code-property-table'.
It can be retrieved with `(get-char-code-property CHAR PROPNAME)'."
  (let ((plist (aref char-code-property-table char)))
    (if plist
	(let ((slot (memq propname plist)))
	  (if slot
	      (setcar (cdr slot) value)
	    (nconc plist (list propname value))))
      (aset char-code-property-table char (list propname value)))))

;;; mule-cmds.el ends here