path: root/lisp/emulation/edt-mapper.el

;;; edt-mapper.el --- create an EDT LK-201 map file for X-Windows Emacs

;; Copyright (C) 1994-1995, 2000-2021 Free Software Foundation, Inc.

;; Author: Kevin Gallagher <kevin.gal@verizon.net>
;; Keywords: emulations
;; Package: edt

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:
;;

;;  [Part of the GNU Emacs EDT Emulation.]

;;  This emacs lisp program can be used to create an emacs lisp file
;;  that defines the mapping of the user's keyboard to the LK-201
;;  keyboard function keys and keypad keys (around which EDT has been
;;  designed).  Please read the "Usage" AND "Known Problems" sections
;;  below before attempting to run this program.  (The design of this
;;  file, edt-mapper.el, was heavily influenced by tpu-mapper.el.)

;;  Version 4.0 contains the following enhancements:

;;  1.  If you access a workstation using an X Server, note that the
;;      initialization file generated by edt-mapper.el will now
;;      contain the name of the X Server vendor.  This is a
;;      convenience for those who have access to their Unix account
;;      from more than one type of X Server.  Since different X
;;      Servers typically require different EDT emulation
;;      initialization files, edt-mapper.el will now generate these
;;      different initialization files and save them with different
;;      names.

;;  2.  Also, edt-mapper.el is now capable of binding an ASCII key
;;      sequence, providing the ASCII key sequence prefix is already
;;      known by Emacs to be a prefix.  As a result, some
;;      terminal/keyboard/window system configurations, which don't
;;      have a complete set of sensible function key map bindings, can
;;      still be configured for EDT Emulation.


;;  Usage:

;;  Simply load this file into emacs and run the function edt-mapper,
;;  using the following command.

;;    emacs -q -l edt-mapper -f edt-mapper

;;  The "-q" option prevents loading of your init file (commands
;;  therein might confuse this program).

;;  An instruction screen showing the typical LK-201 terminal
;;  functions keys will be displayed, and you will be prompted to
;;  press the keys on your keyboard which you want to emulate the
;;  corresponding LK-201 keys.

;;  Finally, you will be prompted for the name of the file to store
;;  the key definitions.  If you chose the default, it will be found
;;  and loaded automatically when the EDT emulation is started.  If
;;  you specify a different file name, you will need to set the
;;  variable "edt-keys-file" before starting the EDT emulation.
;;  Here's how you might go about doing that in your init file:

;;    (setq edt-keys-file (expand-file-name "~/.my-emacs-keys"))


;;  Known Problems:

;;  Sometimes, edt-mapper will ignore a key you press, and just
;;  continue to prompt for the same key.  This can happen when your
;;  window manager sucks up the key and doesn't pass it on to emacs,
;;  or it could be an emacs bug.  Either way, there's nothing that
;;  edt-mapper can do about it.  You must press RETURN, to skip the
;;  current key and continue.  Later, you and/or your local Emacs guru
;;  can try to figure out why the key is being ignored.

;;; History:
;;

;;  Version 4.0    2000    Added 2 New Features

;;; Code:

;;;
;;;  Determine Window System, and X Server Vendor (if appropriate).
;;;
(define-obsolete-variable-alias 'edt-window-system 'window-system "27.1")

