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