lisp/kermit.el

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