mule-cmds.el 29.1 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 37
(define-key mule-keymap "m" 'toggle-enable-multibyte-characters)
(define-key mule-keymap "f" 'set-buffer-file-coding-system)
(define-key mule-keymap "t" 'set-terminal-coding-system)
38 39
(define-key mule-keymap "k" 'set-keyboard-coding-system)
(define-key mule-keymap "p" 'set-buffer-process-coding-system)
40
(define-key mule-keymap "\C-\\" 'select-input-method)
41
(define-key mule-keymap "c" 'universal-coding-system-argument)
42
(define-key mule-keymap "l" 'set-language-environment)
Karl Heuer's avatar
Karl Heuer committed
43

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

Richard M. Stallman's avatar
Richard M. Stallman committed
51
(defvar mule-menu-keymap (make-sparse-keymap "Mule")
52 53 54 55 56 57
  "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))

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

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

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

(define-key-after set-coding-system-map [set-buffer-file-coding-system]
111
  '("Buffer File" . set-buffer-file-coding-system)
112
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
113 114 115
(define-key-after set-coding-system-map [universal-coding-system-argument]
  '("Next Command" . universal-coding-system-argument)
  t)
116 117 118 119 120 121 122
(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]
123
  '("Buffer Process" . set-buffer-process-coding-system)
124 125 126 127
  t)

(define-key setup-language-environment-map
  [Default] '("Default" . setup-specified-language-environment))
Karl Heuer's avatar
Karl Heuer committed
128 129 130

;; These are meaningless when running under X.
(put 'set-terminal-coding-system 'menu-enable
131
     '(not (eq window-system 'x)))
132
(put 'set-keyboard-coding-system 'menu-enable
133
     '(not (eq window-system 'x)))
134 135 136
;; 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
137 138 139 140 141 142 143 144 145

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

146 147 148 149
;;; 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)
150

Karl Heuer's avatar
Karl Heuer committed
151 152 153 154 155 156 157 158 159 160 161 162
(defun toggle-enable-multibyte-characters (&optional arg)
  "Change whether this buffer enables multibyte characters.
With arg, make them enable iff arg is positive."
  (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)
163 164
  ;; We have to decode the file in any environment.
  (let ((default-enable-multibyte-characters t)
165
	(coding-system-for-read 'iso-2022-7bit))
166
    (find-file-read-only (expand-file-name "HELLO" data-directory))))
Karl Heuer's avatar
Karl Heuer committed
167

168 169 170 171 172 173 174 175 176 177 178 179
(defun universal-coding-system-argument ()
  "Execute an I/O command using the specified coding system."
  (interactive)
  (let* ((coding-system (read-coding-system "Coding system: "))
	 (keyseq (read-key-sequence
		  (format "With coding system %s:" coding-system)))
	 (cmd (key-binding keyseq)))
    (let ((coding-system-for-read coding-system)
	  (coding-system-for-write coding-system))
      (message "")
      (call-interactively cmd))))

180
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
181 182 183 184 185 186
  "Set default value of various coding systems to CODING-SYSTEM.
The follwing coding systems are set:
  o coding system of a newly created buffer
  o default coding system for terminal output
  o default coding system for keyboard input
  o default coding system for subprocess I/O"
187 188 189 190 191 192
  (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
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
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
This also sets the following coding systems to CODING-SYSTEM:
  o coding system of a newly created buffer
  o default coding system for terminal output
  o default coding system for keyboard input
  o default coding system for subprocess I/O"
  (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))
	(parent (coding-system-parent coding-system)))
    (if (not coding-category)
	;; CODING-SYSTEM is no-conversion or undecided.
	(error "Can't prefer the coding system `%s'" coding-system))
    (set coding-category (or parent coding-system))
    (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))))
    (if (and parent (interactive-p))
	(message "Highest priority is set to %s (parent of %s)"
		 parent coding-system))
    (set-default-coding-systems (or parent coding-system))))

Karl Heuer's avatar
Karl Heuer committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233

;;; 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."
234 235
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
236
  (let ((lang-slot (assoc-ignore-case language-name language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
237 238 239 240 241 242 243 244 245
    (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:
246

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

Karl Heuer's avatar
Karl Heuer committed
249
coding-system: list of coding systems specific to the langauge.
250

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

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

255
documentation: t or a string describing how Emacs supports the language.
256 257 258
      If a string is specified, it is shown before any other information
      of the language by the command `describe-language-environment'.

259
setup-function: a function to call for setting up environment
260
       convenient for a user of the language.
261 262 263 264 265 266 267

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.
268

269 270
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-'."
271 272
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
273 274 275 276 277 278 279 280 281 282 283
  (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.
284
    (cond ((eq key 'documentation)
285 286 287 288
	   (define-key-after
	     (if (consp info)
		 (prog1 (symbol-value (cdr info))
		   (setq info (car info)))
289
	       describe-language-environment-map)
Kenichi Handa's avatar
Kenichi Handa committed
290
	     (vector (intern language-name))
291
	     (cons language-name 'describe-specified-language-support)
292
	     t))
Kenichi Handa's avatar
Kenichi Handa committed
293
	  ((eq key 'setup-function)
294 295 296 297 298
	   (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
299
	     (vector (intern language-name))
300
	     (cons language-name 'setup-specified-language-environment)
301
	     t)))
302 303

    (setcdr key-slot info)
Karl Heuer's avatar
Karl Heuer committed
304 305 306 307 308 309
    ))

(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."
310 311
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
312 313 314 315
  (while alist
    (set-language-info language-name (car (car alist)) (cdr (car alist)))
    (setq alist (cdr alist))))

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

331 332 333 334 335 336 337 338 339 340 341 342 343
(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
344
;; Each entry has the form:
345 346 347 348 349 350 351 352 353 354 355 356 357
;;   (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.")

358
(defvar leim-list-entry-regexp "^(register-input-method"
359 360 361 362 363 364 365 366
  "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.")

367 368
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
369 370
  (let ((functions update-leim-list-functions))
    (while functions
371
      (apply (car functions) dirs)
372 373
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
374 375
(defvar current-input-method nil
  "The current input method for multilingual text.
376
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
377 378 379 380
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

385 386 387
(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
388
`toggle-input-method' (\\[toggle-input-method])."
389 390
  :group 'mule)

Kenichi Handa's avatar
Kenichi Handa committed
391 392 393 394
(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
395 396 397 398

(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.
399 400 401 402
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
403 404 405 406 407 408 409 410 411
(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)

412 413 414 415 416 417 418 419
(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.
420
INPUT-METHOD and LANGUAGE-NAME are symbols or strings.
421 422 423 424 425 426 427
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."
428 429 430 431
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
432 433 434 435 436 437 438
  (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)))))

439
(defun read-input-method-name (prompt &optional default inhibit-null)
440
  "Read a name of input method from a minibuffer prompting with PROMPT.
441 442
If DEFAULT is non-nil, use that as the default,
  and substitute it into PROMPT at the first `%s'.
443 444 445
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
446 447
  (if default
      (setq prompt (format prompt default)))
448
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
449 450 451
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
	 (minibuffer-history input-method-history)
452
	 (input-method (completing-read prompt input-method-alist
453
					nil t nil nil default)))
454 455 456
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
457
	  (error "No valid input method is specified")))))
458 459

(defun activate-input-method (input-method)
460 461
  "Turn INPUT-METHOD on.
If some input method is already on, turn it off at first."
462 463
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
Kenichi Handa's avatar
Kenichi Handa committed
464 465
  (if (and current-input-method
	   (not (string= current-input-method input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
466 467
    (inactivate-input-method))
  (unless current-input-method
468 469
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
Kenichi Handa's avatar
Kenichi Handa committed
470
	  (error "Can't activate input method `%s'" input-method))
471 472
      (apply (nth 2 slot) input-method (nthcdr 5 slot))
      (setq current-input-method input-method)
Kenichi Handa's avatar
Kenichi Handa committed
473 474
      (setq current-input-method-title (nth 3 slot))
      (run-hooks 'input-method-activate-hook))))
475 476

(defun inactivate-input-method ()
477
  "Turn off the current input method."
Kenichi Handa's avatar
Kenichi Handa committed
478 479 480 481 482 483 484 485 486
  (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)
487
      (unwind-protect
Kenichi Handa's avatar
Kenichi Handa committed
488 489 490
	  (run-hooks 'input-method-inactivate-hook)
	(setq current-input-method nil
	      current-input-method-title nil)))))
Karl Heuer's avatar
Karl Heuer committed
491

492
(defun select-input-method (input-method)
Kenichi Handa's avatar
Kenichi Handa committed
493 494 495
  "Select and turn on INPUT-METHOD.
This sets the default input method to what you specify,
and turn it on for the current buffer."
496
  (interactive
Kenichi Handa's avatar
Kenichi Handa committed
497
   (let* ((default (or (car input-method-history) default-input-method)))
498
     (if (not enable-multibyte-characters)
499
	 (error "Can't activate an input method while multibyte characters are disabled"))
Richard M. Stallman's avatar
Richard M. Stallman committed
500
     (list (read-input-method-name
Kenichi Handa's avatar
Kenichi Handa committed
501
	    (if default "Input method (default %s): " "Input method: ")
Richard M. Stallman's avatar
Richard M. Stallman committed
502
	    default t))))
503
  (activate-input-method input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
504
  (setq default-input-method input-method))
Karl Heuer's avatar
Karl Heuer committed
505 506

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

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

511
Without arg, if some input method is currently activated, turn it off,
Kenichi Handa's avatar
Kenichi Handa committed
512 513 514 515
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
516
  (interactive "P")
Kenichi Handa's avatar
Kenichi Handa committed
517
  (let* ((default (or (car input-method-history) default-input-method)))
518 519
    (if (and current-input-method (not arg))
	(inactivate-input-method)
Kenichi Handa's avatar
Kenichi Handa committed
520 521 522 523 524 525 526 527
      (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)))))
528 529

(defun describe-input-method (input-method)
530
  "Describe  input method INPUT-METHOD."
531 532 533
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
534
  (if (and input-method (symbolp input-method))
535
      (setq input-method (symbol-name input-method)))
536 537 538 539 540 541 542 543
  (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 ()
544
  "Describe the input method currently in use."
Karl Heuer's avatar
Karl Heuer committed
545 546 547 548 549 550 551
  (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))
552
    (error "No input method is activated now")))
Karl Heuer's avatar
Karl Heuer committed
553 554

(defun read-multilingual-string (prompt &optional initial-input
555
					input-method)
Karl Heuer's avatar
Karl Heuer committed
556 557
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
558
If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
559 560
initially.
Optional 3rd argument INPUT-METHOD specifies the input method
561 562
to be activated instead of the one selected last time.  It is a symbol
or a string."
563 564 565 566
  (setq input-method
	(or input-method
	    default-input-method
	    (read-input-method-name "Input method: " nil t)))
567
  (if (and input-method (symbolp input-method))
568
      (setq input-method (symbol-name input-method)))
569
  (let ((current-input-method input-method))
570
    (read-string prompt initial-input nil nil t)))
Karl Heuer's avatar
Karl Heuer committed
571 572 573 574

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

Richard M. Stallman's avatar
Richard M. Stallman committed
575 576
(defcustom input-method-verbose-flag t
  "*If this flag is non-nil, input methods give extra guidance.
Karl Heuer's avatar
Karl Heuer committed
577 578

For instance, Quail input method does not show guidance buffer while
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580 581 582 583 584 585 586 587 588 589
inputting at minibuffer if this flag is t."
  :type 'boolean
  :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.
The underlining goes away when you finish or abort the input method sequence."
  :type 'boolean
  :group 'mule)
Karl Heuer's avatar
Karl Heuer committed
590 591

(defvar input-method-activate-hook nil
592 593 594 595
  "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
596 597

(defvar input-method-inactivate-hook nil
598 599 600 601
  "Normal hook run just after an input method is inactivated.

The variable `current-input-method' still keeps the input method name
just inacitvated.")
Karl Heuer's avatar
Karl Heuer committed
602 603 604 605

(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
606 607 608 609 610 611 612 613
(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
614

615
(defun setup-specified-language-environment ()
616
  "Set up multi-lingual environment convenient for the specified language."
617
  (interactive)
618
  (let (language-name)
619 620 621
    (if (and (symbolp last-command-event)
	     (or (not (eq last-command-event 'Default))
		 (setq last-command-event 'English))
622 623
	     (setq language-name (symbol-name last-command-event)))
	(set-language-environment language-name)
624
      (error "Bogus calling sequence"))))
Karl Heuer's avatar
Karl Heuer committed
625

626 627 628
(defvar current-language-environment "English"
  "The last language environment specified with `set-language-environment'.")

629
(defun set-language-environment (language-name)
630 631 632
  "Set up multi-lingual environment for using LANGUAGE-NAME.
This sets the coding system priority and the default input method
and sometimes other things."
633 634
  (interactive (list (read-language-name 'setup-function
					 "Language (null for default): ")))
635 636 637 638
  (if language-name
      (if (symbolp language-name)
	  (setq language-name (symbol-name language-name)))
    (setq language-name "English"))
639
  (if (null (get-language-info language-name 'setup-function))
640 641 642 643
      (error "Language environment not defined: %S" language-name))
  (funcall (get-language-info language-name 'setup-function))
  (setq current-language-environment language-name)
  (force-mode-line-update t))
Karl Heuer's avatar
Karl Heuer committed
644 645 646 647 648 649

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

650
;; Print a language specific information such as input methods,
651
;; charsets, and coding systems.  This function is intended to be
652
;; called from the menu:
653
;;   [menu-bar mule describe-language-environment LANGUAGE]
654 655
;; and should not run it by `M-x describe-current-input-method-function'.
(defun describe-specified-language-support ()
656
  "Describe how Emacs supports the specified language environment."
657
  (interactive)
658
  (let (language-name)
659
    (if (not (and (symbolp last-command-event)
660
		  (setq language-name (symbol-name last-command-event))))
661
	(error "Bogus calling sequence"))
662 663 664 665
    (describe-language-environment language-name)))

(defun describe-language-environment (language-name)
  "Describe how Emacs supports language environment LANGUAGE-NAME."
666 667 668 669
  (interactive
   (list (read-language-name
	  'documentation
	  "Describe language environment (default, current choise): ")))
670 671
  (if (null language-name)
      (setq language-name current-language-environment))
672 673 674
  (if (or (null language-name)
	  (null (get-language-info language-name 'documentation)))
      (error "No documentation for the specified language"))
675 676
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
677
  (let ((doc (get-language-info language-name 'documentation)))
678
    (with-output-to-temp-buffer "*Help*"
679
      (if (stringp doc)
680 681 682
	  (progn
	    (princ-list doc)
	    (terpri)))
683 684 685
      (let ((str (get-language-info language-name 'sample-text)))
	(if (stringp str)
	    (progn
686
	      (princ "Sample text:\n")
687 688
	      (princ-list "  " str)
	      (terpri))))
689
      (princ "Input methods:\n")
690
      (let ((l input-method-alist))
691
	(while l
692 693 694
	  (if (string= language-name (nth 1 (car l)))
	      (princ-list "  " (car (car l))
			  (format " (`%s' in mode line)" (nth 3 (car l)))))
695
	  (setq l (cdr l))))
696 697
      (terpri)
      (princ "Character sets:\n")
698 699 700 701 702 703 704
      (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)))))
705 706
      (terpri)
      (princ "Coding systems:\n")
707 708 709
      (let ((l (get-language-info language-name 'coding-system)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)
710
	  (while l
711 712 713
	    (princ (format "  %s (`%c' in mode line):\n\t%s\n"
			   (car l)
			   (coding-system-mnemonic (car l))
714
			   (coding-system-doc-string (car l))))
715
	    (setq l (cdr l))))))))
Karl Heuer's avatar
Karl Heuer committed
716 717 718 719 720 721

;;; Charset property

(defsubst get-charset-property (charset propname)
  "Return the value of CHARSET's PROPNAME property.
This is the last value stored with
722
 (put-charset-property CHARSET PROPNAME VALUE)."
Karl Heuer's avatar
Karl Heuer committed
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
  (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
739
`put-char-code-property'.")
Karl Heuer's avatar
Karl Heuer committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

(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