mule-cmds.el 60.3 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 40
(define-key mule-keymap "x" 'set-selection-coding-system)
(define-key mule-keymap "X" 'set-next-selection-coding-system)
41
(define-key mule-keymap "\C-\\" 'set-input-method)
42
(define-key mule-keymap "c" 'universal-coding-system-argument)
43
(define-key mule-keymap "l" 'set-language-environment)
Karl Heuer's avatar
Karl Heuer committed
44

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

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

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

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

61 62
(defvar describe-language-environment-map
  (make-sparse-keymap "Describe Language Environment"))
63

64 65
(defvar setup-language-environment-map
  (make-sparse-keymap "Set Language Environment"))
66

67 68
(defvar set-coding-system-map
  (make-sparse-keymap "Set Coding System"))
69

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

(define-key-after set-coding-system-map [set-buffer-file-coding-system]
111
  '("Buffer File" . set-buffer-file-coding-system)
112
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
113 114 115
(define-key-after set-coding-system-map [universal-coding-system-argument]
  '("Next Command" . universal-coding-system-argument)
  t)
116 117 118 119 120 121 122
(define-key-after set-coding-system-map [set-terminal-coding-system]
  '("Terminal" . set-terminal-coding-system)
  t)
(define-key-after set-coding-system-map [set-keyboard-coding-system]
  '("Keyboard" . set-keyboard-coding-system)
  t)
(define-key-after set-coding-system-map [set-buffer-process-coding-system]
123
  '("Buffer Process" . set-buffer-process-coding-system)
124
  t)
125 126 127 128 129 130
(define-key-after set-coding-system-map [set-selection-coding-system]
  '("X Selection" . set-selection-coding-system)
  t)
(define-key-after set-coding-system-map [set-next-selection-coding-system]
  '("Next X Selection" . set-next-selection-coding-system)
  t)
131 132
(define-key setup-language-environment-map
  [Default] '("Default" . setup-specified-language-environment))
Karl Heuer's avatar
Karl Heuer committed
133

134
;; These are meaningless when running under X and W32.
Karl Heuer's avatar
Karl Heuer committed
135
(put 'set-terminal-coding-system 'menu-enable
136
     '(or (not window-system) (eq window-system 'pc)))
137
(put 'set-keyboard-coding-system 'menu-enable
138
     '(or (not window-system) (eq window-system 'pc)))
139 140 141
;; This is meaningless when the current buffer has no process.
(put 'set-buffer-process-coding-system 'menu-enable
     '(get-buffer-process (current-buffer)))
142 143 144 145 146
;; These are meaningless when running under terminal.
(put 'set-selection-coding-system 'menu-enable
     'window-system)
(put 'set-next-selection-coding-system 'menu-enable
     'window-system)
Karl Heuer's avatar
Karl Heuer committed
147 148 149 150 151 152 153 154 155

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

156 157 158 159
;;; 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)
160

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
(defun coding-system-change-eol-conversion (coding-system eol-type)
  "Return a coding system which differs from CODING-SYSTEM in eol conversion.
The returned coding system converts end-of-line by EOL-TYPE
but text as the same way as CODING-SYSTEM.
EOL-TYPE should be `unix', `dos', `mac', or nil.
If EOL-TYPE is nil, the returned coding system detects
how end-of-line is formatted automatically while decoding.

EOL-TYPE can be specified by an integer 0, 1, or 2.
They means `unix', `dos', and `mac' respectively."
  (if (symbolp eol-type)
      (setq eol-type (cond ((eq eol-type 'unix) 0)
			   ((eq eol-type 'dos) 1)
			   ((eq eol-type 'mac) 2)
			   (t eol-type))))
  (let ((orig-eol-type (coding-system-eol-type coding-system)))
    (if (vectorp orig-eol-type)
	(if (not eol-type)
	    coding-system
	  (aref orig-eol-type eol-type))
      (let ((base (coding-system-base coding-system)))
	(if (not eol-type)
	    base
	  (if (= eol-type orig-eol-type)
	      coding-system
	    (setq orig-eol-type (coding-system-eol-type base))
	    (if (vectorp orig-eol-type)
		(aref orig-eol-type eol-type))))))))

(defun coding-system-change-text-conversion (coding-system coding)
  "Return a coding system which differs from CODING-SYSTEM in text conversion.
The returned coding system converts text by CODING
but end-of-line as the same way as CODING-SYSTEM.
If CODING is nil, the returned coding system detects
how text is formatted automatically while decoding."
  (if (not coding)
      (coding-system-base coding-system)
    (let ((eol-type (coding-system-eol-type coding-system)))
      (coding-system-change-eol-conversion
       coding
       (if (numberp eol-type) (aref [unix dos mac] eol-type))))))

Karl Heuer's avatar
Karl Heuer committed
203
(defun toggle-enable-multibyte-characters (&optional arg)
204 205 206 207 208 209 210 211 212 213 214
  "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
215
  (interactive "P")
216 217 218 219
  (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
220 221 222 223 224
  (force-mode-line-update))

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

230 231 232
(defun universal-coding-system-argument ()
  "Execute an I/O command using the specified coding system."
  (interactive)
233 234 235 236 237 238 239 240 241
  (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))
242
	 (keyseq (read-key-sequence
243
		  (format "Command to execute with %s:" coding-system)))
244 245 246 247 248 249
	 (cmd (key-binding keyseq)))
    (let ((coding-system-for-read coding-system)
	  (coding-system-for-write coding-system))
      (message "")
      (call-interactively cmd))))

250
(defun set-default-coding-systems (coding-system)
Kenichi Handa's avatar
Kenichi Handa committed
251
  "Set default value of various coding systems to CODING-SYSTEM.
252
This sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
253
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
254 255
  o default coding system for subprocess I/O
This also sets the following values:
256
  o default value used as file-name-coding-system for converting file names.
257 258
  o default value for the command `set-terminal-coding-system' (not on MSDOS)
  o default value for the command `set-keyboard-coding-system'."
259 260
  (check-coding-system coding-system)
  (setq-default buffer-file-coding-system coding-system)
261 262
  (if default-enable-multibyte-characters
      (setq default-file-name-coding-system coding-system))
263 264 265 266
  ;; If coding-system is nil, honor that on MS-DOS as well, so
  ;; that they could reset the terminal coding system.
  (unless (and (eq window-system 'pc) coding-system)
    (setq default-terminal-coding-system coding-system))
267 268 269
  (setq default-keyboard-coding-system coding-system)
  (setq default-process-coding-system (cons coding-system coding-system)))

270 271 272
(defalias 'update-iso-coding-systems 'update-coding-systems-internal)
(make-obsolete 'update-iso-coding-systems 'update-coding-systems-internal)

Kenichi Handa's avatar
Kenichi Handa committed
273 274
(defun prefer-coding-system (coding-system)
  "Add CODING-SYSTEM at the front of the priority list for automatic detection.
275
This also sets the following coding systems:
Kenichi Handa's avatar
Kenichi Handa committed
276
  o coding system of a newly created buffer
Kenichi Handa's avatar
Kenichi Handa committed
277 278
  o default coding system for subprocess I/O
This also sets the following values:
279
  o default value used as file-name-coding-system for converting file names.
280 281 282
  o default value for the command `set-terminal-coding-system' (not on MSDOS)
  o default value for the command `set-keyboard-coding-system'

283 284 285
If CODING-SYSTEM specifies a certain type of EOL conversion, the coding
systems set by this function will use that type of EOL conversion.

286 287 288 289
This command does not change the default value of terminal coding system
for MS-DOS terminal, because DOS terminals only support a single coding
system, and Emacs automatically sets the default to that coding system at
startup."
Kenichi Handa's avatar
Kenichi Handa committed
290 291 292 293
  (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))
294 295
	(base (coding-system-base coding-system))
	(eol-type (coding-system-eol-type coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
296 297 298
    (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
299
    (set coding-category (or base coding-system))
300
    (update-coding-systems-internal)
301
    (or (eq coding-category (car coding-category-list))
Kenichi Handa's avatar
Kenichi Handa committed
302
	;; We must change the order.
303
	(set-coding-priority (list coding-category)))
Kenichi Handa's avatar
Kenichi Handa committed
304 305 306
    (if (and base (interactive-p))
	(message "Highest priority is set to %s (base of %s)"
		 base coding-system))
307
    ;; If they asked for specific EOL conversion, honor that.
308
    (if (memq eol-type '(0 1 2))
309 310 311 312
	(setq coding-system
	      (coding-system-change-eol-conversion base eol-type))
      (setq coding-system base))
    (set-default-coding-systems coding-system)))
Kenichi Handa's avatar
Kenichi Handa committed
313

Richard M. Stallman's avatar
Richard M. Stallman committed
314
(defun find-coding-systems-region-subset-p (list1 list2)
315 316 317 318 319 320 321 322 323
  "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
324
(defun find-coding-systems-region (from to)
325 326 327 328
  "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.

Karl Heuer's avatar
Karl Heuer committed
329
If the text contains no multibyte characters, return a list of a single
Kenichi Handa's avatar
Kenichi Handa committed
330 331
element `undecided'."
  (find-coding-systems-for-charsets (find-charset-region from to)))
332

Kenichi Handa's avatar
Kenichi Handa committed
333 334 335 336 337
(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.

Karl Heuer's avatar
Karl Heuer committed
338
If STRING contains no multibyte characters, return a list of a single
Kenichi Handa's avatar
Kenichi Handa committed
339 340 341 342 343 344 345 346 347 348
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)
349
    (setq charsets (delq 'composition charsets))
350
    (let ((l (coding-system-list 'base-only))
351
	  (charset-prefered-codings
Kenichi Handa's avatar
Kenichi Handa committed
352 353
	   (mapcar (function
		    (lambda (x)
354 355 356
		      (if (eq x 'unknown)
			  'raw-text
			(get-charset-property x 'prefered-coding-system))))
Kenichi Handa's avatar
Kenichi Handa committed
357
		   charsets))
358 359
	  (priorities (mapcar (function (lambda (x) (symbol-value x)))
			      coding-category-list))
Kenichi Handa's avatar
Kenichi Handa committed
360
	  codings coding safe)
361 362 363
      (if (memq 'unknown charsets)
	  ;; The region contains invalid multibyte characters.
	  (setq l '(raw-text)))
Kenichi Handa's avatar
Kenichi Handa committed
364 365
      (while l
	(setq coding (car l) l (cdr l))
366
	(if (and (setq safe (coding-system-get coding 'safe-charsets))
Kenichi Handa's avatar
Kenichi Handa committed
367
		 (or (eq safe t)
Richard M. Stallman's avatar
Richard M. Stallman committed
368
		     (find-coding-systems-region-subset-p charsets safe)))
Kenichi Handa's avatar
Kenichi Handa committed
369
	    ;; We put the higher priority to coding systems included
370 371
	    ;; in CHARSET-PREFERED-CODINGS, and within them, put the
	    ;; higher priority to coding systems which support smaller
Kenichi Handa's avatar
Kenichi Handa committed
372 373
	    ;; number of charsets.
	    (let ((priority
374 375 376 377 378
		   (+ (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
379 380 381 382
	      (setq codings (cons (cons priority coding) codings)))))
      (mapcar 'cdr
	      (sort codings (function (lambda (x y) (> (car x) (car y))))))
      )))
383

384 385 386 387 388 389 390 391 392 393
(defun find-multibyte-characters (from to &optional maxcount excludes)
  "Find multibyte characters in the region specified by FROM and TO.
If FROM is a string, find multibyte characters in the string.
The return value is an alist of the following format:
  ((CHARSET COUNT CHAR ...) ...)
where
  CHARSET is a character set,
  COUNT is a number of characters,
  CHARs are found characters of the character set.
Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list.
394 395 396
Optional 4th arg EXCLUDE is a list of character sets to be ignored.

For invalid characters, CHARs are actually strings."
397 398 399 400 401 402 403
  (let ((chars nil)
	charset char)
    (if (stringp from)
	(let ((idx 0))
	  (while (setq idx (string-match "[^\000-\177]" from idx))
	    (setq char (aref from idx)
		  charset (char-charset char))
404 405 406 407
	    (if (eq charset 'unknown)
		(setq char (match-string 0)))
	    (if (or (eq charset 'unknown)
		    (not (or (eq excludes t) (memq charset excludes))))
408 409 410 411 412 413 414 415 416 417 418 419 420 421
		(let ((slot (assq charset chars)))
		  (if slot
		      (if (not (memq char (nthcdr 2 slot)))
			  (let ((count (nth 1 slot)))
			    (setcar (cdr slot) (1+ count))
			    (if (or (not maxcount) (< count maxcount))
				(nconc slot (list char)))))
		    (setq chars (cons (list charset 1 char) chars)))))
	    (setq idx (1+ idx))))
      (save-excursion
	(goto-char from)
	(while (re-search-forward "[^\000-\177]" to t)
	  (setq char (preceding-char)
		charset (char-charset char))
422 423 424 425
	  (if (eq charset 'unknown)
	      (setq char (match-string 0)))
	  (if (or (eq charset 'unknown)
		  (not (or (eq excludes t) (memq charset excludes))))
426 427
	      (let ((slot (assq charset chars)))
		(if slot
428
		    (if (not (member char (nthcdr 2 slot)))
429 430 431 432 433 434 435
			(let ((count (nth 1 slot)))
			  (setcar (cdr slot) (1+ count))
			  (if (or (not maxcount) (< count maxcount))
			      (nconc slot (list char)))))
		  (setq chars (cons (list charset 1 char) chars))))))))
    (nreverse chars)))

436 437 438 439 440 441 442
(defvar last-coding-system-specified nil
  "Most recent coding system explicitly specified by the user when asked.
This variable is set whenever Emacs asks the user which coding system
to use in order to write a file.  If you set it to nil explicitly,
then call `write-region', then afterward this variable will be non-nil
only if the user was explicitly asked and specified a coding system.")

443
(defun select-safe-coding-system (from to &optional default-coding-system)
444 445 446
  "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.
447 448 449 450 451

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.

452 453
If the text can be encoded safely by DEFAULT-CODING-SYSTEM, it is
returned without any user interaction.
454 455 456 457 458

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))
459 460 461
  (let* ((charsets (if (stringp from) (find-charset-string from)
		     (find-charset-region from to)))
	 (safe-coding-systems (find-coding-systems-for-charsets charsets)))
462 463
    (if (or (not enable-multibyte-characters)
	    (eq (car safe-coding-systems) 'undecided)
464
	    (eq default-coding-system 'no-conversion)
465 466 467 468 469
	    (and default-coding-system
		 (memq (coding-system-base default-coding-system)
		       safe-coding-systems)))
	default-coding-system

470 471 472 473 474 475 476 477 478 479
      ;; 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))))

480 481 482 483 484
      (let ((non-safe-chars (find-multibyte-characters
			     from to 3
			     (and default-coding-system
				  (coding-system-get default-coding-system
						     'safe-charsets))))
485
	    show-position overlays)
486 487 488 489 490 491 492 493 494
	(save-excursion
	  ;; Highlight characters that default-coding-system can't encode.
	  (when (integerp from)
	    (goto-char from)
	    (let ((found nil))
	      (while (and (not found)
			  (re-search-forward "[^\000-\177]" to t))
		(setq found (assq (char-charset (preceding-char))
				  non-safe-chars))))
495 496
	    (forward-line -1)
	    (setq show-position (point))
497
	    (save-excursion
498 499
	      (while (and (< (length overlays) 256)
			  (re-search-forward "[^\000-\177]" to t))
500 501 502 503 504 505 506 507 508 509
		(let* ((char (preceding-char))
		       (charset (char-charset char)))
		  (when (assq charset non-safe-chars)
		    (setq overlays (cons (make-overlay (1- (point)) (point))
					 overlays))
		    (overlay-put (car overlays) 'face 'highlight))))))

	  ;; At last, ask a user to select a proper coding system.  
	  (unwind-protect
	      (save-window-excursion
510 511 512 513 514
		(when show-position
		  ;; At first, be sure to show the current buffer.
		  (set-window-buffer (selected-window) (current-buffer))
		  (set-window-start (selected-window) show-position))
		;; Then, show a helpful message.
515 516 517 518 519 520 521 522 523 524 525 526
		(with-output-to-temp-buffer "*Warning*"
		  (save-excursion
		    (set-buffer standard-output)
		    (insert "The target text contains the following non ASCII character(s):\n")
		    (let ((len (length non-safe-chars))
			  (shown 0))
		      (while (and non-safe-chars (< shown 3))
			(when (> (length (car non-safe-chars)) 2)
			  (setq shown (1+ shown))
			  (insert (format "%25s: " (car (car non-safe-chars))))
			  (let ((l (nthcdr 2 (car non-safe-chars))))
			    (while l
527 528
			      (if (or (stringp (car l)) (char-valid-p (car l)))
				  (insert (car l)))
529 530 531 532 533 534 535 536 537
			      (setq l (cdr l))))
			  (if (> (nth 1 (car non-safe-chars)) 3)
			      (insert "..."))
			  (insert "\n"))
			(setq non-safe-chars (cdr non-safe-chars)))
		      (if (< shown len)
			  (insert (format "%27s\n" "..."))))
		    (insert (format "\
These can't be encoded safely by the coding system %s.
538 539

Please select one from the following safe coding systems:\n"
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
				    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)))))
		  (setq last-coding-system-specified (intern name))
		  (if (integerp (coding-system-eol-type default-coding-system))
		      (setq last-coding-system-specified
			    (coding-system-change-eol-conversion
			     last-coding-system-specified
			     (coding-system-eol-type default-coding-system))))
		  last-coding-system-specified))
	    (kill-buffer "*Warning*")
	    (while overlays
	      (delete-overlay (car overlays))
	      (setq overlays (cdr overlays)))))))))
566 567 568

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

569 570 571 572 573 574 575 576 577 578
(defun select-message-coding-system ()
  "Return a coding system to encode the outgoing message of the current buffer.
It at first tries the first coding system found in these variables
in this order:
  (1) local value of `buffer-file-coding-system'
  (2) value of `sendmail-coding-system'
  (3) value of `default-buffer-file-coding-system'
  (4) value of `default-sendmail-coding-system'
If the found coding system can't encode the current buffer,
or none of them are bound to a coding system,
579
it asks the user to select a proper coding system."
580 581 582 583 584 585 586 587 588 589 590 591
  (let ((coding (or (and (local-variable-p 'buffer-file-coding-system)
			 buffer-file-coding-system)
		    sendmail-coding-system
		    default-buffer-file-coding-system
		    default-sendmail-coding-system)))
    (if (eq coding 'no-conversion)
	;; We should never use no-conversion for outgoing mails.
	(setq coding nil))
    (if (fboundp select-safe-coding-system-function)
	(funcall select-safe-coding-system-function
		 (point-min) (point-max) coding)
      coding)))
Karl Heuer's avatar
Karl Heuer committed
592

593
;;; Language support stuff.
Karl Heuer's avatar
Karl Heuer committed
594 595

(defvar language-info-alist nil
Richard M. Stallman's avatar
Richard M. Stallman committed
596
  "Alist of language environment definitions.
Karl Heuer's avatar
Karl Heuer committed
597 598
Each element looks like:
	(LANGUAGE-NAME . ((KEY . INFO) ...))
Richard M. Stallman's avatar
Richard M. Stallman committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
where LANGUAGE-NAME is a string, the name of the language environment,
KEY is a symbol denoting the kind of information, and
INFO is the data associated with KEY.
Meaningful values for KEY include

  documentation      value is documentation of what this language environment
			is meant for, and how to use it.
  charset	     value is a list of the character sets used by this
			language environment.
  sample-text	     value is one line of text,
			written using those character sets,
			appropriate for this language environment.
  setup-function     value is a function to call to switch to this
			language environment.
  exit-function      value is a function to call to leave this
		        language environment.
  coding-system      value is a list of coding systems that are good
			for saving text written in this language environment.
			This list serves as suggestions to the user;
			in effect, as a kind of documentation.
  coding-priority    value is a list of coding systems for this language
			environment, in order of decreasing priority.
			This is used to set up the coding system priority
622
			list when you switch to this language environment.
623
  nonascii-translation
624
		     value is a translation table to be set in the
625
			variable `nonascii-translation-table' in this
626 627
			language environment, or a character set from
			which `nonascii-insert-offset' is calculated.
628 629
  input-method       value is a default input method for this language
			environment.
630 631
  features           value is a list of features requested in this
			language environment.
632 633 634 635 636 637

The following keys take effect only when multibyte characters are
globally disabled, i.e. the value of `default-enable-multibyte-characters'
is nil.

  unibyte-syntax     value is a library name to load to set
Karl Heuer's avatar
Karl Heuer committed
638
			unibyte 8-bit character syntaxes for this
639 640 641 642 643 644 645
			language environment.

  unibyte-display    value is a coding system to encode characters
			for the terminal.  Characters in the range
			of 160 to 255 display not as octal escapes,
			but as non-ASCII characters in this language
			environment.")
Richard M. Stallman's avatar
Richard M. Stallman committed
646 647 648 649 650 651 652 653 654

(defun get-language-info (lang-env key)
  "Return information listed under KEY for language environment LANG-ENV.
KEY is a symbol denoting the kind of information.
For a list of useful values for KEY and their meanings,
see `language-info-alist'."
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
  (let ((lang-slot (assoc-ignore-case lang-env language-info-alist)))
Karl Heuer's avatar
Karl Heuer committed
655 656 657
    (if lang-slot
	(cdr (assq key (cdr lang-slot))))))

658
(defun set-language-info (lang-env key info)
Richard M. Stallman's avatar
Richard M. Stallman committed
659 660 661
  "Modify part of the definition of language environment LANG-ENV.
Specifically, this stores the information INFO under KEY
in the definition of this language environment.
Karl Heuer's avatar
Karl Heuer committed
662
KEY is a symbol denoting the kind of information.
Richard M. Stallman's avatar
Richard M. Stallman committed
663
INFO is the value for that information.
664

Richard M. Stallman's avatar
Richard M. Stallman committed
665
For a list of useful values for KEY and their meanings,
666
see `language-info-alist'."
Richard M. Stallman's avatar
Richard M. Stallman committed
667 668
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
Karl Heuer's avatar
Karl Heuer committed
669
  (let (lang-slot key-slot)
Richard M. Stallman's avatar
Richard M. Stallman committed
670
    (setq lang-slot (assoc lang-env language-info-alist))
Karl Heuer's avatar
Karl Heuer committed
671
    (if (null lang-slot)		; If no slot for the language, add it.
Richard M. Stallman's avatar
Richard M. Stallman committed
672
	(setq lang-slot (list lang-env)
Karl Heuer's avatar
Karl Heuer committed
673 674 675 676 677 678
	      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)))))
679
    (setcdr key-slot info)))
Karl Heuer's avatar
Karl Heuer committed
680

Richard M. Stallman's avatar
Richard M. Stallman committed
681 682 683
(defun set-language-info-alist (lang-env alist &optional parents)
  "Store ALIST as the definition of language environment LANG-ENV.
ALIST is an alist of KEY and INFO values.  See the documentation of
684
`set-language-info' for the meanings of KEY and INFO.
685

Richard M. Stallman's avatar
Richard M. Stallman committed
686 687 688 689 690 691 692
Optional arg PARENTS is a list of parent menu names; it specifies
where to put this language environment in the 
Describe Language Environment and Set Language Environment menus.
For example, (\"European\") means to put this language environment
in the European submenu in each of those two menus."
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
  (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)))))
721 722

    ;; Set up menu items for this language env.
723
    (let ((doc (assq 'documentation alist)))
724 725
      (when doc
	(define-key-after describe-map (vector (intern lang-env))
726 727 728
	  (cons lang-env 'describe-specified-language-support) t)))
    (define-key-after setup-map (vector (intern lang-env))
      (cons lang-env 'setup-specified-language-environment) t)
729

730
    (while alist
731
      (set-language-info lang-env (car (car alist)) (cdr (car alist)))
732
      (setq alist (cdr alist)))))
Karl Heuer's avatar
Karl Heuer committed
733

734
(defun read-language-name (key prompt &optional default)
Richard M. Stallman's avatar
Richard M. Stallman committed
735
  "Read a language environment name which has information for KEY.
736
If KEY is nil, read any language environment.
Richard M. Stallman's avatar
Richard M. Stallman committed
737 738
Prompt with PROMPT.  DEFAULT is the default choice of language environment.
This returns a language environment name as a string."
Karl Heuer's avatar
Karl Heuer committed
739 740 741
  (let* ((completion-ignore-case t)
	 (name (completing-read prompt
				language-info-alist
742 743
				(and key
				     (function (lambda (elm) (assq key elm))))
744
				t nil nil default)))
745
    (if (and (> (length name) 0)
746 747
	     (or (not key)
		 (get-language-info name key)))
748
	name)))
Karl Heuer's avatar
Karl Heuer committed
749 750 751

;;; Multilingual input methods.

752 753 754 755 756 757 758 759 760 761
(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)
Karl Heuer's avatar
Karl Heuer committed
762
;; in the same directory as this file.  Loading this file registers
763 764
;; the whole input methods in Emacs.
;;
Kenichi Handa's avatar
Kenichi Handa committed
765
;; Each entry has the form:
766 767 768 769 770 771 772 773 774 775 776 777 778
;;   (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.")

779
(defvar leim-list-entry-regexp "^(register-input-method"
780 781 782 783 784 785 786 787
  "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.")

788 789
(defun update-leim-list-file (&rest dirs)
  "Update LEIM list file in directories DIRS."
790 791
  (let ((functions update-leim-list-functions))
    (while functions
792
      (apply (car functions) dirs)
793 794
      (setq functions (cdr functions)))))

Karl Heuer's avatar
Karl Heuer committed
795 796
(defvar current-input-method nil
  "The current input method for multilingual text.
797
If nil, that means no input method is activated now.")
Karl Heuer's avatar
Karl Heuer committed
798 799 800 801
(make-variable-buffer-local 'current-input-method)
(put 'current-input-method 'permanent-local t)

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

806
(defcustom default-input-method nil
807
  "*Default input method for multilingual text (a string).
808
This is the input method activated automatically by the command
Richard M. Stallman's avatar
Richard M. Stallman committed
809
`toggle-input-method' (\\[toggle-input-method])."
810
  :group 'mule
811
  :type '(choice (const nil) string))
812

Kenichi Handa's avatar
Kenichi Handa committed
813 814 815 816
(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
817 818 819 820

(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.
821 822 823 824
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
825 826 827 828 829 830 831 832 833
(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)

834
(defvar input-method-alist nil
Richard M. Stallman's avatar
Richard M. Stallman committed
835
  "Alist of input method names vs how to use them.
836
Each element has the form:
Richard M. Stallman's avatar
Richard M. Stallman committed
837 838 839
   (INPUT-METHOD LANGUAGE-ENV ACTIVATE-FUNC TITLE DESCRIPTION ARGS...)
See the function `register-input-method' for the meanings of the elements.")

840
(defun register-input-method (input-method lang-env &rest args)
Richard M. Stallman's avatar
Richard M. Stallman committed
841
  "Register INPUT-METHOD as an input method for language environment ENV.
842
INPUT-METHOD and LANG-ENV are symbols or strings.
843 844

The remaining arguments are:
Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847 848 849
	ACTIVATE-FUNC, TITLE, DESCRIPTION, and ARGS...
ACTIVATE-FUNC is a function to call to activate this method.
TITLE is a string to show in the mode line when this method is active.
DESCRIPTION is a string describing this method and what it is good for.
The ARGS, if any, are passed as arguments to ACTIVATE-FUNC.
850 851 852 853 854 855 856 857 858 859 860 861 862 863
All told, the arguments to ACTIVATE-FUNC are INPUT-METHOD and the ARGS.

This function is mainly used in the file \"leim-list.el\" which is
created at building time of emacs, registering all quail input methods
contained in the emacs distribution.

In case you want to register a new quail input method by yourself, be
careful to use the same input method title as given in the third
parameter of `quail-define-package' (if the values are different, the
string specified in this function takes precedence).

The commands `describe-input-method' and `list-input-methods' need
this duplicated values to show some information about input methods
without loading the affected quail packages."
864 865
  (if (symbolp lang-env)
      (setq lang-env (symbol-name lang-env)))
866 867
  (if (symbolp input-method)
      (setq input-method (symbol-name input-method)))
868
  (let ((info (cons lang-env args))
869 870 871 872 873 874
	(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)))))

875
(defun read-input-method-name (prompt &optional default inhibit-null)
876
  "Read a name of input method from a minibuffer prompting with PROMPT.
877 878
If DEFAULT is non-nil, use that as the default,
  and substitute it into PROMPT at the first `%s'.
879 880 881
If INHIBIT-NULL is non-nil, null input signals an error.

The return value is a string."
882 883
  (if default
      (setq prompt (format prompt default)))
884
  (let* ((completion-ignore-case t)
Kenichi Handa's avatar
Kenichi Handa committed
885 886
	 ;; This binding is necessary because input-method-history is
	 ;; buffer local.
887
	 (input-method (completing-read prompt input-method-alist
888 889
					nil t nil 'input-method-history
					default)))
890 891 892
    (if (> (length input-method) 0)
	input-method
      (if inhibit-null
893
	  (error "No valid input method is specified")))))
894 895

(defun activate-input-method (input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
896 897 898
  "Switch to input method INPUT-METHOD for the current buffer.
If some other input method is already active, turn it off first.
If INPUT-METHOD is nil, deactivate any current input method."
899
  (if (and input-method (symbolp input-method))
900
      (setq input-method (symbol-name input-method)))
Kenichi Handa's avatar
Kenichi Handa committed
901 902
  (if (and current-input-method
	   (not (string= current-input-method input-method)))
903
      (inactivate-input-method))
Richard M. Stallman's avatar
Richard M. Stallman committed
904
  (unless (or current-input-method (null input-method))
905 906
    (let ((slot (assoc input-method input-method-alist)))
      (if (null slot)
Kenichi Handa's avatar
Kenichi Handa committed
907
	  (error "Can't activate input method `%s'" input-method))
Kenichi Handa's avatar
Kenichi Handa committed
908 909 910 911 912 913 914 915
      (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))))
916
      (setq current-input-method input-method)
Kenichi Handa's avatar
Kenichi Handa committed
917
      (setq current-input-method-title (nth 3 slot))
918 919 920
      (unwind-protect
	  (run-hooks 'input-method-activate-hook)
	(force-mode-line-update)))))
921 922

(defun inactivate-input-method ()
923
  "Turn off the current input method."
Kenichi Handa's avatar
Kenichi Handa committed
924 925 926 927 928 929 930 931 932
  (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)
933
      (unwind-protect
Kenichi Handa's avatar
Kenichi Handa committed
934 935
	  (run-hooks 'input-method-inactivate-hook)
	(setq current-input-method nil
936 937
	      current-input-method-title nil)
	(force-mode-line-update)))))
Karl Heuer's avatar
Karl Heuer committed
938

939
(defun set-input-method (input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
940 941
  "Select and activate input method INPUT-METHOD for the current buffer.
This also sets the default input method to the one you specify."
942
  (interactive
Kenichi Handa's avatar
Kenichi Handa committed
943
   (let* ((default (or (car input-method-history) default-input-method)))
Richard M. Stallman's avatar
Richard M. Stallman committed
944
     (list (read-input-method-name
945
	    (if default "Select input method (default %s): " "Select input method: ")
Richard M. Stallman's avatar
Richard M. Stallman committed
946
	    default t))))
947
  (activate-input-method input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
948
  (setq default-input-method input-method))
Karl Heuer's avatar
Karl Heuer committed
949 950

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

953 954 955 956
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
957

958 959 960
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
961 962

When there's no input method to turn on, turn on what read from minibuffer."
Karl Heuer's avatar
Karl Heuer committed
963
  (interactive "P")
964 965 966 967 968 969
  (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
970 971
      (activate-input-method
       (if (or arg (not default))
972 973 974 975
	   (progn
	     (read-input-method-name
	      (if default "Input method (default %s): " "Input method: " )
	      default t))
Kenichi Handa's avatar
Kenichi Handa committed
976 977 978
	 default))
      (or default-input-method
	  (setq default-input-method current-input-method)))))
979 980

(defun describe-input-method (input-method)
Richard M. Stallman's avatar
Richard M. Stallman committed
981
  "Describe input method INPUT-METHOD."
982 983 984
  (interactive
   (list (read-input-method-name
	  "Describe input method (default, current choice): ")))
985
  (if (and input-method (symbolp input-method))
986
      (setq input-method (symbol-name input-method)))
987 988 989 990 991 992 993 994
  (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 ()