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

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

;; Keywords: mule, multilingual

;; This file is part of GNU Emacs.

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

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

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

;;; Code:

;;; MULE related key bindings and menus.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Karl Heuer's avatar
Karl Heuer committed
147
(defun toggle-enable-multibyte-characters (&optional arg)
148 149 150 151 152 153 154 155 156 157 158
  "Change whether this buffer uses multibyte characters.
With arg, use multibyte characters if the arg is positive.

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

We suggest you avoid using use this command unless you know what you
are doing.  If you use it by mistake, and the buffer is now displayed
wrong, use this command again to toggle back to the right mode."
Karl Heuer's avatar
Karl Heuer committed
159
  (interactive "P")
160 161 162 163
  (let ((new-flag
	 (if (null arg) (null enable-multibyte-characters)
	   (> (prefix-numeric-value arg) 0))))
    (set-buffer-multibyte new-flag))
Karl Heuer's avatar
Karl Heuer committed
164 165 166 167 168
  (force-mode-line-update))

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

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

186
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
187
  "Set default value of various coding systems to CODING-SYSTEM.
188
This sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
189
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
190 191
  o default coding system for subprocess I/O
This also sets the following values:
192
  o default value used as file-name-coding-system for converting file names.
Kenichi Handa's avatar
Kenichi Handa committed
193 194
  o default value for the command `set-terminal-coding-system'
  o default value for the command `set-keyboard-coding-system'"
195 196
  (check-coding-system coding-system)
  (setq-default buffer-file-coding-system coding-system)
197
  (setq default-file-name-coding-system coding-system)
