mule-cmds.el 25.9 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.

29
(defvar mule-keymap nil
Karl Heuer's avatar
Karl Heuer committed
30
  "Keymap for MULE (Multilingual environment) specific commands.")
31
(define-prefix-command 'mule-keymap)
Karl Heuer's avatar
Karl Heuer committed
32

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

Karl Heuer's avatar
Karl Heuer committed
36 37 38
(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)
39 40
(define-key mule-keymap "k" 'set-keyboard-coding-system)
(define-key mule-keymap "p" 'set-buffer-process-coding-system)
41
(define-key mule-keymap "\C-\\" 'select-input-method)
42
(define-key mule-keymap "c" 'universal-coding-system-argument)
43
(define-key mule-keymap "l" 'set-language-environment)
Karl Heuer's avatar
Karl Heuer committed
44

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

52 53 54 55 56 57 58 59
(defvar mule-menu-keymap nil
  "Keymap for MULE (Multilingual environment) menu specific commands.")
(define-prefix-command 'mule-menu-keymap)

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

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

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

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

(define-key-after set-coding-system-map [set-buffer-file-coding-system]
113
  '("Buffer File" . set-buffer-file-coding-system)
114 115 116 117 118 119 120 121
  t)
(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]
122
  '("Buffer Process" . set-buffer-process-coding-system)
123 124 125 126
  t)

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

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

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

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

Karl Heuer's avatar
Karl Heuer committed
150 151 152 153 154 155 156 157 158 159 160 161
(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)
162 163
  ;; We have to decode the file in any environment.
  (let ((default-enable-multibyte-characters t)
164
	(coding-system-for-read 'iso-2022-7bit))
165
    (find-file-read-only (expand-file-name "HELLO" data-directory))))
Karl Heuer's avatar
Karl Heuer committed
166

167 168 169 170 171 172 173 174 175 176 177 178
(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))))

179 180 181 182 183 184 185 186
(defun set-default-coding-systems (coding-system)
  "Set default value of various coding systems to CODING-SYSTEM."
  (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)))

Karl Heuer's avatar
Karl Heuer committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

;;; Language support staffs.

(defvar primary-language "English"
  "Name of a user's primary language.
Emacs provide various language supports based on this variable.")

(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.
LANGUAGE-NAME is a string.
KEY is a symbol denoting the kind of required information."
207
  (let ((lang-slot (assoc-ignore-case language-name language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
208 209 210 211 212 213 214 215 216 217
    (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.
LANGUAGE-NAME is a string
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:
218

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

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

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

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

227
documentation: t or a string describing how Emacs supports the language.
228 229 230
      If a string is specified, it is shown before any other information
      of the language by the command `describe-language-environment'.

231
setup-function: a function to call for setting up environment
232
       convenient for a user of the language.
233 234 235 236 237 238 239

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

241 242
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-'."
Karl Heuer's avatar
Karl Heuer committed
243 244 245 246 247 248 249 250 251 252 253
  (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.
254
    (cond ((eq key 'documentation)
255 256 257 258
	   (define-key-after
	     (if (consp info)
		 (prog1 (symbol-value (cdr info))
		   (setq info (car info)))
259
	       describe-language-environment-map)
Kenichi Handa's avatar
Kenichi Handa committed
260
	     (vector (intern language-name))
261
	     (cons language-name 'describe-specified-language-support)
262
	     t))
Kenichi Handa's avatar
Kenichi Handa committed
263
	  ((eq key 'setup-function)
264 265 266 267 268
	   (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
269
	     (vector (intern language-name))
270
	     (cons language-name 'setup-specified-language-environment)
271
	     t)))
272 273

    (setcdr key-slot info)
Karl Heuer's avatar
Karl Heuer committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
    ))

(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."
  (while alist
    (set-language-info language-name (car (car alist)) (cdr (car alist)))
    (setq alist (cdr alist))))

(defun read-language-name (key prompt &optional initial-input)
  "Read language name which has information for KEY, prompting with PROMPT."
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
				(function (lambda (elm) (assq key elm)))
				t
				initial-input)))
292 293 294
    (if (and (> (length name) 0)
	     (get-language-info name key))
	name)))
Karl Heuer's avatar
Karl Heuer committed
295 296 297

;;; Multilingual input methods.

298 299 300 301 302 303 304 305 306 307 308 309 310
(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
311
;; Each entry has the form:
312 313 314 315 316 317 318 319 320 321 322 323 324
;;   (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.")

325
(defvar leim-list-entry-regexp "^(register-input-method"
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
  "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.")

(defun update-leim-list-file (dir)
  "Update LEIM list file in directory DIR."
  (let ((functions update-leim-list-functions))
    (while functions
      (funcall (car functions) (expand-file-name dir))
      (setq functions (cdr functions)))))

(defun update-all-leim-list-files ()
  "Update all the LEIM list files."
  (interactive)
  (let ((l load-path))
    (while l
      (if (string-match "leim" (car l))
	  (update-leim-list-file (car l)))
      (setq l (cdr l)))))

Karl Heuer's avatar
Karl Heuer committed
350 351
(defvar current-input-method nil
  "The current input method for multilingual text.
352
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
353 354 355 356
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

361 362 363 364 365 366 367
(defcustom default-input-method nil
  "*Default input method for multilingual text.
This is the input method activated automatically by the command
`toggle-input-method' (\\[toggle-input-method]).
Automatically local in all buffers."
  :group 'mule)

368 369
(make-variable-buffer-local 'default-input-method)
(put 'default-input-method 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
370 371

(defvar previous-input-method nil
372
  "Input method selected previously in the current buffer.
Karl Heuer's avatar
Karl Heuer committed
373 374
This is the one selected before the current input method is selected.
See also the documentation of `default-input-method'.")
375 376
(make-variable-buffer-local 'previous-input-method)
(put 'previous-input-method 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390

(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.
This function is called with no argument.")
(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)

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 421 422 423 424 425
(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.
INPUT-METHOD and LANGUAGE-NAME are strings.
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."
  (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)))))

(defun read-input-method-name (prompt &optional initial-input inhibit-null)
  "Read a name of input method from a minibuffer prompting with PROMPT.
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
  If it is (STRING . POSITION), the initial input
  is STRING, but point is placed POSITION characters into the string.
If INHIBIT-NULL is non-nil, null input signals an error."
  (let* ((completion-ignore-case t)
	 (input-method (completing-read prompt input-method-alist
					nil t initial-input)))
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
426
	  (error "No valid input method is specified")))))
427 428 429

;; Actvate INPUT-METHOD.
(defun activate-input-method (input-method)
430
  (if (and current-input-method
431
	   (not (string= current-input-method input-method)))
432
      (inactivate-input-method))
433 434 435 436 437 438 439 440 441 442 443
  (if current-input-method
      nil				; We have nothing to do.
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
	  (error "Invalid input method `%s'" input-method))
      (apply (nth 2 slot) input-method (nthcdr 5 slot))
      (setq current-input-method input-method)
      (setq current-input-method-title (nth 3 slot))
      (if (not (string= default-input-method current-input-method))
	  (setq previous-input-method default-input-method
		default-input-method current-input-method)))))
444 445 446 447 448 449 450

;; Inactivate the current input method.
(defun inactivate-input-method ()
  (if current-input-method
      (unwind-protect
	  (funcall inactivate-current-input-method-function)
	(setq current-input-method nil))))
Karl Heuer's avatar
Karl Heuer committed
451

452 453
(defun select-input-method (input-method)
  "Select and activate INPUT-METHOD.
454 455
This sets both the default and local values of `default-input-method'
to the input method you specify.
456 457 458 459
See also the function `register-input-method'."
  (interactive
   (let* ((default (or previous-input-method default-input-method))
	  (initial (if default (cons default 0))))
460 461
     (if (not enable-multibyte-characters)
	 (error "Can't activate any input method while enable-multibyte-characters is nil"))
462 463 464
     (list (read-input-method-name "Input method: " initial t))))
  (activate-input-method input-method)
  (setq-default default-input-method default-input-method))
Karl Heuer's avatar
Karl Heuer committed
465 466

(defun toggle-input-method (&optional arg)
467
  "Turn on or off a multilingual text input method for the current buffer.
468
With arg, read an input method from minibuffer and turn it on.
469
Without arg, if some input method is currently activated, turn it off,
470
else turn on the default input method (see `default-input-method').
471 472
In the latter case, if default-input-method is nil, select an input method
interactively."
Karl Heuer's avatar
Karl Heuer committed
473
  (interactive "P")
474 475
  (let* ((default (or previous-input-method default-input-method))
	 (initial (if default (cons default 0))))
476 477 478
    (if (and current-input-method (not arg))
	(inactivate-input-method)
      (if (not enable-multibyte-characters)
479
	  (error "Can't activate any input method while multibyte characters are disabled"))
480 481 482 483
      (activate-input-method
       (if (or arg (not default-input-method))
	   (read-input-method-name "Input method: " initial t)  
	 default-input-method)))))
484 485

(defun describe-input-method (input-method)
Karl Heuer's avatar
Karl Heuer committed
486
  "Describe the current input method."
487 488 489 490 491 492 493 494 495 496 497
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
  (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 ()
498
  "Describe the input method currently in use."
Karl Heuer's avatar
Karl Heuer committed
499 500 501 502 503 504 505
  (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))
506
    (error "No input method is activated now")))
Karl Heuer's avatar
Karl Heuer committed
507 508

(defun read-multilingual-string (prompt &optional initial-input
509
					input-method)
Karl Heuer's avatar
Karl Heuer committed
510 511
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
512
If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
513 514 515
initially.
Optional 3rd argument INPUT-METHOD specifies the input method
to be activated instead of the one selected last time."
516 517 518 519 520 521 522 523
  (setq input-method
	(or input-method
	    default-input-method
	    (read-input-method-name "Input method: " nil t)))
  (save-excursion
    (set-buffer (window-buffer (minibuffer-window)))
    (let ((default-input-method input-method)
	  (minibuffer-setup-hook '(toggle-input-method)))
524
      (read-string prompt initial-input))))
Karl Heuer's avatar
Karl Heuer committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

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

(defvar input-method-tersely-flag nil
  "*If this flag is non-nil, input method works rather tersely.

For instance, Quail input method does not show guidance buffer while
inputting at minibuffer if this flag is t.")

(defvar input-method-activate-hook nil
  "Normal hook run just after an input method is activated.")

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

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


545
(defun setup-specified-language-environment ()
546
  "Set up multi-lingual environment convenient for the specified language."
547
  (interactive)
548
  (let (language-name)
549 550 551
    (if (and (symbolp last-command-event)
	     (or (not (eq last-command-event 'Default))
		 (setq last-command-event 'English))
552 553
	     (setq language-name (symbol-name last-command-event)))
	(set-language-environment language-name)
554
      (error "Bogus calling sequence"))))
Karl Heuer's avatar
Karl Heuer committed
555

556 557 558
(defvar current-language-environment "English"
  "The last language environment specified with `set-language-environment'.")

559
(defun set-language-environment (language-name)
560 561 562
  "Set up multi-lingual environment for using LANGUAGE-NAME.
This sets the coding system priority and the default input method
and sometimes other things."
563 564 565 566 567
  (interactive (list (read-language-name 'setup-function
					 "Language (null for default): ")))
  (or language-name
      (setq language-name "English"))
  (if (null (get-language-info language-name 'setup-function))
568 569 570 571
      (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
572 573 574 575 576 577

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

578
;; Print a language specific information such as input methods,
579
;; charsets, and coding systems.  This function is intended to be
580
;; called from the menu:
581
;;   [menu-bar mule describe-language-environment LANGUAGE]
582 583
;; and should not run it by `M-x describe-current-input-method-function'.
(defun describe-specified-language-support ()
584
  "Describe how Emacs supports the specified language environment."
585
  (interactive)
586
  (let (language-name)
587
    (if (not (and (symbolp last-command-event)
588
		  (setq language-name (symbol-name last-command-event))))
589
	(error "Bogus calling sequence"))
590 591 592 593 594
    (describe-language-environment language-name)))

(defun describe-language-environment (language-name)
  "Describe how Emacs supports language environment LANGUAGE-NAME."
  (interactive (list (read-language-name 'documentation "Language: ")))
595 596
  (if (null language-name)
      (setq language-name current-language-environment))
597 598 599 600
  (if (or (null language-name)
	  (null (get-language-info language-name 'documentation)))
      (error "No documentation for the specified language"))
  (let ((doc (get-language-info language-name 'documentation)))
601
    (with-output-to-temp-buffer "*Help*"
602
      (if (stringp doc)
603 604 605
	  (progn
	    (princ-list doc)
	    (terpri)))
606 607 608
      (let ((str (get-language-info language-name 'sample-text)))
	(if (stringp str)
	    (progn
609
	      (princ "Sample text:\n")
610 611
	      (princ-list "  " str)
	      (terpri))))
612
      (princ "Input methods:\n")
613
      (let ((l input-method-alist))
614
	(while l
615 616 617
	  (if (string= language-name (nth 1 (car l)))
	      (princ-list "  " (car (car l))
			  (format " (`%s' in mode line)" (nth 3 (car l)))))
618
	  (setq l (cdr l))))
619 620
      (terpri)
      (princ "Character sets:\n")
621 622 623 624 625 626 627
      (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)))))
628 629
      (terpri)
      (princ "Coding systems:\n")
630 631 632
      (let ((l (get-language-info language-name 'coding-system)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)
633
	  (while l
634 635 636
	    (princ (format "  %s (`%c' in mode line):\n\t%s\n"
			   (car l)
			   (coding-system-mnemonic (car l))
637
			   (coding-system-doc-string (car l))))
638
	    (setq l (cdr l))))))))
Karl Heuer's avatar
Karl Heuer committed
639 640 641 642 643 644

;;; Charset property

(defsubst get-charset-property (charset propname)
  "Return the value of CHARSET's PROPNAME property.
This is the last value stored with
645
 (put-charset-property CHARSET PROPNAME VALUE)."
Karl Heuer's avatar
Karl Heuer committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
  (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
662
`put-char-code-property'.")
Karl Heuer's avatar
Karl Heuer committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681

(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