-;; Process command line arguments from within a suspended Emacs job
-;; Copyright (C) 1988 Free Software Foundation, Inc.
+;;; resume.el --- process command line args from within a suspended Emacs job
-;; This file is not yet part of GNU Emacs, but soon will be.
+;; Copyright (C) 1992 Free Software Foundation, Inc.
+
+;; Author: Joe Wells <jbw@bucsf.bu.edu>
+;; Adapted-By: ESR
+;; Keywords: 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. No author or distributor
-;; accepts responsibility to anyone for the consequences of using it
-;; or for whether it serves any particular purpose or works at all,
-;; unless he says so in writing. Refer to the GNU Emacs General Public
-;; License for full details.
-
-;; Everyone is granted permission to copy, modify and redistribute
-;; GNU Emacs, but only under the conditions described in the
-;; GNU Emacs General Public License. A copy of this license is
-;; supposed to have been given to you along with GNU Emacs so you
-;; can know your rights and responsibilities. It should be in a
-;; file named COPYING. Among other things, the copyright notice
-;; and this notice must be preserved on all copies.
-
-;; Created by: Joe Wells, jbw@bucsf.bu.edu
-;; Created on: 1988?
-;; Last modified by: Joe Wells, jbw@dodge
-;; Last modified on: Thu Jun 14 15:20:41 1990
-;; Filename: resume.el
-;; Purpose: handle command line arguments when resuming suspended job
-
-;; Stephen Gildea suggested bug fix (gildea@bbn.com).
+;; 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., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:
+
+;; The purpose of this library is to handle command line arguments
+;; when you resume an existing Emacs job.
+
+;; In order to use it, you must put this code in your .emacs file.
+
+;; (add-hook 'suspend-hook 'resume-suspend-hook)
+;; (add-hook 'suspend-resume-hook 'resume-process-args)
+
+;; You can't get the benefit of this library by using the `emacs' command,
+;; since that always starts a new Emacs job. Instead you must use a
+;; command called `edit' which knows how to resume an existing Emacs job
+;; if you have one, or start a new Emacs job if you don't have one.
+
+;; To define the `edit' command, run the script etc/emacs.csh (if you use CSH),
+;; or etc/emacs.bash if you use BASH. You would normally do this in your
+;; login script.
+
+;; Stephan Gildea suggested bug fix (gildea@bbn.com).
;; Ideas from Michael DeCorte and other people.
-;; For csh users, insert the following alias in your .cshrc file
-;; (after removing the leading double semicolons, of course):
-;;
-;;# The following line could be just EMACS_CMD=emacs, but this depends on
-;;# your site.
-;;if (! $?EMACS_CMD) set EMACS_CMD=emacs
-;;set JOBS_FILE=/tmp/jobs.$USER.$$
-;;set ARGS_FILE=~/.emacs_args
-;;set STOP_PATT='^\[[0-9]*\] *[ +-] Stopped ............ '
-;;set SUNVIEW_CMD='emacstool -nw -f emacstool-init -f server-start'
-;;set X_CMD=\'\''$EMACS_CMD -i -f server-start'
-;;alias emacs \
-;;' \\
-;; jobs >! "$JOBS_FILE" \\
-;; && grep "$STOP_PATT$EMACS_CMD" "$JOBS_FILE" >& /dev/null \\
-;; && echo `pwd` \!* >! "$ARGS_FILE" && ""fg %$EMACS_CMD \\
-;;|| if (! -e ~/.emacs_server || -f ~/.emacs_server) set status=1 \\
-;; && emacsclient \!* \\
-;;|| @ status=1 - $?DISPLAY && eval "$X_CMD -i \!* &" \\
-;;|| @ status=1 - $?WINDOW_PARENT && eval "$SUNVIEW_CMD \!* &" \\
-;;|| ""$EMACS_CMD -nw \!* \\
-;;'
-;;
-;; The alias works as follows:
-;; 1. If there is a suspended Emacs job that is a child of the
-;; current shell, place its arguments in the ~/.emacs_args file and
-;; resume it.
-;; 2. Else if the ~/.emacs_server socket has been created, presume an
-;; Emacs server is running and attempt to connect to it. If no Emacs
-;; server is listening on the socket, this will fail.
-;; 3. Else if the DISPLAY environment variable is set, presume we are
-;; running under X Windows and start a new GNU Emacs process in the
-;; background as an X client.
-;; 4. Else if the WINDOW_PARENT environment variable is set, presume we
-;; are running under SunView and start an emacstool process in the
-;; background.
-;; 5. Else start a regular Emacs process.
-;;
-;; Notes:
-;; The output of the "jobs" command is not piped directly into "grep"
-;; because that would run the "jobs" command in a subshell.
-;; Before resuming a suspended emacs, the current directory and all
-;; command line arguments are placed in a file name ~/.emacs_args.
-;; The "-nw" switch to Emacs means no windowing system.
-
-;; Insert this in your .emacs file:
-;;(setq suspend-resume-hook 'resume-process-args)
-;;(setq suspend-hook 'empty-args-file)
-;;(autoload 'empty-args-file "resume")
-;;(autoload 'resume-process-args "resume")
-
-;; Finally, put the rest in a file named "resume.el" in a lisp library
-;; directory.
-
-(defvar emacs-args-file (expand-file-name "~/.emacs_args")
+;;; Code:
+
+(defvar resume-emacs-args-file (expand-file-name "~/.emacs_args")
"*This file is where arguments are placed for a suspended emacs job.")
-(defvar emacs-args-buffer " *Command Line Args*"
+(defvar resume-emacs-args-buffer " *Command Line Args*"
"Buffer that is used by resume-process-args.")
(defun resume-process-args ()
- "This should be called from inside of `suspend-resume-hook'.
-This grabs the contents of the file whose name is stored in `emacs-args-file',
-and processes these arguments like command line options."
+ "Handler for command line args given when Emacs is resumed."
(let ((start-buffer (current-buffer))
- (args-buffer (get-buffer-create emacs-args-buffer))
- length args)
+ (args-buffer (get-buffer-create resume-emacs-args-buffer))
+ length args
+ (command-line-default-directory default-directory))
(unwind-protect
(progn
(set-buffer args-buffer)
(erase-buffer)
- ;; get the contents of emacs-args-file
+ ;; get the contents of resume-emacs-args-file
(condition-case ()
- (let ((result (insert-file-contents emacs-args-file)))
+ (let ((result (insert-file-contents resume-emacs-args-file)))
(setq length (car (cdr result))))
;; the file doesn't exist, ergo no arguments
(file-error
;; arguments are now in reverse order
(setq args (nreverse args))
;; make sure they're not read again
- (erase-buffer))
- (write-buffer-to-file (current-buffer) emacs-args-file)
+ (erase-buffer))
+ (resume-write-buffer-to-file (current-buffer) resume-emacs-args-file)
;; if nothing was in buffer, args will be null
(or (null args)
- (setq default-directory (file-name-as-directory (car args))
+ (setq command-line-default-directory
+ (file-name-as-directory (car args))
args (cdr args)))
;; actually process the arguments
(command-line-1 args))
(if (eq (current-buffer) args-buffer)
(set-buffer start-buffer)))))
-(defun empty-args-file ()
- "This empties the contents of the file whose name is specified by
-`emacs-args-file'."
+;;;###autoload
+(defun resume-suspend-hook ()
+ "Clear out the file used for transmitting args when Emacs resumes."
(save-excursion
- (set-buffer (get-buffer-create emacs-args-buffer))
+ (set-buffer (get-buffer-create resume-emacs-args-buffer))
(erase-buffer)
- (write-buffer-to-file (current-buffer) emacs-args-file)))
+ (resume-write-buffer-to-file (current-buffer) resume-emacs-args-file)))
-(defun write-buffer-to-file (buffer file)
+(defun resume-write-buffer-to-file (buffer file)
"Writes the contents of BUFFER into FILE, if permissions allow."
(if (not (file-writable-p file))
(error "No permission to write file %s" file))
(widen)
(write-region (point-min) (point-max) file nil 'quiet))
(set-buffer-modified-p nil)))
+
+(provide 'resume)
+
+;;; arch-tag: c90b2761-4803-4e58-a0ae-c4721368b628
+;;; resume.el ends here