desktop.el 56.5 KB
Newer Older
1
;;; desktop.el --- save partial status of Emacs when killed -*- lexical-binding: t -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1993-1995, 1997, 2000-2014 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author: Morten Welinder <terra@diku.dk>
Dave Love's avatar
Dave Love committed
6
;; Keywords: convenience
Paul Eggert's avatar
Paul Eggert committed
7
;; Favorite-brand-of-beer: None, I hate beer.
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23 24 25

;;; Commentary:

26 27 28 29 30 31 32 33
;; Save the Desktop, i.e.,
;;	- some global variables
;; 	- the list of buffers with associated files.  For each buffer also
;;		- the major mode
;;		- the default directory
;;		- the point
;;		- the mark & mark-active
;;		- buffer-read-only
34
;;		- some local variables
35
;;	- frame and window configuration
Richard M. Stallman's avatar
Richard M. Stallman committed
36

Kenichi Handa's avatar
Kenichi Handa committed
37
;; To use this, use customize to turn on desktop-save-mode or add the
38
;; following line somewhere in your init file:
39
;;
Kenichi Handa's avatar
Kenichi Handa committed
40
;;	(desktop-save-mode 1)
41
;;
Kenichi Handa's avatar
Kenichi Handa committed
42
;; For further usage information, look at the section
Glenn Morris's avatar
Glenn Morris committed
43
;; (info "(emacs)Saving Emacs Sessions") in the GNU Emacs Manual.
Kenichi Handa's avatar
Kenichi Handa committed
44 45

;; When the desktop module is loaded, the function `desktop-kill' is
46
;; added to the `kill-emacs-hook'.  This function is responsible for
Kenichi Handa's avatar
Kenichi Handa committed
47
;; saving the desktop when Emacs is killed.  Furthermore an anonymous
48
;; function is added to the `after-init-hook'.  This function is
Kenichi Handa's avatar
Kenichi Handa committed
49
;; responsible for loading the desktop when Emacs is started.
50

51 52 53 54 55
;; 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
56
;; to restore a desktop buffer.  Elements must have the form
57
;;
58
;;    (MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
59
;;
60
;; Functions listed are called by `desktop-create-buffer' when `desktop-read'
61
;; evaluates the desktop file.  Buffers with a major mode not specified here,
62 63 64
;; 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
65
;;
66
;;    (MINOR-MODE . RESTORE-FUNCTION).
67
;;
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
;; 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

;;    (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))

85
;; in the module itself, and make sure that the mode function is
86
;; autoloaded.  See the docstrings of `desktop-buffer-mode-handlers' and
87 88 89 90 91 92 93 94 95 96 97 98 99 100
;; `desktop-minor-mode-handlers' for more info.

;; 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
101
;; functions before writing `desktop-minor-modes'.  If a minor mode has a
102 103 104 105 106 107 108 109 110
;; 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.
;; ---------------------------------------------------------------------------
111

112 113 114 115
;; By the way: don't use desktop.el to customize Emacs -- the file .emacs
;; in your home directory is used for that.  Saving global default values
;; for buffers is an example of misuse.

116 117 118
;; PLEASE NOTE: The kill ring can be saved as specified by the variable
;; `desktop-globals-to-save' (by default it isn't).  This may result in saving
;; things you did not mean to keep.  Use M-x desktop-clear RET.
119

120 121 122 123 124
;; Thanks to  hetrick@phys.uva.nl (Jim Hetrick)      for useful ideas.
;;            avk@rtsg.mot.com (Andrew V. Klein)     for a dired tip.
;;            chris@tecc.co.uk (Chris Boucher)       for a mark tip.
;;            f89-kam@nada.kth.se (Klas Mellbourn)   for a mh-e tip.
;;            kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
125
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
Glenn Morris's avatar
Glenn Morris committed
126
;;            pot@cnuce.cnr.it (Francesco Potortì)  for misc. tips.
127 128 129 130 131
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
132 133 134

;;; Code:

