desktop.el 56 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

3 4
;; Copyright (C) 1993-1995, 1997, 2000-2014 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.
Glenn Morris's avatar
Glenn Morris committed
127
;;            pot@cnuce.cnr.it (Francesco Potortì)  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
(require 'cl-lib)
137
(require 'frameset)
138

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

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

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

152 153
;; Maintained for backward compatibility
(define-obsolete-variable-alias 'desktop-enable 'desktop-save-mode "22.1")
Kenichi Handa's avatar
Kenichi Handa committed
154 155
;;;###autoload
(define-minor-mode desktop-save-mode
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
163
`desktop-read' for details."
Kenichi Handa's avatar
Kenichi Handa committed
164
  :global t
165 166 167 168
  :group 'desktop
  (if desktop-save-mode
      (desktop-auto-save-set-timer)
    (desktop-auto-save-cancel-timer)))
Kenichi Handa's avatar
Kenichi Handa committed
169

170 171 172 173
(defun desktop-save-mode-off ()
  "Disable `desktop-save-mode'.  Provided for use in hooks."
  (desktop-save-mode 0))

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

198 199 200
(defcustom desktop-auto-save-timeout auto-save-timeout
  "Number of seconds idle time before auto-save of the desktop.
Zero or nil means disable auto-saving due to idleness."
201 202 203 204
  :type '(choice (const :tag "Off" nil)
                 (integer :tag "Seconds"))
  :set (lambda (symbol value)
         (set-default symbol value)
205
         (ignore-errors (desktop-auto-save-set-timer)))
206 207 208
  :group 'desktop
  :version "24.4")

209 210 211 212 213 214 215 216 217 218 219 220 221 222
(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
223
  :version "22.2")
224

225 226 227
(define-obsolete-variable-alias 'desktop-basefilename
                                'desktop-base-file-name "22.1")

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

234 235 236 237 238
(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
239
  :version "22.2")
240

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

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

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

266 267 268 269 270 271 272
(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)
273
  :version "22.2")
274

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

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

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

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

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

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

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

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

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

378
(defcustom desktop-restore-frames t
379
  "When non-nil, save frames to desktop file."
380 381 382 383
  :type 'boolean
  :group 'desktop
  :version "24.4")

384
(defcustom desktop-restore-in-current-display nil
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)
Glenn Morris's avatar
Glenn Morris committed
390
		 (const :tag "Delete frames in other displays" delete))
391 392 393
  :group 'desktop
  :version "24.4")

394 395
(defcustom desktop-restore-forces-onscreen t
  "If t, offscreen frames are restored onscreen instead.
Paul Eggert's avatar
Paul Eggert committed
396
If `:all', frames that are partially offscreen are also forced onscreen.
397 398 399 400
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)
401
		 (const :tag "Also partially offscreen frames" :all)
402 403 404 405
		 (const :tag "Do not force frames onscreen" nil))
  :group 'desktop
  :version "24.4")

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

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

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

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

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

447
;;;###autoload
448
(defvar-local desktop-save-buffer nil
449 450
  "When non-nil, save buffer status in desktop file.

451 452
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
453
file along with the state of the buffer for which it was called.
454

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

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

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

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

477
Handlers are called with argument list
478

479
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
480 481

Furthermore, they may use the following variables:
482 483 484 485 486 487 488 489 490

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

491
If a handler returns a buffer, then the saved mode settings
492 493 494 495
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
496

497 498 499 500 501 502
   (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.")
503

504
;;;###autoload
505 506
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
507
                        'desktop-buffer-mode-handlers "22.1")
508

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

526
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
527
(defvar desktop-minor-mode-handlers nil
528 529 530 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
  "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'.")

569
;;;###autoload
570 571
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

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

576 577 578 579 580
(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)))

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

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

595 596 597 598
(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.")

599
(defvar desktop-saved-frameset nil
600 601
  "Saved state of all frames.
Only valid during frame saving & restoring; intended for internal use.")
602

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

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

643
;; ----------------------------------------------------------------------------
644
;;;###autoload
645 646
(defun desktop-clear ()
  "Empty the Desktop.
647 648
This kills all buffers except for internal ones and those with names matched by
a regular expression in the list `desktop-clear-preserve-buffers'.
649 650 651 652
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
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)))))
670
  (delete-other-windows)
671 672 673 674 675
  (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
676
	   (mini (window-frame (minibuffer-window this)))) ; in case they differ
677
      (dolist (frame (sort (frame-list) #'frameset-minibufferless-first-p))
678 679 680 681 682 683 684
	(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))))))))
685

