lisp/emulation/edt-mapper.el

   1 ;;; edt-mapper.el --- create an EDT LK-201 map file for X-Windows Emacs
   2
   3 ;; Copyright (C) 1994, 1995, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   4 ;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   5
   6 ;; Author: Kevin Gallagher <Kevin.Gallagher@boeing.com>
   7 ;; Maintainer: Kevin Gallagher <Kevin.Gallagher@boeing.com>
   8 ;; Keywords: emulations
   9 ;; Package: edt
  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 3 of the License, or
  16 ;; (at your option) 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
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;  [Part of the GNU Emacs EDT Emulation.]
  30
  31 ;;  This emacs lisp program can be used to create an emacs lisp file
  32 ;;  that defines the mapping of the user's keyboard to the LK-201
  33 ;;  keyboard function keys and keypad keys (around which EDT has been
  34 ;;  designed).  Please read the "Usage" AND "Known Problems" sections
  35 ;;  below before attempting to run this program.  (The design of this
  36 ;;  file, edt-mapper.el, was heavily influenced by tpu-mapper.el.)
  37
  38 ;;  Version 4.0 contains the following enhancements:
  39
  40 ;;  1.  If you access a workstation using an X Server, note that the
  41 ;;      initialization file generated by edt-mapper.el will now
  42 ;;      contain the name of the X Server vendor.  This is a
  43 ;;      convenience for those who have access to their Unix account
  44 ;;      from more than one type of X Server.  Since different X
  45 ;;      Servers typically require different EDT emulation
  46 ;;      initialization files, edt-mapper.el will now generate these
  47 ;;      different initialization files and save them with different
  48 ;;      names.
  49
  50 ;;  2.  Also, edt-mapper.el is now capable of binding an ASCII key
  51 ;;      sequence, providing the ASCII key sequence prefix is already
  52 ;;      known by Emacs to be a prefix.  As a result, some
  53 ;;      terminal/keyboard/window system configurations, which don't
  54 ;;      have a complete set of sensible function key map bindings, can
  55 ;;      still be configured for EDT Emulation.
  56
  57
  58 ;;  Usage:
  59
  60 ;;  Simply load this file into emacs (version 19 or higher)
  61 ;;  using the following command.
  62
  63 ;;    emacs -q -l edt-mapper.el
  64
  65 ;;  The "-q" option prevents loading of your .emacs file (commands
  66 ;;  therein might confuse this program).
  67
  68 ;;  An instruction screen showing the typical LK-201 terminal
  69 ;;  functions keys will be displayed, and you will be prompted to
  70 ;;  press the keys on your keyboard which you want to emulate the
  71 ;;  corresponding LK-201 keys.
  72
  73 ;;  Finally, you will be prompted for the name of the file to store
  74 ;;  the key definitions.  If you chose the default, it will be found
  75 ;;  and loaded automatically when the EDT emulation is started.  If
  76 ;;  you specify a different file name, you will need to set the
  77 ;;  variable "edt-keys-file" before starting the EDT emulation.
  78 ;;  Here's how you might go about doing that in your .emacs file.
  79
  80 ;;    (setq edt-keys-file (expand-file-name "~/.my-emacs-keys"))
  81
  82
  83 ;;  Known Problems:
  84
  85 ;;  Sometimes, edt-mapper will ignore a key you press, and just
  86 ;;  continue to prompt for the same key.  This can happen when your
  87 ;;  window manager sucks up the key and doesn't pass it on to emacs,
  88 ;;  or it could be an emacs bug.  Either way, there's nothing that
  89 ;;  edt-mapper can do about it.  You must press RETURN, to skip the
  90 ;;  current key and continue.  Later, you and/or your local Emacs guru
  91 ;;  can try to figure out why the key is being ignored.
  92
  93 ;;; History:
  94 ;;
  95
  96 ;;  Version 4.0    2000    Added 2 New Features
  97
  98 ;;; Code:
  99
 100 ;;;
 101 ;;;  Decide Emacs Variant, GNU Emacs or XEmacs (aka Lucid Emacs).
 102 ;;;  Determine Window System, and X Server Vendor (if appropriate).
 103 ;;;
 104 (defconst edt-window-system (if (featurep 'xemacs) (console-type) window-system)
 105   "Indicates window system \(in GNU Emacs\) or console type \(in XEmacs\).")
 106
 107 (declare-function x-server-vendor "xfns.c" (&optional terminal))
 108
 109 (defconst edt-xserver (when (eq edt-window-system 'x)
 110                         ;; The Cygwin window manager has a `/' in its
 111                         ;; name, which breaks the generated file name of
 112                         ;; the custom key map file.  Replace `/' with a
 113                         ;; `-' to work around that.
 114                         (if (featurep 'xemacs)
 115                             (replace-in-string (x-server-vendor) "[ /]" "-")
 116                           (replace-regexp-in-string "[ /]" "-"
 117                                                     (x-server-vendor))))
 118   "Indicates X server vendor name, if applicable.")
 119
 120
 121 ;;;
 122 ;;;  Key variables
 123 ;;;
 124 (defvar edt-key nil)
 125 (defvar edt-enter nil)
 126 (defvar edt-return nil)
 127 (defvar edt-key-seq nil)
 128 (defvar edt-enter-seq nil)
 129 (defvar edt-return-seq nil)
 130 (defvar edt-term nil)
 131
 132 ;; To silence the byte-compiler
 133 (defvar EDT-key-name)
 134 (defvar edt-save-function-key-map)
 135
 136 ;;;
 137 ;;;  Determine Terminal Type (if appropriate).
 138 ;;;
 139
 140 (if (and edt-window-system (not (eq edt-window-system 'tty)))
 141     (setq edt-term nil)
 142   (setq edt-term (getenv "TERM")))
 143
 144 ;;;
 145 ;;;  Make sure the window is big enough to display the instructions,
 146 ;;;  except where window cannot be re-sized.
 147 ;;;
 148
 149 (if (and edt-window-system (not (eq edt-window-system 'tty)))
 150     (set-frame-size (selected-frame) 80 36))
 151
 152 ;;;
 153 ;;;  Create buffers - Directions and Keys
 154 ;;;
 155 (if (not (get-buffer "Directions")) (generate-new-buffer "Directions"))
 156 (if (not (get-buffer "Keys")) (generate-new-buffer "Keys"))
 157
 158 ;;;
 159 ;;;  Put header in the Keys buffer
 160 ;;;
 161 (set-buffer "Keys")
 162 (insert "\
 163 ;;
 164 ;;  Key definitions for the EDT emulation within GNU Emacs
 165 ;;
 166
 167 (defconst *EDT-keys*
 168   '(
 169 ")
 170
 171 ;;;
 172 ;;;   Display directions
 173 ;;;
 174 (switch-to-buffer "Directions")
 175 (if (and edt-window-system (not (eq edt-window-system 'tty)))
 176     (insert "
 177                                   EDT MAPPER
 178
 179     You will be asked to press keys to create a custom mapping (under a
 180     Window Manager) of your keypad keys and function keys so that they can
 181     emulate the LK-201 keypad and function keys or the subset of keys found
 182     on a VT-100 series terminal keyboard.  (The LK-201 keyboard is the
 183     standard keyboard attached to VT-200 series terminals, and above.)
 184
 185     Sometimes, edt-mapper will ignore a key you press, and just continue to
 186     prompt for the same key.  This can happen when your window manager sucks
 187     up the key and doesn't pass it on to Emacs, or it could be an Emacs bug.
 188     Either way, there's nothing that edt-mapper can do about it.  You must
 189     press RETURN, to skip the current key and continue.  Later, you and/or
 190     your local system guru can try to figure out why the key is being ignored.
 191
 192     Start by pressing the RETURN key, and continue by pressing the keys
 193     specified in the mini-buffer.  If you want to entirely omit a key,
 194     because your keyboard does not have a corresponding key, for example,
 195     just press RETURN at the prompt.
 196
 197 ")
 198   (insert "
 199                                   EDT MAPPER
 200
 201     You will be asked to press keys to create a custom mapping of your
 202     keypad keys and function keys so that they can emulate the LK-201
 203     keypad and function keys or the subset of keys found on a VT-100
 204     series terminal keyboard.  (The LK-201 keyboard is the standard
 205     keyboard attached to VT-200 series terminals, and above.)
 206
 207     If you are using a real LK-201 keyboard, you should map the keys
 208     exactly as they are on the keyboard.
 209
 210     Start by pressing the RETURN key, and continue by pressing the keys
 211     specified in the mini-buffer.  If you want to entirely omit a key,
 212     because your keyboard does not have a corresponding key, for example,
 213     just press RETURN at the prompt.
 214
 215 "))
 216
 217 (delete-other-windows)
 218
 219 ;;;
 220 ;;;  Save <CR> for future reference.
 221 ;;;
 222 ;;;  For GNU Emacs, running in a Window System, first hide bindings in
 223 ;;;  function-key-map.
 224 ;;;
 225 (cond
 226  ((featurep 'xemacs)
 227   (setq edt-return-seq (read-key-sequence "Hit carriage-return <CR> to continue "))
 228   (setq edt-return (concat "[" (format "%s" (event-key (aref edt-return-seq 0))) "]")))
 229  (t
 230   (if edt-window-system
 231       (progn
 232         (setq edt-save-function-key-map function-key-map)
 233         (setq function-key-map (make-sparse-keymap))))
 234   (setq edt-return (read-key-sequence "Hit carriage-return <CR> to continue "))))
 235
 236 ;;;
 237 ;;;  Remove prefix-key bindings to F1 and F2 in global-map so they can be
 238 ;;;  bound in the EDT Emulation mode.
 239 ;;;
 240 (global-unset-key [f1])
 241 (global-unset-key [f2])
 242
 243 ;;;
 244 ;;;   Display Keypad Diagram and Begin Prompting for Keys
 245 ;;;
 246 (set-buffer "Directions")
 247 (delete-region (point-min) (point-max))
 248 (if (and edt-window-system (not (eq edt-window-system 'tty)))
 249     (insert "
 250
 251           PRESS THE KEY SPECIFIED IN THE MINIBUFFER BELOW.
 252
 253     Here's a picture of the standard LK-201 keypad for reference:
 254
 255           _______________________    _______________________________
 256          | HELP  |      DO       |  |  F17  |  F18  |  F19  |  F20  |
 257          |       |               |  |       |       |       |       |
 258          |_______|_______________|  |_______|_______|_______|_______|
 259           _______________________    _______________________________
 260          | FIND  |INSERT |REMOVE |  |  PF1  |  PF2  |  PF3  |  PF4  |
 261          |       |       |       |  |       |       |       |       |
 262          |_______|_______|_______|  |_______|_______|_______|_______|
 263          |SELECT |PREVIOU| NEXT  |  |  KP7  |  KP8  |  KP9  |  KP-  |
 264          |       |       |       |  |       |       |       |       |
 265          |_______|_______|_______|  |_______|_______|_______|_______|
 266                  |   UP  |          |  KP4  |  KP5  |  KP6  |  KP,  |
 267                  |       |          |       |       |       |       |
 268           _______|_______|_______   |_______|_______|_______|_______|
 269          |  LEFT |  DOWN | RIGHT |  |  KP1  |  KP2  |  KP3  |       |
 270          |       |       |       |  |       |       |       |       |
 271          |_______|_______|_______|  |_______|_______|_______|  KPE  |
 272                                     |      KP0      |  KPP  |       |
 273                                     |               |       |       |
 274                                     |_______________|_______|_______|
 275
 276          REMEMBER:  JUST PRESS RETURN TO SKIP MAPPING A KEY.
 277
 278 ")
 279   (progn
 280     (insert "
 281     GENERATING A CUSTOM CONFIGURATION FILE FOR TERMINAL TYPE:  ")
 282     (insert (format "%s." edt-term))
 283     (insert "
 284
 285           PRESS THE KEY SPECIFIED IN THE MINIBUFFER BELOW.
 286
 287           _______________________    _______________________________
 288          | HELP  |      DO       |  |  F17  |  F18  |  F19  |  F20  |
 289          |_______|_______________|  |_______|_______|_______|_______|
 290           _______________________    _______________________________
 291          | FIND  |INSERT |REMOVE |  |  PF1  |  PF2  |  PF3  |  PF4  |
 292          |_______|_______|_______|  |_______|_______|_______|_______|
 293          |SELECT |PREVIOU| NEXT  |  |  KP7  |  KP8  |  KP9  |  KP-  |
 294          |_______|_______|_______|  |_______|_______|_______|_______|
 295                  |   UP  |          |  KP4  |  KP5  |  KP6  |  KP,  |
 296           _______|_______|_______   |_______|_______|_______|_______|
 297          |  LEFT |  DOWN | RIGHT |  |  KP1  |  KP2  |  KP3  |       |
 298          |_______|_______|_______|  |_______|_______|_______|  KPE  |
 299                                     |      KP0      |  KPP  |       |
 300                                     |_______________|_______|_______|
 301
 302          REMEMBER:  JUST PRESS RETURN TO SKIP MAPPING A KEY.")))
 303
 304
 305 ;;;
 306 ;;;  Key mapping functions
 307 ;;;
 308 (defun edt-map-key (ident descrip)
 309   (interactive)
 310   (if (featurep 'xemacs)
 311       (progn
 312         (setq edt-key-seq (read-key-sequence (format "Press %s%s: " ident descrip)))
 313         (setq edt-key (concat "[" (format "%s" (event-key (aref edt-key-seq 0))) "]"))
 314         (cond ((not (equal edt-key edt-return))
 315                (set-buffer "Keys")
 316                (insert (format "    (\"%s\" . %s)\n" ident edt-key))
 317                (set-buffer "Directions"))
 318               ;; bogosity to get next prompt to come up, if the user hits <CR>!
 319               ;; check periodically to see if this is still needed...
 320               (t
 321                (set-buffer "Keys")
 322                (insert (format "    (\"%s\" . \"\" )\n" ident))
 323                (set-buffer "Directions"))))
 324     (setq edt-key (read-key-sequence (format "Press %s%s: " ident descrip)))
 325     (cond ((not (equal edt-key edt-return))
 326            (set-buffer "Keys")
 327            (insert (if (vectorp edt-key)
 328                        (format "    (\"%s\" . %s)\n" ident edt-key)
 329                      (format "    (\"%s\" . \"%s\")\n" ident edt-key)))
 330            (set-buffer "Directions"))
 331           ;; bogosity to get next prompt to come up, if the user hits <CR>!
 332           ;; check periodically to see if this is still needed...
 333           (t
 334            (set-buffer "Keys")
 335            (insert (format "    (\"%s\" . \"\" )\n" ident))
 336            (set-buffer "Directions"))))
 337   edt-key)
 338
 339 (set-buffer "Keys")
 340 (insert "
 341 ;;
 342 ;;  Arrows
 343 ;;
 344 ")
 345 (set-buffer "Directions")
 346
 347 (edt-map-key "UP"     " - The Up Arrow Key")
 348 (edt-map-key "DOWN"   " - The Down Arrow Key")
 349 (edt-map-key "LEFT"   " - The Left Arrow Key")
 350 (edt-map-key "RIGHT"  " - The Right Arrow Key")
 351
 352
 353 (set-buffer "Keys")
 354 (insert "
 355 ;;
 356 ;;  PF keys
 357 ;;
 358 ")
 359 (set-buffer "Directions")
 360
 361 (edt-map-key "PF1"  " - The PF1 (GOLD) Key")
 362 (edt-map-key "PF2"  " - The Keypad PF2 Key")
 363 (edt-map-key "PF3"  " - The Keypad PF3 Key")
 364 (edt-map-key "PF4"  " - The Keypad PF4 Key")
 365
 366 (set-buffer "Keys")
 367 (insert "
 368 ;;
 369 ;;  KP0-9 KP- KP, KPP and KPE
 370 ;;
 371 ")
 372 (set-buffer "Directions")
 373
 374 (edt-map-key "KP0"      " - The Keypad 0 Key")
 375 (edt-map-key "KP1"      " - The Keypad 1 Key")
 376 (edt-map-key "KP2"      " - The Keypad 2 Key")
 377 (edt-map-key "KP3"      " - The Keypad 3 Key")
 378 (edt-map-key "KP4"      " - The Keypad 4 Key")
 379 (edt-map-key "KP5"      " - The Keypad 5 Key")
 380 (edt-map-key "KP6"      " - The Keypad 6 Key")
 381 (edt-map-key "KP7"      " - The Keypad 7 Key")
 382 (edt-map-key "KP8"      " - The Keypad 8 Key")
 383 (edt-map-key "KP9"      " - The Keypad 9 Key")
 384 (edt-map-key "KP-"      " - The Keypad - Key")
 385 (edt-map-key "KP,"      " - The Keypad , Key")
 386 (edt-map-key "KPP"      " - The Keypad . Key")
 387 (edt-map-key "KPE"      " - The Keypad Enter Key")
 388 ;; Save the enter key
 389 (setq edt-enter edt-key)
 390 (setq edt-enter-seq edt-key-seq)
 391
 392
 393 (set-buffer "Keys")
 394 (insert "
 395 ;;
 396 ;;  Editing keypad (FIND, INSERT, REMOVE)
 397 ;;                 (SELECT, PREVIOUS, NEXT)
 398 ;;
 399 ")
 400 (set-buffer "Directions")
 401
 402 (edt-map-key "FIND"      " - The Find key on the editing keypad")
 403 (edt-map-key "INSERT"    " - The Insert key on the editing keypad")
 404 (edt-map-key "REMOVE"    " - The Remove key on the editing keypad")
 405 (edt-map-key "SELECT"    " - The Select key on the editing keypad")
 406 (edt-map-key "PREVIOUS"  " - The Prev Scr key on the editing keypad")
 407 (edt-map-key "NEXT"      " - The Next Scr key on the editing keypad")
 408
 409 (set-buffer "Keys")
 410 (insert "
 411 ;;
 412 ;;  F1-14 Help Do F17-F20
 413 ;;
 414 ")
 415 (set-buffer "Directions")
 416
 417 (edt-map-key "F1"        " - F1 Function Key")
 418 (edt-map-key "F2"        " - F2 Function Key")
 419 (edt-map-key "F3"        " - F3 Function Key")
 420 (edt-map-key "F4"        " - F4 Function Key")
 421 (edt-map-key "F5"        " - F5 Function Key")
 422 (edt-map-key "F6"        " - F6 Function Key")
 423 (edt-map-key "F7"        " - F7 Function Key")
 424 (edt-map-key "F8"        " - F8 Function Key")
 425 (edt-map-key "F9"        " - F9 Function Key")
 426 (edt-map-key "F10"       " - F10 Function Key")
 427 (edt-map-key "F11"       " - F11 Function Key")
 428 (edt-map-key "F12"       " - F12 Function Key")
 429 (edt-map-key "F13"       " - F13 Function Key")
 430 (edt-map-key "F14"       " - F14 Function Key")
 431 (edt-map-key "HELP"      " - HELP Function Key")
 432 (edt-map-key "DO"        " - DO Function Key")
 433 (edt-map-key "F17"       " - F17 Function Key")
 434 (edt-map-key "F18"       " - F18 Function Key")
 435 (edt-map-key "F19"       " - F19 Function Key")
 436 (edt-map-key "F20"       " - F20 Function Key")
 437
 438 (set-buffer "Directions")
 439 (delete-region (point-min) (point-max))
 440 (insert "
 441                        ADDITIONAL FUNCTION KEYS
 442
 443     Your keyboard may have additional function keys which do not correspond
 444     to any LK-201 keys.  The EDT Emulation can be configured to recognize
 445     those keys, since you may wish to add your own key bindings to those keys.
 446
 447     For example, suppose your keyboard has a keycap marked \"Line Del\" and
 448     you wish to add it to the list of keys which can be customized by the EDT
 449     Emulation.  First, assign a unique single-word name to the key for use by
 450     the EDT Emulation, for example, \"linedel\".  Then, at the \"EDT Key
 451     Name:\" prompt, enter \"linedel\", followed by a press of the RETURN key.
 452     Finally, when prompted, press the \"Line Del\" key.  You now will be able
 453     to bind functions to \"linedel\" and \"Gold-linedel\" in edt-user.el in
 454     just the same way you can customize bindings of the LK-201 function and
 455     keypad keys.
 456
 457     When you are done, just press RETURN at the \"EDT Key Name:\" prompt.
 458 ")
 459 (switch-to-buffer "Directions")
 460 ;;;
 461 ;;;  Add support for extras keys
 462 ;;;
 463 (set-buffer "Keys")
 464 (insert "\
 465 ;;
 466 ;;  Extra Keys
 467 ;;
 468 ")
 469 ;;;
 470 ;;;  Restore function-key-map.
 471 ;;;
 472 (if (and edt-window-system (not (featurep 'xemacs)))
 473     (setq function-key-map edt-save-function-key-map))
 474 (setq EDT-key-name "")
 475 (while (not
 476         (string-equal (setq EDT-key-name (read-string "EDT Key Name: ")) ""))
 477   (edt-map-key EDT-key-name ""))
 478
 479 ;
 480 ; No more keys to add, so wrap up.
 481 ;
 482 (set-buffer "Keys")
 483 (insert "\
 484     )
 485   )
 486 ")
 487
 488 ;;;
 489 ;;;  Save the key mapping program
 490 ;;;
 491 ;;;
 492 ;;;  Save the key mapping file
 493 ;;;
 494 (let ((file (concat
 495              "~/.edt-" (if (featurep 'xemacs) "xemacs" "gnu")
 496              (if edt-term (concat "-" edt-term))
 497              (if edt-xserver (concat "-" edt-xserver))
 498              (if edt-window-system (concat "-" (upcase (symbol-name edt-window-system))))
 499              "-keys")))
 500   (set-visited-file-name
 501    (read-file-name (format "Save key mapping to file (default %s): " file) nil file)))
 502 (save-buffer)
 503
 504 (message "That's it!  Press any key to exit")
 505 (sit-for 600)
 506 (kill-emacs t)
 507
 508 ;; arch-tag: 9eea59c8-b8b7-4d66-b858-c8920624c518
 509 ;;; edt-mapper.el ends here