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

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

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

;; This file is part of GNU Emacs.

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

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

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

;;; Commentary:

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

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

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

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

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

111 112 113 114
;; 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.

115 116 117
;; 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.
118

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

;;; Code:

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
148 149 150 151
;;;###autoload
(define-minor-mode desktop-save-mode
  "Toggle desktop saving mode.
With numeric ARG, turn desktop saving on if ARG is positive, off
152 153 154
otherwise.  If desktop saving is turned on, 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
155 156 157 158
  :global t
  :group 'desktop)

;; Maintained for backward compatibility
159 160
(define-obsolete-variable-alias 'desktop-enable
                                'desktop-save-mode "22.1")
161

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

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

190 191 192 193 194 195 196 197 198 199 200 201 202 203
(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
204
  :version "22.2")
205

206 207 208
(define-obsolete-variable-alias 'desktop-basefilename
                                'desktop-base-file-name "22.1")

209
(defcustom desktop-base-file-name
210
  (convert-standard-filename ".emacs.desktop")
Kenichi Handa's avatar
Kenichi Handa committed
211
  "Name of file for Emacs desktop, excluding the directory part."
212 213
  :type 'file
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
214

215 216 217 218 219
(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
220
  :version "22.2")
221

222
(defcustom desktop-path (list "." user-emacs-directory "~")
223 224 225
  "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)
226
  :group 'desktop
227
  :version "23.2")                      ; user-emacs-directory added
228

229
(defcustom desktop-missing-file-warning nil
230
  "If non-nil, offer to recreate the buffer of a deleted file.
231 232 233 234
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."
235
  :type 'boolean
236
  :group 'desktop
237
  :version "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
238

239
(defcustom desktop-no-desktop-file-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
240
  "Normal hook run when `desktop-read' can't find a desktop file.
241
Run in the directory in which the desktop file was sought.
242
May be used to show a dired buffer."
243
  :type 'hook
244
  :group 'desktop
245
  :version "22.1")
246

247 248 249 250 251 252 253
(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)
254
  :version "22.2")
255

256
(defcustom desktop-after-read-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
257
  "Normal hook run after a successful `desktop-read'.
258
May be used to show a buffer list."
259
  :type 'hook
260
  :group 'desktop
261
  :options '(list-buffers)
262
  :version "22.1")
263 264

(defcustom desktop-save-hook nil
Kenichi Handa's avatar
Kenichi Handa committed
265
  "Normal hook run before the desktop is saved in a desktop file.
266 267 268
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."
269 270 271
  :type 'hook
  :group 'desktop)

272 273 274 275 276 277
(defcustom desktop-globals-to-save
  '(desktop-missing-file-warning
    tags-file-name
    tags-table-list
    search-ring
    regexp-search-ring
278 279
    register-alist
    file-name-history)
Kenichi Handa's avatar
Kenichi Handa committed
280 281 282 283
  "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.
284 285 286 287
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
  :group 'desktop)

288 289 290 291 292 293 294
(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)
295
  "List of global variables that `desktop-clear' will clear.
296
An element may be variable name (a symbol) or a cons cell of the form
297 298
\(VAR . FORM).  Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluating FORM."
299
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
300
  :group 'desktop
301
  :version "22.1")
302

303
(defcustom desktop-clear-preserve-buffers
Glenn Morris's avatar
Glenn Morris committed
304 305
  '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*"
    "\\*Warnings\\*")
Lute Kamstra's avatar
Lute Kamstra committed
306
  "List of buffers that `desktop-clear' should not delete.
307 308
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
309
  :version "23.3"                       ; added Warnings - bug#6336
310 311
  :type '(repeat string)
  :group 'desktop)
312

313
;;;###autoload
314 315 316 317 318 319 320 321 322
(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
323 324 325 326
    column-number-mode
    size-indication-mode
    buffer-file-coding-system
    indent-tabs-mode
327
    tab-width
328 329 330
    indicate-buffer-boundaries
    indicate-empty-lines
    show-trailing-whitespace)
Richard M. Stallman's avatar
Richard M. Stallman committed
331
  "List of local variables to save for each buffer.
332 333
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
334 335
  :type '(repeat symbol)
  :group 'desktop)
336

337
(defcustom desktop-buffers-not-to-save nil
338
  "Regexp identifying buffers that are to be excluded from saving."
339 340
  :type '(choice (const :tag "None" nil)
		 regexp)
341
  :version "23.2"                       ; set to nil
342
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
343

Kenichi Handa's avatar
Kenichi Handa committed
344
;; Skip tramp and ange-ftp files
345
(defcustom desktop-files-not-to-save
346
  "\\(^/[^/:]*:\\|(ftp)$\\)"
347
  "Regexp identifying files whose buffers are to be excluded from saving."
348 349
  :type '(choice (const :tag "None" nil)
		 regexp)
350
  :group 'desktop)
351

352 353 354
;; We skip TAGS files to save time (tags-file-name is saved instead).
(defcustom desktop-modes-not-to-save
  '(tags-table-mode)
355 356 357 358
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

359
(defcustom desktop-file-name-format 'absolute
Lute Kamstra's avatar
Lute Kamstra committed
360
  "Format in which desktop file names should be saved.
361 362 363 364 365
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))
366
  :group 'desktop
367
  :version "22.1")
368

369 370 371 372
(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."
373
  :type '(choice (const t) integer)
374
  :group 'desktop
375
  :version "22.1")
376 377 378 379 380

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
381
  :version "22.1")
382 383 384 385 386 387

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

390
;;;###autoload
391 392
(defvar desktop-save-buffer nil
  "When non-nil, save buffer status in desktop file.
393
This variable becomes buffer local when set.
394

395 396
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
397
file along with the state of the buffer for which it was called.
398

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

402 403 404
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'.")
405 406
(make-variable-buffer-local 'desktop-save-buffer)
(make-obsolete-variable 'desktop-buffer-modes-to-save
407
                        'desktop-save-buffer "22.1")
408
(make-obsolete-variable 'desktop-buffer-misc-functions
409
                        'desktop-save-buffer "22.1")
410

411 412 413
;;;###autoload
(defvar desktop-buffer-mode-handlers
  nil
414
  "Alist of major mode specific functions to restore a desktop buffer.
415 416 417 418
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).
419 420 421 422

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

423
Handlers are called with argument list
424

425
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
426 427

Furthermore, they may use the following variables:
428 429 430 431 432 433 434 435 436

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

437
If a handler returns a buffer, then the saved mode settings
438 439 440 441
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
442

443 444 445 446 447 448
   (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.")
449

450
;;;###autoload
451 452
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
453
                        'desktop-buffer-mode-handlers "22.1")
454

455 456
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
457
    (vc-mode nil)
458
    (vc-dired-mode nil)
459 460
    (erc-track-minor-mode nil)
    (savehist-mode nil))
461 462 463 464
  "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.
465
RESTORE-FUNCTION nil means don't try to restore the minor mode.
466
Only minor modes for which the name of the buffer-local variable
467
and the name of the minor mode function are different have to be added to
468
this table.  See also `desktop-minor-mode-handlers'."
469 470 471
  :type 'sexp
  :group 'desktop)

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 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
;;;###autoload
(defvar desktop-minor-mode-handlers
  nil
  "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'.")

516
;;;###autoload
517 518
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

519 520
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Kenichi Handa's avatar
Kenichi Handa committed
521
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
522

523 524 525 526 527
(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)))

528 529 530 531 532
(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
533
(defconst desktop-header
534 535 536
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
537
" "*Header to place in Desktop file.")
538 539 540

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

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
;; ----------------------------------------------------------------------------
;; 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))))

575
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
576
(defun desktop-truncate (list n)
577
  "Truncate LIST to at most N elements destructively."
Kenichi Handa's avatar
Kenichi Handa committed
578
  (let ((here (nthcdr (1- n) list)))
579 580
    (when (consp here)
      (setcdr here nil))))
581

582
;; ----------------------------------------------------------------------------
583
;;;###autoload
584 585
(defun desktop-clear ()
  "Empty the Desktop.
586 587 588
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
589
  (interactive)
590
  (desktop-lazy-abort)
591 592
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
593
	(eval `(setq-default ,var nil))
594
      (eval `(setq-default ,(car var) ,(cdr var)))))
595 596 597 598 599 600 601
  (let ((buffers (buffer-list))
        (preserve-regexp (concat "^\\("
                                 (mapconcat (lambda (regexp)
                                              (concat "\\(" regexp "\\)"))
                                            desktop-clear-preserve-buffers
                                            "\\|")
                                 "\\)$")))
602
    (while buffers
603 604 605
      (let ((bufname (buffer-name (car buffers))))
         (or
           (null bufname)
606
           (string-match preserve-regexp bufname)
607
           ;; Don't kill buffers made for internal purposes.
608
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\s))
609
           (kill-buffer (car buffers))))
610
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
611
  (delete-other-windows))
612

613
;; ----------------------------------------------------------------------------
614
(add-hook 'kill-emacs-hook 'desktop-kill)
615

Richard M. Stallman's avatar
Richard M. Stallman committed
616
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
617
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
618 619
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
620 621 622
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
623 624 625 626
                   (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))
627 628 629 630
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
631 632
    (unless desktop-dirname
      (setq desktop-dirname
633 634
            (file-name-as-directory
             (expand-file-name
635
	      (read-directory-name "Directory for desktop file: " nil nil t)))))
636
    (condition-case err
637
	(desktop-save desktop-dirname t)
638
      (file-error
639
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
640 641 642
	 (signal (car err) (cdr err))))))
  ;; If we own it, we don't anymore.
  (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock)))
643

644
;; ----------------------------------------------------------------------------
645 646 647 648 649 650 651 652 653 654 655
(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)))

656 657 658 659
;; ----------------------------------------------------------------------------
(defun desktop-buffer-info (buffer)
  (set-buffer buffer)
  (list
660 661
   ;; base name of the buffer; replaces the buffer name if managed by uniquify
   (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name))
662
   ;; basic information
663
   (desktop-file-name (buffer-file-name) desktop-dirname)
664
   (buffer-name)
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
   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)
684
     (funcall desktop-save-buffer desktop-dirname))
685 686 687 688 689 690 691 692 693 694 695 696 697
   ;; 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)))

698
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
699
(defun desktop-internal-v2s (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
700 701 702 703
  "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
TXT is a string that when read and evaluated yields value.
QUOTE may be `may' (value may be quoted),
`must' (values must be quoted), or nil (value may not be quoted)."
704
  (cond
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
    ((or (numberp value) (null value) (eq t value) (keywordp value))
     (cons 'may (prin1-to-string value)))
    ((stringp value)
     (let ((copy (copy-sequence value)))
       (set-text-properties 0 (length copy) nil copy)
       ;; Get rid of text properties because we cannot read them
       (cons 'may (prin1-to-string copy))))
    ((symbolp value)
     (cons 'must (prin1-to-string value)))
    ((vectorp value)
     (let* ((special nil)
	    (pass1 (mapcar
		    (lambda (el)
		      (let ((res (desktop-internal-v2s el)))
			(if (null (car res))
			    (setq special t))
			res))
		    value)))
       (if special
	   (cons nil (concat "(vector "
			     (mapconcat (lambda (el)
					  (if (eq (car el) 'must)
					      (concat "'" (cdr el))
					    (cdr el)))
					pass1
					" ")
			     ")"))
	 (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
    ((consp value)
     (let ((p value)
	   newlist
	   use-list*
	   anynil)
       (while (consp p)
	 (let ((q.txt (desktop-internal-v2s (car p))))
	   (or anynil (setq anynil (null (car q.txt))))
	   (setq newlist (cons q.txt newlist)))
	 (setq p (cdr p)))
       (if p
	   (let ((last (desktop-internal-v2s p)))
	     (or anynil (setq anynil (null (car last))))
	     (or anynil
		 (setq newlist (cons '(must . ".") newlist)))
	     (setq use-list* t)
	     (setq newlist (cons last newlist))))
       (setq newlist (nreverse newlist))
       (if anynil
	   (cons nil
		 (concat (if use-list* "(desktop-list* "  "(list ")
			 (mapconcat (lambda (el)
				      (if (eq (car el) 'must)
					  (concat "'" (cdr el))
					(cdr el)))
				    newlist
				    " ")
			 ")"))
	 (cons 'must
	       (concat "(" (mapconcat 'cdr newlist " ") ")")))))
    ((subrp value)
     (cons nil (concat "(symbol-function '"
		       (substring (prin1-to-string value) 7 -1)
		       ")")))
    ((markerp value)
     (let ((pos (prin1-to-string (marker-position value)))
	   (buf (prin1-to-string (buffer-name (marker-buffer value)))))
       (cons nil (concat "(let ((mk (make-marker)))"
			 " (add-hook 'desktop-delay-hook"
			 " (list 'lambda '() (list 'set-marker mk "
			 pos " (get-buffer " buf ")))) mk)"))))
    (t					 ; save as text
     (cons 'may "\"Unprintable entity\""))))
776

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

790
;; ----------------------------------------------------------------------------
791 792 793
(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),
794
or a cons cell of the form (VAR . MAX-SIZE),
795 796 797 798 799 800
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))
801 802 803 804 805 806 807 808 809 810
    (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"))))
811

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

837
;; ----------------------------------------------------------------------------
838 839 840 841 842 843 844 845 846 847 848 849 850 851
(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))))
852

Miles Bader's avatar
Miles Bader committed
853

854
;; ----------------------------------------------------------------------------
855
;;;###autoload
856
(defun desktop-save (dirname &optional release)
Kenichi Handa's avatar
Kenichi Handa committed
857 858
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
859
Optional parameter RELEASE says whether we're done with this desktop.
Kenichi Handa's avatar
Kenichi Handa committed
860
See also `desktop-base-file-name'."
Richard M. Stallman's avatar
Richard M. Stallman committed
861
  (interactive "DDirectory to save desktop file in: ")
862
  (setq desktop-dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
863
  (save-excursion
864 865 866 867 868 869 870 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
    (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)))
901 902 903 904 905 906 907 908 909 910 911
	    (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)
912 913 914
		;; 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))
915 916 917
		(dolist (e l)
		  (insert "\n  " (desktop-value-to-string e)))
		(insert ")\n\n"))))
918

919
	  (setq default-directory desktop-dirname)
920 921 922 923
	  (let ((coding-system-for-write 'emacs-mule))
	    (write-region (point-min) (point-max) (desktop-full-file-name) nil 'nomessage))
	  ;; We remember when it was modified (which is presumably just now).
	  (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name)))))))))
