lisp/kermit.el

   1 ;;; kermit.el --- additions to shell mode for use with kermit
   2
   3 ;; Copyright (C) 1988, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Jeff Norden <jeff@colgate.csnet>
   7 ;; Maintainer: FSF
   8 ;; Created: 15 Feb 1988
   9 ;; Keywords: comm
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;; I'm not sure, but I think somebody asked about running kermit under shell
  29 ;; mode a while ago.  Anyway, here is some code that I find useful.  The result
  30 ;; is that I can log onto machines with primitive operating systems (VMS and
  31 ;; ATT system V :-), and still have the features of shell-mode available for
  32 ;; command history, etc.  It's also handy to be able to run a file transfer in
  33 ;; an emacs window.  The transfer is in the "background", but you can also
  34 ;; monitor or stop it easily.
  35
  36 ;; The ^\ key is bound to a function for sending escape sequences to kermit,
  37 ;; and ^C^Q can be used to send any control characters needed thru to the
  38 ;; system you connect to.  A more serious problem is that some brain-dead
  39 ;; systems will not recognize a ^J as an end-of-line character.  So LFD is
  40 ;; bound to a new function which acts just like CR usually does in shell-mode,
  41 ;; but a ^M is sent as an end-of-line.  Functions are also provided to swap the
  42 ;; bindings of CR and LFD.  I've also included a filter which will clean out
  43 ;; any ^M's or ^@'s that get typed at you, but I don't really recommend it.
  44 ;; There doesn't seem to be an acceptably fast way to do this via emacs-lisp.
  45 ;; Invoking kermit by the command " kermit | tr -d '\015' " seems to work
  46 ;; better (on my system anyway).
  47
  48 ;; Here's how I've been using this setup.  We have several machines connected
  49 ;; thru a fairly stupid terminal switch.  If I want to connect to unix system,
  50 ;; then I use the LFD key to talk to the switch, and ignore any ^M's in the
  51 ;; buffer, and do a " stty -echo nl " after I log in.  Then the only real
  52 ;; difference from being in local shell-mode is that you need to type
  53 ;; ^C^Q^C to send an interrupt, and ^C^Q^Z for a stop signal, etc.  (since ^C^C
  54 ;; just generates a local stop signal, which kermit ignores).
  55 ;; To connect to a VMS system, I use a shell script to invoke kermit thru the
  56 ;; tr filter, do "M-X kermit-send-cr", and then tell VMS that I'm on a
  57 ;; half-duplex terminal.
  58
  59 ;; Some caveats:
  60 ;; 1) Kermit under shell mode is a real pain if you don't have pty's.  I
  61 ;; recently discovered this on our 3b2/400.  When kermit can't find a tty, it
  62 ;; assumes it is supposed to be in remote mode.  So the simple command "kermit"
  63 ;; won't work in shell mode on such a system.  You can get around this by using
  64 ;; the -c (connect) command line option, which means you also have to specify a
  65 ;; line and baud on the command line, as in "kermit -l /dev/tty53 -b 9600 -c".
  66 ;; However, this will cause kermit to exit when the connection is closed.  So
  67 ;; in order to do a file transfer, you have to think ahead and and add -r
  68 ;; (receive) to the command line.  This means that you can't use the server
  69 ;; feature.  The only fix I can see is to muck around with the source code for
  70 ;; kermit, although this probably wouldn't be too hard.  What is needed is an
  71 ;; option to force kermit to be local, to use stdin and stdout for interactive
  72 ;; speech, and to forget about cbreak mode.
  73
  74 ;; Please let me know if any bugs turn up.
  75 ;; Feb 1988, Jeff Norden - jeff@colgate.csnet
  76
  77 ;;; Code:
  78
  79 (require 'shell)
  80
  81 (defvar kermit-esc-char "\C-\\" "*Kermit's escape char.")
  82
  83 (defun kermit-esc ()
  84   "For sending escape sequences to a kermit running in shell mode."
  85   (interactive)
  86   (process-send-string
  87    (get-buffer-process (current-buffer))
  88    (concat kermit-esc-char (char-to-string (read-char)))))
  89
  90 (defun kermit-send-char ()
  91   "Send an arbitrary character to a program in shell mode."
  92   (interactive)
  93   (process-send-string
  94    (get-buffer-process (current-buffer))
  95    (char-to-string (read-char))))
  96
  97 (define-key shell-mode-map "\C-\\" 'kermit-esc)
  98 (define-key shell-mode-map "\C-c\C-q" 'kermit-send-char)
  99 ;; extra bindings for folks suffering form ^S/^Q braindamage:
 100 (define-key shell-mode-map "\C-c\\" 'kermit-esc)
 101
 102 (defun kermit-send-input-cr ()
 103   "Like \\[comint-send-input] but end the line with carriage-return."
 104   (interactive)
 105   (comint-send-input)
 106   (comint-send-string (get-buffer-process (current-buffer)) "\r"))
 107
 108 ;; This is backwards of what makes sense, but ...
 109 (define-key shell-mode-map "\n" 'kermit-send-input-cr)
 110
 111 (defun kermit-default-cr ()
 112   "Make RETURN end the line with carriage-return and LFD end it with a newline.
 113 This is useful for talking to other systems on which carriage-return
 114 is the normal way to end a line."
 115   (interactive)
 116   (define-key shell-mode-map "\r" 'kermit-send-input-cr)
 117   (define-key shell-mode-map "\n" 'comint-send-input))
 118
 119 (defun kermit-default-nl ()
 120   "Make RETURN end the line with a newline char.  This is the default state.
 121 In this state, use LFD to send a line and end it with a carriage-return."
 122   (interactive)
 123   (define-key shell-mode-map "\n" 'kermit-send-input-cr)
 124   (define-key shell-mode-map "\r" 'comint-send-input))
 125
 126 (defun kermit-clean-filter (proc str)
 127   "Strip ^M and ^@ characters from process output."
 128   (save-excursion
 129     (let ((beg (process-mark proc)))
 130       (set-buffer (process-buffer proc))
 131       (goto-char beg)
 132       (insert-before-markers str)
 133       (while (re-search-backward "[\r\C-a]+" beg t)
 134         (replace-match "")))))
 135
 136 (defun kermit-clean-on ()
 137   "Delete all null characters and ^M's from the kermit output.
 138 Note that another (perhaps better) way to do this is to use the
 139 command `kermit | tr -d '\\015''."
 140   (interactive)
 141   (set-process-filter (get-buffer-process (current-buffer))
 142                       'kermit-clean-filter))
 143
 144 (defun kermit-clean-off ()
 145   "Cancel a previous `kermit-clean-on' command."
 146   (interactive)
 147   (set-process-filter (get-buffer-process (current-buffer)) nil))
 148
 149 (provide 'kermit)
 150
 151 ;; arch-tag: 6633215d-6c47-4e66-9f27-16fba02a8dce
 152 ;;; kermit.el ends here