[bpt/emacs.git] / lisp / net / rcompile.el

;;; rcompile.el --- run a compilation on a remote machine

;; Copyright (C) 1993, 1994, 2002, 2003, 2004,
;;   2005 Free Software Foundation, Inc.

;; Author: Albert    <alon@milcse.rtsg.mot.com>
;; Maintainer: FSF
;; Created: 1993 Oct 6
;; Keywords: tools, processes

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; This package is for running a remote compilation and using emacs to parse
;; the error messages. It works by rsh'ing the compilation to a remote host
;; and parsing the output. If the file visited at the time remote-compile was
;; called was loaded remotely (ange-ftp), the host and user name are obtained
;; by the calling ange-ftp-ftp-name on the current directory. In this case the
;; next-error command will also ange-ftp the files over. This is achieved
;; automatically because the compilation-parse-errors function uses
;; default-directory to build its file names. If however the file visited was
;; loaded locally, remote-compile prompts for a host and user and assumes the
;; files mounted locally (otherwise, how was the visited file loaded).

;; See the user defined variables section for more info.

;; I was contemplating redefining "compile" to "remote-compile" automatically
;; if the file visited was ange-ftp'ed but decided against it for now. If you
;; feel this is a good idea, let me know and I'll consider it again.

;; Installation:

;; To use rcompile, you also need to give yourself permission to connect to
;; the remote host.  You do this by putting lines like:

;; monopoly alon
;; vme33
;;
;; in a file named .rhosts in the home directory (of the remote machine).
;; Be careful what you put in this file. A line like:
;;
;; +
;;
;; Will allow anyone access to your account without a password. I suggest you
;; read the rhosts(5) manual page before you edit this file (if you are not
;; familiar with it already)
\f
;;; Code:

