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

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
  "Keymap for MULE (Multilingual environment) menu specific commands.")

53 54 55
(define-key global-map [menu-bar mule]
  `(menu-item "Mule" ,mule-menu-keymap
	      :visible default-enable-multibyte-characters))
56 57 58

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

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

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

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

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

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

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

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

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

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

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

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

176 177 178
(defun universal-coding-system-argument ()
  "Execute an I/O command using the specified coding system."
  (interactive)
179 180 181 182 183 184 185 186 187
  (let* ((default (and buffer-file-coding-system
		       (not (eq (coding-system-type buffer-file-coding-system)
				t))
		       buffer-file-coding-system))
	 (coding-system (read-coding-system
			 (if default
			     (format "Coding system for following command (default, %s): " default)
			   "Coding system for following command: ")
			 default))
188
	 (keyseq (read-key-sequence
189
		  (format "Command to execute with %s:" coding-system)))
190 191 192 193 194 195
	 (cmd (key-binding keyseq)))
    (let ((coding-system-for-read coding-system)
	  (coding-system-for-write coding-system))
      (message "")
      (call-interactively cmd))))

196
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
197
  "Set default value of various coding systems to CODING-SYSTEM.
198
This sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
199
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
200 201
  o default coding system for subprocess I/O
This also sets the following values:
202
  o default value used as file-name-coding-system for converting file names.
Kenichi Handa's avatar
Kenichi Handa committed
203 204
  o default value for the command `set-terminal-coding-system'
  o default value for the command `set-keyboard-coding-system'"
205 206
  (check-coding-system coding-system)
  (setq-default buffer-file-coding-system coding-system)
207
  (setq default-file-name-coding-system coding-system)
208 209 210 211
  (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
212 213
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
214
This also sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
215
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
216 217
  o default coding system for subprocess I/O
This also sets the following values:
218
  o default value used as file-name-coding-system for converting file names.
Kenichi Handa's avatar
Kenichi Handa committed
219 220
  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
221 222 223 224
  (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
225
	(base (coding-system-base coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
226 227 228
    (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
229
    (set coding-category (or base coding-system))
230
    (update-iso-coding-systems)
Kenichi Handa's avatar
Kenichi Handa committed
231 232 233 234 235
    (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
236 237 238 239
    (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
240

Kenichi Handa's avatar
Kenichi Handa committed
241
(defun subset-p (list1 list2)
242 243 244 245 246 247 248 249 250
  "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))

Kenichi Handa's avatar
Kenichi Handa committed
251
(defun find-coding-systems-region (from to)
252 253 254 255 256
  "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
Kenichi Handa's avatar
Kenichi Handa committed
257 258
element `undecided'."
  (find-coding-systems-for-charsets (find-charset-region from to)))
259

