Mercurial > emacs
annotate lisp/international/quail.el @ 17095:b57415dcc114
Add quail-mode to default value of
minor-mode-map-alist if it is set to local variable.
(quail-show-kbd-layout): Bug fixed for keys not translated.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 26 Feb 1997 13:03:20 +0000 |
parents | 70194012fb3a |
children | 9c1191812679 |
rev | line source |
---|---|
17052 | 1 ;;; quail.el -- provides simple input method for multilingual text |
2 | |
3 ;; Copyright (C) 1995 Free Software Foundation, Inc. | |
4 ;; Copyright (C) 1995 Electrotechnical Laboratory, JAPAN. | |
5 | |
6 ;; Author: Kenichi HANDA <handa@etl.go.jp> | |
7 ;; Naoto TAKAHASHI <ntakahas@etl.go.jp> | |
8 ;; Maintainer: Kenichi HANDA <handa@etl.go.jp> | |
9 ;; Keywords: mule, multilingual, input method | |
10 | |
11 ;; This file is part of GNU Emacs. | |
12 | |
13 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 ;; it under the terms of the GNU General Public License as published by | |
15 ;; the Free Software Foundation; either version 2, or (at your option) | |
16 ;; any later version. | |
17 | |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
17071 | 24 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 ;; Boston, MA 02111-1307, USA. | |
17052 | 27 |
28 ;;; Commentary: | |
29 | |
30 ;; In Quail minor mode, you can input multilingual text easily. By | |
31 ;; defining a translation table (named Quail map) which maps ASCII key | |
32 ;; string to multilingual character or string, you can input any text | |
33 ;; from ASCII keyboard. | |
34 ;; | |
35 ;; We use words "translation" and "conversion" differently. The | |
36 ;; former is done by Quail package itself, the latter is the further | |
37 ;; process of converting a translated text to some more desirable | |
38 ;; text. For instance, Quail package for Japanese (`quail-jp') | |
39 ;; translates Roman text (transliteration of Japanese in Latin | |
40 ;; alphabets) to Hiragana text, which is then converted to | |
41 ;; Kanji-and-Kana mixed text or Katakana text by commands specified in | |
42 ;; CONVERSION-KEYS argument of the Quail package. | |
43 | |
44 ;;; Code: | |
45 | |
46 (require 'faces) | |
47 | |
48 ;; Buffer local variables | |
49 | |
50 (defvar quail-current-package nil | |
51 "The current Quail package to input multilingual text in Quail minor mode. | |
52 See the documentation of `quail-package-alist' for the format.") | |
53 (make-variable-buffer-local 'quail-current-package) | |
54 (put 'quail-current-package 'permanent-local t) | |
55 | |
56 ;; Quail uses the following two buffers to assist users. | |
57 ;; A buffer to show available key sequence or translation list. | |
58 (defvar quail-guidance-buf nil) | |
59 ;; A buffer to show completion list of the current key sequence. | |
60 (defvar quail-completion-buf nil) | |
61 | |
62 (defvar quail-mode nil | |
63 "Non-nil if in Quail minor mode.") | |
64 (make-variable-buffer-local 'quail-mode) | |
65 (put 'quail-mode 'permanent-local t) | |
66 | |
67 (defvar quail-overlay nil | |
68 "Overlay which covers the current translation region of Quail.") | |
69 (make-variable-buffer-local 'quail-overlay) | |
70 | |
71 (defvar quail-conv-overlay nil | |
72 "Overlay which covers the text to be converted in Quail mode.") | |
73 (make-variable-buffer-local 'quail-conv-overlay) | |
74 | |
75 (defvar quail-current-key nil | |
76 "Current key for translation in Quail mode.") | |
77 | |
78 (defvar quail-current-str nil | |
79 "Currently selected translation of the current key.") | |
80 | |
81 (defvar quail-current-translations nil | |
82 "Cons of indices and vector of possible translations of the current key.") | |
83 | |
84 ;; A flag to control conversion region. Normally nil, but if set to | |
85 ;; t, it means we must start the new conversion region if new key to | |
86 ;; be translated is input. | |
87 (defvar quail-reset-conversion-region nil) | |
88 | |
89 ;; Quail package handlers. | |
90 | |
91 (defvar quail-package-alist nil | |
92 "List of Quail packages. | |
93 A Quail package is a list of these elements: | |
94 NAME, TITLE, QUAIL-MAP, GUIDANCE, DOCSTRING, TRANSLATION-KEYS, | |
95 FORGET-LAST-SELECTION, DETERMINISTIC, KBD-TRANSLATE, SHOW-LAYOUT, | |
96 DECODE-MAP, MAXIMUM-SHORTEST, OVERLAY-PLIST, UPDATE-TRANSLATION-FUNCTION, | |
97 CONVERSION-KEYS. | |
98 | |
99 QUAIL-MAP is a data structure to map key strings to translations. For | |
100 the format, see the documentation of `quail-map-p'. | |
101 | |
102 DECODE-MAP is an alist of translations and corresponding keys. | |
103 | |
104 See the documentation of `quail-define-package' for the other elements.") | |
105 | |
106 ;; Return various slots in the current quail-package. | |
107 | |
108 (defsubst quail-name () | |
109 "Return the name of the current Quail package." | |
110 (nth 0 quail-current-package)) | |
111 (defsubst quail-title () | |
112 "Return the title of the current Quail package." | |
113 (nth 1 quail-current-package)) | |
114 (defsubst quail-map () | |
115 "Return the translation map of the current Quail package." | |
116 (nth 2 quail-current-package)) | |
117 (defsubst quail-guidance () | |
118 "Return an object used for `guidance' feature of the current Quail package. | |
119 See also the documentation of `quail-define-package'." | |
120 (nth 3 quail-current-package)) | |
121 (defsubst quail-docstring () | |
122 "Return the documentation string of the current Quail package." | |
123 (nth 4 quail-current-package)) | |
124 (defsubst quail-translation-keymap () | |
125 "Return translation keymap in the current Quail package. | |
126 Translation keymap is a keymap used while translation region is active." | |
127 (nth 5 quail-current-package)) | |
128 (defsubst quail-forget-last-selection () | |
129 "Return `forget-last-selection' flag of the current Quail package. | |
130 See also the documentation of `quail-define-package'." | |
131 (nth 6 quail-current-package)) | |
132 (defsubst quail-deterministic () | |
133 "Return `deterministic' flag of the current Quail package. | |
134 See also the documentation of `quail-define-package'." | |
135 (nth 7 quail-current-package)) | |
136 (defsubst quail-kbd-translate () | |
137 "Return `kbd-translate' flag of the current Quail package. | |
138 See also the documentation of `quail-define-package'." | |
139 (nth 8 quail-current-package)) | |
140 (defsubst quail-show-layout () | |
141 "Return `show-layout' flag of the current Quail package. | |
142 See also the documentation of `quail-define-package'." | |
143 (nth 9 quail-current-package)) | |
144 (defsubst quail-decode-map () | |
145 "Return decode map of the current Quail package. | |
146 It is an alist of translations and corresponding keys." | |
147 (nth 10 quail-current-package)) | |
148 (defsubst quail-maximum-shortest () | |
149 "Return `maximum-shortest' flag of the current Quail package. | |
150 See also the documentation of `quail-define-package'." | |
151 (nth 11 quail-current-package)) | |
152 (defsubst quail-overlay-plist () | |
153 "Return property list of an overly used in the current Quail package." | |
154 (nth 12 quail-current-package)) | |
155 (defsubst quail-update-translation-function () | |
156 "Return a function for updating translation in the current Quail package." | |
157 (nth 13 quail-current-package)) | |
158 (defsubst quail-conversion-keymap () | |
159 "Return conversion keymap in the current Quail package. | |
160 Conversion keymap is a keymap used while conversion region is active | |
161 but translation region is not active." | |
162 (nth 14 quail-current-package)) | |
163 | |
164 (defsubst quail-package (name) | |
165 "Return Quail package named NAME." | |
166 (assoc name quail-package-alist)) | |
167 | |
168 (defun quail-add-package (package) | |
169 "Add Quail package PACKAGE to `quail-package-alist'." | |
170 (let ((pac (quail-package (car package)))) | |
171 (if pac | |
172 (setcdr pac (cdr package)) | |
173 (setq quail-package-alist (cons package quail-package-alist))))) | |
174 | |
175 (defun quail-select-package (name) | |
176 "Select Quail package named NAME as the current Quail package." | |
177 (let ((package (quail-package name))) | |
178 (if (null package) | |
179 (error "No Quail package `%s'" name)) | |
180 (setq quail-current-package package) | |
181 (setq-default quail-current-package package) | |
182 name)) | |
183 | |
184 ;;;###autoload | |
185 (defun quail-use-package (package-name &rest libraries) | |
186 "Start using Quail package PACKAGE-NAME. | |
187 The remaining arguments are libraries to be loaded before using the package." | |
188 (while libraries | |
189 (if (not (load (car libraries) t)) | |
190 (progn | |
191 (with-output-to-temp-buffer "*Help*" | |
192 (princ "Quail package \"") | |
193 (princ package-name) | |
194 (princ "\" can't be activated\n because library \"") | |
195 (princ (car libraries)) | |
196 (princ "\" is not in `load-path'. | |
197 | |
198 The most common case is that you have not yet installed appropriate | |
199 libraries in LEIM (Libraries of Emacs Input Method) which is | |
200 distributed separately from Emacs. | |
201 | |
202 Installation of LEIM for Quail is very simple, just copy Quail | |
203 packages (byte-compiled Emacs Lisp files) to somewhere in your | |
204 `load-path'. | |
205 | |
206 LEIM is available from the same ftp directory as Emacs.")) | |
207 (error "")) | |
208 (setq libraries (cdr libraries)))) | |
209 (quail-select-package package-name) | |
210 (setq current-input-method-title (quail-title)) | |
211 (quail-mode 1)) | |
212 | |
213 (defun quail-inactivate () | |
214 "Turn off Quail input method." | |
215 (interactive) | |
216 (throw 'quail-tag t)) | |
217 | |
218 (or (assq 'quail-mode minor-mode-alist) | |
219 (setq minor-mode-alist | |
220 (cons '(quail-mode " Quail") minor-mode-alist))) | |
221 | |
222 (defvar quail-mode-map | |
223 (let ((map (make-keymap)) | |
224 (i ? )) | |
225 (while (< i 127) | |
226 (define-key map (char-to-string i) 'quail-start-translation) | |
227 (setq i (1+ i))) | |
228 map) | |
229 "Keymap for Quail mode.") | |
230 | |
231 (or (assq 'quail-mode minor-mode-map-alist) | |
232 (setq minor-mode-map-alist | |
233 (cons (cons 'quail-mode quail-mode-map) minor-mode-map-alist))) | |
234 | |
17095
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
235 ;; Since some Emacs Lisp programs (e.g. viper.el) make |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
236 ;; minor-mode-map-alist buffer-local, we must be sure to register |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
237 ;; quail-mode-map in default-value of minor-mode-map-alist. |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
238 (if (local-variable-p 'minor-mode-map-alist) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
239 (let ((map (default-value 'minor-mode-map-alist))) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
240 (or (assq 'quail-mode map) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
241 (set-default 'minor-mode-map-alist (cons 'quail-mode map))))) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
242 |
17052 | 243 (defvar quail-translation-keymap |
244 (let ((map (make-keymap)) | |
245 (i 0)) | |
246 (while (< i ?\ ) | |
247 (define-key map (char-to-string i) 'quail-execute-non-quail-command) | |
248 (setq i (1+ i))) | |
249 (while (< i 127) | |
250 (define-key map (char-to-string i) 'quail-self-insert-command) | |
251 (setq i (1+ i))) | |
252 (define-key map "\177" 'quail-delete-last-char) | |
253 (define-key map "\C-\\" 'quail-inactivate) | |
254 (define-key map "\C-f" 'quail-next-translation) | |
255 (define-key map "\C-b" 'quail-prev-translation) | |
256 (define-key map "\C-n" 'quail-next-translation-block) | |
257 (define-key map "\C-p" 'quail-prev-translation-block) | |
258 (define-key map "\C-i" 'quail-completion) | |
259 (define-key map "\C-@" 'quail-select-current) | |
260 (define-key map "\C-c" 'quail-abort-translation) | |
261 (define-key map "\C-h" 'quail-translation-help) | |
262 (define-key map [tab] 'quail-completion) | |
263 (define-key map [delete] 'quail-delete-last-char) | |
264 (define-key map [backspace] 'quail-delete-last-char) | |
265 ;; At last, define default key binding. | |
266 (append map '((t . quail-execute-non-quail-command)))) | |
267 "Keymap used processing translation in Quail mode. | |
268 This map is activated while translation region is active.") | |
269 | |
270 (defvar quail-conversion-keymap | |
271 (let ((map (make-keymap)) | |
272 (i 0)) | |
273 (while (< i ?\ ) | |
274 (define-key map (char-to-string i) 'quail-execute-non-quail-command) | |
275 (setq i (1+ i))) | |
276 (while (< i 127) | |
277 (define-key map (char-to-string i) | |
278 'quail-start-translation-in-conversion-mode) | |
279 (setq i (1+ i))) | |
280 (define-key map "\C-b" 'quail-conversion-backward-char) | |
281 (define-key map "\C-f" 'quail-conversion-forward-char) | |
282 (define-key map "\C-a" 'quail-conversion-beginning-of-region) | |
283 (define-key map "\C-e" 'quail-conversion-end-of-region) | |
284 (define-key map "\C-d" 'quail-conversion-delete-char) | |
285 (define-key map "\C-h" 'quail-conversion-help) | |
286 (define-key map "\C-\\" 'quail-inactivate) | |
287 (define-key map "\177" 'quail-conversion-backward-delete-char) | |
288 (define-key map [delete] 'quail-conversion-backward-delete-char) | |
289 (define-key map [backspace] 'quail-conversion-backward-delete-char) | |
290 ;; At last, define default key binding. | |
291 (append map '((t . quail-execute-non-quail-command)))) | |
292 "Keymap used for processing conversion in Quail mode. | |
293 This map is activated while convesion region is active but translation | |
294 region is not active.") | |
295 | |
296 (defun quail-define-package (name language title | |
297 &optional guidance docstring translation-keys | |
298 forget-last-selection deterministic | |
299 kbd-translate show-layout create-decode-map | |
300 maximum-shortest overlay-plist | |
301 update-translation-function | |
302 conversion-keys) | |
303 "Define NAME as a new Quail package for input LANGUAGE. | |
304 TITLE is a string to be displayed at mode-line to indicate this package. | |
305 Optional arguments are GUIDANCE, DOCSTRING, TRANLSATION-KEYS, | |
306 FORGET-LAST-SELECTION, DETERMINISTIC, KBD-TRANSLATE, SHOW-LAYOUT, | |
307 CREATE-DECODE-MAP, MAXIMUM-SHORTEST, OVERLAY-PLIST, | |
308 UPDATE-TRANSLATION-FUNCTION, and CONVERSION-KEYS. | |
309 | |
310 GUIDANCE specifies how a guidance string is shown in echo area. | |
311 If it is t, list of all possible translations for the current key is shown | |
312 with the currently selected translation being highlighted. | |
313 If it is an alist, the element has the form (CHAR . STRING). Each character | |
314 in the current key is searched in the list and the corresponding string is | |
315 shown. | |
316 If it is nil, the current key is shown. | |
317 | |
318 DOCSTRING is the documentation string of this package. | |
319 | |
320 TRANSLATION-KEYS specifies additional key bindings used while translation | |
321 region is active. It is an alist of single key character vs. corresponding | |
322 command to be called. | |
323 | |
324 FORGET-LAST-SELECTION non-nil means a selected translation is not kept | |
325 for the future to translate the same key. If this flag is nil, a | |
326 translation selected for a key is remembered so that it can be the | |
327 first candidate when the same key is entered later. | |
328 | |
329 DETERMINISTIC non-nil means the first candidate of translation is | |
330 selected automatically without allowing users to select another | |
331 translation for a key. In this case, unselected translations are of | |
332 no use for an interactive use of Quail but can be used by some other | |
333 programs. If this flag is non-nil, FORGET-LAST-SELECTION is also set | |
334 to t. | |
335 | |
336 KBD-TRANSLATE non-nil means input characters are translated from a | |
337 user's keyboard layout to the standard keyboard layout. See the | |
338 documentation of `quail-keyboard-layout' and | |
339 `quail-keyboard-layout-standard' for more detail. | |
340 | |
341 SHOW-LAYOUT non-nil means the `quail-help' command should show | |
342 the user's keyboard layout visually with translated characters. | |
343 If KBD-TRANSLATE is set, it is desirable to set also this flag unless | |
344 this package defines no translations for single character keys. | |
345 | |
346 CREATE-DECODE-MAP non-nil means decode map is also created. A decode | |
347 map is an alist of translations and corresponding original keys. | |
348 Although this map is not used by Quail itself, it can be used by some | |
349 other programs. For instance, Vietnamese supporting needs this map to | |
350 convert Vietnamese text to VIQR format which uses only ASCII | |
351 characters to represent Vietnamese characters. | |
352 | |
353 MAXIMUM-SHORTEST non-nil means break key sequence to get maximum | |
354 length of the shortest sequence. When we don't have a translation of | |
355 key \"..ABCD\" but have translations of \"..AB\" and \"CD..\", break | |
356 the key at \"..AB\" and start translation of \"CD..\". Hangul | |
357 packages, for instance, use this facility. If this flag is nil, we | |
358 break the key just at \"..ABC\" and start translation of \"D..\". | |
359 | |
360 OVERLAY-PLIST if non-nil is a property list put on an overlay which | |
361 covers Quail translation region. | |
362 | |
363 UPDATE-TRANSLATION-FUNCTION if non-nil is a function to call to update | |
364 the current translation region accoding to a new translation data. By | |
365 default, a tranlated text or a user's key sequence (if no transltion | |
366 for it) is inserted. | |
367 | |
368 CONVERSION-KEYS specifies additional key bindings used while | |
369 conversion region is active. It is an alist of single key character | |
370 vs. corresponding command to be called." | |
371 (let (translation-keymap conversion-keymap) | |
372 (if deterministic (setq forget-last-selection t)) | |
373 (if translation-keys | |
374 (progn | |
375 (setq translation-keymap (copy-keymap quail-translation-keymap)) | |
376 (while translation-keys | |
377 (define-key translation-keymap | |
378 (car (car translation-keys)) (cdr (car translation-keys))) | |
379 (setq translation-keys (cdr translation-keys)))) | |
380 (setq translation-keymap quail-translation-keymap)) | |
381 (if conversion-keys | |
382 (progn | |
383 (setq conversion-keymap (copy-keymap quail-conversion-keymap)) | |
384 (while conversion-keys | |
385 (define-key conversion-keymap | |
386 (car (car conversion-keys)) (cdr (car conversion-keys))) | |
387 (setq conversion-keys (cdr conversion-keys))))) | |
388 (quail-add-package | |
389 (list name title (list nil) guidance (or docstring "") | |
390 translation-keymap | |
391 forget-last-selection deterministic kbd-translate show-layout | |
392 (if create-decode-map (list 'decode-map) nil) | |
393 maximum-shortest overlay-plist update-translation-function | |
394 conversion-keymap))) | |
395 (register-input-method language (list name 'quail-use-package)) | |
396 (quail-select-package name)) | |
397 | |
398 ;; Quail minor mode handlers. | |
399 | |
400 ;; Setup overlays used in Quail mode. | |
401 (defun quail-setup-overlays () | |
402 (let ((pos (point))) | |
403 (if (overlayp quail-overlay) | |
404 (move-overlay quail-overlay pos pos) | |
405 (setq quail-overlay (make-overlay pos pos nil nil t)) | |
406 (overlay-put quail-overlay 'face 'underline) | |
407 (let ((l (quail-overlay-plist))) | |
408 (while l | |
409 (overlay-put quail-overlay (car l) (car (cdr l))) | |
410 (setq l (cdr (cdr l)))))) | |
411 (if (overlayp quail-conv-overlay) | |
412 (move-overlay quail-conv-overlay pos pos) | |
413 (setq quail-conv-overlay (make-overlay pos pos nil nil t)) | |
414 (overlay-put quail-conv-overlay 'face 'underline) | |
415 ;;(overlay-put quail-conv-overlay 'modification-hooks | |
416 ;;'(quail-conv-overlay-modification-hook)) | |
417 ))) | |
418 | |
419 ;; Delete overlays used in Quail mode. | |
420 (defun quail-delete-overlays () | |
421 (if (overlayp quail-overlay) | |
422 (delete-overlay quail-overlay)) | |
423 (if (overlayp quail-conv-overlay) | |
424 (delete-overlay quail-conv-overlay))) | |
425 | |
426 ;; While translating and converting, we enter the recursive edit and | |
427 ;; exit it frequently, which results in frequent and annoying change | |
428 ;; of and annoying in mode line. To avoid it, we use a modified | |
429 ;; mode-line-format. | |
430 (defvar quail-mode-line-format nil) | |
431 | |
432 ;; Return a modified mode-line-format which doesn't show the recursive | |
433 ;; editing level. But, we only pay attention to the top level | |
434 ;; elements of the current mode-line-format. | |
435 (defun quail-generate-mode-line-format () | |
436 (if (listp mode-line-format) | |
437 (let ((new (copy-sequence mode-line-format)) | |
438 l elt idx) | |
439 (setq l new) | |
440 (while l | |
441 (setq elt (car l)) | |
442 (if (and (stringp elt) | |
443 (or (setq idx (string-match "%\\[" elt)) | |
444 (setq idx (string-match "%\\]" elt)))) | |
445 (setcar l (concat (substring elt 0 idx) | |
446 (substring elt (+ idx 2))))) | |
447 (setq l (cdr l))) | |
448 new) | |
449 mode-line-format)) | |
450 | |
451 (defun quail-mode (&optional arg) | |
452 "Toggle Quail minor mode. | |
453 With arg, turn Quail mode on if and only if arg is positive. | |
454 Try \\[describe-bindings] in Quail mode to see the available key binding. | |
455 The command \\[describe-input-method] describes the current Quail package." | |
456 (interactive "P") | |
457 (setq quail-mode | |
458 (if (null arg) (null quail-mode) | |
459 (> (prefix-numeric-value arg) 0))) | |
460 (if (null quail-mode) | |
461 ;; Let's turn off Quail mode. | |
462 (progn | |
463 (quail-hide-guidance-buf) | |
464 (quail-delete-overlays) | |
465 (setq describe-current-input-method-function nil) | |
466 (setq current-input-method nil) | |
467 (run-hooks 'quail-mode-exit-hook) | |
468 (run-hooks 'input-method-inactivate-hook)) | |
469 ;; Let's turn on Quail mode. | |
470 (if (null quail-current-package) | |
471 ;; Quail package is not yet selected. Select one now. | |
472 (let (name) | |
473 (if quail-package-alist | |
474 (setq name (car (car quail-package-alist))) | |
475 (setq quail-mode nil) | |
476 (error "No Quail package loaded")) | |
477 (quail-select-package name))) | |
478 (setq inactivate-current-input-method-function 'quail-mode) | |
479 (setq describe-current-input-method-function 'quail-help) | |
480 (setq quail-mode-line-format (quail-generate-mode-line-format)) | |
481 (quail-delete-overlays) | |
482 (quail-show-guidance-buf) | |
483 ;; If we are in minibuffer, turn off Quail mode before exiting. | |
484 (if (eq (selected-window) (minibuffer-window)) | |
485 (add-hook 'minibuffer-exit-hook 'quail-exit-from-minibuffer)) | |
486 (make-local-hook 'post-command-hook) | |
487 (run-hooks 'quail-mode-hook) | |
488 (run-hooks 'input-method-activate-hook)) | |
489 (force-mode-line-update)) | |
490 | |
491 (defun quail-exit-from-minibuffer () | |
492 (if quail-mode (quail-mode -1)) | |
493 (if (<= (minibuffer-depth) 1) | |
494 (remove-hook 'minibuffer-exit-hook 'quail-exit-from-minibuffer))) | |
495 | |
496 (defvar quail-saved-overriding-local-map nil) | |
497 (defvar quail-saved-current-buffer nil) | |
498 | |
499 ;; Toggle `quail-mode'. This function is added to `post-command-hook' | |
500 ;; in Quail mode, to turn Quail mode temporarily off, or back on | |
501 ;; after one non-Quail command. | |
502 (defun quail-toggle-mode-temporarily () | |
503 (if quail-mode | |
504 ;; We are going to handle following events out of Quail mode. | |
505 (setq quail-mode nil | |
506 quail-saved-overriding-local-map overriding-local-map | |
507 quail-saved-current-buffer (current-buffer) | |
508 overriding-local-map nil) | |
509 ;; We have just executed one non-Quail command. We don't need | |
510 ;; this hook any more. | |
511 (remove-hook 'post-command-hook 'quail-toggle-mode-temporarily t) | |
512 ;; If the command changed the current buffer, we should not go | |
513 ;; back to Quail mode. | |
514 (if (not (eq (current-buffer) quail-saved-current-buffer)) | |
515 (throw 'quail-tag nil) | |
516 ;; Let's go back to Quail mode. | |
517 (setq quail-mode t) | |
518 (setq overriding-local-map quail-saved-overriding-local-map) | |
519 ;; If whole text in conversion area was deleted, exit from the | |
520 ;; recursive edit. | |
521 (let ((start (overlay-start quail-conv-overlay))) | |
522 (if (and start (= start (overlay-end quail-conv-overlay))) | |
523 (throw 'quail-tag nil))) | |
524 ))) | |
525 | |
526 (defun quail-execute-non-quail-command () | |
527 "Execute one non-Quail command in Quail mode. | |
528 The current translation and conversion are terminated." | |
529 (interactive) | |
530 (setq unread-command-events (cons last-input-event unread-command-events)) | |
531 (quail-delete-overlays) | |
532 (if (buffer-live-p quail-guidance-buf) | |
533 (save-excursion | |
534 (set-buffer quail-guidance-buf) | |
535 (erase-buffer))) | |
536 (throw 'quail-tag nil)) | |
537 | |
538 ;; Keyboard layout translation handlers. | |
539 | |
540 ;; Some Quail packages provide localized keyboard simulation which | |
541 ;; requires a particular keyboard layout. In this case, what we need | |
542 ;; is locations of keys the user entered, not character codes | |
543 ;; generated by those keys. However, for the moment, there's no | |
544 ;; common way to get such information. So, we ask a user to give | |
545 ;; information of his own keyboard layout, then translate it to the | |
546 ;; standard layout which we defined so that all Quail packages depend | |
547 ;; just on it. | |
548 | |
549 (defconst quail-keyboard-layout-standard | |
550 "\ | |
551 1!2@3#4$5%6^7&8*9(0)-_=+`~ \ | |
552 qQwWeErRtTyYuUiIoOpP[{]} \ | |
553 aAsSdDfFgGhHjJkKlL;:'\"\\| \ | |
554 zZxXcCvVbBnNmM,<.>/? " | |
555 "Standard keyboard layout of printable characters Quail assumes. | |
556 See the documentation of `quail-keyboard-layout' for this format. | |
557 This layout is almost the same as that of VT100, | |
558 but the location of key \\ (backslash) is just right of key ' (single-quote), | |
559 not right of RETURN key.") | |
560 | |
561 (defvar quail-keyboard-layout quail-keyboard-layout-standard | |
562 "A string which represents physical key layout of a particular keyboard. | |
563 We assume there are four rows and each row has 15 keys (columns), | |
564 the first column of the first row is left of key '1', | |
565 the first column of the second row is left of key `q', | |
566 the first column of the third row is left of key `a', | |
567 the first column of the fourth row is left of key `z'. | |
568 Nth (N is even) and (N+1)th characters in the string are non-shifted | |
569 and shifted characters respectively at the same location. | |
570 The location of Nth character is row (N / 30) and column ((N mod 30) / 2).") | |
571 | |
572 (defconst quail-keyboard-layout-len 120) | |
573 | |
574 ;; Here we provide several examples of famous keyboard layouts. | |
575 | |
576 (defvar quail-keyboard-layout-alist | |
577 (list | |
578 '("sun-type3" . "\ | |
579 1!2@3#4$5%6^7&8*9(0)-_=+\\|`~\ | |
580 qQwWeErRtTyYuUiIoOpP[{]} \ | |
581 aAsSdDfFgGhHjJkKlL;:'\" \ | |
582 zZxXcCvVbBnNmM,<.>/? ") | |
583 (cons "standard" quail-keyboard-layout-standard)) | |
584 "Alist of keyboard names and corresponding layout strings. | |
585 See the documentation of `quail-keyboard-layout' for the format of | |
586 the layout string.") | |
587 | |
588 (defun quail-set-keyboard-layout (kbd-type) | |
589 "Set the current keyboard layout to the same as keyboard KBD-TYPE. | |
590 | |
591 Since some Quail packages depends on a physical layout of keys (not | |
592 characters generated by them), those are created by assuming the | |
593 standard layout defined in `quail-keyboard-layout-standard'. This | |
594 function tells Quail system the layout of your keyboard so that what | |
595 you type is correctly handled." | |
596 (interactive | |
597 (let* ((completing-ignore-case t) | |
598 (type (completing-read "Keyboard type: " | |
599 quail-keyboard-layout-alist))) | |
600 (list type))) | |
601 (let ((layout (assoc kbd-type quail-keyboard-layout-alist))) | |
602 (if (null layout) | |
603 ;; Here, we had better ask a user to define his own keyboard | |
604 ;; layout interactively. | |
605 (error "Unknown keyboard type `%s'" kbd-type)) | |
606 (setq quail-keyboard-layout (cdr layout)))) | |
607 | |
608 (defun quail-keyboard-translate (ch) | |
609 "Translate CHAR according to `quail-keyboard-layout' and return the result." | |
610 (if (eq quail-keyboard-layout quail-keyboard-layout-standard) | |
611 ch | |
612 (let ((i 0)) | |
613 (while (and (< i quail-keyboard-layout-len) | |
614 (/= ch (aref quail-keyboard-layout i))) | |
615 (setq i (1+ i))) | |
616 (if (= i quail-keyboard-layout-len) | |
617 (error "Character `%c' not found in your keyboard layout" ch)) | |
618 (aref quail-keyboard-layout-standard i)))) | |
619 | |
620 ;; Quail map | |
621 | |
622 (defsubst quail-map-p (object) | |
623 "Return t if OBJECT is a Quail map. | |
624 | |
625 A Quail map holds information how a particular key should be translated. | |
626 Its format is (TRANSLATION . ALIST). | |
627 TRANSLATION is either a character, or a cons (INDEX . VECTOR). | |
628 In the latter case, each element of VECTOR is a candidate for the translation, | |
629 and INDEX points the currently selected translation. | |
630 | |
631 ALIST is normally a list of elements that look like (CHAR . DEFN), | |
632 where DEFN is another Quail map for a longer key (CHAR added to the | |
633 current key). It may also be a symbol of a function which returns an | |
634 alist of the above format. | |
635 | |
636 Just after a Quail package is read, TRANSLATION may be a string or a | |
637 vector. Then each element of the string or vector is a candidate for | |
638 the translation. These objects are transformed to cons cells in the | |
639 format \(INDEX . VECTOR), as described above." | |
640 (and (consp object) | |
641 (let ((translation (car object))) | |
642 (or (integerp translation) (consp translation) (null translation) | |
643 (vectorp translation) (stringp translation) | |
644 (symbolp translation))) | |
645 (let ((alist (cdr object))) | |
646 (or (listp alist) (symbolp alist))))) | |
647 | |
648 (defmacro quail-define-rules (&rest rules) | |
649 "Define translation rules of the current Quail package. | |
650 Each argument is a list of KEY and TRANSLATION. | |
651 KEY is a string meaning a sequence of keystrokes to be translated. | |
652 TRANSLATION is a character, a string, a vector, a Quail map, or a function. | |
653 It it is a character, it is the sole translation of KEY. | |
654 If it is a string, each character is a candidate for the translation. | |
655 If it is a vector, each element (string or character) is a candidate | |
656 for the translation. | |
657 In these cases, a key specific Quail map is generated and assigned to KEY. | |
658 | |
659 If TRANSLATION is a Quail map or a function symbol which returns a Quail map, | |
660 it is used to handle KEY." | |
661 `(quail-install-map | |
662 ',(let ((l rules) | |
663 (map (list nil))) | |
664 (while l | |
665 (quail-defrule-internal (car (car l)) (car (cdr (car l))) map) | |
666 (setq l (cdr l))) | |
667 map))) | |
668 | |
669 (defun quail-install-map (map) | |
670 "Install the Quail map MAP in the current Quail package. | |
671 The installed map can be referred by the function `quail-map'." | |
672 (if (null quail-current-package) | |
673 (error "No current Quail package")) | |
674 (if (null (quail-map-p map)) | |
675 (error "Invalid Quail map `%s'" map)) | |
676 (setcar (cdr (cdr quail-current-package)) map)) | |
677 | |
678 (defun quail-defrule (key translation &optional name) | |
679 "Add one translation rule, KEY to TRANSLATION, in the current Quail package. | |
680 KEY is a string meaning a sequence of keystrokes to be translated. | |
681 TRANSLATION is a character, a string, a vector, a Quail map, or a function. | |
682 It it is a character, it is the sole translation of KEY. | |
683 If it is a string, each character is a candidate for the translation. | |
684 If it is a vector, each element (string or character) is a candidate | |
685 for the translation. | |
686 In these cases, a key specific Quail map is generated and assigned to KEY. | |
687 | |
688 If TRANSLATION is a Quail map or a function symbol which returns a Quail map, | |
689 it is used to handle KEY. | |
690 Optional argument NAME, if specified, says which Quail package | |
691 to define this translation rule in. The default is to define it in the | |
692 current Quail package." | |
693 (if name | |
694 (let ((package (quail-package name))) | |
695 (if (null package) | |
696 (error "No Quail package `%s'" name)) | |
697 (setq quail-current-package package))) | |
698 (quail-defrule-internal key translation (quail-map))) | |
699 | |
700 ;; Define KEY as TRANS in a Quail map MAP. | |
701 (defun quail-defrule-internal (key trans map) | |
702 (if (null (stringp key)) | |
703 "Invalid Quail key `%s'" key) | |
704 (if (not (or (numberp trans) (stringp trans) (vectorp trans) | |
705 (symbolp trans) | |
706 (quail-map-p trans))) | |
707 (error "Invalid Quail translation `%s'" trans)) | |
708 (if (null (quail-map-p map)) | |
709 (error "Invalid Quail map `%s'" map)) | |
710 (let ((len (length key)) | |
711 (idx 0) | |
712 ch entry) | |
713 (while (< idx len) | |
714 (if (null (consp map)) | |
715 ;; We come here, for example, when we try to define a rule | |
716 ;; for "ABC" but a rule for "AB" is already defined as a | |
717 ;; symbol. | |
718 (error "Quail key %s is too long" key)) | |
719 (setq ch (aref key idx) | |
720 entry (assq ch (cdr map))) | |
721 (if (null entry) | |
722 (progn | |
723 (setq entry (cons ch (list nil))) | |
724 (setcdr map (cons entry (cdr map))))) | |
725 (setq map (cdr entry)) | |
726 (setq idx (1+ idx))) | |
727 (if (symbolp trans) | |
728 (if (cdr map) | |
729 ;; We come here, for example, when we try to define a rule | |
730 ;; for "AB" as a symbol but a rule for "ABC" is already | |
731 ;; defined. | |
732 (error "Quail key %s is too short" key) | |
733 (setcdr entry trans)) | |
734 (if (quail-map-p trans) | |
735 (if (not (listp (cdr map))) | |
736 ;; We come here, for example, when we try to define a rule | |
737 ;; for "AB" as a symbol but a rule for "ABC" is already | |
738 ;; defined. | |
739 (error "Quail key %s is too short" key) | |
740 (if (not (listp (cdr trans))) | |
741 (if (cdr map) | |
742 ;; We come here, for example, when we try to | |
743 ;; define a rule for "AB" as a symbol but a rule | |
744 ;; for "ABC" is already defined. | |
745 (error "Quail key %s is too short" key) | |
746 (setcdr entry trans)) | |
747 (setcdr entry (append trans (cdr map))))) | |
748 (setcar map trans))))) | |
749 | |
750 (defun quail-get-translation (map key len) | |
751 "Return the translation specified in Quail map MAP for KEY of length LEN. | |
752 The translation is either a character or a cons of the form (INDEX . VECTOR), | |
753 where VECTOR is a vector of candidates (character or string) for | |
754 the translation, and INDEX points into VECTOR to specify the currently | |
755 selected translation." | |
756 (let ((def (car map))) | |
757 (if (and def (symbolp def)) | |
758 ;; DEF is a symbol of a function which returns valid translation. | |
759 (setq def (funcall def key len))) | |
760 (cond | |
761 ((or (integerp def) (consp def)) | |
762 def) | |
763 | |
764 ((null def) | |
765 ;; No translation. | |
766 nil) | |
767 | |
768 ((stringp def) | |
769 ;; Each character in DEF is a candidate of translation. Reform | |
770 ;; it as (INDEX . VECTOR). | |
771 (setq def (string-to-vector def)) | |
772 ;; But if the length is 1, we don't need vector but a single | |
773 ;; character as the translation. | |
774 (if (= (length def) 1) | |
775 (aref def 0) | |
776 (cons 0 def))) | |
777 | |
778 ((vectorp def) | |
779 ;; Each element (string or character) in DEF is a candidate of | |
780 ;; translation. Reform it as (INDEX . VECTOR). | |
781 (cons 0 def)) | |
782 | |
783 (t | |
784 (error "Invalid object in Quail map: %s" def))))) | |
785 | |
786 (defun quail-lookup-key (key len) | |
787 "Lookup KEY of length LEN in the current Quail map and return the definition. | |
788 The returned value is a Quail map specific to KEY." | |
789 (let ((idx 0) | |
790 (map (quail-map)) | |
791 (kbd-translate (quail-kbd-translate)) | |
792 slot ch translation) | |
793 (while (and map (< idx len)) | |
794 (setq ch (if kbd-translate (quail-keyboard-translate (aref key idx)) | |
795 (aref key idx))) | |
796 (setq idx (1+ idx)) | |
797 (if (and (cdr map) (symbolp (cdr map))) | |
798 (setcdr map (funcall (cdr map) key idx))) | |
799 (setq slot (assq ch (cdr map))) | |
800 (if (and (cdr slot) (symbolp (cdr slot))) | |
801 (setcdr slot (funcall (cdr slot) key idx))) | |
802 (setq map (cdr slot))) | |
803 (if (and map (setq translation (quail-get-translation map key len))) | |
804 (progn | |
805 ;; We may have to reform car part of MAP. | |
806 (if (not (equal (car map) translation)) | |
807 (setcar map translation)) | |
808 (if (consp translation) | |
809 (progn | |
810 (setq quail-current-translations translation) | |
811 (if (quail-forget-last-selection) | |
812 (setcar quail-current-translations 0)))) | |
813 ;; We may have to reform cdr part of MAP. | |
814 (if (and (cdr map) (symbolp (cdr map))) | |
815 (progn | |
816 (setcdr map (funcall (cdr map) key len)))) | |
817 )) | |
818 map)) | |
819 | |
820 (defun quail-conv-overlay-modification-hook (overlay after &rest ignore) | |
821 (if (and after | |
822 (= (overlay-start overlay) (overlay-end overlay))) | |
823 ;; Whole text in conversion area was deleted. Let's exit from | |
824 ;; the recursive edit. | |
825 (throw 'exit nil))) | |
826 | |
827 (defvar quail-suppress-conversion nil | |
828 "If non-nil, suppress converting facility of the current Quail package.") | |
829 | |
830 ;; If set to non-nil, exit conversion mode before starting new translation. | |
831 (defvar quail-exit-conversion-mode nil) | |
832 | |
833 (defun quail-start-translation () | |
834 "Start translating the typed character in Quail mode." | |
835 (interactive "*") | |
836 (setq unread-command-events | |
837 (cons last-command-event unread-command-events)) | |
838 ;; Check the possibility of translating the last key. | |
839 (if (assq last-command-event (cdr (quail-map))) | |
840 ;; Ok, we can start translation. | |
841 (let ((mode-line-format quail-mode-line-format)) | |
842 (quail-setup-overlays) | |
843 (if (catch 'quail-tag | |
844 (if (and (not quail-suppress-conversion) | |
845 (quail-conversion-keymap)) | |
846 ;; We must start translation in conversion mode. | |
847 (let ((overriding-local-map (quail-conversion-keymap))) | |
848 (setq quail-exit-conversion-mode nil) | |
849 (recursive-edit) | |
850 (if (and auto-fill-function | |
851 (> (current-column) (current-fill-column))) | |
852 (run-hooks 'auto-fill-function))) | |
853 (let ((overriding-local-map (quail-translation-keymap))) | |
854 (setq quail-current-key "") | |
855 (recursive-edit))) | |
856 (if (prog1 (< (overlay-start quail-conv-overlay) | |
857 (overlay-end quail-conv-overlay)) | |
858 (delete-overlay quail-conv-overlay)) | |
859 (run-hooks 'input-method-after-insert-chunk-hook)) | |
860 nil) | |
861 ;; Someone has thrown a tag with value t, which means | |
862 ;; we should turn Quail mode off. | |
863 (quail-mode -1))) | |
864 ;; Since the typed character doesn't start any translation, handle | |
865 ;; it out of Quail mode. We come back to Quail mode later because | |
866 ;; function `quail-toggle-mode-temporarily' is in | |
867 ;; `post-command-hook'. | |
868 (add-hook 'post-command-hook 'quail-toggle-mode-temporarily nil t))) | |
869 | |
870 (defsubst quail-point-in-conversion-region () | |
871 "Return non-nil value if the point is in conversion region of Quail mode." | |
872 (let (start pos) | |
873 (and (setq start (overlay-start quail-conv-overlay)) | |
874 (>= (setq pos (point)) start) | |
875 (<= pos (overlay-end quail-conv-overlay))))) | |
876 | |
877 (defun quail-start-translation-in-conversion-mode () | |
878 "Start translating the typed character in conversion mode of Quail mode." | |
879 (interactive "*") | |
880 (setq unread-command-events | |
881 (cons last-command-event unread-command-events)) | |
882 (if (or quail-exit-conversion-mode | |
883 (not (quail-point-in-conversion-region))) | |
884 (progn | |
885 ;; We must start translation with new conversion region. | |
886 (setq quail-exit-conversion-mode nil) | |
887 (throw 'exit nil))) | |
888 ;; Check the possibility of translating the last key. | |
889 (if (assq last-command-event (cdr (quail-map))) | |
890 ;; Ok, we can start translation. | |
891 (let ((overriding-local-map (quail-translation-keymap))) | |
892 (setq quail-current-key "") | |
893 (move-overlay quail-overlay (point) (point)) | |
894 (recursive-edit)) | |
895 ;; Since the typed character doesn't start any translation, handle | |
896 ;; it out of Quail mode. We come back to Quail mode later because | |
897 ;; function `quail-toggle-mode-temporarily' is in | |
898 ;; `post-command-hook'. | |
899 (add-hook 'post-command-hook 'quail-toggle-mode-temporarily nil t))) | |
900 | |
901 (defun quail-terminate-translation () | |
902 "Terminate the translation of the current key." | |
903 (let ((start (overlay-start quail-overlay))) | |
904 (if (and start | |
905 (< start (overlay-end quail-overlay))) | |
906 ;; Here we simulate self-insert-command. | |
907 (let (last-command-char) | |
908 (goto-char start) | |
909 ;; The first one might want to expand an abbrev. | |
910 (setq last-command-char (following-char)) | |
911 (delete-char 1) | |
912 (self-insert-command 1) | |
913 (if (< (point) (overlay-end quail-overlay)) | |
914 (if overwrite-mode | |
915 (while (< (point) (overlay-end quail-overlay)) | |
916 (setq last-command-char (following-char)) | |
917 (delete-char 1) | |
918 (self-insert-command 1)) | |
919 ;; The last one might still want to auto-fill. | |
920 (goto-char (overlay-end quail-overlay)) | |
921 (let ((last-command-char (preceding-char))) | |
922 (delete-char -1) | |
923 (self-insert-command 1))))))) | |
924 (delete-overlay quail-overlay) | |
925 (if (buffer-live-p quail-guidance-buf) | |
926 (save-excursion | |
927 (set-buffer quail-guidance-buf) | |
928 (erase-buffer))) | |
929 (throw 'exit nil)) | |
930 | |
931 (defsubst quail-delete-region () | |
932 "Delete the text in the current translation region of Quail." | |
933 (delete-region (overlay-start quail-overlay) (overlay-end quail-overlay))) | |
934 | |
935 (defun quail-select-current () | |
936 "Select the current text shown in Quail translation region." | |
937 (interactive) | |
938 (quail-terminate-translation)) | |
939 | |
940 ;; Update the current translation status according to CONTROL-FLAG. | |
941 ;; If CONTROL-FLAG is integer value, it is the number of keys in the | |
942 ;; head quail-current-key which can be translated. The remaining keys | |
943 ;; are put back to unread-command-events to be handled again. | |
944 ;; If CONTROL-FLAG is t, terminate the translation for the whole keys | |
945 ;; in quail-current-key. | |
946 ;; If CONTROL-FLAG is nil, proceed the translation with more keys. | |
947 | |
948 (defun quail-update-translation (control-flag) | |
949 (quail-delete-region) | |
950 (let ((func (quail-update-translation-function))) | |
951 (if func | |
952 (funcall func control-flag) | |
953 (if (numberp control-flag) | |
954 (let ((len (length quail-current-key))) | |
955 (while (> len control-flag) | |
956 (setq len (1- len)) | |
957 (setq unread-command-events | |
958 (cons (aref quail-current-key len) | |
959 unread-command-events))) | |
960 (insert (or quail-current-str | |
961 (substring quail-current-key 0 len)))) | |
962 (insert (or quail-current-str quail-current-key))))) | |
963 (quail-update-guidance) | |
964 (if control-flag | |
965 (quail-terminate-translation))) | |
966 | |
967 (defun quail-self-insert-command () | |
968 "Add the typed character to the key for translation." | |
969 (interactive "*") | |
970 (setq quail-current-key | |
971 (concat quail-current-key (char-to-string last-command-event))) | |
972 (quail-update-translation (quail-translate-key))) | |
973 | |
974 (defun quail-translate-key () | |
975 "Translate the current key sequence according to the current Quail map. | |
976 Return t if we can terminate the translation. | |
977 Return nil if the current key sequence may be followed by more keys. | |
978 Return number if we can't find any translation for the current key | |
979 sequence. The number is the count of valid keys in the current | |
980 sequence counting from the head." | |
981 (let* ((len (length quail-current-key)) | |
982 (map (quail-lookup-key quail-current-key len)) | |
983 def ch) | |
984 (if map | |
985 (let ((def (car map))) | |
986 (setq quail-current-str | |
987 (if (consp def) (aref (cdr def) (car def)) def)) | |
988 ;; Return t only if we can terminate the current translation. | |
989 (and | |
990 ;; No alternative translations. | |
991 (or (null (consp def)) (= (length (cdr def)) 1)) | |
992 ;; No translation for the longer key. | |
993 (null (cdr map)) | |
994 ;; No shorter breaking point. | |
995 (or (null (quail-maximum-shortest)) | |
996 (< len 3) | |
997 (null (quail-lookup-key quail-current-key (1- len))) | |
998 (null (quail-lookup-key | |
999 (substring quail-current-key -2 -1) 1))))) | |
1000 | |
1001 ;; There's no translation for the current key sequence. Before | |
1002 ;; giving up, we must check two possibilities. | |
1003 (cond ((and | |
1004 (quail-maximum-shortest) | |
1005 (>= len 4) | |
1006 (setq def (car (quail-lookup-key quail-current-key (- len 2)))) | |
1007 (quail-lookup-key (substring quail-current-key -2) 2)) | |
1008 ;; Now the sequence is "...ABCD", which can be split into | |
1009 ;; "...AB" and "CD..." to get valid translation. | |
1010 ;; At first, get translation of "...AB". | |
1011 (setq quail-current-str | |
1012 (if (consp def) (aref (cdr def) (car def)) def)) | |
1013 ;; Then, return the length of "...AB". | |
1014 (- len 2)) | |
1015 | |
1016 ((and quail-current-translations | |
1017 (not (quail-deterministic)) | |
1018 (setq ch (aref quail-current-key (1- len))) | |
1019 (>= ch ?0) (<= ch ?9)) | |
1020 ;; A numeric key is entered to select a desirable translation. | |
1021 (setq quail-current-key (substring quail-current-key 0 -1)) | |
1022 (quail-select-translation | |
1023 (+ (* (/ (car quail-current-translations) 10) 10) | |
1024 ;; We treat key 1,2..,9,0 as specifying 0,1,..8,9. | |
1025 (if (= ch ?0) 9 (- ch ?1)))) | |
1026 ;; And, we can terminate the current translation. | |
1027 t) | |
1028 | |
1029 (t | |
1030 ;; No way to handle the last character in this context. | |
1031 (1- len)))))) | |
1032 | |
1033 (defun quail-next-translation () | |
1034 "Select next translation in the current batch of candidates." | |
1035 (interactive) | |
1036 (if quail-current-translations | |
1037 (progn | |
1038 (quail-select-translation (1+ (car quail-current-translations))) | |
1039 (quail-update-translation nil)) | |
1040 (beep))) | |
1041 | |
1042 (defun quail-prev-translation () | |
1043 "Select previous translation in the current batch of candidates." | |
1044 (interactive) | |
1045 (if quail-current-translations | |
1046 (progn | |
1047 (quail-select-translation (1- (car quail-current-translations))) | |
1048 (quail-update-translation nil)) | |
1049 (beep))) | |
1050 | |
1051 (defun quail-next-translation-block () | |
1052 "Select the next batch of 10 translation candidates." | |
1053 (interactive) | |
1054 (if quail-current-translations | |
1055 (let ((limit (1- (length (cdr quail-current-translations)))) | |
1056 (n (car quail-current-translations))) | |
1057 (if (< (/ n 10) (/ limit 10)) | |
1058 (progn | |
1059 (quail-select-translation (min (+ n 10) limit)) | |
1060 (quail-update-translation nil)) | |
1061 ;; We are already at the last block. | |
1062 (beep))) | |
1063 (beep))) | |
1064 | |
1065 (defun quail-prev-translation-block () | |
1066 "Select the previous batch of 10 translation candidates." | |
1067 (interactive) | |
1068 (if (and quail-current-translations | |
1069 (>= (car quail-current-translations) 10)) | |
1070 (progn | |
1071 (quail-select-translation (- (car quail-current-translations) 10)) | |
1072 (quail-update-translation nil)) | |
1073 (beep))) | |
1074 | |
1075 (defun quail-select-translation (n) | |
1076 "Select Nth translation in the current batch of translation candidates." | |
1077 (if (or (< n 0) (>= n (length (cdr quail-current-translations)))) | |
1078 (beep) | |
1079 (setcar quail-current-translations n) | |
1080 (setq quail-current-str (aref (cdr quail-current-translations) n)))) | |
1081 | |
1082 (defun quail-abort-translation () | |
1083 "Abort translation and delete the current Quail key sequence." | |
1084 (interactive) | |
1085 (quail-delete-region) | |
1086 (quail-terminate-translation)) | |
1087 | |
1088 (defun quail-delete-last-char () | |
1089 "Delete the last input character from the current Quail key sequence." | |
1090 (interactive) | |
1091 (if (= (length quail-current-key) 1) | |
1092 (quail-abort-translation) | |
1093 (setq quail-current-key (substring quail-current-key 0 -1)) | |
1094 (quail-update-translation (quail-translate-key)))) | |
1095 | |
1096 ;; For conversion mode. | |
1097 | |
1098 (defun quail-conversion-backward-char () | |
1099 (interactive) | |
1100 (if (<= (point) (overlay-start quail-conv-overlay)) | |
1101 (error "Beginning of conversion region")) | |
1102 (forward-char -1)) | |
1103 | |
1104 (defun quail-conversion-forward-char () | |
1105 (interactive) | |
1106 (if (>= (point) (overlay-end quail-conv-overlay)) | |
1107 (error "End of conversion region")) | |
1108 (forward-char 1)) | |
1109 | |
1110 (defun quail-conversion-beginning-of-region () | |
1111 (interactive) | |
1112 (goto-char (overlay-start quail-conv-overlay))) | |
1113 | |
1114 (defun quail-conversion-end-of-region () | |
1115 (interactive) | |
1116 (goto-char (overlay-end quail-conv-overlay))) | |
1117 | |
1118 (defun quail-conversion-delete-char () | |
1119 (interactive) | |
1120 (if (>= (point) (overlay-end quail-conv-overlay)) | |
1121 (error "End of conversion region")) | |
1122 (delete-char 1) | |
1123 (if (= (overlay-start quail-conv-overlay) | |
1124 (overlay-end quail-conv-overlay)) | |
1125 (throw 'quail-tag nil))) | |
1126 | |
1127 (defun quail-conversion-backward-delete-char () | |
1128 (interactive) | |
1129 (if (<= (point) (overlay-start quail-conv-overlay)) | |
1130 (error "Beginning of conversion region")) | |
1131 (delete-char -1) | |
1132 (if (= (overlay-start quail-conv-overlay) | |
1133 (overlay-end quail-conv-overlay)) | |
1134 (throw 'quail-tag nil))) | |
1135 | |
1136 (defun quail-do-conversion (func &rest args) | |
1137 "Call FUNC to convert text in the current conversion region of Quail. | |
1138 Remaining args are for FUNC." | |
1139 (delete-overlay quail-overlay) | |
1140 (apply func args)) | |
1141 | |
1142 (defun quail-no-conversion () | |
1143 "Do no conversion of the current conversion region of Quail." | |
1144 (interactive) | |
1145 (throw 'exit nil)) | |
1146 | |
1147 ;; Guidance, Completion, and Help buffer handlers. | |
1148 | |
1149 (defun quail-show-guidance-buf () | |
1150 "Display a Quail guidance buffer in some window. | |
1151 Create the buffer if it does not exist yet. | |
1152 The window is normally shown in a minibuffer, | |
1153 but if the selected window is a minibuffer, it is shown in | |
1154 the bottommost ordinary window." | |
1155 | |
1156 (if (or (null input-method-tersely-flag) | |
1157 (not (eq (selected-window) (minibuffer-window)))) | |
1158 (progn | |
1159 ;; At first, setup a guidance buffer. | |
1160 (or (buffer-live-p quail-guidance-buf) | |
1161 (setq quail-guidance-buf | |
1162 (get-buffer-create " *Quail-guidance*"))) | |
1163 (save-excursion | |
1164 (let ((title (quail-title))) | |
1165 (set-buffer quail-guidance-buf) | |
1166 ;; Show the title of Quail package in the left of mode-line. | |
1167 (setq current-input-method nil) | |
1168 (setq current-input-method-title title) | |
1169 (setq mode-line-format (cons '("[" current-input-method-title "]") | |
1170 default-mode-line-format)) | |
1171 (erase-buffer) | |
1172 (or (overlayp quail-overlay) | |
1173 (progn | |
1174 (setq quail-overlay (make-overlay 1 1)) | |
1175 (overlay-put quail-overlay 'face 'highlight))) | |
1176 (delete-overlay quail-overlay) | |
1177 (set-buffer-modified-p nil))) | |
1178 (bury-buffer quail-guidance-buf) | |
1179 | |
1180 ;; Then, display it in an appropriate window. | |
1181 (if (not (get-buffer-window quail-guidance-buf)) | |
1182 ;; Guidance buffer is not yet shown in any window. | |
1183 (let ((win (minibuffer-window))) | |
1184 (if (eq (selected-window) win) | |
1185 ;; Since we are in minibuffer, we can't use it for guidance. | |
1186 ;; Let's find the bottom window. | |
1187 (let (height) | |
1188 (setq win (window-at 0 (- (frame-height) 2))) | |
1189 (setq height (window-height win)) | |
1190 ;; If WIN is too tall, split it vertically and use | |
1191 ;; the lower one. | |
1192 (if (>= height 4) | |
1193 (let ((window-min-height 2)) | |
1194 ;; Here, `split-window' returns a lower window | |
1195 ;; which is what we wanted. | |
1196 (setq win (split-window win (- height 2))))) | |
1197 (set-window-buffer win quail-guidance-buf) | |
1198 (set-window-dedicated-p win t)) | |
1199 (set-window-buffer win quail-guidance-buf)))))) | |
1200 | |
1201 ;; And, create a buffer for completion. | |
1202 (or (buffer-live-p quail-completion-buf) | |
1203 (progn | |
1204 (setq quail-completion-buf (get-buffer-create "*Quail Completions*")) | |
1205 (save-excursion | |
1206 (set-buffer quail-completion-buf) | |
1207 (setq quail-overlay (make-overlay 1 1)) | |
1208 (overlay-put quail-overlay 'face 'highlight)))) | |
1209 (bury-buffer quail-completion-buf)) | |
1210 | |
1211 (defun quail-hide-guidance-buf () | |
1212 "Hide the Quail guidance buffer." | |
1213 (let* ((win (minibuffer-window)) | |
1214 (buf (window-buffer win))) | |
1215 (if (eq buf quail-guidance-buf) | |
1216 ;; Quail guidance buffer is at echo area. Vacate it to the | |
1217 ;; deepest minibuffer. | |
1218 (set-window-buffer win (format " *Minibuf-%d*" (minibuffer-depth))) | |
1219 ;; Delete the window for guidance buffer. | |
1220 (if (or (null input-method-tersely-flag) | |
1221 (not (eq (selected-window) (minibuffer-window)))) | |
1222 (progn | |
1223 (setq win (get-buffer-window quail-guidance-buf)) | |
1224 (set-window-dedicated-p win nil) | |
1225 (delete-window win)))))) | |
1226 | |
1227 (defun quail-update-guidance () | |
1228 "Update the Quail guidance buffer and completion buffer (if displayed now)." | |
1229 ;; Update guidance buffer. | |
1230 (if (or (null input-method-tersely-flag) | |
1231 (not (eq (selected-window) (minibuffer-window)))) | |
1232 (let ((guidance (quail-guidance))) | |
1233 (cond ((eq guidance t) | |
1234 ;; Show the current possible translations. | |
1235 (quail-show-translations)) | |
1236 ((null guidance) | |
1237 ;; Show the current input keys. | |
1238 (let ((key quail-current-key)) | |
1239 (save-excursion | |
1240 (set-buffer quail-guidance-buf) | |
1241 (erase-buffer) | |
1242 (insert key)))) | |
1243 ((listp guidance) | |
1244 ;; Show alternative characters specified in this alist. | |
1245 (let* ((key quail-current-key) | |
1246 (len (length key)) | |
1247 (i 0) | |
1248 ch alternative) | |
1249 (save-excursion | |
1250 (set-buffer quail-guidance-buf) | |
1251 (erase-buffer) | |
1252 (while (< i len) | |
1253 (setq ch (aref key i)) | |
1254 (setq alternative (cdr (assoc ch guidance))) | |
1255 (insert (or alternative ch)) | |
1256 (setq i (1+ i))))))))) | |
1257 | |
1258 ;; Update completion buffer if displayed now. We highlight the | |
1259 ;; selected candidate string in *Completion* buffer if any. | |
1260 (let ((win (get-buffer-window quail-completion-buf)) | |
1261 key str pos) | |
1262 (if win | |
1263 (save-excursion | |
1264 (setq str (if (stringp quail-current-str) | |
1265 quail-current-str | |
1266 (if (numberp quail-current-str) | |
1267 (char-to-string quail-current-str))) | |
1268 key quail-current-key) | |
1269 (set-buffer quail-completion-buf) | |
1270 (goto-char (point-min)) | |
1271 (if (null (search-forward (concat " " key ":") nil t)) | |
1272 (delete-overlay quail-overlay) | |
1273 (setq pos (point)) | |
1274 (if (and str (search-forward (concat "." str) nil t)) | |
1275 (move-overlay quail-overlay (1+ (match-beginning 0)) (point)) | |
1276 (move-overlay quail-overlay (match-beginning 0) (point))) | |
1277 ;; Now POS points end of KEY and (point) points end of STR. | |
1278 (if (pos-visible-in-window-p (point) win) | |
1279 ;; STR is already visible. | |
1280 nil | |
1281 ;; We want to make both KEY and STR visible, but if the | |
1282 ;; window is too short, make at least STR visible. | |
1283 (setq pos (progn (point) (goto-char pos))) | |
1284 (beginning-of-line) | |
1285 (set-window-start win (point)) | |
1286 (if (not (pos-visible-in-window-p pos win)) | |
1287 (set-window-start win pos)) | |
1288 )))))) | |
1289 | |
1290 (defun quail-show-translations () | |
1291 "Show the current possible translations." | |
1292 (let ((key quail-current-key) | |
1293 (map (quail-lookup-key quail-current-key (length quail-current-key)))) | |
1294 (save-excursion | |
1295 (set-buffer quail-guidance-buf) | |
1296 (erase-buffer) | |
1297 | |
1298 ;; Show the current key. | |
1299 (insert key) | |
1300 | |
1301 ;; Show possible following keys. | |
1302 (if (cdr map) | |
1303 (let ((l (cdr map))) | |
1304 (insert "[") | |
1305 (while l | |
1306 (insert (car (car l))) | |
1307 (setq l (cdr l))) | |
1308 (insert "]"))) | |
1309 | |
1310 ;; Show list of translations. | |
1311 (if (consp (car map)) | |
1312 (let* ((idx (car (car map))) | |
1313 (translations (cdr (car map))) | |
1314 (from (* (/ idx 10) 10)) | |
1315 (to (min (+ from 10) (length translations)))) | |
1316 (indent-to 10) | |
1317 (insert (format "(%d/%d)" | |
1318 (1+ (/ from 10)) | |
1319 (1+ (/ (length translations) 10)))) | |
1320 (while (< from to) | |
1321 ;; We show the last digit of FROM, but by changing | |
1322 ;; 0,1,..,9 to 1,2,..,0. | |
1323 (insert (format " %d." | |
1324 (if (= (% from 10) 9) 0 (1+ (% from 10))))) | |
1325 (let ((pos (point))) | |
1326 (insert (aref translations from)) | |
1327 (if (= idx from) | |
1328 (move-overlay quail-overlay pos (point)))) | |
1329 (setq from (1+ from))))) | |
1330 ))) | |
1331 | |
1332 (defun quail-completion () | |
1333 "List all completions for the current key. | |
1334 All possible translations of the current key and whole possible longer keys | |
1335 are shown." | |
1336 (interactive) | |
1337 (let ((key quail-current-key) | |
1338 (map (quail-lookup-key quail-current-key (length quail-current-key)))) | |
1339 (save-excursion | |
1340 (set-buffer quail-completion-buf) | |
1341 (erase-buffer) | |
1342 (insert "Possible completion and corresponding translations are:\n") | |
1343 (quail-completion-1 key map 1) | |
1344 (goto-char (point-min)) | |
1345 (display-buffer (current-buffer))) | |
1346 (quail-update-guidance))) | |
1347 | |
1348 ;; List all completions of KEY in MAP with indentation INDENT. | |
1349 (defun quail-completion-1 (key map indent) | |
1350 (let ((len (length key))) | |
1351 (indent-to indent) | |
1352 (insert key ":") | |
1353 (if (and (symbolp map) (fboundp map)) | |
1354 (setq map (funcall map key len))) | |
1355 (if (car map) | |
1356 (quail-completion-list-translations map key (+ indent len 1)) | |
1357 (insert " -\n")) | |
1358 (setq indent (+ indent 2)) | |
1359 (if (cdr map) | |
1360 (let ((l (cdr map)) | |
1361 (newkey (make-string (1+ len) 0)) | |
1362 (i 0)) | |
1363 ;; Set KEY in the first LEN characters of NEWKEY. | |
1364 (while (< i len) | |
1365 (aset newkey i (aref key i)) | |
1366 (setq i (1+ i))) | |
1367 (while l ; L = ((CHAR . DEFN) ....) ; | |
1368 (aset newkey len (car (car l))) | |
1369 (quail-completion-1 newkey (cdr (car l)) indent) | |
1370 (setq l (cdr l))))))) | |
1371 | |
1372 ;; List all possible translations of KEY in Quail map MAP with | |
1373 ;; indentation INDENT." | |
1374 (defun quail-completion-list-translations (map key indent) | |
1375 (let ((translations | |
1376 (quail-get-translation map key (length key)))) | |
1377 (if (integerp translations) | |
1378 (insert "(1/1) 1." translations "\n") | |
1379 ;; We need only vector part. | |
1380 (setq translations (cdr translations)) | |
1381 ;; Insert every 10 elements with indices in a line. | |
1382 (let ((len (length translations)) | |
1383 (i 0) | |
1384 (first t) | |
1385 num) | |
1386 (while (< i len) | |
1387 (if first | |
1388 (progn | |
1389 (insert "(1/1)") | |
1390 (setq first nil)) | |
1391 (if (= (% i 10) 0) | |
1392 (progn | |
1393 (newline) | |
1394 (indent-to indent) | |
1395 (insert (format "(%d/%d)" (1+ (/ i 10)) (1+ (/ len 10))))))) | |
1396 ;; We show the last digit of FROM while converting | |
1397 ;; 0,1,..,9 to 1,2,..,0. | |
1398 (insert (format " %d." (if (= (% i 10) 9) 0 (1+ (% i 10))))) | |
1399 (insert (aref translations i)) | |
1400 (setq i (1+ i))) | |
1401 (newline))))) | |
1402 | |
1403 (defun quail-help () | |
1404 "Show brief description of the current Quail package." | |
1405 (interactive) | |
1406 (let ((package quail-current-package) | |
1407 (buf (get-buffer-create "*Quail-help*"))) | |
1408 (save-excursion | |
1409 (set-buffer buf) | |
1410 (erase-buffer) | |
1411 (setq quail-current-package package) | |
1412 (insert "Quail input method (name:" | |
1413 (quail-name) | |
1414 ", mode line indicator:[" | |
1415 (quail-title) | |
1416 "])\n---- Documentation ----\n" | |
1417 (quail-docstring)) | |
1418 (newline) | |
1419 (if (quail-show-layout) (quail-show-kbd-layout)) | |
1420 (insert ) | |
1421 (quail-help-insert-keymap-description | |
1422 quail-mode-map | |
1423 "---- Key bindings (before starting translation) ---- | |
1424 key binding | |
1425 --- -------\n") | |
1426 (quail-help-insert-keymap-description | |
1427 (quail-translation-keymap) | |
1428 "--- Key bindings (while translating) --- | |
1429 key binding | |
1430 --- -------\n") | |
1431 (if (quail-conversion-keymap) | |
1432 (quail-help-insert-keymap-description | |
1433 (quail-conversion-keymap) | |
1434 "--- Key bindings (while converting) --- | |
1435 key binding | |
1436 --- -------\n")) | |
1437 (goto-char (point-min)) | |
1438 (set-buffer-modified-p nil) | |
1439 (help-mode)) | |
1440 (display-buffer buf))) | |
1441 | |
1442 (defun quail-help-insert-keymap-description (keymap &optional header) | |
1443 (let (from to) | |
1444 (if header | |
1445 (insert header)) | |
1446 (save-excursion | |
1447 (save-window-excursion | |
1448 (let ((overriding-local-map keymap)) | |
1449 (describe-bindings)) | |
1450 (set-buffer "*Help*") | |
1451 (goto-char (point-min)) | |
1452 (forward-line 4) | |
1453 (setq from (point)) | |
1454 (search-forward "Global Bindings:" nil 'move) | |
1455 (beginning-of-line) | |
1456 (setq to (point)))) | |
1457 (insert-buffer-substring "*Help*" from to))) | |
1458 | |
1459 (defun quail-show-kbd-layout () | |
1460 "Show keyboard layout with key tops of multilingual characters." | |
1461 (insert "--- Keyboard layout ---\n") | |
1462 (let* ((i 0) ch) | |
1463 (while (< i quail-keyboard-layout-len) | |
1464 (if (= (% i 30) 0) | |
1465 (progn | |
1466 (newline) | |
1467 (indent-to (/ i 30))) | |
1468 (if (= (% i 2) 0) | |
1469 (insert " "))) | |
1470 (setq ch (aref quail-keyboard-layout i)) | |
1471 (if (= ch ?\ ) | |
1472 (insert ch) | |
17095
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1473 (let* ((map (cdr (assq ch (cdr (quail-map))))) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1474 (translation (and map (quail-get-translation |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1475 map (char-to-string ch) 1)))) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1476 (if (integerp translation) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1477 (insert translation) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1478 (if (consp translation) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1479 (insert (aref (cdr translation) (car translation))) |
b57415dcc114
Add quail-mode to default value of
Kenichi Handa <handa@m17n.org>
parents:
17071
diff
changeset
|
1480 (insert ch))))) |
17052 | 1481 (setq i (1+ i)))) |
1482 (newline)) | |
1483 | |
1484 (defun quail-translation-help () | |
1485 "Show help message while translating in Quail mode." | |
1486 (interactive) | |
1487 (let ((package quail-current-package) | |
1488 (current-key quail-current-key) | |
1489 (buf (get-buffer-create "*Quail-Help*"))) | |
1490 (save-excursion | |
1491 (set-buffer buf) | |
1492 (erase-buffer) | |
1493 (setq quail-current-package package) | |
1494 (insert | |
1495 (format "You are translating the key sequence \"%s\" in Quail mode.\n" | |
1496 quail-current-key)) | |
1497 (quail-help-insert-keymap-description | |
1498 (quail-translation-keymap) | |
1499 "----------------------- | |
1500 key binding | |
1501 --- -------\n") | |
1502 (goto-char (point-min)) | |
1503 (set-buffer-modified-p nil)) | |
1504 (display-buffer buf))) | |
1505 | |
1506 (defun quail-conversion-help () | |
1507 "Show help message while converting in Quail mode." | |
1508 (interactive) | |
1509 (let ((package quail-current-package) | |
1510 (str (buffer-substring (overlay-start quail-conv-overlay) | |
1511 (overlay-end quail-conv-overlay))) | |
1512 (buf (get-buffer-create "*Quail-Help*"))) | |
1513 (save-excursion | |
1514 (set-buffer buf) | |
1515 (erase-buffer) | |
1516 (setq quail-current-package package) | |
1517 (insert | |
1518 (format "You are converting the string \"%s\" in Quail mode.\n" str)) | |
1519 (quail-help-insert-keymap-description | |
1520 (quail-conversion-keymap) | |
1521 "----------------------- | |
1522 key binding | |
1523 --- -------\n") | |
1524 (goto-char (point-min)) | |
1525 (set-buffer-modified-p nil)) | |
1526 (display-buffer buf))) | |
1527 | |
1528 ;; | |
1529 (provide 'quail) | |
1530 | |
1531 ;;; quail.el ends here |