(scan_sexps_forward): Fix previous change.
[bpt/emacs.git] / lisp / desktop.el
index 6b7fe0c..b9787a8 100644 (file)
@@ -1,9 +1,9 @@
 ;;; desktop.el --- save partial status of Emacs when killed
 
-;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
 
 ;; Author: Morten Welinder <terra@diku.dk>
-;; Version: 2.07
+;; Version: 2.10
 ;; Keywords: customization
 ;; Favourite-brand-of-beer: None, I hate beer.
 
@@ -50,7 +50,7 @@
 ;;
 ;;     (setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
 ;;
-;; To avoid saving excessive amounts of data you may also with to add
+;; To avoid saving excessive amounts of data you may also wish to add
 ;; something like the following
 ;;
 ;;     (add-hook 'kill-emacs-hook
@@ -59,7 +59,8 @@
 ;;                  (desktop-truncate regexp-search-ring 3)))
 ;;
 ;; which will make sure that no more than three search items are saved.  You
-;; must place this line *after* the (load "desktop") line.
+;; must place this line *after* the (load "desktop") line.  See also the
+;; variable desktop-save-hook.
 
 ;; Start Emacs in the root directory of your "project". The desktop saver
 ;; is inactive by default.  You activate it by M-x desktop-save RET.  When
 ;; `desktop-globals-to-save' (by default it isn't).  This may result in saving
 ;; things you did not mean to keep.  Use M-x desktop-clear RET.
 
-;; Thanks to  hetrick@phys.uva.nl (Jim Hetrick)     for useful ideas.
-;;            avk@rtsg.mot.com (Andrew V. Klein)    for a dired tip.
-;;            chris@tecc.co.uk (Chris Boucher)      for a mark tip.
-;;            f89-kam@nada.kth.se (Klas Mellbourn)  for a mh-e tip.
+;; Thanks to  hetrick@phys.uva.nl (Jim Hetrick)      for useful ideas.
+;;            avk@rtsg.mot.com (Andrew V. Klein)     for a dired tip.
+;;            chris@tecc.co.uk (Chris Boucher)       for a mark tip.
+;;            f89-kam@nada.kth.se (Klas Mellbourn)   for a mh-e tip.
+;;            kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
+;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
 ;; ---------------------------------------------------------------------------
 ;; TODO:
 ;;
 ;; Make the compilation more silent
 (eval-when-compile
   ;; We use functions from these modules
-  (mapcar 'require '(info mh-e dired reporter)))
+  ;; We can't (require 'mh-e) since that wants to load something.
+  (mapcar 'require '(info dired reporter)))
 ;; ----------------------------------------------------------------------------
 ;; USER OPTIONS -- settings you might want to play with.
 ;; ----------------------------------------------------------------------------
 (defconst desktop-basefilename
-  (if (eq system-type 'ms-dos)
+  (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
       "emacs.dsk" ; Ms-Dos does not support multiple dots in file name
     ".emacs.desktop")
-  "File for Emacs desktop.  A directory name will be prepended to this name.")
+  "File for Emacs desktop, not including the directory name.")
 
 (defvar desktop-missing-file-warning t
-  "*If non-nil then issue warning if a file no longer exists.
-Otherwise simply ignore the file.")
+  "*If non-nil then desktop warns when a file no longer exists.
+Otherwise it simply ignores that file.")
 
 (defvar desktop-globals-to-save
   (list 'desktop-missing-file-warning
@@ -130,9 +134,10 @@ Otherwise simply ignore the file.")
        'fill-column
        'overwrite-mode
        'change-log-default-name
+       'line-number-mode
        )
-  "List of local variables to save for each buffer.  The variables are saved
-only when they really are local.")
+  "List of local variables to save for each buffer.
+The variables are saved only when they really are local.")
 (make-variable-buffer-local 'desktop-locals-to-save)
 
 ;; We skip .log files because they are normally temporary.
@@ -142,20 +147,30 @@ only when they really are local.")
  "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
  "Regexp identifying buffers that are to be excluded from saving.")
 
+;; Skip ange-ftp files
+(defvar desktop-files-not-to-save
+  "^/[^/:]*:"
+  "Regexp identifying files whose buffers are to be excluded from saving.")
+
 (defvar desktop-buffer-handlers
   '(desktop-buffer-dired
     desktop-buffer-rmail
     desktop-buffer-mh
     desktop-buffer-info
     desktop-buffer-file)
-  "*List of functions to call in order to create a buffer.  The functions are
-called without explicit parameters but may access the the major mode as `mam',
-the file name as `fn', the buffer name as `bn', the default directory as
-`dd'.  If some function returns non-nil no further functions are called.
-If the function returns t then the buffer is considered created.")
+  "*List of functions to call in order to create a buffer.
+The functions are called without explicit parameters but may access
+the the major mode as `mam', the file name as `fn', the buffer name as
+`bn', the default directory as `dd'.  If some function returns non-nil
+no further functions are called.  If the function returns t then the
+buffer is considered created.")
 
 (defvar desktop-create-buffer-form "(desktop-create-buffer 205"
   "Opening of form for creation of new buffers.")
