desktop.el 39.6 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, 2005
4
;;   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 60 61
;; Some words on minor modes: Most minor modes are controlled by
;; buffer-local variables, which have a standard save / restore
;; mechanism.  To handle all minor modes, we take the following
;; approach: (1) check whether the variable name from
;; `minor-mode-alist' is also a function; and (2) use translation
;; table `desktop-minor-mode-table' in the case where the two names
;; are not the same.

62 63 64 65
;; 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.

66 67 68
;; 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.
69

70 71 72 73 74
;; 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.
75
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
76
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
77 78 79 80 81 82
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Save window configuration.
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85

;;; Code:

86
(defvar desktop-file-version "206"
87
  "Version number of desktop file format.
88 89 90
Written into the desktop file and used at desktop read to provide
backward compatibility.")

91
;; ----------------------------------------------------------------------------
92 93
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
94 95 96 97 98

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

Lars Hansen's avatar
Lars Hansen committed
99 100 101 102 103 104 105 106 107 108
;;;###autoload
(define-minor-mode desktop-save-mode
  "Toggle desktop saving mode.
With numeric ARG, turn desktop saving on if ARG is positive, off
otherwise.  See variable `desktop-save' for a description of when the
desktop is saved."
  :global t
  :group 'desktop)

;; Maintained for backward compatibility
109
(define-obsolete-variable-alias 'desktop-enable 'desktop-save-mode "22.1")
110

111
(defcustom desktop-save 'ask-if-new
Lars Hansen's avatar
Lars Hansen committed
112 113 114
  "*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:
115 116 117 118 119 120
   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
121
The desktop is never saved when `desktop-save-mode' is nil.
122
The variables `desktop-dirname' and `desktop-base-file-name'
Lars Hansen's avatar
Lars Hansen committed
123
determine where the desktop is saved."
124 125 126 127 128 129 130
  :type '(choice
    (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))
131
  :group 'desktop
132
  :version "22.1")
133 134