(defconst edt-xserver (when (eq window-system 'x)
			;; The Cygwin window manager has a `/' in its
			;; name, which breaks the generated file name of
			;; the custom key map file.  Replace `/' with a
			;; `-' to work around that.
			(replace-regexp-in-string "[ /]" "-"
                                                  (x-server-vendor)))
  "Indicates X server vendor name, if applicable.")


;;;
;;;  Key variables
;;;

;; FIXME some/all of these should be let-bound, not global.
(defvar edt-key nil)
(defvar edt-enter nil)
(defvar edt-return nil)
(defvar edt-key-seq nil)
(defvar edt-enter-seq nil)
(defvar edt-return-seq nil)
(defvar edt-term nil)

;; To silence the byte-compiler
(defvar EDT-key-name)
(defvar edt-save-function-key-map)

;;;
;;;  Key mapping functions
;;;
(defun edt-map-key (ident descrip)
  (interactive)
  (setq edt-key (read-key-sequence (format "Press %s%s: " ident descrip)))
  (cond ((not (equal edt-key edt-return))
         (set-buffer "Keys")
         (insert (if (vectorp edt-key)
                     (format "    (\"%s\" . %s)\n" ident edt-key)
                   (format "    (\"%s\" . \"%s\")\n" ident edt-key)))
         (set-buffer "Directions"))
        ;; bogosity to get next prompt to come up, if the user hits <CR>!
        ;; check periodically to see if this is still needed...
        (t
         (set-buffer "Keys")
         (insert (format "    (\"%s\" . \"\" )\n" ident))
         (set-buffer "Directions")))
  edt-key)

(defun edt-mapper ()
  (if noninteractive
    (user-error "edt-mapper cannot be loaded in batch mode"))
  ;;  Determine Terminal Type (if appropriate).
  (if (and window-system (not (eq window-system 'tty)))
      (setq edt-term nil)
    (setq edt-term (getenv "TERM")))
  ;;
  ;; Implements a workaround for a feature that was added to simple.el.
  ;;
  ;; Many function keys have no Emacs functions assigned to them by
  ;; default. A subset of these are typically assigned functions in the
  ;; EDT emulation. This includes all the keypad keys and a some others
  ;; like Delete.
  ;;
  ;; Logic in simple.el maps some of these unassigned function keys to
  ;; ordinary typing keys.  Where this is the case, a call to
  ;; read-key-sequence, below, does not return the name of the function
  ;; key pressed by the user but, instead, it returns the name of the
  ;; key to which it has been mapped.  It needs to know the name of the
  ;; key pressed by the user. As a workaround, we assign a function to
  ;; each of the unassigned function keys of interest, here.  These
  ;; assignments override the mapping to other keys and are only
  ;; temporary since, when edt-mapper is finished executing, it causes
  ;; Emacs to exit.
  ;;
  (mapc
   (lambda (function-key)
     (if (not (lookup-key (current-global-map) function-key))
	 (define-key (current-global-map) function-key 'forward-char)))
   '([kp-0] [kp-1] [kp-2] [kp-3] [kp-4]
     [kp-5] [kp-6] [kp-7] [kp-8] [kp-9]
     [kp-space]
     [kp-tab]
     [kp-enter]
     [kp-multiply]
     [kp-add]
     [kp-separator]
     [kp-subtract]
     [kp-decimal]
     [kp-divide]
     [kp-equal]
     [backspace]
     [delete]
     [tab]
     [linefeed]
     [clear]))
  ;;
  ;;  Make sure the window is big enough to display the instructions,
  ;;  except where window cannot be re-sized.
  ;;
  (if (and window-system (not (eq window-system 'tty)))
      (set-frame-size (selected-frame) 80 36))
  ;;
  ;;  Create buffers - Directions and Keys
  ;;
  (if (not (get-buffer "Directions")) (generate-new-buffer "Directions"))
  (if (not (get-buffer "Keys")) (generate-new-buffer "Keys"))
  ;;
  ;;  Put header in the Keys buffer
  ;;
  (set-buffer "Keys")
  (insert "\
;;
;;  Key definitions for the EDT emulation within GNU Emacs
;;

\(defconst *EDT-keys*
  '(
    ")

  ;;
  ;;   Display directions
  ;;
  (switch-to-buffer "Directions")
  (if (and window-system (not (eq window-system 'tty)))
      (insert "
                                  EDT MAPPER

    You will be asked to press keys to create a custom mapping (under a
    Window Manager) of your keypad keys and function keys so that they can
    emulate the LK-201 keypad and function keys or the subset of keys found
    on a VT-100 series terminal keyboard.  (The LK-201 keyboard is the
    standard keyboard attached to VT-200 series terminals, and above.)

    Sometimes, edt-mapper will ignore a key you press, and just continue to
    prompt for the same key.  This can happen when your window manager sucks
    up the key and doesn't pass it on to Emacs, or it could be an Emacs bug.
    Either way, there's nothing that edt-mapper can do about it.  You must
    press RETURN, to skip the current key and continue.  Later, you and/or
    your local system guru can try to figure out why the key is being ignored.

    Start by pressing the RETURN key, and continue by pressing the keys
    specified in the mini-buffer.  If you want to entirely omit a key,
    because your keyboard does not have a corresponding key, for example,
    just press RETURN at the prompt.

")
    (insert "
                                  EDT MAPPER

    You will be asked to press keys to create a custom mapping of your
    keypad keys and function keys so that they can emulate the LK-201
    keypad and function keys or the subset of keys found on a VT-100
    series terminal keyboard.  (The LK-201 keyboard is the standard
    keyboard attached to VT-200 series terminals, and above.)

    If you are using a real LK-201 keyboard, you should map the keys
    exactly as they are on the keyboard.

    Start by pressing the RETURN key, and continue by pressing the keys
    specified in the mini-buffer.  If you want to entirely omit a key,
    because your keyboard does not have a corresponding key, for example,
    just press RETURN at the prompt.

"))

  (delete-other-windows)

  ;;
  ;;  Save <CR> for future reference.
  ;;
  ;;  For Emacs running in a Window System, first hide bindings in
  ;;  function-key-map.
  ;;
  (if window-system
      (progn
        (setq edt-save-function-key-map function-key-map)
        (setq function-key-map (make-sparse-keymap))))
  (setq edt-return (read-key-sequence "Hit carriage-return <CR> to continue "))

  ;;
  ;;  Remove prefix-key bindings to F1 and F2 in global-map so they can be
  ;;  bound in the EDT Emulation mode.
  ;;
  (global-unset-key [f1])
  (global-unset-key [f2])

  ;;
  ;;   Display Keypad Diagram and Begin Prompting for Keys
  ;;
  (set-buffer "Directions")
  (delete-region (point-min) (point-max))
  (if (and window-system (not (eq window-system 'tty)))
      (insert "

          PRESS THE KEY SPECIFIED IN THE MINIBUFFER BELOW.

    Here's a picture of the standard LK-201 keypad for reference:

          ________________________    _______________________________
         | HELP  |      DO        |  |  F17  |  F18  |  F19  |  F20  |
         |       |                |  |       |       |       |       |
         |_______|________________|  |_______|_______|_______|_______|
          ________________________   _______________________________
         | FIND  |INSERT  |REMOVE |  |  PF1  |  PF2  |  PF3  |  PF4  |
         |       |        |       |  |       |       |       |       |
         |_______|________|_______|  |_______|_______|_______|_______|
         |SELECT |PREVIOUS|NEXT   |  |  KP7  |  KP8  |  KP9  |  KP-  |
         |       |        |       |  |       |       |       |       |
         |_______|________|_______|  |_______|_______|_______|_______|
                 |   UP   |          |  KP4  |  KP5  |  KP6  |  KP,  |
                 |        |          |       |       |       |       |
          _______|________|_______   |_______|_______|_______|_______|
         |  LEFT |  DOWN  | RIGHT |  |  KP1  |  KP2  |  KP3  |       |
         |       |        |       |  |       |       |       |       |
         |_______|________|_______|  |_______|_______|_______|  KPE  |
                                     |      KP0      |  KPP  |       |
                                     |               |       |       |
                                     |_______________|_______|_______|

         REMEMBER:  JUST PRESS RETURN TO SKIP MAPPING A KEY.

")
    (progn
      (insert "
    GENERATING A CUSTOM CONFIGURATION FILE FOR TERMINAL TYPE:  ")
      (insert (format "%s." edt-term))
      (insert "

          PRESS THE KEY SPECIFIED IN THE MINIBUFFER BELOW.

          ________________________    _______________________________
         | HELP  |       DO       |  |  F17  |  F18  |  F19  |  F20  |
         |_______|________________|  |_______|_______|_______|_______|
          ________________________    _______________________________
         | FIND  |INSERT  |REMOVE |  |  PF1  |  PF2  |  PF3  |  PF4  |
         |_______|________|_______|  |_______|_______|_______|_______|
         |SELECT |PREVIOUS| NEXT  |  |  KP7  |  KP8  |  KP9  |  KP-  |
         |_______|________|_______|  |_______|_______|_______|_______|
                 |   UP   |          |  KP4  |  KP5  |  KP6  |  KP,  |
          _______|________|_______   |_______|_______|_______|_______|
         |  LEFT |  DOWN  | RIGHT |  |  KP1  |  KP2  |  KP3  |       |
         |_______|________|_______|  |_______|_______|_______|  KPE  |
                                     |      KP0      |  KPP  |       |
                                     |_______________|_______|_______|

         REMEMBER:  JUST PRESS RETURN TO SKIP MAPPING A KEY.")))



  (set-buffer "Keys")
  (insert "
;;
;;  Arrows
;;
")
  (set-buffer "Directions")

  (edt-map-key "UP"     " - The Up Arrow Key")
  (edt-map-key "DOWN"   " - The Down Arrow Key")
  (edt-map-key "LEFT"   " - The Left Arrow Key")
  (edt-map-key "RIGHT"  " - The Right Arrow Key")


  (set-buffer "Keys")
  (insert "
;;
;;  PF keys
;;
")
  (set-buffer "Directions")

  (edt-map-key "PF1"  " - The PF1 (GOLD) Key")
  (edt-map-key "PF2"  " - The Keypad PF2 Key")
  (edt-map-key "PF3"  " - The Keypad PF3 Key")
  (edt-map-key "PF4"  " - The Keypad PF4 Key")

  (set-buffer "Keys")
  (insert "
;;
;;  KP0-9 KP- KP, KPP and KPE
;;
")
  (set-buffer "Directions")

  (edt-map-key "KP0"      " - The Keypad 0 Key")
  (edt-map-key "KP1"      " - The Keypad 1 Key")
  (edt-map-key "KP2"      " - The Keypad 2 Key")
  (edt-map-key "KP3"      " - The Keypad 3 Key")
  (edt-map-key "KP4"      " - The Keypad 4 Key")
  (edt-map-key "KP5"      " - The Keypad 5 Key")
  (edt-map-key "KP6"      " - The Keypad 6 Key")
  (edt-map-key "KP7"      " - The Keypad 7 Key")
  (edt-map-key "KP8"      " - The Keypad 8 Key")
  (edt-map-key "KP9"      " - The Keypad 9 Key")
  (edt-map-key "KP-"      " - The Keypad - Key")
  (edt-map-key "KP,"      " - The Keypad , Key")
  (edt-map-key "KPP"      " - The Keypad . Key")
  (edt-map-key "KPE"      " - The Keypad Enter Key")
  ;; Save the enter key
  (setq edt-enter edt-key)
  (setq edt-enter-seq edt-key-seq)


  (set-buffer "Keys")
  (insert "
;;
;;  Editing keypad (FIND, INSERT, REMOVE)
;;                 (SELECT, PREVIOUS, NEXT)
;;
")
  (set-buffer "Directions")

  (edt-map-key "FIND"      " - The Find key on the editing keypad")
  (edt-map-key "INSERT"    " - The Insert key on the editing keypad")
  (edt-map-key "REMOVE"    " - The Remove key on the editing keypad")
  (edt-map-key "SELECT"    " - The Select key on the editing keypad")
  (edt-map-key "PREVIOUS"  " - The Prev Scr key on the editing keypad")
  (edt-map-key "NEXT"      " - The Next Scr key on the editing keypad")

  (set-buffer "Keys")
  (insert "
;;
;;  F1-14 Help Do F17-F20
;;
")
  (set-buffer "Directions")

  (edt-map-key "F1"        " - F1 Function Key")
  (edt-map-key "F2"        " - F2 Function Key")
  (edt-map-key "F3"        " - F3 Function Key")
  (edt-map-key "F4"        " - F4 Function Key")
  (edt-map-key "F5"        " - F5 Function Key")
  (edt-map-key "F6"        " - F6 Function Key")
  (edt-map-key "F7"        " - F7 Function Key")
  (edt-map-key "F8"        " - F8 Function Key")
  (edt-map-key "F9"        " - F9 Function Key")
  (edt-map-key "F10"       " - F10 Function Key")
  (edt-map-key "F11"       " - F11 Function Key")
  (edt-map-key "F12"       " - F12 Function Key")
  (edt-map-key "F13"       " - F13 Function Key")
  (edt-map-key "F14"       " - F14 Function Key")
  (edt-map-key "HELP"      " - HELP Function Key")
  (edt-map-key "DO"        " - DO Function Key")
  (edt-map-key "F17"       " - F17 Function Key")
  (edt-map-key "F18"       " - F18 Function Key")
  (edt-map-key "F19"       " - F19 Function Key")
  (edt-map-key "F20"       " - F20 Function Key")

  (set-buffer "Directions")
  (delete-region (point-min) (point-max))
  (insert "
                       ADDITIONAL FUNCTION KEYS

    Your keyboard may have additional function keys which do not correspond
    to any LK-201 keys.  The EDT Emulation can be configured to recognize
    those keys, since you may wish to add your own key bindings to those keys.

    For example, suppose your keyboard has a keycap marked \"Line Del\" and
    you wish to add it to the list of keys which can be customized by the EDT
    Emulation.  First, assign a unique single-word name to the key for use by
    the EDT Emulation, for example, \"linedel\".  Then, at the \"EDT Key
    Name:\" prompt, enter \"linedel\", followed by a press of the RETURN key.
    Finally, when prompted, press the \"Line Del\" key.  You now will be able
    to bind functions to \"linedel\" and \"Gold-linedel\" in edt-user.el in
    just the same way you can customize bindings of the LK-201 function and
    keypad keys.

    When you are done, just press RETURN at the \"EDT Key Name:\" prompt.
")
  (switch-to-buffer "Directions")
  ;;
  ;;  Add support for extras keys
  ;;
  (set-buffer "Keys")
  (insert "\
;;
;;  Extra Keys
;;
")
  ;;
  ;;  Restore function-key-map.
  ;;
  (if window-system
      (setq function-key-map edt-save-function-key-map))
  (setq EDT-key-name "")
  (while (not
	  (string-equal (setq EDT-key-name (read-string "EDT Key Name: ")) ""))
    (edt-map-key EDT-key-name ""))

  ;;
  ;; No more keys to add, so wrap up.
  ;;
  (set-buffer "Keys")
  (insert "\
    )
  )
")

  ;;
  ;;  Save the key mapping program
  ;;
  ;;
  ;;  Save the key mapping file
  ;;
  (let ((file (concat
	       "~/.edt-gnu"
	       (if edt-term (concat "-" edt-term))
	       (if edt-xserver (concat "-" edt-xserver))
	       (if window-system (concat "-" (upcase (symbol-name window-system))))
	       "-keys")))
    (set-visited-file-name
     (read-file-name (format-prompt "Save key mapping to file" file)
                     nil file)))
  (save-buffer)

  (message "That's it!  Press any key to exit")
  (sit-for 600)
  (kill-emacs t))

;;; edt-mapper.el ends here