home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / terms / flow-ctrl.el < prev    next >
Encoding:
Text File  |  1993-03-27  |  11.3 KB  |  280 lines
  1. ; From: "Jeff Morgenthaler" <jpmorgen@wisp4.physics.wisc.edu>
  2. ; Subject: flow-ctrl.el
  3. ; Date: Fri, 26 Mar 93 23:52:34 -0600
  4. ; 
  5. ;;; File:  flow-ctrl.el, v 3.0 (emacs 18[.58] version)
  6. ;;;
  7. ;;;               -------   -------------   ---------------------
  8. ;;;               F l o w   C o n t r o l   A d j u s t m e n t s
  9. ;;;               -------   -------------   ---------------------
  10. ;;;
  11. ;;;
  12. ;;; Copyright (C) 1990 Free Software Foundation, Inc.
  13. ;;; Copyright (C) 1993 Jeff Morgenthaler
  14. ;;; Thanks to Kevin Gallagher for TERM-in-list and Joe Wells for
  15. ;;; encouragement to code everything right.  
  16. ;;;
  17.  
  18. ;; LCD Archive Entry:
  19. ;; flow-ctrl|Jeff Morgenthaler|jpmorgen@wisp4.physics.wisc.edu|
  20. ;; Flow control adjustments to remap C-s and C-q.|
  21. ;; 23-Mar-1993|1.0|~/terms/flow-ctrl.el.Z|
  22.  
  23. ;; Archived at archive.cis.ohio-state.edu
  24.  
  25.  
  26. ;;; GNU Emacs is distributed in the hope that it will be useful, but
  27. ;;; WITHOUT ANY WARRANTY.  No author or distributor accepts
  28. ;;; RESPONSIBILITY TO anyone for the consequences of using it or for
  29. ;;; whether it serves any particular purpose or works at all, unless 
  30. ;;; he says so in writing.  Refer to the GNU Emacs General Public
  31. ;;; License for full details.
  32. ;;;
  33. ;;;  Send bug reports and suggestions for improvement to Jeff Morgenthaler
  34. ;;;  (jpmorgen@wisp4.physics.wisc.edu).
  35. ;;;
  36. ;;; Everyone is granted permission to copy, modify and redistribute
  37. ;;; GNU Emacs, but only under the conditions described in the GNU
  38. ;;; Emacs General Public License.  A copy of this license is supposed
  39. ;;; to have been given to you along with GNU Emacs so you can know
  40. ;;; your rights and responsibilities.  It should be in a file named
  41. ;;; COPYING.  Among other things, the Copyright notice and this notice
  42. ;;; must be preserved on all copies.
  43. ;;;
  44.  
  45. ;;;; WARNING: this code uses set-input-mode, which is due to change
  46. ;;;; (slightly?) in emacs 19.
  47.  
  48. ;;;; XON/XOFF flow control is a primitive user interface scheme 
  49. ;;;; employed by most terminals, terminal servers, modems, and
  50. ;;;; operating systems.  XON/XOFF flow control allows the user,
  51. ;;;; terminal, modem, etc. to pause the data stream at any time for
  52. ;;;; whatever reason.  The standard flow control commands are C-s for
  53. ;;;; stop and C-q for "quontinue" (at least that's how I remember it).
  54.  
  55. ;;;; Users of GNU emacs will recognize C-s and C-q as the commands
  56. ;;;; isearch-forward and quote-insert, and part of the commands
  57. ;;;; save-buffer and toggle-read-only.  It does not take very long to
  58. ;;;; recognize the usefulness of these bindings in emacs (and the
  59. ;;;; emacs model in general--mnemonic key bindings) over any
  60. ;;;; usefulness that XON/XOFF flow control had or will ever had.
  61.  
  62. ;;;; Emacs does the best it can to turn XON/XOFF flow control off.
  63. ;;;; Unfortunately, due to poor planing on the part of the inventors
  64. ;;;; of XON/XOFF flow control, it is only possible to disable flow
  65. ;;;; control on the machine that is running emacs: there is no
  66. ;;;; standard sequence of characters that a remote terminal, modem,
  67. ;;;; operating system, etc. will interpret to mean "disable flow
  68. ;;;; control."
  69.  
  70. ;;;; Thus, it is up to each user to make sure that XON/XOFF flow
  71. ;;;; control is disabled at all hardware between the user and the
  72. ;;;; machine running emacs.  Terminals usually have an item in their
  73. ;;;; setup menu for flow control or "hsk."  Modems using the Hayes
  74. ;;;; standard "at" commands should respond to at&k0.  Terminal or
  75. ;;;; modem servers will often have a command such as "set port flow
  76. ;;;; control disable" to be issued an the "local" prompt.  In VMS, you
  77. ;;;; can issue the command SET TERM/PASSALL.  In UNIX, you can try
  78. ;;;; "stty start u stop u," rlogin -8, or use telnet....
  79.  
  80. ;;;; Unfortunately (and you probably wouldn't be reading this if this
  81. ;;;; wasn't the case for you) it is sometimes impossible or
  82. ;;;; inconvenient at the moment to disable flow control.  Emacs has
  83. ;;;; always had a solution for this: the C-\ and C-^ keys are not
  84. ;;;; bound to anything (unlike all the other control characters in
  85. ;;;; emacs).  Following the emacs model, these keys are fairly
  86. ;;;; mnemonic: C-\ (that is back-Slash) resembles / which is search in
  87. ;;;; more/vi/ed) and C-^ can clearly be associated with the ^ produced
  88. ;;;; by C-q C-w.  Also, emacs has a function (set-input-mode) which
  89. ;;;; allows the C-s and C-q characters to be passed to the machine on
  90. ;;;; which emacs is running in case the terminal, modem, server, etc.,
  91. ;;;; really can't handle the rate of data flow and has no other means
  92. ;;;; of flow control.
  93.  
  94. ;;;; What has been missing up to now has been a decent wrapper for
  95. ;;;; these already existing features so that users can function in
  96. ;;;; emacs even when they are stuck on broken hardware without
  97. ;;;; becoming expert emacs code writers.  By "decent wrapper" I mean a
  98. ;;;; function that can be called interactively (with M-x) that is
  99. ;;;; sensibly named.  The function should not interfere with other
  100. ;;;; functions which remap the keys and it should toggle, cleaning up
  101. ;;;; completely after itself.  Variables for customizing the key
  102. ;;;; remappings and an auto-start feature should also be included.
  103.  
  104. ;;;; flow-control-fix is such a function.
  105.  
  106. ;;;; The variables C-s-replacement, C-q-replacement and
  107. ;;;; terminal-uses-flow-control-chars are available for customization
  108. ;;;; of flow-control-fix.  Here are some examples of how to set them
  109. ;;;; (you would put these in your .emacs file):
  110.  
  111. ;;;; (setq C-s-replacement ?\C-t)
  112. ;;;; (setq terminal-uses-flow-control-chars 
  113. ;;;;   '("vt52" "vt100" "vt200"))
  114.  
  115. ;;;; TERM-in-list and init-keyboard-translate-table, which are useful
  116. ;;;; functions for further user customizations are also also defined.
  117.  
  118. ;;;; To make this facility available for use to all users, place this file
  119. ;;;; (flow-ctrl.el) into your site's public emacs/lisp directory and
  120. ;;;; add the following lines to your site's default.el file:
  121.  
  122. ;;;; (require 'flow-ctrl)
  123. ;;;; (auto-flow-control-fix)
  124.  
  125. ;;;; You may also want to preload flow-ctrl into emacs by putting the
  126. ;;;; code:
  127.  
  128. ;;;; (load "flow-ctrl")
  129.  
  130. ;;;; in your site-init.el file.  This will allow the functions
  131. ;;;; TERM-in-list and init-keyboard-translate-table to be called in
  132. ;;;; the user's .emacs file outside of their term-setup-hook.
  133.  
  134. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  135.  
  136. (provide 'flow-ctrl)
  137.  
  138. ;; default C-s, C-q replacements
  139. (defvar C-s-replacement ?\C-\\
  140.   "*Ascii version of character to substitute for Control-S.  Example of 
  141. setting this variable: (setq C-s-replacement ?\\C-t).")
  142.  
  143. (defvar C-q-replacement ?\C-^
  144.   "*Ascii version of character to substitute for Control-Q.  Example of 
  145. setting this variable: (setq C-q-replacement ?\\C-]).")
  146.  
  147. (defvar terminal-uses-flow-control-chars nil
  148.   "*List of general terminal types used by the user which are often 
  149. flow-control hobbled.  Used by auto-flow-control-fix.  Example of setting 
  150. this variable:
  151. (setq terminal-uses-flow-control-chars 
  152.    '(""vt52"" ""vt100"" ""vt200""))")
  153.  
  154. (defvar flow-control-fix-flag nil
  155.   "*Flag to indicate if flow control avoidance is in effect.")
  156.  
  157. (defun init-keyboard-translate-table ()
  158.   "Initialize translate table, saving previous mappings, if any."
  159.   (let ((the-table (make-string 256 0)))
  160.     ;; Some users of PC and DEMACS need a large keyboard-translate-table
  161.     (let ((i 0)
  162.       (j (length keyboard-translate-table)))
  163.       (while (< i j)
  164.     (aset the-table i (elt keyboard-translate-table i))
  165.     (setq i (1+ i)))
  166.       (while (< i 256)
  167.     (aset the-table i i)
  168.     (setq i (1+ i))))
  169.     (setq keyboard-translate-table the-table)))
  170.  
  171. (defun TERM-in-list (term-list)
  172.   "Returns t if the current terminal \(TERM\) is in term-list.  Drops 
  173. everything in TERM past the first hyphen. Example of term-list:
  174.   '\(""vt52"" ""vt100"" ""vt200""\)"
  175.   (let ((term (getenv "TERM"))
  176.     hyphend
  177.     TERM-in-list)
  178.     ;; Make sure TERM is set. Some people start emacs from their 
  179.     ;; .xinitrc or .xsession file, in which case TERM is not set
  180.     (if term
  181.     (progn
  182.       ;; Strip off hyphen and what follows
  183.       (while (setq hyphend (string-match "[-_][^-_]+$" term))
  184.         (setq term (substring term 0 hyphend)))
  185.       (let ((len (length term-list))
  186.         (idx 0)
  187.         (temp-term nil))
  188.         (while (and (< idx len)
  189.             (not temp-term))
  190.           (if (string-equal term 
  191.                 (nth idx term-list))
  192.           (progn
  193.             (setq TERM-in-list t)
  194.             (setq temp-term term))
  195.         (setq idx (1+ idx)))))))
  196.     TERM-in-list))
  197.  
  198. (defun flow-control-fix (arg)
  199.   "Replaces C-s with C-s-replacement, C-q with C-q-replacement \(C-\\
  200. and C-^ by default\) and tells emacs to pass C-s and C-q on to the
  201. operating system.  Gets around XON/XOFF flow control.  This is a last
  202. resort fix!  First try turning off flow control at your terminal \(with
  203. the setup menu\), modem \(at&k0\), terminal server \(set port flow
  204. control disable\), machine you are logging in through \(SET TERM/PASSALL
  205. or rlogin -8\), etc.  Turns on with an argument of t or a positive
  206. argument, off with an argument of nil or negative argument, and toggles 
  207. with no argument."
  208.  
  209.   (interactive
  210.    (list
  211.     (if current-prefix-arg
  212.     ;; If an argument is specified, then turn on if non-negative else
  213.     ;; turn off if negative.
  214.     (>= (prefix-numeric-value current-prefix-arg) 0)
  215.       ;; If no argument is specified, then toggle.
  216.       'toggle)))
  217.  
  218.   (setq flow-control-fix-flag
  219.     (if (eq arg 'toggle)
  220.         (not flow-control-fix-flag)
  221.      arg))
  222.   ;; Thanks to the elisp prowess of jbw for the above sequence!
  223.  
  224.  
  225.   (if flow-control-fix-flag
  226.     ;; Tell emacs to pass C-s and C-q to OS and swap out C-s and C-q.
  227.     (progn
  228.       (set-input-mode nil t)
  229.       ;; !!!!!!!!!!!!emacs 19 users will have to change this!!!!!!!!!!!!!!!!
  230.       (init-keyboard-translate-table)
  231.       ;; Swap C-s and C-s-replacement
  232.       (aset keyboard-translate-table C-s-replacement ?\^s)
  233.       (aset keyboard-translate-table ?\^s C-s-replacement)
  234.       ;; Swap C-q and C-q-replacement
  235.       (aset keyboard-translate-table C-q-replacement ?\^q)
  236.       (aset keyboard-translate-table ?\^q C-q-replacement)
  237.       (message (concat "XON/XOFF adjustment for " 
  238.                  (getenv "TERM") 
  239.                ":  use "(single-key-description C-s-replacement)
  240.                " for C-s  and  use  "
  241.                (single-key-description C-q-replacement)
  242.                " for C-q."))
  243.       (sleep-for 1) ; Give user a chance to see message.
  244.       )
  245.     ;; Tell emacs to not pass C-s and C-q to OS and reset keys.
  246.     (progn
  247.       (set-input-mode nil nil)
  248.       ;; !!!!!!!!!!!!emacs 19 users will have to change this!!!!!!!!!!!!!!!!
  249.       ;; Restore C-s and C-s-replacement
  250.       (init-keyboard-translate-table)
  251.       (aset keyboard-translate-table ?\^s ?\^s)
  252.       (aset keyboard-translate-table C-s-replacement C-s-replacement)
  253.       ;; Restore C-q and C-q-replacement
  254.       (aset keyboard-translate-table ?\^q ?\^q)
  255.       (aset keyboard-translate-table C-q-replacement C-q-replacement)
  256.       (message "C-s and C-q restored.")
  257.       )
  258.     )
  259.   )
  260.  
  261. (defun auto-flow-control-fix ()
  262.   "Enables flow control avoidance using flow-control-fix if the user is
  263. not using X windows and the current terminal (TERM) is in the
  264. terminal-uses-flow-control-chars list.  Drops everything in TERM past
  265. the first hyphen."
  266.  
  267.   (if (or 
  268.        ;; invoked from a shell directly under an xterm:
  269.        (and (getenv "DISPLAY")
  270.         (getenv "WINDOWID")
  271.         (equal (getenv "TERM") "xterm"))
  272.        ;; this is a direct X client:
  273.        (eq 'x window-system))
  274.       ;; Never enable flow control avoidance if you are running X, no
  275.       ;; matter what the TERM variable is set to. (Thanks Joe).
  276.       nil
  277.     (if (TERM-in-list terminal-uses-flow-control-chars)
  278.     (flow-control-fix t)))
  279. )
  280.