(defcustom desktop-base-file-name
135
  (convert-standard-filename ".emacs.desktop")
Lars Hansen's avatar
Lars Hansen committed
136
  "Name of file for Emacs desktop, excluding the directory part."
137 138
  :type 'file
  :group 'desktop)
139
(define-obsolete-variable-alias 'desktop-basefilename 'desktop-base-file-name "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
140

141 142 143 144
(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)
145
  :group 'desktop
146
  :version "22.1")
147

148
(defcustom desktop-missing-file-warning nil
149 150 151 152 153
  "*If non-nil then `desktop-read' asks if a non-existent file should be recreated.
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."
154
  :type 'boolean
155
  :group 'desktop
156
  :version "22.1")
Richard M. Stallman's avatar
Richard M. Stallman committed
157

158
(defcustom desktop-no-desktop-file-hook nil
Lars Hansen's avatar
Lars Hansen committed
159
  "Normal hook run when `desktop-read' can't find a desktop file.
160
May be used to show a dired buffer."
161
  :type 'hook
162
  :group 'desktop
163
  :version "22.1")
164 165

(defcustom desktop-after-read-hook nil
166
  "Normal hook run after a successful `desktop-read'.
167
May be used to show a buffer list."
168
  :type 'hook
169
  :group 'desktop
170
  :version "22.1")
171 172

(defcustom desktop-save-hook nil
Lars Hansen's avatar
Lars Hansen committed
173
  "Normal hook run before the desktop is saved in a desktop file.
174 175 176 177
This is useful for truncating history lists, for example."
  :type 'hook
  :group 'desktop)

178 179 180 181 182 183 184
(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
185 186 187 188
  "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.
189 190 191 192
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
  :group 'desktop)

193 194 195 196 197 198 199
(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)
200
  "List of global variables that `desktop-clear' will clear.
201
An element may be variable name (a symbol) or a cons cell of the form
202 203
\(VAR . FORM).  Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluating FORM."
204
  :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
205
  :group 'desktop
206
  :version "22.1")
207 208

(defcustom desktop-clear-preserve-buffers-regexp
209
  "^\\(\\*scratch\\*\\|\\*Messages\\*\\|\\*server\\*\\|\\*tramp/.+\\*\\)$"
210 211
  "Regexp identifying buffers that `desktop-clear' should not delete.
See also `desktop-clear-preserve-buffers'."
212
  :type 'regexp
213
  :group 'desktop
214
  :version "22.1")
215

Lars Hansen's avatar
Lars Hansen committed
216 217
(defcustom desktop-clear-preserve-buffers nil
  "*List of buffer names that `desktop-clear' should not delete.
218
See also `desktop-clear-preserve-buffers-regexp'."
219 220
  :type '(repeat string)
  :group 'desktop)
221 222 223 224 225 226 227 228 229 230 231

(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
    buffer-file-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
232
  "List of local variables to save for each buffer.
Lars Hansen's avatar
Lars Hansen committed
233 234 235
The variables are saved only when they really are local."
  :type '(repeat symbol)
  :group 'desktop)
236
(make-variable-buffer-local 'desktop-locals-to-save)
237

238
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
239
;;         (ftp) files because they require passwords and whatnot.
240
;;         TAGS files to save time (tags-file-name is saved instead).
241
(defcustom desktop-buffers-not-to-save
242 243 244 245
  "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
  "Regexp identifying buffers that are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
246

Lars Hansen's avatar
Lars Hansen committed
247
;; Skip tramp and ange-ftp files
248
(defcustom desktop-files-not-to-save
249
  "^/[^/:]*:"
250 251 252
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
253

254 255 256 257 258
(defcustom desktop-modes-not-to-save nil
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

259 260 261 262 263 264 265
(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))
266
  :group 'desktop
267
  :version "22.1")
268

269 270 271 272
(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."
273
  :type '(choice (const t) integer)
274
  :group 'desktop
275
  :version "22.1")
276 277 278 279 280

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
281
  :version "22.1")
282 283 284 285 286 287

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

290
;;;###autoload
291 292
(defvar desktop-save-buffer nil
  "When non-nil, save buffer status in desktop file.
293
This variable becomes buffer local when set.
294 295 296 297

If the value is a function, it called by `desktop-save' with argument
DESKTOP-DIRNAME to obtain auxiliary information to saved in the desktop
file along with the state of the buffer for which it was called.
298

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

302
Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
303 304 305 306
to restore the buffer, the auxiliary information is passed as the argument
DESKTOP-BUFFER-MISC.")
(make-variable-buffer-local 'desktop-save-buffer)
(make-obsolete-variable 'desktop-buffer-modes-to-save
307
                        'desktop-save-buffer "22.1")
308
(make-obsolete-variable 'desktop-buffer-misc-functions
309
                        'desktop-save-buffer "22.1")
310

311 312 313 314 315
(defcustom desktop-buffer-mode-handlers
  '((dired-mode . dired-restore-desktop-buffer)
    (rmail-mode . rmail-restore-desktop-buffer)
    (mh-folder-mode . mh-restore-desktop-buffer)
    (Info-mode . Info-restore-desktop-buffer))
316
  "Alist of major mode specific functions to restore a desktop buffer.
317
Functions are called by `desktop-read'.  List elements must have the form
318
\(MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
319 320 321 322

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

323
Handlers are called with argument list
324

325
   (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
326 327 328 329

Furthermore, they may use the following variables:

   desktop-file-version
330 331 332 333 334 335 336
   desktop-buffer-major-mode
   desktop-buffer-minor-modes
   desktop-buffer-point
   desktop-buffer-mark
   desktop-buffer-read-only
   desktop-buffer-locals

337
If a handler returns a buffer, then the saved mode settings
338
and variable values for that buffer are copied into it."
339
  :type 'alist
340
  :group 'desktop)
341

342 343
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
344
                        'desktop-buffer-mode-handlers "22.1")
345

346 347 348 349 350 351 352 353 354
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
    (vc-mode nil))
  "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
355
and the name of the minor mode function are different have to be added to
356 357 358 359
this table."
  :type 'sexp
  :group 'desktop)

360 361
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Lars Hansen's avatar
Lars Hansen committed
362
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364

(defconst desktop-header
365 366 367
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
368
" "*Header to place in Desktop file.")
369 370 371

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

373
;; ----------------------------------------------------------------------------
374
(defun desktop-truncate (list n)
375
  "Truncate LIST to at most N elements destructively."
376
  (let ((here (nthcdr (1- n) list)))
377
    (if (consp here)
378
	(setcdr here nil))))
379

380
;; ----------------------------------------------------------------------------
381 382
(defun desktop-clear ()
  "Empty the Desktop.
Lars Hansen's avatar
Lars Hansen committed
383 384 385
This kills all buffers except for internal ones and those matching
`desktop-clear-preserve-buffers-regexp' or listed in
`desktop-clear-preserve-buffers'.  Furthermore, it clears the
386
variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
387
  (interactive)
388
  (desktop-lazy-abort)
389 390 391 392
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
393 394
  (let ((buffers (buffer-list)))
    (while buffers
395 396 397 398 399 400
      (let ((bufname (buffer-name (car buffers))))
         (or
           (null bufname)
           (string-match desktop-clear-preserve-buffers-regexp bufname)
           (member bufname desktop-clear-preserve-buffers)
           ;; Don't kill buffers made for internal purposes.
401
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\s))
402
           (kill-buffer (car buffers))))
403
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
404
  (delete-other-windows))
405

406
;; ----------------------------------------------------------------------------
407
(add-hook 'kill-emacs-hook 'desktop-kill)
408

Richard M. Stallman's avatar
Richard M. Stallman committed
409
(defun desktop-kill ()
Lars Hansen's avatar
Lars Hansen committed
410
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
411 412 413 414
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
  (when
    (and
Lars Hansen's avatar
Lars Hansen committed
415
      desktop-save-mode
416
      (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))))
417
        (or
Alex Schroeder's avatar
Alex Schroeder committed
418
          (eq desktop-save t)
419 420 421 422 423 424 425 426
          (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? ")))))
    (unless desktop-dirname
      (setq desktop-dirname
427 428 429 430
        (file-name-as-directory
          (expand-file-name
            (call-interactively
              (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
431 432 433
    (condition-case err
      (desktop-save desktop-dirname)
      (file-error
434
        (unless (yes-or-no-p "Error while saving the desktop.  Ignore? ")
435 436
          (signal (car err) (cdr err)))))))

437
;; ----------------------------------------------------------------------------
438 439 440 441 442 443 444 445 446 447 448
(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)))

449
;; ----------------------------------------------------------------------------
450
(defun desktop-internal-v2s (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
451 452 453 454
  "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)."
455
  (cond
456
   ((or (numberp value) (null value) (eq t value) (keywordp value))
457 458 459
    (cons 'may (prin1-to-string value)))
   ((stringp value)
    (let ((copy (copy-sequence value)))
460 461 462
      (set-text-properties 0 (length copy) nil copy)
      ;; Get rid of text properties because we cannot read them
      (cons 'may (prin1-to-string copy))))
463 464 465
   ((symbolp value)
    (cons 'must (prin1-to-string value)))
   ((vectorp value)
466 467 468 469 470 471 472
    (let* ((special nil)
	   (pass1 (mapcar
		   (lambda (el)
		     (let ((res (desktop-internal-v2s el)))
		       (if (null (car res))
			   (setq special t))
		       res))
473
		   value)))
474 475 476 477 478 479 480 481 482 483
      (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 " ") "]")))))
484 485
   ((consp value)
    (let ((p value)
486
	  newlist
487
	  use-list*
488 489 490 491 492 493 494 495 496
	  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)))
497 498 499 500 501
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
502 503 504
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
505
		(concat (if use-list* "(desktop-list* "  "(list ")
506 507 508 509 510 511 512 513 514
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
515
   ((subrp value)
516
    (cons nil (concat "(symbol-function '"
517
		      (substring (prin1-to-string value) 7 -1)
518
		      ")")))
519 520 521
   ((markerp value)
    (let ((pos (prin1-to-string (marker-position value)))
	  (buf (prin1-to-string (buffer-name (marker-buffer value)))))
522 523 524 525 526
      (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
527
    (cons 'may "\"Unprintable entity\""))))
528

529
;; ----------------------------------------------------------------------------
530
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
533 534
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
535
	 (quote.txt (desktop-internal-v2s value))
536 537 538 539 540
	 (quote (car quote.txt))
	 (txt (cdr quote.txt)))
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
541

542
;; ----------------------------------------------------------------------------
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
(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),
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."
  (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)))
558
	      (desktop-truncate (eval var) size))
559 560 561 562 563
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
564

565
;; ----------------------------------------------------------------------------
566
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
567
  "Return t if buffer should have its state saved in the desktop file.
568
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
569
MODE is the major mode."
570
  (let ((case-fold-search nil))
571
    (and (not (string-match desktop-buffers-not-to-save bufname))
572 573 574 575 576 577 578 579 580
         (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))))))
581

582
;; ----------------------------------------------------------------------------
583 584 585 586 587 588 589 590 591 592 593 594 595 596
(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))))
597

598
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
599
(defun desktop-save (dirname)
Lars Hansen's avatar
Lars Hansen committed
600 601 602
  "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
603
  (interactive "DDirectory to save desktop file in: ")
604
  (run-hooks 'desktop-save-hook)
605
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
606
  (save-excursion
607
    (let ((filename (expand-file-name desktop-base-file-name dirname))
608 609
          (info
            (mapcar
610
              #'(lambda (b)
611 612 613 614 615 616 617
                  (set-buffer b)
                  (list
                    (desktop-file-name (buffer-file-name) dirname)
                    (buffer-name)
                    major-mode
                    ;; minor modes
                    (let (ret)
618 619
                      (mapc
                        #'(lambda (minor-mode)
620
                          (and
621 622 623 624 625 626 627 628
                            (boundp minor-mode)
                            (symbol-value minor-mode)
                            (let ((special (assq minor-mode desktop-minor-mode-table)))
                              (when (or special (functionp minor-mode))
                                (setq ret
                                  (cons
                                    (if special (cadr special) minor-mode)
                                    ret))))))
629 630 631 632 633
                        (mapcar #'car minor-mode-alist))
                      ret)
                    (point)
                    (list (mark t) mark-active)
                    buffer-read-only
634
                    ;; Auxiliary information
635 636
                    (when (functionp desktop-save-buffer)
                      (funcall desktop-save-buffer dirname))
637 638 639 640 641 642 643 644 645 646
                    (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)))
647
                      ll)))
648
              (buffer-list)))
649
          (eager desktop-restore-eager)
650
          (buf (get-buffer-create "*desktop*")))
Richard M. Stallman's avatar
Richard M. Stallman committed
651 652
      (set-buffer buf)
      (erase-buffer)
653

654
      (insert
655
        ";; -*- mode: emacs-lisp; coding: emacs-mule; -*-\n"
656 657 658 659 660
        desktop-header
        ";; Created " (current-time-string) "\n"
        ";; Desktop file format version " desktop-file-version "\n"
        ";; Emacs version " emacs-version "\n\n"
        ";; Global section:\n")
661
      (mapc (function desktop-outvar) desktop-globals-to-save)
Richard M. Stallman's avatar
Richard M. Stallman committed
662
      (if (memq 'kill-ring desktop-globals-to-save)
663 664 665 666
        (insert
          "(setq kill-ring-yank-pointer (nthcdr "
          (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer)))
          " kill-ring))\n"))
Richard M. Stallman's avatar
Richard M. Stallman committed
667

668
      (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
669
      (mapc #'(lambda (l)
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
                (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)
Richard M. Stallman's avatar
Richard M. Stallman committed
685
      (setq default-directory dirname)
686
      (when (file-exists-p filename) (delete-file filename))
687
      (let ((coding-system-for-write 'emacs-mule))
688
        (write-region (point-min) (point-max) filename nil 'nomessage))))
Richard M. Stallman's avatar
Richard M. Stallman committed
689
  (setq desktop-dirname dirname))
690

691
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
692
(defun desktop-remove ()
Lars Hansen's avatar
Lars Hansen committed
693 694
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
695
  (interactive)
Lars Hansen's avatar
Lars Hansen committed
696 697 698 699
  (when desktop-dirname
    (let ((filename (expand-file-name desktop-base-file-name desktop-dirname)))
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
700
        (delete-file filename)))))
Lars Hansen's avatar
Lars Hansen committed
701

702 703 704 705 706
(defvar desktop-buffer-args-list nil
  "List of args for `desktop-create-buffer'.")

(defvar desktop-lazy-timer nil)

707
;; ----------------------------------------------------------------------------
708
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
709 710 711 712
(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
713
is processed and `desktop-after-read-hook' is run.  If no desktop file
Lars Hansen's avatar
Lars Hansen committed
714 715 716
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
717
  (interactive)
718
  (unless noninteractive
Lars Hansen's avatar
Lars Hansen committed
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    (setq desktop-dirname
      (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 (expand-file-name desktop-base-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 (expand-file-name desktop-base-file-name desktop-dirname))
      ;; Desktop file found, process it.
740 741 742
      (let ((desktop-first-buffer nil)
            (desktop-buffer-ok-count 0)
            (desktop-buffer-fail-count 0))
743
        (setq desktop-lazy-timer nil)
Lars Hansen's avatar
Lars Hansen committed
744 745 746 747 748
        ;; Evaluate desktop buffer.
        (load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
        ;; `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.
749 750
        (mapc 'bury-buffer
              (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
Lars Hansen's avatar
Lars Hansen committed
751 752 753 754
        (switch-to-buffer (car (buffer-list)))
        (run-hooks 'desktop-delay-hook)
        (setq desktop-delay-hook nil)
        (run-hooks 'desktop-after-read-hook)
755
        (message "Desktop: %d buffer%s restored%s%s."
756 757 758 759
                 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)
760 761 762 763
                   "")
                 (if desktop-buffer-args-list
                     (format ", %d to restore lazily"
                             (length desktop-buffer-args-list))
764
                   ""))
Lars Hansen's avatar
Lars Hansen committed
765 766 767 768 769 770 771
        t)
      ;; No desktop file found.
      (desktop-clear)
      (let ((default-directory desktop-dirname))
        (run-hooks 'desktop-no-desktop-file-hook))
      (message "No desktop file.")
      nil)))
772

773
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
774
;; Maintained for backward compatibility
775
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
776
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
777
  "Load the `default' start-up library manually.
Lars Hansen's avatar
Lars Hansen committed
778
Also inhibit further loading of it."
779
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
780 781 782
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
783
(make-obsolete 'desktop-load-default 'desktop-save-mode "22.1")
784 785 786

;; ----------------------------------------------------------------------------
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
787 788 789 790 791 792 793
(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)))
794 795
  (desktop-kill)
  (desktop-clear)
Lars Hansen's avatar
Lars Hansen committed
796
  (desktop-read dirname))
797

Lars Hansen's avatar
Lars Hansen committed
798
;; ----------------------------------------------------------------------------
799
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
800 801
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
802 803 804 805 806 807 808 809 810 811 812
  (interactive)
  (if desktop-dirname
    (desktop-save desktop-dirname)
    (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
813 814 815 816 817 818
  (unless desktop-dirname
    (error "Unknown desktop directory"))
  (unless (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))
    (error "No desktop file found"))
  (desktop-clear)
  (desktop-read desktop-dirname))
819

820
;; ----------------------------------------------------------------------------
821 822 823 824 825 826 827
(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))
828 829
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
830 831 832 833 834 835
              (let ((msg (format "Desktop: File \"%s\" no longer exists."
                                 desktop-buffer-file-name)))
                 (if desktop-missing-file-warning
		     (y-or-n-p (concat msg " Re-create? "))
                   (message msg)
                   nil)))
836 837 838 839 840 841
	  (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)))