Kenichi Handa's avatar
Kenichi Handa committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
(defun find-coding-systems-string (string)
  "Return a list of proper coding systems to encode STRING.
All coding systems in the list can safely encode any multibyte characters
in STRING.

If STRING contains no multibyte charcters, return a list of a single
element `undecided'."
  (find-coding-systems-for-charsets (find-charset-string string)))

(defun find-coding-systems-for-charsets (charsets)
  "Return a list of proper coding systems to encode characters of CHARSETS.
CHARSETS is a list of character sets."
  (if (or (null charsets)
	  (and (= (length charsets) 1)
	       (eq 'ascii (car charsets))))
      '(undecided)
    (let ((l coding-system-list)
277
	  (charset-prefered-codings
Kenichi Handa's avatar
Kenichi Handa committed
278 279 280 281
	   (mapcar (function
		    (lambda (x)
		      (get-charset-property x 'prefered-coding-system)))
		   charsets))
282 283
	  (priorities (mapcar (function (lambda (x) (symbol-value x)))
			      coding-category-list))
Kenichi Handa's avatar
Kenichi Handa committed
284 285 286 287 288 289 290 291
	  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)
		     (subset-p charsets safe)))
	    ;; We put the higher priority to coding systems included
292 293
	    ;; in CHARSET-PREFERED-CODINGS, and within them, put the
	    ;; higher priority to coding systems which support smaller
Kenichi Handa's avatar
Kenichi Handa committed
294 295
	    ;; number of charsets.
	    (let ((priority
296 297 298 299 300
		   (+ (if (coding-system-get coding 'mime-charset) 4096 0)
		      (lsh (length (memq coding priorities)) 7)
		      (if (memq coding charset-prefered-codings) 64 0)
		      (if (> (coding-system-type coding) 0) 32 0)
		      (if (consp safe) (- 32 (length safe)) 0))))
Kenichi Handa's avatar
Kenichi Handa committed
301 302 303 304
	      (setq codings (cons (cons priority coding) codings)))))
      (mapcar 'cdr
	      (sort codings (function (lambda (x y) (> (car x) (car y))))))
      )))
305 306

(defun select-safe-coding-system (from to &optional default-coding-system)
307 308 309
  "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.
310 311 312 313 314

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.

315 316
If the text can be encoded safely by DEFAULT-CODING-SYSTEM, it is
returned without any user interaction.
317 318 319 320 321

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))
Kenichi Handa's avatar
Kenichi Handa committed
322 323 324
  (let ((safe-coding-systems (if (stringp from)
				 (find-coding-systems-string from)
			       (find-coding-systems-region from to))))
325 326 327 328 329 330
    (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

331 332 333 334 335 336 337 338 339 340 341
      ;; At first, change each coding system to the corresponding
      ;; mime-charset name if it is also a coding system.
      (let ((l safe-coding-systems)
	    mime-charset)
	(while l
	  (setq mime-charset (coding-system-get (car l) 'mime-charset))
	  (if (and mime-charset (coding-system-p mime-charset))
	      (setcar l mime-charset))
	  (setq l (cdr l))))

      ;; Then, ask a user to select a proper coding system.  
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
      (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.
360 361 362 363 364 365 366 367 368
	(unwind-protect
	    (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)))))
	      (intern name))
	  (kill-buffer "*Warning*"))))))
369 370 371

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

Karl Heuer's avatar
Karl Heuer committed
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386

;;; 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."
387 388
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
389
  (let ((lang-slot (assoc-ignore-case language-name language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
390 391 392
    (if lang-slot
	(cdr (assq key (cdr lang-slot))))))

393 394
(defun set-language-info (language-name key info
					&optional describe-map setup-map)
Karl Heuer's avatar
Karl Heuer committed
395 396
  "Set for LANGUAGE-NAME the information INFO under KEY.
KEY is a symbol denoting the kind of information.
397 398
INFO is any Lisp object which contains the actual information specific
  to LANGUAGE-NAME.
Karl Heuer's avatar
Karl Heuer committed
399 400

Currently, the following KEYs are used by Emacs:
401

402 403 404
charset: list of charsets.

coding-system: list of coding systems.
405

406
coding-priority: list of coding systems ordered by priority.
407

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

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

412
documentation: t or a string describing how Emacs supports the language.
413 414
  If a string is specified, it is shown before any other information
  of the language by the command `describe-language-environment'.
415

416
setup-function: a function to call for setting up environment
417
  convenient for a user of the language.
418

419
We will define more KEYs in the future.  To avoid conflict,
420 421 422 423 424
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."
425 426
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
Karl Heuer's avatar
Karl Heuer committed
427 428 429 430 431 432 433 434 435 436 437
  (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.
438
    (cond ((eq key 'documentation)
439 440
	   (define-key-after describe-map (vector (intern language-name))
	     (cons language-name 'describe-specified-language-support) t))
Kenichi Handa's avatar
Kenichi Handa committed
441
	  ((eq key 'setup-function)
442 443
	   (define-key-after setup-map (vector (intern language-name))
	     (cons language-name 'setup-specified-language-environment) t)))
444 445

    (setcdr key-slot info)
Karl Heuer's avatar
Karl Heuer committed
446 447
    ))

448
(defun set-language-info-alist (language-name alist &optional parents)
Karl Heuer's avatar
Karl Heuer committed
449 450
  "Set for LANGUAGE-NAME the information in ALIST.
ALIST is an alist of KEY and INFO.  See the documentation of
451 452 453 454 455
`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."
456 457
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
  (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
490

491
(defun read-language-name (key prompt &optional default)
492
  "Read language name which has information for KEY, prompting with PROMPT.
493
DEFAULT is the default choice of language.
494
This returns a language name as a string."
Karl Heuer's avatar
Karl Heuer committed
495 496 497 498
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
				(function (lambda (elm) (assq key elm)))
499
				t nil nil default)))
500 501 502
    (if (and (> (length name) 0)
	     (get-language-info name key))
	name)))
Karl Heuer's avatar
Karl Heuer committed
503 504 505

;;; Multilingual input methods.

506 507 508 509 510 511 512 513 514 515 516 517 518
(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
519
;; Each entry has the form:
520 521 522 523 524 525 526 527 528 529 530 531 532
;;   (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.")

533
(defvar leim-list-entry-regexp "^(register-input-method"
534 535 536 537 538 539 540 541
  "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.")

542 543
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
544 545
  (let ((functions update-leim-list-functions))
    (while functions
546
      (apply (car functions) dirs)
547 548
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
549 550
(defvar current-input-method nil
  "The current input method for multilingual text.
551
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
552 553 554 555
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

560
(defcustom default-input-method nil
561
  "*Default input method for multilingual text (a string).
562
This is the input method activated automatically by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
563
`toggle-input-method' (\\[toggle-input-method])."
564 565
  :group 'mule
  :type 'string)
566

Kenichi Handa's avatar
Kenichi Handa committed
567 568 569 570
(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
571 572 573 574

(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.
575 576 577 578
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
579 580 581 582 583 584 585 586 587
(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)

588 589 590 591 592 593 594 595
(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.
596
INPUT-METHOD and LANGUAGE-NAME are symbols or strings.
597 598 599 600 601 602 603
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."
604 605 606 607
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
608 609 610 611 612 613 614
  (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)))))

615
(defun read-input-method-name (prompt &optional default inhibit-null)
616
  "Read a name of input method from a minibuffer prompting with PROMPT.
617 618
If DEFAULT is non-nil, use that as the default,
  and substitute it into PROMPT at the first `%s'.
619 620 621
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
622 623
  (if default
      (setq prompt (format prompt default)))
624
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
625 626
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
627
	 (input-method (completing-read prompt input-method-alist
628 629
					nil t nil 'input-method-history
					default)))
630 631 632
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
633
	  (error "No valid input method is specified")))))
634 635

(defun activate-input-method (input-method)
636 637
  "Turn INPUT-METHOD on.
If some input method is already on, turn it off at first."
638 639
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
Kenichi Handa's avatar
Kenichi Handa committed
640 641
  (if (and current-input-method
	   (not (string= current-input-method input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
642 643
    (inactivate-input-method))
  (unless current-input-method
644 645
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
Kenichi Handa's avatar
Kenichi Handa committed
646
	  (error "Can't activate input method `%s'" input-method))
Kenichi Handa's avatar
Kenichi Handa committed
647 648 649 650 651 652 653 654
      (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))))
655
      (setq current-input-method input-method)
Kenichi Handa's avatar
Kenichi Handa committed
656 657
      (setq current-input-method-title (nth 3 slot))
      (run-hooks 'input-method-activate-hook))))
658 659

(defun inactivate-input-method ()
660
  "Turn off the current input method."
Kenichi Handa's avatar
Kenichi Handa committed
661 662 663 664 665 666 667 668 669
  (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)
670
      (unwind-protect
Kenichi Handa's avatar
Kenichi Handa committed
671 672 673
	  (run-hooks 'input-method-inactivate-hook)
	(setq current-input-method nil
	      current-input-method-title nil)))))
Karl Heuer's avatar
Karl Heuer committed
674

675
(defun set-input-method (input-method)
Kenichi Handa's avatar
Kenichi Handa committed
676 677 678
  "Select and turn on INPUT-METHOD.
This sets the default input method to what you specify,
and turn it on for the current buffer."
679
  (interactive
Kenichi Handa's avatar
Kenichi Handa committed
680
   (let* ((default (or (car input-method-history) default-input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
681
     (list (read-input-method-name
682
	    (if default "Select input method (default %s): " "Select input method: ")
Richard M. Stallman's avatar
Richard M. Stallman committed
683
	    default t))))
684
  (activate-input-method input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
685
  (setq default-input-method input-method))
Karl Heuer's avatar
Karl Heuer committed
686 687

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

690 691 692 693
With no prefix argument, if some input method is currently activated,
turn it off.  Otherwise, activate an input method--the one most recently used,
or the one specified in `default-input-method', or one read from the
minibuffer.
Kenichi Handa's avatar
Kenichi Handa committed
694

695 696 697
With a prefix arg, read an input method from minibuffer and turn it on.
The default is the most recent input method specified
\(not including the currently active input method, if any).
Kenichi Handa's avatar
Kenichi Handa committed
698 699

When there's no input method to turn on, turn on what read from minibuffer."
Karl Heuer's avatar
Karl Heuer committed
700
  (interactive "P")
701 702 703 704 705 706
  (if (and current-input-method (not arg))
      (inactivate-input-method)
    (let ((default (or (car input-method-history) default-input-method)))
      (if (and arg default (equal current-input-method default)
	       (> (length input-method-history) 1))
	  (setq default (nth 1 input-method-history)))
Kenichi Handa's avatar
Kenichi Handa committed
707 708
      (activate-input-method
       (if (or arg (not default))
709 710 711 712
	   (progn
	     (read-input-method-name
	      (if default "Input method (default %s): " "Input method: " )
	      default t))
Kenichi Handa's avatar
Kenichi Handa committed
713 714 715
	 default))
      (or default-input-method
	  (setq default-input-method current-input-method)))))
716 717

(defun describe-input-method (input-method)
718
  "Describe  input method INPUT-METHOD."
719 720 721
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
722
  (if (and input-method (symbolp input-method))
723
      (setq input-method (symbol-name input-method)))
724 725 726 727 728 729 730 731
  (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 ()
732
  "Describe the input method currently in use."
Karl Heuer's avatar
Karl Heuer committed
733 734 735 736 737 738 739
  (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))
740
    (error "No input method is activated now")))
Karl Heuer's avatar
Karl Heuer committed
741

742
(defun read-multilingual-string (prompt &optional initial-input input-method)
Karl Heuer's avatar
Karl Heuer committed
743 744
  "Read a multilingual string from minibuffer, prompting with string PROMPT.
The input method selected last time is activated in minibuffer.
745
If optional second arg INITIAL-INPUT is non-nil, insert it in the minibuffer
746 747
initially.
Optional 3rd argument INPUT-METHOD specifies the input method
748 749
to be activated instead of the one selected last time.  It is a symbol
or a string."
750 751
  (setq input-method
	(or input-method
752
	    current-input-method
753 754
	    default-input-method
	    (read-input-method-name "Input method: " nil t)))
755
  (if (and input-method (symbolp input-method))
756
      (setq input-method (symbol-name input-method)))
757 758 759 760 761 762 763 764
  (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
765 766 767 768

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

Kenichi Handa's avatar
Kenichi Handa committed
769 770 771
(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
772

773
The extra guidance is done by showing list of available keys in echo
Kenichi Handa's avatar
Kenichi Handa committed
774 775
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
776

Kenichi Handa's avatar
Kenichi Handa committed
777 778 779 780 781 782 783 784 785 786 787 788
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
789 790 791 792 793 794
  :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
795 796
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
797 798
  :type 'boolean
  :group 'mule)
Karl Heuer's avatar
Karl Heuer committed
799 800

(defvar input-method-activate-hook nil
801 802 803 804
  "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
805 806

(defvar input-method-inactivate-hook nil
807 808 809
  "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
810
just inactivated.")
Karl Heuer's avatar
Karl Heuer committed
811 812 813 814

(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
815 816 817 818 819 820 821 822
(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
823

Kenichi Handa's avatar
Kenichi Handa committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
(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).")

840
(defun setup-specified-language-environment ()
841
  "Set up multi-lingual environment convenient for the specified language."
842
  (interactive)
843
  (let (language-name)
844 845 846
    (if (and (symbolp last-command-event)
	     (or (not (eq last-command-event 'Default))
		 (setq last-command-event 'English))
847 848
	     (setq language-name (symbol-name last-command-event)))
	(set-language-environment language-name)
849
      (error "Bogus calling sequence"))))
Karl Heuer's avatar
Karl Heuer committed
850

851 852 853 854 855 856
(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)
857

858
(defun set-language-environment (language-name)
859 860
  "Set up multi-lingual environment for using LANGUAGE-NAME.
This sets the coding system priority and the default input method
861 862 863
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
864 865 866
  (interactive (list (read-language-name
		      'setup-function
		      "Set language environment (default, English): ")))
867 868 869 870
  (if language-name
      (if (symbolp language-name)
	  (setq language-name (symbol-name language-name)))
    (setq language-name "English"))
871
  (if (null (get-language-info language-name 'setup-function))
872
      (error "Language environment not defined: %S" language-name))
873
  (unless default-enable-multibyte-characters
874
    (or (member (downcase language-name)
875
		'("latin-1" "latin-2" "latin-3" "latin-4" "latin-5"))
876 877 878 879
	(error "Language environment `%s' not supported in unibyte mode"
	       language-name))
    (set-terminal-coding-system (intern (downcase language-name)))
    (standard-display-european-internal))
880

Kenichi Handa's avatar
Kenichi Handa committed
881 882 883
  (if current-language-environment
      (let ((func (get-language-info current-language-environment
				     'exit-function)))
884 885
	(run-hooks 'exit-language-environment-hook)
	(if (fboundp func) (funcall func))))
886
  (setq current-language-environment language-name)
Kenichi Handa's avatar
Kenichi Handa committed
887 888
  (funcall (get-language-info language-name 'setup-function))
  (run-hooks 'set-language-environment-hook)
889
  (force-mode-line-update t))
Karl Heuer's avatar
Karl Heuer committed
890

891 892 893 894 895 896 897 898 899 900 901
(defun standard-display-european-internal ()
  ;; Actually set up direct output of non-ASCII characters.
  (standard-display-8bit 160 255)
  ;; Make non-line-break space display as a plain space.
  ;; Most X fonts do the wrong thing for code 160.
  (aset standard-display-table 160 [32])
  ;; Most Windows programs send out apostrophe's as \222.  Most X fonts
  ;; don't contain a character at that position.  Map it to the ASCII
  ;; apostrophe.
  (aset standard-display-table 146 [39]))

902 903 904 905 906 907 908 909 910 911 912 913 914
(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
915 916 917 918 919
;; Print all arguments with `princ', then print "\n".
(defsubst princ-list (&rest args)
  (while args (princ (car args)) (setq args (cdr args)))
  (princ "\n"))

920
;; Print a language specific information such as input methods,
921
;; charsets, and coding systems.  This function is intended to be
922
;; called from the menu:
923
;;   [menu-bar mule describe-language-environment LANGUAGE]
924 925
;; and should not run it by `M-x describe-current-input-method-function'.
(defun describe-specified-language-support ()
926
  "Describe how Emacs supports the specified language environment."
927
  (interactive)
928
  (let (language-name)
929
    (if (not (and (symbolp last-command-event)
930
		  (setq language-name (symbol-name last-command-event))))
931
	(error "Bogus calling sequence"))
932 933 934 935
    (describe-language-environment language-name)))

(defun describe-language-environment (language-name)
  "Describe how Emacs supports language environment LANGUAGE-NAME."
936 937 938
  (interactive
   (list (read-language-name
	  'documentation
939
	  "Describe language environment (default, current choice): ")))
940 941
  (if (null language-name)
      (setq language-name current-language-environment))
942 943 944
  (if (or (null language-name)
	  (null (get-language-info language-name 'documentation)))
      (error "No documentation for the specified language"))
945 946
  (if (symbolp language-name)
      (setq language-name (symbol-name language-name)))
947
  (let ((doc (get-language-info language-name 'documentation)))
948
    (with-output-to-temp-buffer "*Help*"
949
      (princ-list language-name " language environment" "\n")
950
      (if (stringp doc)
951 952 953
	  (progn
	    (princ-list doc)
	    (terpri)))
954 955 956
      (let ((str (get-language-info language-name 'sample-text)))
	(if (stringp str)
	    (progn
957
	      (princ "Sample text:\n")
958 959
	      (princ-list "  " str)
	      (terpri))))
960
      (princ "Input methods:\n")
961
      (let ((l input-method-alist))
962
	(while l
963 964 965
	  (if (string= language-name (nth 1 (car l)))
	      (princ-list "  " (car (car l))
			  (format " (`%s' in mode line)" (nth 3 (car l)))))
966
	  (setq l (cdr l))))
967 968
      (terpri)
      (princ "Character sets:\n")
969 970 971 972 973 974 975
      (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)))))
976 977
      (terpri)
      (princ "Coding systems:\n")
978 979 980
      (let ((l (get-language-info language-name 'coding-system)))
	(if (null l)
	    (princ-list "  nothing specific to " language-name)