(hs-hide-block): Fix message spelling.
[bpt/emacs.git] / lisp / resume.el
index 86866c1..7df462b 100644 (file)
@@ -1,31 +1,37 @@
-;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+
+;;; Commentary:
+
+;; Theory: the first time you start Emacs, command line arguments are
+;; handled normally.  Then, you suspend your emacs job.  When you want to edit
+;; something else, you type "emacs filename" as usual, but instead of
+;; starting a new emacs job, the old job is resumed instead, and the command
+;; line arguments are placed in a file where the old emacs job looks for
+;; them.
+
+;; 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
 ;; 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")
+;;(add-hook 'suspend-hook 'resume-suspend-hook)
 
 ;; 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
@@ -122,10 +125,11 @@ options."
            (setq args (nreverse args))
            ;; make sure they're not read again
            (erase-buffer))             
-         (write-buffer-to-file (current-buffer) emacs-args-file)
+         (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))
@@ -139,15 +143,15 @@ options."
       (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))
@@ -158,3 +162,7 @@ emacs-args-file."
       (widen)
       (write-region (point-min) (point-max) file nil 'quiet))
     (set-buffer-modified-p nil)))
+
+(provide 'resume)
+
+;;; resume.el ends here