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