1 ;;; desktop.el --- save partial status of Emacs when killed
3 ;; Copyright (C) 1993, 1994, 1995, 1997, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: Morten Welinder <terra@diku.dk>
7 ;; Maintainter: Lars Hansen <larsh@math.ku.dk>
8 ;; Keywords: convenience
9 ;; Favourite-brand-of-beer: None, I hate beer.
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; Save the Desktop, i.e.,
31 ;; - some global variables
32 ;; - the list of buffers with associated files. For each buffer also
34 ;; - the default directory
36 ;; - the mark & mark-active
38 ;; - some local variables
40 ;; To use this, add these lines to the bottom of your .emacs file:
43 ;; (setq desktop-enable t)
45 ;; Between the first two lines you may wish to add something that updates the
46 ;; variables `desktop-globals-to-save' and/or `desktop-locals-to-save'. If
47 ;; for instance you want to save the local variable `foobar' for every buffer
48 ;; in which it is local, you could add the line
50 ;; (add-to-list 'desktop-locals-to-save 'foobar)
52 ;; To avoid saving excessive amounts of data you may also wish to add
53 ;; something like the following
55 ;; (add-hook 'kill-emacs-hook
57 ;; (desktop-truncate search-ring 3)
58 ;; (desktop-truncate regexp-search-ring 3)))
60 ;; which will make sure that no more than three search items are saved. You
61 ;; must place this line *after* the `(desktop-load-default)' line. See also
62 ;; the variable `desktop-save-hook'.
64 ;; Start Emacs in the root directory of your "project". The desktop saver
65 ;; is inactive by default. You activate it by M-x desktop-save RET. When
66 ;; you exit the next time the above data will be saved. This ensures that
67 ;; all the files you were editing will be reloaded the next time you start
68 ;; Emacs from the same directory and that points will be set where you
69 ;; left them. If you save a desktop file in your home directory it will
70 ;; act as a default desktop when you start Emacs from a directory that
71 ;; doesn't have its own. I never do this, but you may want to.
73 ;; Some words on minor modes: Most minor modes are controlled by
74 ;; buffer-local variables, which have a standard save / restore
75 ;; mechanism. To handle all minor modes, we take the following
76 ;; approach: (1) check whether the variable name from
77 ;; `minor-mode-alist' is also a function; and (2) use translation
78 ;; table `desktop-minor-mode-table' in the case where the two names
81 ;; By the way: don't use desktop.el to customize Emacs -- the file .emacs
82 ;; in your home directory is used for that. Saving global default values
83 ;; for buffers is an example of misuse.
85 ;; PLEASE NOTE: The kill ring can be saved as specified by the variable
86 ;; `desktop-globals-to-save' (by default it isn't). This may result in saving
87 ;; things you did not mean to keep. Use M-x desktop-clear RET.
89 ;; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas.
90 ;; avk@rtsg.mot.com (Andrew V. Klein) for a dired tip.
91 ;; chris@tecc.co.uk (Chris Boucher) for a mark tip.
92 ;; f89-kam@nada.kth.se (Klas Mellbourn) for a mh-e tip.
93 ;; kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
94 ;; treese@lcs.mit.edu (Win Treese) for ange-ftp tips.
95 ;; pot@cnuce.cnr.it (Francesco Potorti`) for misc. tips.
96 ;; ---------------------------------------------------------------------------
99 ;; Save window configuration.
100 ;; Recognize more minor modes.
105 ;; Make the compilation more silent
107 ;; We use functions from these modules
108 ;; We can't (require 'mh-e) since that wants to load something.
109 (mapcar 'require
'(info dired reporter
)))
111 (defvar desktop-file-version
"206"
112 "Verion number of desktop file format.
113 Written into the desktop file and used at desktop read to provide
114 backward compatibility.")
116 ;; ----------------------------------------------------------------------------
117 ;; USER OPTIONS -- settings you might want to play with.
118 ;; ----------------------------------------------------------------------------
120 (defgroup desktop nil
121 "Save status of Emacs when you exit."
124 (defcustom desktop-enable nil
125 "*Non-nil enable Desktop to save the state of Emacs when you exit."
129 :initialize
'custom-initialize-default
132 (defcustom desktop-save
'ask-if-new
133 "*When the user changes desktop or quits emacs, should the desktop be saved?
134 \(in the current desktop directory)
137 ask-if-new -- ask if no desktop file exists, otherwise just save.
138 ask-if-exists -- ask if desktop file exists, otherwise don't save.
139 if-exists -- save if desktop file exists, otherwise don't save.
141 The desktop is never saved when `desktop-enable' is nil."
143 (const :tag
"Always save" t
)
144 (const :tag
"Always ask" ask
)
145 (const :tag
"Ask if desktop file is new, else do save" ask-if-new
)
146 (const :tag
"Ask if desktop file exists, else don't save" ask-if-exists
)
147 (const :tag
"Save if desktop file exists, else don't" if-exists
)
148 (const :tag
"Never save" nil
))
151 (defcustom desktop-base-file-name
152 (convert-standard-filename ".emacs.desktop")
153 "File for Emacs desktop, not including the directory name."
156 (defvaralias 'desktop-basefilename
'desktop-base-file-name
)
158 (defcustom desktop-path
'("." "~")
159 "List of directories to search for the desktop file.
160 The base name of the file is specified in `desktop-base-file-name'."
161 :type
'(repeat directory
)
164 (defcustom desktop-missing-file-warning nil
165 "*If non-nil then desktop warns when a file no longer exists.
166 Otherwise it simply ignores that file."
170 (defcustom desktop-no-desktop-file-hook nil
171 "Normal hook run after fail of `desktop-read' due to missing desktop file.
172 May e.g. be used to show a dired buffer."
176 (defcustom desktop-after-read-hook nil
177 "Normal hook run after a sucessful `desktop-read'.
178 May e.g. be used to show a buffer list."
182 (defcustom desktop-save-hook nil
183 "Hook run before desktop saves the state of Emacs.
184 This is useful for truncating history lists, for example."
188 (defcustom desktop-globals-to-save
'(
189 desktop-missing-file-warning
195 "List of global variables to save when killing Emacs.
196 An element may be variable name (a symbol)
197 or a cons cell of the form (VAR . MAX-SIZE),
198 which means to truncate VAR's value to at most MAX-SIZE elements
199 \(if the value is a list) before saving the value.
200 Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
201 :type
'(repeat (restricted-sexp :match-alternatives
(symbolp consp
)))
204 (defcustom desktop-globals-to-clear
'(
206 kill-ring-yank-pointer
208 search-ring-yank-pointer
210 regexp-search-ring-yank-pointer
)
211 "List of global variables set to clear by `desktop-clear'.
212 An element may be variable name (a symbol) or a cons cell of the form
213 \(VAR . FORM). Symbols are set to nil and for cons cells VAR is set
214 to the value obtained by evaluateing FORM."
215 :type
'(repeat (restricted-sexp :match-alternatives
(symbolp consp
)))
218 (defcustom desktop-clear-preserve-buffers-regexp
220 "Regexp identifying buffers that `desktop-clear' should not delete."
224 ;; Maintained for backward compatibility
225 (defcustom desktop-clear-preserve-buffers
226 '("*scratch*" "*Messages*")
227 "*List of buffer names that `desktop-clear' should not delete."
228 :type
'(repeat string
)
231 (defvar desktop-locals-to-save
'(
232 desktop-locals-to-save
; Itself! Think it over.
238 change-log-default-name
240 "List of local variables to save for each buffer.
241 The variables are saved only when they really are local.")
242 (make-variable-buffer-local 'desktop-locals-to-save
)
244 ;; We skip .log files because they are normally temporary.
245 ;; (ftp) files because they require passwords and whatnot.
246 ;; TAGS files to save time (tags-file-name is saved instead).
247 (defcustom desktop-buffers-not-to-save
248 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
249 "Regexp identifying buffers that are to be excluded from saving."
253 ;; Skip ange-ftp files
254 (defcustom desktop-files-not-to-save
256 "Regexp identifying files whose buffers are to be excluded from saving."
260 (defcustom desktop-buffer-modes-to-save
261 '(Info-mode rmail-mode
)
262 "If a buffer is of one of these major modes, save the buffer name.
263 It is up to the functions in `desktop-buffer-handlers' to decide
264 whether the buffer should be recreated or not, and how."
265 :type
'(repeat symbol
)
268 (defcustom desktop-modes-not-to-save nil
269 "List of major modes whose buffers should not be saved."
270 :type
'(repeat symbol
)
273 (defcustom desktop-file-name-format
'absolute
274 "*Format in which desktop file names should be saved.
276 absolute -- Absolute file name.
277 tilde -- Relative to ~.
278 local -- Relative to directory of desktop file."
279 :type
'(choice (const absolute
) (const tilde
) (const local
))
282 (defcustom desktop-buffer-misc-functions
283 '(desktop-buffer-info-misc-data
284 desktop-buffer-dired-misc-data
)
285 "*Functions used to determine auxiliary information for a buffer.
286 These functions are called in order, with no arguments. If a function
287 returns non-nil, its value is saved along with the desktop buffer for
288 which it was called; no further functions will be called.
290 File names should formatted using the call
291 \"(desktop-file-name FILE-NAME dirname)\".
293 Later, when desktop.el restores the buffers it has saved, each of the
294 `desktop-buffer-handlers' functions will have access to a buffer local
295 variable, named `desktop-buffer-misc', whose value is what the
296 \"misc\" function returned previously."
297 :type
'(repeat function
)
300 (defcustom desktop-buffer-handlers
301 '(desktop-buffer-dired
306 "*List of functions to call in order to create a buffer.
307 The functions are called without explicit parameters but can use the
311 desktop-buffer-file-name
313 desktop-buffer-major-mode
314 desktop-buffer-minor-modes
317 desktop-buffer-read-only
319 desktop-buffer-locals
321 If one function returns non-nil, no further functions are called.
322 If the function returns a buffer, then the saved mode settings
323 and variable values for that buffer are copied into it."
324 :type
'(repeat function
)
327 (put 'desktop-buffer-handlers
'risky-local-variable t
)
329 (defcustom desktop-minor-mode-table
330 '((auto-fill-function auto-fill-mode
)
332 "Table mapping minor mode variables to minor mode functions.
333 Each entry has the form (NAME RESTORE-FUNCTION).
334 NAME is the name of the buffer-local variable indicating that the minor
335 mode is active. RESTORE-FUNCTION is the function to activate the minor mode.
336 called. RESTORE-FUNCTION nil means don't try to restore the minor mode.
337 Only minor modes for which the name of the buffer-local variable
338 and the name of the minor mode function are different have to added to
343 ;; ----------------------------------------------------------------------------
344 (defvar desktop-dirname nil
345 "The directory in which the current desktop file resides.")
347 (defconst desktop-header
348 ";; --------------------------------------------------------------------------
349 ;; Desktop File for Emacs
350 ;; --------------------------------------------------------------------------
351 " "*Header to place in Desktop file.")
353 (defvar desktop-delay-hook nil
354 "Hooks run after all buffers are loaded; intended for internal use.")
356 ;; ----------------------------------------------------------------------------
357 (defun desktop-truncate (l n
)
358 "Truncate LIST to at most N elements destructively."
359 (let ((here (nthcdr (1- n
) l
)))
363 ;; ----------------------------------------------------------------------------
364 (defun desktop-clear ()
366 This kills all buffers except for internal ones and those listed
367 in `desktop-clear-preserve-buffers'. Furthermore, it clears the
368 variables listed in `desktop-globals-to-clear'."
370 (dolist (var desktop-globals-to-clear
)
372 (eval `(setq-default ,var nil
))
373 (eval `(setq-default ,(car var
) ,(cdr var
)))))
374 (let ((buffers (buffer-list)))
376 (let ((bufname (buffer-name (car buffers
))))
379 (string-match desktop-clear-preserve-buffers-regexp bufname
)
380 (member bufname desktop-clear-preserve-buffers
)
381 ;; Don't kill buffers made for internal purposes.
382 (and (not (equal bufname
"")) (eq (aref bufname
0) ?\
))
383 (kill-buffer (car buffers
))))
384 (setq buffers
(cdr buffers
))))
385 (delete-other-windows))
387 ;; ----------------------------------------------------------------------------
388 (add-hook 'kill-emacs-hook
'desktop-kill
)
390 (defun desktop-kill ()
391 "If `desktop-enable' is non-nil, do what `desktop-save' says to do.
392 If the desktop should be saved and `desktop-dirname'
393 is nil, ask the user where to save the desktop."
397 (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname
))))
400 (and exists
(memq desktop-save
'(ask-if-new if-exists
)))
403 (memq desktop-save
'(ask ask-if-new
))
404 (and exists
(eq desktop-save
'ask-if-exists
)))
405 (y-or-n-p "Save desktop? ")))))
406 (unless desktop-dirname
407 (setq desktop-dirname
408 (file-name-as-directory
411 (lambda (dir) (interactive "DDirectory for desktop file: ") dir
))))))
413 (desktop-save desktop-dirname
)
415 (unless (yes-or-no-p "Error while saving the desktop. Ignore? ")
416 (signal (car err
) (cdr err
)))))))
418 ;; ----------------------------------------------------------------------------
419 (defun desktop-list* (&rest args
)
420 (if (null (cdr args
))
422 (setq args
(nreverse args
))
423 (let ((value (cons (nth 1 args
) (car args
))))
424 (setq args
(cdr (cdr args
)))
426 (setq value
(cons (car args
) value
))
427 (setq args
(cdr args
)))
430 ;; ----------------------------------------------------------------------------
431 (defun desktop-internal-v2s (val)
432 "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
433 TXT is a string that when read and evaluated yields value.
434 QUOTE may be `may' (value may be quoted),
435 `must' (values must be quoted), or nil (value may not be quoted)."
437 ((or (numberp val
) (null val
) (eq t val
))
438 (cons 'may
(prin1-to-string val
)))
440 (let ((copy (copy-sequence val
)))
441 (set-text-properties 0 (length copy
) nil copy
)
442 ;; Get rid of text properties because we cannot read them
443 (cons 'may
(prin1-to-string copy
))))
445 (cons 'must
(prin1-to-string val
)))
450 (let ((res (desktop-internal-v2s el
)))
456 (cons nil
(concat "(vector "
457 (mapconcat (lambda (el)
458 (if (eq (car el
) 'must
)
459 (concat "'" (cdr el
))
464 (cons 'may
(concat "[" (mapconcat 'cdr pass1
" ") "]")))))
471 (let ((q.txt
(desktop-internal-v2s (car p
))))
472 (or anynil
(setq anynil
(null (car q.txt
))))
473 (setq newlist
(cons q.txt newlist
)))
476 (let ((last (desktop-internal-v2s p
))
478 (or anynil
(setq anynil
(null (car last
))))
480 (setq newlist
(cons '(must .
".") newlist
)))
482 (setq newlist
(cons last newlist
))))
483 (setq newlist
(nreverse newlist
))
486 (concat (if use-list
* "(desktop-list* " "(list ")
487 (mapconcat (lambda (el)
488 (if (eq (car el
) 'must
)
489 (concat "'" (cdr el
))
495 (concat "(" (mapconcat 'cdr newlist
" ") ")")))))
497 (cons nil
(concat "(symbol-function '"
498 (substring (prin1-to-string val
) 7 -
1)
501 (let ((pos (prin1-to-string (marker-position val
)))
502 (buf (prin1-to-string (buffer-name (marker-buffer val
)))))
503 (cons nil
(concat "(let ((mk (make-marker)))"
504 " (add-hook 'desktop-delay-hook"
505 " (list 'lambda '() (list 'set-marker mk "
506 pos
" (get-buffer " buf
")))) mk)"))))
508 (cons 'may
"\"Unprintable entity\""))))
510 ;; ----------------------------------------------------------------------------
511 (defun desktop-value-to-string (val)
512 "Convert VALUE to a string that when read evaluates to the same value.
513 Not all types of values are supported."
514 (let* ((print-escape-newlines t
)
515 (float-output-format nil
)
516 (quote.txt
(desktop-internal-v2s val
))
517 (quote (car quote.txt
))
518 (txt (cdr quote.txt
)))
523 ;; ----------------------------------------------------------------------------
524 (defun desktop-outvar (varspec)
525 "Output a setq statement for variable VAR to the desktop file.
526 The argument VARSPEC may be the variable name VAR (a symbol),
527 or a cons cell of the form (VAR . MAX-SIZE),
528 which means to truncate VAR's value to at most MAX-SIZE elements
529 \(if the value is a list) before saving the value."
532 (setq var
(car varspec
) size
(cdr varspec
))
536 (if (and (integerp size
)
539 (desktop-truncate (eval var
) size
))
543 (desktop-value-to-string (symbol-value var
))
546 ;; ----------------------------------------------------------------------------
547 (defun desktop-save-buffer-p (filename bufname mode
&rest dummy
)
548 "Return t if the desktop should record a particular buffer for next startup.
549 FILENAME is the visited file name, BUFNAME is the buffer name, and
550 MODE is the major mode."
551 (let ((case-fold-search nil
))
552 (and (not (string-match desktop-buffers-not-to-save bufname
))
553 (not (memq mode desktop-modes-not-to-save
))
555 (not (string-match desktop-files-not-to-save filename
)))
556 (and (eq mode
'dired-mode
)
558 (set-buffer (get-buffer bufname
))
559 (not (string-match desktop-files-not-to-save
560 default-directory
))))
562 (memq mode desktop-buffer-modes-to-save
))))))
564 ;; ----------------------------------------------------------------------------
565 (defun desktop-file-name (filename dirname
)
566 "Convert FILENAME to format specified in `desktop-file-name-format'.
567 DIRNAME must be the directory in which the desktop file will be saved."
570 ((eq desktop-file-name-format
'tilde
)
571 (let ((relative-name (file-relative-name (expand-file-name filename
) "~")))
573 ((file-name-absolute-p relative-name
) relative-name
)
574 ((string= "./" relative-name
) "~/")
575 ((string= "." relative-name
) "~")
576 (t (concat "~/" relative-name
)))))
577 ((eq desktop-file-name-format
'local
) (file-relative-name filename dirname
))
578 (t (expand-file-name filename
))))
580 ;; ----------------------------------------------------------------------------
581 (defun desktop-save (dirname)
582 "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
583 (interactive "DDirectory to save desktop file in: ")
584 (run-hooks 'desktop-save-hook
)
585 (setq dirname
(file-name-as-directory (expand-file-name dirname
)))
587 (let ((filename (expand-file-name desktop-base-file-name dirname
))
594 (desktop-file-name (buffer-file-name) dirname
)
606 (let ((special (assq mim desktop-minor-mode-table
)))
607 (if special
(cadr special
) mim
))
609 (mapcar #'car minor-mode-alist
))
612 (list (mark t
) mark-active
)
614 (run-hook-with-args-until-success 'desktop-buffer-misc-functions
)
615 (let ((locals desktop-locals-to-save
)
616 (loclist (buffer-local-variables))
619 (let ((here (assq (car locals
) loclist
)))
621 (setq ll
(cons here ll
))
622 (when (member (car locals
) loclist
)
623 (setq ll
(cons (car locals
) ll
)))))
624 (setq locals
(cdr locals
)))
627 (buf (get-buffer-create "*desktop*")))
632 ";; -*- coding: emacs-mule; -*-\n"
634 ";; Created " (current-time-string) "\n"
635 ";; Desktop file format version " desktop-file-version
"\n"
636 ";; Emacs version " emacs-version
"\n\n"
637 ";; Global section:\n")
638 (mapcar (function desktop-outvar
) desktop-globals-to-save
)
639 (if (memq 'kill-ring desktop-globals-to-save
)
641 "(setq kill-ring-yank-pointer (nthcdr "
642 (int-to-string (- (length kill-ring
) (length kill-ring-yank-pointer
)))
645 (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
649 (if (apply 'desktop-save-buffer-p l
)
651 (insert "(desktop-create-buffer " desktop-file-version
)
655 (insert "\n " (desktop-value-to-string e
))))
659 (setq default-directory dirname
)
660 (when (file-exists-p filename
) (delete-file filename
))
661 (let ((coding-system-for-write 'emacs-mule
))
662 (write-region (point-min) (point-max) filename nil
'nomessage
))))
663 (setq desktop-dirname dirname
))
665 ;; ----------------------------------------------------------------------------
666 (defun desktop-remove ()
667 "Delete the Desktop file and inactivate the desktop system."
670 (let ((filename (expand-file-name desktop-base-file-name desktop-dirname
)))
671 (setq desktop-dirname nil
)
672 (if (file-exists-p filename
)
673 (delete-file filename
)))))
674 ;; ----------------------------------------------------------------------------
676 (defun desktop-read ()
677 "Read the Desktop file and the files it specifies.
678 This is a no-op when Emacs is running in batch mode.
679 Look for the desktop file according to the variables `desktop-base-file-name'
680 and `desktop-path'. If no desktop file is found, clear the desktop.
681 Returns t if it has read a desktop file, nil otherwise."
683 (unless noninteractive
684 (let ((dirs desktop-path
))
689 (file-exists-p (expand-file-name desktop-base-file-name
(car dirs
)))))
690 (setq dirs
(cdr dirs
)))
691 (setq desktop-dirname
(and dirs
(file-name-as-directory (expand-file-name (car dirs
)))))
693 (let ((desktop-first-buffer nil
))
694 ;; Evaluate desktop buffer.
695 (load (expand-file-name desktop-base-file-name desktop-dirname
) t t t
)
696 ;; `desktop-create-buffer' puts buffers at end of the buffer list.
697 ;; We want buffers existing prior to evaluating the desktop (and not reused)
698 ;; to be placed at the end of the buffer list, so we move them here.
700 (nreverse (cdr (memq desktop-first-buffer
(nreverse (buffer-list))))))
701 (switch-to-buffer (car (buffer-list)))
702 (run-hooks 'desktop-delay-hook
)
703 (setq desktop-delay-hook nil
)
704 (run-hooks 'desktop-after-read-hook
)
705 (message "Desktop loaded.")
708 (run-hooks 'desktop-no-desktop-file-hook
)
709 (message "No desktop file.")
712 ;; ----------------------------------------------------------------------------
714 (defun desktop-load-default ()
715 "Load the `default' start-up library manually.
716 Also inhibit further loading of it. Call this from your `.emacs' file
717 to provide correct modes for autoloaded files."
718 (if (not inhibit-default-init
) ; safety check
721 (setq inhibit-default-init t
))))
723 ;; ----------------------------------------------------------------------------
725 (defun desktop-change-dir (dir)
726 "Save and clear the desktop, then load the desktop from directory DIR.
727 However, if `desktop-enable' was nil at call, don't save the old desktop.
728 This function always sets `desktop-enable' to t."
729 (interactive "DNew directory: ")
730 (setq dir
(file-name-as-directory (expand-file-name dir desktop-dirname
)))
733 (setq desktop-enable t
)
734 (let ((desktop-path (list dir
))
735 (default-directory dir
))
737 ;; Set `desktop-dirname' even in no desktop file was found
738 (setq desktop-dirname dir
))
739 ;; ----------------------------------------------------------------------------
741 (defun desktop-save-in-load-dir ()
742 "Save desktop in directory from which it was loaded."
745 (desktop-save desktop-dirname
)
746 (call-interactively 'desktop-save
))
747 (message "Desktop saved in %s" desktop-dirname
))
749 ;; ----------------------------------------------------------------------------
751 (defun desktop-revert ()
752 "Revert to the last loaded desktop."
754 (unless desktop-dirname
(error "No desktop has been loaded"))
755 (setq desktop-enable nil
)
756 (desktop-change-dir desktop-dirname
))
758 ;; ----------------------------------------------------------------------------
759 ;; Note: the following functions use the dynamic variable binding in Lisp.
762 (eval-when-compile ; Just to silence the byte compiler
763 (defvar desktop-file-version
)
764 (defvar desktop-buffer-file-name
)
765 (defvar desktop-buffer-name
)
766 (defvar desktop-buffer-major-mode
)
767 (defvar desktop-buffer-minor-modes
)
768 (defvar desktop-buffer-point
)
769 (defvar desktop-buffer-mark
)
770 (defvar desktop-buffer-read-only
)
771 (defvar desktop-buffer-misc
)
772 (defvar desktop-buffer-locals
)
775 (defun desktop-buffer-info-misc-data ()
776 (if (eq major-mode
'Info-mode
)
777 (list Info-current-file
780 ;; ----------------------------------------------------------------------------
781 (defun desktop-buffer-dired-misc-data ()
782 (when (eq major-mode
'dired-mode
)
783 (eval-when-compile (defvar dirname
))
785 ;; Value of `dired-directory'.
786 (if (consp dired-directory
)
787 ;; Directory name followed by list of files.
788 (cons (desktop-file-name (car dired-directory
) dirname
) (cdr dired-directory
))
789 ;; Directory name, optionally with with shell wildcard.
790 (desktop-file-name dired-directory dirname
))
791 ;; Subdirectories in `dired-subdir-alist'.
795 (function (lambda (f) (desktop-file-name (car f
) dirname
)))
796 dired-subdir-alist
))))))
798 ;; ----------------------------------------------------------------------------
799 (defun desktop-buffer-info () "Load an info file."
800 (if (eq 'Info-mode desktop-buffer-major-mode
)
802 (let ((first (nth 0 desktop-buffer-misc
))
803 (second (nth 1 desktop-buffer-misc
)))
804 (when (and first second
)
807 (Info-find-node first second
))
808 (current-buffer))))))
810 ;; ----------------------------------------------------------------------------
811 (eval-when-compile (defvar rmail-buffer
)) ; Just to silence the byte compiler.
812 (defun desktop-buffer-rmail () "Load an RMAIL file."
813 (if (eq 'rmail-mode desktop-buffer-major-mode
)
814 (condition-case error
815 (progn (rmail-input desktop-buffer-file-name
)
816 (if (eq major-mode
'rmail-mode
)
820 (kill-buffer (current-buffer))
823 ;; ----------------------------------------------------------------------------
824 (defun desktop-buffer-mh () "Load a folder in the mh system."
825 (if (eq 'mh-folder-mode desktop-buffer-major-mode
)
828 (mh-visit-folder desktop-buffer-name
)
831 ;; ----------------------------------------------------------------------------
832 (defun desktop-buffer-dired () "Load a directory using dired."
833 (if (eq 'dired-mode desktop-buffer-major-mode
)
834 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
835 ;; This value is a directory name, optionally with with shell wildcard or
836 ;; a directory name followed by list of files.
837 (let* ((dired-directory (car desktop-buffer-misc
))
838 (dir (if (consp dired-directory
) (car dired-directory
) dired-directory
)))
839 (if (file-directory-p (file-name-directory dir
))
841 (dired dired-directory
)
842 (mapcar 'dired-maybe-insert-subdir
(cdr desktop-buffer-misc
))
844 (message "Directory %s no longer exists." dir
)
848 ;; ----------------------------------------------------------------------------
849 (defun desktop-buffer-file ()
851 (if desktop-buffer-file-name
852 (if (or (file-exists-p desktop-buffer-file-name
)
853 (and desktop-missing-file-warning
855 "File \"%s\" no longer exists. Re-create? "
856 desktop-buffer-file-name
))))
857 (let ((buf (find-file-noselect desktop-buffer-file-name
)))
859 (switch-to-buffer buf
)
860 (error (pop-to-buffer buf
)))
861 (and (not (eq major-mode desktop-buffer-major-mode
))
862 (functionp desktop-buffer-major-mode
)
863 (funcall desktop-buffer-major-mode
))
867 ;; ----------------------------------------------------------------------------
868 ;; Create a buffer, load its file, set is mode, ...; called from Desktop file
871 (eval-when-compile ; Just to silence the byte compiler
872 (defvar desktop-first-buffer
) ;; Dynamically bound in `desktop-read'
875 (defun desktop-create-buffer (
877 desktop-buffer-file-name
879 desktop-buffer-major-mode
880 desktop-buffer-minor-modes
883 desktop-buffer-read-only
886 desktop-buffer-locals
)
887 ;; To make desktop files with relative file names possible, we cannot
888 ;; allow `default-directory' to change. Therefore we save current buffer.
891 (buffer-list (buffer-list))
892 (hlist desktop-buffer-handlers
)
896 ;; Call desktop-buffer-handlers to create buffer.
897 (while (and (not result
) hlist
)
898 (setq handler
(car hlist
))
899 (setq result
(funcall handler
))
900 (setq hlist
(cdr hlist
)))
901 (unless (bufferp result
) (setq result nil
))
902 ;; Restore buffer list order with new buffer at end. Don't change
903 ;; the order for old desktop files (old desktop module behaviour).
904 (unless (< desktop-file-version
206)
905 (mapcar 'bury-buffer buffer-list
)
906 (when result
(bury-buffer result
)))
908 (unless (or desktop-first-buffer
(< desktop-file-version
206))
909 (setq desktop-first-buffer result
))
911 (unless (equal (buffer-name) desktop-buffer-name
)
912 (rename-buffer desktop-buffer-name
))
915 ;; backwards compatible
916 (equal '(t) desktop-buffer-minor-modes
)
918 (equal '(nil) desktop-buffer-minor-modes
)
922 #'(lambda (minor-mode)
923 (when (functionp minor-mode
) (funcall minor-mode
1)))
924 desktop-buffer-minor-modes
)))
925 ;; Even though point and mark are non-nil when written by `desktop-save'
926 ;; they may be modified by handlers wanting to set point or mark themselves.
927 (when desktop-buffer-point
(goto-char desktop-buffer-point
))
928 (when desktop-buffer-mark
929 (if (consp desktop-buffer-mark
)
931 (set-mark (car desktop-buffer-mark
))
932 (setq mark-active
(car (cdr desktop-buffer-mark
))))
933 (set-mark desktop-buffer-mark
)))
934 ;; Never override file system if the file really is read-only marked.
935 (if desktop-buffer-read-only
(setq buffer-read-only desktop-buffer-read-only
))
936 (while desktop-buffer-locals
937 (let ((this (car desktop-buffer-locals
)))
939 ;; an entry of this form `(symbol . value)'
941 (make-local-variable (car this
))
942 (set (car this
) (cdr this
)))
943 ;; an entry of the form `symbol'
944 (make-local-variable this
)
946 (setq desktop-buffer-locals
(cdr desktop-buffer-locals
)))))))
948 ;; ----------------------------------------------------------------------------
949 ;; Backward compatibility -- update parameters to 205 standards.
950 (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
951 desktop-buffer-major-mode
952 mim pt mk ro tl fc cfs cr desktop-buffer-misc
)
953 (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
954 desktop-buffer-major-mode
(cdr mim
) pt mk ro
956 (list (cons 'truncate-lines tl
)
957 (cons 'fill-column fc
)
958 (cons 'case-fold-search cfs
)
959 (cons 'case-replace cr
)
960 (cons 'overwrite-mode
(car mim
)))))
962 ;; ----------------------------------------------------------------------------
963 ;; When `desktop-enable' is non-nil and "--no-desktop" is not specified on the
964 ;; command line, we do the rest of what it takes to use desktop, but do it
965 ;; after finishing loading the init file.
966 ;; We cannot use `command-switch-alist' to process "--no-desktop" because these
967 ;; functions are processed after `after-init-hook'.
971 (let ((key "--no-desktop"))
972 (if (member key command-line-args
)
973 (delete key command-line-args
)
975 (desktop-load-default)
980 ;;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9
981 ;;; desktop.el ends here