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

;; Author: Morten Welinder <terra@diku.dk>
6
;; Version: 2.07
Richard M. Stallman's avatar
Richard M. Stallman committed
7 8
;; Keywords: customization
;; 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 23 24 25 26 27

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; 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 39 40 41 42 43 44
;; To use this, first put these three lines in the bottom of your .emacs
;; file (the later the better):
;;
;;	(load "desktop")
;;	(desktop-load-default)
;;	(desktop-read)
;;
45
;; Between the second and the third line you may wish to add something that
46
;; updates the variables `desktop-globals-to-save' and/or
47 48 49 50 51 52
;; `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))
;;
53
;; To avoid saving excessive amounts of data you may also with to add
54 55 56
;; something like the following
;;
;;	(add-hook 'kill-emacs-hook
57
;;		  '(lambda ()
58 59 60 61 62
;;		     (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
;; must place this line *after* the (load "desktop") line.
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

;; 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.
85 86 87 88 89 90 91
;; ---------------------------------------------------------------------------
;; 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
92 93 94

;;; Code:

95 96 97
;; Make the compilation more silent
(eval-when-compile
  ;; We use functions from these modules
98
  (mapcar 'require '(info mh-e dired reporter)))
99
;; ----------------------------------------------------------------------------
100 101 102
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
(defconst desktop-basefilename
103
  (if (eq system-type 'ms-dos)
Richard M. Stallman's avatar
Richard M. Stallman committed
104 105 106 107
      "emacs.dsk" ; Ms-Dos does not support multiple dots in file name
    ".emacs.desktop")
  "File for Emacs desktop.  A directory name will be prepended to this name.")

108
(defvar desktop-missing-file-warning t
Richard M. Stallman's avatar
Richard M. Stallman committed
109 110 111
  "*If non-nil then issue warning if a file no longer exists.
Otherwise simply ignore the file.")

112
(defvar desktop-globals-to-save
Richard M. Stallman's avatar
Richard M. Stallman committed
113
  (list 'desktop-missing-file-warning
114
	;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
115
	;; 'kill-ring
116 117
	'tags-file-name
	'tags-table-list
118 119
	'search-ring
	'regexp-search-ring
120
	'register-alist
121
	;; 'desktop-globals-to-save	; Itself!
Richard M. Stallman's avatar
Richard M. Stallman committed
122
	)
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124
  "List of global variables to save when killing Emacs.")

125 126 127 128 129 130 131 132 133 134 135
(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
	)
  "List of local variables to save for each buffer.  The variables are saved
only when they really are local.")
136
(make-variable-buffer-local 'desktop-locals-to-save)
137

138 139 140
;; We skip .log files because they are normally temporary.
;;         (ftp) files because they require passwords and whatsnot.
;;         TAGS files to save time (tags-file-name is saved instead).
Richard M. Stallman's avatar
Richard M. Stallman committed
141
(defvar desktop-buffers-not-to-save
142
 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145
 "Regexp identifying buffers that are to be excluded from saving.")

(defvar desktop-buffer-handlers
146
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
147
    desktop-buffer-rmail
148
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
149 150
    desktop-buffer-info
    desktop-buffer-file)
151 152 153 154
  "*List of functions to call in order to create a buffer.  The functions are
called without explicit parameters but may access the the major mode as `mam',
the file name as `fn', the buffer name as `bn', the default directory as
`dd'.  If some function returns non-nil no further functions are called.
Richard M. Stallman's avatar
Richard M. Stallman committed
155
If the function returns t then the buffer is considered created.")
156 157 158

(defvar desktop-create-buffer-form "(desktop-create-buffer 205"
  "Opening of form for creation of new buffers.")
159 160
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162 163
  "The directory in which the current desktop file resides.")

(defconst desktop-header
164 165 166
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
167
" "*Header to place in Desktop file.")
168 169 170

(defvar desktop-delay-hook nil
  "Hooks run after all buffers are loaded; intended for internal use.")
171
;; ----------------------------------------------------------------------------
172 173 174 175
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
176
	(setcdr here nil))))
177
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179 180 181
(defun desktop-clear () "Empty the Desktop."
  (interactive)
  (setq kill-ring nil)
  (setq kill-ring-yank-pointer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183
  (mapcar (function kill-buffer) (buffer-list))
  (delete-other-windows))
184
;; ----------------------------------------------------------------------------
185
(add-hook 'kill-emacs-hook 'desktop-kill)
186

Richard M. Stallman's avatar
Richard M. Stallman committed
187
(defun desktop-kill ()
188
  (if desktop-dirname
Richard M. Stallman's avatar
Richard M. Stallman committed
189 190
      (progn
	(desktop-save desktop-dirname))))
191
;; ----------------------------------------------------------------------------
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
(defun desktop-internal-v2s (val)
  "Convert VALUE to a pair (quote . txt) where 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)."
  (cond
   ((or (numberp val) (stringp val) (null val) (eq t val))
    (cons 'may (prin1-to-string val)))
   ((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)
    (let ((car-q.txt (desktop-internal-v2s (car val)))
	  (cdr-q.txt (desktop-internal-v2s (cdr val))))
      (cond
       ((or (null (car car-q.txt)) (null (car cdr-q.txt)))
	(cons nil (concat "(cons " 
			  (if (eq (car car-q.txt) 'must) "'")			      
			  (cdr car-q.txt) " "
			  (if (eq (car cdr-q.txt) 'must) "'")			      
			  (cdr cdr-q.txt) ")")))
       ((consp (cdr val))
	(cons 'must (concat "(" (cdr car-q.txt) 
			    " " (substring (cdr cdr-q.txt) 1 -1) ")")))
       ((null (cdr val))
	(cons 'must (concat "(" (cdr car-q.txt) ")")))
       (t
	(cons 'must (concat "(" (cdr car-q.txt) " . " (cdr cdr-q.txt) ")"))))))
   ((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
    (prin1-to-string (prin1-to-string val)))))

251
(defun desktop-value-to-string (val)
252 253 254 255 256 257 258 259 260 261
  "Convert VALUE to a string that when read evaluates to the same value.  Not
all types of values are supported."
  (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)))
262
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
263
(defun desktop-outvar (var)
Richard M. Stallman's avatar
Richard M. Stallman committed
264
  "Output a setq statement for VAR to the desktop file."
Richard M. Stallman's avatar
Richard M. Stallman committed
265
  (if (boundp var)
266 267 268 269 270
      (insert "(setq "
	      (symbol-name var)
	      " "
	      (desktop-value-to-string (symbol-value var))
	      ")\n")))
271
;; ----------------------------------------------------------------------------
272
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
273
  "Return t if the desktop should record a particular buffer for next startup.
274
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
275 276 277 278 279
MODE is the major mode."
  (or (and filename
	   (not (string-match desktop-buffers-not-to-save bufname)))
      (and (null filename)
	   (memq mode '(Info-mode dired-mode rmail-mode)))))
280
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
281 282 283 284
(defun desktop-save (dirname)
  "Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
  (interactive "DDirectory to save desktop file in: ")
  (save-excursion
285
    (let ((filename (expand-file-name
Richard M. Stallman's avatar
Richard M. Stallman committed
286
		     (concat dirname desktop-basefilename)))
287 288
	  (info (nreverse
		 (mapcar
Richard M. Stallman's avatar
Richard M. Stallman committed
289 290
		  (function (lambda (b)
			      (set-buffer b)
291
			      (list
Richard M. Stallman's avatar
Richard M. Stallman committed
292 293
			       (buffer-file-name)
			       (buffer-name)
294 295
			       major-mode
			       (list	; list explaining minor modes
296
				     (not (null auto-fill-function)))
Richard M. Stallman's avatar
Richard M. Stallman committed
297
			       (point)
298
			       (list (mark t) mark-active)
Richard M. Stallman's avatar
Richard M. Stallman committed
299
			       buffer-read-only
300 301 302 303
			       (cond ((eq major-mode 'Info-mode)
				      (list Info-current-file
					    Info-current-node))
				     ((eq major-mode 'dired-mode)
304 305 306 307
				      (nreverse
				       (mapcar
					(function car)
					dired-subdir-alist)))
308 309 310 311 312 313 314 315 316 317 318 319
				     )
			       (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
320 321 322 323 324
			       )))
		  (buffer-list))))
	  (buf (get-buffer-create "*desktop*")))
      (set-buffer buf)
      (erase-buffer)
325
      
326 327
      (insert desktop-header
	      ";; Created " (current-time-string) "\n"
328 329
		  ";; Emacs version " emacs-version "\n\n"
		      ";; Global section:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
330 331
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
332 333
	  (insert "(setq kill-ring-yank-pointer (nthcdr "
		  (int-to-string
Richard M. Stallman's avatar
Richard M. Stallman committed
334 335 336
		   (- (length kill-ring) (length kill-ring-yank-pointer)))
		  " kill-ring))\n"))

337
      (insert "\n;; Buffer section:\n")
338 339 340 341 342 343 344 345 346 347 348 349
      (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
350 351 352 353
      (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))
354
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356 357 358 359 360 361
(defun desktop-remove ()
  "Delete the Desktop file and inactivate the desktop system."
  (interactive)
  (if desktop-dirname
      (let ((filename (concat desktop-dirname desktop-basefilename)))
	(if (file-exists-p filename) (delete-file filename))
	(setq desktop-dirname nil))))
362
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364 365 366 367 368 369 370 371 372 373 374
(defun desktop-read ()
  "Read the Desktop file and the files it specifies."
  (interactive)
  (let ((filename))
    (if (file-exists-p (concat "./" desktop-basefilename))
	(setq desktop-dirname (expand-file-name "./"))
      (if (file-exists-p (concat "~/" desktop-basefilename))
	  (setq desktop-dirname (expand-file-name "~/"))
	(setq desktop-dirname nil)))
    (if desktop-dirname
	(progn
	  (load (concat desktop-dirname desktop-basefilename) t t t)
375
	  (run-hooks 'desktop-delay-hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
376 377
	  (message "Desktop loaded."))
      (desktop-clear))))
378
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
379
(defun desktop-load-default ()
380
  "Load the `default' start-up library manually.  Also inhibit further loading
381
of it.  Call this from your `.emacs' file to provide correct modes for
382 383
autoloaded files."
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
384 385 386
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
387 388 389
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
390
(defun desktop-buffer-info () "Load an info file."
391
  (if (eq 'Info-mode mam)
Richard M. Stallman's avatar
Richard M. Stallman committed
392 393 394 395
      (progn
	(require 'info)
	(Info-find-node (nth 0 misc) (nth 1 misc))
	t)))
396
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
397 398
(defun desktop-buffer-rmail () "Load an RMAIL file."
  (if (eq 'rmail-mode mam)
Richard M. Stallman's avatar
Richard M. Stallman committed
399
      (progn (rmail-input fn) t)))
400
;; ----------------------------------------------------------------------------
401 402 403 404 405 406 407 408
(defun desktop-buffer-mh () "Load a folder in the mh system."
  (if (eq 'mh-folder-mode mam)
      (progn
	(require 'mh-e)
	(mh-find-path)
	(mh-visit-folder bn)
	t)))
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
409
(defun desktop-buffer-dired () "Load a directory using dired."
Richard M. Stallman's avatar
Richard M. Stallman committed
410
  (if (eq 'dired-mode mam)
411 412 413 414 415
      (progn
	(dired (car misc))
	(mapcar (function dired-maybe-insert-subdir) (cdr misc))
	t)))
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
416 417 418 419
(defun desktop-buffer-file () "Load a file."
  (if fn
      (if (or (file-exists-p fn)
	      (and desktop-missing-file-warning
420 421
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
Richard M. Stallman's avatar
Richard M. Stallman committed
422 423 424
			      fn))))
	  (progn (find-file fn) t)
	'ignored)))
425 426
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
427
;; only.
428
(defun desktop-create-buffer (ver fn bn mam mim pt mk ro misc &optional locals)
Richard M. Stallman's avatar
Richard M. Stallman committed
429 430 431 432 433 434 435
  (let ((hlist desktop-buffer-handlers)
	(result)
	(handler))
    (while (and (not result) hlist)
      (setq handler (car hlist))
      (setq result (funcall handler))
      (setq hlist (cdr hlist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
436
    (if (eq result t)
Richard M. Stallman's avatar
Richard M. Stallman committed
437 438 439
	(progn
	  (if (not (equal (buffer-name) bn))
	      (rename-buffer bn))
440
	  (auto-fill-mode (if (nth 0 mim) 1 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
441
	  (goto-char pt)
442 443 444 445 446 447 448
	  (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))
449 450 451 452 453 454 455 456 457 458 459
	  (while locals
	    (let ((this (car locals)))
	      (if (consp this)
		  ;; an entry of this form `(symbol . value)'
		  (progn
		    (make-local-variable (car this))
		    (set (car this) (cdr this)))
		;; an entry of the form `symbol'
		(make-local-variable this)
		(makunbound this)))
	    (setq locals (cdr locals)))
Richard M. Stallman's avatar
Richard M. Stallman committed
460
	  ))))
461 462 463 464 465 466 467 468 469

;; Backward compatibility -- update parameters to 205 standards.
(defun desktop-buffer (fn bn mam mim pt mk ro tl fc cfs cr misc)
  (desktop-create-buffer 205 fn bn mam (cdr mim) pt mk ro misc
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
470
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
471
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
472 473

;; desktop.el ends here.