198 199 200 201
  (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
202 203
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
204
This also sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
205
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
206 207
  o default coding system for subprocess I/O
This also sets the following values:
208
  o default value used as file-name-coding-system for converting file names.
Kenichi Handa's avatar
Kenichi Handa committed
209 210
  o default value for the command `set-terminal-coding-system'
  o default value for the command `set-keyboard-coding-system'"
Kenichi Handa's avatar
Kenichi Handa committed
211 212 213 214
  (interactive "zPrefer coding system: ")
  (if (not (and coding-system (coding-system-p coding-system)))
      (error "Invalid coding system `%s'" coding-system))
  (let ((coding-category (coding-system-category coding-system))
Kenichi Handa's avatar
Kenichi Handa committed
215
	(base (coding-system-base coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
216 217 218
    (if (not coding-category)
	;; CODING-SYSTEM is no-conversion or undecided.
	(error "Can't prefer the coding system `%s'" coding-system))
Kenichi Handa's avatar
Kenichi Handa committed
219
    (set coding-category (or base coding-system))
220
    (update-iso-coding-systems)
Kenichi Handa's avatar
Kenichi Handa committed
221 222 223 224 225
    (if (not (eq coding-category (car coding-category-list)))
	;; We must change the order.
	(setq coding-category-list
	      (cons coding-category
		    (delq coding-category coding-category-list))))
Kenichi Handa's avatar
Kenichi Handa committed
226 227 228 229
    (if (and base (interactive-p))
	(message "Highest priority is set to %s (base of %s)"
		 base coding-system))
    (set-default-coding-systems (or base coding-system))))
Kenichi Handa's avatar
Kenichi Handa committed
230

231
(defun find-safe-coding-system-list-subset-p (list1 list2)
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
  "Return non-nil if all elements in LIST1 are included in LIST2.
Comparison done with EQ."
  (catch 'tag
    (while list1
      (or (memq (car list1) list2)
	  (throw 'tag nil))
      (setq list1 (cdr list1)))
    t))

(defun find-safe-coding-system (from to)
  "Return a list of proper coding systems to encode a text between FROM and TO.
All coding systems in the list can safely encode any multibyte characters
in the text.

If the text contains no multibyte charcters, return a list of a single
element `undecided'.

Kludgy feature: if FROM is a string, the string is the target text,
and TO is ignored."
  (let ((charset-list (if (stringp from) (find-charset-string from)
			(find-charset-region from to))))
253 254 255
    (if (or (null charset-list)
	    (and (= (length charset-list) 1)
		 (eq 'ascii (car charset-list))))
256 257 258 259 260 261 262 263 264 265 266 267 268
	'(undecided)
      (let ((l coding-system-list)
	    (prefered-codings
	     (mapcar (function
		      (lambda (x)
			(get-charset-property x 'prefered-coding-system)))
		     charset-list))
	    codings coding safe)
	(while l
	  (setq coding (car l) l (cdr l))
	  (if (and (eq coding (coding-system-base coding))
		   (setq safe (coding-system-get coding 'safe-charsets))
		   (or (eq safe t)
269 270
		       (find-safe-coding-system-list-subset-p
			charset-list safe)))
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
	      ;; We put the higher priority to coding systems included
	      ;; in PREFERED-CODINGS, and within them, put the higher
	      ;; priority to coding systems which support smaller
	      ;; number of charsets.
	      (let ((priority
		     (logior (if (coding-system-get coding 'mime-charset)
				 256 0)
			     (if (memq coding prefered-codings) 128 0)
			     (if (> (coding-system-type coding) 0) 64 0)
			     (if (consp safe) (- 64 (length safe)) 0))))
		(setq codings (cons (cons priority coding) codings)))))
	(mapcar 'cdr
		(sort codings (function (lambda (x y) (> (car x) (car y))))))
	))))

(defun select-safe-coding-system (from to &optional default-coding-system)
287 288 289
  "Ask a user to select a safe coding system from candidates.
The candidates of coding systems which can safely encode a text
between FROM and TO are shown in a popup window.
290 291 292 293 294

Optional arg DEFAULT-CODING-SYSTEM specifies a coding system to be
checked at first.  If omitted, buffer-file-coding-system of the
current buffer is used.

295 296
If the text can be encoded safely by DEFAULT-CODING-SYSTEM, it is
returned without any user interaction.
297 298 299 300 301 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 330 331 332 333

Kludgy feature: if FROM is a string, the string is the target text,
and TO is ignored."
  (or default-coding-system
      (setq default-coding-system buffer-file-coding-system))
  (let ((safe-coding-systems (find-safe-coding-system from to)))
    (if (or (eq (car safe-coding-systems) 'undecided)
	    (and default-coding-system
		 (memq (coding-system-base default-coding-system)
		       safe-coding-systems)))
	default-coding-system

      ;; Ask a user to select a proper coding system.
      (save-window-excursion
	;; At first, show a helpful message.
	(with-output-to-temp-buffer "*Warning*"
	  (save-excursion
	    (set-buffer standard-output)
	    (insert (format "\
The target text contains a multibyte character which can't be
encoded safely by the coding system %s.

Please select one from the following safe coding systems:\n"
			    default-coding-system))
	    (let ((pos (point))
		  (fill-prefix "  "))
	      (mapcar (function (lambda (x) (princ "  ") (princ x)))
		      safe-coding-systems)
	      (fill-region-as-paragraph pos (point)))))

	;; Read a coding system.
	(let* ((safe-names (mapcar (lambda (x) (list (symbol-name x)))
				   safe-coding-systems))
	       (name (completing-read
		      (format "Select coding system (default %s): "
			      (car safe-coding-systems))
		      safe-names nil t nil nil (car (car safe-names)))))
334
	  (kill-buffer "*Warning*")
335 336 337 338
	  (intern name))))))

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

Karl Heuer's avatar
Karl Heuer committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

;;; 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."
354 355
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
356
  (let ((lang-slot (assoc-ignore-case language-name language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
357 358 359
    (if lang-slot
	(cdr (assq key (cdr lang-slot))))))

360 361
(defun set-language-info (language-name key info
					&optional describe-map setup-map)
Karl Heuer's avatar
Karl Heuer committed
362 363
  "Set for LANGUAGE-NAME the information INFO under KEY.
KEY is a symbol denoting the kind of information.
364 365
INFO is any Lisp object which contains the actual information specific
  to LANGUAGE-NAME.
Karl Heuer's avatar
Karl Heuer committed
366 367

Currently, the following KEYs are used by Emacs:
368

369 370 371
charset: list of charsets.

coding-system: list of coding systems.
372

373
coding-priority: list of coding systems ordered by priority.
374

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

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

379
documentation: t or a string describing how Emacs supports the language.
380 381
  If a string is specified, it is shown before any other information
  of the language by the command `describe-language-environment'.
382

383
setup-function: a function to call for setting up environment
384
  convenient for a user of the language.
385

386
We will define more KEYs in the future.  To avoid conflict,
387 388 389 390 391
if you want to use your own KEY values, make them start with `user-'.

Optional 4th and 5th args DESCRIBE-MAP and SETUP-MAP are keymaps to
register LANGUAGE-NAME in the menu of `Mule'->`Describe Language
Environment' and `Mule'->`Setup Language Environment' respectively."
392 393
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
394 395 396 397 398 399 400 401 402 403 404
  (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.
405
    (cond ((eq key 'documentation)
406 407
	   (define-key-after describe-map (vector (intern language-name))
	     (cons language-name 'describe-specified-language-support) t))
Kenichi Handa's avatar
Kenichi Handa committed
408
	  ((eq key 'setup-function)
409 410
	   (define-key-after setup-map (vector (intern language-name))
	     (cons language-name 'setup-specified-language-environment) t)))
411 412

    (setcdr key-slot info)
Karl Heuer's avatar
Karl Heuer committed
413 414
    ))

415
(defun set-language-info-alist (language-name alist &optional parents)
Karl Heuer's avatar
Karl Heuer committed
416 417
  "Set for LANGUAGE-NAME the information in ALIST.
ALIST is an alist of KEY and INFO.  See the documentation of
418 419 420 421 422
`set-langauge-info' for the meanings of KEY and INFO.

Optional arg PARENTS is a list of parent language environments ordered
from the highest to the lower.  If it is nil, we make LANGUAGE-NAME
the top level language environment."
423 424
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
  (let ((describe-map describe-language-environment-map)
	(setup-map setup-language-environment-map))
    (if parents
	(let ((l parents)
	      map parent-symbol parent)
	  (while l
	    (if (symbolp (setq parent-symbol (car l)))
		(setq parent (symbol-name parent))
	      (setq parent parent-symbol parent-symbol (intern parent)))
	    (setq map (lookup-key describe-map (vector parent-symbol)))
	    (if (not map)
		(progn
		  (setq map (intern (format "describe-%s-environment-map"
					    (downcase parent))))
		  (define-prefix-command map)
		  (define-key-after describe-map (vector parent-symbol)
		    (cons parent map) t)))
	    (setq describe-map (symbol-value map))
	    (setq map (lookup-key setup-map (vector parent-symbol)))
	    (if (not map)
		(progn
		  (setq map (intern (format "setup-%s-environment-map"
					    (downcase parent))))
		  (define-prefix-command map)
		  (define-key-after setup-map (vector parent-symbol)
		    (cons parent map) t)))
	    (setq setup-map (symbol-value map))
	    (setq l (cdr l)))))
    (while alist
      (set-language-info language-name (car (car alist)) (cdr (car alist))
			 describe-map setup-map)
      (setq alist (cdr alist)))))
Karl Heuer's avatar
Karl Heuer committed
457

458
(defun read-language-name (key prompt &optional default)
459
  "Read language name which has information for KEY, prompting with PROMPT.
460
DEFAULT is the default choice of language.
461
This returns a language name as a string."
Karl Heuer's avatar
Karl Heuer committed
462 463 464 465
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
				(function (lambda (elm) (assq key elm)))
466
				t nil nil default)))
467 468 469
    (if (and (> (length name) 0)
	     (get-language-info name key))
	name)))
Karl Heuer's avatar
Karl Heuer committed
470 471 472

;;; Multilingual input methods.

473 474 475 476 477 478 479 480 481 482 483 484 485
(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
486
;; Each entry has the form:
487 488 489 490 491 492 493 494 495 496 497 498 499
;;   (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.")

500
(defvar leim-list-entry-regexp "^(register-input-method"
501 502 503 504 505 506 507 508
  "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.")

509 510
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
511 512
  (let ((functions update-leim-list-functions))
    (while functions
513
      (apply (car functions) dirs)
514 515
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
516 517
(defvar current-input-method nil
  "The current input method for multilingual text.
518
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
519 520 521 522
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

527
(defcustom default-input-method nil
528
  "*Default input method for multilingual text (a string).
529
This is the input method activated automatically by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
530
`toggle-input-method' (\\[toggle-input-method])."
531 532
  :group 'mule
  :type 'string)
533

Kenichi Handa's avatar
Kenichi Handa committed
534 535 536 537
(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
538 539 540 541

(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.
542 543 544 545
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
546 547 548 549 550 551 552 553 554
(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)

555 556 557 558 559 560 561 562
(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.
563
INPUT-METHOD and LANGUAGE-NAME are symbols or strings.
564 565 566 567 568 569 570
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."
571 572 573 574
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
575 576 577 578 579 580 581
  (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)))))

582
(defun read-input-method-name (prompt &optional default inhibit-null)
583
  "Read a name of input method from a minibuffer prompting with PROMPT.
584 585
If DEFAULT is non-nil, use that as the default,
  and substitute it into PROMPT at the first `%s'.
586 587 588
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
589 590
  (if default
      (setq prompt (format prompt default)))
591
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
592 593
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
594
	 (input-method (completing-read prompt input-method-alist
595 596
					nil t nil 'input-method-history
					default)))
597 598 599
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
600
	  (error "No valid input method is specified")))))
601 602

(defun activate-input-method (input-method)
603 604
  "Turn INPUT-METHOD on.
If some input method is already on, turn it off at first."
605 606
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
Kenichi Handa's avatar
Kenichi Handa committed
607 608
  (if (and current-input-method
	   (not (string= current-input-method input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
609 610
    (inactivate-input-method))
  (unless current-input-method
611 612
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
Kenichi Handa's avatar
Kenichi Handa committed
613
	  (error "Can't activate input method `%s'" input-method))
Kenichi Handa's avatar
Kenichi Handa committed
614 615 616 617 618 619 620 621
      (let ((func (nth 2 slot)))
	(if (functionp func)
	    (apply (nth 2 slot) input-method (nthcdr 5 slot))
	  (if (and (consp func) (symbolp (car func)) (symbolp (cdr func)))
	      (progn
		(require (cdr func))
		(apply (car func) input-method (nthcdr 5 slot)))
	    (error "Can't activate input method `%s'" input-method))))
622
      (setq current-input-method input-method)
Kenichi Handa's avatar
Kenichi Handa committed
623 624
      (setq current-input-method-title (nth 3 slot))
      (run-hooks 'input-method-activate-hook))))
625 626

(defun inactivate-input-method ()
627
  "Turn off the current input method."
Kenichi Handa's avatar
Kenichi Handa committed
628 629 630 631 632 633 634 635 636
  (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)
637
      (unwind-protect
Kenichi Handa's avatar
Kenichi Handa committed
638 639 640
	  (run-hooks 'input-method-inactivate-hook)
	(setq current-input-method nil
	      current-input-method-title nil)))))
Karl Heuer's avatar
Karl Heuer committed
641

642
(defun set-input-method (input-method)
Kenichi Handa's avatar
Kenichi Handa committed
643 644 645
  "Select and turn on INPUT-METHOD.
This sets the default input method to what you specify,
and turn it on for the current buffer."
646
  (interactive
Kenichi Handa's avatar
Kenichi Handa committed
647
   (let* ((default (or (car input-method-history) default-input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
648
     (list (read-input-method-name
649
	    (if default "Select input method (default %s): " "Select input method: ")
Richard M. Stallman's avatar
Richard M. Stallman committed
650
	    default t))))
651
  (activate-input-method input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
652
  (setq default-input-method input-method))
Karl Heuer's avatar
Karl Heuer committed
653 654

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

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

659
Without arg, if some input method is currently activated, turn it off,
Kenichi Handa's avatar
Kenichi Handa committed
660 661 662 663
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
664
  (interactive "P")
Kenichi Handa's avatar
Kenichi Handa committed
665
  (let* ((default (or (car input-method-history) default-input-method)))
666 667
    (if (and current-input-method (not arg))
	(inactivate-input-method)
Kenichi Handa's avatar
Kenichi Handa committed
668 669 670 671 672 673 674 675
      (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)))))
676 677

(defun describe-input-method (input-method)
678
  "Describe  input method INPUT-METHOD."
679 680 681
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
682
  (if (and input-method (symbolp input-method))
683
      (setq input-method (symbol-name input-method)))
684 685 686 687 688 689 690 691
  (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 ()
692
  "Describe the input method currently in use."
Karl Heuer's avatar
Karl Heuer committed
693 694 695 696 697 698 699
  (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))
700
    (error "No input method is activated now")))
Karl Heuer's avatar
Karl Heuer committed
701

702
(defun read-multilingual-string (prompt &optional initial-input input-method)
Karl Heuer's avatar
Karl Heuer committed
703 704
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
705
If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
706 707
initially.
Optional 3rd argument INPUT-METHOD specifies the input method
708 709
to be activated instead of the one selected last time.  It is a symbol
or a string."
710 711
  (setq input-method
	(or input-method
712
	    current-input-method
713 714
	    default-input-method
	    (read-input-method-name "Input method: " nil t)))
715
  (if (and input-method (symbolp input-method))
716
      (setq input-method (symbol-name input-method)))
717 718 719 720 721 722 723 724
  (let ((previous-input-method current-input-method))
    (unwind-protect
	(progn
	  (activate-input-method input-method)
	  (read-string prompt initial-input nil nil t))
      (if previous-input-method
	  (activate-input-method previous-input-method)
	(inactivate-input-method)))))
Karl Heuer's avatar
Karl Heuer committed
725 726 727 728

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
737 738 739 740 741 742 743 744 745 746 747 748
If the value is t, extra guidance is always given, if the value is
nil, extra guidance is always suppressed.

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

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

See also the variable `input-method-highlight-flag'."
  :type '(choice (const t) (const nil) (const complex-only) (const default))
Richard M. Stallman's avatar
Richard M. Stallman committed
749 750 751 752 753 754
  :group 'mule)

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

(defvar input-method-activate-hook nil
761 762 763 764
  "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
765 766

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

The variable `current-input-method' still keeps the input method name
Karl Heuer's avatar
Karl Heuer committed
770
just inactivated.")
Karl Heuer's avatar
Karl Heuer committed
771 772 773 774

(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
775 776 777 778 779 780 781 782
(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
783

Kenichi Handa's avatar
Kenichi Handa committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
(defvar set-language-environment-hook nil
  "Normal hook run after some language environment is set.

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

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

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

800
(defun setup-specified-language-environment ()
801
  "Set up multi-lingual environment convenient for the specified language."
802
  (interactive)
803
  (let (language-name)
804 805 806
    (if (and (symbolp last-command-event)
	     (or (not (eq last-command-event 'Default))
		 (setq last-command-event 'English))
807 808
	     (setq language-name (symbol-name last-command-event)))
	(set-language-environment language-name)
809
      (error "Bogus calling sequence"))))
Karl Heuer's avatar
Karl Heuer committed
810

811 812 813 814 815 816
(defcustom current-language-environment "English"
  "The last language environment specified with `set-language-environment'."
  :set 'set-language-environment
  :initialize 'custom-initialize-default
  :group 'mule
  :type 'string)
817

818
(defun set-language-environment (language-name)
819 820
  "Set up multi-lingual environment for using LANGUAGE-NAME.
This sets the coding system priority and the default input method
821 822 823
and sometimes other things.  LANGUAGE-NAME should be a string
which is the name of a language environment.  For example, \"Latin-1\"
specifies the character set for the major languages of Western Europe."
Kenichi Handa's avatar
Kenichi Handa committed
824 825 826
  (interactive (list (read-language-name
		      'setup-function
		      "Set language environment (default, English): ")))
827 828 829 830
  (if language-name
      (if (symbolp language-name)
	  (setq language-name (symbol-name language-name)))
    (setq language-name "English"))
831
  (if (null (get-language-info language-name 'setup-function))
832
      (error "Language environment not defined: %S" language-name))
Kenichi Handa's avatar
Kenichi Handa committed
833 834 835
  (if current-language-environment
      (let ((func (get-language-info current-language-environment
				     'exit-function)))
836 837
	(run-hooks 'exit-language-environment-hook)
	(if (fboundp func) (funcall func))))
838
  (setq current-language-environment language-name)
Kenichi Handa's avatar
Kenichi Handa committed
839 840
  (funcall (get-language-info language-name 'setup-function))
  (run-hooks 'set-language-environment-hook)
841
  (force-mode-line-update t))
Karl Heuer's avatar
Karl Heuer committed
842

843 844 845 846 847 848 849 850 851 852 853 854 855
(defun set-language-environment-coding-systems (language-name)
  "Do various coding system setups for language environment LANGUAGE-NAME."
  (let* ((priority (get-language-info language-name 'coding-priority))
	 (default-coding (car priority)))
    (if priority
	(let ((categories (mapcar 'coding-system-category priority)))
	  (set-default-coding-systems default-coding)
	  (set-coding-priority categories)
	  (while priority
	    (set (car categories) (car priority))
	    (setq priority (cdr priority) categories (cdr categories)))
	  (update-iso-coding-systems)))))

Karl Heuer's avatar
Karl Heuer committed
856 857 858 859 860
;; Print all arguments with `princ', then print "\n".
(defsubst princ-list (&rest args)
  (while args (princ (car args)) (setq args (cdr args)))
  (princ "\n"))

861
;; Print a language specific information such as input methods,
862
;; charsets, and coding systems.  This function is intended to be
863
;; called from the menu:
864
;;   [menu-bar mule describe-language-environment LANGUAGE]
865 866
;; and should not run it by `M-x describe-current-input-method-function'.
(defun describe-specified-language-support ()
867
  "Describe how Emacs supports the specified language environment."
868
  (interactive)
869
  (let (language-name)
870
    (if (not (and (symbolp last-command-event)
871
		  (setq language-name (symbol-name last-command-event))))
872
	(error "Bogus calling sequence"))
873 874 875 876
    (describe-language-environment language-name)))

(defun describe-language-environment (language-name)
  "Describe how Emacs supports language environment LANGUAGE-NAME."
877 878 879
  (interactive
   (list (read-language-name
	  'documentation
880
	  "Describe language environment (default, current choice): ")))
881 882
  (if (null language-name)
      (setq language-name current-language-environment))
883 884 885
  (if (or (null language-name)
	  (null (get-language-info language-name 'documentation)))
      (error "No documentation for the specified language"))
886 887
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
888
  (let ((doc (get-language-info language-name 'documentation)))
889
    (with-output-to-temp-buffer "*Help*"
890
      (if (stringp doc)
891 892 893
	  (progn
	    (princ-list doc)
	    (terpri)))
894 895 896
      (let ((str (get-language-info language-name 'sample-text)))
	(if (stringp str)
	    (progn
897
	      (princ "Sample text:\n")
898 899
	      (princ-list "  " str)
	      (terpri))))
900
      (princ "Input methods:\n")
901
      (let ((l input-method-alist))
902
	(while l
903 904 905
	  (if (string= language-name (nth 1 (car l)))
	      (princ-list "  " (car (car l))
			  (format " (`%s' in mode line)" (nth 3 (car l)))))
906
	  (setq l (cdr l))))
907 908
      (terpri)
      (princ "Character sets:\n")
909 910 911 912 913 914 915
      (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)))))
916 917
      (terpri)
      (princ "Coding systems:\n")
918 919 920
      (let ((l (get-language-info language-name 'coding-system)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)
921
	  (while l
922 923 924
	    (princ (format "  %s (`%c' in mode line):\n\t%s\n"
			   (car l)
			   (coding-system-mnemonic (car l))
925
			   (coding-system-doc-string (car l))))
Kenichi Handa's avatar
Kenichi Handa committed
926 927 928 929 930
	    (let ((aliases (coding-system-get (car l) 'alias-coding-systems)))
	      (when aliases
		(princ "\t")
		(princ (cons 'alias: (cdr aliases)))
		(terpri)))
931
	    (setq l (cdr l))))))))
Karl Heuer's avatar
Karl Heuer committed
932 933 934 935 936 937

;;; Charset property

(defsubst get-charset-property (charset propname)
  "Return the value of CHARSET's PROPNAME property.
This is the last value stored with
938
 (put-charset-property CHARSET PROPNAME VALUE)."
Karl Heuer's avatar
Karl Heuer committed
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
  (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
955
`put-char-code-property'.")
Karl Heuer's avatar
Karl Heuer committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974

(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