desktop.el 51.5 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
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.
126
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
127 128 129 130 131 132
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Save window configuration.
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134 135

;;; Code:

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

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

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

149 150
;; Maintained for backward compatibility
(define-obsolete-variable-alias 'desktop-enable 'desktop-save-mode "22.1")
Kenichi Handa's avatar
Kenichi Handa committed
151 152
;;;###autoload
(define-minor-mode desktop-save-mode
153 154 155 156 157 158 159 160
  "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
161 162 163
  :global t
  :group 'desktop)

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

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

192 193 194 195 196 197 198 199 200 201 202 203 204
(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)
         (condition-case nil
	     (desktop-auto-save-set-timer)
	   (error nil)))
  :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-file-name-format 'absolute
Lute Kamstra's avatar
Lute Kamstra committed
375
  "Format in which desktop file names should be saved.
376 377 378 379 380
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))
381
  :group 'desktop
382
  :version "22.1")
383

384 385 386 387
(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."
388
  :type '(choice (const t) integer)
389
  :group 'desktop
390
  :version "22.1")
391 392 393 394 395

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
396
  :version "22.1")
397 398 399 400 401 402

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

405
;;;###autoload
406 407
(defvar desktop-save-buffer nil
  "When non-nil, save buffer status in desktop file.
408
This variable becomes buffer local when set.
409

410 411
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
412
file along with the state of the buffer for which it was called.
413

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

417 418 419
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'.")
420 421
(make-variable-buffer-local 'desktop-save-buffer)
(make-obsolete-variable 'desktop-buffer-modes-to-save
422
                        'desktop-save-buffer "22.1")
423
(make-obsolete-variable 'desktop-buffer-misc-functions
424
                        'desktop-save-buffer "22.1")
425

426
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
427
(defvar desktop-buffer-mode-handlers nil
428
  "Alist of major mode specific functions to restore a desktop buffer.
429 430 431 432
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).
433 434 435 436

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

437
Handlers are called with argument list
438

439
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
440 441

Furthermore, they may use the following variables:
442 443 444 445 446 447 448 449 450

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

451
If a handler returns a buffer, then the saved mode settings
452 453 454 455
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
456

457 458 459 460 461 462
   (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.")
463

464
;;;###autoload
465 466
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
467
                        'desktop-buffer-mode-handlers "22.1")
468

469 470
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
471
    (vc-mode nil)
472
    (vc-dired-mode nil)
473 474
    (erc-track-minor-mode nil)
    (savehist-mode nil))
475 476 477 478
  "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.
479
RESTORE-FUNCTION nil means don't try to restore the minor mode.
480
Only minor modes for which the name of the buffer-local variable
481
and the name of the minor mode function are different have to be added to
482
this table.  See also `desktop-minor-mode-handlers'."
483 484 485
  :type 'sexp
  :group 'desktop)

486
;;;###autoload
Chong Yidong's avatar
Chong Yidong committed
487
(defvar desktop-minor-mode-handlers nil
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
  "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'.")

529
;;;###autoload
530 531
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

532 533
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Kenichi Handa's avatar
Kenichi Handa committed
534
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
535

536 537 538 539 540
(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)))

541 542 543 544 545
(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
546
(defconst desktop-header
547 548 549
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
550
" "*Header to place in Desktop file.")
551 552 553

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

555 556 557 558
(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.")

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
;; ----------------------------------------------------------------------------
;; 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'."
  (let (owner)
    (and (file-exists-p (desktop-full-lock-name dirname))
	 (condition-case nil
	     (with-temp-buffer
	       (insert-file-contents-literally (desktop-full-lock-name dirname))
	       (goto-char (point-min))
	       (setq owner (read (current-buffer)))
	       (integerp owner))
	   (error nil))
	 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))))

592
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
593
(defun desktop-truncate (list n)
594
  "Truncate LIST to at most N elements destructively."
Kenichi Handa's avatar
Kenichi Handa committed
595
  (let ((here (nthcdr (1- n) list)))
596 597
    (when (consp here)
      (setcdr here nil))))
598

599
;; ----------------------------------------------------------------------------
600
;;;###autoload
601 602
(defun desktop-clear ()
  "Empty the Desktop.
603 604 605
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
606
  (interactive)
607
  (desktop-lazy-abort)
608 609
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
610
	(eval `(setq-default ,var nil))
611
      (eval `(setq-default ,(car var) ,(cdr var)))))
612 613 614 615 616 617 618
  (let ((buffers (buffer-list))
        (preserve-regexp (concat "^\\("
                                 (mapconcat (lambda (regexp)
                                              (concat "\\(" regexp "\\)"))
                                            desktop-clear-preserve-buffers
                                            "\\|")
                                 "\\)$")))
619
    (while buffers
620 621 622
      (let ((bufname (buffer-name (car buffers))))
         (or
           (null bufname)
623
           (string-match preserve-regexp bufname)
624
           ;; Don't kill buffers made for internal purposes.
625
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\s))
626
           (kill-buffer (car buffers))))
627
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
628
  (delete-other-windows))
629

630
;; ----------------------------------------------------------------------------
Juanma Barranquero's avatar
Juanma Barranquero committed
631 632
(unless noninteractive
  (add-hook 'kill-emacs-hook 'desktop-kill))
633

Richard M. Stallman's avatar
Richard M. Stallman committed
634
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
635
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
636 637
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
638 639 640
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
641 642 643 644
                   (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))
645 646 647 648
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
649 650
    (unless desktop-dirname
      (setq desktop-dirname
651 652
            (file-name-as-directory
             (expand-file-name
653
	      (read-directory-name "Directory for desktop file: " nil nil t)))))
654
    (condition-case err
655
	(desktop-save desktop-dirname t)
656
      (file-error
657
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
658 659 660
	 (signal (car err) (cdr err))))))
  ;; If we own it, we don't anymore.
  (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
661

662
;; ----------------------------------------------------------------------------
663 664 665 666 667 668 669 670 671 672 673
(defun desktop-list* (&rest args)
  (if (null (cdr args))
      (car args)
    (setq args (nreverse args))
    (let ((value (cons (nth 1 args) (car args))))
      (setq args (cdr (cdr args)))
      (while args
	(setq value (cons (car args) value))
	(setq args (cdr args)))
      value)))

674 675 676 677
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
  (set-buffer buffer)
  (list
678 679
   ;; base name of the buffer; replaces the buffer name if managed by uniquify
   (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
680
   ;; basic information
681
   (desktop-file-name (buffer-file-name) desktop-dirname)
682
   (buffer-name)
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
   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)
702
     (funcall desktop-save-buffer desktop-dirname))
703 704 705 706 707 708 709 710 711 712 713 714 715
   ;; local variables
   (let ((locals desktop-locals-to-save)
	 (loclist (buffer-local-variables))
	 (ll))
     (while locals
       (let ((here (assq (car locals) loclist)))
	 (if here
	     (setq ll (cons here ll))
	   (when (member (car locals) loclist)
	     (setq ll (cons (car locals) ll)))))
       (setq locals (cdr locals)))
     ll)))

716
;; ----------------------------------------------------------------------------
717 718 719
(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
720
QUOTE may be `may' (value may be quoted),
721
`must' (value must be quoted), or nil (value must not be quoted)."
722
  (cond
723
    ((or (numberp value) (null value) (eq t value) (keywordp value))
724
     (cons 'may value))
725 726 727
    ((stringp value)
     (let ((copy (copy-sequence value)))
       (set-text-properties 0 (length copy) nil copy)
728 729
       ;; Get rid of text properties because we cannot read them.
       (cons 'may copy)))
730
    ((symbolp value)
731
     (cons 'must value))
732
    ((vectorp value)
733 734
     (let* ((pass1 (mapcar #'desktop--v2s value))
	    (special (assq nil pass1)))
735
       (if special
736 737 738 739 740 741
	   (cons nil `(vector
                       ,@(mapcar (lambda (el)
                                   (if (eq (car el) 'must)
                                       `',(cdr el) (cdr el)))
                                 pass1)))
	 (cons 'may `[,@(mapcar #'cdr pass1)]))))
742 743 744 745 746 747
    ((consp value)
     (let ((p value)
	   newlist
	   use-list*
	   anynil)
       (while (consp p)
748 749
	 (let ((q.sexp (desktop--v2s (car p))))
           (push q.sexp newlist))
750
	 (setq p (cdr p)))
751 752 753 754 755
       (when p
         (let ((last (desktop--v2s p)))
           (setq use-list* t)
           (push last newlist)))
       (if (assq nil newlist)
756
	   (cons nil
757 758 759 760 761
		 `(,(if use-list* 'desktop-list* 'list)
                   ,@(mapcar (lambda (el)
                               (if (eq (car el) 'must)
                                   `',(cdr el) (cdr el)))
                             (nreverse newlist))))
762
	 (cons 'must
763 764 765
	       `(,@(mapcar #'cdr
                           (nreverse (if use-list* (cdr newlist) newlist)))
                 ,@(if use-list* (cdar newlist)))))))
766
    ((subrp value)
767 768
     (cons nil `(symbol-function
                 ',(intern-soft (substring (prin1-to-string value) 7 -1)))))
769
    ((markerp value)
770 771 772 773 774 775 776 777 778 779
     (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"))))
780

781
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
782
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
783 784
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
785 786
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
787 788 789 790 791
	 (quote.sexp (desktop--v2s value))
	 (quote (car quote.sexp))
	 (txt
          (let ((print-quoted t))
            (prin1-to-string (cdr quote.sexp)))))
792 793 794
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
795

796
;; ----------------------------------------------------------------------------
797 798 799
(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),
800
or a cons cell of the form (VAR . MAX-SIZE),
801 802 803 804 805 806
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))
807 808 809 810 811 812 813 814 815 816
    (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"))))
817

818
;; ----------------------------------------------------------------------------
819
(defun desktop-save-buffer-p (filename bufname mode &rest _dummy)
820
  "Return t if buffer should have its state saved in the desktop file.
821
FILENAME is the visited file name, BUFNAME is the buffer name, and
822 823
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
Glenn Morris's avatar
Glenn Morris committed
824 825
  (let ((case-fold-search nil)
        dired-skip)
826 827 828
    (and (not (and (stringp desktop-buffers-not-to-save)
		   (not filename)
		   (string-match desktop-buffers-not-to-save bufname)))
829
         (not (memq mode desktop-modes-not-to-save))
Glenn Morris's avatar
Glenn Morris committed
830
         ;; FIXME this is broken if desktop-files-not-to-save is nil.
831
         (or (and filename
832
		  (stringp desktop-files-not-to-save)
833
                  (not (string-match desktop-files-not-to-save filename)))
834
             (and (memq mode '(dired-mode vc-dir-mode))
835
                  (with-current-buffer bufname
Glenn Morris's avatar
Glenn Morris committed
836 837 838
                    (not (setq dired-skip
                               (string-match desktop-files-not-to-save
                                             default-directory)))))
839
             (and (null filename)
Glenn Morris's avatar
Glenn Morris committed
840
                  (null dired-skip)     ; bug#5755
841
		  (with-current-buffer bufname desktop-save-buffer))))))
842

843
;; ----------------------------------------------------------------------------
844 845 846 847 848 849 850 851 852 853 854 855 856 857
(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))))
858

Miles Bader's avatar
Miles Bader committed
859

860
;; ----------------------------------------------------------------------------
861
;;;###autoload
862
(defun desktop-save (dirname &optional release auto-save)
Kenichi Handa's avatar
Kenichi Handa committed
863 864
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
865
Optional parameter RELEASE says whether we're done with this desktop.
866 867
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."
Richard M. Stallman's avatar
Richard M. Stallman committed
868
  (interactive "DDirectory to save desktop file in: ")
869
  (setq desktop-dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
870
  (save-excursion
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    (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")
	  (mapc (function desktop-outvar) desktop-globals-to-save)
	  (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)))
908 909 910 911 912 913 914 915 916 917 918
	    (let ((base (pop l)))
	      (when (apply 'desktop-save-buffer-p l)
		(insert "("
			(if (or (not (integerp eager))
				(if (zerop eager)
				    nil
				  (setq eager (1- eager))))
			    "desktop-create-buffer"
			  "desktop-append-buffer-args")
			" "
			desktop-file-version)
919 920 921
		;; If there's a non-empty base name, we save it instead of the buffer name
		(when (and base (not (string= base "")))
		  (setcar (nthcdr 1 l) base))
922 923 924
		(dolist (e l)
		  (insert "\n  " (desktop-value-to-string e)))
		(insert ")\n\n"))))
925

926
	  (setq default-directory desktop-dirname)
927 928 929 930 931 932 933 934 935 936 937
	  ;; If auto-saving, avoid writing if nothing has changed since the last write.
	  ;; Don't check 300 characters of the header that contains the timestamp.
	  (let ((checksum (and auto-save (md5 (current-buffer)
					      (+ (point-min) 300) (point-max)
					      'emacs-mule))))
	    (unless (and auto-save (equal checksum desktop-file-checksum))
	      (let ((coding-system-for-write 'emacs-mule))
		(write-region (point-min) (point-max) (desktop-full-file-name) nil 'nomessage))
	      (setq desktop-file-checksum checksum)
	      ;; We remember when it was modified (which is presumably just now).
	      (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name)))))))))))
938

939
;; ----------------------------------------------------------------------------
940
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
941
(defun desktop-remove ()
Kenichi Handa's avatar
Kenichi Handa committed
942 943
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
944
  (interactive)
Kenichi Handa's avatar
Kenichi Handa committed
945
  (when desktop-dirname
946
    (let ((filename (desktop-full-file-name)))
Kenichi Handa's avatar
Kenichi Handa committed
947 948
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
949
        (delete-file filename)))))
Kenichi Handa's avatar
Kenichi Handa committed
950

951 952 953 954 955
(defvar desktop-buffer-args-list nil
  "List of args for `desktop-create-buffer'.")

(defvar desktop-lazy-timer nil)

956
;; ----------------------------------------------------------------------------
957
;;;###autoload
Kenichi Handa's avatar
Kenichi Handa committed
958 959 960 961
(defun desktop-read (&optional dirname)
  "Read and process the desktop file in directory DIRNAME.
Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in
directories listed in `desktop-path'.  If a desktop file is found, it
962
is processed and `desktop-after-read-hook' is run.  If no desktop file
Kenichi Handa's avatar
Kenichi Handa committed
963 964 965
is found, clear the desktop and run `desktop-no-desktop-file-hook'.
This function is a no-op when Emacs is running in batch mode.
It returns t if a desktop file was loaded, nil otherwise."
Richard M. Stallman's avatar
Richard M. Stallman committed
966
  (interactive)
967
  (unless noninteractive
Kenichi Handa's avatar
Kenichi Handa committed
968
    (setq desktop-dirname
969 970 971 972 973 974 975 976 977 978 979 980 981 982
          (file-name-as-directory
           (expand-file-name
            (or
             ;; If DIRNAME is specified, use it.
             (and (< 0 (length dirname)) dirname)
             ;; Otherwise search desktop file in desktop-path.
             (let ((dirs desktop-path))
               (while (and dirs
                           (not (file-exists-p
                                 (desktop-full-file-name (car dirs)))))
                 (setq dirs (cdr dirs)))
               (and dirs (car dirs)))
             ;; If not found and `desktop-path' is non-nil, use its first element.
             (and desktop-path (car desktop-path))
983 984
             ;; Default: .emacs.d.
             user-emacs-directory))))
985
    (if (file-exists-p (desktop-full-file-name))
986 987 988 989 990 991 992 993
	;; Desktop file found, but is it already in use?
	(let ((desktop-first-buffer nil)
	      (desktop-buffer-ok-count 0)
	      (desktop-buffer-fail-count 0)
	      (owner (desktop-owner))
	      ;; Avoid desktop saving during evaluation of desktop buffer.
	      (desktop-save nil))
	  (if (and owner
994 995
		   (memq desktop-load-locked-desktop '(nil ask))
		   (or (null desktop-load-locked-desktop)
Chong Yidong's avatar
Chong Yidong committed
996
		       (daemonp)
997 998
		       (not (y-or-n-p (format "Warning: desktop file appears to be in use by PID %s.\n\
Using it may cause conflicts.  Use it anyway? " owner)))))
999
	      (let ((default-directory desktop-dirname))
1000
		(setq desktop-dirname nil)
1001 1002 1003
		(run-hooks 'desktop-not-loaded-hook)
		(unless desktop-dirname
		  (message "Desktop file in use; not loaded.")))
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033