135
(require 'cl-lib)
136
(require 'frameset)
137

138
(defvar desktop-file-version "206"
Kenichi Handa's avatar
Kenichi Handa committed
139
  "Version number of desktop file format.
140 141 142
Written into the desktop file and used at desktop read to provide
backward compatibility.")

143
;; ----------------------------------------------------------------------------
144 145
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
146 147 148 149 150

(defgroup desktop nil
  "Save status of Emacs when you exit."
  :group 'frames)

151 152
;; Maintained for backward compatibility
(define-obsolete-variable-alias 'desktop-enable 'desktop-save-mode "22.1")
Kenichi Handa's avatar
Kenichi Handa committed
153 154
;;;###autoload
(define-minor-mode desktop-save-mode
155
  "Toggle desktop saving (Desktop Save mode).
Glenn Morris's avatar
Glenn Morris committed
156 157 158
With a prefix argument ARG, enable Desktop Save mode if ARG is positive,
and disable it otherwise.  If called from Lisp, enable the mode if ARG
is omitted or nil.
159

Glenn Morris's avatar
Glenn Morris committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173
When Desktop Save mode is enabled, the state of Emacs is saved from
one session to another.  In particular, Emacs will save the desktop when
it exits (this may prompt you; see the option `desktop-save').  The next
time Emacs starts, if this mode is active it will restore the desktop.

To manually save the desktop at any time, use the command `M-x desktop-save'.
To load it, use `M-x desktop-read'.

Once a desktop file exists, Emacs will auto-save it according to the
option `desktop-auto-save-timeout'.

To see all the options you can set, browse the `desktop' customization group.

For further details, see info node `(emacs)Saving Emacs Sessions'."
Kenichi Handa's avatar
Kenichi Handa committed
174
  :global t
175 176 177 178
  :group 'desktop
  (if desktop-save-mode
      (desktop-auto-save-set-timer)
    (desktop-auto-save-cancel-timer)))
Kenichi Handa's avatar
Kenichi Handa committed
179

180 181 182 183
(defun desktop-save-mode-off ()
  "Disable `desktop-save-mode'.  Provided for use in hooks."
  (desktop-save-mode 0))

184
(defcustom desktop-save 'ask-if-new
Lute Kamstra's avatar
Lute Kamstra committed
185
  "Specifies whether the desktop should be saved when it is killed.
Kenichi Handa's avatar
Kenichi Handa committed
186 187
A desktop is killed when the user changes desktop or quits Emacs.
Possible values are:
188 189 190 191 192 193
   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.
Kenichi Handa's avatar
Kenichi Handa committed
194
The desktop is never saved when `desktop-save-mode' is nil.
195
The variables `desktop-dirname' and `desktop-base-file-name'
Kenichi Handa's avatar
Kenichi Handa committed
196
determine where the desktop is saved."
197 198
  :type
  '(choice
199 200 201 202 203 204
    (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))
205
  :group 'desktop
206
  :version "22.1")
207

208 209
(defcustom desktop-auto-save-timeout auto-save-timeout
  "Number of seconds idle time before auto-save of the desktop.
Glenn Morris's avatar
Glenn Morris committed
210
This applies to an existing desktop file when `desktop-save-mode' is enabled.
211
Zero or nil means disable auto-saving due to idleness."
212 213 214 215
  :type '(choice (const :tag "Off" nil)
                 (integer :tag "Seconds"))
  :set (lambda (symbol value)
         (set-default symbol value)
216
         (ignore-errors (desktop-auto-save-set-timer)))
217 218 219
  :group 'desktop
  :version "24.4")

220 221 222 223 224 225 226 227 228 229 230 231 232 233
(defcustom desktop-load-locked-desktop 'ask
  "Specifies whether the desktop should be loaded if locked.
Possible values are:
   t    -- load anyway.
   nil  -- don't load.
   ask  -- ask the user.
If the value is nil, or `ask' and the user chooses not to load the desktop,
the normal hook `desktop-not-loaded-hook' is run."
  :type
  '(choice
    (const :tag "Load anyway" t)
    (const :tag "Don't load" nil)
    (const :tag "Ask the user" ask))
  :group 'desktop
234
  :version "22.2")
235

236 237 238
(define-obsolete-variable-alias 'desktop-basefilename
                                'desktop-base-file-name "22.1")

239
(defcustom desktop-base-file-name
240
  (convert-standard-filename ".emacs.desktop")
Kenichi Handa's avatar
Kenichi Handa committed
241
  "Name of file for Emacs desktop, excluding the directory part."
242 243
  :type 'file
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
244

245 246 247 248 249
(defcustom desktop-base-lock-name
  (convert-standard-filename ".emacs.desktop.lock")
  "Name of lock file for Emacs desktop, excluding the directory part."
  :type 'file
  :group 'desktop
250
  :version "22.2")
251

Chong Yidong's avatar
Chong Yidong committed
252
(defcustom desktop-path (list user-emacs-directory "~")
253 254 255
  "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)
256
  :group 'desktop
257
  :version "23.2")                      ; user-emacs-directory added
258

259
(defcustom desktop-missing-file-warning nil
260
  "If non-nil, offer to recreate the buffer of a deleted file.
261 262 263 264
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."
265
  :type 'boolean
266
  :group 'desktop
267
  :version "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
268

269
(defcustom desktop-no-desktop-file-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
270
  "Normal hook run when `desktop-read' can't find a desktop file.
271
Run in the directory in which the desktop file was sought.
272
May be used to show a dired buffer."
273
  :type 'hook
274
  :group 'desktop
275
  :version "22.1")
276

277 278 279 280 281 282 283
(defcustom desktop-not-loaded-hook nil
  "Normal hook run when the user declines to re-use a desktop file.
Run in the directory in which the desktop file was found.
May be used to deal with accidental multiple Emacs jobs."
  :type 'hook
  :group 'desktop
  :options '(desktop-save-mode-off save-buffers-kill-emacs)
284
  :version "22.2")
285

286
(defcustom desktop-after-read-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
287
  "Normal hook run after a successful `desktop-read'.
288
May be used to show a buffer list."
289
  :type 'hook
290
  :group 'desktop
291
  :options '(list-buffers)
292
  :version "22.1")
293 294

(defcustom desktop-save-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
295
  "Normal hook run before the desktop is saved in a desktop file.
296 297 298
Run with the desktop buffer current with only the header present.
May be used to add to the desktop code or to truncate history lists,
for example."
299 300 301
  :type 'hook
  :group 'desktop)

302 303 304 305 306 307
(defcustom desktop-globals-to-save
  '(desktop-missing-file-warning
    tags-file-name
    tags-table-list
    search-ring
    regexp-search-ring
308 309
    register-alist
    file-name-history)
Kenichi Handa's avatar
Kenichi Handa committed
310 311 312 313
  "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.
314 315 316 317
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
  :group 'desktop)

318 319 320 321 322 323 324
(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)
325
  "List of global variables that `desktop-clear' will clear.
326
An element may be variable name (a symbol) or a cons cell of the form
327 328
\(VAR . FORM).  Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluating FORM."
329
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
330
  :group 'desktop
331
  :version "22.1")
332

333
(defcustom desktop-clear-preserve-buffers
Glenn Morris's avatar
Glenn Morris committed
334 335
  '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*"
    "\\*Warnings\\*")
Lute Kamstra's avatar
Lute Kamstra committed
336
  "List of buffers that `desktop-clear' should not delete.
337 338
Each element is a regular expression.  Buffers with a name matched by any of
these won't be deleted."
Glenn Morris's avatar
Glenn Morris committed
339
  :version "23.3"                       ; added Warnings - bug#6336
340 341
  :type '(repeat string)
  :group 'desktop)
342

343
;;;###autoload
344 345 346 347 348 349 350 351 352
(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
353 354 355 356
    column-number-mode
    size-indication-mode
    buffer-file-coding-system
    indent-tabs-mode
357
    tab-width
358 359 360
    indicate-buffer-boundaries
    indicate-empty-lines
    show-trailing-whitespace)
Richard M. Stallman's avatar
Richard M. Stallman committed
361
  "List of local variables to save for each buffer.
362 363
The variables are saved only when they really are local.  Conventional minor
modes are restored automatically; they should not be listed here."
Kenichi Handa's avatar
Kenichi Handa committed
364 365
  :type '(repeat symbol)
  :group 'desktop)
366

367
(defcustom desktop-buffers-not-to-save "\\` "
368
  "Regexp identifying buffers that are to be excluded from saving."
369 370
  :type '(choice (const :tag "None" nil)
		 regexp)
371
  :version "24.4"		    ; skip invisible temporary buffers
372
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
373

Kenichi Handa's avatar
Kenichi Handa committed
374
;; Skip tramp and ange-ftp files
375
(defcustom desktop-files-not-to-save
376
  "\\(^/[^/:]*:\\|(ftp)$\\)"
377
  "Regexp identifying files whose buffers are to be excluded from saving."
378 379
  :type '(choice (const :tag "None" nil)
		 regexp)
380
  :group 'desktop)
381

382 383 384
;; We skip TAGS files to save time (tags-file-name is saved instead).
(defcustom desktop-modes-not-to-save
  '(tags-table-mode)
385 386 387 388
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

389
(defcustom desktop-restore-frames t
390
  "When non-nil, save frames to desktop file."
391 392 393 394
  :type 'boolean
  :group 'desktop
  :version "24.4")

395
(defcustom desktop-restore-in-current-display nil
396 397 398 399 400
  "If t, frames are restored in the current display.
If nil, frames are restored, if possible, in their original displays.
If `delete', frames on other displays are deleted instead of restored."
  :type '(choice (const :tag "Restore in current display" t)
		 (const :tag "Restore in original display" nil)
Glenn Morris's avatar
Glenn Morris committed
401
		 (const :tag "Delete frames in other displays" delete))
402 403 404
  :group 'desktop
  :version "24.4")

405 406
(defcustom desktop-restore-forces-onscreen t
  "If t, offscreen frames are restored onscreen instead.
Paul Eggert's avatar
Paul Eggert committed
407
If `:all', frames that are partially offscreen are also forced onscreen.
408 409 410 411
NOTE: Checking of frame boundaries is only approximate and can fail
to reliably detect frames whose onscreen/offscreen state depends on a
few pixels, especially near the right / bottom borders of the screen."
  :type '(choice (const :tag "Only fully offscreen frames" t)
412
		 (const :tag "Also partially offscreen frames" :all)
413 414 415 416
		 (const :tag "Do not force frames onscreen" nil))
  :group 'desktop
  :version "24.4")

417
(defcustom desktop-restore-reuses-frames t
418 419
  "If t, restoring frames reuses existing frames.
If nil, existing frames are deleted.
420
If `:keep', existing frames are kept and not reused."
421 422
  :type '(choice (const :tag "Reuse existing frames" t)
		 (const :tag "Delete existing frames" nil)
423
		 (const :tag "Keep existing frames" :keep))
424 425 426
  :group 'desktop
  :version "24.4")

427
(defcustom desktop-file-name-format 'absolute
Lute Kamstra's avatar
Lute Kamstra committed
428
  "Format in which desktop file names should be saved.
429 430 431 432 433
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))
434
  :group 'desktop
435
  :version "22.1")
436

437 438 439 440
(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."
441
  :type '(choice (const t) integer)
442
  :group 'desktop
443
  :version "22.1")
444 445 446 447 448

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
449
  :version "22.1")
450 451 452 453 454 455

(defcustom desktop-lazy-idle-delay 5
  "Idle delay before starting to create buffers.
See `desktop-restore-eager'."
  :type 'integer
  :group 'desktop
456
  :version "22.1")
457

458
;;;###autoload
459
(defvar-local desktop-save-buffer nil
460 461
  "When non-nil, save buffer status in desktop file.

462 463
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
464
file along with the state of the buffer for which it was called.
465

Kenichi Handa's avatar
Kenichi Handa committed
466
When file names are returned, they should be formatted using the call
467
\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
468

469 470 471
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'.")
472
(make-obsolete-variable 'desktop-buffer-modes-to-save
473
                        'desktop-save-buffer "22.1")
474
(make-obsolete-variable 'desktop-buffer-misc-functions
475
                        'desktop-save-buffer "22.1")
476

477
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
478
(defvar desktop-buffer-mode-handlers nil
479
  "Alist of major mode specific functions to restore a desktop buffer.
480 481 482 483
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).
484 485 486 487

Buffers with a major mode not specified here, are restored by the default
handler `desktop-restore-file-buffer'.

488
Handlers are called with argument list
489

490
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
491 492

Furthermore, they may use the following variables:
493 494 495 496 497 498 499 500 501

   desktop-file-version
   desktop-buffer-major-mode
   desktop-buffer-minor-modes
   desktop-buffer-point
   desktop-buffer-mark
   desktop-buffer-read-only
   desktop-buffer-locals

502
If a handler returns a buffer, then the saved mode settings
503 504 505 506
and variable values for that buffer are copied into it.

Modules that define a major mode that needs a special handler should contain
code like
507

508 509 510 511 512 513
   (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.")
514

515
;;;###autoload
516 517
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
518
                        'desktop-buffer-mode-handlers "22.1")
519

520 521
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
522
    (vc-mode nil)
523
    (vc-dired-mode nil)
524 525
    (erc-track-minor-mode nil)
    (savehist-mode nil))
526 527 528 529
  "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.
530
RESTORE-FUNCTION nil means don't try to restore the minor mode.
531
Only minor modes for which the name of the buffer-local variable
532
and the name of the minor mode function are different have to be added to
533
this table.  See also `desktop-minor-mode-handlers'."
534 535 536
  :type 'sexp
  :group 'desktop)

537
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
538
(defvar desktop-minor-mode-handlers nil
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
  "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'.")

580
;;;###autoload
581 582
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

583 584
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Kenichi Handa's avatar
Kenichi Handa committed
585
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
586

587 588 589 590 591
(defun desktop-full-file-name (&optional dirname)
  "Return the full name of the desktop file in DIRNAME.
DIRNAME omitted or nil means use `desktop-dirname'."
  (expand-file-name desktop-base-file-name (or dirname desktop-dirname)))

592 593 594 595 596
(defun desktop-full-lock-name (&optional dirname)
  "Return the full name of the desktop lock file in DIRNAME.
DIRNAME omitted or nil means use `desktop-dirname'."
  (expand-file-name desktop-base-lock-name (or dirname desktop-dirname)))

Richard M. Stallman's avatar
Richard M. Stallman committed
597
(defconst desktop-header
598 599 600
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
601
" "*Header to place in Desktop file.")
602 603 604

(defvar desktop-delay-hook nil
  "Hooks run after all buffers are loaded; intended for internal use.")
605

606 607 608 609
(defvar desktop-file-checksum nil
  "Checksum of the last auto-saved contents of the desktop file.
Used to avoid writing contents unchanged between auto-saves.")

610
(defvar desktop-saved-frameset nil
611 612
  "Saved state of all frames.
Only valid during frame saving & restoring; intended for internal use.")
613

614 615 616 617 618 619 620 621 622 623
;; ----------------------------------------------------------------------------
;; Desktop file conflict detection
(defvar desktop-file-modtime nil
  "When the desktop file was last modified to the knowledge of this Emacs.
Used to detect desktop file conflicts.")

(defun desktop-owner (&optional dirname)
  "Return the PID of the Emacs process that owns the desktop file in DIRNAME.
Return nil if no desktop file found or no Emacs process is using it.
DIRNAME omitted or nil means use `desktop-dirname'."
624 625 626 627 628 629 630 631 632
  (let (owner
	(file (desktop-full-lock-name dirname)))
    (and (file-exists-p file)
	 (ignore-errors
	   (with-temp-buffer
	     (insert-file-contents-literally file)
	     (goto-char (point-min))
	     (setq owner (read (current-buffer)))
	     (integerp owner)))
633 634 635 636 637 638 639 640 641 642 643 644 645 646
	 owner)))

(defun desktop-claim-lock (&optional dirname)
  "Record this Emacs process as the owner of the desktop file in DIRNAME.
DIRNAME omitted or nil means use `desktop-dirname'."
  (write-region (number-to-string (emacs-pid)) nil
		(desktop-full-lock-name dirname)))

(defun desktop-release-lock (&optional dirname)
  "Remove the lock file for the desktop in DIRNAME.
DIRNAME omitted or nil means use `desktop-dirname'."
  (let ((file (desktop-full-lock-name dirname)))
    (when (file-exists-p file) (delete-file file))))

647
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
648
(defun desktop-truncate (list n)
649
  "Truncate LIST to at most N elements destructively."
Kenichi Handa's avatar
Kenichi Handa committed
650
  (let ((here (nthcdr (1- n) list)))
651 652
    (when (consp here)
      (setcdr here nil))))
653

654
;; ----------------------------------------------------------------------------
655
;;;###autoload
656 657
(defun desktop-clear ()
  "Empty the Desktop.
658 659
This kills all buffers except for internal ones and those with names matched by
a regular expression in the list `desktop-clear-preserve-buffers'.
660 661 662 663
Furthermore, it clears the variables listed in `desktop-globals-to-clear'.
When called interactively and `desktop-restore-frames' is non-nil, it also
deletes all frames except the selected one (and its minibuffer frame,
if different)."
Richard M. Stallman's avatar
Richard M. Stallman committed
664
  (interactive)
665
  (desktop-lazy-abort)
666 667
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
668
	(eval `(setq-default ,var nil))
669
      (eval `(setq-default ,(car var) ,(cdr var)))))
670
  (let ((preserve-regexp (concat "^\\("
671 672 673 674 675
                                 (mapconcat (lambda (regexp)
                                              (concat "\\(" regexp "\\)"))
                                            desktop-clear-preserve-buffers
                                            "\\|")
                                 "\\)$")))
676 677
    (dolist (buffer (buffer-list))
      (let ((bufname (buffer-name buffer)))
678
	(unless (or (eq (aref bufname 0) ?\s) ;; Don't kill internal buffers
679 680
		    (string-match-p preserve-regexp bufname))
	  (kill-buffer buffer)))))
681
  (delete-other-windows)
682 683 684 685 686
  (when (and desktop-restore-frames
	     ;; Non-interactive calls to desktop-clear happen before desktop-read
	     ;; which already takes care of frame restoration and deletion.
	     (called-interactively-p 'any))
    (let* ((this (selected-frame))
Paul Eggert's avatar
Paul Eggert committed
687
	   (mini (window-frame (minibuffer-window this)))) ; in case they differ
688
      (dolist (frame (sort (frame-list) #'frameset-minibufferless-first-p))
689 690 691 692 693 694 695
	(condition-case err
	    (unless (or (eq frame this)
			(eq frame mini)
			(frame-parameter frame 'desktop-dont-clear))
	      (delete-frame frame))
	  (error
	 (delay-warning 'desktop (error-message-string err))))))))
696

697
;; ----------------------------------------------------------------------------
Juanma Barranquero's avatar
Juanma Barranquero committed
698 699
(unless noninteractive
  (add-hook 'kill-emacs-hook 'desktop-kill))
700

Richard M. Stallman's avatar
Richard M. Stallman committed
701
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
702
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
703 704
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
705 706 707
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
708 709 710 711
                   (and exists (eq desktop-save 'if-exists))
		   ;; If it exists, but we aren't using it, we are going
		   ;; to ask for a new directory below.
                   (and exists desktop-dirname (eq desktop-save 'ask-if-new))
712 713 714 715
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
716 717
    (unless desktop-dirname
      (setq desktop-dirname
718 719
            (file-name-as-directory
             (expand-file-name
720
	      (read-directory-name "Directory for desktop file: " nil nil t)))))
721
    (condition-case err
722
	(desktop-save desktop-dirname t)
723
      (file-error
724
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
725 726 727
	 (signal (car err) (cdr err))))))
  ;; If we own it, we don't anymore.
  (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
728

729
;; ----------------------------------------------------------------------------
730
(defun desktop-list* (&rest args)
731
  (and args (apply #'cl-list* args)))
732

733 734 735 736
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
  (set-buffer buffer)
  (list
737 738
   ;; base name of the buffer; replaces the buffer name if managed by uniquify
   (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
739
   ;; basic information
740
   (desktop-file-name (buffer-file-name) desktop-dirname)
741
   (buffer-name)
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
   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 and mark, and read-only status
   (point)
   (list (mark t) mark-active)
   buffer-read-only
   ;; auxiliary information
   (when (functionp desktop-save-buffer)
761
     (funcall desktop-save-buffer desktop-dirname))
762
   ;; local variables
763 764 765 766 767 768 769 770
   (let ((loclist (buffer-local-variables))
	 (ll nil))
     (dolist (local desktop-locals-to-save)
       (let ((here (assq local loclist)))
	 (cond (here
		(push here ll))
	       ((member local loclist)
		(push local ll)))))
771 772
     ll)))

773
;; ----------------------------------------------------------------------------
774 775 776
(defun desktop--v2s (value)
  "Convert VALUE to a pair (QUOTE . SEXP); (eval SEXP) gives VALUE.
SEXP is an sexp that when evaluated yields VALUE.
Richard M. Stallman's avatar
Richard M. Stallman committed
777
QUOTE may be `may' (value may be quoted),
778
`must' (value must be quoted), or nil (value must not be quoted)."
779
  (cond
780
    ((or (numberp value) (null value) (eq t value) (keywordp value))
781
     (cons 'may value))
782 783 784
    ((stringp value)
     (let ((copy (copy-sequence value)))
       (set-text-properties 0 (length copy) nil copy)
785 786
       ;; Get rid of text properties because we cannot read them.
       (cons 'may copy)))
787
    ((symbolp value)
788
     (cons 'must value))
789
    ((vectorp value)
790 791
     (let* ((pass1 (mapcar #'desktop--v2s value))
	    (special (assq nil pass1)))
792
       (if special
793 794 795 796 797 798
	   (cons nil `(vector
                       ,@(mapcar (lambda (el)
                                   (if (eq (car el) 'must)
                                       `',(cdr el) (cdr el)))
                                 pass1)))
	 (cons 'may `[,@(mapcar #'cdr pass1)]))))
799 800 801
    ((consp value)
     (let ((p value)
	   newlist
802
	   use-list*)
803
       (while (consp p)
804 805
	 (let ((q.sexp (desktop--v2s (car p))))
           (push q.sexp newlist))
806
	 (setq p (cdr p)))
807 808 809 810 811
       (when p
         (let ((last (desktop--v2s p)))
           (setq use-list* t)
           (push last newlist)))
       (if (assq nil newlist)
812
	   (cons nil
813 814 815 816 817
		 `(,(if use-list* 'desktop-list* 'list)
                   ,@(mapcar (lambda (el)
                               (if (eq (car el) 'must)
                                   `',(cdr el) (cdr el)))
                             (nreverse newlist))))
818
	 (cons 'must
819 820 821
	       `(,@(mapcar #'cdr
                           (nreverse (if use-list* (cdr newlist) newlist)))
                 ,@(if use-list* (cdar newlist)))))))
822
    ((subrp value)
823 824
     (cons nil `(symbol-function
                 ',(intern-soft (substring (prin1-to-string value) 7 -1)))))
825
    ((markerp value)
826 827 828 829 830 831 832 833 834 835
     (let ((pos (marker-position value))
	   (buf (buffer-name (marker-buffer value))))
       (cons nil
             `(let ((mk (make-marker)))
                (add-hook 'desktop-delay-hook
                          `(lambda ()
                             (set-marker ,mk ,,pos (get-buffer ,,buf))))
                mk))))
    (t                                  ; Save as text.
     (cons 'may "Unprintable entity"))))
836

837
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
838
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
839 840
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
841 842
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
843 844 845 846 847
	 (quote.sexp (desktop--v2s value))
	 (quote (car quote.sexp))
	 (txt
          (let ((print-quoted t))
            (prin1-to-string (cdr quote.sexp)))))
848 849 850
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
851

852
;; ----------------------------------------------------------------------------
853 854 855
(defun desktop-outvar (varspec)
  "Output a setq statement for variable VAR to the desktop file.
The argument VARSPEC may be the variable name VAR (a symbol),
856
or a cons cell of the form (VAR . MAX-SIZE),
857 858 859 860 861 862
which means to truncate VAR's value to at most MAX-SIZE elements
\(if the value is a list) before saving the value."
  (let (var size)
    (if (consp varspec)
	(setq var (car varspec) size (cdr varspec))
      (setq var varspec))
863 864 865 866 867 868 869 870 871 872
    (when (boundp var)
      (when (and (integerp size)
		 (> size 0)
		 (listp (eval var)))
	(desktop-truncate (eval var) size))
      (insert "(setq "
	      (symbol-name var)
	      " "
	      (desktop-value-to-string (symbol-value var))
	      ")\n"))))
873

874
;; ----------------------------------------------------------------------------
875
(defun desktop-save-buffer-p (filename bufname mode &rest _dummy)
876
  "Return t if buffer should have its state saved in the desktop file.
877
FILENAME is the visited file name, BUFNAME is the buffer name, and
878 879
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
Glenn Morris's avatar
Glenn Morris committed
880
  (let ((case-fold-search nil)
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
	(no-regexp-to-check (not (stringp desktop-files-not-to-save)))
	dired-skip)
    (and (or filename
	     (not (stringp desktop-buffers-not-to-save))
	     (not (string-match-p desktop-buffers-not-to-save bufname)))
	 (not (memq mode desktop-modes-not-to-save))
	 (or (and filename
		  (or no-regexp-to-check
		      (not (string-match-p desktop-files-not-to-save filename))))
	     (and (memq mode '(dired-mode vc-dir-mode))
		  (or no-regexp-to-check
		      (not (setq dired-skip
				 (with-current-buffer bufname
				   (string-match-p desktop-files-not-to-save
						   default-directory))))))
	     (and (null filename)
		  (null dired-skip)  ; bug#5755
		  (with-current-buffer bufname desktop-save-buffer)))
	 t)))
900

901
;; ----------------------------------------------------------------------------
902 903 904 905 906 907 908 909 910 911 912 913 914 915
(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))))
916

Miles Bader's avatar
Miles Bader committed
917

918
;; ----------------------------------------------------------------------------
919 920 921 922 923 924 925
(defun desktop--check-dont-save (frame)
  (not (frame-parameter frame 'desktop-dont-save)))

(defconst desktop--app-id `(desktop . ,desktop-file-version))

(defun desktop-save-frameset ()
  "Save the state of existing frames in `desktop-saved-frameset'.
926
Frames with a non-nil `desktop-dont-save' parameter are not saved."
927
  (setq desktop-saved-frameset
928
	(and desktop-restore-frames
929 930 931 932
	     (frameset-save nil
			    :app desktop--app-id
			    :name (concat user-login-name "@" system-name)
			    :predicate #'desktop--check-dont-save))))
933

934
;;;###autoload
935
(defun desktop-save (dirname &optional release auto-save)
Kenichi Handa's avatar
Kenichi Handa committed
936 937
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
938
Optional parameter RELEASE says whether we're done with this desktop.
939 940
If AUTO-SAVE is non-nil, compare the saved contents to the one last saved,
and don't save the buffer if they are the same."
941 942 943 944 945 946 947
  (interactive (list
                ;; Or should we just use (car desktop-path)?
                (let ((default (if (member "." desktop-path)
                                   default-directory
                                 user-emacs-directory)))
                  (read-directory-name "Directory to save desktop file in: "
                                       default default t))))
948
  (setq desktop-dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
949
  (save-excursion
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
    (let ((eager desktop-restore-eager)
	  (new-modtime (nth 5 (file-attributes (desktop-full-file-name)))))
      (when
	  (or (not new-modtime)		; nothing to overwrite
	      (equal desktop-file-modtime new-modtime)
	      (yes-or-no-p (if desktop-file-modtime
			       (if (> (float-time new-modtime) (float-time desktop-file-modtime))
				   "Desktop file is more recent than the one loaded.  Save anyway? "
				 "Desktop file isn't the one loaded.  Overwrite it? ")
			     "Current desktop was not loaded from a file.  Overwrite this desktop file? "))
	      (unless release (error "Desktop file conflict")))

	;; If we're done with it, release the lock.
	;; Otherwise, claim it if it's unclaimed or if we created it.
	(if release
	    (desktop-release-lock)
	  (unless (and new-modtime (desktop-owner)) (desktop-claim-lock)))

	(with-temp-buffer
	  (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")
	  (save-excursion (run-hooks 'desktop-save-hook))
	  (goto-char (point-max))
	  (insert "\n;; Global section:\n")
978 979
	  ;; Called here because we save the window/frame state as a global
	  ;; variable for compatibility with previous Emacsen.
980 981 982
	  (desktop-save-frameset)
	  (unless (memq 'desktop-saved-frameset desktop-globals-to-save)
	    (desktop-outvar 'desktop-saved-frameset))
983
	  (mapc (function desktop-outvar) desktop-globals-to-save)
984
	  (setq desktop-saved-frameset nil) ; after saving desktop-globals-to-save
985 986 987 988 989 990 991 992
	  (when (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 "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
	  (dolist (l (mapcar 'desktop-buffer-info (buffer-list)))