desktop.el 44.9 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, 1994, 1995, 1997, 2000, 2001, 2002, 2003,
4
;;   2004, 2005, 2006 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

;; Author: Morten Welinder <terra@diku.dk>
Lars Hansen's avatar
Lars Hansen committed
7
;; Maintainter: Lars Hansen <larsh@soem.dk>
Dave Love's avatar
Dave Love committed
8
;; Keywords: convenience
Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; Favourite-brand-of-beer: None, I hate beer.
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29

;;; Commentary:

30 31 32 33 34 35 36 37
;; 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
38
;;		- some local variables
Richard M. Stallman's avatar
Richard M. Stallman committed
39

Lars Hansen's avatar
Lars Hansen committed
40 41
;; To use this, use customize to turn on desktop-save-mode or add the
;; following line somewhere in your .emacs file:
42
;;
Lars Hansen's avatar
Lars Hansen committed
43
;;	(desktop-save-mode 1)
44
;;
Lars Hansen's avatar
Lars Hansen committed
45 46 47 48 49 50 51 52
;; For further usage information, look at the section
;; "Saving Emacs Sessions" in the GNU Emacs Manual.

;; When the desktop module is loaded, the function `desktop-kill' is
;; added to the `kill-emacs-hook'. This function is responsible for
;; saving the desktop when Emacs is killed.  Furthermore an anonymous
;; function is added to the `after-init-hook'. This function is
;; responsible for loading the desktop when Emacs is started.
53

54 55 56 57 58 59
;; 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
;; to restore a desktop buffer. Elements must have the form
60
;;
61
;;    (MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
62
;;
63 64 65 66 67
;; Functions listed are called by `desktop-create-buffer' when `desktop-read'
;; evaluates the desktop file. Buffers with a major mode not specified here,
;; 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
68
;;
69
;;    (MINOR-MODE . RESTORE-FUNCTION).
70
;;
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
;; 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))

;; in the module itself, and make shure that the mode function is
;; autoloaded. See the docstrings of `desktop-buffer-mode-handlers' and
;; `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
;; functions before writing `desktop-minor-modes'. If a minor mode has a
;; 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.
;; ---------------------------------------------------------------------------
114

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

119 120 121
;; 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.
122

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

;;; Code:

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

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

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

Lars Hansen's avatar
Lars Hansen committed
152 153 154 155
;;;###autoload
(define-minor-mode desktop-save-mode
  "Toggle desktop saving mode.
With numeric ARG, turn desktop saving on if ARG is positive, off
156 157 158
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."
Lars Hansen's avatar
Lars Hansen committed
159 160 161 162
  :global t
  :group 'desktop)

;; Maintained for backward compatibility
163 164
(define-obsolete-variable-alias 'desktop-enable
                                'desktop-save-mode "22.1")
165

166
(defcustom desktop-save 'ask-if-new
Lars Hansen's avatar
Lars Hansen committed
167 168 169
  "*Specifies whether the desktop should be saved when it is killed.
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.
Lars Hansen's avatar
Lars Hansen committed
176
The desktop is never saved when `desktop-save-mode' is nil.
177
The variables `desktop-dirname' and `desktop-base-file-name'
Lars Hansen's avatar
Lars Hansen 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

