desktop.el 37.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 87 88
;; Make the compilation more silent
(eval-when-compile
  ;; We use functions from these modules
89 90
  ;; We can't (require 'mh-e) since that wants to load something.
  (mapcar 'require '(info dired reporter)))
91 92 93 94 95 96

(defvar desktop-file-version "206"
  "Verion number of desktop file format.
Written into the desktop file and used at desktop read to provide
backward compatibility.")

97
;; ----------------------------------------------------------------------------
98 99
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
100 101 102 103 104

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

Lars Hansen's avatar
Lars Hansen committed
105 106 107 108 109 110 111 112 113 114 115 116
;;;###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)
117

118
(defcustom desktop-save 'ask-if-new
Lars Hansen's avatar
Lars Hansen committed
119 120 121
  "*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:
122 123 124 125 126 127
   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
128 129 130
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."
131 132 133 134 135 136 137 138 139 140
  :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))
  :group 'desktop)

(defcustom desktop-base-file-name
141
  (convert-standard-filename ".emacs.desktop")
Lars Hansen's avatar
Lars Hansen committed
142
  "Name of file for Emacs desktop, excluding the directory part."
143 144
  :type 'file
  :group 'desktop)
145
(defvaralias 'desktop-basefilename 'desktop-base-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
146

147 148 149 150 151 152
(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)
  :group 'desktop)

153
(defcustom desktop-missing-file-warning nil
Lars Hansen's avatar
Lars Hansen committed
154
  "*If non-nil then `desktop-read' warns when a file no longer exists.
155 156 157
Otherwise it simply ignores that file."
  :type 'boolean
  :group 'desktop)
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 163 164 165 166 167 168 169 170 171
May e.g. be used to show a dired buffer."
  :type 'hook
  :group 'desktop)

(defcustom desktop-after-read-hook nil
  "Normal hook run after a sucessful `desktop-read'.
May e.g. be used to show a buffer list."
  :type 'hook
  :group 'desktop)

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

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

(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)
Lars Hansen's avatar
Lars Hansen committed
199
  "List of global variables to clear by `desktop-clear'.
200 201 202 203 204 205 206
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)))
  :group 'desktop)

(defcustom desktop-clear-preserve-buffers-regexp
Lars Hansen's avatar
Lars Hansen committed
207
  "^\\(\\*scratch\\*\\|\\*Messages\\*\\|\\*tramp/.+\\*\\)$"
208 209 210 211 212
  "Regexp identifying buffers that `desktop-clear' should not delete."
  :type 'regexp
  :group 'desktop)

;; Maintained for backward compatibility
Lars Hansen's avatar
Lars Hansen committed
213 214 215 216
(defcustom desktop-clear-preserve-buffers nil
  "*List of buffer names that `desktop-clear' should not delete.
This variable is maintained for backward compatibility only.  Use
`desktop-clear-preserve-buffers-regexp' instead."
217 218
  :type '(repeat string)
  :group 'desktop)
Lars Hansen's avatar
Lars Hansen committed
219 220
(make-obsolete-variable 'desktop-clear-preserve-buffers
                        'desktop-clear-preserve-buffers-regexp)
221

Lars Hansen's avatar
Lars Hansen committed
222
(defcustom desktop-locals-to-save '(
223 224 225 226 227 228 229
  desktop-locals-to-save  ; Itself!  Think it over.
  truncate-lines
  case-fold-search
  case-replace
  fill-column
  overwrite-mode
  change-log-default-name
230 231
  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
(defcustom desktop-buffer-modes-to-save
  '(Info-mode rmail-mode)
Lars Hansen's avatar
Lars Hansen committed
256
  "If a buffer is of one of these major modes, save the buffer state.
257 258 259 260 261
It is up to the functions in `desktop-buffer-handlers' to decide
whether the buffer should be recreated or not, and how."
  :type '(repeat symbol)
  :group 'desktop)

262 263 264 265 266
(defcustom desktop-modes-not-to-save nil
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

267 268 269 270 271 272 273
(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))
274
  :group 'desktop)
275

276 277 278 279
(defcustom desktop-buffer-misc-functions
  '(desktop-buffer-info-misc-data
    desktop-buffer-dired-misc-data)
  "*Functions used to determine auxiliary information for a buffer.
Lars Hansen's avatar
Lars Hansen committed
280 281 282 283
These functions are called by `desktop-save' in order, with no
arguments.  If a function returns non-nil, its value is saved along
with the state of the buffer for which it was called; no further
functions will be called.
284

Lars Hansen's avatar
Lars Hansen committed
285
When file names are returned, they should be formatted using the call
286 287
\"(desktop-file-name FILE-NAME dirname)\".

Lars Hansen's avatar
Lars Hansen committed
288 289 290 291
Later, when `desktop-read' restores buffers, each of the functions in
`desktop-buffer-handlers' will have access to a buffer local variable,
named `desktop-buffer-misc', whose value is what the function in
`desktop-buffer-misc-functions' returned."
292 293 294
  :type '(repeat function)
  :group 'desktop)

295
(defcustom desktop-buffer-handlers
296
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
297
    desktop-buffer-rmail
298
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
299 300
    desktop-buffer-info
    desktop-buffer-file)
Lars Hansen's avatar
Lars Hansen committed
301
  "*Functions called by `desktop-read' in order to create a buffer.
302
The functions are called without explicit parameters but can use the
303 304 305 306 307 308 309 310 311 312 313 314 315
following variables:

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

316
If one function returns non-nil, no further functions are called.
317 318
If the function returns a buffer, then the saved mode settings
and variable values for that buffer are copied into it."
319 320
  :type '(repeat function)
  :group 'desktop)
321

322 323
(put 'desktop-buffer-handlers 'risky-local-variable t)

324 325 326 327 328 329 330 331 332 333 334 335 336 337
(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
and the name of the minor mode function are different have to added to
this table."
  :type 'sexp
  :group 'desktop)

338 339
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Lars Hansen's avatar
Lars Hansen committed
340
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
341 342

(defconst desktop-header
343 344 345
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
346
" "*Header to place in Desktop file.")
347 348 349

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

351
;; ----------------------------------------------------------------------------
352 353 354 355
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
356
	(setcdr here nil))))
357

358
;; ----------------------------------------------------------------------------
359 360
(defun desktop-clear ()
  "Empty the Desktop.
Lars Hansen's avatar
Lars Hansen committed
361 362 363
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
364
variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
365
  (interactive)
366 367 368 369
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
370 371
  (let ((buffers (buffer-list)))
    (while buffers
372 373 374 375 376 377 378 379
      (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))))
380
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
381
  (delete-other-windows))
382

383
;; ----------------------------------------------------------------------------
384
(add-hook 'kill-emacs-hook 'desktop-kill)
385

Richard M. Stallman's avatar
Richard M. Stallman committed
386
(defun desktop-kill ()
Lars Hansen's avatar
Lars Hansen committed
387
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
388 389 390 391
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
392
      desktop-save-mode
393
      (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))))
