desktop.el 75.8 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; desktop.el --- save partial status of Emacs when killed

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

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

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; 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
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24 25 26

;;; Commentary:

27 28 29 30 31 32 33 34
;; 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
35
;;		- some local variables
36
;;	- frame and window configuration
Richard M. Stallman's avatar
Richard M. Stallman committed
37

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

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

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

86
;; in the module itself, and make sure that the mode function is
87
;; autoloaded.  See the docstrings of `desktop-buffer-mode-handlers' and
88 89 90 91 92 93 94 95 96 97 98 99 100 101
;; `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
102
;; functions before writing `desktop-minor-modes'.  If a minor mode has a
103 104 105 106 107 108 109 110 111
;; 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.
;; ---------------------------------------------------------------------------
112

113 114 115 116
;; 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.

117 118 119
;; 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.
120

121 122 123 124 125
;; 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.
126
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
127
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
128 129 130 131 132
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134 135

;;; Code:

136 137
(require 'cl-lib)

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 156 157 158 159 160 161 162
  "Toggle desktop saving (Desktop Save mode).
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.

If Desktop Save mode is enabled, the state of Emacs is saved from
one session to another.  See variable `desktop-save' and function
`desktop-read' for details."
Kenichi Handa's avatar
Kenichi Handa committed
163 164 165
  :global t
  :group 'desktop)

166 167 168 169
(defun desktop-save-mode-off ()
  "Disable `desktop-save-mode'.  Provided for use in hooks."
  (desktop-save-mode 0))

170
(defcustom desktop-save 'ask-if-new
Lute Kamstra's avatar
Lute Kamstra committed
171
  "Specifies whether the desktop should be saved when it is killed.
Kenichi Handa's avatar
Kenichi Handa committed
172 173
A desktop is killed when the user changes desktop or quits Emacs.
Possible values are:
174 175 176 177 178 179
   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
180
The desktop is never saved when `desktop-save-mode' is nil.
181
The variables `desktop-dirname' and `desktop-base-file-name'
Kenichi Handa's avatar
Kenichi Handa committed
182
determine where the desktop is saved."
183 184
  :type
  '(choice
185 186 187 188 189 190
    (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))
191
  :group 'desktop
192
  :version "22.1")
193

194 195 196 197 198 199 200
(defcustom desktop-auto-save-timeout nil
  "Number of seconds between auto-saves of the desktop.
Zero or nil means disable timer-based auto-saving."
  :type '(choice (const :tag "Off" nil)
                 (integer :tag "Seconds"))
  :set (lambda (symbol value)
         (set-default symbol value)
201
         (ignore-errors (desktop-auto-save-set-timer)))
202 203 204
  :group 'desktop
  :version "24.4")

205 206 207 208 209 210 211 212 213 214 215 216 217 218
(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
219
  :version "22.2")
220

