desktop.el 22.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 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5

;; Author: Morten Welinder <terra@diku.dk>
Richard M. Stallman's avatar
Richard M. Stallman committed
6 7
;; Keywords: customization
;; 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
;; Between the second and the third line you may wish to add something that
45
;; updates the variables `desktop-globals-to-save' and/or
46 47 48 49 50 51
;; `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
;;
;;	(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 (load "desktop") 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 73 74 75 76
;; doesn't have its own.  I never do this, but you may want to.

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

77 78 79
;; 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.
80

81 82 83 84 85
;; 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.
86
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
87
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
88 89 90 91 92 93 94
;; ---------------------------------------------------------------------------
;; 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
95 96 97

;;; Code:

98 99 100
;; Make the compilation more silent
(eval-when-compile
  ;; We use functions from these modules
101 102
  ;; We can't (require 'mh-e) since that wants to load something.
  (mapcar 'require '(info dired reporter)))
103
;; ----------------------------------------------------------------------------
104 105
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
106 107 108 109 110

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

111 112 113 114 115
(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
116 117
  :initialize 'custom-initialize-default
  :version "20.3")
118 119

(defcustom desktop-basefilename
120
  (convert-standard-filename ".emacs.desktop")
121 122 123
  "File for Emacs desktop, not including the directory name."
  :type 'file
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

125
(defcustom desktop-missing-file-warning nil
Richard M. Stallman's avatar
Richard M. Stallman committed
126
  "*If non-nil then desktop warns when a file no longer exists.
127 128 129
Otherwise it simply ignores that file."
  :type 'boolean
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
130

131
(defvar desktop-globals-to-save
Richard M. Stallman's avatar
Richard M. Stallman committed
132
  (list 'desktop-missing-file-warning
133
	;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
134
	;; 'kill-ring
135 136
	'tags-file-name
	'tags-table-list
137 138
	'search-ring
	'regexp-search-ring
139
	'register-alist
140
	;; 'desktop-globals-to-save	; Itself!
Richard M. Stallman's avatar
Richard M. Stallman committed
141
	)
142 143 144 145 146
  "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
147

148 149 150 151 152 153 154 155
(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
156
	'line-number-mode
157
	)
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159
  "List of local variables to save for each buffer.
The variables are saved only when they really are local.")
160
(make-variable-buffer-local 'desktop-locals-to-save)
161

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

171
;; Skip ange-ftp files
172
(defcustom desktop-files-not-to-save
173
  "^/[^/:]*:"
174 175 176
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
177

178 179 180 181
(defcustom desktop-buffer-major-mode nil
  "When desktop creates a buffer, this holds the desired Major mode."
  :type 'symbol
  :group 'desktop)
182

183 184 185 186
(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)
187

188 189 190 191
(defcustom desktop-buffer-name nil
  "When desktop creates a buffer, this holds the desired buffer name."
  :type '(choice string (const nil))
  :group 'desktop)
192

193 194 195 196
(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.")

197
(defcustom desktop-buffer-handlers
198
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
199
    desktop-buffer-rmail
200
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202
    desktop-buffer-info
    desktop-buffer-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
203
  "*List of functions to call in order to create a buffer.
204 205 206 207
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.
208 209 210
If the function returns t then the buffer is considered created."
  :type '(repeat function)
  :group 'desktop)
211 212 213

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

215
(defcustom desktop-save-hook nil
216 217
  "Hook run before desktop saves the state of Emacs.
This is useful for truncating history lists, for example."
218 219
  :type 'hook
  :group 'desktop)
220

221 222
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224 225
  "The directory in which the current desktop file resides.")

(defconst desktop-header
226 227 228
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
229
" "*Header to place in Desktop file.")
230 231 232

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

234
;; ----------------------------------------------------------------------------
235 236 237 238
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
239
	(setcdr here nil))))
240
;; ----------------------------------------------------------------------------
241 242 243 244 245 246 247 248 249 250
(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
251
  (interactive)
252 253 254 255 256 257
  (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)
258 259 260
  (let ((buffers (buffer-list)))
    (while buffers
      (or (member (buffer-name (car buffers)) desktop-clear-preserve-buffers)
261
	  (null (buffer-name (car buffers)))
262 263 264 265 266
	  ;; 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
267
  (delete-other-windows))
268
;; ----------------------------------------------------------------------------
269
(add-hook 'kill-emacs-hook 'desktop-kill)
270

Richard M. Stallman's avatar
Richard M. Stallman committed
271
(defun desktop-kill ()
272
  (if desktop-dirname
273 274 275 276 277 278
      (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)))))))
279
;; ----------------------------------------------------------------------------
280 281 282 283 284 285 286 287 288 289 290
(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)))

291
(defun desktop-internal-v2s (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
292 293 294 295
  "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)."
296
  (cond
297
   ((or (numberp val) (null val) (eq t val))
298
    (cons 'may (prin1-to-string val)))
299
   ((stringp val)
300 301 302 303
    (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))))
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
   ((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)
326 327
    (let ((p val)
	  newlist
328
	  use-list*
329 330 331 332 333 334 335 336 337
	  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)))
338 339 340 341 342
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
343 344 345
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
346
		(concat (if use-list* "(desktop-list* "  "(list ")
347 348 349 350 351 352 353 354 355
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
356 357 358 359 360 361 362 363 364 365 366 367
   ((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
368
    (cons 'may "\"Unprintable entity\""))))
369

370
(defun desktop-value-to-string (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
371 372
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
373 374 375 376 377 378 379 380
  (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)))
381
;; ----------------------------------------------------------------------------
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
(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)))
	      (desktop-truncate (eval var) size)) 
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
403
;; ----------------------------------------------------------------------------
404
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
405
  "Return t if the desktop should record a particular buffer for next startup.
406
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
407
MODE is the major mode."
408 409 410 411 412 413 414 415 416 417 418
  (let ((case-fold-search nil))
    (or (and filename
	     (not (string-match desktop-buffers-not-to-save bufname))
	     (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)
	     (memq mode '(Info-mode rmail-mode))))))
419
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
420 421 422
(defun desktop-save (dirname)
  "Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
  (interactive "DDirectory to save desktop file in: ")
423
  (run-hooks 'desktop-save-hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
424
  (save-excursion
425
    (let ((filename (expand-file-name
Richard M. Stallman's avatar
Richard M. Stallman committed
426
		     (concat dirname desktop-basefilename)))
427 428
	  (info (nreverse
		 (mapcar
Richard M. Stallman's avatar
Richard M. Stallman committed
429 430
		  (function (lambda (b)
			      (set-buffer b)
431
			      (list
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433
			       (buffer-file-name)
			       (buffer-name)
434
			       major-mode
435 436 437 438 439 440 441
			       (let (ret)
				 (mapcar #'(lambda (minor-mode)
					     (and (symbol-value minor-mode)
						  (setq ret (cons minor-mode
								  ret))))
					 (mapcar #'car minor-mode-alist))
				 ret)
Richard M. Stallman's avatar
Richard M. Stallman committed
442
			       (point)
443
			       (list (mark t) mark-active)
Richard M. Stallman's avatar
Richard M. Stallman committed
444
			       buffer-read-only
445 446 447 448
			       (cond ((eq major-mode 'Info-mode)
				      (list Info-current-file
					    Info-current-node))
				     ((eq major-mode 'dired-mode)
449 450 451 452 453 454 455
				      (cons
				       (expand-file-name dired-directory)
				       (cdr
					(nreverse
					 (mapcar
					  (function car)
					  dired-subdir-alist))))))
456 457 458 459 460 461 462 463 464 465 466
			       (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
467 468 469 470 471
			       )))
		  (buffer-list))))
	  (buf (get-buffer-create "*desktop*")))
      (set-buffer buf)
      (erase-buffer)
472

473 474
      (insert desktop-header
	      ";; Created " (current-time-string) "\n"
475 476
	      ";; Emacs version " emacs-version "\n\n"
	      ";; Global section:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
477 478
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
479 480
	  (insert "(setq kill-ring-yank-pointer (nthcdr "
		  (int-to-string
Richard M. Stallman's avatar
Richard M. Stallman committed
481 482 483
		   (- (length kill-ring) (length kill-ring-yank-pointer)))
		  " kill-ring))\n"))

484
      (insert "\n;; Buffer section:\n")
485 486 487 488 489 490 491 492 493 494 495 496
      (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
497 498 499 500
      (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))
501
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
502 503 504 505 506
(defun desktop-remove ()
  "Delete the Desktop file and inactivate the desktop system."
  (interactive)
  (if desktop-dirname
      (let ((filename (concat desktop-dirname desktop-basefilename)))
507 508 509
	(setq desktop-dirname nil)
	(if (file-exists-p filename)
	    (delete-file filename)))))
510
;; ----------------------------------------------------------------------------
511
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
512
(defun desktop-read ()
513 514
  "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
515
  (interactive)
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
  (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)))))
533
;; ----------------------------------------------------------------------------
534
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
535
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
536 537 538
  "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."
539
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
540 541 542
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
543 544 545
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
546
(defun desktop-buffer-info () "Load an info file."
547
  (if (eq 'Info-mode desktop-buffer-major-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
548 549
      (progn
	(require 'info)
550
	(Info-find-node (nth 0 desktop-buffer-misc) (nth 1 desktop-buffer-misc))
551
	(current-buffer))))
552
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
553
(defun desktop-buffer-rmail () "Load an RMAIL file."
554
  (if (eq 'rmail-mode desktop-buffer-major-mode)
555
      (condition-case error
556 557 558 559
	  (progn (rmail-input desktop-buffer-file-name)
                         (if (eq major-mode 'rmail-mode)
                             (current-buffer)
                           rmail-buffer))
560 561 562
	(file-locked
	 (kill-buffer (current-buffer))
	 'ignored))))
563
;; ----------------------------------------------------------------------------
564
(defun desktop-buffer-mh () "Load a folder in the mh system."
565
  (if (eq 'mh-folder-mode desktop-buffer-major-mode)
566 567 568
      (progn
	(require 'mh-e)
	(mh-find-path)
569 570
        (mh-visit-folder desktop-buffer-name)
	(current-buffer))))
571
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
572
(defun desktop-buffer-dired () "Load a directory using dired."
573
  (if (eq 'dired-mode desktop-buffer-major-mode)
574
      (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
575
	  (progn
576
            (dired (car desktop-buffer-misc))
577
	    (mapcar 'dired-insert-subdir (cdr desktop-buffer-misc))
578
	    (current-buffer))
579
	(message "Directory %s no longer exists." (car desktop-buffer-misc))
580 581
	(sit-for 1)
	'ignored)))
582
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
583
(defun desktop-buffer-file () "Load a file."
584 585
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
586
	      (and desktop-missing-file-warning
587 588
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
589
			      desktop-buffer-file-name))))
590
	  (progn (find-file desktop-buffer-file-name) (current-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
591
	'ignored)))
592 593
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
594
;; only.
595 596
(defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
				  desktop-buffer-major-mode
597
				  mim pt mk ro desktop-buffer-misc &optional locals)
Richard M. Stallman's avatar
Richard M. Stallman committed
598 599 600 601 602 603 604
  (let ((hlist desktop-buffer-handlers)
	(result)
	(handler))
    (while (and (not result) hlist)
      (setq handler (car hlist))
      (setq result (funcall handler))
      (setq hlist (cdr hlist)))
605 606 607 608 609
    (when (bufferp result)
      (set-buffer result)
      (if (not (equal (buffer-name) desktop-buffer-name))
	  (rename-buffer desktop-buffer-name))
      (auto-fill-mode (if (nth 0 mim) 1 0))
610
      (mapcar #'(lambda (minor-mode) (funcall minor-mode 1)) mim)
611 612 613 614 615 616 617 618 619 620 621
      (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)'
622
	      (progn
623 624 625 626 627 628
		(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))))))
629 630

;; Backward compatibility -- update parameters to 205 standards.
631 632
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
633
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
634
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
635 636
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
637 638 639 640 641
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
642
;; ----------------------------------------------------------------------------
643 644 645 646 647 648 649 650 651 652

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

;; desktop.el ends here.