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

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

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

;; 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
22 23 24
;; 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
25 26 27

;;; Commentary:

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

38
;; To use this, first put these two lines in the bottom of your .emacs
39 40 41 42 43
;; file (the later the better):
;;
;;	(desktop-load-default)
;;	(desktop-read)
;;
44 45 46 47
;; Between these two lines you may wish to add something that updates the
;; variables `desktop-globals-to-save' and/or `desktop-locals-to-save'.  If
;; for instance you want to save the local variable `foobar' for every buffer
;; in which it is local, you could add the line
48 49 50
;;
;;	(setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
;;
51
;; To avoid saving excessive amounts of data you may also wish to add
52 53 54
;; something like the following
;;
;;	(add-hook 'kill-emacs-hook
55
;;		  '(lambda ()
56 57 58 59
;;		     (desktop-truncate search-ring 3)
;;		     (desktop-truncate regexp-search-ring 3)))
;;
;; which will make sure that no more than three search items are saved.  You
60 61
;; must place this line *after* the `(desktop-load-default)' line.  See also
;; the variable `desktop-save-hook'.
Richard M. Stallman's avatar
Richard M. Stallman committed
62

63 64 65 66 67
;; Start Emacs in the root directory of your "project". The desktop saver
;; is inactive by default.  You activate it by M-x desktop-save RET.  When
;; you exit the next time the above data will be saved.  This ensures that
;; all the files you were editing will be reloaded the next time you start
;; Emacs from the same directory and that points will be set where you
68
;; left them.  If you save a desktop file in your home directory it will
69
;; act as a default desktop when you start Emacs from a directory that
70 71
;; doesn't have its own.  I never do this, but you may want to.

72 73 74 75 76 77 78 79
;; 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.

80 81 82 83
;; 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.

84 85 86
;; 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.
87

88 89 90 91 92
;; 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.
93
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
94
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
95 96 97 98 99 100 101
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Save window configuration.
;; Recognize more minor modes.
;; Save mark rings.
;; Start-up with buffer-menu???
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103 104

;;; Code:

105 106 107
;; Make the compilation more silent
(eval-when-compile
  ;; We use functions from these modules
108 109
  ;; We can't (require 'mh-e) since that wants to load something.
  (mapcar 'require '(info dired reporter)))
110
;; ----------------------------------------------------------------------------
111 112
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
113 114 115 116 117

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

118 119 120 121 122
(defcustom desktop-enable nil
  "*Non-nil enable Desktop to save the state of Emacs when you exit."
  :group 'desktop
  :type 'boolean
  :require 'desktop
Dan Nicolaescu's avatar
Dan Nicolaescu committed
123 124
  :initialize 'custom-initialize-default
  :version "20.3")
125 126

(defcustom desktop-basefilename
127
  (convert-standard-filename ".emacs.desktop")
128 129 130
  "File for Emacs desktop, not including the directory name."
  :type 'file
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
131

132
(defcustom desktop-missing-file-warning nil
Richard M. Stallman's avatar
Richard M. Stallman committed
133
  "*If non-nil then desktop warns when a file no longer exists.
134 135 136
Otherwise it simply ignores that file."
  :type 'boolean
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
137

138
(defvar desktop-globals-to-save
Richard M. Stallman's avatar
Richard M. Stallman committed
139
  (list 'desktop-missing-file-warning
140
	;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
141
	;; 'kill-ring
142 143
	'tags-file-name
	'tags-table-list
144 145
	'search-ring
	'regexp-search-ring
146
	'register-alist
147
	;; 'desktop-globals-to-save	; Itself!
Richard M. Stallman's avatar
Richard M. Stallman committed
148
	)
149 150 151 152 153
  "List of global variables to save when killing Emacs.
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.")
Richard M. Stallman's avatar
Richard M. Stallman committed
154

155 156 157 158 159 160 161 162
(defvar desktop-locals-to-save
  (list 'desktop-locals-to-save		; Itself!  Think it over.
        'truncate-lines
	'case-fold-search
	'case-replace
	'fill-column
	'overwrite-mode
	'change-log-default-name
163
	'line-number-mode
164
	)
Richard M. Stallman's avatar
Richard M. Stallman committed
165 166
  "List of local variables to save for each buffer.
The variables are saved only when they really are local.")
167
(make-variable-buffer-local 'desktop-locals-to-save)
168

169
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
170
;;         (ftp) files because they require passwords and whatnot.
171
;;         TAGS files to save time (tags-file-name is saved instead).
172
(defcustom desktop-buffers-not-to-save
173
 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
174 175 176
 "Regexp identifying buffers that are to be excluded from saving."
 :type 'regexp
 :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
177

178
;; Skip ange-ftp files
179
(defcustom desktop-files-not-to-save
180
  "^/[^/:]*:"
181 182 183
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
184

185 186 187 188 189 190 191 192
(defcustom desktop-buffer-modes-to-save
  '(Info-mode rmail-mode)
  "If a buffer is of one of these major modes, save the buffer name.
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)

193 194 195 196 197
(defcustom desktop-modes-not-to-save nil
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

198 199 200 201
(defcustom desktop-buffer-major-mode nil
  "When desktop creates a buffer, this holds the desired Major mode."
  :type 'symbol
  :group 'desktop)
202

203 204 205 206
(defcustom desktop-buffer-file-name nil
  "When desktop creates a buffer, this holds the file name to visit."
  :type '(choice file (const nil))
  :group 'desktop)
207

208 209 210 211
(defcustom desktop-buffer-name nil
  "When desktop creates a buffer, this holds the desired buffer name."
  :type '(choice string (const nil))
  :group 'desktop)
212

213 214 215 216
(defvar desktop-buffer-misc nil
  "When desktop creates a buffer, this holds a list of misc info.
It is used by the `desktop-buffer-handlers' functions.")

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
(defcustom desktop-buffer-misc-functions
  '(desktop-buffer-info-misc-data
    desktop-buffer-dired-misc-data)
  "*Functions used to determine auxiliary information for a buffer.
