desktop.el 44.4 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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

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

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

;;; Commentary:

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

Kenichi Handa's avatar
Kenichi Handa committed
39 40
;; To use this, use customize to turn on desktop-save-mode or add the
;; following line somewhere in your .emacs file:
41
;;
Kenichi Handa's avatar
Kenichi Handa committed
42
;;	(desktop-save-mode 1)
43
;;
Kenichi Handa's avatar
Kenichi Handa committed
44 45 46 47
;; 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
48
;; added to the `kill-emacs-hook'.  This function is responsible for
Kenichi Handa's avatar
Kenichi Handa committed
49
;; saving the desktop when Emacs is killed.  Furthermore an anonymous
50
;; function is added to the `after-init-hook'.  This function is
Kenichi Handa's avatar
Kenichi Handa committed
51
;; responsible for loading the desktop when Emacs is started.
52

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

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

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

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

;;; Code:

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

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

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

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

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

165
(defcustom desktop-save 'ask-if-new
Kenichi Handa's avatar
Kenichi Handa committed
166 167 168
  "*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:
169 170 171 172 173 174
   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
175
The desktop is never saved when `desktop-save-mode' is nil.
176
The variables `desktop-dirname' and `desktop-base-file-name'
Kenichi Handa's avatar
Kenichi Handa committed
177
determine where the desktop is saved."
178 179
  :type
  '(choice
180 181 182 183 184 185
    (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))
186
  :group 'desktop
187
  :version "22.1")
188 189

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

197 198 199 200
(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)
201
  :group 'desktop
202
  :version "22.1")
203

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

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

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

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

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

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

268 269 270 271 272
(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."
273 274
  :type '(repeat string)
  :group 'desktop)
275

276
;;;###autoload
277 278 279 280 281 282 283 284 285
(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
286 287 288 289
    column-number-mode
    size-indication-mode
    buffer-file-coding-system
    indent-tabs-mode
290
    tab-width
291 292 293
    indicate-buffer-boundaries
    indicate-empty-lines
    show-trailing-whitespace)
Richard M. Stallman's avatar
Richard M. Stallman committed
294
  "List of local variables to save for each buffer.
295 296
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
297 298
  :type '(repeat symbol)
  :group 'desktop)
299

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

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

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

322 323 324 325 326 327 328
(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))
329
  :group 'desktop
330
  :version "22.1")
331

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

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

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

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

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

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

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

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

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

386
Handlers are called with argument list
387

388
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
389 390

Furthermore, they may use the following variables:
391 392 393 394 395 396 397 398 399

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

400
If a handler returns a buffer, then the saved mode settings
401 402 403 404
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
405

406 407 408 409 410 411
   (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.")
412

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

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

433 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
;;;###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'.")

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

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

484 485 486 487 488
(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
489
(defconst desktop-header
490 491 492
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
493
" "*Header to place in Desktop file.")
494 495 496

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
539
(defun desktop-kill ()
Kenichi Handa's avatar
Kenichi Handa committed
540
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
541 542
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
543 544 545 546 547 548 549 550
  (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? ")))))
551 552
    (unless desktop-dirname
      (setq desktop-dirname
553 554 555 556 557
            (file-name-as-directory
             (expand-file-name
              (call-interactively
               (lambda (dir)
                 (interactive "DDirectory for desktop file: ") dir))))))
558
    (condition-case err
559
        (desktop-save desktop-dirname)
560
      (file-error
561 562
       (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
         (signal (car err) (cdr err)))))))
563

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

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

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

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

691
;; ----------------------------------------------------------------------------
692
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
693
  "Return t if buffer should have its state saved in the desktop file.
694
FILENAME is the visited file name, BUFNAME is the buffer name, and
695 696
MODE is the major mode.
\n\(fn FILENAME BUFNAME MODE)"
697
  (let ((case-fold-search nil))
698
    (and (not (string-match desktop-buffers-not-to-save bufname))
699 700 701 702 703 704 705 706 707
         (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))))))
708

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

