1 ;;; encoded-kb.el --- handler to input multibyte characters encoded somehow
3 ;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
5 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6 ;; 2005, 2006, 2007, 2008, 2009
7 ;; National Institute of Advanced Industrial Science and Technology (AIST)
8 ;; Registration Number H14PRO021
10 ;; National Institute of Advanced Industrial Science and Technology (AIST)
11 ;; Registration Number H13PRO009
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;; Usually this map is empty (even if Encoded-kbd mode is on), but if
33 ;; the keyboard coding system is iso-2022-based, it defines dummy key
34 ;; bindings for ESC $ ..., etc. so that those bindings in
35 ;; input-decode-map take effect.
36 (defconst encoded-kbd-mode-map
(make-sparse-keymap)
37 "Keymap for Encoded-kbd minor mode.")
39 ;; Subsidiary keymaps for handling ISO2022 escape sequences.
41 (defvar encoded-kbd-iso2022-esc-map
42 (let ((map (make-sparse-keymap)))
43 (define-key map
"$" 'encoded-kbd-iso2022-esc-dollar-prefix
)
44 (define-key map
"(" 'encoded-kbd-iso2022-designation-prefix
)
45 (define-key map
")" 'encoded-kbd-iso2022-designation-prefix
)
46 (define-key map
"," 'encoded-kbd-iso2022-designation-prefix
)
47 (define-key map
"-" 'encoded-kbd-iso2022-designation-prefix
)
49 "Keymap for handling ESC code in Encoded-kbd mode.")
50 (fset 'encoded-kbd-iso2022-esc-prefix encoded-kbd-iso2022-esc-map
)
52 (defvar encoded-kbd-iso2022-esc-dollar-map
53 (let ((map (make-sparse-keymap)))
54 (define-key map
"(" 'encoded-kbd-iso2022-designation-prefix
)
55 (define-key map
")" 'encoded-kbd-iso2022-designation-prefix
)
56 (define-key map
"," 'encoded-kbd-iso2022-designation-prefix
)
57 (define-key map
"-" 'encoded-kbd-iso2022-designation-prefix
)
58 (define-key map
"@" 'encoded-kbd-iso2022-designation
)
59 (define-key map
"A" 'encoded-kbd-iso2022-designation
)
60 (define-key map
"B" 'encoded-kbd-iso2022-designation
)
62 "Keymap for handling ESC $ sequence in Encoded-kbd mode.")
63 (fset 'encoded-kbd-iso2022-esc-dollar-prefix
64 encoded-kbd-iso2022-esc-dollar-map
)
66 (defvar encoded-kbd-iso2022-designation-map
67 (let ((map (make-sparse-keymap))
71 (setq final-char
(charset-iso-final-char (car l
)))
73 (define-key map
(char-to-string final-char
)
74 'encoded-kbd-iso2022-designation
))
77 "Keymap for handling ISO2022 designation sequence in Encoded-kbd mode.")
78 (fset 'encoded-kbd-iso2022-designation-prefix
79 encoded-kbd-iso2022-designation-map
)
81 ;; Keep information of designation state of ISO2022 encoding. When
82 ;; Encoded-kbd mode is on, this is set to a vector of length 4, the
83 ;; elements are character sets currently designated to graphic
84 ;; registers 0 thru 3.
86 (defvar encoded-kbd-iso2022-designations nil
)
87 (put 'encoded-kbd-iso2022-designations
'permanent-local t
)
89 ;; Keep information of invocation state of ISO2022 encoding. When
90 ;; Encoded-kbd mode is on, this is set to a vector of length 3,
91 ;; graphic register numbers currently invoked to graphic plane 1 and
92 ;; 2, and a single shifted graphic register number.
94 (defvar encoded-kbd-iso2022-invocations nil
)
95 (put 'encoded-kbd-iso2022-invocations
'permanent-local t
)
97 (defsubst encoded-kbd-last-key
()
98 (let ((keys (this-single-command-keys)))
99 (aref keys
(1- (length keys
)))))
101 (defun encoded-kbd-iso2022-designation (ignore)
102 "Do ISO2022 designation according to the current key in Encoded-kbd mode.
103 The following key sequence may cause multilingual text insertion."
104 (let ((key-seq (this-single-command-keys))
105 (prev-g0-charset (aref encoded-kbd-iso2022-designations
106 (aref encoded-kbd-iso2022-invocations
0)))
107 intermediate-char final-char
108 reg dimension chars charset
)
109 (if (= (length key-seq
) 4)
110 ;; ESC $ <intermediate-char> <final-char>
111 (setq intermediate-char
(aref key-seq
2)
113 chars
(if (< intermediate-char ?
,) 94 96)
114 final-char
(aref key-seq
3)
115 reg
(mod intermediate-char
4))
116 (if (= (aref key-seq
1) ?$
)
117 ;; ESC $ <final-char>
120 final-char
(aref key-seq
2)
122 ;; ESC <intermediate-char> <final-char>
123 (setq intermediate-char
(aref key-seq
1)
125 chars
(if (< intermediate-char ?
,) 94 96)
126 final-char
(aref key-seq
2)
127 reg
(mod intermediate-char
4))))
128 (aset encoded-kbd-iso2022-designations reg
129 (iso-charset dimension chars final-char
)))
132 (defun encoded-kbd-iso2022-single-shift (ignore)
133 (let ((char (encoded-kbd-last-key)))
134 (aset encoded-kbd-iso2022-invocations
2 (if (= char ?
\216) 2 3)))
137 (defun encoded-kbd-self-insert-iso2022-7bit (ignore)
138 (let ((char (encoded-kbd-last-key))
139 (charset (aref encoded-kbd-iso2022-designations
140 (or (aref encoded-kbd-iso2022-invocations
2)
141 (aref encoded-kbd-iso2022-invocations
0)))))
142 (aset encoded-kbd-iso2022-invocations
2 nil
)
143 (vector (if (= (charset-dimension charset
) 1)
144 (make-char charset char
)
145 (make-char charset char
(read-char-exclusive))))))
147 (defun encoded-kbd-self-insert-iso2022-8bit (ignore)
148 (let ((char (encoded-kbd-last-key))
149 (charset (aref encoded-kbd-iso2022-designations
150 (or (aref encoded-kbd-iso2022-invocations
2)
151 (aref encoded-kbd-iso2022-invocations
1)))))
152 (aset encoded-kbd-iso2022-invocations
2 nil
)
153 (vector (if (= (charset-dimension charset
) 1)
154 (make-char charset char
)
155 (make-char charset char
(read-char-exclusive))))))
157 (defun encoded-kbd-self-insert-sjis (ignore)
158 (let ((char (encoded-kbd-last-key)))
160 (if (or (< char ?
\xA0) (>= char ?
\xE0))
161 (decode-sjis-char (+ (ash char
8) (read-char-exclusive)))
162 (make-char 'katakana-jisx0201 char
)))))
164 (defun encoded-kbd-self-insert-big5 (ignore)
165 (let ((char (encoded-kbd-last-key)))
167 (decode-big5-char (+ (ash char
8) (read-char-exclusive))))))
169 (defun encoded-kbd-self-insert-ccl (ignore)
170 (let ((str (char-to-string (encoded-kbd-last-key)))
171 (ccl (coding-system-get (keyboard-coding-system) :ccl-decoder
))
172 (vec [nil nil nil nil nil nil nil nil nil
])
174 (while (= (length (setq result
(ccl-execute-on-string ccl vec str t
))) 0)
175 (dotimes (i 9) (aset vec i nil
))
176 (setq str
(format "%s%c" str
(read-char-exclusive))))
177 (vector (aref result
0))))
180 ;; Decode list of codes in CODE-LIST by CHARSET and return the decoded
181 ;; characters. If CODE-LIST is too short for the dimension of
182 ;; CHARSET, read new codes and append them to the tail of CODE-LIST.
183 ;; Return nil if CODE-LIST can't be decoded.
185 (defun encoded-kbd-decode-code-list (charset code-list
)
186 (let ((dimension (charset-dimension charset
))
188 (while (> dimension
(length code-list
))
189 (nconc code-list
(list (read-char-exclusive))))
190 (setq code
(car code-list
))
192 (decode-char charset code
)
193 (setq code-list
(cdr code-list
)
194 code
(logior (lsh code
8) (car code-list
)))
196 (decode-char charset code
)
197 (setq code-list
(cdr code-list
)
198 code
(logior (lsh code
8) (car code-list
)))
200 (decode-char charset code
)
201 ;; As Emacs can't handle full 32-bit integer, we must give a
202 ;; cons of higher and lower 16-bit codes to decode-char.
203 (setq code
(cons (lsh code -
8)
204 (logior (lsh (car code-list
) 8) (cadr code-list
))))
205 (decode-char charset code
))))))
207 (defun encoded-kbd-self-insert-charset (ignore)
209 (coding-system-get (keyboard-coding-system) :charset-list
))
210 (code-list (list (encoded-kbd-last-key)))
212 (while (and charset-list
(not char
))
213 (setq char
(encoded-kbd-decode-code-list (car charset-list
) code-list
)
214 charset-list
(cdr charset-list
)))
217 (setq unread-command-events
(cdr code-list
))
218 (vector (car code-list
)))))
220 (defun encoded-kbd-self-insert-utf-8 (arg)
222 (let* ((lead (encoded-kbd-last-key))
226 (setq len
1 char
(logand char
#x1F
)))
228 (setq len
2 char
(logand char
#x0F
)))
230 (setq len
3 char
(logand char
#x07
)))
232 (setq len
4 char
0)))
234 (setq event
(read-char-exclusive))
235 (if (and (>= event
#x80
) (< event
#xc0
))
236 ;; Valid utf-8 sequence.
237 (setq char
(logior (lsh char
6) (- event
#x80
))
239 ;; Invalid utf-8 sequence. Might be because Quail got involved
240 ;; in-between and the bytes we thought we were reading were actually
241 ;; latin-1 chars. Let's presume that `event' is the second "byte",
242 ;; i.e. there weren't any "apprently correct" between `lead' and
243 ;; `event': it's easy to recover in this case, and the more general
244 ;; case seems pretty unlikely.
245 ;; FIXME: We should really do encoded-kbd decoding before processing
247 (push event unread-command-events
)
252 (defun encoded-kbd-setup-keymap (keymap coding
)
253 ;; At first, reset the keymap.
254 (define-key encoded-kbd-mode-map
"\e" nil
)
255 ;; Then setup the keymap according to the keyboard coding system.
257 ((eq (coding-system-type coding
) 'shift-jis
)
261 (vector i
) 'encoded-kbd-self-insert-sjis
)
265 ((eq (coding-system-type coding
) 'charset
)
268 (let ((dim (charset-dimension x
))
269 (code-space (get-charset-property x
:code-space
)))
270 (cons (aref code-space
(* (1- dim
) 2))
271 (aref code-space
(1+ (* (1- dim
) 2))))))
272 (coding-system-get coding
:charset-list
)))
273 (let ((from (max (car elt
) 128))
277 (vector from
) 'encoded-kbd-self-insert-charset
)
278 (setq from
(1+ from
)))))
281 ((eq (coding-system-type coding
) 'iso-2022
)
282 (let ((flags (coding-system-get coding
:flags
))
283 (designation (coding-system-get coding
:designation
)))
284 (if (memq 'locking-shift flags
)
285 nil
; Don't support locking-shift.
286 (setq encoded-kbd-iso2022-designations
(make-vector 4 nil
)
287 encoded-kbd-iso2022-invocations
(make-vector 3 nil
))
289 (if (aref designation i
)
290 (if (charsetp (aref designation i
))
291 (aset encoded-kbd-iso2022-designations
292 i
(aref designation i
))
293 (if (charsetp (car-safe (aref designation i
)))
294 (aset encoded-kbd-iso2022-designations
295 i
(car (aref designation i
)))))))
296 (aset encoded-kbd-iso2022-invocations
0 0)
297 (if (aref encoded-kbd-iso2022-designations
1)
298 (aset encoded-kbd-iso2022-invocations
1 1))
299 (when (memq 'designation flags
)
300 (define-key encoded-kbd-mode-map
"\e" 'encoded-kbd-iso2022-esc-prefix
)
301 (define-key keymap
"\e" 'encoded-kbd-iso2022-esc-prefix
))
302 (when (or (aref designation
2) (aref designation
3))
304 [?
\216] 'encoded-kbd-iso2022-single-shift
)
306 [?
\217] 'encoded-kbd-iso2022-single-shift
))
307 (or (eq (aref designation
0) 'ascii
)
310 (vector (+ 32 i
)) 'encoded-kbd-self-insert-iso2022-7bit
)))
311 (if (memq '7-bit flags
)
315 (vector (+ 160 i
)) 'encoded-kbd-self-insert-iso2022-8bit
))
318 ((eq (coding-system-type coding
) 4) ; CCL-base
319 (let ((valid-codes (or (coding-system-get coding
:valid
)
323 (setq elt
(car valid-codes
) valid-codes
(cdr valid-codes
))
325 (setq from
(car elt
) to
(cdr elt
))
326 (setq from
(setq to elt
)))
330 (vector from
) 'encoded-kbd-self-insert-ccl
))
331 (setq from
(1+ from
))))
334 ((eq (coding-system-type coding
) 'utf-8
)
338 (vector i
) 'encoded-kbd-self-insert-utf-8
)
346 (defun encoded-kbd-setup-display (display)
347 "Set up a `input-decode-map' for `keyboard-coding-system' on DISPLAY.
349 DISPLAY may be a display id, a frame, or nil for the selected frame's display."
350 (let ((frame (if (framep display
) display
(car (frames-on-display-list display
)))))
352 (with-selected-frame frame
353 ;; Remove any previous encoded-kb keymap from input-decode-map.
354 (let ((m input-decode-map
)
357 (if (not (equal (keymap-prompt m
) "encoded-kb"))
360 (setq m
(keymap-parent m
)))
361 ;; We've found an encoded-kb map, but maybe the prompt we get
362 ;; is really inherited from the encoded-kb map.
364 (while (and (keymapp (setq mp
(keymap-parent m
)))
365 (equal (keymap-prompt mp
) "encoded-kb"))
368 ;; (assert (equal (keymap-prompt m) "encoded-kb"))
369 ;; (assert (eq mp (keymap-parent m)))
370 ;; (assert (not (and (keymapp mp)
371 ;; (equal (keymap-prompt mp) "encoded-kb"))))
372 ;; (assert (eq m (if child
373 ;; (keymap-parent child) input-decode-map)))
374 ;; We can finally do the actual removal.
376 (set-keymap-parent child mp
)
377 (setq input-decode-map mp
))
380 (if (keyboard-coding-system)
381 ;; We are turning on Encoded-kbd mode.
382 (let ((coding (keyboard-coding-system))
383 (keymap (make-sparse-keymap "encoded-kb"))
384 (cim (current-input-mode))
386 ;; Place `keymap' as the immediate parent of input-decode-map
387 ;; rather than on top, so that later `define-key' on
388 ;; input-decode-map don't end up accidentally changing our
389 ;; part of the keymap, which would lead to bugs when/if we later
390 ;; on remove that part.
391 (set-keymap-parent keymap
(keymap-parent input-decode-map
))
392 (set-keymap-parent input-decode-map keymap
)
393 (unless (terminal-parameter nil
'encoded-kbd-saved-input-meta-mode
)
394 (set-terminal-parameter nil
'encoded-kbd-saved-input-mode
396 (setq result
(and coding
(encoded-kbd-setup-keymap keymap coding
)))
398 (when (and (eq result
8)
399 (memq (nth 2 cim
) '(t nil
)))
400 (set-input-meta-mode 'use-8th-bit
))
401 (set-terminal-parameter
402 nil
'encoded-kbd-saved-input-meta-mode nil
)
403 (error "Unsupported coding system in Encoded-kbd mode: %S"
405 ;; We are turning off Encoded-kbd mode.
406 (let ((old (terminal-parameter nil
'encoded-kbd-saved-input-meta-mode
)))
407 (when (and old
(not (equal (nth 2 (current-input-mode)) old
)))
408 (set-input-meta-mode old
))
409 (set-terminal-parameter
410 nil
'encoded-kbd-saved-input-meta-mode nil
))))))
412 (provide 'encoded-kb
)
414 ;; arch-tag: 76f0f9b3-65e7-45c3-b692-59509a87ad44
415 ;;; encoded-kb.el ends here