These functions are called in order, with no arguments.  If a function
returns non-nil, its value is saved along with the desktop buffer for
which it was called; no further functions will be called.

Later, when desktop.el restores the buffers it has saved, each of the
`desktop-buffer-handlers' functions will have access to a buffer local
variable, named `desktop-buffer-misc', whose value is what the
\"misc\" function returned previously."
  :type '(repeat function)
  :group 'desktop)

232
(defcustom desktop-buffer-handlers
233
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
234
    desktop-buffer-rmail
235
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
236 237
    desktop-buffer-info
    desktop-buffer-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
238
  "*List of functions to call in order to create a buffer.
239 240 241 242
The functions are called without explicit parameters but can use the
variables `desktop-buffer-major-mode', `desktop-buffer-file-name',
`desktop-buffer-name'.
If one function returns non-nil, no further functions are called.
243 244 245
If the function returns t then the buffer is considered created."
  :type '(repeat function)
  :group 'desktop)
246

247 248
(put 'desktop-buffer-handlers 'risky-local-variable t)

249 250
(defvar desktop-create-buffer-form "(desktop-create-buffer 205"
  "Opening of form for creation of new buffers.")
251

252
(defcustom desktop-save-hook nil
253 254
  "Hook run before desktop saves the state of Emacs.
This is useful for truncating history lists, for example."
255 256
  :type 'hook
  :group 'desktop)
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271
(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)

272 273
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275 276
  "The directory in which the current desktop file resides.")

(defconst desktop-header
277 278 279
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
280
" "*Header to place in Desktop file.")
281 282 283

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

285
;; ----------------------------------------------------------------------------
286 287 288 289
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
290
	(setcdr here nil))))
291
;; ----------------------------------------------------------------------------
292 293 294 295 296 297 298 299 300 301
(defcustom desktop-clear-preserve-buffers
  '("*scratch*" "*Messages*")
  "*Buffer names that `desktop-clear' should not delete."
  :type '(repeat string)
  :group 'desktop)

(defun desktop-clear ()
  "Empty the Desktop.
This kills all buffers except for internal ones
and those listed in `desktop-clear-preserve-buffers'."
Richard M. Stallman's avatar
Richard M. Stallman committed
302
  (interactive)
303 304 305 306 307 308
  (setq kill-ring nil
	kill-ring-yank-pointer nil
	search-ring nil
	search-ring-yank-pointer nil
	regexp-search-ring nil
	regexp-search-ring-yank-pointer nil)
309 310 311
  (let ((buffers (buffer-list)))
    (while buffers
      (or (member (buffer-name (car buffers)) desktop-clear-preserve-buffers)
312
	  (null (buffer-name (car buffers)))
313 314 315 316 317
	  ;; Don't kill buffers made for internal purposes.
	  (and (not (equal (buffer-name (car buffers)) ""))
	       (eq (aref (buffer-name (car buffers)) 0) ?\ ))
	  (kill-buffer (car buffers)))
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
318
  (delete-other-windows))
319
;; ----------------------------------------------------------------------------
320
(add-hook 'kill-emacs-hook 'desktop-kill)
321

Richard M. Stallman's avatar
Richard M. Stallman committed
322
(defun desktop-kill ()
323
  (if desktop-dirname
324 325 326 327 328 329
      (condition-case err
	  (desktop-save desktop-dirname)
	(file-error
	 (if (yes-or-no-p "Error while saving the desktop.  Quit anyway? ")
	     nil
	   (signal (car err) (cdr err)))))))
330
;; ----------------------------------------------------------------------------
331 332 333 334 335 336 337 338 339 340 341
(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)))

342
(defun desktop-internal-v2s (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344 345 346
  "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)."
347
  (cond
348
   ((or (numberp val) (null val) (eq t val))
349
    (cons 'may (prin1-to-string val)))
350
   ((stringp val)
351 352 353 354
    (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))))
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
   ((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)
377 378
    (let ((p val)
	  newlist
379
	  use-list*
380 381 382 383 384 385 386 387 388
	  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)))
389 390 391 392 393
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
394 395 396
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
397
		(concat (if use-list* "(desktop-list* "  "(list ")
398 399 400 401 402 403 404 405 406
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
407 408 409 410 411 412 413 414 415 416 417 418
   ((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
419
    (cons 'may "\"Unprintable entity\""))))
420

421
(defun desktop-value-to-string (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
422 423
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
424 425 426 427 428 429 430 431
  (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)))
432
;; ----------------------------------------------------------------------------
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
(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)))
448
	      (desktop-truncate (eval var) size))
449 450 451 452 453
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
454
;; ----------------------------------------------------------------------------
455
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
456
  "Return t if the desktop should record a particular buffer for next startup.
457
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
458
MODE is the major mode."
459
  (let ((case-fold-search nil))
460 461 462 463 464 465 466 467 468 469
    (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)
470
		  (memq mode desktop-buffer-modes-to-save))))))
471
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
472 473 474
(defun desktop-save (dirname)
  "Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
  (interactive "DDirectory to save desktop file in: ")
475
  (run-hooks 'desktop-save-hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
476
  (save-excursion
477
    (let ((filename (expand-file-name
Richard M. Stallman's avatar
Richard M. Stallman committed
478
		     (concat dirname desktop-basefilename)))
479 480
	  (info (nreverse
		 (mapcar
481 482
		  (function
		   (lambda (b)
Richard M. Stallman's avatar
Richard M. Stallman committed
483
			      (set-buffer b)
484
			      (list
Richard M. Stallman's avatar
Richard M. Stallman committed
485 486
			       (buffer-file-name)
			       (buffer-name)
487
			       major-mode
488 489 490 491
			       ;; minor modes
			       (let (ret)
				 (mapcar
				  #'(lambda (mim)
492 493
				      (and (boundp mim)
					   (symbol-value mim)
494 495 496 497 498 499 500 501
					   (setq ret
						 (cons (let ((special (assq mim desktop-minor-mode-table)))
							(if special
							    (cadr special)
							  mim))
						      ret))))
				  (mapcar #'car minor-mode-alist))
				 ret)
Richard M. Stallman's avatar
Richard M. Stallman committed
502
			       (point)
503
			       (list (mark t) mark-active)
Richard M. Stallman's avatar
Richard M. Stallman committed
504
			       buffer-read-only
505 506
                               (run-hook-with-args-until-success
                                'desktop-buffer-misc-functions)
507 508 509 510 511 512 513 514 515 516 517
			       (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))
				       (if (member (car locals) loclist)
					   (setq ll (cons (car locals) ll)))))
				   (setq locals (cdr locals)))
				 ll)
Richard M. Stallman's avatar
Richard M. Stallman committed
518 519 520 521 522
			       )))
		  (buffer-list))))
	  (buf (get-buffer-create "*desktop*")))
      (set-buffer buf)
      (erase-buffer)
523

524 525
      (insert desktop-header
	      ";; Created " (current-time-string) "\n"
526 527
	      ";; Emacs version " emacs-version "\n\n"
	      ";; Global section:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
528 529
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
530 531
	  (insert "(setq kill-ring-yank-pointer (nthcdr "
		  (int-to-string
Richard M. Stallman's avatar
Richard M. Stallman committed
532 533 534
		   (- (length kill-ring) (length kill-ring-yank-pointer)))
		  " kill-ring))\n"))

535
      (insert "\n;; Buffer section:\n")
536 537 538 539 540 541 542 543 544 545 546 547
      (mapcar
       (function (lambda (l)
		   (if (apply 'desktop-save-buffer-p l)
		       (progn
			 (insert desktop-create-buffer-form)
			 (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
548 549 550 551
      (setq default-directory dirname)
      (if (file-exists-p filename) (delete-file filename))
      (write-region (point-min) (point-max) filename nil 'nomessage)))
  (setq desktop-dirname dirname))
552
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
553 554 555 556 557
(defun desktop-remove ()
  "Delete the Desktop file and inactivate the desktop system."
  (interactive)
  (if desktop-dirname
      (let ((filename (concat desktop-dirname desktop-basefilename)))
558 559 560
	(setq desktop-dirname nil)
	(if (file-exists-p filename)
	    (delete-file filename)))))
561
;; ----------------------------------------------------------------------------
562
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
563
(defun desktop-read ()
564 565
  "Read the Desktop file and the files it specifies.
This is a no-op when Emacs is running in batch mode."
Richard M. Stallman's avatar
Richard M. Stallman committed
566
  (interactive)
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
  (if noninteractive
      nil
    (let ((dirs '("./" "~/")))
      (while (and dirs
		  (not (file-exists-p (expand-file-name
				       desktop-basefilename
				       (car dirs)))))
	(setq dirs (cdr dirs)))
      (setq desktop-dirname (and dirs (expand-file-name (car dirs))))
      (if desktop-dirname
	  (progn
	    (load (expand-file-name desktop-basefilename desktop-dirname)
		  t t t)
	    (run-hooks 'desktop-delay-hook)
	    (setq desktop-delay-hook nil)
	    (message "Desktop loaded."))
	(desktop-clear)))))
584
;; ----------------------------------------------------------------------------
585
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
586
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588 589
  "Load the `default' start-up library manually.
Also inhibit further loading of it.  Call this from your `.emacs' file
to provide correct modes for autoloaded files."
590
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592 593
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
594 595 596
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
(defun desktop-buffer-info-misc-data ()
  (if (eq major-mode 'Info-mode)
      (list Info-current-file
            Info-current-node)))

(defun desktop-buffer-dired-misc-data ()
  (if (eq major-mode 'dired-mode)
      (cons
       (expand-file-name dired-directory)
       (cdr
        (nreverse
         (mapcar
          (function car)
          dired-subdir-alist))))))

Richard M. Stallman's avatar
Richard M. Stallman committed
612
(defun desktop-buffer-info () "Load an info file."
613
  (if (eq 'Info-mode desktop-buffer-major-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
614
      (progn
615 616 617 618 619 620
	(let ((first (nth 0 desktop-buffer-misc))
	      (second (nth 1 desktop-buffer-misc)))
	(when (and first second)
	  (require 'info)
	  (Info-find-node first second)
	  (current-buffer))))))
621
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
622
(defun desktop-buffer-rmail () "Load an RMAIL file."
623
  (if (eq 'rmail-mode desktop-buffer-major-mode)
624
      (condition-case error
625 626 627 628
	  (progn (rmail-input desktop-buffer-file-name)
                         (if (eq major-mode 'rmail-mode)
                             (current-buffer)
                           rmail-buffer))
629 630 631
	(file-locked
	 (kill-buffer (current-buffer))
	 'ignored))))
632
;; ----------------------------------------------------------------------------
633
(defun desktop-buffer-mh () "Load a folder in the mh system."
634
  (if (eq 'mh-folder-mode desktop-buffer-major-mode)
635 636 637
      (progn
	(require 'mh-e)
	(mh-find-path)
638 639
        (mh-visit-folder desktop-buffer-name)
	(current-buffer))))
640
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
641
(defun desktop-buffer-dired () "Load a directory using dired."
642
  (if (eq 'dired-mode desktop-buffer-major-mode)
643
      (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
644
	  (progn
645
            (dired (car desktop-buffer-misc))
646
	    (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
647
	    (current-buffer))
648
	(message "Directory %s no longer exists." (car desktop-buffer-misc))
649 650
	(sit-for 1)
	'ignored)))
651
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
652
(defun desktop-buffer-file () "Load a file."
653 654
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
655
	      (and desktop-missing-file-warning
656 657
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
658
			      desktop-buffer-file-name))))
659 660 661 662
	  (let ((buf (find-file-noselect desktop-buffer-file-name)))
	    (condition-case nil
		(switch-to-buffer buf)
	      (error (pop-to-buffer buf))))
Richard M. Stallman's avatar
Richard M. Stallman committed
663
	'ignored)))
664 665
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
666
;; only.
667 668
(defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
				  desktop-buffer-major-mode
669 670
				  mim pt mk ro desktop-buffer-misc
				  &optional locals)
Richard M. Stallman's avatar
Richard M. Stallman committed
671 672 673 674 675 676 677
  (let ((hlist desktop-buffer-handlers)
	(result)
	(handler))
    (while (and (not result) hlist)
      (setq handler (car hlist))
      (setq result (funcall handler))
      (setq hlist (cdr hlist)))
678 679 680 681
    (when (bufferp result)
      (set-buffer result)
      (if (not (equal (buffer-name) desktop-buffer-name))
	  (rename-buffer desktop-buffer-name))
682 683 684 685
      ;; minor modes
      (cond ((equal '(t) mim)   (auto-fill-mode 1))	; backwards compatible
	    ((equal '(nil) mim) (auto-fill-mode 0))
	    (t (mapcar #'(lambda (minor-mode)
686 687 688
			   (unless (or (eq minor-mode t) (eq minor-mode nil))
			     (if (and minor-mode (fboundp minor-mode))
				 (funcall minor-mode 1))))
689
			   mim)))
690
      (goto-char pt)
691 692 693 694 695 696 697 698 699 700 701
      (if (consp mk)
	  (progn
	    (set-mark (car mk))
	    (setq mark-active (car (cdr mk))))
	(set-mark mk))
      ;; Never override file system if the file really is read-only marked.
      (if ro (setq buffer-read-only ro))
      (while locals
	(let ((this (car locals)))
	  (if (consp this)
	      ;; an entry of this form `(symbol . value)'
702
	      (progn
703 704 705 706 707 708
		(make-local-variable (car this))
		(set (car this) (cdr this)))
	    ;; an entry of the form `symbol'
	    (make-local-variable this)
	    (makunbound this)))
	(setq locals (cdr locals))))))
709 710

;; Backward compatibility -- update parameters to 205 standards.
711 712
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
713
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
714
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
715 716
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
717 718 719 720 721
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
722
;; ----------------------------------------------------------------------------
723 724 725 726 727 728 729 730 731 732

;; If the user set desktop-enable to t with Custom,
;; do the rest of what it takes to use desktop,
;; but do it after finishing loading the init file.
(add-hook 'after-init-hook
	  '(lambda ()
	     (when desktop-enable
	       (desktop-load-default)
	       (desktop-read))))

Richard M. Stallman's avatar
Richard M. Stallman committed
733
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
734

735
;;; desktop.el ends here