1 ;;; rcompile.el --- run a compilation on a remote machine
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Albert <alon@milcse.rtsg.mot.com>
8 ;; Keywords: tools, processes
10 ;; This file is part of GNU Emacs.
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)
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.
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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; This package is for running a remote compilation and using emacs to parse
30 ;; the error messages. It works by rsh'ing the compilation to a remote host
31 ;; and parsing the output. If the file visited at the time remote-compile was
32 ;; called was loaded remotely (ange-ftp), the host and user name are obtained
33 ;; by the calling ange-ftp-ftp-name on the current directory. In this case the
34 ;; next-error command will also ange-ftp the files over. This is achieved
35 ;; automatically because the compilation-parse-errors function uses
36 ;; default-directory to build its file names. If however the file visited was
37 ;; loaded locally, remote-compile prompts for a host and user and assumes the
38 ;; files mounted locally (otherwise, how was the visited file loaded).
40 ;; See the user defined variables section for more info.
42 ;; I was contemplating redefining "compile" to "remote-compile" automatically
43 ;; if the file visited was ange-ftp'ed but decided against it for now. If you
44 ;; feel this is a good idea, let me know and I'll consider it again.
48 ;; To use rcompile, you also need to give yourself permission to connect to
49 ;; the remote host. You do this by putting lines like:
54 ;; in a file named .rhosts in the home directory (of the remote machine).
55 ;; Be careful what you put in this file. A line like:
59 ;; Will allow anyone access to your account without a password. I suggest you
60 ;; read the rhosts(5) manual page before you edit this file (if you are not
61 ;; familiar with it already)
67 ;;; The following should not be needed.
68 ;;; (eval-when-compile (require 'ange-ftp))
70 ;;;; user defined variables
72 (defgroup remote-compile nil
73 "Run a compilation on a remote machine"
78 (defcustom remote-compile-host nil
79 "*Host for remote compilations."
80 :type '(choice string (const nil))
81 :group 'remote-compile)
83 (defcustom remote-compile-user nil
84 "User for remote compilations.
85 nil means use the value returned by \\[user-login-name]."
86 :type '(choice string (const nil))
87 :group 'remote-compile)
89 (defcustom remote-compile-run-before nil
90 "*Command to run before compilation.
91 This can be used for setting up environment variables,
92 since rsh does not invoke the shell as a login shell and files like .login
93 \(tcsh\) and .bash_profile \(bash\) are not run.
94 nil means run no commands."
95 :type '(choice string (const nil))
96 :group 'remote-compile)
98 (defcustom remote-compile-prompt-for-host nil
99 "*Non-nil means prompt for host if not available from filename."
101 :group 'remote-compile)
103 (defcustom remote-compile-prompt-for-user nil
104 "*Non-nil means prompt for user if not available from filename."
106 :group 'remote-compile)
108 ;;;; internal variables
110 ;; History of remote compile hosts and users
111 (defvar remote-compile-host-history nil)
112 (defvar remote-compile-user-history nil)
118 (defun remote-compile (host user command)
119 "Compile the the current buffer's directory on HOST. Log in as USER.
122 (let ((parsed (or (and (featurep 'ange-ftp)
123 (ange-ftp-ftp-name default-directory))))
124 host user command prompt)
126 (setq host (nth 0 parsed)
128 (setq prompt (if (stringp remote-compile-host)
129 (format "Compile on host (default %s): "
132 host (if (or remote-compile-prompt-for-host
133 (null remote-compile-host))
134 (read-from-minibuffer prompt
136 'remote-compile-host-history)
138 user (if remote-compile-prompt-for-user
139 (read-from-minibuffer (format
140 "Compile by user (default %s)"
141 (or remote-compile-user
144 'remote-compile-user-history)
145 remote-compile-user)))
146 (setq command (read-from-minibuffer "Compile command: "
147 compile-command nil nil
148 '(compile-history . 1)))
149 (list (if (string= host "") remote-compile-host host)
150 (if (string= user "") remote-compile-user user)
152 (setq compile-command command)
154 (setq remote-compile-user user))
155 ((null remote-compile-user)
156 (setq remote-compile-user (user-login-name))))
157 (let* ((parsed (and (featurep 'ange-ftp)
158 (ange-ftp-ftp-name default-directory)))
160 (format "%s %s -l %s \"(%scd %s; %s)\""
164 (if remote-compile-run-before
165 (concat remote-compile-run-before "; ")
167 (if parsed (nth 2 parsed) default-directory)
169 (setq remote-compile-host host)
170 (save-some-buffers nil nil)
171 (compile-internal compile-command "No more errors")
172 ;; Set comint-file-name-prefix in the compilation buffer so
173 ;; compilation-parse-errors will find referenced files by ange-ftp.
175 (set-buffer compilation-last-buffer)
176 (make-variable-buffer-local 'comint-file-name-prefix)
177 (setq comint-file-name-prefix (concat "/" host ":")))))
179 ;;; rcompile.el ends here