Merge from trunk
[bpt/emacs.git] / lisp / desktop.el
CommitLineData
6343ed61
RS
1;;; desktop.el --- save partial status of Emacs when killed
2
95df8112 3;; Copyright (C) 1993-1995, 1997, 2000-2011 Free Software Foundation, Inc.
6343ed61
RS
4
5;; Author: Morten Welinder <terra@diku.dk>
3ea96cac 6;; Keywords: convenience
b6105c76 7;; Favourite-brand-of-beer: None, I hate beer.
6343ed61
RS
8
9;; This file is part of GNU Emacs.
10
eb3fa2cf 11;; GNU Emacs is free software: you can redistribute it and/or modify
6343ed61 12;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
13;; the Free Software Foundation, either version 3 of the License, or
14;; (at your option) any later version.
6343ed61
RS
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
eb3fa2cf 22;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
6343ed61
RS
23
24;;; Commentary:
25
0b9bd504
RS
26;; Save the Desktop, i.e.,
27;; - some global variables
28;; - the list of buffers with associated files. For each buffer also
29;; - the major mode
30;; - the default directory
31;; - the point
32;; - the mark & mark-active
33;; - buffer-read-only
ec4c6f22 34;; - some local variables
6343ed61 35
6b61353c
KH
36;; To use this, use customize to turn on desktop-save-mode or add the
37;; following line somewhere in your .emacs file:
0b9bd504 38;;
6b61353c 39;; (desktop-save-mode 1)
0b9bd504 40;;
6b61353c 41;; For further usage information, look at the section
20535d5b 42;; (info "(emacs)Saving Emacs Sessions") in the GNU Emacs Manual.
6b61353c
KH
43
44;; When the desktop module is loaded, the function `desktop-kill' is
341c2f07 45;; added to the `kill-emacs-hook'. This function is responsible for
6b61353c 46;; saving the desktop when Emacs is killed. Furthermore an anonymous
341c2f07 47;; function is added to the `after-init-hook'. This function is
6b61353c 48;; responsible for loading the desktop when Emacs is started.
ec4c6f22 49
0f4804e7
LH
50;; Special handling.
51;; -----------------
52;; Variables `desktop-buffer-mode-handlers' and `desktop-minor-mode-handlers'
53;; are supplied to handle special major and minor modes respectively.
54;; `desktop-buffer-mode-handlers' is an alist of major mode specific functions
341c2f07 55;; to restore a desktop buffer. Elements must have the form
be617bbf 56;;
0f4804e7 57;; (MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
be617bbf 58;;
0f4804e7 59;; Functions listed are called by `desktop-create-buffer' when `desktop-read'
341c2f07 60;; evaluates the desktop file. Buffers with a major mode not specified here,
0f4804e7
LH
61;; are restored by the default handler `desktop-restore-file-buffer'.
62;; `desktop-minor-mode-handlers' is an alist of functions to restore
63;; non-standard minor modes. Elements must have the form
be617bbf 64;;
0f4804e7 65;; (MINOR-MODE . RESTORE-FUNCTION).
be617bbf 66;;
0f4804e7
LH
67;; Functions are called by `desktop-create-buffer' to restore minor modes.
68;; Minor modes not specified here, are restored by the standard minor mode
69;; function. If you write a module that defines a major or minor mode that
70;; needs a special handler, then place code like
71
72;; (defun foo-restore-desktop-buffer
73;; ...
74;; (add-to-list 'desktop-buffer-mode-handlers
75;; '(foo-mode . foo-restore-desktop-buffer))
76
77;; or
78
79;; (defun bar-desktop-restore
80;; ...
81;; (add-to-list 'desktop-minor-mode-handlers
82;; '(bar-mode . bar-desktop-restore))
83
fb8a6326 84;; in the module itself, and make sure that the mode function is
341c2f07 85;; autoloaded. See the docstrings of `desktop-buffer-mode-handlers' and
0f4804e7
LH
86;; `desktop-minor-mode-handlers' for more info.
87
88;; Minor modes.
89;; ------------
90;; Conventional minor modes (see node "Minor Mode Conventions" in the elisp
91;; manual) are handled in the following way:
92;; When `desktop-save' saves the state of a buffer to the desktop file, it
93;; saves as `desktop-minor-modes' the list of names of those variables in
94;; `minor-mode-alist' that have a non-nil value.
95;; When `desktop-create' restores the buffer, each of the symbols in
96;; `desktop-minor-modes' is called as function with parameter 1.
97;; The variables `desktop-minor-mode-table' and `desktop-minor-mode-handlers'
98;; are used to handle non-conventional minor modes. `desktop-save' uses
99;; `desktop-minor-mode-table' to map minor mode variables to minor mode
341c2f07 100;; functions before writing `desktop-minor-modes'. If a minor mode has a
0f4804e7
LH
101;; variable name that is different form its function name, an entry
102
103;; (NAME RESTORE-FUNCTION)
104
105;; should be added to `desktop-minor-mode-table'. If a minor mode should not
106;; be restored, RESTORE-FUNCTION should be set to nil. `desktop-create' uses
107;; `desktop-minor-mode-handlers' to lookup minor modes that needs a restore
108;; function different from the usual minor mode function.
109;; ---------------------------------------------------------------------------
47640244 110
ec4c6f22
RS
111;; By the way: don't use desktop.el to customize Emacs -- the file .emacs
112;; in your home directory is used for that. Saving global default values
113;; for buffers is an example of misuse.
114
0b9bd504
RS
115;; PLEASE NOTE: The kill ring can be saved as specified by the variable
116;; `desktop-globals-to-save' (by default it isn't). This may result in saving
117;; things you did not mean to keep. Use M-x desktop-clear RET.
ec4c6f22 118
fa379636
KH
119;; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas.
120;; avk@rtsg.mot.com (Andrew V. Klein) for a dired tip.
121;; chris@tecc.co.uk (Chris Boucher) for a mark tip.
122;; f89-kam@nada.kth.se (Klas Mellbourn) for a mh-e tip.
123;; kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
f4c73d07 124;; treese@lcs.mit.edu (Win Treese) for ange-ftp tips.
253406b9 125;; pot@cnuce.cnr.it (Francesco Potorti`) for misc. tips.
0b9bd504
RS
126;; ---------------------------------------------------------------------------
127;; TODO:
128;;
129;; Save window configuration.
130;; Recognize more minor modes.
131;; Save mark rings.
6343ed61
RS
132
133;;; Code:
134
4a2fce7a 135(defvar desktop-file-version "206"
6b61353c 136 "Version number of desktop file format.
4a2fce7a
RS
137Written into the desktop file and used at desktop read to provide
138backward compatibility.")
139
ec4c6f22 140;; ----------------------------------------------------------------------------
0b9bd504
RS
141;; USER OPTIONS -- settings you might want to play with.
142;; ----------------------------------------------------------------------------
bbf5eb28
RS
143
144(defgroup desktop nil
145 "Save status of Emacs when you exit."
146 :group 'frames)
147
6b61353c
KH
148;;;###autoload
149(define-minor-mode desktop-save-mode
150 "Toggle desktop saving mode.
151With numeric ARG, turn desktop saving on if ARG is positive, off
11425834
LH
152otherwise. If desktop saving is turned on, the state of Emacs is
153saved from one session to another. See variable `desktop-save'
154and function `desktop-read' for details."
6b61353c
KH
155 :global t
156 :group 'desktop)
157
158;; Maintained for backward compatibility
b89c5a72
JB
159(define-obsolete-variable-alias 'desktop-enable
160 'desktop-save-mode "22.1")
813dbb2d 161
e88110db
JB
162(defun desktop-save-mode-off ()
163 "Disable `desktop-save-mode'. Provided for use in hooks."
164 (desktop-save-mode 0))
165
4a2fce7a 166(defcustom desktop-save 'ask-if-new
9201cc28 167 "Specifies whether the desktop should be saved when it is killed.
6b61353c
KH
168A desktop is killed when the user changes desktop or quits Emacs.
169Possible values are:
4a2fce7a
RS
170 t -- always save.
171 ask -- always ask.
172 ask-if-new -- ask if no desktop file exists, otherwise just save.
173 ask-if-exists -- ask if desktop file exists, otherwise don't save.
174 if-exists -- save if desktop file exists, otherwise don't save.
175 nil -- never save.
6b61353c 176The desktop is never saved when `desktop-save-mode' is nil.
cc8b76bf 177The variables `desktop-dirname' and `desktop-base-file-name'
6b61353c 178determine where the desktop is saved."
11425834
LH
179 :type
180 '(choice
4a2fce7a
RS
181 (const :tag "Always save" t)
182 (const :tag "Always ask" ask)
183 (const :tag "Ask if desktop file is new, else do save" ask-if-new)
184 (const :tag "Ask if desktop file exists, else don't save" ask-if-exists)
185 (const :tag "Save if desktop file exists, else don't" if-exists)
186 (const :tag "Never save" nil))
af61551b 187 :group 'desktop
bf247b6e 188 :version "22.1")
4a2fce7a 189
1f7efe1b
JB
190(defcustom desktop-load-locked-desktop 'ask
191 "Specifies whether the desktop should be loaded if locked.
192Possible values are:
193 t -- load anyway.
194 nil -- don't load.
195 ask -- ask the user.
196If the value is nil, or `ask' and the user chooses not to load the desktop,
197the normal hook `desktop-not-loaded-hook' is run."
198 :type
199 '(choice
200 (const :tag "Load anyway" t)
201 (const :tag "Don't load" nil)
202 (const :tag "Ask the user" ask))
203 :group 'desktop
8f3f313d 204 :version "22.2")
1f7efe1b 205
cd6ef82d
GM
206(define-obsolete-variable-alias 'desktop-basefilename
207 'desktop-base-file-name "22.1")
208
4a2fce7a 209(defcustom desktop-base-file-name
fc715501 210 (convert-standard-filename ".emacs.desktop")
6b61353c 211 "Name of file for Emacs desktop, excluding the directory part."
813dbb2d
RS
212 :type 'file
213 :group 'desktop)
6343ed61 214
e88110db
JB
215(defcustom desktop-base-lock-name
216 (convert-standard-filename ".emacs.desktop.lock")
217 "Name of lock file for Emacs desktop, excluding the directory part."
218 :type 'file
219 :group 'desktop
8f3f313d 220 :version "22.2")
e88110db 221
13dc2bc2 222(defcustom desktop-path (list "." user-emacs-directory "~")
4a2fce7a
RS
223 "List of directories to search for the desktop file.
224The base name of the file is specified in `desktop-base-file-name'."
225 :type '(repeat directory)
af61551b 226 :group 'desktop
a3b337cd 227 :version "23.2") ; user-emacs-directory added
4a2fce7a 228
bbf5eb28 229(defcustom desktop-missing-file-warning nil
6c27fdb9 230 "If non-nil, offer to recreate the buffer of a deleted file.
ebb39555
LH
231Also pause for a moment to display message about errors signaled in
232`desktop-buffer-mode-handlers'.
233
234If nil, just print error messages in the message buffer."
bbf5eb28 235 :type 'boolean
af61551b 236 :group 'desktop
bf247b6e 237 :version "22.1")
6343ed61 238
4a2fce7a 239(defcustom desktop-no-desktop-file-hook nil
6b61353c 240 "Normal hook run when `desktop-read' can't find a desktop file.
11425834 241Run in the directory in which the desktop file was sought.
8649a87b 242May be used to show a dired buffer."
4a2fce7a 243 :type 'hook
af61551b 244 :group 'desktop
bf247b6e 245 :version "22.1")
4a2fce7a 246
e88110db
JB
247(defcustom desktop-not-loaded-hook nil
248 "Normal hook run when the user declines to re-use a desktop file.
249Run in the directory in which the desktop file was found.
250May be used to deal with accidental multiple Emacs jobs."
251 :type 'hook
252 :group 'desktop
253 :options '(desktop-save-mode-off save-buffers-kill-emacs)
8f3f313d 254 :version "22.2")
e88110db 255
4a2fce7a 256(defcustom desktop-after-read-hook nil
6b61353c 257 "Normal hook run after a successful `desktop-read'.
8649a87b 258May be used to show a buffer list."
4a2fce7a 259 :type 'hook
af61551b 260 :group 'desktop
11425834 261 :options '(list-buffers)
bf247b6e 262 :version "22.1")
4a2fce7a
RS
263
264(defcustom desktop-save-hook nil
6b61353c 265 "Normal hook run before the desktop is saved in a desktop file.
11425834
LH
266Run with the desktop buffer current with only the header present.
267May be used to add to the desktop code or to truncate history lists,
268for example."
4a2fce7a
RS
269 :type 'hook
270 :group 'desktop)
271
340db502
LH
272(defcustom desktop-globals-to-save
273 '(desktop-missing-file-warning
274 tags-file-name
275 tags-table-list
276 search-ring
277 regexp-search-ring
c760f19e
CY
278 register-alist
279 file-name-history)
6b61353c
KH
280 "List of global variables saved by `desktop-save'.
281An element may be variable name (a symbol) or a cons cell of the form
282\(VAR . MAX-SIZE), which means to truncate VAR's value to at most
283MAX-SIZE elements (if the value is a list) before saving the value.
4a2fce7a
RS
284Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
285 :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
286 :group 'desktop)
287
340db502
LH
288(defcustom desktop-globals-to-clear
289 '(kill-ring
290 kill-ring-yank-pointer
291 search-ring
292 search-ring-yank-pointer
293 regexp-search-ring
294 regexp-search-ring-yank-pointer)
150f39ee 295 "List of global variables that `desktop-clear' will clear.
4a2fce7a 296An element may be variable name (a symbol) or a cons cell of the form
cc8b76bf
JB
297\(VAR . FORM). Symbols are set to nil and for cons cells VAR is set
298to the value obtained by evaluating FORM."
4a2fce7a 299 :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
af61551b 300 :group 'desktop
bf247b6e 301 :version "22.1")
4a2fce7a 302
0f4804e7 303(defcustom desktop-clear-preserve-buffers
3845c322
GM
304 '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*"
305 "\\*Warnings\\*")
9201cc28 306 "List of buffers that `desktop-clear' should not delete.
0f4804e7
LH
307Each element is a regular expression. Buffers with a name matched by any of
308these won't be deleted."
3845c322 309 :version "23.3" ; added Warnings - bug#6336
4a2fce7a
RS
310 :type '(repeat string)
311 :group 'desktop)
340db502 312
0f4804e7 313;;;###autoload
340db502
LH
314(defcustom desktop-locals-to-save
315 '(desktop-locals-to-save ; Itself! Think it over.
316 truncate-lines
317 case-fold-search
318 case-replace
319 fill-column
320 overwrite-mode
321 change-log-default-name
322 line-number-mode
0f4804e7
LH
323 column-number-mode
324 size-indication-mode
325 buffer-file-coding-system
326 indent-tabs-mode
11425834 327 tab-width
0f4804e7
LH
328 indicate-buffer-boundaries
329 indicate-empty-lines
330 show-trailing-whitespace)
577ed2b2 331 "List of local variables to save for each buffer.
0f4804e7
LH
332The variables are saved only when they really are local. Conventional minor
333modes are restored automatically; they should not be listed here."
6b61353c
KH
334 :type '(repeat symbol)
335 :group 'desktop)
ec4c6f22 336
a6c2c80c 337(defcustom desktop-buffers-not-to-save nil
4a2fce7a 338 "Regexp identifying buffers that are to be excluded from saving."
a6c2c80c
EZ
339 :type '(choice (const :tag "None" nil)
340 regexp)
1a8d3541 341 :version "23.2" ; set to nil
4a2fce7a 342 :group 'desktop)
6343ed61 343
6b61353c 344;; Skip tramp and ange-ftp files
bbf5eb28 345(defcustom desktop-files-not-to-save
a6c2c80c 346 "\\(^/[^/:]*:\\|(ftp)$\\)"
bbf5eb28 347 "Regexp identifying files whose buffers are to be excluded from saving."
a6c2c80c
EZ
348 :type '(choice (const :tag "None" nil)
349 regexp)
bbf5eb28 350 :group 'desktop)
fa379636 351
df410295
JL
352;; We skip TAGS files to save time (tags-file-name is saved instead).
353(defcustom desktop-modes-not-to-save
354 '(tags-table-mode)
80f9f3db
SM
355 "List of major modes whose buffers should not be saved."
356 :type '(repeat symbol)
357 :group 'desktop)
358
4a2fce7a 359(defcustom desktop-file-name-format 'absolute
9201cc28 360 "Format in which desktop file names should be saved.
4a2fce7a
RS
361Possible values are:
362 absolute -- Absolute file name.
363 tilde -- Relative to ~.
364 local -- Relative to directory of desktop file."
365 :type '(choice (const absolute) (const tilde) (const local))
af61551b 366 :group 'desktop
bf247b6e 367 :version "22.1")
569c754e 368
150f39ee
LH
369(defcustom desktop-restore-eager t
370 "Number of buffers to restore immediately.
371Remaining buffers are restored lazily (when Emacs is idle).
372If value is t, all buffers are restored immediately."
0ba9bc53 373 :type '(choice (const t) integer)
150f39ee 374 :group 'desktop
bf247b6e 375 :version "22.1")
150f39ee
LH
376
377(defcustom desktop-lazy-verbose t
378 "Verbose reporting of lazily created buffers."
379 :type 'boolean
380 :group 'desktop
bf247b6e 381 :version "22.1")
150f39ee
LH
382
383(defcustom desktop-lazy-idle-delay 5
384 "Idle delay before starting to create buffers.
385See `desktop-restore-eager'."
386 :type 'integer
387 :group 'desktop
bf247b6e 388 :version "22.1")
150f39ee 389
e5780ae1 390;;;###autoload
ebb39555
LH
391(defvar desktop-save-buffer nil
392 "When non-nil, save buffer status in desktop file.
e5780ae1 393This variable becomes buffer local when set.
ebb39555 394
b89c5a72
JB
395If the value is a function, it is called by `desktop-save' with argument
396DESKTOP-DIRNAME to obtain auxiliary information to save in the desktop
ebb39555 397file along with the state of the buffer for which it was called.
b6b70cda 398
6b61353c 399When file names are returned, they should be formatted using the call
e5780ae1 400\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
4a2fce7a 401
0f4804e7
LH
402Later, when `desktop-read' evaluates the desktop file, auxiliary information
403is passed as the argument DESKTOP-BUFFER-MISC to functions in
404`desktop-buffer-mode-handlers'.")
ebb39555
LH
405(make-variable-buffer-local 'desktop-save-buffer)
406(make-obsolete-variable 'desktop-buffer-modes-to-save
cc8b76bf 407 'desktop-save-buffer "22.1")
e5780ae1 408(make-obsolete-variable 'desktop-buffer-misc-functions
cc8b76bf 409 'desktop-save-buffer "22.1")
b6b70cda 410
0f4804e7
LH
411;;;###autoload
412(defvar desktop-buffer-mode-handlers
413 nil
e5780ae1 414 "Alist of major mode specific functions to restore a desktop buffer.
0f4804e7
LH
415Functions listed are called by `desktop-create-buffer' when `desktop-read'
416evaluates the desktop file. List elements must have the form
417
418 (MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
e5780ae1
LH
419
420Buffers with a major mode not specified here, are restored by the default
421handler `desktop-restore-file-buffer'.
422
55775448 423Handlers are called with argument list
4a2fce7a 424
9bcabb45 425 (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
e5780ae1
LH
426
427Furthermore, they may use the following variables:
4a2fce7a
RS
428
429 desktop-file-version
4a2fce7a
RS
430 desktop-buffer-major-mode
431 desktop-buffer-minor-modes
432 desktop-buffer-point
433 desktop-buffer-mark
434 desktop-buffer-read-only
4a2fce7a
RS
435 desktop-buffer-locals
436
e5780ae1 437If a handler returns a buffer, then the saved mode settings
0f4804e7
LH
438and variable values for that buffer are copied into it.
439
440Modules that define a major mode that needs a special handler should contain
441code like
ec4c6f22 442
0f4804e7
LH
443 (defun foo-restore-desktop-buffer
444 ...
445 (add-to-list 'desktop-buffer-mode-handlers
446 '(foo-mode . foo-restore-desktop-buffer))
447
448Furthermore the major mode function must be autoloaded.")
ec4c6f22 449
498eb267 450;;;###autoload
e5780ae1
LH
451(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
452(make-obsolete-variable 'desktop-buffer-handlers
cc8b76bf 453 'desktop-buffer-mode-handlers "22.1")
b6b70cda 454
47640244
GM
455(defcustom desktop-minor-mode-table
456 '((auto-fill-function auto-fill-mode)
5fff0265 457 (vc-mode nil)
f2168a4c 458 (vc-dired-mode nil)
fb8a6326
JB
459 (erc-track-minor-mode nil)
460 (savehist-mode nil))
47640244
GM
461 "Table mapping minor mode variables to minor mode functions.
462Each entry has the form (NAME RESTORE-FUNCTION).
463NAME is the name of the buffer-local variable indicating that the minor
464mode is active. RESTORE-FUNCTION is the function to activate the minor mode.
7d6ee4df 465RESTORE-FUNCTION nil means don't try to restore the minor mode.
47640244 466Only minor modes for which the name of the buffer-local variable
7bfa55b3 467and the name of the minor mode function are different have to be added to
0f4804e7 468this table. See also `desktop-minor-mode-handlers'."
47640244
GM
469 :type 'sexp
470 :group 'desktop)
471
0f4804e7
LH
472;;;###autoload
473(defvar desktop-minor-mode-handlers
474 nil
475 "Alist of functions to restore non-standard minor modes.
476Functions are called by `desktop-create-buffer' to restore minor modes.
477List elements must have the form
478
479 (MINOR-MODE . RESTORE-FUNCTION).
480
481Minor modes not specified here, are restored by the standard minor mode
482function.
483
484Handlers are called with argument list
485
486 (DESKTOP-BUFFER-LOCALS)
487
488Furthermore, they may use the following variables:
489
490 desktop-file-version
491 desktop-buffer-file-name
492 desktop-buffer-name
493 desktop-buffer-major-mode
494 desktop-buffer-minor-modes
495 desktop-buffer-point
496 desktop-buffer-mark
497 desktop-buffer-read-only
498 desktop-buffer-misc
499
500When a handler is called, the buffer has been created and the major mode has
501been set, but local variables listed in desktop-buffer-locals has not yet been
502created and set.
503
504Modules that define a minor mode that needs a special handler should contain
505code like
506
507 (defun foo-desktop-restore
508 ...
509 (add-to-list 'desktop-minor-mode-handlers
510 '(foo-mode . foo-desktop-restore))
511
512Furthermore the minor mode function must be autoloaded.
513
514See also `desktop-minor-mode-table'.")
515
498eb267 516;;;###autoload
0f4804e7
LH
517(put 'desktop-minor-mode-handlers 'risky-local-variable t)
518
0b9bd504
RS
519;; ----------------------------------------------------------------------------
520(defvar desktop-dirname nil
6b61353c 521 "The directory in which the desktop file should be saved.")
6343ed61 522
11425834
LH
523(defun desktop-full-file-name (&optional dirname)
524 "Return the full name of the desktop file in DIRNAME.
525DIRNAME omitted or nil means use `desktop-dirname'."
526 (expand-file-name desktop-base-file-name (or dirname desktop-dirname)))
527
e88110db
JB
528(defun desktop-full-lock-name (&optional dirname)
529 "Return the full name of the desktop lock file in DIRNAME.
530DIRNAME omitted or nil means use `desktop-dirname'."
531 (expand-file-name desktop-base-lock-name (or dirname desktop-dirname)))
532
6343ed61 533(defconst desktop-header
0b9bd504
RS
534";; --------------------------------------------------------------------------
535;; Desktop File for Emacs
536;; --------------------------------------------------------------------------
6343ed61 537" "*Header to place in Desktop file.")
de9e2828
RS
538
539(defvar desktop-delay-hook nil
540 "Hooks run after all buffers are loaded; intended for internal use.")
813dbb2d 541
e88110db
JB
542;; ----------------------------------------------------------------------------
543;; Desktop file conflict detection
544(defvar desktop-file-modtime nil
545 "When the desktop file was last modified to the knowledge of this Emacs.
546Used to detect desktop file conflicts.")
547
548(defun desktop-owner (&optional dirname)
549 "Return the PID of the Emacs process that owns the desktop file in DIRNAME.
550Return nil if no desktop file found or no Emacs process is using it.
551DIRNAME omitted or nil means use `desktop-dirname'."
552 (let (owner)
553 (and (file-exists-p (desktop-full-lock-name dirname))
554 (condition-case nil
555 (with-temp-buffer
556 (insert-file-contents-literally (desktop-full-lock-name dirname))
557 (goto-char (point-min))
558 (setq owner (read (current-buffer)))
559 (integerp owner))
560 (error nil))
561 owner)))
562
563(defun desktop-claim-lock (&optional dirname)
564 "Record this Emacs process as the owner of the desktop file in DIRNAME.
565DIRNAME omitted or nil means use `desktop-dirname'."
566 (write-region (number-to-string (emacs-pid)) nil
567 (desktop-full-lock-name dirname)))
568
569(defun desktop-release-lock (&optional dirname)
570 "Remove the lock file for the desktop in DIRNAME.
571DIRNAME omitted or nil means use `desktop-dirname'."
572 (let ((file (desktop-full-lock-name dirname)))
573 (when (file-exists-p file) (delete-file file))))
574
0b9bd504 575;; ----------------------------------------------------------------------------
6b61353c 576(defun desktop-truncate (list n)
ec4c6f22 577 "Truncate LIST to at most N elements destructively."
6b61353c 578 (let ((here (nthcdr (1- n) list)))
1f7efe1b
JB
579 (when (consp here)
580 (setcdr here nil))))
f9be4574 581
4a2fce7a 582;; ----------------------------------------------------------------------------
11425834 583;;;###autoload
f9be4574
RS
584(defun desktop-clear ()
585 "Empty the Desktop.
0f4804e7
LH
586This kills all buffers except for internal ones and those with names matched by
587a regular expression in the list `desktop-clear-preserve-buffers'.
588Furthermore, it clears the variables listed in `desktop-globals-to-clear'."
6343ed61 589 (interactive)
150f39ee 590 (desktop-lazy-abort)
4a2fce7a
RS
591 (dolist (var desktop-globals-to-clear)
592 (if (symbolp var)
1f7efe1b 593 (eval `(setq-default ,var nil))
4a2fce7a 594 (eval `(setq-default ,(car var) ,(cdr var)))))
0f4804e7
LH
595 (let ((buffers (buffer-list))
596 (preserve-regexp (concat "^\\("
597 (mapconcat (lambda (regexp)
598 (concat "\\(" regexp "\\)"))
599 desktop-clear-preserve-buffers
600 "\\|")
601 "\\)$")))
f9be4574 602 (while buffers
4a2fce7a
RS
603 (let ((bufname (buffer-name (car buffers))))
604 (or
605 (null bufname)
0f4804e7 606 (string-match preserve-regexp bufname)
4a2fce7a 607 ;; Don't kill buffers made for internal purposes.
3f32d6a3 608 (and (not (equal bufname "")) (eq (aref bufname 0) ?\s))
4a2fce7a 609 (kill-buffer (car buffers))))
f9be4574 610 (setq buffers (cdr buffers))))
b6105c76 611 (delete-other-windows))
4a2fce7a 612
0b9bd504 613;; ----------------------------------------------------------------------------
845fc5e5
JB
614(unless noninteractive
615 (add-hook 'kill-emacs-hook 'desktop-kill))
ec4c6f22 616
6343ed61 617(defun desktop-kill ()
6b61353c 618 "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
4a2fce7a
RS
619If the desktop should be saved and `desktop-dirname'
620is nil, ask the user where to save the desktop."
11425834
LH
621 (when (and desktop-save-mode
622 (let ((exists (file-exists-p (desktop-full-file-name))))
623 (or (eq desktop-save t)
7dd7fbb9
JD
624 (and exists (eq desktop-save 'if-exists))
625 ;; If it exists, but we aren't using it, we are going
626 ;; to ask for a new directory below.
627 (and exists desktop-dirname (eq desktop-save 'ask-if-new))
11425834
LH
628 (and
629 (or (memq desktop-save '(ask ask-if-new))
630 (and exists (eq desktop-save 'ask-if-exists)))
631 (y-or-n-p "Save desktop? ")))))
4a2fce7a
RS
632 (unless desktop-dirname
633 (setq desktop-dirname
11425834
LH
634 (file-name-as-directory
635 (expand-file-name
794855ca 636 (read-directory-name "Directory for desktop file: " nil nil t)))))
4a2fce7a 637 (condition-case err
e88110db 638 (desktop-save desktop-dirname t)
4a2fce7a 639 (file-error
11425834 640 (unless (yes-or-no-p "Error while saving the desktop. Ignore? ")
e88110db
JB
641 (signal (car err) (cdr err))))))
642 ;; If we own it, we don't anymore.
643 (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
4a2fce7a 644
0b9bd504 645;; ----------------------------------------------------------------------------
ed2f7fc8
RS
646(defun desktop-list* (&rest args)
647 (if (null (cdr args))
648 (car args)
649 (setq args (nreverse args))
650 (let ((value (cons (nth 1 args) (car args))))
651 (setq args (cdr (cdr args)))
652 (while args
653 (setq value (cons (car args) value))
654 (setq args (cdr args)))
655 value)))
656
e88110db
JB
657;; ----------------------------------------------------------------------------
658(defun desktop-buffer-info (buffer)
659 (set-buffer buffer)
660 (list
a8049a30
JB
661 ;; base name of the buffer; replaces the buffer name if managed by uniquify
662 (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
e88110db 663 ;; basic information
9e29c91c 664 (desktop-file-name (buffer-file-name) desktop-dirname)
a8049a30 665 (buffer-name)
e88110db
JB
666 major-mode
667 ;; minor modes
668 (let (ret)
669 (mapc
670 #'(lambda (minor-mode)
671 (and (boundp minor-mode)
672 (symbol-value minor-mode)
673 (let* ((special (assq minor-mode desktop-minor-mode-table))
674 (value (cond (special (cadr special))
675 ((functionp minor-mode) minor-mode))))
676 (when value (add-to-list 'ret value)))))
677 (mapcar #'car minor-mode-alist))
678 ret)
679 ;; point and mark, and read-only status
680 (point)
681 (list (mark t) mark-active)
682 buffer-read-only
683 ;; auxiliary information
684 (when (functionp desktop-save-buffer)
9e29c91c 685 (funcall desktop-save-buffer desktop-dirname))
e88110db
JB
686 ;; local variables
687 (let ((locals desktop-locals-to-save)
688 (loclist (buffer-local-variables))
689 (ll))
690 (while locals
691 (let ((here (assq (car locals) loclist)))
692 (if here
693 (setq ll (cons here ll))
694 (when (member (car locals) loclist)
695 (setq ll (cons (car locals) ll)))))
696 (setq locals (cdr locals)))
697 ll)))
698
4a2fce7a 699;; ----------------------------------------------------------------------------
6b61353c 700(defun desktop-internal-v2s (value)
577ed2b2
RS
701 "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
702TXT is a string that when read and evaluated yields value.
703QUOTE may be `may' (value may be quoted),
704`must' (values must be quoted), or nil (value may not be quoted)."
de9e2828 705 (cond
1f7efe1b
JB
706 ((or (numberp value) (null value) (eq t value) (keywordp value))
707 (cons 'may (prin1-to-string value)))
708 ((stringp value)
709 (let ((copy (copy-sequence value)))
710 (set-text-properties 0 (length copy) nil copy)
711 ;; Get rid of text properties because we cannot read them
712 (cons 'may (prin1-to-string copy))))
713 ((symbolp value)
714 (cons 'must (prin1-to-string value)))
715 ((vectorp value)
716 (let* ((special nil)
717 (pass1 (mapcar
718 (lambda (el)
719 (let ((res (desktop-internal-v2s el)))
720 (if (null (car res))
721 (setq special t))
722 res))
723 value)))
724 (if special
725 (cons nil (concat "(vector "
726 (mapconcat (lambda (el)
727 (if (eq (car el) 'must)
728 (concat "'" (cdr el))
729 (cdr el)))
730 pass1
731 " ")
732 ")"))
733 (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
734 ((consp value)
735 (let ((p value)
736 newlist
737 use-list*
738 anynil)
739 (while (consp p)
740 (let ((q.txt (desktop-internal-v2s (car p))))
741 (or anynil (setq anynil (null (car q.txt))))
742 (setq newlist (cons q.txt newlist)))
743 (setq p (cdr p)))
744 (if p
745 (let ((last (desktop-internal-v2s p)))
746 (or anynil (setq anynil (null (car last))))
747 (or anynil
748 (setq newlist (cons '(must . ".") newlist)))
749 (setq use-list* t)
750 (setq newlist (cons last newlist))))
751 (setq newlist (nreverse newlist))
752 (if anynil
753 (cons nil
754 (concat (if use-list* "(desktop-list* " "(list ")
755 (mapconcat (lambda (el)
756 (if (eq (car el) 'must)
757 (concat "'" (cdr el))
758 (cdr el)))
759 newlist
760 " ")
761 ")"))
762 (cons 'must
763 (concat "(" (mapconcat 'cdr newlist " ") ")")))))
764 ((subrp value)
765 (cons nil (concat "(symbol-function '"
766 (substring (prin1-to-string value) 7 -1)
767 ")")))
768 ((markerp value)
769 (let ((pos (prin1-to-string (marker-position value)))
770 (buf (prin1-to-string (buffer-name (marker-buffer value)))))
771 (cons nil (concat "(let ((mk (make-marker)))"
772 " (add-hook 'desktop-delay-hook"
773 " (list 'lambda '() (list 'set-marker mk "
774 pos " (get-buffer " buf ")))) mk)"))))
775 (t ; save as text
776 (cons 'may "\"Unprintable entity\""))))
de9e2828 777
4a2fce7a 778;; ----------------------------------------------------------------------------
6b61353c 779(defun desktop-value-to-string (value)
577ed2b2
RS
780 "Convert VALUE to a string that when read evaluates to the same value.
781Not all types of values are supported."
de9e2828
RS
782 (let* ((print-escape-newlines t)
783 (float-output-format nil)
6b61353c 784 (quote.txt (desktop-internal-v2s value))
de9e2828
RS
785 (quote (car quote.txt))
786 (txt (cdr quote.txt)))
787 (if (eq quote 'must)
788 (concat "'" txt)
789 txt)))
4a2fce7a 790
ec4c6f22 791;; ----------------------------------------------------------------------------
0e7c8611
RS
792(defun desktop-outvar (varspec)
793 "Output a setq statement for variable VAR to the desktop file.
794The argument VARSPEC may be the variable name VAR (a symbol),
be617bbf 795or a cons cell of the form (VAR . MAX-SIZE),
0e7c8611
RS
796which means to truncate VAR's value to at most MAX-SIZE elements
797\(if the value is a list) before saving the value."
798 (let (var size)
799 (if (consp varspec)
800 (setq var (car varspec) size (cdr varspec))
801 (setq var varspec))
1f7efe1b
JB
802 (when (boundp var)
803 (when (and (integerp size)
804 (> size 0)
805 (listp (eval var)))
806 (desktop-truncate (eval var) size))
807 (insert "(setq "
808 (symbol-name var)
809 " "
810 (desktop-value-to-string (symbol-value var))
811 ")\n"))))
4a2fce7a 812
0b9bd504 813;; ----------------------------------------------------------------------------
ec4c6f22 814(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
ebb39555 815 "Return t if buffer should have its state saved in the desktop file.
0b9bd504 816FILENAME is the visited file name, BUFNAME is the buffer name, and
be617bbf
JB
817MODE is the major mode.
818\n\(fn FILENAME BUFNAME MODE)"
b23caf75
GM
819 (let ((case-fold-search nil)
820 dired-skip)
a6c2c80c
EZ
821 (and (not (and (stringp desktop-buffers-not-to-save)
822 (not filename)
823 (string-match desktop-buffers-not-to-save bufname)))
ebb39555 824 (not (memq mode desktop-modes-not-to-save))
b23caf75 825 ;; FIXME this is broken if desktop-files-not-to-save is nil.
ebb39555 826 (or (and filename
a6c2c80c 827 (stringp desktop-files-not-to-save)
ebb39555
LH
828 (not (string-match desktop-files-not-to-save filename)))
829 (and (eq mode 'dired-mode)
830 (with-current-buffer bufname
b23caf75
GM
831 (not (setq dired-skip
832 (string-match desktop-files-not-to-save
833 default-directory)))))
ebb39555 834 (and (null filename)
b23caf75 835 (null dired-skip) ; bug#5755
ebb39555 836 (with-current-buffer bufname desktop-save-buffer))))))
4a2fce7a 837
0b9bd504 838;; ----------------------------------------------------------------------------
4a2fce7a
RS
839(defun desktop-file-name (filename dirname)
840 "Convert FILENAME to format specified in `desktop-file-name-format'.
841DIRNAME must be the directory in which the desktop file will be saved."
842 (cond
843 ((not filename) nil)
844 ((eq desktop-file-name-format 'tilde)
845 (let ((relative-name (file-relative-name (expand-file-name filename) "~")))
846 (cond
847 ((file-name-absolute-p relative-name) relative-name)
848 ((string= "./" relative-name) "~/")
849 ((string= "." relative-name) "~")
850 (t (concat "~/" relative-name)))))
851 ((eq desktop-file-name-format 'local) (file-relative-name filename dirname))
852 (t (expand-file-name filename))))
e5714620 853
b3615392 854
4a2fce7a 855;; ----------------------------------------------------------------------------
11425834 856;;;###autoload
e88110db 857(defun desktop-save (dirname &optional release)
6b61353c
KH
858 "Save the desktop in a desktop file.
859Parameter DIRNAME specifies where to save the desktop file.
e88110db 860Optional parameter RELEASE says whether we're done with this desktop.
6b61353c 861See also `desktop-base-file-name'."
6343ed61 862 (interactive "DDirectory to save desktop file in: ")
e88110db 863 (setq desktop-dirname (file-name-as-directory (expand-file-name dirname)))
6343ed61 864 (save-excursion
e88110db
JB
865 (let ((eager desktop-restore-eager)
866 (new-modtime (nth 5 (file-attributes (desktop-full-file-name)))))
867 (when
868 (or (not new-modtime) ; nothing to overwrite
869 (equal desktop-file-modtime new-modtime)
870 (yes-or-no-p (if desktop-file-modtime
871 (if (> (float-time new-modtime) (float-time desktop-file-modtime))
872 "Desktop file is more recent than the one loaded. Save anyway? "
873 "Desktop file isn't the one loaded. Overwrite it? ")
874 "Current desktop was not loaded from a file. Overwrite this desktop file? "))
875 (unless release (error "Desktop file conflict")))
876
877 ;; If we're done with it, release the lock.
878 ;; Otherwise, claim it if it's unclaimed or if we created it.
879 (if release
880 (desktop-release-lock)
881 (unless (and new-modtime (desktop-owner)) (desktop-claim-lock)))
882
883 (with-temp-buffer
884 (insert
885 ";; -*- mode: emacs-lisp; coding: emacs-mule; -*-\n"
886 desktop-header
887 ";; Created " (current-time-string) "\n"
888 ";; Desktop file format version " desktop-file-version "\n"
889 ";; Emacs version " emacs-version "\n")
890 (save-excursion (run-hooks 'desktop-save-hook))
891 (goto-char (point-max))
892 (insert "\n;; Global section:\n")
893 (mapc (function desktop-outvar) desktop-globals-to-save)
894 (when (memq 'kill-ring desktop-globals-to-save)
895 (insert
896 "(setq kill-ring-yank-pointer (nthcdr "
897 (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer)))
898 " kill-ring))\n"))
899
900 (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
901 (dolist (l (mapcar 'desktop-buffer-info (buffer-list)))
a8049a30
JB
902 (let ((base (pop l)))
903 (when (apply 'desktop-save-buffer-p l)
904 (insert "("
905 (if (or (not (integerp eager))
906 (if (zerop eager)
907 nil
908 (setq eager (1- eager))))
909 "desktop-create-buffer"
910 "desktop-append-buffer-args")
911 " "
912 desktop-file-version)
ae4370a8
JB
913 ;; If there's a non-empty base name, we save it instead of the buffer name
914 (when (and base (not (string= base "")))
915 (setcar (nthcdr 1 l) base))
a8049a30
JB
916 (dolist (e l)
917 (insert "\n " (desktop-value-to-string e)))
918 (insert ")\n\n"))))
e88110db 919
9e29c91c 920 (setq default-directory desktop-dirname)
e88110db
JB
921 (let ((coding-system-for-write 'emacs-mule))
922 (write-region (point-min) (point-max) (desktop-full-file-name) nil 'nomessage))
923 ;; We remember when it was modified (which is presumably just now).
924 (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name)))))))))
4a2fce7a 925
0b9bd504 926;; ----------------------------------------------------------------------------
11425834 927;;;###autoload
6343ed61 928(defun desktop-remove ()
6b61353c
KH
929 "Delete desktop file in `desktop-dirname'.
930This function also sets `desktop-dirname' to nil."
6343ed61 931 (interactive)
6b61353c 932 (when desktop-dirname
11425834 933 (let ((filename (desktop-full-file-name)))
6b61353c
KH
934 (setq desktop-dirname nil)
935 (when (file-exists-p filename)
73b0b745 936 (delete-file filename)))))
6b61353c 937
150f39ee
LH
938(defvar desktop-buffer-args-list nil
939 "List of args for `desktop-create-buffer'.")
940
941(defvar desktop-lazy-timer nil)
942
0b9bd504 943;; ----------------------------------------------------------------------------
478653c9 944;;;###autoload
6b61353c
KH
945(defun desktop-read (&optional dirname)
946 "Read and process the desktop file in directory DIRNAME.
947Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in
948directories listed in `desktop-path'. If a desktop file is found, it
cc8b76bf 949is processed and `desktop-after-read-hook' is run. If no desktop file
6b61353c
KH
950is found, clear the desktop and run `desktop-no-desktop-file-hook'.
951This function is a no-op when Emacs is running in batch mode.
952It returns t if a desktop file was loaded, nil otherwise."
6343ed61 953 (interactive)
4a2fce7a 954 (unless noninteractive
6b61353c 955 (setq desktop-dirname
11425834
LH
956 (file-name-as-directory
957 (expand-file-name
958 (or
959 ;; If DIRNAME is specified, use it.
960 (and (< 0 (length dirname)) dirname)
961 ;; Otherwise search desktop file in desktop-path.
962 (let ((dirs desktop-path))
963 (while (and dirs
964 (not (file-exists-p
965 (desktop-full-file-name (car dirs)))))
966 (setq dirs (cdr dirs)))
967 (and dirs (car dirs)))
968 ;; If not found and `desktop-path' is non-nil, use its first element.
969 (and desktop-path (car desktop-path))
970 ;; Default: Home directory.
971 "~"))))
972 (if (file-exists-p (desktop-full-file-name))
e88110db
JB
973 ;; Desktop file found, but is it already in use?
974 (let ((desktop-first-buffer nil)
975 (desktop-buffer-ok-count 0)
976 (desktop-buffer-fail-count 0)
977 (owner (desktop-owner))
978 ;; Avoid desktop saving during evaluation of desktop buffer.
979 (desktop-save nil))
980 (if (and owner
1f7efe1b
JB
981 (memq desktop-load-locked-desktop '(nil ask))
982 (or (null desktop-load-locked-desktop)
983 (not (y-or-n-p (format "Warning: desktop file appears to be in use by PID %s.\n\
984Using it may cause conflicts. Use it anyway? " owner)))))
c41cf130 985 (let ((default-directory desktop-dirname))
794855ca 986 (setq desktop-dirname nil)
c41cf130
JB
987 (run-hooks 'desktop-not-loaded-hook)
988 (unless desktop-dirname
989 (message "Desktop file in use; not loaded.")))
e88110db
JB
990 (desktop-lazy-abort)
991 ;; Evaluate desktop buffer and remember when it was modified.
992 (load (desktop-full-file-name) t t t)
993 (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name))))
994 ;; If it wasn't already, mark it as in-use, to bother other
995 ;; desktop instances.
996 (unless owner
997 (condition-case nil
998 (desktop-claim-lock)
999 (file-error (message "Couldn't record use of desktop file")
1000 (sit-for 1))))
1001
1002 ;; `desktop-create-buffer' puts buffers at end of the buffer list.
1003 ;; We want buffers existing prior to evaluating the desktop (and
1004 ;; not reused) to be placed at the end of the buffer list, so we
1005 ;; move them here.
1006 (mapc 'bury-buffer
1007 (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
1008 (switch-to-buffer (car (buffer-list)))
1009 (run-hooks 'desktop-delay-hook)
1010 (setq desktop-delay-hook nil)
1011 (run-hooks 'desktop-after-read-hook)
1012 (message "Desktop: %d buffer%s restored%s%s."
1013 desktop-buffer-ok-count
1014 (if (= 1 desktop-buffer-ok-count) "" "s")
1015 (if (< 0 desktop-buffer-fail-count)
1016 (format ", %d failed to restore" desktop-buffer-fail-count)
1017 "")
1018 (if desktop-buffer-args-list
1019 (format ", %d to restore lazily"
1020 (length desktop-buffer-args-list))
1021 ""))
1022 t))
6b61353c
KH
1023 ;; No desktop file found.
1024 (desktop-clear)
1025 (let ((default-directory desktop-dirname))
1026 (run-hooks 'desktop-no-desktop-file-hook))
1027 (message "No desktop file.")
1028 nil)))
4a2fce7a 1029
0b9bd504 1030;; ----------------------------------------------------------------------------
6b61353c 1031;; Maintained for backward compatibility
478653c9 1032;;;###autoload
6343ed61 1033(defun desktop-load-default ()
577ed2b2 1034 "Load the `default' start-up library manually.
6b61353c 1035Also inhibit further loading of it."
b89c5a72
JB
1036 (unless inhibit-default-init ; safety check
1037 (load "default" t t)
1038 (setq inhibit-default-init t)))
1039(make-obsolete 'desktop-load-default
1040 'desktop-save-mode "22.1")
4a2fce7a
RS
1041
1042;; ----------------------------------------------------------------------------
1043;;;###autoload
6b61353c
KH
1044(defun desktop-change-dir (dirname)
1045 "Change to desktop saved in DIRNAME.
1046Kill the desktop as specified by variables `desktop-save-mode' and
1047`desktop-save', then clear the desktop and load the desktop file in
1048directory DIRNAME."
1049 (interactive "DChange to directory: ")
1050 (setq dirname (file-name-as-directory (expand-file-name dirname desktop-dirname)))
4a2fce7a
RS
1051 (desktop-kill)
1052 (desktop-clear)
6b61353c 1053 (desktop-read dirname))
bf247b6e 1054
6b61353c 1055;; ----------------------------------------------------------------------------
4a2fce7a 1056;;;###autoload
6b61353c
KH
1057(defun desktop-save-in-desktop-dir ()
1058 "Save the desktop in directory `desktop-dirname'."
4a2fce7a
RS
1059 (interactive)
1060 (if desktop-dirname
b89c5a72 1061 (desktop-save desktop-dirname)
4a2fce7a 1062 (call-interactively 'desktop-save))
a609d13b 1063 (message "Desktop saved in %s" (abbreviate-file-name desktop-dirname)))
4a2fce7a
RS
1064
1065;; ----------------------------------------------------------------------------
1066;;;###autoload
1067(defun desktop-revert ()
1068 "Revert to the last loaded desktop."
1069 (interactive)
6b61353c
KH
1070 (unless desktop-dirname
1071 (error "Unknown desktop directory"))
11425834 1072 (unless (file-exists-p (desktop-full-file-name))
6b61353c
KH
1073 (error "No desktop file found"))
1074 (desktop-clear)
1075 (desktop-read desktop-dirname))
4a2fce7a 1076
341c2f07
SM
1077(defvar desktop-buffer-major-mode)
1078(defvar desktop-buffer-locals)
0b9bd504 1079;; ----------------------------------------------------------------------------
e5780ae1
LH
1080(defun desktop-restore-file-buffer (desktop-buffer-file-name
1081 desktop-buffer-name
1082 desktop-buffer-misc)
1083 "Restore a file buffer."
1f7efe1b
JB
1084 (when desktop-buffer-file-name
1085 (if (or (file-exists-p desktop-buffer-file-name)
1086 (let ((msg (format "Desktop: File \"%s\" no longer exists."
1087 desktop-buffer-file-name)))
1088 (if desktop-missing-file-warning
1089 (y-or-n-p (concat msg " Re-create buffer? "))
1090 (message "%s" msg)
1091 nil)))
1092 (let* ((auto-insert nil) ; Disable auto insertion
1093 (coding-system-for-read
1094 (or coding-system-for-read
1095 (cdr (assq 'buffer-file-coding-system
1096 desktop-buffer-locals))))
1097 (buf (find-file-noselect desktop-buffer-file-name)))
1098 (condition-case nil
1099 (switch-to-buffer buf)
1100 (error (pop-to-buffer buf)))
1101 (and (not (eq major-mode desktop-buffer-major-mode))
1102 (functionp desktop-buffer-major-mode)
1103 (funcall desktop-buffer-major-mode))
1104 buf)
1105 nil)))
4a2fce7a 1106
0f4804e7
LH
1107(defun desktop-load-file (function)
1108 "Load the file where auto loaded FUNCTION is defined."
97b3a214 1109 (when function
07696982 1110 (let ((fcell (and (fboundp function) (symbol-function function))))
97b3a214
LH
1111 (when (and (listp fcell)
1112 (eq 'autoload (car fcell)))
1113 (load (cadr fcell))))))
0f4804e7 1114
0b9bd504 1115;; ----------------------------------------------------------------------------
eb982898
JL
1116;; Create a buffer, load its file, set its mode, ...;
1117;; called from Desktop file only.
1d500ca6 1118
0f4804e7 1119;; Just to silence the byte compiler.
341c2f07
SM
1120
1121(defvar desktop-first-buffer) ; Dynamically bound in `desktop-read'
1122
1123;; Bound locally in `desktop-read'.
1124(defvar desktop-buffer-ok-count)
1125(defvar desktop-buffer-fail-count)
4a2fce7a 1126
340db502
LH
1127(defun desktop-create-buffer
1128 (desktop-file-version
1129 desktop-buffer-file-name
1130 desktop-buffer-name
1131 desktop-buffer-major-mode
1132 desktop-buffer-minor-modes
1133 desktop-buffer-point
1134 desktop-buffer-mark
1135 desktop-buffer-read-only
1136 desktop-buffer-misc
1137 &optional
1138 desktop-buffer-locals)
4a2fce7a
RS
1139 ;; To make desktop files with relative file names possible, we cannot
1140 ;; allow `default-directory' to change. Therefore we save current buffer.
1141 (save-current-buffer
0f4804e7
LH
1142 ;; Give major mode module a chance to add a handler.
1143 (desktop-load-file desktop-buffer-major-mode)
340db502
LH
1144 (let ((buffer-list (buffer-list))
1145 (result
116d5bc7 1146 (condition-case-no-debug err
340db502
LH
1147 (funcall (or (cdr (assq desktop-buffer-major-mode
1148 desktop-buffer-mode-handlers))
1149 'desktop-restore-file-buffer)
1150 desktop-buffer-file-name
1151 desktop-buffer-name
1152 desktop-buffer-misc)
1153 (error
1154 (message "Desktop: Can't load buffer %s: %s"
1155 desktop-buffer-name
1156 (error-message-string err))
1157 (when desktop-missing-file-warning (sit-for 1))
1158 nil))))
e5780ae1
LH
1159 (if (bufferp result)
1160 (setq desktop-buffer-ok-count (1+ desktop-buffer-ok-count))
1161 (setq desktop-buffer-fail-count (1+ desktop-buffer-fail-count))
1162 (setq result nil))
7bcbf3c2
JB
1163 ;; Restore buffer list order with new buffer at end. Don't change
1164 ;; the order for old desktop files (old desktop module behaviour).
4a2fce7a 1165 (unless (< desktop-file-version 206)
48aa4dfc 1166 (mapc 'bury-buffer buffer-list)
7bcbf3c2 1167 (when result (bury-buffer result)))
4a2fce7a 1168 (when result
7bcbf3c2
JB
1169 (unless (or desktop-first-buffer (< desktop-file-version 206))
1170 (setq desktop-first-buffer result))
4a2fce7a
RS
1171 (set-buffer result)
1172 (unless (equal (buffer-name) desktop-buffer-name)
93c5a976 1173 (rename-buffer desktop-buffer-name t))
4a2fce7a 1174 ;; minor modes
340db502
LH
1175 (cond ((equal '(t) desktop-buffer-minor-modes) ; backwards compatible
1176 (auto-fill-mode 1))
1177 ((equal '(nil) desktop-buffer-minor-modes) ; backwards compatible
1178 (auto-fill-mode 0))
1179 (t
341c2f07
SM
1180 (dolist (minor-mode desktop-buffer-minor-modes)
1181 ;; Give minor mode module a chance to add a handler.
1182 (desktop-load-file minor-mode)
1183 (let ((handler (cdr (assq minor-mode desktop-minor-mode-handlers))))
1184 (if handler
1185 (funcall handler desktop-buffer-locals)
1186 (when (functionp minor-mode)
1187 (funcall minor-mode 1)))))))
1188 ;; Even though point and mark are non-nil when written by
1189 ;; `desktop-save', they may be modified by handlers wanting to set
1190 ;; point or mark themselves.
e5780ae1
LH
1191 (when desktop-buffer-point
1192 (goto-char
1193 (condition-case err
341c2f07
SM
1194 ;; Evaluate point. Thus point can be something like
1195 ;; '(search-forward ...
e5780ae1
LH
1196 (eval desktop-buffer-point)
1197 (error (message "%s" (error-message-string err)) 1))))
4a2fce7a
RS
1198 (when desktop-buffer-mark
1199 (if (consp desktop-buffer-mark)
1f7efe1b
JB
1200 (progn
1201 (set-mark (car desktop-buffer-mark))
1202 (setq mark-active (car (cdr desktop-buffer-mark))))
4a2fce7a
RS
1203 (set-mark desktop-buffer-mark)))
1204 ;; Never override file system if the file really is read-only marked.
1f7efe1b 1205 (when desktop-buffer-read-only (setq buffer-read-only desktop-buffer-read-only))
4a2fce7a
RS
1206 (while desktop-buffer-locals
1207 (let ((this (car desktop-buffer-locals)))
1208 (if (consp this)
1f7efe1b
JB
1209 ;; an entry of this form `(symbol . value)'
1210 (progn
1211 (make-local-variable (car this))
1212 (set (car this) (cdr this)))
4a2fce7a
RS
1213 ;; an entry of the form `symbol'
1214 (make-local-variable this)
1215 (makunbound this)))
1216 (setq desktop-buffer-locals (cdr desktop-buffer-locals)))))))
ec4c6f22 1217
4a2fce7a 1218;; ----------------------------------------------------------------------------
ec4c6f22 1219;; Backward compatibility -- update parameters to 205 standards.
569c754e
RS
1220(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
1221 desktop-buffer-major-mode
2699e23e 1222 mim pt mk ro tl fc cfs cr desktop-buffer-misc)
569c754e 1223 (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
2699e23e
RS
1224 desktop-buffer-major-mode (cdr mim) pt mk ro
1225 desktop-buffer-misc
ec4c6f22
RS
1226 (list (cons 'truncate-lines tl)
1227 (cons 'fill-column fc)
1228 (cons 'case-fold-search cfs)
1229 (cons 'case-replace cr)
1230 (cons 'overwrite-mode (car mim)))))
84b538ec 1231
150f39ee 1232(defun desktop-append-buffer-args (&rest args)
cc8b76bf 1233 "Append ARGS at end of `desktop-buffer-args-list'.
150f39ee
LH
1234ARGS must be an argument list for `desktop-create-buffer'."
1235 (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args)))
1236 (unless desktop-lazy-timer
1237 (setq desktop-lazy-timer
1238 (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers))))
1239
1240(defun desktop-lazy-create-buffer ()
1241 "Pop args from `desktop-buffer-args-list', create buffer and bury it."
1242 (when desktop-buffer-args-list
1243 (let* ((remaining (length desktop-buffer-args-list))
1244 (args (pop desktop-buffer-args-list))
1245 (buffer-name (nth 2 args))
1246 (msg (format "Desktop lazily opening %s (%s remaining)..."
1247 buffer-name remaining)))
1248 (when desktop-lazy-verbose
8a26c165 1249 (message "%s" msg))
150f39ee
LH
1250 (let ((desktop-first-buffer nil)
1251 (desktop-buffer-ok-count 0)
1252 (desktop-buffer-fail-count 0))
1253 (apply 'desktop-create-buffer args)
1254 (run-hooks 'desktop-delay-hook)
1255 (setq desktop-delay-hook nil)
1256 (bury-buffer (get-buffer buffer-name))
1257 (when desktop-lazy-verbose
1258 (message "%s%s" msg (if (> desktop-buffer-ok-count 0) "done" "failed")))))))
1259
1260(defun desktop-idle-create-buffers ()
1261 "Create buffers until the user does something, then stop.
1262If there are no buffers left to create, kill the timer."
1263 (let ((repeat 1))
1264 (while (and repeat desktop-buffer-args-list)
1265 (save-window-excursion
1266 (desktop-lazy-create-buffer))
1267 (setq repeat (sit-for 0.2))
1268 (unless desktop-buffer-args-list
1269 (cancel-timer desktop-lazy-timer)
1270 (setq desktop-lazy-timer nil)
1271 (message "Lazy desktop load complete")
1272 (sit-for 3)
1273 (message "")))))
1274
1275(defun desktop-lazy-complete ()
1276 "Run the desktop load to completion."
1277 (interactive)
1278 (let ((desktop-lazy-verbose t))
1279 (while desktop-buffer-args-list
1280 (save-window-excursion
1281 (desktop-lazy-create-buffer)))
1282 (message "Lazy desktop load complete")))
1283
1284(defun desktop-lazy-abort ()
1285 "Abort lazy loading of the desktop."
1286 (interactive)
1287 (when desktop-lazy-timer
1288 (cancel-timer desktop-lazy-timer)
1289 (setq desktop-lazy-timer nil))
1290 (when desktop-buffer-args-list
1291 (setq desktop-buffer-args-list nil)
32226619 1292 (when (called-interactively-p 'interactive)
150f39ee
LH
1293 (message "Lazy desktop load aborted"))))
1294
0b9bd504 1295;; ----------------------------------------------------------------------------
6b61353c 1296;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
4a2fce7a
RS
1297;; command line, we do the rest of what it takes to use desktop, but do it
1298;; after finishing loading the init file.
1299;; We cannot use `command-switch-alist' to process "--no-desktop" because these
1300;; functions are processed after `after-init-hook'.
1301(add-hook
1302 'after-init-hook
341c2f07 1303 (lambda ()
4a2fce7a 1304 (let ((key "--no-desktop"))
4b217d46
LH
1305 (when (member key command-line-args)
1306 (setq command-line-args (delete key command-line-args))
1307 (setq desktop-save-mode nil)))
54d22a6f
JL
1308 (when desktop-save-mode
1309 (desktop-read)
1310 (setq inhibit-startup-screen t))))
813dbb2d 1311
ab1d55ea 1312(provide 'desktop)
6343ed61 1313
80f9f3db 1314;;; desktop.el ends here