(U+5B67): Add `total-strokes'.
[chise/xemacs-chise.git.1] / lisp / x-win-sun.el
1 ;;; x-win-sun.el --- runtime initialization for Sun X servers and keyboards
2 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
3
4 ;; Authors: jwz, ben, martin
5 ;; Keywords: terminals
6
7 ;; This file is part of XEmacs.
8
9 ;; XEmacs is free software; you can redistribute it and/or modify it
10 ;; under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; XEmacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 ;; General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with XEmacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Commentary:
25
26 ;; This file is loaded by x-win.el at run-time when we are sure that XEmacs
27 ;; is running on the display of a Sun.
28
29 ;; The Sun X server (both the MIT and OpenWindows varieties) have extremely
30 ;; stupid names for their keypad and function keys.  For example, the key
31 ;; labeled 3 / PgDn, with R15 written on the front, is actually called F35.
32
33 ;; There are 3 methods of dealing with the Sun key brokenness:
34 ;;
35 ;; - Use xmodmap to give all keys more sensible names for all apps:
36 ;;   I use this shell script:
37 ;;
38 ;;   for i in 0 1 2 3 4 5 6 7 8 9 Add Subtract Multiply Divide Decimal ; do
39 ;;     echo "keysym KP-$i = KP-$i"
40 ;;   done | xmodmap
41 ;;
42 ;;   Clearly, as a good X11 citizen, we can't do this.
43 ;;
44 ;; - Use keyboard-translate-table to remap the keybindings at a low level.
45 ;;   This approach is taken in the function `sun-x11-keyboard-translate'.
46 ;;   This is like running xmodmap within XEmacs only.
47 ;;   This is not the default, however, so that legacy keybindings in users'
48 ;;   .emacs files like (global-set-key [(f35)] 'foo) continue to work
49 ;;
50 ;; - Use keyboard macros to provide indirection for keybindings.
51 ;;   If we do (global-set-key [(f35)] [(kp-3)]), then the user's keybindings
52 ;;   work whether he uses `f35' or `kp-3'.
53 ;;   This is also compatible with FSF Emacs and other X11 apps.
54 ;;   Although this has the disadvantage that these remappings
55 ;;   only work with the global key map, we use this as the default.
56 ;;
57 ;; - The Right Way to do this remains to be written...
58
59 ;; OK, here's another try at doing things the right way.
60
61 ;; We use function-key-map, which honors explicit key-bindings for the
62 ;; stupid Sun names, but also allows indirection if no explicit
63 ;; key-binding exists.
64
65 ;;; Code:
66
67 ;;;###autoload
68 (defun x-win-init-sun ()
69
70   ;; help is ok
71   ;; num_lock is ok
72   ;; up is ok
73   ;; left is ok
74   ;; right is ok
75   ;; kp-add is ok
76   ;; down is ok
77   ;; insert is ok
78   ;; delete is ok
79   ;; kp-enter is ok
80   ;; Sun Function keys
81   (loop for (from-key to-key) in
82     `((f21 pause)
83       (f22 print)
84       (f23 scroll_lock)
85
86       ;; X11 R6 mappings
87       (SunProps props)
88       (SunFront front)
89       (SunOpen  open)
90       (SunFind  find)
91       (cancel   stop)
92       (Undo     undo)
93       (SunCopy  copy)
94       (SunPaste paste)
95       (SunCut   cut)
96
97       (f13 props)
98       (f14 undo)
99       (f15 front)
100       (f16 copy)
101       (f17 open)
102       (f18 paste)
103       (f19 find)
104       (f20 cut)
105
106       (f25 kp-divide)
107       (f26 kp-multiply)
108       (f31 kp-5)
109
110       ;; Map f33 and r13 to end or kp-end
111       ,@(cond
112          ((not (x-keysym-on-keyboard-sans-modifiers-p 'end))
113           '((f33 end)
114             (r13 end)))
115          ((not (x-keysym-on-keyboard-sans-modifiers-p 'kp-end))
116           '((f33 kp-end)
117             (r13 kp-end))))
118
119       ,@(when (x-keysym-on-keyboard-sans-modifiers-p 'f36)
120           '((f36 stop)
121             (f37 again)))
122
123       ;; Type 4 keyboards have a real kp-subtract  and a f24 labelled `='
124       ;; Type 5 keyboards have no key labelled `=' and a f24 labelled `-'
125       ,@(when (x-keysym-on-keyboard-sans-modifiers-p 'f24)
126           `((f24 ,(if (x-keysym-on-keyboard-sans-modifiers-p 'kp-subtract)
127                       'kp-equal
128                     'kp-subtract))))
129
130       ;; Map f27 to home or kp-home, as appropriate
131       ,@(cond ((not (x-keysym-on-keyboard-sans-modifiers-p 'home))
132                '((f27 home)))
133               ((not (x-keysym-on-keyboard-sans-modifiers-p 'kp-home))
134                '((f27 kp-home))))
135
136       ;; Map f29 to prior or kp-prior, as appropriate
137       ,@(cond ((not (x-keysym-on-keyboard-sans-modifiers-p 'prior))
138                '((f29 prior)))
139               ((not (x-keysym-on-keyboard-sans-modifiers-p 'kp-prior))
140                '((f29 kp-prior))))
141
142       ;; Map f35 to next or kp-next, as appropriate
143       ,@(cond ((not (x-keysym-on-keyboard-sans-modifiers-p 'next))
144                '((f35 next)))
145               ((not (x-keysym-on-keyboard-sans-modifiers-p 'kp-next))
146                '((f35 kp-next))))
147
148       ,@(cond ((x-keysym-on-keyboard-sans-modifiers-p 'apRead) ; SunOS 4.1.1
149                '((apRead f11) (apEdit f12)))
150               ((x-keysym-on-keyboard-sans-modifiers-p 'SunF36) ; SunOS 5
151                '((SunF36 f11)
152                  (SunF37 f12)
153                  (f11    stop)
154                  (f12    again))))
155       )
156     do (when (x-keysym-on-keyboard-sans-modifiers-p from-key)
157          (dolist (prefix '(() (shift) (control) (meta) (alt)
158                            (shift control) (shift alt) (shift meta)
159                            (control alt) (control meta) (alt meta)
160                            (shift control alt) (shift control meta)
161                            (shift alt meta) (control alt meta)
162                            (shift control alt meta)))
163            (define-key function-key-map
164              (append prefix (list from-key))
165              (vector (append prefix (list to-key)))))))
166
167   ;; for each element in the left column of the above table, alias it
168   ;; to the thing in the right column.  Then do the same for many, but
169   ;; not all, modifier combinations.
170   ;;
171   ;; (Well, we omit hyper and super. #### Handle this some other way!)
172   ;;  (while mapping
173   ;;    (let ((mods '(() (shift) (control) (meta) (alt))))
174   ;;      (while mods
175   ;;    (let ((k1 (vector (append (car mods) (list (car (car mapping))))))
176   ;;          (k2 (vector (append (car mods) (list (cdr (car mapping)))))))
177   ;;      (define-key global-map k1 k2))
178   ;;    (setq mods (cdr mods))))
179   ;;    (setq mapping (cdr mapping))))
180
181 ;;; I've extended keyboard-translate-table to work over keysyms.
182 ;;; [FSF Emacs has something called `system-key-alist' that is
183 ;;; supposed to accomplish approximately the same thing.  Unfortunately,
184 ;;; it's brain-dead in the typically FSF way, and associates *numbers*
185 ;;; (who knows where the hell they come from?) with symbols.] --ben
186
187 ;;; And I've made it into a function which is NOT called by default --martin
188
189   (defun sun-x11-keyboard-translate ()
190     "Remap Sun's X11 keyboard.
191 Keys with names like `f35' are remapped, at a low level,
192 to more mnemonic ones,like `kp-3'."
193     (interactive)
194
195     (keyboard-translate
196      'f11               'stop           ; the type4 keyboard Sun/MIT name
197      'f36               'stop           ; the type5 keyboard Sun name
198      'cancel    'stop                   ; R6 binding
199      'f12               'again          ; the type4 keyboard Sun/MIT name
200      'f37               'again          ; the type5 keyboard Sun name
201      'f13               'props          ;
202      'SunProps  'props                  ; R6 binding
203      'f14               'undo           ;
204      'f15               'front          ;
205      'SunFront  'front                  ; R6 binding
206      'f16               'copy           ;
207      'SunCopy   'copy                   ; R6 binding
208      'f17               'open           ;
209      'SunOpen   'open                   ; R6 binding
210      'f18               'paste          ;
211      'SunPaste  'paste                  ; R6 binding
212      'f19               'find           ;
213      'f20               'cut            ;
214      'SunCut    'cut                    ; R6 binding
215      ;; help is ok
216      'f21 'pause
217      'f22 'prsc
218      'f23 'scroll
219      ;; num_lock is ok
220      ;;'f24 'kp-equal)                  ; type4 only!
221      'f25 'kp-divide                    ;
222      'f26 'kp-multiply                  ;
223      'f24 'kp-subtract                  ; type5 only!
224      'f27 'kp-7                         ;
225      ;; up is ok
226      'f29 'kp-9
227      ;; left is ok
228      'f31 'kp-5
229      ;; right is ok
230      ;; kp-add is ok
231      'f33 'kp-1                         ; the Sun name
232      'r13 'end                          ; the MIT name
233      ;; down is ok
234      'f35 'kp-3
235      ;; insert is ok
236      ;; delete is ok
237      ;; kp-enter is ok
238      'SunF36 'f11                       ; Type 5 keyboards
239      'SunF37 'f12                       ; Used to be Stop & Again
240      ))
241
242   \f
243 ;;; OpenWindows-like "find" processing.
244 ;;; As far as I know, the `find' key is a Sunism, so we do that binding
245 ;;; here.  This is the only Sun-specific keybinding.  (The functions
246 ;;; themselves are in x-win.el in case someone wants to use them when
247 ;;; not running on a Sun display.)
248
249   (or (lookup-key global-map 'find)
250       (define-key global-map 'find 'ow-find))
251   (or (lookup-key global-map '(shift find))
252        (define-key global-map '(shift find) 'ow-find-backward))
253
254   )
255
256 ;;; x-win-sun.el ends here