(defcustom desktop-base-file-name
191
  (convert-standard-filename ".emacs.desktop")
Lars Hansen's avatar
Lars Hansen committed
192
  "Name of file for Emacs desktop, excluding the directory part."
193 194
  :type 'file
  :group 'desktop)
195 196
(define-obsolete-variable-alias 'desktop-basefilename
                                'desktop-base-file-name "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
197

198 199 200 201
(defcustom desktop-path '("." "~")
  "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)
202
  :group 'desktop
203
  :version "22.1")
204

205
(defcustom desktop-missing-file-warning nil
206
  "If non-nil, offer to recreate the buffer of a deleted file.
207 208 209 210
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."
211
  :type 'boolean
212
  :group 'desktop
213
  :version "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
214

215
(defcustom desktop-no-desktop-file-hook nil
Lars Hansen's avatar
Lars Hansen committed
216
  "Normal hook run when `desktop-read' can't find a desktop file.
217
Run in the directory in which the desktop file was sought.
218
May be used to show a dired buffer."
219
  :type 'hook
220
  :group 'desktop
221
  :version "22.1")
222 223

(defcustom desktop-after-read-hook nil
224
  "Normal hook run after a successful `desktop-read'.
225
May be used to show a buffer list."
226
  :type 'hook
227
  :group 'desktop
228
  :options '(list-buffers)
229
  :version "22.1")
230 231

(defcustom desktop-save-hook nil
Lars Hansen's avatar
Lars Hansen committed
232
  "Normal hook run before the desktop is saved in a desktop file.
233 234 235
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."
236 237 238
  :type 'hook
  :group 'desktop)

239 240 241 242 243 244 245
(defcustom desktop-globals-to-save
  '(desktop-missing-file-warning
    tags-file-name
    tags-table-list
    search-ring
    regexp-search-ring
    register-alist)
Lars Hansen's avatar
Lars Hansen committed
246 247 248 249
  "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.
250 251 252 253
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
  :group 'desktop)

254 255 256 257 258 259 260
(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)
261
  "List of global variables that `desktop-clear' will clear.
262
An element may be variable name (a symbol) or a cons cell of the form
263 264
\(VAR . FORM).  Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluating FORM."
265
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
266
  :group 'desktop
267
  :version "22.1")
268

269 270 271 272 273
(defcustom desktop-clear-preserve-buffers
  '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*")
  "*List of buffers that `desktop-clear' should not delete.
Each element is a regular expression.  Buffers with a name matched by any of
these won't be deleted."
274 275
  :type '(repeat string)
  :group 'desktop)
276

277
;;;###autoload
278 279 280 281 282 283 284 285 286
(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
287 288 289 290
    column-number-mode
    size-indication-mode
    buffer-file-coding-system
    indent-tabs-mode
291
    tab-width
292 293 294
    indicate-buffer-boundaries
    indicate-empty-lines
    show-trailing-whitespace)
Richard M. Stallman's avatar
Richard M. Stallman committed
295
  "List of local variables to save for each buffer.
296 297
The variables are saved only when they really are local.  Conventional minor
modes are restored automatically; they should not be listed here."
Lars Hansen's avatar
Lars Hansen committed
298 299
  :type '(repeat symbol)
  :group 'desktop)
300

301
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
302
;;         (ftp) files because they require passwords and whatnot.
303
(defcustom desktop-buffers-not-to-save
304
  "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\)$"
305 306 307
  "Regexp identifying buffers that are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
308

Lars Hansen's avatar
Lars Hansen committed
309
;; Skip tramp and ange-ftp files
310
(defcustom desktop-files-not-to-save
311
  "^/[^/:]*:"
312 313 314
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
315

316 317 318
;; We skip TAGS files to save time (tags-file-name is saved instead).
(defcustom desktop-modes-not-to-save
  '(tags-table-mode)
319 320 321 322
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

323 324 325 326 327 328 329
(defcustom desktop-file-name-format 'absolute
  "*Format in which desktop file names should be saved.
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))
330
  :group 'desktop
331
  :version "22.1")
332

333 334 335 336
(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."
337
  :type '(choice (const t) integer)
338
  :group 'desktop
339
  :version "22.1")
340 341 342 343 344

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
345
  :version "22.1")
346 347 348 349 350 351

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

354
;;;###autoload
355 356
(defvar desktop-save-buffer nil
  "When non-nil, save buffer status in desktop file.
357
This variable becomes buffer local when set.
358

359 360
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
361
file along with the state of the buffer for which it was called.
362

Lars Hansen's avatar
Lars Hansen committed
363
When file names are returned, they should be formatted using the call
364
\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
365

366 367 368
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'.")
369 370
(make-variable-buffer-local 'desktop-save-buffer)
(make-obsolete-variable 'desktop-buffer-modes-to-save
371
                        'desktop-save-buffer "22.1")
372
(make-obsolete-variable 'desktop-buffer-misc-functions
373
                        'desktop-save-buffer "22.1")
374

375 376 377
;;;###autoload
(defvar desktop-buffer-mode-handlers
  nil
378
  "Alist of major mode specific functions to restore a desktop buffer.
379 380 381 382
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).
383 384 385 386

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

387
Handlers are called with argument list
388

389
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
390 391 392 393

Furthermore, they may use the following variables:

   desktop-file-version
394 395 396 397 398 399 400
   desktop-buffer-major-mode
   desktop-buffer-minor-modes
   desktop-buffer-point
   desktop-buffer-mark
   desktop-buffer-read-only
   desktop-buffer-locals

401
If a handler returns a buffer, then the saved mode settings
402 403 404 405 406 407 408 409 410 411 412
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

   (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.")
413

414
;;;###autoload
415 416
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
417
                        'desktop-buffer-mode-handlers "22.1")
418

419 420
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
421 422
    (vc-mode nil)
    (vc-dired-mode nil))
423 424 425 426 427 428
  "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.
called.  RESTORE-FUNCTION nil means don't try to restore the minor mode.
Only minor modes for which the name of the buffer-local variable
429
and the name of the minor mode function are different have to be added to
430
this table.  See also `desktop-minor-mode-handlers'."
431 432 433
  :type 'sexp
  :group 'desktop)

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
;;;###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'.")

478
;;;###autoload
479 480
(put 'desktop-minor-mode-handlers 'risky-local-variable t)

481 482
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Lars Hansen's avatar
Lars Hansen committed
483
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
484

485 486 487 488 489
(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)))

Richard M. Stallman's avatar
Richard M. Stallman committed
490
(defconst desktop-header
491 492 493
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
494
" "*Header to place in Desktop file.")
495 496 497

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

499
;; ----------------------------------------------------------------------------
500
(defun desktop-truncate (list n)
501
  "Truncate LIST to at most N elements destructively."
502
  (let ((here (nthcdr (1- n) list)))
503
    (if (consp here)
504
	(setcdr here nil))))
505

506
;; ----------------------------------------------------------------------------
507
;;;###autoload
508 509
(defun desktop-clear ()
  "Empty the Desktop.
510 511 512
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
513
  (interactive)
514
  (desktop-lazy-abort)
515 516 517 518
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
519 520 521 522 523 524 525
  (let ((buffers (buffer-list))
        (preserve-regexp (concat "^\\("
                                 (mapconcat (lambda (regexp)
                                              (concat "\\(" regexp "\\)"))
                                            desktop-clear-preserve-buffers
                                            "\\|")
                                 "\\)$")))
526
    (while buffers
527 528 529
      (let ((bufname (buffer-name (car buffers))))
         (or
           (null bufname)
530
           (string-match preserve-regexp bufname)
531
           ;; Don't kill buffers made for internal purposes.
532
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\s))
533
           (kill-buffer (car buffers))))
534
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
535
  (delete-other-windows))
536

537
;; ----------------------------------------------------------------------------
538
(add-hook 'kill-emacs-hook 'desktop-kill)
539

Richard M. Stallman's avatar
Richard M. Stallman committed
540
(defun desktop-kill ()
Lars Hansen's avatar
Lars Hansen committed
541
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
542 543
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
544 545 546 547 548 549 550 551
  (when (and desktop-save-mode
             (let ((exists (file-exists-p (desktop-full-file-name))))
               (or (eq desktop-save t)
                   (and exists (memq desktop-save '(ask-if-new if-exists)))
                   (and
                    (or (memq desktop-save '(ask ask-if-new))
                        (and exists (eq desktop-save 'ask-if-exists)))
                    (y-or-n-p "Save desktop? ")))))
552 553
    (unless desktop-dirname
      (setq desktop-dirname
554 555 556 557 558
            (file-name-as-directory
             (expand-file-name
              (call-interactively
               (lambda (dir)
                 (interactive "DDirectory for desktop file: ") dir))))))
559
    (condition-case err
560
        (desktop-save desktop-dirname)
561
      (file-error
562 563
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
         (signal (car err) (cdr err)))))))
564

565
;; ----------------------------------------------------------------------------
566 567 568 569 570 571 572 573 574 575 576
(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)))

577
;; ----------------------------------------------------------------------------
578
(defun desktop-internal-v2s (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
579 580 581 582
  "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)."
583
  (cond
584
   ((or (numberp value) (null value) (eq t value) (keywordp value))
585 586 587
    (cons 'may (prin1-to-string value)))
   ((stringp value)
    (let ((copy (copy-sequence value)))
588 589 590
      (set-text-properties 0 (length copy) nil copy)
      ;; Get rid of text properties because we cannot read them
      (cons 'may (prin1-to-string copy))))
591 592 593
   ((symbolp value)
    (cons 'must (prin1-to-string value)))
   ((vectorp value)
594 595 596 597 598 599 600
    (let* ((special nil)
	   (pass1 (mapcar
		   (lambda (el)
		     (let ((res (desktop-internal-v2s el)))
		       (if (null (car res))
			   (setq special t))
		       res))
601
		   value)))
602 603 604 605 606 607 608 609 610 611
      (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 " ") "]")))))
612 613
   ((consp value)
    (let ((p value)
614
	  newlist
615
	  use-list*
616 617 618 619 620 621 622 623 624
	  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))
		(el (car newlist)))
625 626 627 628 629
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
630 631 632
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
633
		(concat (if use-list* "(desktop-list* "  "(list ")
634 635 636 637 638 639 640 641 642
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
643
   ((subrp value)
644
    (cons nil (concat "(symbol-function '"
645
		      (substring (prin1-to-string value) 7 -1)
646
		      ")")))
647 648 649
   ((markerp value)
    (let ((pos (prin1-to-string (marker-position value)))
	  (buf (prin1-to-string (buffer-name (marker-buffer value)))))
650 651 652 653 654
      (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
655
    (cons 'may "\"Unprintable entity\""))))
656

657
;; ----------------------------------------------------------------------------
658
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
659 660
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
661 662
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
663
	 (quote.txt (desktop-internal-v2s value))
664 665 666 667 668
	 (quote (car quote.txt))
	 (txt (cdr quote.txt)))
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
669

670
;; ----------------------------------------------------------------------------
671 672 673
(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),
674
or a cons cell of the form (VAR . MAX-SIZE),
675 676 677 678 679 680 681 682 683 684 685
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))
    (if (boundp var)
	(progn
	  (if (and (integerp size)
		   (> size 0)
		   (listp (eval var)))
686
	      (desktop-truncate (eval var) size))
687 688 689 690 691
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
692

693
;; ----------------------------------------------------------------------------
694
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
695
  "Return t if buffer should have its state saved in the desktop file.
696
FILENAME is the visited file name, BUFNAME is the buffer name, and
697 698
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
699
  (let ((case-fold-search nil))
700
    (and (not (string-match desktop-buffers-not-to-save bufname))
701 702 703 704 705 706 707 708 709
         (not (memq mode desktop-modes-not-to-save))
         (or (and filename
                  (not (string-match desktop-files-not-to-save filename)))
             (and (eq mode 'dired-mode)
                  (with-current-buffer bufname
                    (not (string-match desktop-files-not-to-save
                                       default-directory))))
             (and (null filename)
		  (with-current-buffer bufname desktop-save-buffer))))))
710

711
;; ----------------------------------------------------------------------------
712 713 714 715 716 717 718 719 720 721 722 723 724 725
(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))))
726

727
;; ----------------------------------------------------------------------------
728
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
729
(defun desktop-save (dirname)
Lars Hansen's avatar
Lars Hansen committed
730 731 732
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
See also `desktop-base-file-name'."
Richard M. Stallman's avatar
Richard M. Stallman committed
733
  (interactive "DDirectory to save desktop file in: ")
734
  (run-hooks 'desktop-save-hook)
735
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
736
  (save-excursion
737
    (let ((filename (desktop-full-file-name dirname))
738 739
          (info
            (mapcar
740
              #'(lambda (b)
741 742 743 744 745 746 747
                  (set-buffer b)
                  (list
                    (desktop-file-name (buffer-file-name) dirname)
                    (buffer-name)
                    major-mode
                    ;; minor modes
                    (let (ret)
748 749
                      (mapc
                        #'(lambda (minor-mode)
750
                          (and
751 752
                            (boundp minor-mode)
                            (symbol-value minor-mode)
753 754 755 756
                            (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)))))
757 758 759 760 761
                        (mapcar #'car minor-mode-alist))
                      ret)
                    (point)
                    (list (mark t) mark-active)
                    buffer-read-only
762
                    ;; Auxiliary information
763 764
                    (when (functionp desktop-save-buffer)
                      (funcall desktop-save-buffer dirname))
765 766 767 768 769 770 771 772 773 774
                    (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)))
775
                      ll)))
776
              (buffer-list)))
777 778
          (eager desktop-restore-eager))
      (with-temp-buffer
779
        (insert
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
         ";; -*- 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\n"
         ";; Global section:\n")
        (mapc (function desktop-outvar) desktop-globals-to-save)
        (if (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")
        (mapc #'(lambda (l)
                  (when (apply 'desktop-save-buffer-p l)
                    (insert "("
                            (if (or (not (integerp eager))
                                    (unless (zerop eager)
                                      (setq eager (1- eager))
                                      t))
                                "desktop-create-buffer"
                              "desktop-append-buffer-args")
                            " "
                            desktop-file-version)
                    (mapc #'(lambda (e)
                              (insert "\n  " (desktop-value-to-string e)))
                          l)
                    (insert ")\n\n")))
              info)
        (setq default-directory dirname)
        (let ((coding-system-for-write 'emacs-mule))
          (write-region (point-min) (point-max) filename nil 'nomessage)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
813
  (setq desktop-dirname dirname))
814

815
;; ----------------------------------------------------------------------------
816
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
817
(defun desktop-remove ()
Lars Hansen's avatar
Lars Hansen committed
818 819
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
820
  (interactive)
Lars Hansen's avatar
Lars Hansen committed
821
  (when desktop-dirname
822
    (let ((filename (desktop-full-file-name)))
Lars Hansen's avatar
Lars Hansen committed
823 824
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
825
        (delete-file filename)))))
Lars Hansen's avatar
Lars Hansen committed
826

827 828 829 830 831
(defvar desktop-buffer-args-list nil
  "List of args for `desktop-create-buffer'.")

(defvar desktop-lazy-timer nil)

832
;; ----------------------------------------------------------------------------
833
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
834 835 836 837
(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
838
is processed and `desktop-after-read-hook' is run.  If no desktop file
Lars Hansen's avatar
Lars Hansen committed
839 840 841
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
842
  (interactive)
843
  (unless noninteractive
Lars Hansen's avatar
Lars Hansen committed
844
    (setq desktop-dirname
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
          (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))
Lars Hansen's avatar
Lars Hansen committed
862
      ;; Desktop file found, process it.
863 864 865
      (let ((desktop-first-buffer nil)
            (desktop-buffer-ok-count 0)
            (desktop-buffer-fail-count 0))
866
        (setq desktop-lazy-timer nil)
Lars Hansen's avatar
Lars Hansen committed
867
        ;; Evaluate desktop buffer.
868
        (load (desktop-full-file-name) t t t)
Lars Hansen's avatar
Lars Hansen committed
869 870 871
        ;; `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.
872 873
        (mapc 'bury-buffer
              (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
Lars Hansen's avatar
Lars Hansen committed
874 875 876 877
        (switch-to-buffer (car (buffer-list)))
        (run-hooks 'desktop-delay-hook)
        (setq desktop-delay-hook nil)
        (run-hooks 'desktop-after-read-hook)
878
        (message "Desktop: %d buffer%s restored%s%s."
879 880 881 882
                 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)
883 884 885 886
                   "")
                 (if desktop-buffer-args-list
                     (format ", %d to restore lazily"
                             (length desktop-buffer-args-list))
887
                   ""))
Lars Hansen's avatar
Lars Hansen committed
888 889 890 891 892 893 894
        t)
      ;; No desktop file found.
      (desktop-clear)
      (let ((default-directory desktop-dirname))
        (run-hooks 'desktop-no-desktop-file-hook))
      (message "No desktop file.")
      nil)))
895

896
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
897
;; Maintained for backward compatibility
898
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
899
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
900
  "Load the `default' start-up library manually.
Lars Hansen's avatar
Lars Hansen committed
901
Also inhibit further loading of it."
902 903 904 905 906
  (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")
907 908 909

;; ----------------------------------------------------------------------------
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
910 911 912 913 914 915 916
(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)))
917 918
  (desktop-kill)
  (desktop-clear)
Lars Hansen's avatar
Lars Hansen committed
919
  (desktop-read dirname))
920

Lars Hansen's avatar
Lars Hansen committed
921
;; ----------------------------------------------------------------------------
922
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
923 924
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
925 926
  (interactive)
  (if desktop-dirname
927
      (desktop-save desktop-dirname)
928 929 930 931 932 933 934 935
    (call-interactively 'desktop-save))
  (message "Desktop saved in %s" desktop-dirname))

;; ----------------------------------------------------------------------------
;;;###autoload
(defun desktop-revert ()
  "Revert to the last loaded desktop."
  (interactive)
Lars Hansen's avatar
Lars Hansen committed
936 937
  (unless desktop-dirname
    (error "Unknown desktop directory"))
938
  (unless (file-exists-p (desktop-full-file-name))
Lars Hansen's avatar
Lars Hansen committed
939 940 941
    (error "No desktop file found"))
  (desktop-clear)
  (desktop-read desktop-dirname))
942

943
;; ----------------------------------------------------------------------------
944 945 946 947 948 949 950
(defun desktop-restore-file-buffer (desktop-buffer-file-name
                                    desktop-buffer-name
                                    desktop-buffer-misc)
  "Restore a file buffer."
  (eval-when-compile ; Just to silence the byte compiler
    (defvar desktop-buffer-major-mode)
    (defvar desktop-buffer-locals))
951 952
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
953 954 955
              (let ((msg (format "Desktop: File \"%s\" no longer exists."
                                 desktop-buffer-file-name)))
                 (if desktop-missing-file-warning
956
		     (y-or-n-p (concat msg " Re-create buffer? "))
Deepak Goel's avatar
Deepak Goel committed
957
                   (message "%s" msg)
958
                   nil)))
959 960 961 962 963 964
	  (let* ((auto-insert nil) ; Disable auto insertion
		 (coding-system-for-read
		  (or coding-system-for-read
		      (cdr (assq 'buffer-file-coding-system
				 desktop-buffer-locals))))
		 (buf (find-file-noselect desktop-buffer-file-name)))
965 966
	    (condition-case nil
		(switch-to-buffer buf)
967
	      (error (pop-to-buffer buf)))
968 969 970
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
971
	    buf)
972
	nil)))
973

974 975
(defun desktop-load-file (function)
  "Load the file where auto loaded FUNCTION is defined."
976
  (when function
977
    (let ((fcell (and (fboundp function) (symbol-function function))))
978 979 980
      (when (and (listp fcell)
                 (eq 'autoload (car fcell)))
        (load (cadr fcell))))))
981

982
;; ----------------------------------------------------------------------------
Juri Linkov's avatar
Juri Linkov committed
983 984
;; Create a buffer, load its file, set its mode, ...;
;; called from Desktop file only.
985

986 987 988
;; Just to silence the byte compiler.
(eval-when-compile
  (defvar desktop-first-buffer)) ; Dynamically bound in `desktop-read'
989

990 991 992 993 994 995 996 997 998 999 1000 1001
(defun desktop-create-buffer
  (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
   &optional
   desktop-buffer-locals)
1002 1003 1004 1005
  ;; Just to silence the byte compiler. Bound locally in `desktop-read'.
  (eval-when-compile
    (defvar desktop-buffer-ok-count)
    (defvar desktop-buffer-fail-count))
1006 1007 1008
  ;; To make desktop files with relative file names possible, we cannot
  ;; allow `default-directory' to change. Therefore we save current buffer.
  (save-current-buffer
1009 1010
    ;; Give major mode module a chance to add a handler.
    (desktop-load-file desktop-buffer-major-mode)
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
    (let ((buffer-list (buffer-list))
          (result
           (condition-case err
               (funcall (or (cdr (assq desktop-buffer-major-mode
                                       desktop-buffer-mode-handlers))
                            'desktop-restore-file-buffer)
                        desktop-buffer-file-name
                        desktop-buffer-name
                        desktop-buffer-misc)
             (error
              (message "Desktop: Can't load buffer %s: %s"
                       desktop-buffer-name
                       (error-message-string err))
              (when desktop-missing-file-warning (sit-for 1))
              nil))))
1026 1027 1028 1029
      (if (bufferp result)
          (setq desktop-buffer-ok-count (1+ desktop-buffer-ok-count))
        (setq desktop-buffer-fail-count (1+ desktop-buffer-fail-count))
        (setq result nil))
1030 1031
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
1032
      (unless (< desktop-file-version 206)
1033
        (mapc 'bury-buffer buffer-list)
1034
        (when result (bury-buffer result)))
1035
      (when result
103