desktop.el 27.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>
Dave Love's avatar
Dave Love committed
7
;; Keywords: convenience
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;; Favourite-brand-of-beer: None, I hate beer.
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; 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
26 27 28

;;; Commentary:

29 30 31 32 33 34 35 36
;; Save the Desktop, i.e.,
;;	- some global variables
;; 	- the list of buffers with associated files.  For each buffer also
;;		- the major mode
;;		- the default directory
;;		- the point
;;		- the mark & mark-active
;;		- buffer-read-only
37
;;		- some local variables
Richard M. Stallman's avatar
Richard M. Stallman committed
38

39
;; To use this, first put these two lines in the bottom of your .emacs
40 41 42 43 44
;; file (the later the better):
;;
;;	(desktop-load-default)
;;	(desktop-read)
;;
45 46 47 48
;; 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
49 50 51
;;
;;	(setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
;;
52
;; To avoid saving excessive amounts of data you may also wish to add
53 54 55
;; something like the following
;;
;;	(add-hook 'kill-emacs-hook
56
;;		  '(lambda ()
57 58 59 60
;;		     (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
61 62
;; 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
63

64 65 66 67 68
;; 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
69
;; left them.  If you save a desktop file in your home directory it will
70
;; act as a default desktop when you start Emacs from a directory that
71 72
;; doesn't have its own.  I never do this, but you may want to.

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

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

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

89 90 91 92 93
;; 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.
94
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
95
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
96 97 98 99 100 101 102
;; ---------------------------------------------------------------------------
;; 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
103 104 105

;;; Code:

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

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

119 120 121 122 123
(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
124 125
  :initialize 'custom-initialize-default
  :version "20.3")
126 127

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

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

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

156 157 158 159 160 161 162 163
(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
164
	'line-number-mode
165
	)
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167
  "List of local variables to save for each buffer.
The variables are saved only when they really are local.")
168
(make-variable-buffer-local 'desktop-locals-to-save)
169

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

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

186 187 188 189 190 191 192 193
(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)

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

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

204 205 206 207
(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)
208

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

214 215 216 217
(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.")

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
(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)

233
(defcustom desktop-buffer-handlers
234
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
235
    desktop-buffer-rmail
236
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
237 238
    desktop-buffer-info
    desktop-buffer-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
239
  "*List of functions to call in order to create a buffer.
240 241 242 243
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.
244 245
If the function returns a buffer, then the saved mode settings
and variable values for that buffer are copied into it."
246 247
  :type '(repeat function)
  :group 'desktop)
248

249 250
(put 'desktop-buffer-handlers 'risky-local-variable t)

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

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

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

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

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

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

287
;; ----------------------------------------------------------------------------
288 289 290 291
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
292
	(setcdr here nil))))
293
;; ----------------------------------------------------------------------------
294 295 296 297 298 299 300 301 302 303
(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
304
  (interactive)
305 306 307 308 309 310
  (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)
311 312 313
  (let ((buffers (buffer-list)))
    (while buffers
      (or (member (buffer-name (car buffers)) desktop-clear-preserve-buffers)
314
	  (null (buffer-name (car buffers)))
315 316 317 318 319
	  ;; 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
320
  (delete-other-windows))
321
;; ----------------------------------------------------------------------------
322
(add-hook 'kill-emacs-hook 'desktop-kill)
323

Richard M. Stallman's avatar
Richard M. Stallman committed
324
(defun desktop-kill ()
325
  (if desktop-dirname
326 327 328 329 330 331
      (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)))))))
332
;; ----------------------------------------------------------------------------
333 334 335 336 337 338 339 340 341 342 343
(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)))

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

423
(defun desktop-value-to-string (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
424 425
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
426 427 428 429 430 431 432 433
  (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)))
434
;; ----------------------------------------------------------------------------
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
(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)))
450
	      (desktop-truncate (eval var) size))
