1 ;;; desktop.el --- save partial status of Emacs when killed
3 ;; Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
5 ;; Author: Morten Welinder <terra@diku.dk>
6 ;; Keywords: customization
7 ;; Favourite-brand-of-beer: None, I hate beer.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; Save the Desktop, i.e.,
29 ;; - some global variables
30 ;; - the list of buffers with associated files. For each buffer also
32 ;; - the default directory
34 ;; - the mark & mark-active
36 ;; - some local variables
38 ;; To use this, first put these three lines in the bottom of your .emacs
39 ;; file (the later the better):
42 ;; (desktop-load-default)
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 ;; `desktop-locals-to-save'. If for instance you want to save the local
48 ;; variable `foobar' for every buffer in which it is local, you could add
51 ;; (setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
53 ;; To avoid saving excessive amounts of data you may also wish to add
54 ;; something like the following
56 ;; (add-hook 'kill-emacs-hook
58 ;; (desktop-truncate search-ring 3)
59 ;; (desktop-truncate regexp-search-ring 3)))
61 ;; which will make sure that no more than three search items are saved. You
62 ;; must place this line *after* the (load "desktop") line. See also the
63 ;; variable desktop-save-hook.
65 ;; Start Emacs in the root directory of your "project". The desktop saver
66 ;; is inactive by default. You activate it by M-x desktop-save RET. When
67 ;; you exit the next time the above data will be saved. This ensures that
68 ;; all the files you were editing will be reloaded the next time you start
69 ;; Emacs from the same directory and that points will be set where you
70 ;; left them. If you save a desktop file in your home directory it will
71 ;; act as a default desktop when you start Emacs from a directory that
72 ;; doesn't have its own. I never do this, but you may want to.
74 ;; By the way: don't use desktop.el to customize Emacs -- the file .emacs
75 ;; in your home directory is used for that. Saving global default values
76 ;; for buffers is an example of misuse.
78 ;; PLEASE NOTE: The kill ring can be saved as specified by the variable
79 ;; `desktop-globals-to-save' (by default it isn't). This may result in saving
80 ;; things you did not mean to keep. Use M-x desktop-clear RET.
82 ;; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas.
83 ;; avk@rtsg.mot.com (Andrew V. Klein) for a dired tip.
84 ;; chris@tecc.co.uk (Chris Boucher) for a mark tip.
85 ;; f89-kam@nada.kth.se (Klas Mellbourn) for a mh-e tip.
86 ;; kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
87 ;; treese@lcs.mit.edu (Win Treese) for ange-ftp tips.
88 ;; pot@cnuce.cnr.it (Francesco Potorti`) for misc. tips.
89 ;; ---------------------------------------------------------------------------
92 ;; Save window configuration.
93 ;; Recognize more minor modes.
95 ;; Start-up with buffer-menu???
99 ;; Make the compilation more silent
101 ;; We use functions from these modules
102 ;; We can't (require 'mh-e) since that wants to load something.
103 (mapcar 'require
'(info dired reporter
)))
104 ;; ----------------------------------------------------------------------------
105 ;; USER OPTIONS -- settings you might want to play with.
106 ;; ----------------------------------------------------------------------------
108 (defgroup desktop nil
109 "Save status of Emacs when you exit."
112 (defconst desktop-basefilename
113 (convert-standard-filename ".emacs.desktop")
114 "File for Emacs desktop, not including the directory name.")
116 (defcustom desktop-missing-file-warning nil
117 "*If non-nil then desktop warns when a file no longer exists.
118 Otherwise it simply ignores that file."
122 (defvar desktop-globals-to-save
123 (list 'desktop-missing-file-warning
124 ;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
131 ;; 'desktop-globals-to-save ; Itself!
133 "List of global variables to save when killing Emacs.
134 An element may be variable name (a symbol)
135 or a cons cell of the form (VAR . MAX-SIZE),
136 which means to truncate VAR's value to at most MAX-SIZE elements
137 \(if the value is a list) before saving the value.")
139 (defvar desktop-locals-to-save
140 (list 'desktop-locals-to-save
; Itself! Think it over.
146 'change-log-default-name
149 "List of local variables to save for each buffer.
150 The variables are saved only when they really are local.")
151 (make-variable-buffer-local 'desktop-locals-to-save
)
153 ;; We skip .log files because they are normally temporary.
154 ;; (ftp) files because they require passwords and whatnot.
155 ;; TAGS files to save time (tags-file-name is saved instead).
156 (defcustom desktop-buffers-not-to-save
157 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
158 "Regexp identifying buffers that are to be excluded from saving."
162 ;; Skip ange-ftp files
163 (defcustom desktop-files-not-to-save
165 "Regexp identifying files whose buffers are to be excluded from saving."
169 (defcustom desktop-buffer-major-mode nil
170 "When desktop creates a buffer, this holds the desired Major mode."
174 (defcustom desktop-buffer-file-name nil
175 "When desktop creates a buffer, this holds the file name to visit."
176 :type
'(choice file
(const nil
))
179 (defcustom desktop-buffer-name nil
180 "When desktop creates a buffer, this holds the desired buffer name."
181 :type
'(choice string
(const nil
))
184 (defvar desktop-buffer-misc nil
185 "When desktop creates a buffer, this holds a list of misc info.
186 It is used by the `desktop-buffer-handlers' functions.")
188 (defcustom desktop-buffer-handlers
189 '(desktop-buffer-dired
194 "*List of functions to call in order to create a buffer.
195 The functions are called without explicit parameters but can use the
196 variables `desktop-buffer-major-mode', `desktop-buffer-file-name',
197 `desktop-buffer-name'.
198 If one function returns non-nil, no further functions are called.
199 If the function returns t then the buffer is considered created."
200 :type
'(repeat function
)
203 (defvar desktop-create-buffer-form
"(desktop-create-buffer 205"
204 "Opening of form for creation of new buffers.")
206 (defcustom desktop-save-hook nil
207 "Hook run before saving the desktop to allow you to cut history lists and
211 ;; ----------------------------------------------------------------------------
212 (defvar desktop-dirname nil
213 "The directory in which the current desktop file resides.")
215 (defconst desktop-header
216 ";; --------------------------------------------------------------------------
217 ;; Desktop File for Emacs
218 ;; --------------------------------------------------------------------------
219 " "*Header to place in Desktop file.")
221 (defvar desktop-delay-hook nil
222 "Hooks run after all buffers are loaded; intended for internal use.")
223 ;; ----------------------------------------------------------------------------
224 (defun desktop-truncate (l n
)
225 "Truncate LIST to at most N elements destructively."
226 (let ((here (nthcdr (1- n
) l
)))
229 ;; ----------------------------------------------------------------------------
230 (defcustom desktop-clear-preserve-buffers
231 '("*scratch*" "*Messages*")
232 "*Buffer names that `desktop-clear' should not delete."
233 :type
'(repeat string
)
236 (defun desktop-clear ()
238 This kills all buffers except for internal ones
239 and those listed in `desktop-clear-preserve-buffers'."
242 kill-ring-yank-pointer nil
244 search-ring-yank-pointer nil
245 regexp-search-ring nil
246 regexp-search-ring-yank-pointer nil
)
247 (let ((buffers (buffer-list)))
249 (or (member (buffer-name (car buffers
)) desktop-clear-preserve-buffers
)
250 ;; Don't kill buffers made for internal purposes.
251 (and (not (equal (buffer-name (car buffers
)) ""))
252 (eq (aref (buffer-name (car buffers
)) 0) ?\
))
253 (kill-buffer (car buffers
)))
254 (setq buffers
(cdr buffers
))))
255 (delete-other-windows))
256 ;; ----------------------------------------------------------------------------
257 (add-hook 'kill-emacs-hook
'desktop-kill
)
259 (defun desktop-kill ()
262 (desktop-save desktop-dirname
)
264 (if (yes-or-no-p "Error while saving the desktop. Quit anyway? ")
266 (signal (car err
) (cdr err
)))))))
267 ;; ----------------------------------------------------------------------------
268 (defun desktop-list* (&rest args
)
269 (if (null (cdr args
))
271 (setq args
(nreverse args
))
272 (let ((value (cons (nth 1 args
) (car args
))))
273 (setq args
(cdr (cdr args
)))
275 (setq value
(cons (car args
) value
))
276 (setq args
(cdr args
)))
279 (defun desktop-internal-v2s (val)
280 "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
281 TXT is a string that when read and evaluated yields value.
282 QUOTE may be `may' (value may be quoted),
283 `must' (values must be quoted), or nil (value may not be quoted)."
285 ((or (numberp val
) (null val
) (eq t val
))
286 (cons 'may
(prin1-to-string val
)))
288 (let ((copy (copy-sequence val
)))
289 (set-text-properties 0 (length copy
) nil copy
)
290 ;; Get rid of text properties because we cannot read them
291 (cons 'may
(prin1-to-string copy
))))
293 (cons 'must
(prin1-to-string val
)))
298 (let ((res (desktop-internal-v2s el
)))
304 (cons nil
(concat "(vector "
305 (mapconcat (lambda (el)
306 (if (eq (car el
) 'must
)
307 (concat "'" (cdr el
))
312 (cons 'may
(concat "[" (mapconcat 'cdr pass1
" ") "]")))))
319 (let ((q.txt
(desktop-internal-v2s (car p
))))
320 (or anynil
(setq anynil
(null (car q.txt
))))
321 (setq newlist
(cons q.txt newlist
)))
324 (let ((last (desktop-internal-v2s p
))
326 (or anynil
(setq anynil
(null (car last
))))
328 (setq newlist
(cons '(must .
".") newlist
)))
330 (setq newlist
(cons last newlist
))))
331 (setq newlist
(nreverse newlist
))
334 (concat (if use-list
* "(desktop-list* " "(list ")
335 (mapconcat (lambda (el)
336 (if (eq (car el
) 'must
)
337 (concat "'" (cdr el
))
343 (concat "(" (mapconcat 'cdr newlist
" ") ")")))))
345 (cons nil
(concat "(symbol-function '"
346 (substring (prin1-to-string val
) 7 -
1)
349 (let ((pos (prin1-to-string (marker-position val
)))
350 (buf (prin1-to-string (buffer-name (marker-buffer val
)))))
351 (cons nil
(concat "(let ((mk (make-marker)))"
352 " (add-hook 'desktop-delay-hook"
353 " (list 'lambda '() (list 'set-marker mk "
354 pos
" (get-buffer " buf
")))) mk)"))))
356 (cons 'may
"\"Unprintable entity\""))))
358 (defun desktop-value-to-string (val)
359 "Convert VALUE to a string that when read evaluates to the same value.
360 Not all types of values are supported."
361 (let* ((print-escape-newlines t
)
362 (float-output-format nil
)
363 (quote.txt
(desktop-internal-v2s val
))
364 (quote (car quote.txt
))
365 (txt (cdr quote.txt
)))
369 ;; ----------------------------------------------------------------------------
370 (defun desktop-outvar (varspec)
371 "Output a setq statement for variable VAR to the desktop file.
372 The argument VARSPEC may be the variable name VAR (a symbol),
373 or a cons cell of the form (VAR . MAX-SIZE),
374 which means to truncate VAR's value to at most MAX-SIZE elements
375 \(if the value is a list) before saving the value."
378 (setq var
(car varspec
) size
(cdr varspec
))
382 (if (and (integerp size
)
385 (desktop-truncate (eval var
) size
))
389 (desktop-value-to-string (symbol-value var
))
391 ;; ----------------------------------------------------------------------------
392 (defun desktop-save-buffer-p (filename bufname mode
&rest dummy
)
393 "Return t if the desktop should record a particular buffer for next startup.
394 FILENAME is the visited file name, BUFNAME is the buffer name, and
395 MODE is the major mode."
396 (let ((case-fold-search nil
))
398 (not (string-match desktop-buffers-not-to-save bufname
))
399 (not (string-match desktop-files-not-to-save filename
)))
400 (and (eq mode
'dired-mode
)
402 (set-buffer (get-buffer bufname
))
403 (not (string-match desktop-files-not-to-save
404 default-directory
))))
406 (memq mode
'(Info-mode rmail-mode
))))))
407 ;; ----------------------------------------------------------------------------
408 (defun desktop-save (dirname)
409 "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
410 (interactive "DDirectory to save desktop file in: ")
411 (run-hooks 'desktop-save-hook
)
413 (let ((filename (expand-file-name
414 (concat dirname desktop-basefilename
)))
417 (function (lambda (b)
423 (list ; list explaining minor modes
424 (not (null auto-fill-function
)))
426 (list (mark t
) mark-active
)
428 (cond ((eq major-mode
'Info-mode
)
429 (list Info-current-file
431 ((eq major-mode
'dired-mode
)
433 (expand-file-name dired-directory
)
438 dired-subdir-alist
))))))
439 (let ((locals desktop-locals-to-save
)
440 (loclist (buffer-local-variables))
443 (let ((here (assq (car locals
) loclist
)))
445 (setq ll
(cons here ll
))
446 (if (member (car locals
) loclist
)
447 (setq ll
(cons (car locals
) ll
)))))
448 (setq locals
(cdr locals
)))
452 (buf (get-buffer-create "*desktop*")))
456 (insert desktop-header
457 ";; Created " (current-time-string) "\n"
458 ";; Emacs version " emacs-version
"\n\n"
459 ";; Global section:\n")
460 (mapcar (function desktop-outvar
) desktop-globals-to-save
)
461 (if (memq 'kill-ring desktop-globals-to-save
)
462 (insert "(setq kill-ring-yank-pointer (nthcdr "
464 (- (length kill-ring
) (length kill-ring-yank-pointer
)))
467 (insert "\n;; Buffer section:\n")
469 (function (lambda (l)
470 (if (apply 'desktop-save-buffer-p l
)
472 (insert desktop-create-buffer-form
)
474 (function (lambda (e)
476 (desktop-value-to-string e
))))
480 (setq default-directory dirname
)
481 (if (file-exists-p filename
) (delete-file filename
))
482 (write-region (point-min) (point-max) filename nil
'nomessage
)))
483 (setq desktop-dirname dirname
))
484 ;; ----------------------------------------------------------------------------
485 (defun desktop-remove ()
486 "Delete the Desktop file and inactivate the desktop system."
489 (let ((filename (concat desktop-dirname desktop-basefilename
)))
490 (setq desktop-dirname nil
)
491 (if (file-exists-p filename
)
492 (delete-file filename
)))))
493 ;; ----------------------------------------------------------------------------
494 (defun desktop-read ()
495 "Read the Desktop file and the files it specifies.
496 This is a no-op when Emacs is running in batch mode."
500 (let ((dirs '("./" "~/")))
502 (not (file-exists-p (expand-file-name
505 (setq dirs
(cdr dirs
)))
506 (setq desktop-dirname
(and dirs
(expand-file-name (car dirs
))))
509 (load (expand-file-name desktop-basefilename desktop-dirname
)
511 (run-hooks 'desktop-delay-hook
)
512 (setq desktop-delay-hook nil
)
513 (message "Desktop loaded."))
515 ;; ----------------------------------------------------------------------------
516 (defun desktop-load-default ()
517 "Load the `default' start-up library manually.
518 Also inhibit further loading of it. Call this from your `.emacs' file
519 to provide correct modes for autoloaded files."
520 (if (not inhibit-default-init
) ; safety check
523 (setq inhibit-default-init t
))))
524 ;; ----------------------------------------------------------------------------
525 ;; Note: the following functions use the dynamic variable binding in Lisp.
527 (defun desktop-buffer-info () "Load an info file."
528 (if (eq 'Info-mode desktop-buffer-major-mode
)
531 (Info-find-node (nth 0 desktop-buffer-misc
) (nth 1 desktop-buffer-misc
))
533 ;; ----------------------------------------------------------------------------
534 (defun desktop-buffer-rmail () "Load an RMAIL file."
535 (if (eq 'rmail-mode desktop-buffer-major-mode
)
536 (condition-case error
537 (progn (rmail-input desktop-buffer-file-name
) t
)
539 (kill-buffer (current-buffer))
541 ;; ----------------------------------------------------------------------------
542 (defun desktop-buffer-mh () "Load a folder in the mh system."
543 (if (eq 'mh-folder-mode desktop-buffer-major-mode
)
547 (mh-visit-folder desktop-buffer-name
)
549 ;; ----------------------------------------------------------------------------
550 (defun desktop-buffer-dired () "Load a directory using dired."
551 (if (eq 'dired-mode desktop-buffer-major-mode
)
552 (if (file-directory-p (file-name-directory (car desktop-buffer-misc
)))
554 (dired (car desktop-buffer-misc
))
555 (mapcar 'dired-insert-subdir
(cdr desktop-buffer-misc
))
557 (message "Directory %s no longer exists." (car desktop-buffer-misc
))
560 ;; ----------------------------------------------------------------------------
561 (defun desktop-buffer-file () "Load a file."
562 (if desktop-buffer-file-name
563 (if (or (file-exists-p desktop-buffer-file-name
)
564 (and desktop-missing-file-warning
566 "File \"%s\" no longer exists. Re-create? "
567 desktop-buffer-file-name
))))
568 (progn (find-file desktop-buffer-file-name
) t
)
570 ;; ----------------------------------------------------------------------------
571 ;; Create a buffer, load its file, set is mode, ...; called from Desktop file
573 (defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
574 desktop-buffer-major-mode
575 mim pt mk ro desktop-buffer-misc
&optional locals
)
576 (let ((hlist desktop-buffer-handlers
)
579 (while (and (not result
) hlist
)
580 (setq handler
(car hlist
))
581 (setq result
(funcall handler
))
582 (setq hlist
(cdr hlist
)))
585 (if (not (equal (buffer-name) desktop-buffer-name
))
586 (rename-buffer desktop-buffer-name
))
587 (auto-fill-mode (if (nth 0 mim
) 1 0))
592 (setq mark-active
(car (cdr mk
))))
594 ;; Never override file system if the file really is read-only marked.
595 (if ro
(setq buffer-read-only ro
))
597 (let ((this (car locals
)))
599 ;; an entry of this form `(symbol . value)'
601 (make-local-variable (car this
))
602 (set (car this
) (cdr this
)))
603 ;; an entry of the form `symbol'
604 (make-local-variable this
)
606 (setq locals
(cdr locals
)))
609 ;; Backward compatibility -- update parameters to 205 standards.
610 (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
611 desktop-buffer-major-mode
612 mim pt mk ro tl fc cfs cr desktop-buffer-misc
)
613 (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
614 desktop-buffer-major-mode
(cdr mim
) pt mk ro
616 (list (cons 'truncate-lines tl
)
617 (cons 'fill-column fc
)
618 (cons 'case-fold-search cfs
)
619 (cons 'case-replace cr
)
620 (cons 'overwrite-mode
(car mim
)))))
621 ;; ----------------------------------------------------------------------------
624 ;; desktop.el ends here.