842 843
	    (condition-case nil
		(switch-to-buffer buf)
844
	      (error (pop-to-buffer buf)))
845 846 847
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
848
	    buf)
849
	nil)))
850

851
;; ----------------------------------------------------------------------------
Juri Linkov's avatar
Juri Linkov committed
852 853
;; Create a buffer, load its file, set its mode, ...;
;; called from Desktop file only.
854

855 856 857 858
(eval-when-compile ; Just to silence the byte compiler
   (defvar desktop-first-buffer) ;; Dynamically bound in `desktop-read'
)

859 860 861 862 863 864 865 866 867 868 869 870
(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)
871 872 873 874
  ;; Just to silence the byte compiler. Bound locally in `desktop-read'.
  (eval-when-compile
    (defvar desktop-buffer-ok-count)
    (defvar desktop-buffer-fail-count))
875 876 877
  ;; To make desktop files with relative file names possible, we cannot
  ;; allow `default-directory' to change. Therefore we save current buffer.
  (save-current-buffer
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
    (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))))
893 894 895 896
      (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))
897 898
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
899
      (unless (< desktop-file-version 206)
900
        (mapc 'bury-buffer buffer-list)
901
        (when result (bury-buffer result)))
902
      (when result
903 904
        (unless (or desktop-first-buffer (< desktop-file-version 206))
          (setq desktop-first-buffer result))
905 906 907 908
        (set-buffer result)
        (unless (equal (buffer-name) desktop-buffer-name)
          (rename-buffer desktop-buffer-name))
        ;; minor modes
909 910 911 912 913
        (cond ((equal '(t) desktop-buffer-minor-modes) ; backwards compatible
               (auto-fill-mode 1))
              ((equal '(nil) desktop-buffer-minor-modes) ; backwards compatible
               (auto-fill-mode 0))
              (t
914 915 916
               (mapc #'(lambda (minor-mode)
			 (when (functionp minor-mode) (funcall minor-mode 1)))
		     desktop-buffer-minor-modes)))
917
        ;; Even though point and mark are non-nil when written by `desktop-save'
918
        ;; they may be modified by handlers wanting to set point or mark themselves.
919 920 921 922 923 924
        (when desktop-buffer-point
          (goto-char
            (condition-case err
                ;; Evaluate point. Thus point can be something like '(search-forward ...
                (eval desktop-buffer-point)
              (error (message "%s" (error-message-string err)) 1))))
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
        (when desktop-buffer-mark
          (if (consp desktop-buffer-mark)
            (progn
              (set-mark (car desktop-buffer-mark))
              (setq mark-active (car (cdr desktop-buffer-mark))))
            (set-mark desktop-buffer-mark)))
        ;; Never override file system if the file really is read-only marked.
        (if desktop-buffer-read-only (setq buffer-read-only desktop-buffer-read-only))
        (while desktop-buffer-locals
          (let ((this (car desktop-buffer-locals)))
            (if (consp this)
              ;; an entry of this form `(symbol . value)'
              (progn
                (make-local-variable (car this))
                (set (car this) (cdr this)))
              ;; an entry of the form `symbol'
              (make-local-variable this)
              (makunbound this)))
          (setq desktop-buffer-locals (cdr desktop-buffer-locals)))))))