725
;; ----------------------------------------------------------------------------
726
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
727
(defun desktop-save (dirname)
Kenichi Handa's avatar
Kenichi Handa committed
728 729 730
  "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
731
  (interactive "DDirectory to save desktop file in: ")
732
  (run-hooks 'desktop-save-hook)
733
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
734
  (save-excursion
735
    (let ((filename (desktop-full-file-name dirname))
736 737
          (info
            (mapcar
738
              #'(lambda (b)
739 740 741 742 743 744 745
                  (set-buffer b)
                  (list
                    (desktop-file-name (buffer-file-name) dirname)
                    (buffer-name)
                    major-mode
                    ;; minor modes
                    (let (ret)
746 747
                      (mapc
                        #'(lambda (minor-mode)
748
                          (and
749 750
                            (boundp minor-mode)
                            (symbol-value minor-mode)
751 752 753 754
                            (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)))))
755 756 757 758 759
                        (mapcar #'car minor-mode-alist))
                      ret)
                    (point)
                    (list (mark t) mark-active)
                    buffer-read-only
760
                    ;; Auxiliary information
761 762
                    (when (functionp desktop-save-buffer)
                      (funcall desktop-save-buffer dirname))
763 764 765 766 767 768 769 770 771 772
                    (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)))
773
                      ll)))
774
              (buffer-list)))
775 776
          (eager desktop-restore-eager))
      (with-temp-buffer
Miles Bader's avatar
Miles Bader committed
777 778 779 780
	(insert
	  ";; -*- mode: emacs-lisp; coding: utf-8-emacs; -*-\n"
	  desktop-header
	  ";; Created " (current-time-string) "\n"
781 782 783
         ";; Desktop file format version " desktop-file-version "\n"
         ";; Emacs version " emacs-version "\n\n"
         ";; Global section:\n")
784 785
        (dolist (varspec desktop-globals-to-save)
          (desktop-outvar varspec))
786 787 788
        (if (memq 'kill-ring desktop-globals-to-save)
            (insert
             "(setq kill-ring-yank-pointer (nthcdr "
Miles Bader's avatar
Miles Bader committed
789
	    (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer)))
790
             " kill-ring))\n"))
Miles Bader's avatar
Miles Bader committed
791

792
        (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
793
        (dolist (l info)
Miles Bader's avatar
Miles Bader committed
794 795 796 797 798 799 800 801 802 803 804 805 806
	  (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)
	    (dolist (e l)
	      (insert "\n  " (desktop-value-to-string e)))
	    (insert ")\n\n")))
Miles Bader's avatar
Miles Bader committed
807 808 809
	(setq default-directory dirname)
	(let ((coding-system-for-write 'utf-8-emacs))
	  (write-region (point-min) (point-max) filename nil 'nomessage)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
810
  (setq desktop-dirname dirname))
811

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

824 825 826 827 828
(defvar desktop-buffer-args-list nil
  "List of args for `desktop-create-buffer'.")

(defvar desktop-lazy-timer nil)

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

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

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

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

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

942 943
(defvar desktop-buffer-major-mode)
(defvar desktop-buffer-locals)
944
;; ----------------------------------------------------------------------------
945 946 947 948
(defun desktop-restore-file-buffer (desktop-buffer-file-name
                                    desktop-buffer-name
                                    desktop-buffer-misc)
  "Restore a file buffer."
949 950
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
951 952 953
              (let ((msg (format "Desktop: File \"%s\" no longer exists."
                                 desktop-buffer-file-name)))
                 (if desktop-missing-file-warning
954
		     (y-or-n-p (concat msg " Re-create buffer? "))
Deepak Goel's avatar
Deepak Goel committed
955
                   (message "%s" msg)
956
                   nil)))
Kenichi Handa's avatar
Kenichi Handa committed
957 958 959 960 961 962
	  (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)))
963 964
	    (condition-case nil
		(switch-to-buffer buf)
965
	      (error (pop-to-buffer buf)))
966 967 968
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
969
	    buf)
970
	nil)))
971

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

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

984
;; Just to silence the byte compiler.
985 986 987 988 989