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 ;; ----------------------------------------------------------------------------
107 (defconst desktop-basefilename
108 (if (or (eq system-type
'ms-dos
) (eq system-type
'windows-nt
))
109 "emacs.dsk" ; Ms-Dos does not support multiple dots in file name
111 "File for Emacs desktop, not including the directory name.")
113 (defvar desktop-missing-file-warning t
114 "*If non-nil then desktop warns when a file no longer exists.
115 Otherwise it simply ignores that file.")
117 (defvar desktop-globals-to-save
118 (list 'desktop-missing-file-warning
119 ;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
126 ;; 'desktop-globals-to-save ; Itself!
128 "List of global variables to save when killing Emacs.
129 An element may be variable name (a symbol)
130 or a cons cell of the form (VAR . MAX-SIZE),
131 which means to truncate VAR's value to at most MAX-SIZE elements
132 \(if the value is a list) before saving the value.")
134 (defvar desktop-locals-to-save
135 (list 'desktop-locals-to-save
; Itself! Think it over.
141 'change-log-default-name
144 "List of local variables to save for each buffer.
145 The variables are saved only when they really are local.")
146 (make-variable-buffer-local 'desktop-locals-to-save
)
148 ;; We skip .log files because they are normally temporary.
149 ;; (ftp) files because they require passwords and whatnot.
150 ;; TAGS files to save time (tags-file-name is saved instead).
151 (defvar desktop-buffers-not-to-save
152 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
153 "Regexp identifying buffers that are to be excluded from saving.")
155 ;; Skip ange-ftp files
156 (defvar desktop-files-not-to-save
158 "Regexp identifying files whose buffers are to be excluded from saving.")
160 (defvar desktop-buffer-handlers
161 '(desktop-buffer-dired
166 "*List of functions to call in order to create a buffer.
167 The functions are called without explicit parameters but may access
168 the the major mode as `mam', the file name as `fn', the buffer name as
169 `bn', the default directory as `dd'. If some function returns non-nil
170 no further functions are called. If the function returns t then the
171 buffer is considered created.")
173 (defvar desktop-create-buffer-form
"(desktop-create-buffer 205"
174 "Opening of form for creation of new buffers.")
176 (defvar desktop-save-hook nil
177 "Hook run before saving the desktop to allow you to cut history lists and
179 ;; ----------------------------------------------------------------------------
180 (defvar desktop-dirname nil
181 "The directory in which the current desktop file resides.")
183 (defconst desktop-header
184 ";; --------------------------------------------------------------------------
185 ;; Desktop File for Emacs
186 ;; --------------------------------------------------------------------------
187 " "*Header to place in Desktop file.")
189 (defvar desktop-delay-hook nil
190 "Hooks run after all buffers are loaded; intended for internal use.")
191 ;; ----------------------------------------------------------------------------
192 (defun desktop-truncate (l n
)
193 "Truncate LIST to at most N elements destructively."
194 (let ((here (nthcdr (1- n
) l
)))
197 ;; ----------------------------------------------------------------------------
198 (defun desktop-clear () "Empty the Desktop."
201 kill-ring-yank-pointer nil
203 search-ring-yank-pointer nil
204 regexp-search-ring nil
205 regexp-search-ring-yank-pointer nil
)
206 (mapcar (function kill-buffer
) (buffer-list))
207 (delete-other-windows))
208 ;; ----------------------------------------------------------------------------
209 (add-hook 'kill-emacs-hook
'desktop-kill
)
211 (defun desktop-kill ()
214 (desktop-save desktop-dirname
)
216 (if (yes-or-no-p "Error while saving the desktop. Quit anyway? ")
218 (signal (car err
) (cdr err
)))))))
219 ;; ----------------------------------------------------------------------------
220 (defun desktop-internal-v2s (val)
221 "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
222 TXT is a string that when read and evaluated yields value.
223 QUOTE may be `may' (value may be quoted),
224 `must' (values must be quoted), or nil (value may not be quoted)."
226 ((or (numberp val
) (null val
) (eq t val
))
227 (cons 'may
(prin1-to-string val
)))
229 (let ((copy (copy-sequence val
)))
230 (set-text-properties 0 (length copy
) nil copy
)
231 ;; Get rid of text properties because we cannot read them
232 (cons 'may
(prin1-to-string copy
))))
234 (cons 'must
(prin1-to-string val
)))
239 (let ((res (desktop-internal-v2s el
)))
245 (cons nil
(concat "(vector "
246 (mapconcat (lambda (el)
247 (if (eq (car el
) 'must
)
248 (concat "'" (cdr el
))
253 (cons 'may
(concat "[" (mapconcat 'cdr pass1
" ") "]")))))
259 (let ((q.txt
(desktop-internal-v2s (car p
))))
260 (or anynil
(setq anynil
(null (car q.txt
))))
261 (setq newlist
(cons q.txt newlist
)))
264 (let ((last (desktop-internal-v2s p
))
267 (if (or anynil
(setq anynil
(null (car last
))))
270 (if (eq (car el
) 'must
) "'" "")
273 (if (eq (car last
) 'must
) "'" "")
277 (concat (cdr el
) " . " (cdr last
)))))))
278 (setq newlist
(nreverse newlist
))
282 (mapconcat (lambda (el)
283 (if (eq (car el
) 'must
)
284 (concat "'" (cdr el
))
290 (concat "(" (mapconcat 'cdr newlist
" ") ")")))))
292 (cons nil
(concat "(symbol-function '"
293 (substring (prin1-to-string val
) 7 -
1)
296 (let ((pos (prin1-to-string (marker-position val
)))
297 (buf (prin1-to-string (buffer-name (marker-buffer val
)))))
298 (cons nil
(concat "(let ((mk (make-marker)))"
299 " (add-hook 'desktop-delay-hook"
300 " (list 'lambda '() (list 'set-marker mk "
301 pos
" (get-buffer " buf
")))) mk)"))))
303 (cons 'may
"\"Unprintable entity\""))))
305 (defun desktop-value-to-string (val)
306 "Convert VALUE to a string that when read evaluates to the same value.
307 Not all types of values are supported."
308 (let* ((print-escape-newlines t
)
309 (float-output-format nil
)
310 (quote.txt
(desktop-internal-v2s val
))
311 (quote (car quote.txt
))
312 (txt (cdr quote.txt
)))
316 ;; ----------------------------------------------------------------------------
317 (defun desktop-outvar (varspec)
318 "Output a setq statement for variable VAR to the desktop file.
319 The argument VARSPEC may be the variable name VAR (a symbol),
320 or a cons cell of the form (VAR . MAX-SIZE),
321 which means to truncate VAR's value to at most MAX-SIZE elements
322 \(if the value is a list) before saving the value."
325 (setq var
(car varspec
) size
(cdr varspec
))
329 (if (and (integerp size
)
332 (desktop-truncate (eval var
) size
))
336 (desktop-value-to-string (symbol-value var
))
338 ;; ----------------------------------------------------------------------------
339 (defun desktop-save-buffer-p (filename bufname mode
&rest dummy
)
340 "Return t if the desktop should record a particular buffer for next startup.
341 FILENAME is the visited file name, BUFNAME is the buffer name, and
342 MODE is the major mode."
343 (let ((case-fold-search nil
))
345 (not (string-match desktop-buffers-not-to-save bufname
))
346 (not (string-match desktop-files-not-to-save filename
)))
347 (and (eq mode
'dired-mode
)
349 (set-buffer (get-buffer bufname
))
350 (not (string-match desktop-files-not-to-save
351 default-directory
))))
353 (memq mode
'(Info-mode rmail-mode
))))))
354 ;; ----------------------------------------------------------------------------
355 (defun desktop-save (dirname)
356 "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
357 (interactive "DDirectory to save desktop file in: ")
358 (run-hooks 'desktop-save-hook
)
360 (let ((filename (expand-file-name
361 (concat dirname desktop-basefilename
)))
364 (function (lambda (b)
370 (list ; list explaining minor modes
371 (not (null auto-fill-function
)))
373 (list (mark t
) mark-active
)
375 (cond ((eq major-mode
'Info-mode
)
376 (list Info-current-file
378 ((eq major-mode
'dired-mode
)
380 (expand-file-name dired-directory
)
385 dired-subdir-alist
))))))
386 (let ((locals desktop-locals-to-save
)
387 (loclist (buffer-local-variables))
390 (let ((here (assq (car locals
) loclist
)))
392 (setq ll
(cons here ll
))
393 (if (member (car locals
) loclist
)
394 (setq ll
(cons (car locals
) ll
)))))
395 (setq locals
(cdr locals
)))
399 (buf (get-buffer-create "*desktop*")))
403 (insert desktop-header
404 ";; Created " (current-time-string) "\n"
405 ";; Emacs version " emacs-version
"\n\n"
406 ";; Global section:\n")
407 (mapcar (function desktop-outvar
) desktop-globals-to-save
)
408 (if (memq 'kill-ring desktop-globals-to-save
)
409 (insert "(setq kill-ring-yank-pointer (nthcdr "
411 (- (length kill-ring
) (length kill-ring-yank-pointer
)))
414 (insert "\n;; Buffer section:\n")
416 (function (lambda (l)
417 (if (apply 'desktop-save-buffer-p l
)
419 (insert desktop-create-buffer-form
)
421 (function (lambda (e)
423 (desktop-value-to-string e
))))
427 (setq default-directory dirname
)
428 (if (file-exists-p filename
) (delete-file filename
))
429 (write-region (point-min) (point-max) filename nil
'nomessage
)))
430 (setq desktop-dirname dirname
))
431 ;; ----------------------------------------------------------------------------
432 (defun desktop-remove ()
433 "Delete the Desktop file and inactivate the desktop system."
436 (let ((filename (concat desktop-dirname desktop-basefilename
)))
437 (setq desktop-dirname nil
)
438 (if (file-exists-p filename
)
439 (delete-file filename
)))))
440 ;; ----------------------------------------------------------------------------
441 (defun desktop-read ()
442 "Read the Desktop file and the files it specifies.
443 This is a no-op when Emacs is running in batch mode."
447 (let ((dirs '("./" "~/")))
449 (not (file-exists-p (expand-file-name
452 (setq dirs
(cdr dirs
)))
453 (setq desktop-dirname
(and dirs
(expand-file-name (car dirs
))))
456 (load (expand-file-name desktop-basefilename desktop-dirname
)
458 (run-hooks 'desktop-delay-hook
)
459 (setq desktop-delay-hook nil
)
460 (message "Desktop loaded."))
462 ;; ----------------------------------------------------------------------------
463 (defun desktop-load-default ()
464 "Load the `default' start-up library manually.
465 Also inhibit further loading of it. Call this from your `.emacs' file
466 to provide correct modes for autoloaded files."
467 (if (not inhibit-default-init
) ; safety check
470 (setq inhibit-default-init t
))))
471 ;; ----------------------------------------------------------------------------
472 ;; Note: the following functions use the dynamic variable binding in Lisp.
474 (defun desktop-buffer-info () "Load an info file."
475 (if (eq 'Info-mode mam
)
478 (Info-find-node (nth 0 misc
) (nth 1 misc
))
480 ;; ----------------------------------------------------------------------------
481 (defun desktop-buffer-rmail () "Load an RMAIL file."
482 (if (eq 'rmail-mode mam
)
483 (condition-case error
484 (progn (rmail-input fn
) t
)
486 (kill-buffer (current-buffer))
488 ;; ----------------------------------------------------------------------------
489 (defun desktop-buffer-mh () "Load a folder in the mh system."
490 (if (eq 'mh-folder-mode mam
)
496 ;; ----------------------------------------------------------------------------
497 (defun desktop-buffer-dired () "Load a directory using dired."
498 (if (eq 'dired-mode mam
)
499 (if (file-directory-p (file-name-directory (car misc
)))
502 (mapcar 'dired-insert-subdir
(cdr misc
))
504 (message "Directory %s no longer exists." (car misc
))
507 ;; ----------------------------------------------------------------------------
508 (defun desktop-buffer-file () "Load a file."
510 (if (or (file-exists-p fn
)
511 (and desktop-missing-file-warning
513 "File \"%s\" no longer exists. Re-create? "
515 (progn (find-file fn
) t
)
517 ;; ----------------------------------------------------------------------------
518 ;; Create a buffer, load its file, set is mode, ...; called from Desktop file
520 (defun desktop-create-buffer (ver fn bn mam mim pt mk ro misc
&optional locals
)
521 (let ((hlist desktop-buffer-handlers
)
524 (while (and (not result
) hlist
)
525 (setq handler
(car hlist
))
526 (setq result
(funcall handler
))
527 (setq hlist
(cdr hlist
)))
530 (if (not (equal (buffer-name) bn
))
532 (auto-fill-mode (if (nth 0 mim
) 1 0))
537 (setq mark-active
(car (cdr mk
))))
539 ;; Never override file system if the file really is read-only marked.
540 (if ro
(setq buffer-read-only ro
))
542 (let ((this (car locals
)))
544 ;; an entry of this form `(symbol . value)'
546 (make-local-variable (car this
))
547 (set (car this
) (cdr this
)))
548 ;; an entry of the form `symbol'
549 (make-local-variable this
)
551 (setq locals
(cdr locals
)))
554 ;; Backward compatibility -- update parameters to 205 standards.
555 (defun desktop-buffer (fn bn mam mim pt mk ro tl fc cfs cr misc
)
556 (desktop-create-buffer 205 fn bn mam
(cdr mim
) pt mk ro misc
557 (list (cons 'truncate-lines tl
)
558 (cons 'fill-column fc
)
559 (cons 'case-fold-search cfs
)
560 (cons 'case-replace cr
)
561 (cons 'overwrite-mode
(car mim
)))))
562 ;; ----------------------------------------------------------------------------
565 ;; desktop.el ends here.