394
        (or
Alex Schroeder's avatar
Alex Schroeder committed
395
          (eq desktop-save t)
396 397 398 399 400 401 402 403
          (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
404 405 406 407
        (file-name-as-directory
          (expand-file-name
            (call-interactively
              (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
408 409 410 411 412 413
    (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)))))))

414
;; ----------------------------------------------------------------------------
415 416 417 418 419 420 421 422 423 424 425
(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)))

426
;; ----------------------------------------------------------------------------
427
(defun desktop-internal-v2s (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
428 429 430 431
  "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)."
432
  (cond
433
   ((or (numberp val) (null val) (eq t val))
434
    (cons 'may (prin1-to-string val)))
435
   ((stringp val)
436 437 438 439
    (let ((copy (copy-sequence val)))
      (set-text-properties 0 (length copy) nil copy)
      ;; Get rid of text properties because we cannot read them
      (cons 'may (prin1-to-string copy))))
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
   ((symbolp val)
    (cons 'must (prin1-to-string val)))
   ((vectorp val)
    (let* ((special nil)
	   (pass1 (mapcar
		   (lambda (el)
		     (let ((res (desktop-internal-v2s el)))
		       (if (null (car res))
			   (setq special t))
		       res))
		   val)))
      (if special
	  (cons nil (concat "(vector "
			    (mapconcat (lambda (el)
					 (if (eq (car el) 'must)
					     (concat "'" (cdr el))
					   (cdr el)))
				       pass1
				       " ")
			    ")"))
	(cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
   ((consp val)
462 463
    (let ((p val)
	  newlist
464
	  use-list*
465 466 467 468 469 470 471 472 473
	  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)))
474 475 476 477 478
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
479 480 481
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
482
		(concat (if use-list* "(desktop-list* "  "(list ")
483 484 485 486 487 488 489 490 491
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
492 493 494 495 496 497 498 499 500 501 502 503
   ((subrp val)
    (cons nil (concat "(symbol-function '"
		      (substring (prin1-to-string val) 7 -1)
		      ")")))
   ((markerp val)
    (let ((pos (prin1-to-string (marker-position val)))
	  (buf (prin1-to-string (buffer-name (marker-buffer val)))))
      (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
504
    (cons 'may "\"Unprintable entity\""))))
505

506
;; ----------------------------------------------------------------------------
507
(defun desktop-value-to-string (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
508 509
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
510 511 512 513 514 515 516 517
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
	 (quote.txt (desktop-internal-v2s val))
	 (quote (car quote.txt))
	 (txt (cdr quote.txt)))
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
518

519
;; ----------------------------------------------------------------------------
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
(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)))
535
	      (desktop-truncate (eval var) size))
536 537 538 539 540
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
541

542
;; ----------------------------------------------------------------------------
543
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
544
  "Return t if the desktop should record a particular buffer for next startup.
545
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
546
MODE is the major mode."
547
  (let ((case-fold-search nil))
548 549 550 551 552 553 554 555 556 557
    (and (not (string-match desktop-buffers-not-to-save bufname))
	 (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)
		  (save-excursion
		    (set-buffer (get-buffer bufname))
		    (not (string-match desktop-files-not-to-save
				       default-directory))))
	     (and (null filename)
558
		  (memq mode desktop-buffer-modes-to-save))))))
559

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

576
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
577
(defun desktop-save (dirname)
Lars Hansen's avatar
Lars Hansen committed
578 579 580
  "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
581
  (interactive "DDirectory to save desktop file in: ")
582
  (run-hooks 'desktop-save-hook)
583
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
584
  (save-excursion
585
    (let ((filename (expand-file-name desktop-base-file-name dirname))
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
          (info
            (mapcar
              (function
                (lambda (b)
                  (set-buffer b)
                  (list
                    (desktop-file-name (buffer-file-name) dirname)
                    (buffer-name)
                    major-mode
                    ;; minor modes
                    (let (ret)
                      (mapcar
                        #'(lambda (mim)
                          (and
                            (boundp mim)
                            (symbol-value mim)
                            (setq ret
                              (cons
                                (let ((special (assq mim desktop-minor-mode-table)))
                                  (if special (cadr special) mim))
                                ret))))
                        (mapcar #'car minor-mode-alist))
                      ret)
                    (point)
                    (list (mark t) mark-active)
                    buffer-read-only
                    (run-hook-with-args-until-success 'desktop-buffer-misc-functions)
                    (let ((locals desktop-locals-to-save)
                          (loclist (buffer-local-variables))
                          (ll))
                      (while locals
                        (let ((here (assq (car locals) loclist)))
                          (if here
                            (setq ll (cons here ll))
                            (when (member (car locals) loclist)
                              (setq ll (cons (car locals) ll)))))
                        (setq locals (cdr locals)))
                      ll))))
              (buffer-list)))
          (buf (get-buffer-create "*desktop*")))
Richard M. Stallman's avatar
Richard M. Stallman committed
626 627
      (set-buffer buf)
      (erase-buffer)
628

629 630 631 632 633 634 635
      (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")
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
638 639 640 641
        (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
642

643
      (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
644
      (mapcar
645 646 647 648 649 650 651 652 653 654 655 656
        (function
          (lambda (l)
            (if (apply 'desktop-save-buffer-p l)
              (progn
                (insert "(desktop-create-buffer " desktop-file-version)
                (mapcar
                  (function
                    (lambda (e)
                      (insert "\n  " (desktop-value-to-string e))))
                  l)
                (insert ")\n\n")))))
        info)
Richard M. Stallman's avatar
Richard M. Stallman committed
657
      (setq default-directory dirname)
658
      (when (file-exists-p filename) (delete-file filename))
659
      (let ((coding-system-for-write 'emacs-mule))
660
        (write-region (point-min) (point-max) filename nil 'nomessage))))
Richard M. Stallman's avatar
Richard M. Stallman committed
661
  (setq desktop-dirname dirname))
662

663
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
664
(defun desktop-remove ()
Lars Hansen's avatar
Lars Hansen committed
665 666
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
667
  (interactive)
Lars Hansen's avatar
Lars Hansen committed
668 669 670 671
  (when desktop-dirname
    (let ((filename (expand-file-name desktop-base-file-name desktop-dirname)))
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
672
        (delete-file filename)))))
Lars Hansen's avatar
Lars Hansen committed
673

674
;; ----------------------------------------------------------------------------
675
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
676 677 678 679 680 681 682 683
(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
684
  (interactive)
685
  (unless noninteractive
Lars Hansen's avatar
Lars Hansen committed
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
    (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.
      (let ((desktop-first-buffer nil))
        ;; 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.
        (mapcar 'bury-buffer
                (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
        (switch-to-buffer (car (buffer-list)))
        (run-hooks 'desktop-delay-hook)
        (setq desktop-delay-hook nil)
        (run-hooks 'desktop-after-read-hook)
        (message "Desktop loaded.")
        t)
      ;; No desktop file found.
      (desktop-clear)
      (let ((default-directory desktop-dirname))
        (run-hooks 'desktop-no-desktop-file-hook))
      (message "No desktop file.")
      nil)))
727

728
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
729
;; Maintained for backward compatibility
730
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
731
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
732
  "Load the `default' start-up library manually.
Lars Hansen's avatar
Lars Hansen committed
733
Also inhibit further loading of it."
734
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
735 736 737
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
Lars Hansen's avatar
Lars Hansen committed
738
(make-obsolete 'desktop-load-default 'desktop-save-mode)
739 740 741

;; ----------------------------------------------------------------------------
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
742 743 744 745 746 747 748
(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)))
749 750
  (desktop-kill)
  (desktop-clear)
Lars Hansen's avatar
Lars Hansen committed
751 752 753
  (desktop-read dirname))
  
;; ----------------------------------------------------------------------------
754
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
755 756
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
757 758 759 760 761 762 763 764 765 766 767
  (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
768 769 770 771 772 773
  (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))
774

775 776 777
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
778 779 780 781 782 783 784 785 786 787 788 789 790 791

(eval-when-compile ; Just to silence the byte compiler
  (defvar desktop-file-version)
  (defvar desktop-buffer-file-name)
  (defvar desktop-buffer-name)
  (defvar desktop-buffer-major-mode)
  (defvar desktop-buffer-minor-modes)
  (defvar desktop-buffer-point)
  (defvar desktop-buffer-mark)
  (defvar desktop-buffer-read-only)
  (defvar desktop-buffer-misc)
  (defvar desktop-buffer-locals)
)

792 793 794 795 796
(defun desktop-buffer-info-misc-data ()
  (if (eq major-mode 'Info-mode)
      (list Info-current-file
            Info-current-node)))

797
;; ----------------------------------------------------------------------------
798
(defun desktop-buffer-dired-misc-data ()
799 800 801
  (when (eq major-mode 'dired-mode)
    (eval-when-compile (defvar dirname))
    (cons
802 803 804 805 806 807 808 809 810 811 812 813
     ;; Value of `dired-directory'.
     (if (consp dired-directory)
	 ;; Directory name followed by list of files.
	 (cons (desktop-file-name (car dired-directory) dirname) (cdr dired-directory))
       ;; Directory name, optionally with with shell wildcard.
       (desktop-file-name dired-directory dirname))
     ;; Subdirectories in `dired-subdir-alist'.
     (cdr
      (nreverse
       (mapcar
	(function (lambda (f) (desktop-file-name (car f) dirname)))
	dired-subdir-alist))))))
814

815
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
816
(defun desktop-buffer-info () "Load an info file."
817
  (if (eq 'Info-mode desktop-buffer-major-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
818
      (progn
819 820 821 822
	(let ((first (nth 0 desktop-buffer-misc))
	      (second (nth 1 desktop-buffer-misc)))
	(when (and first second)
	  (require 'info)
823 824
	  (with-no-warnings
	   (Info-find-node first second))
825
	  (current-buffer))))))
826

827
;; ----------------------------------------------------------------------------
828
(eval-when-compile (defvar rmail-buffer)) ; Just to silence the byte compiler.
Richard M. Stallman's avatar
Richard M. Stallman committed
829
(defun desktop-buffer-rmail () "Load an RMAIL file."
830
  (if (eq 'rmail-mode desktop-buffer-major-mode)
831
      (condition-case error
832 833 834 835
	  (progn (rmail-input desktop-buffer-file-name)
                         (if (eq major-mode 'rmail-mode)
                             (current-buffer)
                           rmail-buffer))
836 837 838
	(file-locked
	 (kill-buffer (current-buffer))
	 'ignored))))
839

840
;; ----------------------------------------------------------------------------
841
(defun desktop-buffer-mh () "Load a folder in the mh system."
842
  (if (eq 'mh-folder-mode desktop-buffer-major-mode)
843
      (with-no-warnings
844
	(mh-find-path)
845 846
        (mh-visit-folder desktop-buffer-name)
	(current-buffer))))
847

848
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
849
(defun desktop-buffer-dired () "Load a directory using dired."
850
  (if (eq 'dired-mode desktop-buffer-major-mode)
851 852 853
      ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
      ;; This value is a directory name, optionally with with shell wildcard or
      ;; a directory name followed by list of files.
854 855
      (let* ((dired-dir (car desktop-buffer-misc))
	     (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
856 857
	(if (file-directory-p (file-name-directory dir))
	    (progn
858 859 860
	      (dired dired-dir)
              ;; The following elements of `desktop-buffer-misc' are the keys
              ;; from `dired-subdir-alist'.
861 862 863 864 865
	      (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
	      (current-buffer))
	  (message "Directory %s no longer exists." dir)
	  (sit-for 1)
	  'ignored))))
866

867
;; ----------------------------------------------------------------------------
868 869
(defun desktop-buffer-file ()
  "Load a file."
870 871
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
872
	      (and desktop-missing-file-warning
873 874
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
875
			      desktop-buffer-file-name))))
876 877 878 879 880 881
	  (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)))
882 883
	    (condition-case nil
		(switch-to-buffer buf)
884
	      (error (pop-to-buffer buf)))
885 886 887
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
888
	    buf)
Richard M. Stallman's avatar
Richard M. Stallman committed
889
	'ignored)))
890

891 892
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
893
;; only.
894

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
(eval-when-compile ; Just to silence the byte compiler
   (defvar desktop-first-buffer) ;; Dynamically bound in `desktop-read'
)

(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)
  ;; To make desktop files with relative file names possible, we cannot
  ;; allow `default-directory' to change. Therefore we save current buffer.
  (save-current-buffer
    (let (
      (buffer-list (buffer-list))
      (hlist desktop-buffer-handlers)
      (result)
      (handler)
    )
      ;; Call desktop-buffer-handlers to create buffer.
      (while (and (not result) hlist)
        (setq handler (car hlist))
        (setq result (funcall handler))
        (setq hlist (cdr hlist)))
      (unless (bufferp result) (setq result nil))
926 927
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
928
      (unless (< desktop-file-version 206)
929 930
        (mapcar 'bury-buffer buffer-list)
        (when result (bury-buffer result)))
931
      (when result
932 933
        (unless (or desktop-first-buffer (< desktop-file-version 206))
          (setq desktop-first-buffer result))
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
        (set-buffer result)
        (unless (equal (buffer-name) desktop-buffer-name)
          (rename-buffer desktop-buffer-name))
        ;; minor modes
        (cond (
          ;; backwards compatible
          (equal '(t) desktop-buffer-minor-modes)
          (auto-fill-mode 1))(
          (equal '(nil) desktop-buffer-minor-modes)
          (auto-fill-mode 0))(
          t
          (mapcar
            #'(lambda (minor-mode)
              (when (functionp minor-mode) (funcall minor-mode 1)))
            desktop-buffer-minor-modes)))
        ;; Even though point and mark are non-nil when written by `desktop-save'
950
        ;; they may be modified by handlers wanting to set point or mark themselves.
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
        (when desktop-buffer-point (goto-char desktop-buffer-point))
        (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)))))))
971

972
;; ----------------------------------------------------------------------------
973
;; Backward compatibility -- update parameters to 205 standards.
974 975
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
976
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
977
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
978 979
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
980 981 982 983 984
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
985

986
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
987
;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
988 989 990 991 992 993 994 995 996 997
;; 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
998
        (when desktop-save-mode (desktop-read))))))
999

Richard M. Stallman's avatar
Richard M. Stallman committed
1000
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
1001

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