+
+(defvar desktop-save-hook nil
+  "Hook run before saving the desktop to allow you to cut history lists and
+the like shorter.")
 ;; ----------------------------------------------------------------------------
 (defvar desktop-dirname nil
   "The directory in which the current desktop file resides.")
@@ -177,8 +192,12 @@ If the function returns t then the buffer is considered created.")
 ;; ----------------------------------------------------------------------------
 (defun desktop-clear () "Empty the Desktop."
   (interactive)
-  (setq kill-ring nil)
-  (setq kill-ring-yank-pointer nil)
+  (setq kill-ring nil
+       kill-ring-yank-pointer nil
+       search-ring nil
+       search-ring-yank-pointer nil
+       regexp-search-ring nil
+       regexp-search-ring-yank-pointer nil)
   (mapcar (function kill-buffer) (buffer-list))
   (delete-other-windows))
 ;; ----------------------------------------------------------------------------
@@ -186,16 +205,26 @@ If the function returns t then the buffer is considered created.")
 
 (defun desktop-kill ()
   (if desktop-dirname
-      (progn
-       (desktop-save desktop-dirname))))
+      (condition-case err
+         (desktop-save desktop-dirname)
+       (file-error
+        (if (yes-or-no-p "Error while saving the desktop.  Quit anyway? ")
+            nil
+          (signal (car err) (cdr err)))))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-internal-v2s (val)
-  "Convert VALUE to a pair (quote . txt) where txt is a string that when read
-and evaluated yields value.  quote may be 'may (value may be quoted), 
-'must (values must be quoted), or nil (value may not be quoted)."
+  "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
+TXT is a string that when read and evaluated yields value.
+QUOTE may be `may' (value may be quoted),
+`must' (values must be quoted), or nil (value may not be quoted)."
   (cond
-   ((or (numberp val) (stringp val) (null val) (eq t val))
+   ((or (numberp val) (null val) (eq t val))
     (cons 'may (prin1-to-string val)))
+   ((stringp val)
+    (let ((copy (copy-sequence val)))
+      (set-text-properties 0 (length copy) nil copy)
+      ;; Get rid of text properties because we cannot read them
+      (cons 'may (prin1-to-string copy))))
    ((symbolp val)
     (cons 'must (prin1-to-string val)))
    ((vectorp val)
@@ -218,22 +247,42 @@ and evaluated yields value.  quote may be 'may (value may be quoted),
                            ")"))
        (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
    ((consp val)
-    (let ((car-q.txt (desktop-internal-v2s (car val)))
-         (cdr-q.txt (desktop-internal-v2s (cdr val))))
-      (cond
-       ((or (null (car car-q.txt)) (null (car cdr-q.txt)))
-       (cons nil (concat "(cons " 
-                         (if (eq (car car-q.txt) 'must) "'")                         
-                         (cdr car-q.txt) " "
-                         (if (eq (car cdr-q.txt) 'must) "'")                         
-                         (cdr cdr-q.txt) ")")))
-       ((consp (cdr val))
-       (cons 'must (concat "(" (cdr car-q.txt) 
-                           " " (substring (cdr cdr-q.txt) 1 -1) ")")))
-       ((null (cdr val))
-       (cons 'must (concat "(" (cdr car-q.txt) ")")))
-       (t
-       (cons 'must (concat "(" (cdr car-q.txt) " . " (cdr cdr-q.txt) ")"))))))
+    (let ((p val)
+         newlist
+         anynil)
+      (while (consp p)
+       (let ((q.txt (desktop-internal-v2s (car p))))
+         (or anynil (setq anynil (null (car q.txt))))
+         (setq newlist (cons q.txt newlist)))
+       (setq p (cdr p)))
+      (if p
+         (let ((last (desktop-internal-v2s p))
+               (el (car newlist)))
+           (setcar newlist
+                   (if (or anynil (setq anynil (null (car last))))
+                       (cons nil
+                             (concat "(cons "
+                                     (if (eq (car el) 'must) "'" "")
+                                     (cdr el)
+                                     " "
+                                     (if (eq (car last) 'must) "'" "")
+                                     (cdr last)
+                                     ")"))
+                     (cons 'must
+                           (concat (cdr el) " . " (cdr last)))))))
+      (setq newlist (nreverse newlist))
+      (if anynil
+         (cons nil
+               (concat "(list "
+                       (mapconcat (lambda (el)
+                                    (if (eq (car el) 'must)
+                                        (concat "'" (cdr el))
+                                      (cdr el)))
+                                  newlist
+                                  " ")
+                       ")"))
+       (cons 'must
+             (concat "(" (mapconcat 'cdr newlist " ") ")")))))
    ((subrp val)
     (cons nil (concat "(symbol-function '"
                      (substring (prin1-to-string val) 7 -1)
@@ -246,11 +295,11 @@ and evaluated yields value.  quote may be 'may (value may be quoted),
                        " (list 'lambda '() (list 'set-marker mk "
                        pos " (get-buffer " buf ")))) mk)"))))
    (t                                  ; save as text
-    (prin1-to-string (prin1-to-string val)))))
+    (cons 'may "\"Unprintable entity\""))))
 
 (defun desktop-value-to-string (val)
-  "Convert VALUE to a string that when read evaluates to the same value.  Not
-all types of values are supported."
+  "Convert VALUE to a string that when read evaluates to the same value.
+Not all types of values are supported."
   (let* ((print-escape-newlines t)
         (float-output-format nil)
         (quote.txt (desktop-internal-v2s val))
@@ -273,14 +322,22 @@ all types of values are supported."
   "Return t if the desktop should record a particular buffer for next startup.
 FILENAME is the visited file name, BUFNAME is the buffer name, and
 MODE is the major mode."
-  (or (and filename
-          (not (string-match desktop-buffers-not-to-save bufname)))
-      (and (null filename)
-          (memq mode '(Info-mode dired-mode rmail-mode)))))
+  (let ((case-fold-search nil))
+    (or (and filename
+            (not (string-match desktop-buffers-not-to-save bufname))
+            (not (string-match desktop-files-not-to-save filename)))
+       (and (eq mode 'dired-mode)
+            (save-excursion
+              (set-buffer (get-buffer bufname))
+              (not (string-match desktop-files-not-to-save
+                                 default-directory))))
+       (and (null filename)
+            (memq mode '(Info-mode rmail-mode))))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-save (dirname)
   "Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
   (interactive "DDirectory to save desktop file in: ")
+  (run-hooks 'desktop-save-hook)
   (save-excursion
     (let ((filename (expand-file-name
                     (concat dirname desktop-basefilename)))
@@ -293,7 +350,7 @@ MODE is the major mode."
                               (buffer-name)
                               major-mode
                               (list    ; list explaining minor modes
-                                    (not (null auto-fill-function)))
+                               (not (null auto-fill-function)))
                               (point)
                               (list (mark t) mark-active)
                               buffer-read-only
@@ -301,11 +358,13 @@ MODE is the major mode."
                                      (list Info-current-file
                                            Info-current-node))
                                     ((eq major-mode 'dired-mode)
-                                     (nreverse
-                                      (mapcar
-                                       (function car)
-                                       dired-subdir-alist)))
-                                    )
+                                     (cons
+                                      (expand-file-name dired-directory)
+                                      (cdr
+                                       (nreverse
+                                        (mapcar
+                                         (function car)
+                                         dired-subdir-alist))))))
                               (let ((locals desktop-locals-to-save)
                                     (loclist (buffer-local-variables))
                                     (ll))
@@ -322,11 +381,11 @@ MODE is the major mode."
          (buf (get-buffer-create "*desktop*")))
       (set-buffer buf)
       (erase-buffer)
-      
+
       (insert desktop-header
              ";; Created " (current-time-string) "\n"
-                 ";; Emacs version " emacs-version "\n\n"
-                     ";; Global section:\n")
+             ";; Emacs version " emacs-version "\n\n"
+             ";; Global section:\n")
       (mapcar (function desktop-outvar) desktop-globals-to-save)
       (if (memq 'kill-ring desktop-globals-to-save)
          (insert "(setq kill-ring-yank-pointer (nthcdr "
@@ -357,8 +416,9 @@ MODE is the major mode."
   (interactive)
   (if desktop-dirname
       (let ((filename (concat desktop-dirname desktop-basefilename)))
-       (if (file-exists-p filename) (delete-file filename))
-       (setq desktop-dirname nil))))
+       (setq desktop-dirname nil)
+       (if (file-exists-p filename)
+           (delete-file filename)))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-read ()
   "Read the Desktop file and the files it specifies."
@@ -377,9 +437,9 @@ MODE is the major mode."
       (desktop-clear))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-load-default ()
-  "Load the `default' start-up library manually.  Also inhibit further loading
-of it.  Call this from your `.emacs' file to provide correct modes for
-autoloaded files."
+  "Load the `default' start-up library manually.
+Also inhibit further loading of it.  Call this from your `.emacs' file
+to provide correct modes for autoloaded files."
   (if (not inhibit-default-init)       ; safety check
       (progn
        (load "default" t t)
@@ -396,7 +456,11 @@ autoloaded files."
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-rmail () "Load an RMAIL file."
   (if (eq 'rmail-mode mam)
-      (progn (rmail-input fn) t)))
+      (condition-case error
+         (progn (rmail-input fn) t)
+       (file-locked
+        (kill-buffer (current-buffer))
+        'ignored))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-mh () "Load a folder in the mh system."
   (if (eq 'mh-folder-mode mam)
@@ -408,10 +472,14 @@ autoloaded files."
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-dired () "Load a directory using dired."
   (if (eq 'dired-mode mam)
-      (progn
-       (dired (car misc))
-       (mapcar (function dired-maybe-insert-subdir) (cdr misc))
-       t)))
+      (if (file-directory-p (file-name-directory (car misc)))
+         (progn
+           (dired (car misc))
+           (mapcar 'dired-insert-subdir (cdr misc))
+           t)
+       (message "Directory %s no longer exists." (car misc))
+       (sit-for 1)
+       'ignored)))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-file () "Load a file."
   (if fn