686
;; ----------------------------------------------------------------------------
Juanma Barranquero's avatar
Juanma Barranquero committed
687 688
(unless noninteractive
  (add-hook 'kill-emacs-hook 'desktop-kill))
689

Richard M. Stallman's avatar
Richard M. Stallman committed
690
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
691
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
692 693
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
694 695 696
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
697 698 699 700
                   (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))
701 702 703 704
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
705 706
    (unless desktop-dirname
      (setq desktop-dirname
707 708
            (file-name-as-directory
             (expand-file-name
709
	      (read-directory-name "Directory for desktop file: " nil nil t)))))
710
    (condition-case err
711
	(desktop-save desktop-dirname t)
712
      (file-error
713
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
714 715 716
	 (signal (car err) (cdr err))))))
  ;; If we own it, we don't anymore.
  (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
717

718
;; ----------------------------------------------------------------------------
719
(defun desktop-list* (&rest args)
720
  (and args (apply #'cl-list* args)))
721

722 723 724 725
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
  (set-buffer buffer)
  (list
726 727
   ;; base name of the buffer; replaces the buffer name if managed by uniquify
   (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
728
   ;; basic information
729
   (desktop-file-name (buffer-file-name) desktop-dirname)
730
   (buffer-name)
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
   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)
750
     (funcall desktop-save-buffer desktop-dirname))
751
   ;; local variables
752 753 754 755 756 757 758 759
   (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)))))
760 761
     ll)))

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

826
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
827
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
828 829
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
830 831
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
832 833 834 835 836
	 (quote.sexp (desktop--v2s value))
	 (quote (car quote.sexp))
	 (txt
          (let ((print-quoted t))
            (prin1-to-string (cdr quote.sexp)))))
837 838 839
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
840

841
;; ----------------------------------------------------------------------------
842 843 844
(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),
845
or a cons cell of the form (VAR . MAX-SIZE),
846 847 848 849 850 851
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))
852 853 854 855 856 857 858 859 860 861
    (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"))))
862

863
;; ----------------------------------------------------------------------------
864
(defun desktop-save-buffer-p (filename bufname mode &rest _dummy)
865
  "Return t if buffer should have its state saved in the desktop file.
866
FILENAME is the visited file name, BUFNAME is the buffer name, and
867 868
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
Glenn Morris's avatar
Glenn Morris committed
869 870
  (let ((case-fold-search nil)
        dired-skip)
871 872
    (and (not (and (stringp desktop-buffers-not-to-save)
		   (not filename)
873
		   (string-match-p desktop-buffers-not-to-save bufname)))
874
         (not (memq mode desktop-modes-not-to-save))
Glenn Morris's avatar
Glenn Morris committed
875
         ;; FIXME this is broken if desktop-files-not-to-save is nil.
876
         (or (and filename
877
		  (stringp desktop-files-not-to-save)
878
                  (not (string-match-p desktop-files-not-to-save filename)))
879
             (and (memq mode '(dired-mode vc-dir-mode))
880
                  (with-current-buffer bufname
Glenn Morris's avatar
Glenn Morris committed
881
                    (not (setq dired-skip
882 883
                               (string-match-p desktop-files-not-to-save
                                               default-directory)))))
884
             (and (null filename)
Glenn Morris's avatar
Glenn Morris committed
885
                  (null dired-skip)     ; bug#5755
886
		  (with-current-buffer bufname desktop-save-buffer))))))
887

888
;; ----------------------------------------------------------------------------
889 890 891 892 893 894 895 896 897 898 899 900 901 902
(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))))
903

Miles Bader's avatar
Miles Bader committed
904

905
;; ----------------------------------------------------------------------------
906 907 908 909 910 911 912
(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'.
913
Frames with a non-nil `desktop-dont-save' parameter are not saved."
914
  (setq desktop-saved-frameset
915
	(and desktop-restore-frames
916 917 918 919
	     (frameset-save nil
			    :app desktop--app-id
			    :name (concat user-login-name "@" system-name)
			    :predicate #'desktop--check-dont-save))))
920

921
;;;###autoload
922
(defun desktop-save (dirname &optional release auto-save)
Kenichi Handa's avatar
Kenichi Handa committed
923 924
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
925
Optional parameter RELEASE says whether we're done with this desktop.
926 927
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."
928 929 930 931 932 933 934
  (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))))
935
  (setq desktop-dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
936
  (save-excursion
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
    (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")
965 966
	  ;; Called here because we save the window/frame state as a global
	  ;; variable for compatibility with previous Emacsen.
967 968 969
	  (desktop-save-frameset)
	  (unless (memq 'desktop-saved-frameset desktop-globals-to-save)
	    (desktop-outvar 'desktop-saved-frameset))