221 222 223
(define-obsolete-variable-alias 'desktop-basefilename
                                'desktop-base-file-name "22.1")

224
(defcustom desktop-base-file-name
225
  (convert-standard-filename ".emacs.desktop")
Kenichi Handa's avatar
Kenichi Handa committed
226
  "Name of file for Emacs desktop, excluding the directory part."
227 228
  :type 'file
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
229

230 231 232 233 234
(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
235
  :version "22.2")
236

Chong Yidong's avatar
Chong Yidong committed
237
(defcustom desktop-path (list user-emacs-directory "~")
238 239 240
  "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)
241
  :group 'desktop
242
  :version "23.2")                      ; user-emacs-directory added
243

244
(defcustom desktop-missing-file-warning nil
245
  "If non-nil, offer to recreate the buffer of a deleted file.
246 247 248 249
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."
250
  :type 'boolean
251
  :group 'desktop
252
  :version "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
253

254
(defcustom desktop-no-desktop-file-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
255
  "Normal hook run when `desktop-read' can't find a desktop file.
256
Run in the directory in which the desktop file was sought.
257
May be used to show a dired buffer."
258
  :type 'hook
259
  :group 'desktop
260
  :version "22.1")
261

262 263 264 265 266 267 268
(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)
269
  :version "22.2")
270

271
(defcustom desktop-after-read-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
272
  "Normal hook run after a successful `desktop-read'.
273
May be used to show a buffer list."
274
  :type 'hook
275
  :group 'desktop
276
  :options '(list-buffers)
277
  :version "22.1")
278 279

(defcustom desktop-save-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
280
  "Normal hook run before the desktop is saved in a desktop file.
281 282 283
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."
284 285 286
  :type 'hook
  :group 'desktop)

287 288 289 290 291 292
(defcustom desktop-globals-to-save
  '(desktop-missing-file-warning
    tags-file-name
    tags-table-list
    search-ring
    regexp-search-ring
293 294
    register-alist
    file-name-history)
Kenichi Handa's avatar
Kenichi Handa committed
295 296 297 298
  "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.
299 300 301 302
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
  :group 'desktop)

303 304 305 306 307 308 309
(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)
310
  "List of global variables that `desktop-clear' will clear.
311
An element may be variable name (a symbol) or a cons cell of the form
312 313
\(VAR . FORM).  Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluating FORM."
314
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
315
  :group 'desktop
316
  :version "22.1")
317

318
(defcustom desktop-clear-preserve-buffers
Glenn Morris's avatar
Glenn Morris committed
319 320
  '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*"
    "\\*Warnings\\*")
Lute Kamstra's avatar
Lute Kamstra committed
321
  "List of buffers that `desktop-clear' should not delete.
322 323
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
324
  :version "23.3"                       ; added Warnings - bug#6336
325 326
  :type '(repeat string)
  :group 'desktop)
327

328
;;;###autoload
329 330 331 332 333 334 335 336 337
(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
338 339 340 341
    column-number-mode
    size-indication-mode
    buffer-file-coding-system
    indent-tabs-mode
342
    tab-width
343 344 345
    indicate-buffer-boundaries
    indicate-empty-lines
    show-trailing-whitespace)
Richard M. Stallman's avatar
Richard M. Stallman committed
346
  "List of local variables to save for each buffer.
347 348
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
349 350
  :type '(repeat symbol)
  :group 'desktop)
351

352
(defcustom desktop-buffers-not-to-save nil
353
  "Regexp identifying buffers that are to be excluded from saving."
354 355
  :type '(choice (const :tag "None" nil)
		 regexp)
356
  :version "23.2"                       ; set to nil
357
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
358

Kenichi Handa's avatar
Kenichi Handa committed
359
;; Skip tramp and ange-ftp files
360
(defcustom desktop-files-not-to-save
361
  "\\(^/[^/:]*:\\|(ftp)$\\)"
362
  "Regexp identifying files whose buffers are to be excluded from saving."
363 364
  :type '(choice (const :tag "None" nil)
		 regexp)
365
  :group 'desktop)
366

367 368 369
;; We skip TAGS files to save time (tags-file-name is saved instead).
(defcustom desktop-modes-not-to-save
  '(tags-table-mode)
370 371 372 373
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

374
(defcustom desktop-restore-frames t
375 376 377 378 379
  "When non-nil, save window/frame configuration to desktop file."
  :type 'boolean
  :group 'desktop
  :version "24.4")

380
(defcustom desktop-restore-in-current-display nil
381 382 383 384 385 386 387 388 389
  "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)
		 (const :tag "Delete frames in other displays" 'delete))
  :group 'desktop
  :version "24.4")

390 391 392 393 394 395 396 397 398 399 400 401
(defcustom desktop-restore-forces-onscreen t
  "If t, offscreen frames are restored onscreen instead.
If `all', frames that are partially offscreen are also forced onscren.
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)
		 (const :tag "Also partially offscreen frames" 'all)
		 (const :tag "Do not force frames onscreen" nil))
  :group 'desktop
  :version "24.4")

402 403 404 405 406 407 408
(defcustom desktop-restoring-reuses-frames t
  "If t, restoring frames reuses existing frames.
If nil, existing frames are deleted.
If `keep', existing frames are kept and not reused."
  :type '(choice (const :tag "Reuse existing frames" t)
		 (const :tag "Delete existing frames" nil)
		 (const :tag "Keep existing frames" 'keep))
409 410 411
  :group 'desktop
  :version "24.4")

412 413 414 415 416 417 418
(defcustom desktop-before-saving-frames-functions nil
  "Abnormal hook run before saving frames.
Functions in this hook are called with one argument, a live frame."
  :type 'hook
  :group 'desktop
  :version "24.4")

419
(defcustom desktop-file-name-format 'absolute
Lute Kamstra's avatar
Lute Kamstra committed
420
  "Format in which desktop file names should be saved.
421 422 423 424 425
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))
426
  :group 'desktop
427
  :version "22.1")
428

429 430 431 432
(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."
433
  :type '(choice (const t) integer)
434
  :group 'desktop
435
  :version "22.1")
436 437 438 439 440

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
441
  :version "22.1")
442 443 444 445 446 447

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

450
;;;###autoload
451
(defvar-local desktop-save-buffer nil
452 453
  "When non-nil, save buffer status in desktop file.

454 455
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
456
file along with the state of the buffer for which it was called.
457

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

461 462 463
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'.")
464
(make-obsolete-variable 'desktop-buffer-modes-to-save
465
                        'desktop-save-buffer "22.1")
466
(make-obsolete-variable 'desktop-buffer-misc-functions
467
                        'desktop-save-buffer "22.1")
468

469
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
470
(defvar desktop-buffer-mode-handlers nil
471
  "Alist of major mode specific functions to restore a desktop buffer.
472 473 474 475
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).
476 477 478 479

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

480
Handlers are called with argument list
481

482
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
483 484

Furthermore, they may use the following variables:
485 486 487 488 489 490 491 492 493

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

494
If a handler returns a buffer, then the saved mode settings
495 496 497 498
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
499

500 501 502 503 504 505
   (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.")
506

507
;;;###autoload
508 509
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
510
                        'desktop-buffer-mode-handlers "22.1")
511

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

529
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
530
(defvar desktop-minor-mode-handlers nil
531 532 533 534 535 536 537 538 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
  "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'.")

572
;;;###autoload
573 574
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

575 576
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Kenichi Handa's avatar
Kenichi Handa committed
577
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
578

579 580 581 582 583
(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)))

584 585 586 587 588
(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
589
(defconst desktop-header
590 591 592
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
593
" "*Header to place in Desktop file.")
594 595 596

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

598 599 600 601
(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.")

602 603 604
(defvar desktop-saved-frame-states nil
  "Saved state of all frames.
Only valid during frame saving & restoring; intended for internal use.")
605

606 607 608 609 610 611 612 613 614 615
;; ----------------------------------------------------------------------------
;; 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'."
616 617 618 619 620 621 622 623 624
  (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)))
625 626 627 628 629 630 631 632 633 634 635 636 637 638
	 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))))

639
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
640
(defun desktop-truncate (list n)
641
  "Truncate LIST to at most N elements destructively."
Kenichi Handa's avatar
Kenichi Handa committed
642
  (let ((here (nthcdr (1- n) list)))
643 644
    (when (consp here)
      (setcdr here nil))))
645

646
;; ----------------------------------------------------------------------------
647
;;;###autoload
648 649
(defun desktop-clear ()
  "Empty the Desktop.
650 651 652
This kills all buffers except for internal ones and those with names matched by
a regular expression in the list `desktop-clear-preserve-buffers'.
Furthermore, it clears the variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
653
  (interactive)
654
  (desktop-lazy-abort)
655 656
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
657
	(eval `(setq-default ,var nil))
658
      (eval `(setq-default ,(car var) ,(cdr var)))))
659
  (let ((preserve-regexp (concat "^\\("
660 661 662 663 664
                                 (mapconcat (lambda (regexp)
                                              (concat "\\(" regexp "\\)"))
                                            desktop-clear-preserve-buffers
                                            "\\|")
                                 "\\)$")))
665 666
    (dolist (buffer (buffer-list))
      (let ((bufname (buffer-name buffer)))
667
	(unless (or (eq (aref bufname 0) ?\s) ;; Don't kill internal buffers
668 669
		    (string-match-p preserve-regexp bufname))
	  (kill-buffer buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
670
  (delete-other-windows))
671

672
;; ----------------------------------------------------------------------------
Juanma Barranquero's avatar
Juanma Barranquero committed
673 674
(unless noninteractive
  (add-hook 'kill-emacs-hook 'desktop-kill))
675

Richard M. Stallman's avatar
Richard M. Stallman committed
676
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
677
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
678 679
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
680 681 682
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
683 684 685 686
                   (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))
687 688 689 690
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
691 692
    (unless desktop-dirname
      (setq desktop-dirname
693 694
            (file-name-as-directory
             (expand-file-name
695
	      (read-directory-name "Directory for desktop file: " nil nil t)))))
696
    (condition-case err
697
	(desktop-save desktop-dirname t)
698
      (file-error
699
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
700 701 702
	 (signal (car err) (cdr err))))))
  ;; If we own it, we don't anymore.
  (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
703

704
;; ----------------------------------------------------------------------------
705
(defun desktop-list* (&rest args)
706
  (and args (apply #'cl-list* args)))
707

708 709 710 711
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
  (set-buffer buffer)
  (list
712 713
   ;; base name of the buffer; replaces the buffer name if managed by uniquify
   (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
714
   ;; basic information
715
   (desktop-file-name (buffer-file-name) desktop-dirname)
716
   (buffer-name)
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
   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)
736
     (funcall desktop-save-buffer desktop-dirname))
737
   ;; local variables
738 739 740 741 742 743 744 745
   (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)))))
746 747
     ll)))

748
;; ----------------------------------------------------------------------------
749 750 751
(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
752
QUOTE may be `may' (value may be quoted),
753
`must' (value must be quoted), or nil (value must not be quoted)."
754
  (cond
755
    ((or (numberp value) (null value) (eq t value) (keywordp value))
756
     (cons 'may value))
757 758 759
    ((stringp value)
     (let ((copy (copy-sequence value)))
       (set-text-properties 0 (length copy) nil copy)
760 761
       ;; Get rid of text properties because we cannot read them.
       (cons 'may copy)))
762
    ((symbolp value)
763
     (cons 'must value))
764
    ((vectorp value)
765 766
     (let* ((pass1 (mapcar #'desktop--v2s value))
	    (special (assq nil pass1)))
767
       (if special
768 769 770 771 772 773
	   (cons nil `(vector
                       ,@(mapcar (lambda (el)
                                   (if (eq (car el) 'must)
                                       `',(cdr el) (cdr el)))
                                 pass1)))
	 (cons 'may `[,@(mapcar #'cdr pass1)]))))
774 775 776
    ((consp value)
     (let ((p value)
	   newlist
777
	   use-list*)
778
       (while (consp p)
779 780
	 (let ((q.sexp (desktop--v2s (car p))))
           (push q.sexp newlist))
781
	 (setq p (cdr p)))
782 783 784 785 786
       (when p
         (let ((last (desktop--v2s p)))
           (setq use-list* t)
           (push last newlist)))
       (if (assq nil newlist)
787
	   (cons nil
788 789 790 791 792
		 `(,(if use-list* 'desktop-list* 'list)
                   ,@(mapcar (lambda (el)
                               (if (eq (car el) 'must)
                                   `',(cdr el) (cdr el)))
                             (nreverse newlist))))
793
	 (cons 'must
794 795 796
	       `(,@(mapcar #'cdr
                           (nreverse (if use-list* (cdr newlist) newlist)))
                 ,@(if use-list* (cdar newlist)))))))
797
    ((subrp value)
798 799
     (cons nil `(symbol-function
                 ',(intern-soft (substring (prin1-to-string value) 7 -1)))))
800
    ((markerp value)
801 802 803 804 805 806 807 808 809 810
     (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"))))
811

812
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
813
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
814 815
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
816 817
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
818 819 820 821 822
	 (quote.sexp (desktop--v2s value))
	 (quote (car quote.sexp))
	 (txt
          (let ((print-quoted t))
            (prin1-to-string (cdr quote.sexp)))))
823 824 825
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
826

827
;; ----------------------------------------------------------------------------
828 829 830
(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),
831
or a cons cell of the form (VAR . MAX-SIZE),
832 833 834 835 836 837
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))
838 839 840 841 842 843 844 845 846 847
    (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"))))
848

849
;; ----------------------------------------------------------------------------
850
(defun desktop-save-buffer-p (filename bufname mode &rest _dummy)
851
  "Return t if buffer should have its state saved in the desktop file.
852
FILENAME is the visited file name, BUFNAME is the buffer name, and
853 854
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
Glenn Morris's avatar
Glenn Morris committed
855 856
  (let ((case-fold-search nil)
        dired-skip)
857 858
    (and (not (and (stringp desktop-buffers-not-to-save)
		   (not filename)
859
		   (string-match-p desktop-buffers-not-to-save bufname)))
860
         (not (memq mode desktop-modes-not-to-save))
Glenn Morris's avatar
Glenn Morris committed
861
         ;; FIXME this is broken if desktop-files-not-to-save is nil.
862
         (or (and filename
863
		  (stringp desktop-files-not-to-save)
864
                  (not (string-match-p desktop-files-not-to-save filename)))
865
             (and (memq mode '(dired-mode vc-dir-mode))
866
                  (with-current-buffer bufname
Glenn Morris's avatar
Glenn Morris committed
867
                    (not (setq dired-skip
868 869
                               (string-match-p desktop-files-not-to-save
                                               default-directory)))))
870
             (and (null filename)
Glenn Morris's avatar
Glenn Morris committed
871
                  (null dired-skip)     ; bug#5755
872
		  (with-current-buffer bufname desktop-save-buffer))))))
873

874
;; ----------------------------------------------------------------------------
875 876 877 878 879 880 881 882 883 884 885 886 887 888
(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))))
889

Miles Bader's avatar
Miles Bader committed
890

891
;; ----------------------------------------------------------------------------
892
(defvar desktop-filter-parameters-alist
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
  '((background-color	 . desktop--filter-*-color)
    (buffer-list	 . t)
    (buffer-predicate	 . t)
    (buried-buffer-list  . t)
    (desktop--font	 . desktop--filter-restore-desktop-parm)
    (desktop--fullscreen . desktop--filter-restore-desktop-parm)
    (desktop--height	 . desktop--filter-restore-desktop-parm)
    (desktop--width	 . desktop--filter-restore-desktop-parm)
    (font		 . desktop--filter-save-desktop-parm)
    (font-backend	 . t)
    (foreground-color	 . desktop--filter-*-color)
    (fullscreen		 . desktop--filter-save-desktop-parm)
    (height		 . desktop--filter-save-desktop-parm)
    (left		 . desktop--filter-iconified-position)
    (minibuffer		 . desktop--filter-minibuffer)
    (name		 . t)
    (outer-window-id	 . t)
    (parent-id		 . t)
    (top		 . desktop--filter-iconified-position)
    (tty		 . desktop--filter-tty*)
    (tty-type		 . desktop--filter-tty*)
    (width		 . desktop--filter-save-desktop-parm)
    (window-id		 . t)
    (window-system	 . t))
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 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 978 979 980 981 982 983 984 985 986
  "Alist of frame parameters and filtering functions.

Each element is a cons (PARAM . FILTER), where PARAM is a parameter
name (a symbol identifying a frame parameter), and FILTER can be t
\(meaning the parameter is removed from the parameter list on saving
and restoring), or a function that will be called with three args:

 CURRENT     a cons (PARAM . VALUE), where PARAM is the one being
             filtered and VALUE is its current value
 PARAMETERS  the complete alist of parameters being filtered
 SAVING      non-nil if filtering before saving state, nil otherwise

The FILTER function must return:
 nil                  CURRENT is removed from the list
 t                    CURRENT is left as is
 (PARAM' . VALUE')    replace CURRENT with this

Frame parameters not on this list are passed intact.")

(defvar desktop--target-display nil
  "Either (minibuffer . VALUE) or nil.
This refers to the current frame config being processed inside
`frame--restore-frames' and its auxiliary functions (like filtering).
If nil, there is no need to change the display.
If non-nil, display parameter to use when creating the frame.
Internal use only.")

(defun desktop-switch-to-gui-p (parameters)
  "True when switching to a graphic display.
Return t if PARAMETERS describes a text-only terminal and
the target is a graphic display; otherwise return nil.
Only meaningful when called from a filtering function in
`desktop-filter-parameters-alist'."
  (and desktop--target-display		       ; we're switching
       (null (cdr (assq 'display parameters))) ; from a tty
       (cdr desktop--target-display)))	       ; to a GUI display

(defun desktop-switch-to-tty-p (parameters)
  "True when switching to a text-only terminal.
Return t if PARAMETERS describes a graphic display and
the target is a text-only terminal; otherwise return nil.
Only meaningful when called from a filtering function in
`desktop-filter-parameters-alist'."
  (and desktop--target-display		       ; we're switching
       (cdr (assq 'display parameters))	       ; from a GUI display
       (null (cdr desktop--target-display))))  ; to a tty

(defun desktop--filter-tty* (_current parameters saving)
  ;; Remove tty and tty-type parameters when switching
  ;; to a GUI frame.
  (or saving
      (not (desktop-switch-to-gui-p parameters))))

(defun desktop--filter-*-color (current parameters saving)
  ;; Remove (foreground|background)-color parameters
  ;; when switching to a GUI frame if they denote an
  ;; "unspecified" color.
  (or saving
      (not (desktop-switch-to-gui-p parameters))
      (not (stringp (cdr current)))
      (not (string-match-p "^unspecified-[fb]g$" (cdr current)))))

(defun desktop--filter-minibuffer (current _parameters saving)
  ;; When minibuffer is a window, save it as minibuffer . t
  (or (not saving)
      (if (windowp (cdr current))
	  '(minibuffer . t)
	t)))

(defun desktop--filter-restore-desktop-parm (current parameters saving)
987
  ;; When switching to a GUI frame, convert desktop--XXX parameter to XXX
988 989 990 991 992 993
  (or saving
      (not (desktop-switch-to-gui-p parameters))
      (let ((val (cdr current)))
	(if (eq val :desktop-processed)
	    nil
	  (cons (intern (substring (symbol-name (car current))
994
				   9)) ;; (length "desktop--")
995 996 997
		val)))))

(defun desktop--filter-save-desktop-parm (current parameters saving)
998
  ;; When switching to a tty frame, save parameter XXX as desktop--XXX so it
999 1000 1001
  ;; can be restored in a subsequent GUI session, unless it already exists.
  (cond (saving t)
	((desktop-switch-to-tty-p parameters)
1002
	 (let ((sym (intern (format "desktop--%s" (car current)))))
1003 1004 1005 1006
	   (if (assq sym parameters)
	       nil
	     (cons sym (cdr current)))))
	((desktop-switch-to-gui-p parameters)
1007
	 (let* ((dtp (assq (intern (format "desktop--%s" (car current)))
1008 1009 1010 1011 1012 1013 1014 1015
			   parameters))
		(val (cdr dtp)))
	   (if (eq val :desktop-processed)
	       nil
	     (setcdr dtp :desktop-processed)
	     (cons (car current) val))))
	(t t)))

1016 1017 1018 1019 1020
(defun desktop--filter-iconified-position (_current parameters saving)
  ;; When saving an iconified frame, top & left are meaningless,
  ;; so remove them to allow restoring to a default position.
  (not (and saving (eq (cdr (assq 'visibility parameters)) 'icon))))

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
(defun desktop-restore-in-original-display-p ()
  "True if saved frames' displays should be honored."
  (cond ((daemonp) t)
	((eq system-type 'windows-nt) nil)
	(t (null desktop-restore-in-current-display))))

(defun desktop--filter-frame-parms (parameters saving)
  "Filter frame parameters and return filtered list.
PARAMETERS is a parameter alist as returned by `frame-parameters'.
If SAVING is non-nil, filtering is happening before saving frame state;
otherwise, filtering is being done before restoring frame state.
Parameters are filtered according to the setting of
`desktop-filter-parameters-alist' (which see).
1034
Internal use only."
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
  (let ((filtered nil))
    (dolist (param parameters)
      (let ((filter (cdr (assq (car param) desktop-filter-parameters-alist)))
	    this)
	(cond (;; no filter: pass param
	       (null filter)
	       (push param filtered))
	      (;; filter = t; skip param
	       (eq filter t))
	      (;; filter func returns nil: skip param
	       (null (setq this (funcall filter param