mule-cmds.el 20.6 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
;;; mule-cmds.el --- Commands for mulitilingual environment

;; Copyright (C) 1995 Free Software Foundation, Inc.
;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.

;; 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 29 30 31 32

;;; Code:

;;; MULE related key bindings and menus.

(defvar mule-keymap (make-sparse-keymap "MULE")
  "Keymap for MULE (Multilingual environment) specific commands.")
(fset 'mule-prefix mule-keymap)

33 34
;; Keep "C-x C-m ..." for mule specific commands.
(define-key ctl-x-map "\C-m" 'mule-prefix)
Karl Heuer's avatar
Karl Heuer committed
35 36 37 38 39 40 41 42 43 44

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

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

(defvar mule-describe-language-support-map
  (make-sparse-keymap "Describe Language Support"))
(fset 'mule-describe-language-support-prefix
      mule-describe-language-support-map)

Kenichi Handa's avatar
Kenichi Handa committed
45 46 47 48 49
(defvar mule-set-language-environment-map
  (make-sparse-keymap "Set Language Environment"))
(fset 'mule-set-language-environment-prefix
      mule-set-language-environment-map)

Karl Heuer's avatar
Karl Heuer committed
50 51 52
(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)
53
(define-key mule-keymap "k" 'encoded-kbd-set-coding-system)
Karl Heuer's avatar
Karl Heuer committed
54 55
(define-key mule-keymap "p" 'set-current-process-coding-system)
(define-key mule-keymap "i" 'select-input-method)
56
(define-key mule-keymap "\C-\\" 'select-input-method)
Karl Heuer's avatar
Karl Heuer committed
57 58 59 60 61 62

(define-key help-map "\C-L" 'describe-language-support)
(define-key help-map "\C-\\" 'describe-input-method)
(define-key help-map "C" 'describe-current-coding-system)
(define-key help-map "h" 'view-hello-file)

Kenichi Handa's avatar
Kenichi Handa committed
63 64 65 66 67 68
(define-key mule-keymap [view-hello-file]
  '("Show many languages" . view-hello-file))
(define-key mule-keymap [mule-diag]
  '("Show diagnosis for MULE" . mule-diag))
(define-key mule-keymap [separator-coding-system]
  '("--"))
Karl Heuer's avatar
Karl Heuer committed
69
(define-key mule-keymap [set-process-coding-system]
Kenichi Handa's avatar
Kenichi Handa committed
70
  '("Set coding system of process" . set-current-process-coding-system))
71 72
(define-key mule-keymap [encoded-kbd-set-coding-system]
  '("Set coding system for Encoded-kbd mode" . encoded-kbd-set-coding-system))
Karl Heuer's avatar
Karl Heuer committed
73
(define-key mule-keymap [set-terminal-coding-system]
Kenichi Handa's avatar
Kenichi Handa committed
74
  '("Set coding system of terminal" . set-terminal-coding-system))
Karl Heuer's avatar
Karl Heuer committed
75
(define-key mule-keymap [set-buffer-file-coding-system]
Kenichi Handa's avatar
Kenichi Handa committed
76
  '("Set coding system of buffer file" . set-buffer-file-coding-system))
Karl Heuer's avatar
Karl Heuer committed
77 78
(define-key mule-keymap [describe-current-coding-system]
  '("Describe current coding systems" . describe-current-coding-system))
Kenichi Handa's avatar
Kenichi Handa committed
79 80
(define-key mule-keymap [separator-input-method]
  '("--"))
Karl Heuer's avatar
Karl Heuer committed
81 82 83 84 85 86
(define-key mule-keymap [describe-input-method]
  '("Describe input method" . describe-input-method))
(define-key mule-keymap [select-input-method]
  '("Select input method" . select-input-method))
(define-key mule-keymap [toggle-input-method]
  '("Toggle input method" . toggle-input-method))
Kenichi Handa's avatar
Kenichi Handa committed
87 88 89 90 91 92
(define-key mule-keymap [separator-mule]
  '("--"))
(define-key mule-keymap [set-language-environment]
  '("Set language environment" . mule-set-language-environment-prefix))
(define-key mule-keymap [describe-language-support]
  '("Describe language support" . mule-describe-language-support-prefix))
Karl Heuer's avatar
Karl Heuer committed
93
(define-key mule-keymap [toggle-mule]
Kenichi Handa's avatar
Kenichi Handa committed
94
  '("Disable/enable multibyte character" . toggle-enable-multibyte-characters))
Karl Heuer's avatar
Karl Heuer committed
95 96

;; These are meaningless when running under X.
97
(put 'encoded-kbd-set-coding-system 'menu-enable
Karl Heuer's avatar
Karl Heuer committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
     '(null window-system))
(put 'set-terminal-coding-system 'menu-enable
     '(null window-system))

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

(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)
122 123 124 125
  ;; We have to decode the file in any environment.
  (let ((default-enable-multibyte-characters t)
	(coding-system-for-read 'iso-2022-7))
    (find-file-read-only (expand-file-name "HELLO" data-directory))))
Karl Heuer's avatar
Karl Heuer committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146


;;; 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."
147 148
  (let ((lang-slot (assoc-ignore-case
		    (downcase language-name) language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
    (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:
charset: list of symbols whose values are charsets specific to the language.
coding-system: list of coding systems specific to the langauge.
tutorial: a tutorial file name written in the language.
sample-text: one line short text containing characters of the language.
input-method: alist of input method names for the language vs information
  for activating them.  Use `register-input-method' (which see)
  to add a new input method to the alist.
166 167 168 169 170 171 172 173 174
documentation: a string describing how Emacs supports the langauge.
describe-function: a function to call for descriebing how Emacs supports
 the language.  The function uses information listed abobe.
setup-function: a function to call for setting up environment
 convenient for the language.

Emacs will use more KEYs in the future.  To avoid conflict, users
should use prefix \"user-\" in the name of KEY if he wants to set
different kind of information."
Karl Heuer's avatar
Karl Heuer committed
175 176 177 178 179 180 181 182 183 184 185 186
  (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)))))
    (setcdr key-slot info)
    ;; Setup menu.
187 188
    (cond ((eq key 'describe-function)
	   (define-key-after mule-describe-language-support-map
Kenichi Handa's avatar
Kenichi Handa committed
189
	     (vector (intern language-name))
190 191
	     (cons language-name info)
	     t))
Kenichi Handa's avatar
Kenichi Handa committed
192
	  ((eq key 'setup-function)
193
	   (define-key-after mule-set-language-environment-map
Kenichi Handa's avatar
Kenichi Handa committed
194
	     (vector (intern language-name))
195 196
	     (cons language-name info)
	     t)))
Karl Heuer's avatar
Karl Heuer committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    ))

(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)))
215 216 217
    (if (and (> (length name) 0)
	     (get-language-info name key))
	name)))
Karl Heuer's avatar
Karl Heuer committed
218 219 220 221 222 223 224 225 226 227 228 229

;;; Multilingual input methods.

(defvar current-input-method nil
  "The current input method for multilingual text.
The value is a cons of language name and input method name.
If nil, it means no input method is activated now.")
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

(defvar current-input-method-title nil
  "Title string of the current input method shown in mode line.
230
Every input method should set this to an appropriate value when activated.")
Karl Heuer's avatar
Karl Heuer committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
(make-variable-buffer-local 'current-input-method-title)
(put 'current-input-method-title 'permanent-local t)

(defvar default-input-method nil
  "Default input method.
The default input method is the one activated automatically by the command
`toggle-input-method' (\\[toggle-input-method]).
The value is a cons of language name and input method name.")

(defvar default-input-method-title nil
  "Title string of the default input method.")

(defvar previous-input-method nil
  "Input method selected previously.
This is the one selected before the current input method is selected.
See also the documentation of `default-input-method'.")

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

(defun register-input-method (language-name input-method)
  "Register INPUT-METHOD as an input method of LANGUAGE-NAME.
LANGUAGE-NAME is a string.
INPUT-METHOD is a list of the form:
	(METHOD-NAME ACTIVATE-FUNC ARG ...)
where METHOD-NAME is the name of this method,
ACTIVATE-FUNC is the function to call for activating this method.
Arguments for the function are METHOD-NAME and ARGs."
  (let ((slot (get-language-info language-name 'input-method))
	method-slot)
    (if (null slot)
	(set-language-info language-name 'input-method (list input-method))
      (setq method-slot (assoc (car input-method) slot))
      (if method-slot
	  (setcdr method-slot (cdr input-method))
	(set-language-info language-name 'input-method
			   (cons input-method slot))))))

(defun read-language-and-input-method-name ()
  "Read a language names and the corresponding input method from a minibuffer.
Return a cons of those names."
  (let ((language-name (read-language-name
			'input-method
			"Language: "
			(if previous-input-method
			    (cons (car previous-input-method) 0)))))
    (if (null language-name)
	(error "No input method for the specified language"))
    (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
290 291
	   (key-slot (cdr (assq 'input-method
				(assoc language-name language-info-alist))))
Karl Heuer's avatar
Karl Heuer committed
292
	   (method-name
Kenichi Handa's avatar
Kenichi Handa committed
293
	    (completing-read "Input method: " key-slot nil t
Karl Heuer's avatar
Karl Heuer committed
294 295 296 297 298 299
			     (if (and previous-input-method
				      (string= language-name
					       (car previous-input-method)))
				 (cons (cdr previous-input-method) 0)))))
      (if (= (length method-name) 0)
	  (error "No input method specified"))
Kenichi Handa's avatar
Kenichi Handa committed
300 301
      (list language-name
	    (car (assoc-ignore-case (downcase method-name) key-slot))))))
Karl Heuer's avatar
Karl Heuer committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329

(defun set-default-input-method (language-name method-name)
  "Set the default input method to METHOD-NAME for inputting LANGUAGE-NAME.
The default input method is the one activated automatically by the command
`toggle-input-method' (\\[toggle-input-method]).
This doesn't affect the currently activated input method."
  (interactive (read-language-and-input-method-name))
  (let* ((key-slot (get-language-info language-name 'input-method))
	 (method-slot (assoc method-name key-slot)))
    (if (null method-slot)
	(error "No input method `%s' for %s" method-name language-name))
    (setq default-input-method (cons language-name method-name))))

(defun select-input-method (language-name method-name)
  "Select and activate input method METHOD-NAME for inputting LANGUAGE-NAME.
The information for activating METHOD-NAME is stored
in `language-info-alist' under the key 'input-method.
The format of the information has the form:
	((METHOD-NAME ACTIVATE-FUNC ARG ...) ...)
where ACTIVATE-FUNC is a function to call for activating this method.
Arguments for the function are METHOD-NAME and ARGs."
  (interactive (read-language-and-input-method-name))
  (let* ((key-slot (get-language-info language-name 'input-method))
	 (method-slot (assoc method-name key-slot)))
    (if (null method-slot)
	(error "No input method `%s' for %s" method-name language-name))
    (if current-input-method
	(progn
330 331 332 333
	  (setq previous-input-method current-input-method)
	  (unwind-protect
	      (funcall inactivate-current-input-method-function)
	    (setq current-input-method nil))))
Karl Heuer's avatar
Karl Heuer committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    (setq method-slot (cdr method-slot))
    (apply (car method-slot) method-name (cdr method-slot))
    (setq default-input-method
	  (setq current-input-method (cons language-name method-name)))
    (setq default-input-method-title current-input-method-title)
    (setq current-input-method default-input-method)))

(defun toggle-input-method (&optional arg)
  "Toggle whether a multilingual input method is activated in this buffer.
With arg, activate an input method specified interactively.
Without arg, the method being activated is the one selected most recently,
 but if no input method has ever been selected, select one interactively."
  (interactive "P")
  (if arg
      (call-interactively 'select-input-method)
    (if (null current-input-method)
	(if default-input-method
	    (select-input-method (car default-input-method)
				 (cdr default-input-method))
	  (call-interactively 'select-input-method))
      (funcall inactivate-current-input-method-function)
      (setq current-input-method nil))))

(defun describe-input-method ()
  "Describe the current input method."
  (interactive)
  (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))
    (message "No input method is activated now")
    (ding)))

(defun read-multilingual-string (prompt &optional initial-input
					language-name method-name)
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
Optional 3rd and 4th arguments LANGUAGE-NAME and METHOD-NAME specify
 the input method to be activated instead of the one selected last time."
  (let ((minibuffer-setup-hook '(toggle-input-method))
	(default-input-method default-input-method))
    (if (and language-name method-name)
	(set-default-input-method language-name method-name))
    (read-string prompt initial-input)))

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


;;; Language specific setup functions.
(defun set-language-environment (language-name)
404
  "Setup multilingual environment convenient for LANGUAGE-NAME.
Karl Heuer's avatar
Karl Heuer committed
405

406
For that, a fucntion returned by:
Karl Heuer's avatar
Karl Heuer committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
  (get-language-info LANGUAGE-NAME 'setup-function)
is called."
  (interactive (list (read-language-name 'setup-function "Language: ")))
  (let (func)
    (if (or (null language-name)
	    (null (setq func
			(get-language-info language-name 'setup-function))))
	(error "No way to setup environment for the specified language"))
    (funcall func)))

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

(defun describe-language-support (language-name)
423 424 425 426 427
  "Describe how Emacs supports LANGUAGE-NAME.

For that, a function returned by:
  (get-language-info LANGUAGE-NAME 'describe-function)
is called."
Karl Heuer's avatar
Karl Heuer committed
428
  (interactive (list (read-language-name 'documentation "Language: ")))
429
  (let (func)
Karl Heuer's avatar
Karl Heuer committed
430
    (if (or (null language-name)
431 432
	    (null (setq func
			(get-language-info language-name 'describe-function))))
Karl Heuer's avatar
Karl Heuer committed
433
	(error "No documentation for the specified language"))
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    (funcall func)))

;; Print LANGUAGE-NAME specific information such as input methods,
;; charsets, and coding systems.  This function is intended to be
;; called from various describe-LANGUAGE-support functions defined in
;; lisp/language/LANGUAGE.el.
(defun describe-language-support-internal (language-name)
  (with-output-to-temp-buffer "*Help*"
    (let ((doc (get-language-info language-name 'documentation)))
      (if (stringp doc)
	  (princ-list doc)))
    (princ "-----------------------------------------------------------\n")
    (princ-list "List of items specific to "
		language-name
		" support")
    (princ "-----------------------------------------------------------\n")
    (let ((str (get-language-info language-name 'sample-text)))
      (if (stringp str)
	  (progn
	    (princ "<sample text>\n")
	    (princ-list "  " str))))
    (princ "<input methods>\n")
    (let ((l (get-language-info language-name 'input-method)))
      (while l
	(princ-list "  " (car (car l)))
	(setq l (cdr l))))
    (princ "<character sets>\n")
    (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)))))
    (princ "<coding systems>\n")
    (let ((l (get-language-info language-name 'coding-system)))
      (if (null l)
	  (princ-list "  nothing specific to " language-name)
	(while l
	  (princ-list "  " (car l) ":\n\t"
		      (coding-system-docstring (car l)))
	  (setq l (cdr l)))))))
Karl Heuer's avatar
Karl Heuer committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518

;;; Charset property

(defsubst get-charset-property (charset propname)
  "Return the value of CHARSET's PROPNAME property.
This is the last value stored with
`(put-charset-property CHARSET PROPNAME VALUE)'."
  (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
`put-char-code-property'")

(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