]> code.delx.au - gnu-emacs/blobdiff - lisp/desktop.el
Copyright up-date.
[gnu-emacs] / lisp / desktop.el
index b31f17353da2cf7b26d88f4d6240fc1b008dcb00..dd26daa097083903c9e2a12727675d5ce1345d6c 100644 (file)
@@ -3,7 +3,7 @@
 ;; Copyright (C) 1993, 1994, 1995, 1997 Free Software Foundation, Inc.
 
 ;; Author: Morten Welinder <terra@diku.dk>
-;; Keywords: customization
+;; Keywords: convenience
 ;; Favourite-brand-of-beer: None, I hate beer.
 
 ;; This file is part of GNU Emacs.
 ;;             - buffer-read-only
 ;;             - some local variables
 
-;; To use this, first put these three lines in the bottom of your .emacs
+;; To use this, first put these two lines in the bottom of your .emacs
 ;; file (the later the better):
 ;;
-;;     (load "desktop")
 ;;     (desktop-load-default)
 ;;     (desktop-read)
 ;;
-;; Between the second and the third line you may wish to add something that
-;; updates the variables `desktop-globals-to-save' and/or
-;; `desktop-locals-to-save'.  If for instance you want to save the local
-;; variable `foobar' for every buffer in which it is local, you could add
-;; the line
+;; Between these two lines you may wish to add something that updates the
+;; variables `desktop-globals-to-save' and/or `desktop-locals-to-save'.  If
+;; for instance you want to save the local variable `foobar' for every buffer
+;; in which it is local, you could add the line
 ;;
 ;;     (setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
 ;;
@@ -59,8 +57,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.  See also the
-;; variable desktop-save-hook.
+;; must place this line *after* the `(desktop-load-default)' 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
 ;; act as a default desktop when you start Emacs from a directory that
 ;; doesn't have its own.  I never do this, but you may want to.
 
+;; Some words on minor modes: Most minor modes are controlled by
+;; buffer-local variables, which have a standard save / restore
+;; mechanism.  To handle all minor modes, we take the following
+;; approach: (1) check whether the variable name from
+;; `minor-mode-alist' is also a function; and (2) use translation
+;; table `desktop-minor-mode-table' in the case where the two names
+;; are not the same.
+
 ;; By the way: don't use desktop.el to customize Emacs -- the file .emacs
 ;; in your home directory is used for that.  Saving global default values
 ;; for buffers is an example of misuse.
   :group 'desktop
   :type 'boolean
   :require 'desktop