451 452 453 454 455
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
456
;; ----------------------------------------------------------------------------
457
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
458
  "Return t if the desktop should record a particular buffer for next startup.
459
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
460
MODE is the major mode."
461
  (let ((case-fold-search nil))
462 463 464 465 466 467 468 469 470 471
    (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)
472
		  (memq mode desktop-buffer-modes-to-save))))))
473
;; ----------------------------------------------------------------------------
474 475 476 477 478
(defcustom desktop-relative-file-names nil
  "*Store relative file names in the desktop file."
  :type 'boolean
  :group 'desktop)

Richard M. Stallman's avatar
Richard M. Stallman committed
479 480 481
(defun desktop-save (dirname)
  "Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
  (interactive "DDirectory to save desktop file in: ")
482
  (run-hooks 'desktop-save-hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
483
  (save-excursion
484
    (let ((filename (expand-file-name desktop-basefilename dirname))
485 486
	  (info (nreverse
		 (mapcar
487 488
		  (function
		   (lambda (b)
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
                    (set-buffer b)
                    (list
                     (let ((bn (buffer-file-name)))
                       (if bn
                           (if desktop-relative-file-names
                               (file-relative-name bn dirname)
                             bn)))
                     (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))
                             (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
529 530 531 532
		  (buffer-list))))
	  (buf (get-buffer-create "*desktop*")))
      (set-buffer buf)
      (erase-buffer)
533

534 535
      (insert ";; -*- coding: emacs-mule; -*-\n"
	      desktop-header
536
	      ";; Created " (current-time-string) "\n"
537 538
	      ";; Emacs version " emacs-version "\n\n"
	      ";; Global section:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
539 540
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
541 542
	  (insert "(setq kill-ring-yank-pointer (nthcdr "
		  (int-to-string
Richard M. Stallman's avatar
Richard M. Stallman committed
543 544 545
		   (- (length kill-ring) (length kill-ring-yank-pointer)))
		  " kill-ring))\n"))

546
      (insert "\n;; Buffer section:\n")
547 548
      (mapcar
       (function (lambda (l)
549 550 551 552 553 554 555 556 557
         (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")))))
558
       info)
Richard M. Stallman's avatar
Richard M. Stallman committed
559 560
      (setq default-directory dirname)
      (if (file-exists-p filename) (delete-file filename))
561 562
      (let ((coding-system-for-write 'emacs-mule))
	(write-region (point-min) (point-max) filename nil 'nomessage))))
Richard M. Stallman's avatar
Richard M. Stallman committed
563
  (setq desktop-dirname dirname))
564
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
565 566 567 568 569
(defun desktop-remove ()
  "Delete the Desktop file and inactivate the desktop system."
  (interactive)
  (if desktop-dirname
      (let ((filename (concat desktop-dirname desktop-basefilename)))
570 571 572
	(setq desktop-dirname nil)
	(if (file-exists-p filename)
	    (delete-file filename)))))
573
;; ----------------------------------------------------------------------------
574
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
575
(defun desktop-read ()
576 577
  "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
578
  (interactive)
579 580 581 582 583 584 585 586 587 588
  (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
589 590 591 592 593 594 595
	  (let ((desktop-last-buffer nil))
	    ;; `load-with-code-conversion' calls `eval-buffer' which
	    ;; contains a `save-excursion', so we end up with the same
	    ;; buffer before and after the load.  This is a problem
	    ;; when the desktop is read initially when Emacs starts up
	    ;; because, if we still are in *scratch* after running
	    ;; `after-init-hook', the splash screen will be displayed.
596 597
	    (load (expand-file-name desktop-basefilename desktop-dirname)
		  t t t)
598 599
	    (when desktop-last-buffer
	      (switch-to-buffer desktop-last-buffer))
600 601 602 603
	    (run-hooks 'desktop-delay-hook)
	    (setq desktop-delay-hook nil)
	    (message "Desktop loaded."))
	(desktop-clear)))))
604
;; ----------------------------------------------------------------------------
605
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
606
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
607 608 609
  "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."
610
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
611 612 613
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
614 615 616
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
(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
632
(defun desktop-buffer-info () "Load an info file."
633
  (if (eq 'Info-mode desktop-buffer-major-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
634
      (progn
635 636 637 638 639 640
	(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))))))
641
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
642
(defun desktop-buffer-rmail () "Load an RMAIL file."
643
  (if (eq 'rmail-mode desktop-buffer-major-mode)
644
      (condition-case error
645 646 647 648
	  (progn (rmail-input desktop-buffer-file-name)
                         (if (eq major-mode 'rmail-mode)
                             (current-buffer)
                           rmail-buffer))
649 650 651
	(file-locked
	 (kill-buffer (current-buffer))
	 'ignored))))
652
;; ----------------------------------------------------------------------------
653
(defun desktop-buffer-mh () "Load a folder in the mh system."
654
  (if (eq 'mh-folder-mode desktop-buffer-major-mode)
655 656 657
      (progn
	(require 'mh-e)
	(mh-find-path)
658 659
        (mh-visit-folder desktop-buffer-name)
	(current-buffer))))
660
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
661
(defun desktop-buffer-dired () "Load a directory using dired."
662
  (if (eq 'dired-mode desktop-buffer-major-mode)
663
      (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
664
	  (progn
665
            (dired (car desktop-buffer-misc))
666
	    (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
667
	    (current-buffer))
668
	(message "Directory %s no longer exists." (car desktop-buffer-misc))
669 670
	(sit-for 1)
	'ignored)))
671
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
672
(defun desktop-buffer-file () "Load a file."
673 674
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
675
	      (and desktop-missing-file-warning
676 677
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
678
			      desktop-buffer-file-name))))
679 680 681
	  (let ((buf (find-file-noselect desktop-buffer-file-name)))
	    (condition-case nil
		(switch-to-buffer buf)
682 683
	      (error (pop-to-buffer buf)))
	    buf)
Richard M. Stallman's avatar
Richard M. Stallman committed
684
	'ignored)))
685 686
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
687
;; only.
688 689 690 691

(defvar desktop-last-buffer nil
  "Last buffer read.  Dynamically bound in `desktop-read'.")

692 693
(defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
				  desktop-buffer-major-mode
694 695
				  mim pt mk ro desktop-buffer-misc
				  &optional locals)
Richard M. Stallman's avatar
Richard M. Stallman committed
696 697 698 699 700 701 702
  (let ((hlist desktop-buffer-handlers)
	(result)
	(handler))
    (while (and (not result) hlist)
      (setq handler (car hlist))
      (setq result (funcall handler))
      (setq hlist (cdr hlist)))
703
    (when (bufferp result)
704
      (setq desktop-last-buffer result)
705 706 707
      (set-buffer result)
      (if (not (equal (buffer-name) desktop-buffer-name))
	  (rename-buffer desktop-buffer-name))
708 709 710 711
      ;; minor modes
      (cond ((equal '(t) mim)   (auto-fill-mode 1))	; backwards compatible
	    ((equal '(nil) mim) (auto-fill-mode 0))
	    (t (mapcar #'(lambda (minor-mode)
712 713 714
			   (when (functionp minor-mode)
			     (funcall minor-mode 1)))
		       mim)))
715
      (goto-char pt)
716 717 718 719 720 721 722 723 724 725 726
      (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)'
727
	      (progn
728 729 730 731 732 733
		(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))))))
734 735

;; Backward compatibility -- update parameters to 205 standards.
736 737
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
738
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
739
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
740 741
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
742 743 744 745 746
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
747
;; ----------------------------------------------------------------------------
748 749 750 751 752 753 754 755 756 757

;; 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
758
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
759

760
;;; desktop.el ends here