Commit | Line | Data |
---|---|---|
be010748 | 1 | ;;; edt-mapper.el --- Create an EDT LK-201 Map File for X-Windows Emacs |
c0e42a4d | 2 | |
732be465 | 3 | ;; Copyright (C) 1994, 1995 Free Software Foundation, Inc. |
c0e42a4d | 4 | |
26d81466 RS |
5 | ;; Author: Kevin Gallagher <kevingal@onramp.net> |
6 | ;; Maintainer: Kevin Gallagher <kevingal@onramp.net> | |
c0e42a4d KH |
7 | ;; Keywords: emulations |
8 | ||
e9f722ee | 9 | ;; This file is part of GNU Emacs. |
c0e42a4d KH |
10 | |
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
c0e42a4d KH |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; This emacs lisp program can be used to create an emacs lisp file | |
29 | ;; that defines the mapping of the user's keyboard under X-Windows to | |
30 | ;; the LK-201 keyboard function keys and keypad keys (around which | |
31 | ;; EDT has been designed). Please read the "Usage" AND "Known | |
32 | ;; Problems" sections before attempting to run this program. (The | |
33 | ;; design of this file, edt-mapper.el, was heavily influenced by | |
34 | ;; tpu-mapper.el.) | |
35 | ||
36 | ;;; Usage: | |
37 | ||
38 | ;; Simply load this file into the X-Windows version of emacs (version 19) | |
39 | ;; using the following command. | |
40 | ||
41 | ;; emacs -q -l edt-mapper.el | |
42 | ||
43 | ;; The "-q" option prevents loading of your .emacs file (commands therein | |
44 | ;; might confuse this program). | |
45 | ||
46 | ;; An instruction screen showing the typical LK-201 terminal functions keys | |
47 | ;; will be displayed, and you will be prompted to press the keys on your | |
48 | ;; keyboard which you want to emulate the corresponding LK-201 keys. | |
49 | ||
50 | ;; Finally, you will be prompted for the name of the file to store | |
51 | ;; the key definitions. If you chose the default, it will be found | |
52 | ;; and loaded automatically when the EDT emulation is started. If | |
53 | ;; you specify a different file name, you will need to set the | |
54 | ;; variable "edt-xkeys-file" before starting the EDT emulation. | |
55 | ;; Here's how you might go about doing that in your .emacs file. | |
56 | ||
57 | ;; (setq edt-xkeys-file (expand-file-name "~/.my-emacs-x-keys")) | |
58 | ||
59 | ;;; Known Problems: | |
60 | ||
61 | ;; Sometimes, edt-mapper will ignore a key you press, and just continue to | |
62 | ;; prompt for the same key. This can happen when your window manager sucks | |
63 | ;; up the key and doesn't pass it on to emacs, or it could be an emacs bug. | |
64 | ;; Either way, there's nothing that edt-mapper can do about it. You must | |
65 | ;; press RETURN, to skip the current key and continue. Later, you and/or | |
66 | ;; your local X guru can try to figure out why the key is being ignored. | |
67 | ||
68 | ;; ==================================================================== | |
69 | ||
c0e42a4d KH |
70 | ;;; |
71 | ;;; Make sure we're running X-windows and Emacs version 19 | |
72 | ;;; | |
73 | (cond | |
74 | ((not (and window-system (not (string-lessp emacs-version "19")))) | |
75 | (insert " | |
76 | ||
77 | Whoa! This isn't going to work... | |
78 | ||
79 | You must run edt-mapper.el under X-windows and Emacs version 19. | |
80 | ||
81 | Press any key to exit. ") | |
82 | (sit-for 600) | |
83 | (kill-emacs t))) | |
84 | ||
85 | ||
86 | ;;; | |
87 | ;;; Decide whether we're running GNU or Lucid emacs. | |
88 | ;;; | |
89 | (defconst edt-lucid-emacs19-p (string-match "Lucid" emacs-version) | |
90 | "Non-NIL if we are running Lucid Emacs version 19.") | |
91 | ||
92 | ||
93 | ;;; | |
94 | ;;; Key variables | |
95 | ;;; | |
96 | (defvar edt-key nil) | |
97 | (defvar edt-enter nil) | |
98 | (defvar edt-return nil) | |
99 | (defvar edt-key-seq nil) | |
100 | (defvar edt-enter-seq nil) | |
101 | (defvar edt-return-seq nil) | |
102 | ||
103 | ||
104 | ;;; | |
105 | ;;; Make sure the window is big enough to display the instructions | |
106 | ;;; | |
107 | (if edt-lucid-emacs19-p (set-screen-size nil 80 36) | |
108 | (set-frame-size (selected-frame) 80 36)) | |
109 | ||
110 | ||
111 | ;;; | |
112 | ;;; Create buffers - Directions and Keys | |
113 | ;;; | |
114 | (if (not (get-buffer "Directions")) (generate-new-buffer "Directions")) | |
115 | (if (not (get-buffer "Keys")) (generate-new-buffer "Keys")) | |
116 | ||
117 | ;;; | |
118 | ;;; Put header in the Keys buffer | |
119 | ;;; | |
120 | (set-buffer "Keys") | |
121 | (insert "\ | |
122 | ;; | |
123 | ;; Key definitions for the EDT emulation within GNU Emacs | |
124 | ;; | |
125 | ||
126 | (defconst *EDT-keys* | |
127 | '( | |
128 | ") | |
129 | ||
130 | ;;; | |
131 | ;;; Display directions | |
132 | ;;; | |
133 | (switch-to-buffer "Directions") | |
134 | (insert " | |
135 | EDT MAPPER | |
136 | ||
137 | You will be asked to press keys to create a custom mapping (under | |
138 | X-Windows) of your keypad keys and function keys so that they can emulate | |
139 | the LK-201 keypad and function keys or the subset of keys found on a | |
140 | VT-100 series terminal keyboard. (The LK-201 keyboard is the standard | |
141 | keyboard attached to VT-200 series terminals, and above.) | |
142 | ||
143 | Sometimes, edt-mapper will ignore a key you press, and just continue to | |
144 | prompt for the same key. This can happen when your window manager sucks | |
145 | up the key and doesn't pass it on to emacs, or it could be an emacs bug. | |
146 | Either way, there's nothing that edt-mapper can do about it. You must | |
147 | press RETURN, to skip the current key and continue. Later, you and/or | |
148 | your local X guru can try to figure out why the key is being ignored. | |
149 | ||
150 | Start by pressing the RETURN key, and continue by pressing the keys | |
151 | specified in the mini-buffer. If you want to entirely omit a key, | |
152 | because your keyboard does not have a corresponding key, for example, | |
153 | just press RETURN at the prompt. | |
154 | ||
155 | ") | |
156 | (delete-other-windows) | |
157 | ||
158 | ;;; | |
159 | ;;; Save <CR> for future reference | |
160 | ;;; | |
161 | (cond | |
162 | (edt-lucid-emacs19-p | |
163 | (setq edt-return-seq (read-key-sequence "Hit carriage-return <CR> to continue ")) | |
164 | (setq edt-return (concat "[" (format "%s" (event-key (aref edt-return-seq 0))) "]"))) | |
165 | (t | |
166 | (message "Hit carriage-return <CR> to continue ") | |
167 | (setq edt-return-seq (read-event)) | |
168 | (setq edt-return (concat "[" (format "%s" edt-return-seq) "]")))) | |
169 | ||
170 | ;;; | |
171 | ;;; Display Keypad Diagram and Begin Prompting for Keys | |
172 | ;;; | |
173 | (set-buffer "Directions") | |
174 | (delete-region (point-min) (point-max)) | |
175 | (insert " | |
176 | ||
177 | ||
178 | ||
179 | PRESS THE KEY SPECIFIED IN THE MINIBUFFER BELOW. | |
180 | ||
181 | ||
182 | ||
183 | ||
184 | Here's a picture of the standard LK-201 keypad for reference: | |
185 | ||
186 | _______________________ _______________________________ | |
187 | | HELP | DO | | F17 | F18 | F19 | F20 | | |
188 | | | | | | | | | | |
189 | |_______|_______________| |_______|_______|_______|_______| | |
190 | _______________________ _______________________________ | |
191 | | FIND |INSERT |REMOVE | | PF1 | PF2 | PF3 | PF4 | | |
192 | | | | | | | | | | | |
193 | |_______|_______|_______| |_______|_______|_______|_______| | |
194 | |SELECT |PREVIOU| NEXT | | KP7 | KP8 | KP9 | KP- | | |
195 | | | | | | | | | | | |
196 | |_______|_______|_______| |_______|_______|_______|_______| | |
197 | | UP | | KP4 | KP5 | KP6 | KP, | | |
198 | | | | | | | | | |
199 | _______|_______|_______ |_______|_______|_______|_______| | |
200 | | LEFT | DOWN | RIGHT | | KP1 | KP2 | KP3 | | | |
201 | | | | | | | | | | | |
202 | |_______|_______|_______| |_______|_______|_______| KPE | | |
203 | | KP0 | KPP | | | |
204 | | | | | | |
205 | |_______________|_______|_______| | |
206 | ||
207 | ") | |
208 | ||
209 | ;;; | |
210 | ;;; Key mapping functions | |
211 | ;;; | |
212 | (defun edt-lucid-map-key (ident descrip func gold-func) | |
213 | (interactive) | |
214 | (setq edt-key-seq (read-key-sequence (format "Press %s%s: " ident descrip))) | |
215 | (setq edt-key (concat "[" (format "%s" (event-key (aref edt-key-seq 0))) "]")) | |
216 | (cond ((not (equal edt-key edt-return)) | |
217 | (set-buffer "Keys") | |
218 | (insert (format " (\"%s\" . %s)\n" ident edt-key)) | |
219 | (set-buffer "Directions")) | |
220 | ;; bogosity to get next prompt to come up, if the user hits <CR>! | |
221 | ;; check periodically to see if this is still needed... | |
222 | (t | |
223 | (format "%s" edt-key))) | |
224 | edt-key) | |
225 | ||
226 | (defun edt-gnu-map-key (ident descrip) | |
227 | (interactive) | |
228 | (message "Press %s%s: " ident descrip) | |
229 | (setq edt-key-seq (read-event)) | |
230 | (setq edt-key (concat "[" (format "%s" edt-key-seq) "]")) | |
231 | (cond ((not (equal edt-key edt-return)) | |
232 | (set-buffer "Keys") | |
233 | (insert (format " (\"%s\" . %s)\n" ident edt-key)) | |
234 | (set-buffer "Directions")) | |
235 | ;; bogosity to get next prompt to come up, if the user hits <CR>! | |
236 | ;; check periodically to see if this is still needed... | |
237 | (t | |
238 | (set-buffer "Keys") | |
239 | (insert (format " (\"%s\" . \"\" )\n" ident)) | |
240 | (set-buffer "Directions"))) | |
241 | edt-key) | |
242 | ||
243 | (fset 'edt-map-key (if edt-lucid-emacs19-p 'edt-lucid-map-key 'edt-gnu-map-key)) | |
244 | (set-buffer "Keys") | |
245 | (insert " | |
246 | ;; | |
247 | ;; Arrows | |
248 | ;; | |
249 | ") | |
250 | (set-buffer "Directions") | |
251 | ||
252 | (edt-map-key "UP" " - The Up Arrow Key") | |
253 | (edt-map-key "DOWN" " - The Down Arrow Key") | |
254 | (edt-map-key "LEFT" " - The Left Arrow Key") | |
255 | (edt-map-key "RIGHT" " - The Right Arrow Key") | |
256 | ||
257 | ||
258 | (set-buffer "Keys") | |
259 | (insert " | |
260 | ;; | |
261 | ;; PF keys | |
262 | ;; | |
263 | ") | |
264 | (set-buffer "Directions") | |
265 | ||
266 | (edt-map-key "PF1" " - The PF1 (GOLD) Key") | |
267 | (edt-map-key "PF2" " - The Keypad PF2 Key") | |
268 | (edt-map-key "PF3" " - The Keypad PF3 Key") | |
269 | (edt-map-key "PF4" " - The Keypad PF4 Key") | |
270 | ||
271 | (set-buffer "Keys") | |
272 | (insert " | |
273 | ;; | |
274 | ;; KP0-9 KP- KP, KPP and KPE | |
275 | ;; | |
276 | ") | |
277 | (set-buffer "Directions") | |
278 | ||
279 | (edt-map-key "KP0" " - The Keypad 0 Key") | |
280 | (edt-map-key "KP1" " - The Keypad 1 Key") | |
281 | (edt-map-key "KP2" " - The Keypad 2 Key") | |
282 | (edt-map-key "KP3" " - The Keypad 3 Key") | |
283 | (edt-map-key "KP4" " - The Keypad 4 Key") | |
284 | (edt-map-key "KP5" " - The Keypad 5 Key") | |
285 | (edt-map-key "KP6" " - The Keypad 6 Key") | |
286 | (edt-map-key "KP7" " - The Keypad 7 Key") | |
287 | (edt-map-key "KP8" " - The Keypad 8 Key") | |
288 | (edt-map-key "KP9" " - The Keypad 9 Key") | |
289 | (edt-map-key "KP-" " - The Keypad - Key") | |
290 | (edt-map-key "KP," " - The Keypad , Key") | |
291 | (edt-map-key "KPP" " - The Keypad . Key") | |
292 | (edt-map-key "KPE" " - The Keypad Enter Key") | |
293 | ;; Save the enter key | |
294 | (setq edt-enter edt-key) | |
295 | (setq edt-enter-seq edt-key-seq) | |
296 | ||
297 | ||
298 | (set-buffer "Keys") | |
299 | (insert " | |
300 | ;; | |
301 | ;; Editing keypad (FIND, INSERT, REMOVE) | |
302 | ;; (SELECT, PREVIOUS, NEXT) | |
303 | ;; | |
304 | ") | |
305 | (set-buffer "Directions") | |
306 | ||
307 | (edt-map-key "FIND" " - The Find key on the editing keypad") | |
308 | (edt-map-key "INSERT" " - The Insert key on the editing keypad") | |
309 | (edt-map-key "REMOVE" " - The Remove key on the editing keypad") | |
310 | (edt-map-key "SELECT" " - The Select key on the editing keypad") | |
311 | (edt-map-key "PREVIOUS" " - The Prev Scr key on the editing keypad") | |
312 | (edt-map-key "NEXT" " - The Next Scr key on the editing keypad") | |
313 | ||
314 | (set-buffer "Keys") | |
315 | (insert " | |
316 | ;; | |
317 | ;; F1-14 Help Do F17-F20 | |
318 | ;; | |
319 | ") | |
320 | (set-buffer "Directions") | |
321 | ||
322 | (edt-map-key "F1" " - F1 Function Key") | |
323 | (edt-map-key "F2" " - F2 Function Key") | |
324 | (edt-map-key "F3" " - F3 Function Key") | |
325 | (edt-map-key "F4" " - F4 Function Key") | |
326 | (edt-map-key "F5" " - F5 Function Key") | |
327 | (edt-map-key "F6" " - F6 Function Key") | |
328 | (edt-map-key "F7" " - F7 Function Key") | |
329 | (edt-map-key "F8" " - F8 Function Key") | |
330 | (edt-map-key "F9" " - F9 Function Key") | |
331 | (edt-map-key "F10" " - F10 Function Key") | |
332 | (edt-map-key "F11" " - F11 Function Key") | |
333 | (edt-map-key "F12" " - F12 Function Key") | |
334 | (edt-map-key "F13" " - F13 Function Key") | |
335 | (edt-map-key "F14" " - F14 Function Key") | |
336 | (edt-map-key "HELP" " - HELP Function Key") | |
337 | (edt-map-key "DO" " - DO Function Key") | |
338 | (edt-map-key "F17" " - F17 Function Key") | |
339 | (edt-map-key "F18" " - F18 Function Key") | |
340 | (edt-map-key "F19" " - F19 Function Key") | |
341 | (edt-map-key "F20" " - F20 Function Key") | |
342 | ||
343 | (set-buffer "Directions") | |
344 | (delete-region (point-min) (point-max)) | |
345 | (insert " | |
346 | ADDITIONAL FUNCTION KEYS | |
347 | ||
348 | Your keyboard may have additional function keys which do not | |
349 | correspond to any LK-201 keys. The EDT Emulation can be | |
350 | configured to recognize those keys, since you may wish to add your | |
351 | own key bindings to those keys. | |
352 | ||
353 | For example, suppose your keyboard has a keycap marked \"Line Del\" | |
354 | and you wish to add it to the list of keys which can be customized | |
355 | by the EDT Emulation. First, assign a unique single-word name to | |
356 | the key for use by the EDT Emulation, let's say \"linedel\", in this | |
357 | example. Then, at the \"EDT Key Name:\" prompt, enter \"linedel\", | |
358 | followed by a press of the RETURN key. Finally, when prompted, | |
359 | press the \"Line Del\" key. You now will be able to bind functions | |
360 | to \"linedel\" and \"Gold-linedel\" in edt-user.el in just the same way | |
361 | you can customize bindings of the standard LK-201 keys. | |
362 | ||
363 | When you have no additional function keys to specify, just press | |
364 | RETURN at the \"EDT Key Name:\" prompt. (If you change your mind | |
365 | AFTER you enter an EDT Key Name and before you press a key at the | |
366 | \"Press\" prompt, you may omit the key by simply pressing RETURN at | |
367 | the prompt.) | |
368 | ") | |
369 | (switch-to-buffer "Directions") | |
370 | ;;; | |
371 | ;;; Add support for extras keys | |
372 | ;;; | |
373 | (set-buffer "Keys") | |
374 | (insert "\ | |
375 | ;; | |
376 | ;; Extra Keys | |
377 | ;; | |
378 | ") | |
379 | (setq EDT-key-name "") | |
380 | (while (not | |
381 | (string-equal (setq EDT-key-name (read-string "EDT Key Name: ")) "")) | |
382 | (edt-map-key EDT-key-name "")) | |
383 | ||
384 | ; | |
385 | ; No more keys to add, so wrap up. | |
386 | ; | |
387 | (set-buffer "Keys") | |
388 | (insert "\ | |
389 | ) | |
390 | ) | |
391 | ") | |
392 | ||
393 | ;;; | |
394 | ;;; Save the key mapping program and blow this pop stand | |
395 | ;;; | |
396 | (let ((file (if edt-lucid-emacs19-p "~/.edt-lucid-keys" "~/.edt-gnu-keys"))) | |
397 | (set-visited-file-name | |
398 | (read-file-name (format "Save key mapping to file (default %s): " file) nil file))) | |
399 | (save-buffer) | |
400 | ||
401 | (message "That's it! Press any key to exit") | |
402 | (sit-for 600) | |
403 | (kill-emacs t) | |
404 | ||
405 | ;;; edt-mapper.el ends here |