924

925
;; ----------------------------------------------------------------------------
926
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
927
(defun desktop-remove ()
Kenichi Handa's avatar
Kenichi Handa committed
928 929
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
930
  (interactive)
Kenichi Handa's avatar
Kenichi Handa committed
931
  (when desktop-dirname
932
    (let ((filename (desktop-full-file-name)))
Kenichi Handa's avatar
Kenichi Handa committed
933 934
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
935
        (delete-file filename)))))
Kenichi Handa's avatar
Kenichi Handa committed
936

937 938 939 940 941
(defvar desktop-buffer-args-list nil
  "List of args for `desktop-create-buffer'.")

(defvar desktop-lazy-timer nil)

942
;; ----------------------------------------------------------------------------
943
;;;###autoload
Kenichi Handa's avatar
Kenichi Handa committed
944 945 946 947
(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
948
is processed and `desktop-after-read-hook' is run.  If no desktop file
Kenichi Handa's avatar
Kenichi Handa committed
949 950 951
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
952
  (interactive)
953
  (unless noninteractive
Kenichi Handa's avatar
Kenichi Handa committed
954
    (setq desktop-dirname
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
          (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))
             ;; Default: Home directory.
             "~"))))
    (if (file-exists-p (desktop-full-file-name))
972 973 974 975 976 977 978 979
	;; 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
980 981 982 983
		   (memq desktop-load-locked-desktop '(nil ask))
		   (or (null desktop-load-locked-desktop)
		       (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)))))
984
	      (let ((default-directory desktop-dirname))
985
		(setq desktop-dirname nil)
986 987 988
		(run-hooks 'desktop-not-loaded-hook)
		(unless desktop-dirname
		  (message "Desktop file in use; not loaded.")))
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
	    (desktop-lazy-abort)
	    ;; Evaluate desktop buffer and remember when it was modified.
	    (load (desktop-full-file-name) t t t)
	    (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name))))
	    ;; If it wasn't already, mark it as in-use, to bother other
	    ;; desktop instances.
	    (unless owner
	      (condition-case nil
		  (desktop-claim-lock)
		(file-error (message "Couldn't record use of desktop file")
			    (sit-for 1))))

	    ;; `desktop-create-buffer' puts buffers at end of the buffer list.
	    ;; We want buffers existing prior to evaluating the desktop (and
	    ;; not reused) to be placed at the end of the buffer list, so we
	    ;; move them here.
	    (mapc 'bury-buffer
		  (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
	    (switch-to-buffer (car (buffer-list)))
	    (run-hooks 'desktop-delay-hook)
	    (setq desktop-delay-hook nil)
	    (run-hooks 'desktop-after-read-hook)
	    (message "Desktop: %d buffer%s restored%s%s."
		     desktop-buffer-ok-count
		     (if (= 1 desktop-buffer-ok-count) "" "s")
		     (if (< 0 desktop-buffer-fail-count)
			 (format ", %d failed to restore" desktop-buffer-fail-count)
		       "")
		     (if desktop-buffer-args-list
			 (format ", %d to restore lazily"
				 (length desktop-buffer-args-list))
		       ""))
	    t))
Kenichi Handa's avatar
Kenichi Handa committed
1022 1023 1024 1025 1026 1027
      ;; No desktop file found.
      (desktop-clear)
      (let ((default-directory desktop-dirname))
        (run-hooks 'desktop-no-desktop-file-hook))
      (message "No desktop file.")
      nil)))
1028

1029
;; ----------------------------------------------------------------------------
Kenichi Handa's avatar
Kenichi Handa committed
1030
;; Maintained for backward compatibility
1031
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
1032
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1033
  "Load the `default' start-up library manually.
Kenichi Handa's avatar
Kenichi Handa committed
1034
Also inhibit further loading of it."
1035 1036 1037 1038 1039
  (unless inhibit-default-init	        ; safety check
    (load "default" t t)
    (setq inhibit-default-init t)))
(make-obsolete 'desktop-load-default
               'desktop-save-mode "22.1")
1040 1041 1042

;; ----------------------------------------------------------------------------
;;;###autoload
Kenichi Handa's avatar
Kenichi Handa committed
1043 1044 1045 1046 1047 1048 1049
(defun desktop-change-dir (dirname)
  "Change to desktop saved in DIRNAME.
Kill the desktop as specified by variables `desktop-save-mode' and
`desktop-save', then clear the desktop and load the desktop file in
directory DIRNAME."
  (interactive "DChange to directory: ")
  (setq dirname (file-name-as-directory (expand-file-name dirname desktop-dirname)))
1050 1051
  (desktop-kill)
  (desktop-clear)
Kenichi Handa's avatar
Kenichi Handa committed
1052
  (desktop-read dirname))
1053

Kenichi Handa's avatar
Kenichi Handa committed
1054
;; ----------------------------------------------------------------------------
1055
;;;###autoload
Kenichi Handa's avatar
Kenichi Handa committed
1056 1057
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
1058 1059
  (interactive)
  (if desktop-dirname
1060
      (desktop-save desktop-dirname)
1061
    (call-interactively 'desktop-save))
1062
  (message "Desktop saved in %s" (abbreviate-file-name desktop-dirname)))
1063 1064