-  :initialize 'custom-initialize-default)
+  :initialize 'custom-initialize-default
+  :version "20.3")
 
 (defcustom desktop-basefilename
   (convert-standard-filename ".emacs.desktop")
@@ -218,6 +225,20 @@ This is useful for truncating history lists, for example."
   :type 'hook
   :group 'desktop)
 
+(defcustom desktop-minor-mode-table
+  '((auto-fill-function auto-fill-mode)
+    (vc-mode nil))
+  "Table mapping minor mode variables to minor mode functions.
+Each entry has the form (NAME RESTORE-FUNCTION).
+NAME is the name of the buffer-local variable indicating that the minor
+mode is active.  RESTORE-FUNCTION is the function to activate the minor mode.
+called.  RESTORE-FUNCTION nil means don't try to restore the minor mode.
+Only minor modes for which the name of the buffer-local variable
+and the name of the minor mode function are different have to added to
+this table."
+  :type 'sexp
+  :group 'desktop)
+
 ;; ----------------------------------------------------------------------------
 (defvar desktop-dirname nil
   "The directory in which the current desktop file resides.")
@@ -394,7 +415,7 @@ which means to truncate VAR's value to at most MAX-SIZE elements
          (if (and (integerp size)
                   (> size 0)
                   (listp (eval var)))
-             (desktop-truncate (eval var) size)) 
+             (desktop-truncate (eval var) size))
          (insert "(setq "
                  (symbol-name var)
                  " "
@@ -426,14 +447,27 @@ MODE is the major mode."
                     (concat dirname desktop-basefilename)))
          (info (nreverse
                 (mapcar
-                 (function (lambda (b)
+                 (function
+                  (lambda (b)
                              (set-buffer b)
                              (list
                               (buffer-file-name)
                               (buffer-name)
                               major-mode
-                              (list    ; list explaining minor modes
-                               (not (null auto-fill-function)))
+                              ;; minor modes
+                              (let (ret)
+                                (mapcar
+                                 #'(lambda (mim)
+                                     (and (boundp mim)
+                                          (symbol-value mim)
+                                          (setq ret
+                                                (cons (let ((special (assq mim desktop-minor-mode-table)))
+                                                       (if special
+                                                           (cadr special)
+                                                         mim))
+                                                     ret))))
+                                 (mapcar #'car minor-mode-alist))
+                                ret)
                               (point)
                               (list (mark t) mark-active)
                               buffer-read-only
@@ -503,6 +537,7 @@ MODE is the major mode."
        (if (file-exists-p filename)
            (delete-file filename)))))
 ;; ----------------------------------------------------------------------------
+;;;###autoload
 (defun desktop-read ()
   "Read the Desktop file and the files it specifies.
 This is a no-op when Emacs is running in batch mode."
@@ -525,6 +560,7 @@ This is a no-op when Emacs is running in batch mode."
            (message "Desktop loaded."))
        (desktop-clear)))))
 ;; ----------------------------------------------------------------------------
+;;;###autoload
 (defun desktop-load-default ()
   "Load the `default' start-up library manually.
 Also inhibit further loading of it.  Call this from your `.emacs' file
@@ -541,12 +577,15 @@ to provide correct modes for autoloaded files."
       (progn
        (require 'info)
        (Info-find-node (nth 0 desktop-buffer-misc) (nth 1 desktop-buffer-misc))
-       t)))
+       (current-buffer))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-rmail () "Load an RMAIL file."
   (if (eq 'rmail-mode desktop-buffer-major-mode)
       (condition-case error
-         (progn (rmail-input desktop-buffer-file-name) t)
+         (progn (rmail-input desktop-buffer-file-name)
+                         (if (eq major-mode 'rmail-mode)
+                             (current-buffer)
+                           rmail-buffer))
        (file-locked
         (kill-buffer (current-buffer))
         'ignored))))
@@ -556,16 +595,16 @@ to provide correct modes for autoloaded files."
       (progn
        (require 'mh-e)
        (mh-find-path)
-       (mh-visit-folder desktop-buffer-name)
-       t)))
+        (mh-visit-folder desktop-buffer-name)
+       (current-buffer))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-dired () "Load a directory using dired."
   (if (eq 'dired-mode desktop-buffer-major-mode)
       (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
          (progn
-           (dired (car desktop-buffer-misc))
-           (mapcar 'dired-insert-subdir (cdr desktop-buffer-misc))
-           t)
+            (dired (car desktop-buffer-misc))
+           (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
+           (current-buffer))
        (message "Directory %s no longer exists." (car desktop-buffer-misc))
        (sit-for 1)
        'ignored)))
@@ -577,14 +616,15 @@ to provide correct modes for autoloaded files."
                   (y-or-n-p (format
                              "File \"%s\" no longer exists. Re-create? "
                              desktop-buffer-file-name))))
-         (progn (find-file desktop-buffer-file-name) t)
+         (progn (find-file desktop-buffer-file-name) (current-buffer))
        'ignored)))
 ;; ----------------------------------------------------------------------------
 ;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
 ;; only.
 (defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
                                  desktop-buffer-major-mode
-                                 mim pt mk ro desktop-buffer-misc &optional locals)
+                                 mim pt mk ro desktop-buffer-misc
+                                 &optional locals)
   (let ((hlist desktop-buffer-handlers)
        (result)
        (handler))
@@ -592,31 +632,35 @@ to provide correct modes for autoloaded files."
       (setq handler (car hlist))
       (setq result (funcall handler))
       (setq hlist (cdr hlist)))
-    (if (eq result t)
-       (progn
-         (if (not (equal (buffer-name) desktop-buffer-name))
-             (rename-buffer desktop-buffer-name))
-         (auto-fill-mode (if (nth 0 mim) 1 0))
-         (goto-char pt)
-         (if (consp mk)
+    (when (bufferp result)
+      (set-buffer result)
+      (if (not (equal (buffer-name) desktop-buffer-name))
+         (rename-buffer desktop-buffer-name))
+      ;; minor modes
+      (cond ((equal '(t) mim)   (auto-fill-mode 1))    ; backwards compatible
+           ((equal '(nil) mim) (auto-fill-mode 0))
+           (t (mapcar #'(lambda (minor-mode)
+                          (when minor-mode (funcall minor-mode 1)))
+                          mim)))
+      (goto-char pt)
+      (if (consp mk)
+         (progn
+           (set-mark (car mk))
+           (setq mark-active (car (cdr mk))))
+       (set-mark mk))
+      ;; Never override file system if the file really is read-only marked.
+      (if ro (setq buffer-read-only ro))
+      (while locals
+       (let ((this (car locals)))
+         (if (consp this)
+             ;; an entry of this form `(symbol . value)'
              (progn
-               (set-mark (car mk))
-               (setq mark-active (car (cdr mk))))
-           (set-mark mk))
-         ;; Never override file system if the file really is read-only marked.
-         (if ro (setq buffer-read-only ro))
-         (while locals
-           (let ((this (car locals)))
-             (if (consp this)
-                 ;; an entry of this form `(symbol . value)'
-                 (progn
-                   (make-local-variable (car this))
-                   (set (car this) (cdr this)))
-               ;; an entry of the form `symbol'
-               (make-local-variable this)
-               (makunbound this)))
-           (setq locals (cdr locals)))
-         ))))
+               (make-local-variable (car this))
+               (set (car this) (cdr this)))
+           ;; an entry of the form `symbol'
+           (make-local-variable this)
+           (makunbound this)))
+       (setq locals (cdr locals))))))
 
 ;; Backward compatibility -- update parameters to 205 standards.
 (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name