Mercurial > emacs
diff lisp/desktop.el @ 88155:d7ddb3e565de
sync with trunk
| author | Henrik Enberg <henrik.enberg@telia.com> |
|---|---|
| date | Mon, 16 Jan 2006 00:03:54 +0000 |
| parents | 8c7919f99581 |
| children |
line wrap: on
line diff
--- a/lisp/desktop.el Sun Jan 15 23:02:10 2006 +0000 +++ b/lisp/desktop.el Mon Jan 16 00:03:54 2006 +0000 @@ -1,9 +1,10 @@ ;;; desktop.el --- save partial status of Emacs when killed -;; Copyright (C) 1993, 1994, 1995, 1997, 2000, 2001 -;; Free Software Foundation, Inc. +;; Copyright (C) 1993, 1994, 1995, 1997, 2000, 2001, 2002, 2003, +;; 2004, 2005 Free Software Foundation, Inc. ;; Author: Morten Welinder <terra@diku.dk> +;; Maintainter: Lars Hansen <larsh@soem.dk> ;; Keywords: convenience ;; Favourite-brand-of-beer: None, I hate beer. @@ -21,8 +22,8 @@ ;; 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. +;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: @@ -36,47 +37,80 @@ ;; - 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): -;; -;; (desktop-load-default) -;; (desktop-read) +;; To use this, use customize to turn on desktop-save-mode or add the +;; following line somewhere in your .emacs file: ;; -;; 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))) +;; (desktop-save-mode 1) ;; -;; 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'. +;; 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. + +;; Special handling. +;; ----------------- +;; Variables `desktop-buffer-mode-handlers' and `desktop-minor-mode-handlers' +;; are supplied to handle special major and minor modes respectively. +;; `desktop-buffer-mode-handlers' is an alist of major mode specific functions +;; to restore a desktop buffer. Elements must have the form +;; +;; (MAJOR-MODE . RESTORE-BUFFER-FUNCTION). +;; +;; Functions listed are called by `desktop-create-buffer' when `desktop-read' +;; evaluates the desktop file. Buffers with a major mode not specified here, +;; are restored by the default handler `desktop-restore-file-buffer'. +;; `desktop-minor-mode-handlers' is an alist of functions to restore +;; non-standard minor modes. Elements must have the form +;; +;; (MINOR-MODE . RESTORE-FUNCTION). +;; +;; Functions are called by `desktop-create-buffer' to restore minor modes. +;; Minor modes not specified here, are restored by the standard minor mode +;; function. If you write a module that defines a major or minor mode that +;; needs a special handler, then place code like -;; 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. +;; (defun foo-restore-desktop-buffer +;; ... +;; (add-to-list 'desktop-buffer-mode-handlers +;; '(foo-mode . foo-restore-desktop-buffer)) + +;; or + +;; (defun bar-desktop-restore +;; ... +;; (add-to-list 'desktop-minor-mode-handlers +;; '(bar-mode . bar-desktop-restore)) + +;; in the module itself, and make shure that the mode function is +;; autoloaded. See the docstrings of `desktop-buffer-mode-handlers' and +;; `desktop-minor-mode-handlers' for more info. -;; 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. +;; Minor modes. +;; ------------ +;; Conventional minor modes (see node "Minor Mode Conventions" in the elisp +;; manual) are handled in the following way: +;; When `desktop-save' saves the state of a buffer to the desktop file, it +;; saves as `desktop-minor-modes' the list of names of those variables in +;; `minor-mode-alist' that have a non-nil value. +;; When `desktop-create' restores the buffer, each of the symbols in +;; `desktop-minor-modes' is called as function with parameter 1. +;; The variables `desktop-minor-mode-table' and `desktop-minor-mode-handlers' +;; are used to handle non-conventional minor modes. `desktop-save' uses +;; `desktop-minor-mode-table' to map minor mode variables to minor mode +;; functions before writing `desktop-minor-modes'. If a minor mode has a +;; variable name that is different form its function name, an entry + +;; (NAME RESTORE-FUNCTION) + +;; should be added to `desktop-minor-mode-table'. If a minor mode should not +;; be restored, RESTORE-FUNCTION should be set to nil. `desktop-create' uses +;; `desktop-minor-mode-handlers' to lookup minor modes that needs a restore +;; function different from the usual minor mode function. +;; --------------------------------------------------------------------------- ;; 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 @@ -99,15 +133,14 @@ ;; Save window configuration. ;; Recognize more minor modes. ;; Save mark rings. -;; Start-up with buffer-menu??? ;;; 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" + "Version number of desktop file format. +Written into the desktop file and used at desktop read to provide +backward compatibility.") + ;; ---------------------------------------------------------------------------- ;; USER OPTIONS -- settings you might want to play with. ;; ---------------------------------------------------------------------------- @@ -116,164 +149,331 @@ "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") - -(defcustom desktop-basefilename - (convert-standard-filename ".emacs.desktop") - "File for Emacs desktop, not including the directory name." - :type 'file - :group 'desktop) - -(defcustom desktop-missing-file-warning nil - "*If non-nil then desktop warns when a file no longer exists. -Otherwise it simply ignores that file." - :type 'boolean +;;;###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) -(defvar desktop-globals-to-save - (list 'desktop-missing-file-warning - ;; Feature: saving kill-ring implies saving kill-ring-yank-pointer - ;; 'kill-ring - 'tags-file-name - 'tags-table-list - 'search-ring - 'regexp-search-ring - 'register-alist - ;; 'desktop-globals-to-save ; Itself! - ) - "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.") +;; Maintained for backward compatibility +(define-obsolete-variable-alias 'desktop-enable + 'desktop-save-mode "22.1") + +(defcustom desktop-save 'ask-if-new + "*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-save-mode' is nil. +The variables `desktop-dirname' 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 is new, else do save" ask-if-new) + (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 + :version "22.1") + +(defcustom desktop-base-file-name + (convert-standard-filename ".emacs.desktop") + "Name of file for Emacs desktop, excluding the directory part." + :type 'file + :group 'desktop) +(define-obsolete-variable-alias 'desktop-basefilename + 'desktop-base-file-name "22.1") + +(defcustom desktop-path '("." "~") + "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 + :version "22.1") + +(defcustom desktop-missing-file-warning nil + "*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 + :version "22.1") + +(defcustom desktop-no-desktop-file-hook nil + "Normal hook run when `desktop-read' can't find a desktop file. +May be used to show a dired buffer." + :type 'hook + :group 'desktop + :version "22.1") + +(defcustom desktop-after-read-hook nil + "Normal hook run after a successful `desktop-read'. +May be used to show a buffer list." + :type 'hook + :group 'desktop + :version "22.1") -(defvar desktop-locals-to-save - (list '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-save-hook nil + "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 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 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 evaluating FORM." + :type '(repeat (restricted-sexp :match-alternatives (symbolp consp))) + :group 'desktop + :version "22.1") + +(defcustom desktop-clear-preserve-buffers + '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*") + "*List of buffers that `desktop-clear' should not delete. +Each element is a regular expression. Buffers with a name matched by any of +these won't be deleted." + :type '(repeat string) + :group 'desktop) + +;;;###autoload +(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 + column-number-mode + size-indication-mode + buffer-file-coding-system + indent-tabs-mode + indicate-buffer-boundaries + indicate-empty-lines + show-trailing-whitespace) "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) +The variables are saved only when they really are local. Conventional minor +modes are restored automatically; they should not be listed here." + :type '(repeat symbol) + :group 'desktop) ;; We skip .log files because they are normally temporary. ;; (ftp) files because they require passwords and whatnot. -;; TAGS files to save time (tags-file-name is saved instead). (defcustom desktop-buffers-not-to-save - "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$" - "Regexp identifying buffers that are to be excluded from saving." - :type 'regexp - :group 'desktop) + "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\)$" + "Regexp identifying buffers that are to be excluded from saving." + :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 +;; We skip TAGS files to save time (tags-file-name is saved instead). +(defcustom desktop-modes-not-to-save + '(tags-table-mode) "List of major modes whose buffers should not be saved." :type '(repeat symbol) :group 'desktop) -(defcustom desktop-buffer-major-mode nil - "When desktop creates a buffer, this holds the desired Major mode." - :type 'symbol - :group 'desktop) +(defcustom desktop-file-name-format 'absolute + "*Format in which desktop file names should be saved. +Possible values are: + absolute -- Absolute file name. + tilde -- Relative to ~. + local -- Relative to directory of desktop file." + :type '(choice (const absolute) (const tilde) (const local)) + :group 'desktop + :version "22.1") -(defcustom desktop-buffer-file-name nil - "When desktop creates a buffer, this holds the file name to visit." - :type '(choice file (const nil)) - :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-buffer-name nil - "When desktop creates a buffer, this holds the desired buffer name." - :type '(choice string (const nil)) - :group 'desktop) +(defcustom desktop-lazy-verbose t + "Verbose reporting of lazily created buffers." + :type 'boolean + :group 'desktop + :version "22.1") -(defvar desktop-buffer-misc nil - "When desktop creates a buffer, this holds a list of misc info. -It is used by the `desktop-buffer-handlers' functions.") +(defcustom desktop-lazy-idle-delay 5 + "Idle delay before starting to create buffers. +See `desktop-restore-eager'." + :type 'integer + :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. +;;;###autoload +(defvar desktop-save-buffer nil + "When non-nil, save buffer status in desktop file. +This variable becomes buffer local when set. + +If the value is a function, it is called by `desktop-save' with argument +DESKTOP-DIRNAME to obtain auxiliary information to save 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.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) +Later, when `desktop-read' evaluates the desktop file, auxiliary information +is passed as the argument DESKTOP-BUFFER-MISC to functions in +`desktop-buffer-mode-handlers'.") +(make-variable-buffer-local 'desktop-save-buffer) +(make-obsolete-variable 'desktop-buffer-modes-to-save + 'desktop-save-buffer "22.1") +(make-obsolete-variable 'desktop-buffer-misc-functions + 'desktop-save-buffer "22.1") + +;;;###autoload +(defvar desktop-buffer-mode-handlers + nil + "Alist of major mode specific functions to restore a desktop buffer. +Functions listed are called by `desktop-create-buffer' when `desktop-read' +evaluates the desktop file. 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) -(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 -variables `desktop-buffer-major-mode', `desktop-buffer-file-name', -`desktop-buffer-name'. -If one function returns non-nil, no further functions are called. -If the function returns a buffer, then the saved mode settings -and variable values for that buffer are copied into it." - :type '(repeat function) - :group 'desktop) +Furthermore, they may use the following variables: + + desktop-file-version + desktop-buffer-major-mode + desktop-buffer-minor-modes + desktop-buffer-point + desktop-buffer-mark + desktop-buffer-read-only + desktop-buffer-locals + +If a handler returns a buffer, then the saved mode settings +and variable values for that buffer are copied into it. -(put 'desktop-buffer-handlers 'risky-local-variable t) - -(defvar desktop-create-buffer-form "(desktop-create-buffer 205" - "Opening of form for creation of new buffers.") +Modules that define a major mode that needs a special handler should contain +code like -(defcustom desktop-save-hook nil - "Hook run before desktop saves the state of Emacs. -This is useful for truncating history lists, for example." - :type 'hook - :group 'desktop) + (defun foo-restore-desktop-buffer + ... + (add-to-list 'desktop-buffer-mode-handlers + '(foo-mode . foo-restore-desktop-buffer)) + +Furthermore the major mode function must be autoloaded.") + +;;;###autoload +(put 'desktop-buffer-mode-handlers 'risky-local-variable t) +(make-obsolete-variable 'desktop-buffer-handlers + 'desktop-buffer-mode-handlers "22.1") (defcustom desktop-minor-mode-table '((auto-fill-function auto-fill-mode) - (vc-mode nil)) + (vc-mode nil) + (vc-dired-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." +and the name of the minor mode function are different have to be added to +this table. See also `desktop-minor-mode-handlers'." :type 'sexp :group 'desktop) +;;;###autoload +(defvar desktop-minor-mode-handlers + nil + "Alist of functions to restore non-standard minor modes. +Functions are called by `desktop-create-buffer' to restore minor modes. +List elements must have the form + + (MINOR-MODE . RESTORE-FUNCTION). + +Minor modes not specified here, are restored by the standard minor mode +function. + +Handlers are called with argument list + + (DESKTOP-BUFFER-LOCALS) + +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 + +When a handler is called, the buffer has been created and the major mode has +been set, but local variables listed in desktop-buffer-locals has not yet been +created and set. + +Modules that define a minor mode that needs a special handler should contain +code like + + (defun foo-desktop-restore + ... + (add-to-list 'desktop-minor-mode-handlers + '(foo-mode . foo-desktop-restore)) + +Furthermore the minor mode function must be autoloaded. + +See also `desktop-minor-mode-table'.") + +;;;###autoload +(put 'desktop-minor-mode-handlers 'risky-local-variable t) + ;; ---------------------------------------------------------------------------- (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 ";; -------------------------------------------------------------------------- @@ -285,50 +485,73 @@ "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)))) + ;; ---------------------------------------------------------------------------- -(defcustom desktop-clear-preserve-buffers - '("*scratch*" "*Messages*") - "*Buffer names that `desktop-clear' should not delete." - :type '(repeat string) - :group 'desktop) - (defun desktop-clear () "Empty the Desktop. -This kills all buffers except for internal ones -and those listed in `desktop-clear-preserve-buffers'." +This kills all buffers except for internal ones and those with names matched by +a regular expression in the list `desktop-clear-preserve-buffers'. +Furthermore, it clears the variables listed in `desktop-globals-to-clear'." (interactive) - (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) - (let ((buffers (buffer-list))) + (desktop-lazy-abort) + (dolist (var desktop-globals-to-clear) + (if (symbolp var) + (eval `(setq-default ,var nil)) + (eval `(setq-default ,(car var) ,(cdr var))))) + (let ((buffers (buffer-list)) + (preserve-regexp (concat "^\\(" + (mapconcat (lambda (regexp) + (concat "\\(" regexp "\\)")) + desktop-clear-preserve-buffers + "\\|") + "\\)$"))) (while buffers - (or (member (buffer-name (car buffers)) desktop-clear-preserve-buffers) - (null (buffer-name (car buffers))) - ;; Don't kill buffers made for internal purposes. - (and (not (equal (buffer-name (car buffers)) "")) - (eq (aref (buffer-name (car buffers)) 0) ?\ )) - (kill-buffer (car buffers))) + (let ((bufname (buffer-name (car buffers)))) + (or + (null bufname) + (string-match preserve-regexp bufname) + ;; Don't kill buffers made for internal purposes. + (and (not (equal bufname "")) (eq (aref bufname 0) ?\s)) + (kill-buffer (car buffers)))) (setq buffers (cdr buffers)))) (delete-other-windows)) + ;; ---------------------------------------------------------------------------- (add-hook 'kill-emacs-hook 'desktop-kill) (defun desktop-kill () - (if 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))))))) + "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-save-mode + (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname)))) + (or + (eq desktop-save t) + (and exists (memq desktop-save '(ask-if-new if-exists))) + (and + (or + (memq desktop-save '(ask ask-if-new)) + (and exists (eq desktop-save 'ask-if-exists))) + (y-or-n-p "Save desktop? "))))) + (unless desktop-dirname + (setq desktop-dirname + (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 + (unless (yes-or-no-p "Error while saving the desktop. Ignore? ") + (signal (car err) (cdr err))))))) + ;; ---------------------------------------------------------------------------- (defun desktop-list* (&rest args) (if (null (cdr args)) @@ -341,22 +564,23 @@ (setq args (cdr args))) 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) (keywordp 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) @@ -364,7 +588,7 @@ (if (null (car res)) (setq special t)) res)) - val))) + value))) (if special (cons nil (concat "(vector " (mapconcat (lambda (el) @@ -375,8 +599,8 @@ " ") ")")) (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]"))))) - ((consp val) - (let ((p val) + ((consp value) + (let ((p value) newlist use-list* anynil) @@ -406,13 +630,13 @@ ")")) (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 " @@ -420,17 +644,19 @@ (t ; save as text (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) (concat "'" txt) txt))) + ;; ---------------------------------------------------------------------------- (defun desktop-outvar (varspec) "Output a setq statement for variable VAR to the desktop file. @@ -453,285 +679,401 @@ " " (desktop-value-to-string (symbol-value var)) ")\n"))))) + ;; ---------------------------------------------------------------------------- (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)))))) + ;; ---------------------------------------------------------------------------- -(defcustom desktop-relative-file-names nil - "*Store relative file names in the desktop file." - :type 'boolean - :group 'desktop) +(defun desktop-file-name (filename dirname) + "Convert FILENAME to format specified in `desktop-file-name-format'. +DIRNAME must be the directory in which the desktop file will be saved." + (cond + ((not filename) nil) + ((eq desktop-file-name-format 'tilde) + (let ((relative-name (file-relative-name (expand-file-name filename) "~"))) + (cond + ((file-name-absolute-p relative-name) relative-name) + ((string= "./" relative-name) "~/") + ((string= "." relative-name) "~") + (t (concat "~/" relative-name))))) + ((eq desktop-file-name-format 'local) (file-relative-name filename dirname)) + (t (expand-file-name filename)))) +;; ---------------------------------------------------------------------------- (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 (expand-file-name desktop-basefilename dirname)) - (info (nreverse - (mapcar - (function - (lambda (b) - (set-buffer b) - (list - (let ((bn (buffer-file-name))) - (if bn - (if desktop-relative-file-names - (file-relative-name bn dirname) - bn))) - (buffer-name) - major-mode - ;; 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)))) + (let ((filename (expand-file-name desktop-base-file-name dirname)) + (info + (mapcar + #'(lambda (b) + (set-buffer b) + (list + (desktop-file-name (buffer-file-name) dirname) + (buffer-name) + major-mode + ;; minor modes + (let (ret) + (mapc + #'(lambda (minor-mode) + (and + (boundp minor-mode) + (symbol-value minor-mode) + (let* ((special (assq minor-mode desktop-minor-mode-table)) + (value (cond (special (cadr special)) + ((functionp minor-mode) minor-mode)))) + (when value (add-to-list 'ret value))))) (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) - (let ((locals desktop-locals-to-save) - (loclist (buffer-local-variables)) - (ll)) - (while locals - (let ((here (assq (car locals) loclist))) - (if here - (setq ll (cons here ll)) - (if (member (car locals) loclist) - (setq ll (cons (car locals) ll))))) - (setq locals (cdr locals))) - ll) - ))) - (buffer-list)))) - (buf (get-buffer-create "*desktop*"))) + ret) + (point) + (list (mark t) mark-active) + buffer-read-only + ;; Auxiliary information + (when (functionp desktop-save-buffer) + (funcall desktop-save-buffer dirname)) + (let ((locals desktop-locals-to-save) + (loclist (buffer-local-variables)) + (ll)) + (while locals + (let ((here (assq (car locals) loclist))) + (if here + (setq ll (cons here ll)) + (when (member (car locals) loclist) + (setq ll (cons (car locals) ll))))) + (setq locals (cdr locals))) + ll))) + (buffer-list))) + (eager desktop-restore-eager) + (buf (get-buffer-create "*desktop*"))) (set-buffer buf) (erase-buffer) - (insert ";; -*- coding: emacs-mule; -*-\n" - desktop-header - ";; Created " (current-time-string) "\n" - ";; Emacs version " emacs-version "\n\n" - ";; Global section:\n") - (mapcar (function desktop-outvar) desktop-globals-to-save) + (insert + ";; -*- 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") + (mapc (function desktop-outvar) desktop-globals-to-save) (if (memq 'kill-ring desktop-globals-to-save) - (insert "(setq kill-ring-yank-pointer (nthcdr " - (int-to-string - (- (length kill-ring) (length kill-ring-yank-pointer))) - " kill-ring))\n")) + (insert + "(setq kill-ring-yank-pointer (nthcdr " + (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer))) + " kill-ring))\n")) - (insert "\n;; Buffer section:\n") - (mapcar - (function (lambda (l) - (if (apply 'desktop-save-buffer-p l) - (progn - (insert desktop-create-buffer-form) - (mapcar - (function (lambda (e) - (insert "\n " - (desktop-value-to-string e)))) - l) - (insert ")\n\n"))))) - info) + (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n") + (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) - (if (file-exists-p filename) (delete-file filename)) (let ((coding-system-for-write 'emacs-mule)) - (write-region (point-min) (point-max) filename nil 'nomessage)))) + (write-region (point-min) (point-max) filename nil 'nomessage)))) (setq desktop-dirname dirname)) + ;; ---------------------------------------------------------------------------- (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-basefilename))) - (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." +(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) - (if noninteractive - nil - (let ((dirs '("./" "~/"))) - (while (and dirs - (not (file-exists-p (expand-file-name - desktop-basefilename - (car dirs))))) - (setq dirs (cdr dirs))) - (setq desktop-dirname (and dirs (expand-file-name (car dirs)))) - (if desktop-dirname - (let ((desktop-last-buffer nil)) - ;; `load-with-code-conversion' calls `eval-buffer' which - ;; contains a `save-excursion', so we end up with the same - ;; buffer before and after the load. This is a problem - ;; when the desktop is read initially when Emacs starts up - ;; because, if we still are in *scratch* after running - ;; `after-init-hook', the splash screen will be displayed. - (load (expand-file-name desktop-basefilename desktop-dirname) - t t t) - (when desktop-last-buffer - (switch-to-buffer desktop-last-buffer)) - (run-hooks 'desktop-delay-hook) - (setq desktop-delay-hook nil) - (message "Desktop loaded.")) - (desktop-clear))))) + (unless noninteractive + (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." - (if (not inhibit-default-init) ; safety check - (progn - (load "default" t t) - (setq inhibit-default-init t)))) +Also inhibit further loading of it." + (unless inhibit-default-init ; safety check + (load "default" t t) + (setq inhibit-default-init t))) +(make-obsolete 'desktop-load-default + 'desktop-save-mode "22.1") + ;; ---------------------------------------------------------------------------- -;; Note: the following functions use the dynamic variable binding in Lisp. -;; -(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 () - (if (eq major-mode 'dired-mode) - (cons - (expand-file-name dired-directory) - (cdr - (nreverse - (mapcar - (function car) - dired-subdir-alist)))))) +;;;###autoload +(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) + (desktop-read dirname)) -(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)))))) ;; ---------------------------------------------------------------------------- -(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)))) +;;;###autoload +(defun desktop-save-in-desktop-dir () + "Save the desktop in directory `desktop-dirname'." + (interactive) + (if desktop-dirname + (desktop-save desktop-dirname) + (call-interactively 'desktop-save)) + (message "Desktop saved in %s" desktop-dirname)) + ;; ---------------------------------------------------------------------------- -(defun desktop-buffer-mh () "Load a folder in the mh system." - (if (eq 'mh-folder-mode desktop-buffer-major-mode) - (progn - (require 'mh-e) - (mh-find-path) - (mh-visit-folder desktop-buffer-name) - (current-buffer)))) +;;;###autoload +(defun desktop-revert () + "Revert to the last loaded desktop." + (interactive) + (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-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))) -;; ---------------------------------------------------------------------------- -(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 "%s" 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))) + (and (not (eq major-mode desktop-buffer-major-mode)) + (functionp desktop-buffer-major-mode) + (funcall desktop-buffer-major-mode)) buf) - 'ignored))) + nil))) + +(defun desktop-load-file (function) + "Load the file where auto loaded FUNCTION is defined." + (when function + (let ((fcell (symbol-function function))) + (when (and (listp fcell) + (eq 'autoload (car fcell))) + (load (cadr fcell)))))) + ;; ---------------------------------------------------------------------------- -;; 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. -(defvar desktop-last-buffer nil - "Last buffer read. Dynamically bound in `desktop-read'.") +;; Just to silence the byte compiler. +(eval-when-compile + (defvar desktop-first-buffer)) ; Dynamically bound in `desktop-read' -(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) - (let ((hlist desktop-buffer-handlers) - (result) - (handler)) - (while (and (not result) hlist) - (setq handler (car hlist)) - (setq result (funcall handler)) - (setq hlist (cdr hlist))) - (when (bufferp result) - (setq desktop-last-buffer 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 (functionp 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 - (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)))))) +(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 + ;; Give major mode module a chance to add a handler. + (desktop-load-file desktop-buffer-major-mode) + (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) + (mapc 'bury-buffer buffer-list) + (when result (bury-buffer result))) + (when result + (unless (or desktop-first-buffer (< desktop-file-version 206)) + (setq desktop-first-buffer result)) + (set-buffer result) + (unless (equal (buffer-name) desktop-buffer-name) + (rename-buffer desktop-buffer-name)) + ;; 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) + ;; Give minor mode module a chance to add a handler. + (desktop-load-file minor-mode) + (let ((handler (cdr (assq minor-mode desktop-minor-mode-handlers)))) + (if handler + (funcall handler desktop-buffer-locals) + (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 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 + (set-mark (car desktop-buffer-mark)) + (setq mark-active (car (cdr desktop-buffer-mark)))) + (set-mark desktop-buffer-mark))) + ;; Never override file system if the file really is read-only marked. + (if desktop-buffer-read-only (setq buffer-read-only desktop-buffer-read-only)) + (while desktop-buffer-locals + (let ((this (car desktop-buffer-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 desktop-buffer-locals (cdr desktop-buffer-locals))))))) +;; ---------------------------------------------------------------------------- ;; Backward compatibility -- update parameters to 205 standards. (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name desktop-buffer-major-mode @@ -744,17 +1086,86 @@ (cons 'case-fold-search cfs) (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 "%s" 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"))))))) -;; If the user set desktop-enable to t with Custom, -;; do the rest of what it takes to use desktop, -;; but do it after finishing loading the init file. -(add-hook 'after-init-hook - '(lambda () - (when desktop-enable - (desktop-load-default) - (desktop-read)))) +(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-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 +;; functions are processed after `after-init-hook'. +(add-hook + 'after-init-hook + '(lambda () + (let ((key "--no-desktop")) + (when (member key command-line-args) + (setq command-line-args (delete key command-line-args)) + (setq desktop-save-mode nil))) + (when desktop-save-mode (desktop-read)))) (provide 'desktop) +;;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9 ;;; desktop.el ends here