;; Free Software Foundation, Inc.
;; Author: Morten Welinder <terra@diku.dk>
+;; Maintainter: Lars Hansen <larsh@math.ku.dk>
;; Keywords: convenience
;; Favourite-brand-of-beer: None, I hate beer.
;; - buffer-read-only
;; - some local variables
-;; To use this, first put these two lines in the bottom of your .emacs
-;; file (the later the better):
+;; To use this, use customize to turn on desktop-save-mode or add the
+;; following line somewhere in your .emacs file:
;;
-;; (desktop-load-default)
-;; (desktop-read)
+;; (desktop-save-mode 1)
;;
-;; 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))
-;;
-;; To avoid saving excessive amounts of data you may also wish to add
-;; something like the following
-;;
-;; (add-hook 'kill-emacs-hook
-;; '(lambda ()
-;; (desktop-truncate search-ring 3)
-;; (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 `(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
-;; you exit the next time the above data will be saved. This ensures that
-;; all the files you were editing will be reloaded the next time you start
-;; Emacs from the same directory and that points will be set where you
-;; left them. If you save a desktop file in your home directory it will
-;; 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.
+;; For further usage information, look at the section
+;; "Saving Emacs Sessions" in the GNU Emacs Manual.
+
+;; When the desktop module is loaded, the function `desktop-kill' is
+;; added to the `kill-emacs-hook'. This function is responsible for
+;; saving the desktop when Emacs is killed. Furthermore an anonymous
+;; function is added to the `after-init-hook'. This function is
+;; responsible for loading the desktop when Emacs is started.
;; Some words on minor modes: Most minor modes are controlled by
;; buffer-local variables, which have a standard save / restore
;;; Code:
-;; Make the compilation more silent
-(eval-when-compile
- ;; We use functions from these modules
- ;; We can't (require 'mh-e) since that wants to load something.
- (mapcar 'require '(info dired reporter)))
-
(defvar desktop-file-version "206"
- "Verion number of desktop file format.
+ "Version number of desktop file format.
Written into the desktop file and used at desktop read to provide
backward compatibility.")
"Save status of Emacs when you exit."
:group 'frames)
-(defcustom desktop-enable nil
- "*Non-nil enable Desktop to save the state of Emacs when you exit."
- :group 'desktop
- :type 'boolean
- :require 'desktop
- :initialize 'custom-initialize-default
- :version "20.3")
+;;;###autoload
+(define-minor-mode desktop-save-mode
+ "Toggle desktop saving mode.
+With numeric ARG, turn desktop saving on if ARG is positive, off
+otherwise. See variable `desktop-save' for a description of when the
+desktop is saved."
+ :global t
+ :group 'desktop)
+
+;; Maintained for backward compatibility
+(defvaralias 'desktop-enable 'desktop-save-mode)
+(make-obsolete-variable 'desktop-enable 'desktop-save-mode)
(defcustom desktop-save 'ask-if-new
- "*When the user changes desktop or quits emacs, should the desktop be saved?
-\(in the current desktop directory)
+ "*Specifies whether the desktop should be saved when it is killed.
+A desktop is killed when the user changes desktop or quits Emacs.
+Possible values are:
t -- always save.
ask -- always ask.
ask-if-new -- ask if no desktop file exists, otherwise just save.
ask-if-exists -- ask if desktop file exists, otherwise don't save.
if-exists -- save if desktop file exists, otherwise don't save.
nil -- never save.
-The desktop is never saved when `desktop-enable' is nil."
+The desktop is never saved when `desktop-save-mode' is nil.
+The variables `desktop-directory' and `desktop-base-file-name'
+determine where the desktop is saved."
:type '(choice
(const :tag "Always save" t)
(const :tag "Always ask" ask)
(const :tag "Ask if desktop file exists, else don't save" ask-if-exists)
(const :tag "Save if desktop file exists, else don't" if-exists)
(const :tag "Never save" nil))
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-base-file-name
(convert-standard-filename ".emacs.desktop")
- "File for Emacs desktop, not including the directory name."
+ "Name of file for Emacs desktop, excluding the directory part."
:type 'file
:group 'desktop)
(defvaralias 'desktop-basefilename 'desktop-base-file-name)
"List of directories to search for the desktop file.
The base name of the file is specified in `desktop-base-file-name'."
:type '(repeat directory)
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-missing-file-warning nil
- "*If non-nil then desktop warns when a file no longer exists.
-Otherwise it simply ignores that file."
+ "*If non-nil then `desktop-read' asks if a non-existent file should be recreated.
+Also pause for a moment to display message about errors signaled in
+`desktop-buffer-mode-handlers'.
+
+If nil, just print error messages in the message buffer."
:type 'boolean
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-no-desktop-file-hook nil
- "Normal hook run after fail of `desktop-read' due to missing desktop file.
+ "Normal hook run when `desktop-read' can't find a desktop file.
May e.g. be used to show a dired buffer."
:type 'hook
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-after-read-hook nil
- "Normal hook run after a sucessful `desktop-read'.
+ "Normal hook run after a successful `desktop-read'.
May e.g. be used to show a buffer list."
:type 'hook
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-save-hook nil
- "Hook run before desktop saves the state of Emacs.
+ "Normal hook run before the desktop is saved in a desktop file.
This is useful for truncating history lists, for example."
:type 'hook
:group 'desktop)
-(defcustom desktop-globals-to-save '(
- desktop-missing-file-warning
- tags-file-name
- tags-table-list
- search-ring
- regexp-search-ring
- register-alist)
- "List of global variables to save when killing Emacs.
-An element may be variable name (a symbol)
-or a cons cell of the form (VAR . MAX-SIZE),
-which means to truncate VAR's value to at most MAX-SIZE elements
-\(if the value is a list) before saving the value.
+(defcustom desktop-globals-to-save
+ '(desktop-missing-file-warning
+ tags-file-name
+ tags-table-list
+ search-ring
+ regexp-search-ring
+ register-alist)
+ "List of global variables saved by `desktop-save'.
+An element may be variable name (a symbol) or a cons cell of the form
+\(VAR . MAX-SIZE), which means to truncate VAR's value to at most
+MAX-SIZE elements (if the value is a list) before saving the value.
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
:type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
:group 'desktop)
-(defcustom desktop-globals-to-clear '(
- kill-ring
- kill-ring-yank-pointer
- search-ring
- search-ring-yank-pointer
- regexp-search-ring
- regexp-search-ring-yank-pointer)
- "List of global variables set to clear by `desktop-clear'.
+(defcustom desktop-globals-to-clear
+ '(kill-ring
+ kill-ring-yank-pointer
+ search-ring
+ search-ring-yank-pointer
+ regexp-search-ring
+ regexp-search-ring-yank-pointer)
+ "List of global variables that `desktop-clear' will clear.
An element may be variable name (a symbol) or a cons cell of the form
\(VAR . FORM). Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluateing FORM."
:type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
(defcustom desktop-clear-preserve-buffers-regexp
- "^\\*tramp/.+\\*$"
- "Regexp identifying buffers that `desktop-clear' should not delete."
+ "^\\(\\*scratch\\*\\|\\*Messages\\*\\|\\*tramp/.+\\*\\)$"
+ "Regexp identifying buffers that `desktop-clear' should not delete.
+See also `desktop-clear-preserve-buffers'."
:type 'regexp
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
-;; Maintained for backward compatibility
-(defcustom desktop-clear-preserve-buffers
- '("*scratch*" "*Messages*")
- "*List of buffer names that `desktop-clear' should not delete."
+(defcustom desktop-clear-preserve-buffers nil
+ "*List of buffer names that `desktop-clear' should not delete.
+See also `desktop-clear-preserve-buffers-regexp'."
:type '(repeat string)
:group 'desktop)
-(defvar desktop-locals-to-save '(
- desktop-locals-to-save ; Itself! Think it over.
- truncate-lines
- case-fold-search
- case-replace
- fill-column
- overwrite-mode
- change-log-default-name
- line-number-mode)
+(defcustom desktop-locals-to-save
+ '(desktop-locals-to-save ; Itself! Think it over.
+ truncate-lines
+ case-fold-search
+ case-replace
+ fill-column
+ overwrite-mode
+ change-log-default-name
+ line-number-mode
+ buffer-file-coding-system)
"List of local variables to save for each buffer.
-The variables are saved only when they really are local.")
+The variables are saved only when they really are local."
+ :type '(repeat symbol)
+ :group 'desktop)
(make-variable-buffer-local 'desktop-locals-to-save)
;; We skip .log files because they are normally temporary.
:type 'regexp
:group 'desktop)
-;; Skip ange-ftp files
+;; Skip tramp and ange-ftp files
(defcustom desktop-files-not-to-save
"^/[^/:]*:"
"Regexp identifying files whose buffers are to be excluded from saving."
:type 'regexp
:group 'desktop)
-(defcustom desktop-buffer-modes-to-save
- '(Info-mode rmail-mode)
- "If a buffer is of one of these major modes, save the buffer name.
-It is up to the functions in `desktop-buffer-handlers' to decide
-whether the buffer should be recreated or not, and how."
- :type '(repeat symbol)
- :group 'desktop)
-
(defcustom desktop-modes-not-to-save nil
"List of major modes whose buffers should not be saved."
:type '(repeat symbol)
tilde -- Relative to ~.
local -- Relative to directory of desktop file."
:type '(choice (const absolute) (const tilde) (const local))
- :group 'desktop)
+ :group 'desktop
+ :version "22.1")
-(defcustom desktop-buffer-misc-functions
- '(desktop-buffer-info-misc-data
- desktop-buffer-dired-misc-data)
- "*Functions used to determine auxiliary information for a buffer.
-These functions are called in order, with no arguments. If a function
-returns non-nil, its value is saved along with the desktop buffer for
-which it was called; no further functions will be called.
-
-File names should formatted using the call
-\"(desktop-file-name FILE-NAME dirname)\".
-
-Later, when desktop.el restores the buffers it has saved, each of the
-`desktop-buffer-handlers' functions will have access to a buffer local
-variable, named `desktop-buffer-misc', whose value is what the
-\"misc\" function returned previously."
- :type '(repeat function)
- :group 'desktop)
+(defcustom desktop-restore-eager t
+ "Number of buffers to restore immediately.
+Remaining buffers are restored lazily (when Emacs is idle).
+If value is t, all buffers are restored immediately."
+ :type '(choice (const t) integer)
+ :group 'desktop
+ :version "22.1")
+
+(defcustom desktop-lazy-verbose t
+ "Verbose reporting of lazily created buffers."
+ :type 'boolean
+ :group 'desktop
+ :version "22.1")
+
+(defcustom desktop-lazy-idle-delay 5
+ "Idle delay before starting to create buffers.
+See `desktop-restore-eager'."
+ :type 'integer
+ :group 'desktop
+ :version "22.1")
+
+;;;###autoload
+(defvar desktop-save-buffer nil
+ "When non-nil, save buffer status in desktop file.
+This variable becomes buffer local when set.
-(defcustom 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 can use the
-following variables:
+If the value is a function, it called by `desktop-save' with argument
+DESKTOP-DIRNAME to obtain auxiliary information to saved in the desktop
+file along with the state of the buffer for which it was called.
+
+When file names are returned, they should be formatted using the call
+\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
+
+Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
+to restore the buffer, the auxiliary information is passed as the argument
+DESKTOP-BUFFER-MISC.")
+(make-variable-buffer-local 'desktop-save-buffer)
+(make-obsolete-variable 'desktop-buffer-modes-to-save
+ 'desktop-save-buffer)
+(make-obsolete-variable 'desktop-buffer-misc-functions
+ 'desktop-save-buffer)
+
+(defcustom desktop-buffer-mode-handlers
+ '((dired-mode . dired-restore-desktop-buffer)
+ (rmail-mode . rmail-restore-desktop-buffer)
+ (mh-folder-mode . mh-restore-desktop-buffer)
+ (Info-mode . Info-restore-desktop-buffer))
+ "Alist of major mode specific functions to restore a desktop buffer.
+Functions are called by `desktop-read'. List elements must have the form
+\(MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
+
+Buffers with a major mode not specified here, are restored by the default
+handler `desktop-restore-file-buffer'.
+
+Handlers are called with argument list
+
+ (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
+
+Furthermore, they may use the following variables:
desktop-file-version
- desktop-buffer-file-name
- desktop-buffer-name
desktop-buffer-major-mode
desktop-buffer-minor-modes
desktop-buffer-point
desktop-buffer-mark
desktop-buffer-read-only
- desktop-buffer-misc
desktop-buffer-locals
-If one function returns non-nil, no further functions are called.
-If the function returns a buffer, then the saved mode settings
+If a handler returns a buffer, then the saved mode settings
and variable values for that buffer are copied into it."
- :type '(repeat function)
+ :type 'alist
:group 'desktop)
-(put 'desktop-buffer-handlers 'risky-local-variable t)
+(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
+(make-obsolete-variable 'desktop-buffer-handlers
+ 'desktop-buffer-mode-handlers)
(defcustom desktop-minor-mode-table
'((auto-fill-function auto-fill-mode)
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
+and the name of the minor mode function are different have to be added to
this table."
:type 'sexp
:group 'desktop)
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
- "The directory in which the current desktop file resides.")
+ "The directory in which the desktop file should be saved.")
(defconst desktop-header
";; --------------------------------------------------------------------------
"Hooks run after all buffers are loaded; intended for internal use.")
;; ----------------------------------------------------------------------------
-(defun desktop-truncate (l n)
+(defun desktop-truncate (list n)
"Truncate LIST to at most N elements destructively."
- (let ((here (nthcdr (1- n) l)))
+ (let ((here (nthcdr (1- n) list)))
(if (consp here)
(setcdr here nil))))
;; ----------------------------------------------------------------------------
(defun desktop-clear ()
"Empty the Desktop.
-This kills all buffers except for internal ones and those listed
-in `desktop-clear-preserve-buffers'. Furthermore, it clears the
+This kills all buffers except for internal ones and those matching
+`desktop-clear-preserve-buffers-regexp' or listed in
+`desktop-clear-preserve-buffers'. Furthermore, it clears the
variables listed in `desktop-globals-to-clear'."
(interactive)
+ (desktop-lazy-abort)
(dolist (var desktop-globals-to-clear)
(if (symbolp var)
(eval `(setq-default ,var nil))
(add-hook 'kill-emacs-hook 'desktop-kill)
(defun desktop-kill ()
- "If `desktop-enable' is non-nil, do what `desktop-save' says to do.
+ "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
(when
(and
- desktop-enable
- (let ((exists (file-exists-p (concat desktop-dirname desktop-base-file-name))))
+ desktop-save-mode
+ (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))))
(or
- (eq desktop-save 't)
+ (eq desktop-save t)
(and exists (memq desktop-save '(ask-if-new if-exists)))
(and
(or
(y-or-n-p "Save desktop? ")))))
(unless desktop-dirname
(setq desktop-dirname
- (expand-file-name
- (call-interactively
- (lambda (dir) (interactive "DDirectory for desktop file: ") dir)))))
+ (file-name-as-directory
+ (expand-file-name
+ (call-interactively
+ (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
(condition-case err
(desktop-save desktop-dirname)
(file-error
value)))
;; ----------------------------------------------------------------------------
-(defun desktop-internal-v2s (val)
+(defun desktop-internal-v2s (value)
"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) (null val) (eq t val))
- (cons 'may (prin1-to-string val)))
- ((stringp val)
- (let ((copy (copy-sequence val)))
+ ((or (numberp value) (null value) (eq t value))
+ (cons 'may (prin1-to-string value)))
+ ((stringp value)
+ (let ((copy (copy-sequence value)))
(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)
+ ((symbolp value)
+ (cons 'must (prin1-to-string value)))
+ ((vectorp value)
(let* ((special nil)
(pass1 (mapcar
(lambda (el)
(if (null (car res))
(setq special t))
res))
- val)))
+ value)))
(if special
(cons nil (concat "(vector "
(mapconcat (lambda (el)
" ")
")"))
(cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
- ((consp val)
- (let ((p val)
+ ((consp value)
+ (let ((p value)
newlist
use-list*
anynil)
")"))
(cons 'must
(concat "(" (mapconcat 'cdr newlist " ") ")")))))
- ((subrp val)
+ ((subrp value)
(cons nil (concat "(symbol-function '"
- (substring (prin1-to-string val) 7 -1)
+ (substring (prin1-to-string value) 7 -1)
")")))
- ((markerp val)
- (let ((pos (prin1-to-string (marker-position val)))
- (buf (prin1-to-string (buffer-name (marker-buffer val)))))
+ ((markerp value)
+ (let ((pos (prin1-to-string (marker-position value)))
+ (buf (prin1-to-string (buffer-name (marker-buffer value)))))
(cons nil (concat "(let ((mk (make-marker)))"
" (add-hook 'desktop-delay-hook"
" (list 'lambda '() (list 'set-marker mk "
(cons 'may "\"Unprintable entity\""))))
;; ----------------------------------------------------------------------------
-(defun desktop-value-to-string (val)
+(defun desktop-value-to-string (value)
"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))
+ (quote.txt (desktop-internal-v2s value))
(quote (car quote.txt))
(txt (cdr quote.txt)))
(if (eq quote 'must)
;; ----------------------------------------------------------------------------
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
- "Return t if the desktop should record a particular buffer for next startup.
+ "Return t if buffer should have its state saved in the desktop file.
FILENAME is the visited file name, BUFNAME is the buffer name, and
MODE is the major mode."
(let ((case-fold-search nil))
(and (not (string-match desktop-buffers-not-to-save bufname))
- (not (memq mode desktop-modes-not-to-save))
- (or (and filename
- (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 desktop-buffer-modes-to-save))))))
+ (not (memq mode desktop-modes-not-to-save))
+ (or (and filename
+ (not (string-match desktop-files-not-to-save filename)))
+ (and (eq mode 'dired-mode)
+ (with-current-buffer bufname
+ (not (string-match desktop-files-not-to-save
+ default-directory))))
+ (and (null filename)
+ (with-current-buffer bufname desktop-save-buffer))))))
;; ----------------------------------------------------------------------------
(defun desktop-file-name (filename dirname)
;; ----------------------------------------------------------------------------
(defun desktop-save (dirname)
- "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
+ "Save the desktop in a desktop file.
+Parameter DIRNAME specifies where to save the desktop file.
+See also `desktop-base-file-name'."
(interactive "DDirectory to save desktop file in: ")
(run-hooks 'desktop-save-hook)
(setq dirname (file-name-as-directory (expand-file-name dirname)))
(save-excursion
- (let ((filename (concat dirname desktop-base-file-name))
+ (let ((filename (expand-file-name desktop-base-file-name dirname))
(info
(mapcar
- (function
- (lambda (b)
+ #'(lambda (b)
(set-buffer b)
(list
(desktop-file-name (buffer-file-name) dirname)
major-mode
;; minor modes
(let (ret)
- (mapcar
- #'(lambda (mim)
+ (mapc
+ #'(lambda (minor-mode)
(and
- (boundp mim)
- (symbol-value mim)
- (setq ret
- (cons
- (let ((special (assq mim desktop-minor-mode-table)))
- (if special (cadr special) mim))
- ret))))
+ (boundp minor-mode)
+ (symbol-value minor-mode)
+ (let ((special (assq minor-mode desktop-minor-mode-table)))
+ (when (or special (functionp minor-mode))
+ (setq ret
+ (cons
+ (if special (cadr special) minor-mode)
+ ret))))))
(mapcar #'car minor-mode-alist))
ret)
(point)
(list (mark t) mark-active)
buffer-read-only
- (run-hook-with-args-until-success 'desktop-buffer-misc-functions)
+ ;; Auxiliary information
+ (when (functionp desktop-save-buffer)
+ (funcall desktop-save-buffer dirname))
(let ((locals desktop-locals-to-save)
(loclist (buffer-local-variables))
(ll))
(when (member (car locals) loclist)
(setq ll (cons (car locals) ll)))))
(setq locals (cdr locals)))
- ll))))
+ ll)))
(buffer-list)))
+ (eager desktop-restore-eager)
(buf (get-buffer-create "*desktop*")))
(set-buffer buf)
(erase-buffer)
(insert
- ";; -*- coding: emacs-mule; -*-\n"
+ ";; -*- mode: emacs-lisp; coding: emacs-mule; -*-\n"
desktop-header
";; Created " (current-time-string) "\n"
";; Desktop file format version " desktop-file-version "\n"
";; Emacs version " emacs-version "\n\n"
";; Global section:\n")
- (mapcar (function desktop-outvar) desktop-globals-to-save)
+ (mapc (function desktop-outvar) desktop-globals-to-save)
(if (memq 'kill-ring desktop-globals-to-save)
(insert
"(setq kill-ring-yank-pointer (nthcdr "
" kill-ring))\n"))
(insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
- (mapcar
- (function
- (lambda (l)
- (if (apply 'desktop-save-buffer-p l)
- (progn
- (insert "(desktop-create-buffer " desktop-file-version)
- (mapcar
- (function
- (lambda (e)
- (insert "\n " (desktop-value-to-string e))))
- l)
- (insert ")\n\n")))))
- info)
+ (mapc #'(lambda (l)
+ (when (apply 'desktop-save-buffer-p l)
+ (insert "("
+ (if (or (not (integerp eager))
+ (unless (zerop eager)
+ (setq eager (1- eager))
+ t))
+ "desktop-create-buffer"
+ "desktop-append-buffer-args")
+ " "
+ desktop-file-version)
+ (mapc #'(lambda (e)
+ (insert "\n " (desktop-value-to-string e)))
+ l)
+ (insert ")\n\n")))
+ info)
(setq default-directory dirname)
(when (file-exists-p filename) (delete-file filename))
(let ((coding-system-for-write 'emacs-mule))
;; ----------------------------------------------------------------------------
(defun desktop-remove ()
- "Delete the Desktop file and inactivate the desktop system."
+ "Delete desktop file in `desktop-dirname'.
+This function also sets `desktop-dirname' to nil."
(interactive)
- (if desktop-dirname
- (let ((filename (concat desktop-dirname desktop-base-file-name)))
- (setq desktop-dirname nil)
- (if (file-exists-p filename)
- (delete-file filename)))))
+ (when desktop-dirname
+ (let ((filename (expand-file-name desktop-base-file-name desktop-dirname)))
+ (setq desktop-dirname nil)
+ (when (file-exists-p filename)
+ (delete-file filename)))))
+
+(defvar desktop-buffer-args-list nil
+ "List of args for `desktop-create-buffer'.")
+
+(defvar desktop-lazy-timer nil)
;; ----------------------------------------------------------------------------
;;;###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.
-Look for the desktop file according to the variables `desktop-base-file-name'
-and `desktop-path'. If no desktop file is found, clear the desktop.
-Returns t if it has read a desktop file, nil otherwise."
+(defun desktop-read (&optional dirname)
+ "Read and process the desktop file in directory DIRNAME.
+Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in
+directories listed in `desktop-path'. If a desktop file is found, it
+is processed and `desktop-after-read-hook' is run. If no desktop file
+is found, clear the desktop and run `desktop-no-desktop-file-hook'.
+This function is a no-op when Emacs is running in batch mode.
+It returns t if a desktop file was loaded, nil otherwise."
(interactive)
(unless noninteractive
- (let ((dirs desktop-path))
- (while
- (and
- dirs
- (not
- (file-exists-p (expand-file-name desktop-base-file-name (car dirs)))))
- (setq dirs (cdr dirs)))
- (setq desktop-dirname (and dirs (expand-file-name (car dirs))))
- (if desktop-dirname
- (let ((desktop-first-buffer nil))
- ;; Evaluate desktop buffer.
- (load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
- ;; `desktop-create-buffer' puts buffers at end of the buffer list.
- ;; We want buffers existing prior to evaluating the desktop (and not reused)
- ;; to be placed at the end of the buffer list, so we move them here.
- (mapcar 'bury-buffer
- (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
- (switch-to-buffer (car (buffer-list)))
- (run-hooks 'desktop-delay-hook)
- (setq desktop-delay-hook nil)
- (run-hooks 'desktop-after-read-hook)
- (message "Desktop loaded.")
- t)
- (desktop-clear)
- (run-hooks 'desktop-no-desktop-file-hook)
- (message "No desktop file.")
- nil))))
+ (setq desktop-dirname
+ (file-name-as-directory
+ (expand-file-name
+ (or
+ ;; If DIRNAME is specified, use it.
+ (and (< 0 (length dirname)) dirname)
+ ;; Otherwise search desktop file in desktop-path.
+ (let ((dirs desktop-path))
+ (while
+ (and
+ dirs
+ (not
+ (file-exists-p (expand-file-name desktop-base-file-name (car dirs)))))
+ (setq dirs (cdr dirs)))
+ (and dirs (car dirs)))
+ ;; If not found and `desktop-path' is non-nil, use its first element.
+ (and desktop-path (car desktop-path))
+ ;; Default: Home directory.
+ "~"))))
+ (if (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))
+ ;; Desktop file found, process it.
+ (let ((desktop-first-buffer nil)
+ (desktop-buffer-ok-count 0)
+ (desktop-buffer-fail-count 0))
+ (setq desktop-lazy-timer nil)
+ ;; Evaluate desktop buffer.
+ (load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
+ ;; `desktop-create-buffer' puts buffers at end of the buffer list.
+ ;; We want buffers existing prior to evaluating the desktop (and not reused)
+ ;; to be placed at the end of the buffer list, so we move them here.
+ (mapc 'bury-buffer
+ (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
+ (switch-to-buffer (car (buffer-list)))
+ (run-hooks 'desktop-delay-hook)
+ (setq desktop-delay-hook nil)
+ (run-hooks 'desktop-after-read-hook)
+ (message "Desktop: %d buffer%s restored%s%s."
+ desktop-buffer-ok-count
+ (if (= 1 desktop-buffer-ok-count) "" "s")
+ (if (< 0 desktop-buffer-fail-count)
+ (format ", %d failed to restore" desktop-buffer-fail-count)
+ "")
+ (if desktop-buffer-args-list
+ (format ", %d to restore lazily"
+ (length desktop-buffer-args-list))
+ ""))
+ t)
+ ;; No desktop file found.
+ (desktop-clear)
+ (let ((default-directory desktop-dirname))
+ (run-hooks 'desktop-no-desktop-file-hook))
+ (message "No desktop file.")
+ nil)))
;; ----------------------------------------------------------------------------
+;; Maintained for backward compatibility
;;;###autoload
(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."
+Also inhibit further loading of it."
(if (not inhibit-default-init) ; safety check
(progn
(load "default" t t)
(setq inhibit-default-init t))))
+(make-obsolete 'desktop-load-default 'desktop-save-mode)
;; ----------------------------------------------------------------------------
;;;###autoload
-(defun desktop-change-dir (dir)
- "Save and clear the desktop, then load the desktop from directory DIR.
-However, if `desktop-enable' was nil at call, don't save the old desktop.
-This function always sets `desktop-enable' to t."
- (interactive "DNew directory: ")
+(defun desktop-change-dir (dirname)
+ "Change to desktop saved in DIRNAME.
+Kill the desktop as specified by variables `desktop-save-mode' and
+`desktop-save', then clear the desktop and load the desktop file in
+directory DIRNAME."
+ (interactive "DChange to directory: ")
+ (setq dirname (file-name-as-directory (expand-file-name dirname desktop-dirname)))
(desktop-kill)
(desktop-clear)
- (cd dir)
- (setq desktop-enable t)
- (let ((desktop-path '(".")))
- (desktop-read)
- ;; Set `desktop-dirname' even in no desktop file was found
- (setq desktop-dirname (expand-file-name dir))))
+ (desktop-read dirname))
;; ----------------------------------------------------------------------------
;;;###autoload
-(defun desktop-save-in-load-dir ()
- "Save desktop in directory from which it was loaded."
+(defun desktop-save-in-desktop-dir ()
+ "Save the desktop in directory `desktop-dirname'."
(interactive)
(if desktop-dirname
(desktop-save desktop-dirname)
(defun desktop-revert ()
"Revert to the last loaded desktop."
(interactive)
- (unless desktop-dirname (error "No desktop has been loaded"))
- (setq desktop-enable nil)
- (desktop-change-dir desktop-dirname))
-
-;; ----------------------------------------------------------------------------
-;; Note: the following functions use the dynamic variable binding in Lisp.
-;;
-
-(eval-when-compile ; Just to silence the byte compiler
- (defvar desktop-file-version)
- (defvar desktop-buffer-file-name)
- (defvar desktop-buffer-name)
- (defvar desktop-buffer-major-mode)
- (defvar desktop-buffer-minor-modes)
- (defvar desktop-buffer-point)
- (defvar desktop-buffer-mark)
- (defvar desktop-buffer-read-only)
- (defvar desktop-buffer-misc)
- (defvar desktop-buffer-locals)
-)
-
-(defun desktop-buffer-info-misc-data ()
- (if (eq major-mode 'Info-mode)
- (list Info-current-file
- Info-current-node)))
-
-;; ----------------------------------------------------------------------------
-(defun desktop-buffer-dired-misc-data ()
- (when (eq major-mode 'dired-mode)
- (eval-when-compile (defvar dirname))
- (cons
- ;; dired directory in portable form
- (file-name-as-directory (desktop-file-name dired-directory dirname))
- (cdr (nreverse (mapcar (function car) dired-subdir-alist))))))
-
-;; ----------------------------------------------------------------------------
-(defun desktop-buffer-info () "Load an info file."
- (if (eq 'Info-mode desktop-buffer-major-mode)
- (progn
- (let ((first (nth 0 desktop-buffer-misc))
- (second (nth 1 desktop-buffer-misc)))
- (when (and first second)
- (require 'info)
- (Info-find-node first second)
- (current-buffer))))))
-
-;; ----------------------------------------------------------------------------
-(eval-when-compile (defvar rmail-buffer)) ; Just to silence the byte compiler.
-(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)
- (if (eq major-mode 'rmail-mode)
- (current-buffer)
- rmail-buffer))
- (file-locked
- (kill-buffer (current-buffer))
- 'ignored))))
-
-;; ----------------------------------------------------------------------------
-(defun desktop-buffer-mh () "Load a folder in the mh system."
- (if (eq 'mh-folder-mode desktop-buffer-major-mode)
- (progn
- (mh-find-path)
- (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-maybe-insert-subdir (cdr desktop-buffer-misc))
- (current-buffer))
- (message "Directory %s no longer exists." (car desktop-buffer-misc))
- (sit-for 1)
- 'ignored)))
+ (unless desktop-dirname
+ (error "Unknown desktop directory"))
+ (unless (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))
+ (error "No desktop file found"))
+ (desktop-clear)
+ (desktop-read desktop-dirname))
;; ----------------------------------------------------------------------------
-(defun desktop-buffer-file ()
- "Load a file."
+(defun desktop-restore-file-buffer (desktop-buffer-file-name
+ desktop-buffer-name
+ desktop-buffer-misc)
+ "Restore a file buffer."
+ (eval-when-compile ; Just to silence the byte compiler
+ (defvar desktop-buffer-major-mode)
+ (defvar desktop-buffer-locals))
(if desktop-buffer-file-name
(if (or (file-exists-p desktop-buffer-file-name)
- (and desktop-missing-file-warning
- (y-or-n-p (format
- "File \"%s\" no longer exists. Re-create? "
- desktop-buffer-file-name))))
- (let ((buf (find-file-noselect desktop-buffer-file-name)))
+ (let ((msg (format "Desktop: File \"%s\" no longer exists."
+ desktop-buffer-file-name)))
+ (if desktop-missing-file-warning
+ (y-or-n-p (concat msg " Re-create? "))
+ (message msg)
+ nil)))
+ (let* ((auto-insert nil) ; Disable auto insertion
+ (coding-system-for-read
+ (or coding-system-for-read
+ (cdr (assq 'buffer-file-coding-system
+ desktop-buffer-locals))))
+ (buf (find-file-noselect desktop-buffer-file-name)))
(condition-case nil
(switch-to-buffer buf)
(error (pop-to-buffer buf)))
(functionp desktop-buffer-major-mode)
(funcall desktop-buffer-major-mode))
buf)
- 'ignored)))
+ nil)))
;; ----------------------------------------------------------------------------
-;; Create a buffer, load its file, set is mode, ...; called from Desktop file
-;; only.
+;; Create a buffer, load its file, set its mode, ...;
+;; called from Desktop file only.
(eval-when-compile ; Just to silence the byte compiler
(defvar desktop-first-buffer) ;; Dynamically bound in `desktop-read'
)
-(defun desktop-create-buffer (
- desktop-file-version
- desktop-buffer-file-name
- desktop-buffer-name
- desktop-buffer-major-mode
- desktop-buffer-minor-modes
- desktop-buffer-point
- desktop-buffer-mark
- desktop-buffer-read-only
- desktop-buffer-misc
- &optional
- desktop-buffer-locals)
+(defun desktop-create-buffer
+ (desktop-file-version
+ desktop-buffer-file-name
+ desktop-buffer-name
+ desktop-buffer-major-mode
+ desktop-buffer-minor-modes
+ desktop-buffer-point
+ desktop-buffer-mark
+ desktop-buffer-read-only
+ desktop-buffer-misc
+ &optional
+ desktop-buffer-locals)
+ ;; Just to silence the byte compiler. Bound locally in `desktop-read'.
+ (eval-when-compile
+ (defvar desktop-buffer-ok-count)
+ (defvar desktop-buffer-fail-count))
;; To make desktop files with relative file names possible, we cannot
;; allow `default-directory' to change. Therefore we save current buffer.
(save-current-buffer
- (let (
- (buffer-list (buffer-list))
- (hlist desktop-buffer-handlers)
- (result)
- (handler)
- )
- ;; Call desktop-buffer-handlers to create buffer.
- (while (and (not result) hlist)
- (setq handler (car hlist))
- (setq result (funcall handler))
- (setq hlist (cdr hlist)))
- (unless (bufferp result) (setq result nil))
+ (let ((buffer-list (buffer-list))
+ (result
+ (condition-case err
+ (funcall (or (cdr (assq desktop-buffer-major-mode
+ desktop-buffer-mode-handlers))
+ 'desktop-restore-file-buffer)
+ desktop-buffer-file-name
+ desktop-buffer-name
+ desktop-buffer-misc)
+ (error
+ (message "Desktop: Can't load buffer %s: %s"
+ desktop-buffer-name
+ (error-message-string err))
+ (when desktop-missing-file-warning (sit-for 1))
+ nil))))
+ (if (bufferp result)
+ (setq desktop-buffer-ok-count (1+ desktop-buffer-ok-count))
+ (setq desktop-buffer-fail-count (1+ desktop-buffer-fail-count))
+ (setq result nil))
;; Restore buffer list order with new buffer at end. Don't change
;; the order for old desktop files (old desktop module behaviour).
(unless (< desktop-file-version 206)
- (mapcar 'bury-buffer buffer-list)
+ (mapc 'bury-buffer buffer-list)
(when result (bury-buffer result)))
(when result
(unless (or desktop-first-buffer (< desktop-file-version 206))
(unless (equal (buffer-name) desktop-buffer-name)
(rename-buffer desktop-buffer-name))
;; minor modes
- (cond (
- ;; backwards compatible
- (equal '(t) desktop-buffer-minor-modes)
- (auto-fill-mode 1))(
- (equal '(nil) desktop-buffer-minor-modes)
- (auto-fill-mode 0))(
- t
- (mapcar
- #'(lambda (minor-mode)
- (when (functionp minor-mode) (funcall minor-mode 1)))
- desktop-buffer-minor-modes)))
+ (cond ((equal '(t) desktop-buffer-minor-modes) ; backwards compatible
+ (auto-fill-mode 1))
+ ((equal '(nil) desktop-buffer-minor-modes) ; backwards compatible
+ (auto-fill-mode 0))
+ (t
+ (mapc #'(lambda (minor-mode)
+ (when (functionp minor-mode) (funcall minor-mode 1)))
+ desktop-buffer-minor-modes)))
;; Even though point and mark are non-nil when written by `desktop-save'
- ;; they may be modified by mandlers wanting to set point or mark themselves.
- (when desktop-buffer-point (goto-char desktop-buffer-point))
+ ;; they may be modified by handlers wanting to set point or mark themselves.
+ (when desktop-buffer-point
+ (goto-char
+ (condition-case err
+ ;; Evaluate point. Thus point can be something like '(search-forward ...
+ (eval desktop-buffer-point)
+ (error (message "%s" (error-message-string err)) 1))))
(when desktop-buffer-mark
(if (consp desktop-buffer-mark)
(progn
(cons 'case-replace cr)
(cons 'overwrite-mode (car mim)))))
+(defun desktop-append-buffer-args (&rest args)
+ "Append ARGS at end of `desktop-buffer-args-list'
+ARGS must be an argument list for `desktop-create-buffer'."
+ (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args)))
+ (unless desktop-lazy-timer
+ (setq desktop-lazy-timer
+ (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers))))
+
+(defun desktop-lazy-create-buffer ()
+ "Pop args from `desktop-buffer-args-list', create buffer and bury it."
+ (when desktop-buffer-args-list
+ (let* ((remaining (length desktop-buffer-args-list))
+ (args (pop desktop-buffer-args-list))
+ (buffer-name (nth 2 args))
+ (msg (format "Desktop lazily opening %s (%s remaining)..."
+ buffer-name remaining)))
+ (when desktop-lazy-verbose
+ (message msg))
+ (let ((desktop-first-buffer nil)
+ (desktop-buffer-ok-count 0)
+ (desktop-buffer-fail-count 0))
+ (apply 'desktop-create-buffer args)
+ (run-hooks 'desktop-delay-hook)
+ (setq desktop-delay-hook nil)
+ (bury-buffer (get-buffer buffer-name))
+ (when desktop-lazy-verbose
+ (message "%s%s" msg (if (> desktop-buffer-ok-count 0) "done" "failed")))))))
+
+(defun desktop-idle-create-buffers ()
+ "Create buffers until the user does something, then stop.
+If there are no buffers left to create, kill the timer."
+ (let ((repeat 1))
+ (while (and repeat desktop-buffer-args-list)
+ (save-window-excursion
+ (desktop-lazy-create-buffer))
+ (setq repeat (sit-for 0.2))
+ (unless desktop-buffer-args-list
+ (cancel-timer desktop-lazy-timer)
+ (setq desktop-lazy-timer nil)
+ (message "Lazy desktop load complete")
+ (sit-for 3)
+ (message "")))))
+
+(defun desktop-lazy-complete ()
+ "Run the desktop load to completion."
+ (interactive)
+ (let ((desktop-lazy-verbose t))
+ (while desktop-buffer-args-list
+ (save-window-excursion
+ (desktop-lazy-create-buffer)))
+ (message "Lazy desktop load complete")))
+
+(defun desktop-lazy-abort ()
+ "Abort lazy loading of the desktop."
+ (interactive)
+ (when desktop-lazy-timer
+ (cancel-timer desktop-lazy-timer)
+ (setq desktop-lazy-timer nil))
+ (when desktop-buffer-args-list
+ (setq desktop-buffer-args-list nil)
+ (when (interactive-p)
+ (message "Lazy desktop load aborted"))))
+
;; ----------------------------------------------------------------------------
-;; When `desktop-enable' is non-nil and "--no-desktop" is not specified on the
+;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
;; command line, we do the rest of what it takes to use desktop, but do it
;; after finishing loading the init file.
;; We cannot use `command-switch-alist' to process "--no-desktop" because these
(let ((key "--no-desktop"))
(if (member key command-line-args)
(delete key command-line-args)
- (when desktop-enable
- (desktop-load-default)
- (desktop-read))))))
+ (when desktop-save-mode (desktop-read))))))
(provide 'desktop)
+;;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9
;;; desktop.el ends here
HCoop / bpt / emacs.git / blobdiff