lisp/kermit.el

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