(provide 'rcompile)
(require 'compile)
;;; The following should not be needed.
;;; (eval-when-compile (require 'ange-ftp))

;;;; user defined variables

(defgroup remote-compile nil
  "Run a compilation on a remote machine."
  :group 'processes
  :group 'tools)


(defcustom remote-compile-host nil
  "*Host for remote compilations."
  :type '(choice string (const nil))
  :group 'remote-compile)

(defcustom remote-compile-user nil
  "User for remote compilations.
nil means use the value returned by \\[user-login-name]."
  :type '(choice string (const nil))
  :group 'remote-compile)

(defcustom remote-compile-run-before nil
  "*Command to run before compilation.
This can be used for setting up environment variables,
since rsh does not invoke the shell as a login shell and files like .login
\(tcsh\) and .bash_profile \(bash\) are not run.
nil means run no commands."
  :type '(choice string (const nil))
  :group 'remote-compile)

(defcustom remote-compile-prompt-for-host nil
  "*Non-nil means prompt for host if not available from filename."
  :type 'boolean
  :group 'remote-compile)

(defcustom remote-compile-prompt-for-user nil
  "*Non-nil means prompt for user if not available from filename."
  :type 'boolean
  :group 'remote-compile)

;;;; internal variables

;; History of remote compile hosts and users
(defvar remote-compile-host-history nil)
(defvar remote-compile-user-history nil)

\f
;;;; entry point

;;;###autoload
(defun remote-compile (host user command)
  "Compile the current buffer's directory on HOST.  Log in as USER.
See \\[compile]."
  (interactive
   (let ((parsed (or (and (featurep 'ange-ftp)
                          (ange-ftp-ftp-name default-directory))))
         host user command prompt)
     (if parsed
         (setq host (nth 0 parsed)
               user (nth 1 parsed))
       (setq prompt (if (stringp remote-compile-host)
                        (format "Compile on host (default %s): "
                                remote-compile-host)
                      "Compile on host: ")
             host (if (or remote-compile-prompt-for-host
                          (null remote-compile-host))
                      (read-from-minibuffer prompt
                                            "" nil nil
                                            'remote-compile-host-history)
                    remote-compile-host)
             user (if remote-compile-prompt-for-user
                      (read-from-minibuffer (format
                                             "Compile by user (default %s): "
                                             (or remote-compile-user
                                                 (user-login-name)))
                                            "" nil nil
                                            'remote-compile-user-history)
                    remote-compile-user)))
     (setq command (read-from-minibuffer "Compile command: "
                                         compile-command nil nil
                                         '(compile-history . 1)))
     (list (if (string= host "") remote-compile-host host)
           (if (string= user "") remote-compile-user user)
           command)))
  (setq compile-command command)
  (cond (user
         (setq remote-compile-user user))
        ((null remote-compile-user)
         (setq remote-compile-user (user-login-name))))
  (let* ((parsed (and (featurep 'ange-ftp)
                      (ange-ftp-ftp-name default-directory)))
         (compile-command
          (format "%s %s -l %s \"(%scd %s; %s)\""
		  remote-shell-program
                  host
                  remote-compile-user
                  (if remote-compile-run-before
                      (concat remote-compile-run-before "; ")
                    "")
                  (if parsed (nth 2 parsed) default-directory)
                  compile-command)))
    (setq remote-compile-host host)
    (save-some-buffers nil nil)
    (compilation-start compile-command)
    ;; Set comint-file-name-prefix in the compilation buffer so
    ;; compilation-parse-errors will find referenced files by ange-ftp.
    (with-current-buffer compilation-last-buffer
      (set (make-local-variable 'comint-file-name-prefix)
	   (concat "/" host ":")))))

;;; arch-tag: 2866a132-ece4-4ce9-9f91-ec147f803f73
;;; rcompile.el ends here
Commit	Line	Data
8749abea GM	1	;;; rcompile.el --- run a compilation on a remote machine
8749abea GM	2
5fd6d89f TTN	3	;; Copyright (C) 1993, 1994, 2002, 2003, 2004,
5fd6d89f TTN	4	;; 2005 Free Software Foundation, Inc.
8749abea GM	5
	6	;; Author: Albert <alon@milcse.rtsg.mot.com>
	7	;; Maintainer: FSF
	8	;; Created: 1993 Oct 6
	9	;; Keywords: tools, processes
	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 2, 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
3a35cf56 LK	25	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
3a35cf56 LK	26	;; Boston, MA 02110-1301, USA.
8749abea GM	27
	28	;;; Commentary:
	29
	30	;; This package is for running a remote compilation and using emacs to parse
	31	;; the error messages. It works by rsh'ing the compilation to a remote host
	32	;; and parsing the output. If the file visited at the time remote-compile was
	33	;; called was loaded remotely (ange-ftp), the host and user name are obtained
	34	;; by the calling ange-ftp-ftp-name on the current directory. In this case the
	35	;; next-error command will also ange-ftp the files over. This is achieved
	36	;; automatically because the compilation-parse-errors function uses
	37	;; default-directory to build its file names. If however the file visited was
	38	;; loaded locally, remote-compile prompts for a host and user and assumes the
	39	;; files mounted locally (otherwise, how was the visited file loaded).
	40
	41	;; See the user defined variables section for more info.
	42
	43	;; I was contemplating redefining "compile" to "remote-compile" automatically
	44	;; if the file visited was ange-ftp'ed but decided against it for now. If you
	45	;; feel this is a good idea, let me know and I'll consider it again.
	46
	47	;; Installation:
	48
	49	;; To use rcompile, you also need to give yourself permission to connect to
	50	;; the remote host. You do this by putting lines like:
	51
	52	;; monopoly alon
	53	;; vme33
	54	;;
	55	;; in a file named .rhosts in the home directory (of the remote machine).
	56	;; Be careful what you put in this file. A line like:
	57	;;
	58	;; +
	59	;;
	60	;; Will allow anyone access to your account without a password. I suggest you
	61	;; read the rhosts(5) manual page before you edit this file (if you are not
a1506d29	62	;; familiar with it already)
8749abea GM	63	\f
	64	;;; Code:
	65
	66	(provide 'rcompile)
	67	(require 'compile)
	68	;;; The following should not be needed.
	69	;;; (eval-when-compile (require 'ange-ftp))
	70
	71	;;;; user defined variables
	72
	73	(defgroup remote-compile nil
5c4ad728	74	"Run a compilation on a remote machine."
8749abea GM	75	:group 'processes
	76	:group 'tools)
	77
	78
	79	(defcustom remote-compile-host nil
	80	"*Host for remote compilations."
	81	:type '(choice string (const nil))
	82	:group 'remote-compile)
	83
	84	(defcustom remote-compile-user nil
	85	"User for remote compilations.
	86	nil means use the value returned by \\[user-login-name]."
	87	:type '(choice string (const nil))
	88	:group 'remote-compile)
	89
	90	(defcustom remote-compile-run-before nil
	91	"*Command to run before compilation.
	92	This can be used for setting up environment variables,
	93	since rsh does not invoke the shell as a login shell and files like .login
	94	\(tcsh\) and .bash_profile \(bash\) are not run.
	95	nil means run no commands."
	96	:type '(choice string (const nil))
	97	:group 'remote-compile)
	98
	99	(defcustom remote-compile-prompt-for-host nil
	100	"*Non-nil means prompt for host if not available from filename."
	101	:type 'boolean
	102	:group 'remote-compile)
	103
	104	(defcustom remote-compile-prompt-for-user nil
	105	"*Non-nil means prompt for user if not available from filename."
	106	:type 'boolean
	107	:group 'remote-compile)
	108
	109	;;;; internal variables
	110
	111	;; History of remote compile hosts and users
	112	(defvar remote-compile-host-history nil)
	113	(defvar remote-compile-user-history nil)
	114
	115	\f
	116	;;;; entry point
	117
	118	;;;###autoload
	119	(defun remote-compile (host user command)
110c171f	120	"Compile the current buffer's directory on HOST. Log in as USER.
8749abea GM	121	See \\[compile]."
	122	(interactive
	123	(let ((parsed (or (and (featurep 'ange-ftp)
	124	(ange-ftp-ftp-name default-directory))))
	125	host user command prompt)
	126	(if parsed
	127	(setq host (nth 0 parsed)
	128	user (nth 1 parsed))
	129	(setq prompt (if (stringp remote-compile-host)
	130	(format "Compile on host (default %s): "
	131	remote-compile-host)
	132	"Compile on host: ")
	133	host (if (or remote-compile-prompt-for-host
	134	(null remote-compile-host))
	135	(read-from-minibuffer prompt
	136	"" nil nil
	137	'remote-compile-host-history)
	138	remote-compile-host)
	139	user (if remote-compile-prompt-for-user
	140	(read-from-minibuffer (format
5b76833f	141	"Compile by user (default %s): "
8749abea GM	142	(or remote-compile-user
	143	(user-login-name)))
	144	"" nil nil
	145	'remote-compile-user-history)
	146	remote-compile-user)))
	147	(setq command (read-from-minibuffer "Compile command: "
	148	compile-command nil nil
	149	'(compile-history . 1)))
	150	(list (if (string= host "") remote-compile-host host)
	151	(if (string= user "") remote-compile-user user)
	152	command)))
	153	(setq compile-command command)
	154	(cond (user
	155	(setq remote-compile-user user))
	156	((null remote-compile-user)
	157	(setq remote-compile-user (user-login-name))))
	158	(let* ((parsed (and (featurep 'ange-ftp)
	159	(ange-ftp-ftp-name default-directory)))
	160	(compile-command
	161	(format "%s %s -l %s \"(%scd %s; %s)\""
	162	remote-shell-program
	163	host
	164	remote-compile-user
	165	(if remote-compile-run-before
	166	(concat remote-compile-run-before "; ")
	167	"")
	168	(if parsed (nth 2 parsed) default-directory)
	169	compile-command)))
	170	(setq remote-compile-host host)
	171	(save-some-buffers nil nil)
a3d41848	172	(compilation-start compile-command)
8749abea GM	173	;; Set comint-file-name-prefix in the compilation buffer so
8749abea GM	174	;; compilation-parse-errors will find referenced files by ange-ftp.
3432260a SM	175	(with-current-buffer compilation-last-buffer
	176	(set (make-local-variable 'comint-file-name-prefix)
	177	(concat "/" host ":")))))
8749abea	178
ab5796a9	179	;;; arch-tag: 2866a132-ece4-4ce9-9f91-ec147f803f73
8749abea	180	;;; rcompile.el ends here