code.delx.au - gnu-emacs/blob - lisp/emulation/tpu-mapper.el

   1 ;;; tpu-mapper.el --- create a TPU-edt X-windows keymap file
   2
   3 ;; Copyright (C) 1993, 1994, 1995, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007 Free Software Foundation, Inc.
   5
   6 ;; Author: Rob Riepel <riepel@networking.stanford.edu>
   7 ;; Maintainer: Rob Riepel <riepel@networking.stanford.edu>
   8 ;; Keywords: emulations
   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, or (at your option)
  15 ;; 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; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  25 ;; Boston, MA 02110-1301, USA.
  26
  27 ;;; Commentary:
  28
  29 ;;  This emacs lisp program can be used to create an emacs lisp file that
  30 ;;  defines the TPU-edt keypad for emacs running on x-windows.  Please read
  31 ;;  the "Usage" AND "Known Problems" sections before attempting to run this
  32 ;;  program.
  33
  34 ;;; Usage:
  35
  36 ;;  Simply load this file into the X-windows version of emacs using the
  37 ;;  following command.
  38
  39 ;;    emacs -q -l tpu-mapper
  40
  41 ;;  The "-q" option prevents loading of your .emacs file (commands therein
  42 ;;  might confuse this program).
  43
  44 ;;  An instruction screen showing the TPU-edt keypad will be displayed, and
  45 ;;  you will be prompted to press the TPU-edt editing keys.  Tpu-mapper uses
  46 ;;  the keys you press to create an Emacs Lisp file that will define a
  47 ;;  TPU-edt keypad for your X server.  You can even re-arrange the standard
  48 ;;  EDT keypad to suit your tastes (or to cope with those silly Sun and PC
  49 ;;  keypads).
  50
  51 ;;  Finally, you will be prompted for the name of the file to store the key
  52 ;;  definitions.  If you chose the default, TPU-edt will find it and load it
  53 ;;  automatically.  If you specify a different file name, you will need to
  54 ;;  set the variable "tpu-xkeys-file" before starting TPU-edt.  Here's how
  55 ;;  you might go about doing that in your .emacs file.
  56
  57 ;;    (setq tpu-xkeys-file (expand-file-name "~/.my-emacs-x-keys"))
  58 ;;    (tpu-edt)
  59
  60 ;;; Known Problems:
  61
  62 ;;  Sometimes, tpu-mapper will ignore a key you press, and just continue to
  63 ;;  prompt for the same key.  This can happen when your window manager sucks
  64 ;;  up the key and doesn't pass it on to Emacs, or it could be an Emacs bug.
  65 ;;  Either way, there's nothing that tpu-mapper can do about it.  You must
  66 ;;  press RETURN, to skip the current key and continue.  Later, you and/or
  67 ;;  your local X guru can try to figure out why the key is being ignored.
  68
  69 ;;; Code:
  70
  71
  72 ;;;
  73 ;;;  Make sure we're running X-windows and Emacs version 19
  74 ;;;
  75 (cond
  76  ((not (and window-system (not (string-lessp emacs-version "19"))))
  77   (error "tpu-mapper requires running in Emacs 19, with an X display")))
  78
  79
  80 ;;;
  81 ;;;  Key variables
  82 ;;;
  83 (defvar tpu-kp4 nil)
  84 (defvar tpu-kp5 nil)
  85 (defvar tpu-key nil)
  86 (defvar tpu-enter nil)
  87 (defvar tpu-return nil)
  88 (defvar tpu-key-seq nil)
  89 (defvar tpu-enter-seq nil)
  90 (defvar tpu-return-seq nil)
  91
  92
  93 ;;;
  94 ;;;  Make sure the window is big enough to display the instructions
  95 ;;;
  96 (if (featurep 'xemacs) (set-screen-size (selected-screen) 80 36)
  97   (set-frame-size (selected-frame) 80 36))
  98
  99
 100 ;;;
 101 ;;;  Create buffers - Directions, Keys, Gold-Keys
 102 ;;;
 103 (if (not (get-buffer "Directions")) (generate-new-buffer "Directions"))
 104 (if (not (get-buffer "Keys")) (generate-new-buffer "Keys"))
 105 (if (not (get-buffer "Gold-Keys")) (generate-new-buffer "Gold-Keys"))
 106
 107
 108 ;;;
 109 ;;;  Put headers in the Keys buffer
 110 ;;;
 111 (set-buffer "Keys")
 112 (insert "\
 113 ;;  Key definitions for TPU-edt
 114 ;;
 115 ")
 116
 117
 118 ;;;
 119 ;;;   Display directions
 120 ;;;
 121 (switch-to-buffer "Directions")
 122 (insert "
 123     This program prompts you to press keys to create a custom keymap file
 124     for use with the x-windows version of Emacs and TPU-edt.
 125
 126     Start by pressing the RETURN key, and continue by pressing the keys
 127     specified in the mini-buffer.  You can re-arrange the TPU-edt keypad
 128     by pressing any key you want at any prompt.  If you want to entirely
 129     omit a key, just press RETURN at the prompt.
 130
 131     Here's a picture of the standard TPU/edt keypad for reference:
 132
 133           _______________________    _______________________________
 134          | HELP  |      Do       |  |       |       |       |       |
 135          |KeyDefs|               |  |       |       |       |       |
 136          |_______|_______________|  |_______|_______|_______|_______|
 137           _______________________    _______________________________
 138          | Find  |Insert |Remove |  | Gold  | HELP  |FndNxt | Del L |
 139          |       |       |Sto Tex|  |  key  |E-Help | Find  |Undel L|
 140          |_______|_______|_______|  |_______|_______|_______|_______|
 141          |Select |Pre Scr|Nex Scr|  | Page  | Sect  |Append | Del W |
 142          | Reset |Pre Win|Nex Win|  |  Do   | Fill  |Replace|Undel W|
 143          |_______|_______|_______|  |_______|_______|_______|_______|
 144                  |Move up|          |Forward|Reverse|Remove | Del C |
 145                  |  Top  |          |Bottom |  Top  |Insert |Undel C|
 146           _______|_______|_______   |_______|_______|_______|_______|
 147          |Mov Lef|Mov Dow|Mov Rig|  | Word  |  EOL  | Char  |       |
 148          |StaOfLi|Bottom |EndOfLi|  |ChngCas|Del EOL|SpecIns| Enter |
 149          |_______|_______|_______|  |_______|_______|_______|       |
 150                                     |     Line      |Select | Subs  |
 151                                     |   Open Line   | Reset |       |
 152                                     |_______________|_______|_______|
 153
 154
 155 ")
 156 (delete-other-windows)
 157 (goto-char (point-min))
 158
 159 ;;;
 160 ;;;  Save <CR> for future reference
 161 ;;;
 162 (cond
 163  ((featurep 'xemacs)
 164   (setq tpu-return-seq (read-key-sequence "Hit carriage-return <CR> to continue "))
 165   (setq tpu-return (concat "[" (format "%s" (event-key (aref tpu-return-seq 0))) "]")))
 166  (t
 167   (message "Hit carriage-return <CR> to continue ")
 168   (setq tpu-return-seq (read-event))
 169   (setq tpu-return (concat "[" (format "%s" tpu-return-seq) "]"))))
 170
 171
 172 ;;;
 173 ;;;  Key mapping functions
 174 ;;;
 175 (defun tpu-map-key (ident descrip func gold-func)
 176   (interactive)
 177   (if (featurep 'xemacs)
 178       (progn
 179         (setq tpu-key-seq (read-key-sequence
 180                            (format "Press %s%s: " ident descrip))
 181               tpu-key (format "[%s]" (event-key (aref tpu-key-seq 0))))
 182         (unless (equal tpu-key tpu-return)
 183           (set-buffer "Keys")
 184           (insert (format"(global-set-key %s %s)\n" tpu-key func))
 185           (set-buffer "Gold-Keys")
 186           (insert (format "(define-key GOLD-map %s %s)\n" tpu-key gold-func))))
 187     (message "Press %s%s: " ident descrip)
 188     (setq tpu-key-seq (read-event)
 189           tpu-key (format "[%s]" tpu-key-seq))
 190     (unless (equal tpu-key tpu-return)
 191       (set-buffer "Keys")
 192       (insert (format"(define-key tpu-global-map %s %s)\n" tpu-key func))
 193       (set-buffer "Gold-Keys")
 194       (insert (format "(define-key tpu-gold-map %s %s)\n" tpu-key gold-func))))
 195   (set-buffer "Directions")
 196   tpu-key)
 197
 198 (set-buffer "Keys")
 199 (insert "
 200 ;;  Arrows
 201 ;;
 202 ")
 203 (set-buffer "Gold-Keys")
 204 (insert "
 205 ;;  GOLD Arrows
 206 ;;
 207 ")
 208 (set-buffer "Directions")
 209
 210 (tpu-map-key "Up-Arrow"     ""  "'tpu-previous-line"  "'tpu-move-to-beginning")
 211 (tpu-map-key "Down-arrow"   ""  "'tpu-next-line"      "'tpu-move-to-end")
 212 (tpu-map-key "Right-arrow"  ""  "'tpu-forward-char"   "'end-of-line")
 213 (tpu-map-key "Left-arrow"   ""  "'tpu-backward-char"  "'beginning-of-line")
 214
 215
 216 (set-buffer "Keys")
 217 (insert "
 218 ;;  PF keys
 219 ;;
 220 ")
 221 (set-buffer "Gold-Keys")
 222 (insert "
 223 ;;  GOLD PF keys
 224 ;;
 225 ")
 226 (set-buffer "Directions")
 227
 228 (tpu-map-key "PF1"  " - The GOLD key"               "GOLD-map"                 "'keyboard-quit")
 229 (tpu-map-key "PF2"  " - The Keypad Help key"        "'tpu-help"                 "'help-for-help")
 230 (tpu-map-key "PF3"  " - The Find/Find-Next key"     "'tpu-search-again"         "'tpu-search")
 231 (tpu-map-key "PF4"  " - The Del/Undelete Line key"  "'tpu-delete-current-line"  "'tpu-undelete-lines")
 232
 233 (set-buffer "Keys")
 234 (insert "
 235 ;;  KP0-9 KP- KP, KP. and KPenter
 236 ;;
 237 ")
 238 (set-buffer "Gold-Keys")
 239 (insert "
 240 ;;  GOLD KP0-9 KP- KP, and KPenter
 241 ;;
 242 ")
 243 (set-buffer "Directions")
 244
 245 (tpu-map-key "KP-0"      " - The Line/Open-Line key"               "'tpu-line"                 "'open-line")
 246 (tpu-map-key "KP-1"      " - The Word/Change-Case key"             "'tpu-word"                 "'tpu-change-case")
 247 (tpu-map-key "KP-2"      " - The EOL/Delete-EOL key"               "'tpu-end-of-line"          "'tpu-delete-to-eol")
 248 (tpu-map-key "KP-3"      " - The Character/Special-Insert key"     "'tpu-char"                 "'tpu-special-insert")
 249 (setq tpu-kp4 (tpu-map-key "KP-4"      " - The Forward/Bottom key"               "'tpu-advance-direction"    "'tpu-move-to-end"))
 250 (setq tpu-kp5 (tpu-map-key "KP-5"      " - The Reverse/Top key"                  "'tpu-backup-direction"     "'tpu-move-to-beginning"))
 251 (tpu-map-key "KP-6"      " - The Remove/Insert key"                "'tpu-cut"                  "'tpu-paste")
 252 (tpu-map-key "KP-7"      " - The Page/Do key"                      "'tpu-page"                 "'execute-extended-command")
 253 (tpu-map-key "KP-8"      " - The Section/Fill key"                 "'tpu-scroll-window"        "'tpu-fill")
 254 (tpu-map-key "KP-9"      " - The Append/Replace key"               "'tpu-append-region"        "'tpu-replace")
 255 (tpu-map-key "KP--"      " - The Delete/Undelete Word key"         "'tpu-delete-current-word"  "'tpu-undelete-words")
 256 (tpu-map-key "KP-,"      " - The Delete/Undelete Character key"    "'tpu-delete-current-char"  "'tpu-undelete-char")
 257 (tpu-map-key "KP-."      " - The Select/Reset key"                 "'tpu-select"               "'tpu-unselect")
 258 (tpu-map-key "KP-Enter"  " - The Enter key on the numeric keypad"  "'newline"                  "'tpu-substitute")
 259 ;; Save the enter key
 260 (setq tpu-enter tpu-key)
 261 (setq tpu-enter-seq tpu-key-seq)
 262
 263 (set-buffer "Keys")
 264 (insert "
 265 ;;  Editing keypad (find, insert, remove)
 266 ;;                 (select, prev, next)
 267 ;;
 268 ")
 269 (set-buffer "Gold-Keys")
 270 (insert "
 271 ;;  GOLD Editing keypad (find, insert, remove)
 272 ;;                      (select, prev, next)
 273 ;;
 274 ")
 275 (set-buffer "Directions")
 276
 277 (tpu-map-key "Find"      " - The Find key on the editing keypad"       "'tpu-search"              "'nil")
 278 (tpu-map-key "Insert"    " - The Insert key on the editing keypad"     "'tpu-paste"               "'nil")
 279 (tpu-map-key "Remove"    " - The Remove key on the editing keypad"     "'tpu-cut"                 "'tpu-store-text")
 280 (tpu-map-key "Select"    " - The Select key on the editing keypad"     "'tpu-select"              "'tpu-unselect")
 281 (tpu-map-key "Prev Scr"  " - The Prev Scr key on the editing keypad"   "'tpu-scroll-window-down"  "'tpu-previous-window")
 282 (tpu-map-key "Next Scr"  " - The Next Scr key on the editing keypad"   "'tpu-scroll-window-up"    "'tpu-next-window")
 283
 284 (set-buffer "Keys")
 285 (insert "
 286 ;;  F10-14 Help Do F17
 287 ;;
 288 ")
 289 (set-buffer "Gold-Keys")
 290 (insert "
 291 ;;  GOLD F10-14 Help Do F17
 292 ;;
 293 ")
 294 (set-buffer "Directions")
 295
 296 (tpu-map-key "F10"       " - Invokes the Exit function on VT200+ terminals"  "'tpu-exit"                    "'nil")
 297 (tpu-map-key "F11"       " - Inserts an Escape character into the text"      "'tpu-insert-escape"           "'nil")
 298 (tpu-map-key "Backspace" " - Not Delete nor ^H!  Sometimes on the F12 key"   "'tpu-next-beginning-of-line" "'nil")
 299 (tpu-map-key "F13"       " - Invokes the delete previous word function"      "'tpu-delete-previous-word"   "'nil")
 300 (tpu-map-key "F14"       " - Toggles insert/overstrike modes"                "'tpu-toggle-overwrite-mode"  "'nil")
 301 (tpu-map-key "Help"      " - Brings up the help screen, same as PF2"         "'tpu-help"                   "'describe-bindings")
 302 (tpu-map-key "Do"        " - Invokes the COMMAND function"                   "'execute-extended-command"   "'nil")
 303 (tpu-map-key "F17"       ""                                                  "'tpu-goto-breadcrumb"        "'tpu-drop-breadcrumb")
 304
 305 (set-buffer "Gold-Keys")
 306 (cond
 307  ((not (equal tpu-enter tpu-return))
 308   (insert "
 309 ;;  Minibuffer map additions to make KP_enter = RET
 310 ;;
 311 ")
 312
 313   (insert (format "(define-key minibuffer-local-map %s 'exit-minibuffer)\n" tpu-enter))
 314   (insert (format "(define-key minibuffer-local-ns-map %s 'exit-minibuffer)\n" tpu-enter))
 315   (insert (format "(define-key minibuffer-local-completion-map %s 'exit-minibuffer)\n" tpu-enter))
 316   (insert (format "(define-key minibuffer-local-must-match-map %s 'minibuffer-complete-and-exit)\n" tpu-enter))))
 317
 318 (cond
 319  ((not (or (equal tpu-kp4 tpu-return) (equal tpu-kp5 tpu-return)))
 320   (insert "
 321 ;;  Minibuffer map additions to allow KP-4/5 termination of search strings.
 322 ;;
 323 ")
 324
 325   (insert (format "(define-key minibuffer-local-map %s 'tpu-search-forward-exit)\n" tpu-kp4))
 326   (insert (format "(define-key minibuffer-local-map %s 'tpu-search-backward-exit)\n" tpu-kp5))))
 327
 328 (insert "
 329 ;;  Define the tpu-help-enter/return symbols
 330 ;;
 331 ")
 332
 333 (cond ((featurep 'xemacs)
 334        (insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter-seq))
 335        (insert (format "(setq tpu-help-return \"%s\")\n" tpu-return-seq))
 336        (insert "(setq tpu-help-N \"[#<keypress-event N>]\")\n")
 337        (insert "(setq tpu-help-n \"[#<keypress-event n>]\")\n")
 338        (insert "(setq tpu-help-P \"[#<keypress-event P>]\")\n")
 339        (insert "(setq tpu-help-p \"[#<keypress-event p>]\")\n"))
 340       (t
 341        (insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter))))
 342
 343 (append-to-buffer "Keys" 1 (point))
 344 (set-buffer "Keys")
 345
 346 ;;;
 347 ;;;  Save the key mapping program
 348 ;;;
 349 (let ((file
 350        (convert-standard-filename
 351         (if (featurep 'xemacs) "~/.tpu-lucid-keys" "~/.tpu-keys"))))
 352   (set-visited-file-name
 353    (read-file-name (format "Save key mapping to file (default %s): " file) "" file)))
 354 (save-buffer)
 355
 356 ;;;
 357 ;;;  Load the newly defined keys and clean up
 358 ;;;
 359 (eval-buffer)
 360 (kill-buffer (current-buffer))
 361 (kill-buffer "*scratch*")
 362 (kill-buffer "Gold-Keys")
 363
 364 ;;;
 365 ;;;  Let them know it worked.
 366 ;;;
 367 (switch-to-buffer "Directions")
 368 (erase-buffer)
 369 (insert "
 370     A custom TPU-edt keymap file has been created.
 371
 372     Press GOLD-k to remove this buffer and continue editing.
 373 ")
 374 (goto-char (point-min))
 375
 376 ;; arch-tag: bab5872f-cd3a-4c1c-aedb-047b67646f6c
 377 ;;; tpu-mapper.el ends here