(tpu-mapper): New command. Contains all the code previously at top-level.

This commit is contained in:
Stefan Monnier 2008-01-04 06:52:03 +00:00
parent 48d33090d0
commit f33e2ef151

View file

@ -1,7 +1,7 @@
;;; tpu-mapper.el --- create a TPU-edt X-windows keymap file
;; Copyright (C) 1993, 1994, 1995, 2001, 2002, 2003, 2004,
;; 2005, 2006, 2007 Free Software Foundation, Inc.
;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: Rob Riepel <riepel@networking.stanford.edu>
;; Maintainer: Rob Riepel <riepel@networking.stanford.edu>
@ -26,57 +26,11 @@
;;; Commentary:
;; This emacs lisp program can be used to create an emacs lisp file that
;; defines the TPU-edt keypad for emacs running on x-windows. Please read
;; the "Usage" AND "Known Problems" sections before attempting to run this
;; program.
;;; Usage:
;; Simply load this file into the X-windows version of emacs using the
;; following command.
;; emacs -q -l tpu-mapper
;; The "-q" option prevents loading of your .emacs file (commands therein
;; might confuse this program).
;; An instruction screen showing the TPU-edt keypad will be displayed, and
;; you will be prompted to press the TPU-edt editing keys. Tpu-mapper uses
;; the keys you press to create an Emacs Lisp file that will define a
;; TPU-edt keypad for your X server. You can even re-arrange the standard
;; EDT keypad to suit your tastes (or to cope with those silly Sun and PC
;; keypads).
;; Finally, you will be prompted for the name of the file to store the key
;; definitions. If you chose the default, TPU-edt will find it and load it
;; automatically. If you specify a different file name, you will need to
;; set the variable "tpu-xkeys-file" before starting TPU-edt. Here's how
;; you might go about doing that in your .emacs file.
;; (setq tpu-xkeys-file (expand-file-name "~/.my-emacs-x-keys"))
;; (tpu-edt)
;;; Known Problems:
;; Sometimes, tpu-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 tpu-mapper can do about it. You must
;; press RETURN, to skip the current key and continue. Later, you and/or
;; your local X guru can try to figure out why the key is being ignored.
;; This Emacs Lisp program can be used to create an Emacs Lisp file that
;; defines the TPU-edt keypad for Emacs running on X-Windows.
;;; Code:
;;;
;;; Make sure we're running X-windows and Emacs version 19
;;;
(cond
((not (and window-system (not (string-lessp emacs-version "19"))))
(error "tpu-mapper requires running in Emacs 19, with an X display")))
;;;
;;; Key variables
;;;
@ -89,37 +43,89 @@
(defvar tpu-enter-seq nil)
(defvar tpu-return-seq nil)
;;;
;;; Key mapping function
;;;
(defun tpu-map-key (ident descrip func gold-func)
(interactive)
(if (featurep 'xemacs)
(progn
(setq tpu-key-seq (read-key-sequence
(format "Press %s%s: " ident descrip))
tpu-key (format "[%s]" (event-key (aref tpu-key-seq 0))))
(unless (equal tpu-key tpu-return)
(set-buffer "Keys")
(insert (format"(global-set-key %s %s)\n" tpu-key func))
(set-buffer "Gold-Keys")
(insert (format "(define-key GOLD-map %s %s)\n" tpu-key gold-func))))
(message "Press %s%s: " ident descrip)
(setq tpu-key-seq (read-event)
tpu-key (format "[%s]" tpu-key-seq))
(unless (equal tpu-key tpu-return)
(set-buffer "Keys")
(insert (format"(define-key tpu-global-map %s %s)\n" tpu-key func))
(set-buffer "Gold-Keys")
(insert (format "(define-key tpu-gold-map %s %s)\n" tpu-key gold-func))))
(set-buffer "Directions")
tpu-key)
;;;
;;; Make sure the window is big enough to display the instructions
;;;
(if (featurep 'xemacs) (set-screen-size (selected-screen) 80 36)
(set-frame-size (selected-frame) 80 36))
;;;###autoload
(defun tpu-mapper ()
"Create an Emacs lisp file defining the TPU-edt keypad for X-windows.
This command displays an instruction screen showing the TPU-edt keypad
and asks you to press the TPU-edt editing keys. It uses the keys you
press to create an Emacs Lisp file that will define a TPU-edt keypad
for your X server. You can even re-arrange the standard EDT keypad to
suit your tastes (or to cope with those silly Sun and PC keypads).
;;;
;;; Create buffers - Directions, Keys, Gold-Keys
;;;
(if (not (get-buffer "Directions")) (generate-new-buffer "Directions"))
(if (not (get-buffer "Keys")) (generate-new-buffer "Keys"))
(if (not (get-buffer "Gold-Keys")) (generate-new-buffer "Gold-Keys"))
Finally, you will be prompted for the name of the file to store the key
definitions. If you chose the default, TPU-edt will find it and load it
automatically. If you specify a different file name, you will need to
set the variable ``tpu-xkeys-file'' before starting TPU-edt. Here's how
you might go about doing that in your .emacs file.
(setq tpu-xkeys-file (expand-file-name \"~/.my-emacs-x-keys\"))
(tpu-edt)
;;;
;;; Put headers in the Keys buffer
;;;
(set-buffer "Keys")
(insert "\
Known Problems:
Sometimes, tpu-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 tpu-mapper can do about it. You must
press RETURN, to skip the current key and continue. Later, you and/or
your local X guru can try to figure out why the key is being ignored."
(interactive)
;; Make sure we're running X-windows
(if (not window-system)
(error "tpu-mapper requires running Emacs with an X display"))
;; Make sure the window is big enough to display the instructions
(if (featurep 'xemacs) (set-screen-size (selected-screen) 80 36)
(set-frame-size (selected-frame) 80 36))
;; Create buffers - Directions, Keys, Gold-Keys
(if (not (get-buffer "Directions")) (generate-new-buffer "Directions"))
(if (not (get-buffer "Keys")) (generate-new-buffer "Keys"))
(if (not (get-buffer "Gold-Keys")) (generate-new-buffer "Gold-Keys"))
;; Put headers in the Keys buffer
(set-buffer "Keys")
(insert "\
;; Key definitions for TPU-edt
;;
")
;; Display directions
;;;
;;; Display directions
;;;
(switch-to-buffer "Directions")
(insert "
(switch-to-buffer "Directions")
(insert "
This program prompts you to press keys to create a custom keymap file
for use with the x-windows version of Emacs and TPU-edt.
@ -153,225 +159,197 @@
")
(delete-other-windows)
(goto-char (point-min))
(delete-other-windows)
(goto-char (point-min))
;;;
;;; Save <CR> for future reference
;;;
(cond
((featurep 'xemacs)
(setq tpu-return-seq (read-key-sequence "Hit carriage-return <CR> to continue "))
(setq tpu-return (concat "[" (format "%s" (event-key (aref tpu-return-seq 0))) "]")))
(t
(message "Hit carriage-return <CR> to continue ")
(setq tpu-return-seq (read-event))
(setq tpu-return (concat "[" (format "%s" tpu-return-seq) "]"))))
;; Save <CR> for future reference
(cond
((featurep 'xemacs)
(setq tpu-return-seq (read-key-sequence "Hit carriage-return <CR> to continue "))
(setq tpu-return (concat "[" (format "%s" (event-key (aref tpu-return-seq 0))) "]")))
(t
(message "Hit carriage-return <CR> to continue ")
(setq tpu-return-seq (read-event))
(setq tpu-return (concat "[" (format "%s" tpu-return-seq) "]"))))
;;;
;;; Key mapping functions
;;;
(defun tpu-map-key (ident descrip func gold-func)
(interactive)
(if (featurep 'xemacs)
(progn
(setq tpu-key-seq (read-key-sequence
(format "Press %s%s: " ident descrip))
tpu-key (format "[%s]" (event-key (aref tpu-key-seq 0))))
(unless (equal tpu-key tpu-return)
(set-buffer "Keys")
(insert (format"(global-set-key %s %s)\n" tpu-key func))
(set-buffer "Gold-Keys")
(insert (format "(define-key GOLD-map %s %s)\n" tpu-key gold-func))))
(message "Press %s%s: " ident descrip)
(setq tpu-key-seq (read-event)
tpu-key (format "[%s]" tpu-key-seq))
(unless (equal tpu-key tpu-return)
(set-buffer "Keys")
(insert (format"(define-key tpu-global-map %s %s)\n" tpu-key func))
(set-buffer "Gold-Keys")
(insert (format "(define-key tpu-gold-map %s %s)\n" tpu-key gold-func))))
(set-buffer "Directions")
tpu-key)
;; Build the keymap file
(set-buffer "Keys")
(insert "
(set-buffer "Keys")
(insert "
;; Arrows
;;
")
(set-buffer "Gold-Keys")
(insert "
(set-buffer "Gold-Keys")
(insert "
;; GOLD Arrows
;;
")
(set-buffer "Directions")
(set-buffer "Directions")
(tpu-map-key "Up-Arrow" "" "'tpu-previous-line" "'tpu-move-to-beginning")
(tpu-map-key "Down-arrow" "" "'tpu-next-line" "'tpu-move-to-end")
(tpu-map-key "Right-arrow" "" "'tpu-forward-char" "'end-of-line")
(tpu-map-key "Left-arrow" "" "'tpu-backward-char" "'beginning-of-line")
(tpu-map-key "Up-Arrow" "" "'tpu-previous-line" "'tpu-move-to-beginning")
(tpu-map-key "Down-arrow" "" "'tpu-next-line" "'tpu-move-to-end")
(tpu-map-key "Right-arrow" "" "'tpu-forward-char" "'end-of-line")
(tpu-map-key "Left-arrow" "" "'tpu-backward-char" "'beginning-of-line")
(set-buffer "Keys")
(insert "
(set-buffer "Keys")
(insert "
;; PF keys
;;
")
(set-buffer "Gold-Keys")
(insert "
(set-buffer "Gold-Keys")
(insert "
;; GOLD PF keys
;;
")
(set-buffer "Directions")
(set-buffer "Directions")
(tpu-map-key "PF1" " - The GOLD key" "GOLD-map" "'keyboard-quit")
(tpu-map-key "PF2" " - The Keypad Help key" "'tpu-help" "'help-for-help")
(tpu-map-key "PF3" " - The Find/Find-Next key" "'tpu-search-again" "'tpu-search")
(tpu-map-key "PF4" " - The Del/Undelete Line key" "'tpu-delete-current-line" "'tpu-undelete-lines")
(tpu-map-key "PF1" " - The GOLD key" "GOLD-map" "'keyboard-quit")
(tpu-map-key "PF2" " - The Keypad Help key" "'tpu-help" "'help-for-help")
(tpu-map-key "PF3" " - The Find/Find-Next key" "'tpu-search-again" "'tpu-search")
(tpu-map-key "PF4" " - The Del/Undelete Line key" "'tpu-delete-current-line" "'tpu-undelete-lines")
(set-buffer "Keys")
(insert "
(set-buffer "Keys")
(insert "
;; KP0-9 KP- KP, KP. and KPenter
;;
")
(set-buffer "Gold-Keys")
(insert "
(set-buffer "Gold-Keys")
(insert "
;; GOLD KP0-9 KP- KP, and KPenter
;;
")
(set-buffer "Directions")
(set-buffer "Directions")
(tpu-map-key "KP-0" " - The Line/Open-Line key" "'tpu-line" "'open-line")
(tpu-map-key "KP-1" " - The Word/Change-Case key" "'tpu-word" "'tpu-change-case")
(tpu-map-key "KP-2" " - The EOL/Delete-EOL key" "'tpu-end-of-line" "'tpu-delete-to-eol")
(tpu-map-key "KP-3" " - The Character/Special-Insert key" "'tpu-char" "'tpu-special-insert")
(setq tpu-kp4 (tpu-map-key "KP-4" " - The Forward/Bottom key" "'tpu-advance-direction" "'tpu-move-to-end"))
(setq tpu-kp5 (tpu-map-key "KP-5" " - The Reverse/Top key" "'tpu-backup-direction" "'tpu-move-to-beginning"))
(tpu-map-key "KP-6" " - The Remove/Insert key" "'tpu-cut" "'tpu-paste")
(tpu-map-key "KP-7" " - The Page/Do key" "'tpu-page" "'execute-extended-command")
(tpu-map-key "KP-8" " - The Section/Fill key" "'tpu-scroll-window" "'tpu-fill")
(tpu-map-key "KP-9" " - The Append/Replace key" "'tpu-append-region" "'tpu-replace")
(tpu-map-key "KP--" " - The Delete/Undelete Word key" "'tpu-delete-current-word" "'tpu-undelete-words")
(tpu-map-key "KP-," " - The Delete/Undelete Character key" "'tpu-delete-current-char" "'tpu-undelete-char")
(tpu-map-key "KP-." " - The Select/Reset key" "'tpu-select" "'tpu-unselect")
(tpu-map-key "KP-Enter" " - The Enter key on the numeric keypad" "'newline" "'tpu-substitute")
;; Save the enter key
(setq tpu-enter tpu-key)
(setq tpu-enter-seq tpu-key-seq)
(tpu-map-key "KP-0" " - The Line/Open-Line key" "'tpu-line" "'open-line")
(tpu-map-key "KP-1" " - The Word/Change-Case key" "'tpu-word" "'tpu-change-case")
(tpu-map-key "KP-2" " - The EOL/Delete-EOL key" "'tpu-end-of-line" "'tpu-delete-to-eol")
(tpu-map-key "KP-3" " - The Character/Special-Insert key" "'tpu-char" "'tpu-special-insert")
(setq tpu-kp4 (tpu-map-key "KP-4" " - The Forward/Bottom key" "'tpu-advance-direction" "'tpu-move-to-end"))
(setq tpu-kp5 (tpu-map-key "KP-5" " - The Reverse/Top key" "'tpu-backup-direction" "'tpu-move-to-beginning"))
(tpu-map-key "KP-6" " - The Remove/Insert key" "'tpu-cut" "'tpu-paste")
(tpu-map-key "KP-7" " - The Page/Do key" "'tpu-page" "'execute-extended-command")
(tpu-map-key "KP-8" " - The Section/Fill key" "'tpu-scroll-window" "'tpu-fill")
(tpu-map-key "KP-9" " - The Append/Replace key" "'tpu-append-region" "'tpu-replace")
(tpu-map-key "KP--" " - The Delete/Undelete Word key" "'tpu-delete-current-word" "'tpu-undelete-words")
(tpu-map-key "KP-," " - The Delete/Undelete Character key" "'tpu-delete-current-char" "'tpu-undelete-char")
(tpu-map-key "KP-." " - The Select/Reset key" "'tpu-select" "'tpu-unselect")
(tpu-map-key "KP-Enter" " - The Enter key on the numeric keypad" "'newline" "'tpu-substitute")
;; Save the enter key
(setq tpu-enter tpu-key)
(setq tpu-enter-seq tpu-key-seq)
(set-buffer "Keys")
(insert "
(set-buffer "Keys")
(insert "
;; Editing keypad (find, insert, remove)
;; (select, prev, next)
;;
")
(set-buffer "Gold-Keys")
(insert "
(set-buffer "Gold-Keys")
(insert "
;; GOLD Editing keypad (find, insert, remove)
;; (select, prev, next)
;;
")
(set-buffer "Directions")
(set-buffer "Directions")
(tpu-map-key "Find" " - The Find key on the editing keypad" "'tpu-search" "'nil")
(tpu-map-key "Insert" " - The Insert key on the editing keypad" "'tpu-paste" "'nil")
(tpu-map-key "Remove" " - The Remove key on the editing keypad" "'tpu-cut" "'tpu-store-text")
(tpu-map-key "Select" " - The Select key on the editing keypad" "'tpu-select" "'tpu-unselect")
(tpu-map-key "Prev Scr" " - The Prev Scr key on the editing keypad" "'tpu-scroll-window-down" "'tpu-previous-window")
(tpu-map-key "Next Scr" " - The Next Scr key on the editing keypad" "'tpu-scroll-window-up" "'tpu-next-window")
(tpu-map-key "Find" " - The Find key on the editing keypad" "'tpu-search" "'nil")
(tpu-map-key "Insert" " - The Insert key on the editing keypad" "'tpu-paste" "'nil")
(tpu-map-key "Remove" " - The Remove key on the editing keypad" "'tpu-cut" "'tpu-store-text")
(tpu-map-key "Select" " - The Select key on the editing keypad" "'tpu-select" "'tpu-unselect")
(tpu-map-key "Prev Scr" " - The Prev Scr key on the editing keypad" "'tpu-scroll-window-down" "'tpu-previous-window")
(tpu-map-key "Next Scr" " - The Next Scr key on the editing keypad" "'tpu-scroll-window-up" "'tpu-next-window")
(set-buffer "Keys")
(insert "
(set-buffer "Keys")
(insert "
;; F10-14 Help Do F17
;;
")
(set-buffer "Gold-Keys")
(insert "
(set-buffer "Gold-Keys")
(insert "
;; GOLD F10-14 Help Do F17
;;
")
(set-buffer "Directions")
(set-buffer "Directions")
(tpu-map-key "F10" " - Invokes the Exit function on VT200+ terminals" "'tpu-exit" "'nil")
(tpu-map-key "F11" " - Inserts an Escape character into the text" "'tpu-insert-escape" "'nil")
(tpu-map-key "Backspace" " - Not Delete nor ^H! Sometimes on the F12 key" "'tpu-next-beginning-of-line" "'nil")
(tpu-map-key "F13" " - Invokes the delete previous word function" "'tpu-delete-previous-word" "'nil")
(tpu-map-key "F14" " - Toggles insert/overstrike modes" "'tpu-toggle-overwrite-mode" "'nil")
(tpu-map-key "Help" " - Brings up the help screen, same as PF2" "'tpu-help" "'describe-bindings")
(tpu-map-key "Do" " - Invokes the COMMAND function" "'execute-extended-command" "'nil")
(tpu-map-key "F17" "" "'tpu-goto-breadcrumb" "'tpu-drop-breadcrumb")
(tpu-map-key "F10" " - Invokes the Exit function on VT200+ terminals" "'tpu-exit" "'nil")
(tpu-map-key "F11" " - Inserts an Escape character into the text" "'tpu-insert-escape" "'nil")
(tpu-map-key "Backspace" " - Not Delete nor ^H! Sometimes on the F12 key" "'tpu-next-beginning-of-line" "'nil")
(tpu-map-key "F13" " - Invokes the delete previous word function" "'tpu-delete-previous-word" "'nil")
(tpu-map-key "F14" " - Toggles insert/overstrike modes" "'tpu-toggle-overwrite-mode" "'nil")
(tpu-map-key "Help" " - Brings up the help screen, same as PF2" "'tpu-help" "'describe-bindings")
(tpu-map-key "Do" " - Invokes the COMMAND function" "'execute-extended-command" "'nil")
(tpu-map-key "F17" "" "'tpu-goto-breadcrumb" "'tpu-drop-breadcrumb")
(set-buffer "Gold-Keys")
(cond
((not (equal tpu-enter tpu-return))
(insert "
(set-buffer "Gold-Keys")
(cond
((not (equal tpu-enter tpu-return))
(insert "
;; Minibuffer map additions to make KP_enter = RET
;;
")
(insert (format "(define-key minibuffer-local-map %s 'exit-minibuffer)\n" tpu-enter))
(insert (format "(define-key minibuffer-local-ns-map %s 'exit-minibuffer)\n" tpu-enter))
(insert (format "(define-key minibuffer-local-completion-map %s 'exit-minibuffer)\n" tpu-enter))
(insert (format "(define-key minibuffer-local-must-match-map %s 'minibuffer-complete-and-exit)\n" tpu-enter))))
(insert (format "(define-key minibuffer-local-map %s 'exit-minibuffer)\n" tpu-enter))
;; These are not necessary because they are inherited.
;; (insert (format "(define-key minibuffer-local-ns-map %s 'exit-minibuffer)\n" tpu-enter))
;; (insert (format "(define-key minibuffer-local-completion-map %s 'exit-minibuffer)\n" tpu-enter))
(insert (format "(define-key minibuffer-local-must-match-map %s 'minibuffer-complete-and-exit)\n" tpu-enter))))
(cond
((not (or (equal tpu-kp4 tpu-return) (equal tpu-kp5 tpu-return)))
(insert "
(cond
((not (or (equal tpu-kp4 tpu-return) (equal tpu-kp5 tpu-return)))
(insert "
;; Minibuffer map additions to allow KP-4/5 termination of search strings.
;;
")
(insert (format "(define-key minibuffer-local-map %s 'tpu-search-forward-exit)\n" tpu-kp4))
(insert (format "(define-key minibuffer-local-map %s 'tpu-search-backward-exit)\n" tpu-kp5))))
(insert (format "(define-key minibuffer-local-map %s 'tpu-search-forward-exit)\n" tpu-kp4))
(insert (format "(define-key minibuffer-local-map %s 'tpu-search-backward-exit)\n" tpu-kp5))))
(insert "
(insert "
;; Define the tpu-help-enter/return symbols
;;
")
(cond ((featurep 'xemacs)
(insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter-seq))
(insert (format "(setq tpu-help-return \"%s\")\n" tpu-return-seq))
(insert "(setq tpu-help-N \"[#<keypress-event N>]\")\n")
(insert "(setq tpu-help-n \"[#<keypress-event n>]\")\n")
(insert "(setq tpu-help-P \"[#<keypress-event P>]\")\n")
(insert "(setq tpu-help-p \"[#<keypress-event p>]\")\n"))
(t
(insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter))))
(cond ((featurep 'xemacs)
(insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter-seq))
(insert (format "(setq tpu-help-return \"%s\")\n" tpu-return-seq))
(insert "(setq tpu-help-N \"[#<keypress-event N>]\")\n")
(insert "(setq tpu-help-n \"[#<keypress-event n>]\")\n")
(insert "(setq tpu-help-P \"[#<keypress-event P>]\")\n")
(insert "(setq tpu-help-p \"[#<keypress-event p>]\")\n"))
(t
(insert (format "(setq tpu-help-enter \"%s\")\n" tpu-enter))))
(append-to-buffer "Keys" 1 (point))
(set-buffer "Keys")
(append-to-buffer "Keys" 1 (point))
(set-buffer "Keys")
;;;
;;; Save the key mapping program
;;;
(let ((file
(convert-standard-filename
(if (featurep 'xemacs) "~/.tpu-lucid-keys" "~/.tpu-keys"))))
(set-visited-file-name
(read-file-name (format "Save key mapping to file (default %s): " file) "" file)))
(save-buffer)
;; Save the key mapping program
;;;
;;; Load the newly defined keys and clean up
;;;
(eval-buffer)
(kill-buffer (current-buffer))
(kill-buffer "*scratch*")
(kill-buffer "Gold-Keys")
(let ((file
(convert-standard-filename
(if (featurep 'xemacs) "~/.tpu-lucid-keys" "~/.tpu-keys"))))
(set-visited-file-name
(read-file-name (format "Save key mapping to file (default %s): " file) "" file)))
(save-buffer)
;;;
;;; Let them know it worked.
;;;
(switch-to-buffer "Directions")
(erase-buffer)
(insert "
;; Load the newly defined keys and clean up
(require 'tpu-edt)
(eval-buffer)
(kill-buffer (current-buffer))
(kill-buffer "*scratch*")
(kill-buffer "Gold-Keys")
;; Let them know it worked.
(switch-to-buffer "Directions")
(erase-buffer)
(insert "
A custom TPU-edt keymap file has been created.
Press GOLD-k to remove this buffer and continue editing.
")
(goto-char (point-min))
(goto-char (point-min)))
;; arch-tag: bab5872f-cd3a-4c1c-aedb-047b67646f6c
;;; tpu-mapper.el ends here