944

945
;; ----------------------------------------------------------------------------
946
;; Backward compatibility -- update parameters to 205 standards.
947 948
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
949
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
950
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
951 952
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
953 954 955 956 957
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
958

959
(defun desktop-append-buffer-args (&rest args)
960
  "Append ARGS at end of `desktop-buffer-args-list'.
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
ARGS must be an argument list for `desktop-create-buffer'."
  (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args)))
  (unless desktop-lazy-timer
    (setq desktop-lazy-timer
          (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers))))

(defun desktop-lazy-create-buffer ()
  "Pop args from `desktop-buffer-args-list', create buffer and bury it."
  (when desktop-buffer-args-list
    (let* ((remaining (length desktop-buffer-args-list))
           (args (pop desktop-buffer-args-list))
           (buffer-name (nth 2 args))
           (msg (format "Desktop lazily opening %s (%s remaining)..."
                            buffer-name remaining)))
      (when desktop-lazy-verbose
        (message msg))
      (let ((desktop-first-buffer nil)
            (desktop-buffer-ok-count 0)
            (desktop-buffer-fail-count 0))
        (apply 'desktop-create-buffer args)
        (run-hooks 'desktop-delay-hook)
        (setq desktop-delay-hook nil)
        (bury-buffer (get-buffer buffer-name))
        (when desktop-lazy-verbose
          (message "%s%s" msg (if (> desktop-buffer-ok-count 0) "done" "failed")))))))

(defun desktop-idle-create-buffers ()
  "Create buffers until the user does something, then stop.
If there are no buffers left to create, kill the timer."
  (let ((repeat 1))
    (while (and repeat desktop-buffer-args-list)
      (save-window-excursion
        (desktop-lazy-create-buffer))
      (setq repeat (sit-for 0.2))
    (unless desktop-buffer-args-list
      (cancel-timer desktop-lazy-timer)
      (setq desktop-lazy-timer nil)
      (message "Lazy desktop load complete")
      (sit-for 3)
      (message "")))))

(defun desktop-lazy-complete ()
  "Run the desktop load to completion."
  (interactive)
  (let ((desktop-lazy-verbose t))
    (while desktop-buffer-args-list
      (save-window-excursion
        (desktop-lazy-create-buffer)))
    (message "Lazy desktop load complete")))

(defun desktop-lazy-abort ()
  "Abort lazy loading of the desktop."
  (interactive)
  (when desktop-lazy-timer
    (cancel-timer desktop-lazy-timer)
    (setq desktop-lazy-timer nil))
  (when desktop-buffer-args-list
    (setq desktop-buffer-args-list nil)
    (when (interactive-p)
      (message "Lazy desktop load aborted"))))

1022
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
1023
;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
1024 1025 1026 1027 1028 1029 1030 1031
;; command line, we do the rest of what it takes to use desktop, but do it
;; after finishing loading the init file.
;; We cannot use `command-switch-alist' to process "--no-desktop" because these
;; functions are processed after `after-init-hook'.
(add-hook
  'after-init-hook
  '(lambda ()
    (let ((key "--no-desktop"))
1032 1033 1034 1035
      (when (member key command-line-args)
        (setq command-line-args (delete key command-line-args))
        (setq desktop-save-mode nil)))
    (when desktop-save-mode (desktop-read))))
1036

Richard M. Stallman's avatar