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

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

;; Author: Morten Welinder <terra@diku.dk>
Juanma Barranquero's avatar
Juanma Barranquero committed
7
;; Maintainter: Lars Hansen <larsh@math.ku.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 25 26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, 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 109 110
;;;###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
(defvaralias 'desktop-enable 'desktop-save-mode)
(make-obsolete-variable 'desktop-enable 'desktop-save-mode)
111

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

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

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

149
(defcustom desktop-missing-file-warning nil
150 151 152 153 154
  "*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."
155
  :type 'boolean
156 157
  :group 'desktop
  :version "21.4")
Richard M. Stallman's avatar
Richard M. Stallman committed
158

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

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

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

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

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

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

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

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

239
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
240
;;         (ftp) files because they require passwords and whatnot.
241
;;         TAGS files to save time (tags-file-name is saved instead).
242
(defcustom desktop-buffers-not-to-save
243 244 245 246
  "\\(^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
247

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

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

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

270 271 272 273
(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."
274
  :type '(choice (const t) integer)
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  :group 'desktop
  :version "21.4")

(defcustom desktop-lazy-verbose t
  "Verbose reporting of lazily created buffers."
  :type 'boolean
  :group 'desktop
  :version "21.4")

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

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

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.
299

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

303
Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
304 305 306 307 308
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
                        'desktop-save-buffer)
309
(make-obsolete-variable 'desktop-buffer-misc-functions
310
                        'desktop-save-buffer)
311

312 313 314 315 316
(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))
317 318
  "Alist of major mode specific functions to restore a desktop buffer.
Functions are called by `desktop-read'. List elements must have the form
319
\(MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
320 321 322 323

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

324
Handlers are called with argument list
325

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

Furthermore, they may use the following variables:

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

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

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

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

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

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

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

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

381
;; ----------------------------------------------------------------------------
382 383
(defun desktop-clear ()
  "Empty the Desktop.
Lars Hansen's avatar
Lars Hansen committed
384 385 386
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
387
variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
388
  (interactive)
389
  (desktop-lazy-abort)
390 391 392 393
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
394 395
  (let ((buffers (buffer-list)))
    (while buffers
396 397 398 399 400 401 402 403
      (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.
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\ ))
           (kill-buffer (car buffers))))
404
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
405
  (delete-other-windows))
406

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

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

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

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

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

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

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

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

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

655 656 657 658 659 660 661
      (insert
        ";; -*- coding: emacs-mule; -*-\n"
        desktop-header
        ";; Created " (current-time-string) "\n"
        ";; Desktop file format version " desktop-file-version "\n"
        ";; Emacs version " emacs-version "\n\n"
        ";; Global section:\n")
662
      (mapc (function desktop-outvar) desktop-globals-to-save)
Richard M. Stallman's avatar
Richard M. Stallman committed
663
      (if (memq 'kill-ring desktop-globals-to-save)
664 665 666 667
        (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
668

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

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

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

(defvar desktop-lazy-timer nil)

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

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

;; ----------------------------------------------------------------------------
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
788 789 790 791 792 793 794
(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)))
795 796
  (desktop-kill)
  (desktop-clear)
Lars Hansen's avatar
Lars Hansen committed
797 798 799
  (desktop-read dirname))
  
;; ----------------------------------------------------------------------------
800
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
801 802
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
803 804 805 806 807 808 809 810 811 812 813
  (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
814 815 816 817 818 819
  (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))
820

821
;; ----------------------------------------------------------------------------
822 823 824 825 826 827 828
(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))
829 830
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
831 832 833 834 835 836
              (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)))
837 838 839 840 841 842
	  (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)))
843 844
	    (condition-case nil
		(switch-to-buffer buf)
845
	      (error (pop-to-buffer buf)))
846 847 848
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
849
	    buf)
850
	nil)))
851

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

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

860 861 862 863 864 865 866 867 868 869 870 871
(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)
872 873 874 875
  ;; Just to silence the byte compiler. Bound locally in `desktop-read'.
  (eval-when-compile
    (defvar desktop-buffer-ok-count)
    (defvar desktop-buffer-fail-count))
876 877 878
  ;; To make desktop files with relative file names possible, we cannot
  ;; allow `default-directory' to change. Therefore we save current buffer.
  (save-current-buffer
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
    (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))))
894 895 896 897
      (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))
898 899
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
900
      (unless (< desktop-file-version 206)
901
        (mapc 'bury-buffer buffer-list)
902
        (when result (bury-buffer result)))
903
      (when result
904 905
        (unless (or desktop-first-buffer (< desktop-file-version 206))
          (setq desktop-first-buffer result))
906 907 908 909
        (set-buffer result)
        (unless (equal (buffer-name) desktop-buffer-name)
          (rename-buffer desktop-buffer-name))
        ;; minor modes
910 911 912 913 914
        (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
915 916 917
               (mapc #'(lambda (minor-mode)
			 (when (functionp minor-mode) (funcall minor-mode 1)))
		     desktop-buffer-minor-modes)))
918
        ;; Even though point and mark are non-nil when written by `desktop-save'
919
        ;; they may be modified by handlers wanting to set point or mark themselves.
920 921 922 923 924 925
        (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))))
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
        (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)))))))
945

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

960 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 1022
(defun desktop-append-buffer-args (&rest args)
  "Append ARGS at end of `desktop-buffer-args-list'
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"))))

1023
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
1024
;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
;; 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"))
      (if (member key command-line-args)
        (delete key command-line-args)
Lars Hansen's avatar
Lars Hansen committed
1035
        (when desktop-save-mode (desktop-read))))))
1036

Richard M. Stallman's avatar
Richard M. Stallman committed
1037
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
1038

Miles Bader's avatar
Miles Bader committed
1039
;;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9
1040
;;; desktop.el ends here