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-major-mode nil
161 "When desktop creates a buffer, this holds the desired Major mode.")
163 (defvar desktop-buffer-file-name nil
164 "When desktop creates a buffer, this holds the file name to visit.")
166 (defvar desktop-buffer-name nil
167 "When desktop creates a buffer, this holds the desired buffer name.")
169 (defvar desktop-buffer-misc nil
170 "When desktop creates a buffer, this holds a list of misc info.
171 It is used by the `desktop-buffer-handlers' functions.")
173 (defvar desktop-buffer-handlers
174 '(desktop-buffer-dired
179 "*List of functions to call in order to create a buffer.
180 The functions are called without explicit parameters but can use the
181 variables `desktop-buffer-major-mode', `desktop-buffer-file-name',
182 `desktop-buffer-name'.
183 If one function returns non-nil, no further functions are called.
184 If the function returns t then the buffer is considered created.")
186 (defvar desktop-create-buffer-form
"(desktop-create-buffer 205"
187 "Opening of form for creation of new buffers.")
189 (defvar desktop-save-hook nil
190 "Hook run before saving the desktop to allow you to cut history lists and
192 ;; ----------------------------------------------------------------------------
193 (defvar desktop-dirname nil
194 "The directory in which the current desktop file resides.")
196 (defconst desktop-header
197 ";; --------------------------------------------------------------------------
198 ;; Desktop File for Emacs
199 ;; --------------------------------------------------------------------------
200 " "*Header to place in Desktop file.")
202 (defvar desktop-delay-hook nil
203 "Hooks run after all buffers are loaded; intended for internal use.")
204 ;; ----------------------------------------------------------------------------
205 (defun desktop-truncate (l n
)
206 "Truncate LIST to at most N elements destructively."
207 (let ((here (nthcdr (1- n
) l
)))
210 ;; ----------------------------------------------------------------------------
211 (defun desktop-clear () "Empty the Desktop."
214 kill-ring-yank-pointer nil
216 search-ring-yank-pointer nil
217 regexp-search-ring nil
218 regexp-search-ring-yank-pointer nil
)
219 (mapcar (function kill-buffer
) (buffer-list))
220 (delete-other-windows))
221 ;; ----------------------------------------------------------------------------
222 (add-hook 'kill-emacs-hook
'desktop-kill
)
224 (defun desktop-kill ()
227 (desktop-save desktop-dirname
)
229 (if (yes-or-no-p "Error while saving the desktop. Quit anyway? ")
231 (signal (car err
) (cdr err
)))))))
232 ;; ----------------------------------------------------------------------------
233 (defun desktop-list* (&rest args
)
234 (if (null (cdr args
))
236 (setq args
(nreverse args
))
237 (let ((value (cons (nth 1 args
) (car args
))))
238 (setq args
(cdr (cdr args
)))
240 (setq value
(cons (car args
) value
))
241 (setq args
(cdr args
)))
244 (defun desktop-internal-v2s (val)
245 "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
246 TXT is a string that when read and evaluated yields value.
247 QUOTE may be `may' (value may be quoted),
248 `must' (values must be quoted), or nil (value may not be quoted)."
250 ((or (numberp val
) (null val
) (eq t val
))
251 (cons 'may
(prin1-to-string val
)))
253 (let ((copy (copy-sequence val
)))
254 (set-text-properties 0 (length copy
) nil copy
)
255 ;; Get rid of text properties because we cannot read them
256 (cons 'may
(prin1-to-string copy
))))
258 (cons 'must
(prin1-to-string val
)))
263 (let ((res (desktop-internal-v2s el
)))
269 (cons nil
(concat "(vector "
270 (mapconcat (lambda (el)
271 (if (eq (car el
) 'must
)
272 (concat "'" (cdr el
))
277 (cons 'may
(concat "[" (mapconcat 'cdr pass1
" ") "]")))))
284 (let ((q.txt
(desktop-internal-v2s (car p
))))
285 (or anynil
(setq anynil
(null (car q.txt
))))
286 (setq newlist
(cons q.txt newlist
)))
289 (let ((last (desktop-internal-v2s p
))
291 (or anynil
(setq anynil
(null (car last
))))
293 (setq newlist
(cons '(must .
".") newlist
)))
295 (setq newlist
(cons last newlist
))))
296 (setq newlist
(nreverse newlist
))
299 (concat (if use-list
* "(desktop-list* " "(list ")
300 (mapconcat (lambda (el)
301 (if (eq (car el
) 'must
)
302 (concat "'" (cdr el
))
308 (concat "(" (mapconcat 'cdr newlist
" ") ")")))))
310 (cons nil
(concat "(symbol-function '"
311 (substring (prin1-to-string val
) 7 -
1)
314 (let ((pos (prin1-to-string (marker-position val
)))
315 (buf (prin1-to-string (buffer-name (marker-buffer val
)))))
316 (cons nil
(concat "(let ((mk (make-marker)))"
317 " (add-hook 'desktop-delay-hook"
318 " (list 'lambda '() (list 'set-marker mk "
319 pos
" (get-buffer " buf
")))) mk)"))))
321 (cons 'may
"\"Unprintable entity\""))))
323 (defun desktop-value-to-string (val)
324 "Convert VALUE to a string that when read evaluates to the same value.
325 Not all types of values are supported."
326 (let* ((print-escape-newlines t
)
327 (float-output-format nil
)
328 (quote.txt
(desktop-internal-v2s val
))
329 (quote (car quote.txt
))
330 (txt (cdr quote.txt
)))
334 ;; ----------------------------------------------------------------------------
335 (defun desktop-outvar (varspec)
336 "Output a setq statement for variable VAR to the desktop file.
337 The argument VARSPEC may be the variable name VAR (a symbol),
338 or a cons cell of the form (VAR . MAX-SIZE),
339 which means to truncate VAR's value to at most MAX-SIZE elements
340 \(if the value is a list) before saving the value."
343 (setq var
(car varspec
) size
(cdr varspec
))
347 (if (and (integerp size
)
350 (desktop-truncate (eval var
) size
))
354 (desktop-value-to-string (symbol-value var
))
356 ;; ----------------------------------------------------------------------------
357 (defun desktop-save-buffer-p (filename bufname mode
&rest dummy
)
358 "Return t if the desktop should record a particular buffer for next startup.
359 FILENAME is the visited file name, BUFNAME is the buffer name, and
360 MODE is the major mode."
361 (let ((case-fold-search nil
))
363 (not (string-match desktop-buffers-not-to-save bufname
))
364 (not (string-match desktop-files-not-to-save filename
)))
365 (and (eq mode
'dired-mode
)
367 (set-buffer (get-buffer bufname
))
368 (not (string-match desktop-files-not-to-save
369 default-directory
))))
371 (memq mode
'(Info-mode rmail-mode
))))))
372 ;; ----------------------------------------------------------------------------
373 (defun desktop-save (dirname)
374 "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
375 (interactive "DDirectory to save desktop file in: ")
376 (run-hooks 'desktop-save-hook
)
378 (let ((filename (expand-file-name
379 (concat dirname desktop-basefilename
)))
382 (function (lambda (b)
388 (list ; list explaining minor modes
389 (not (null auto-fill-function
)))
391 (list (mark t
) mark-active
)
393 (cond ((eq major-mode
'Info-mode
)
394 (list Info-current-file
396 ((eq major-mode
'dired-mode
)
398 (expand-file-name dired-directory
)
403 dired-subdir-alist
))))))
404 (let ((locals desktop-locals-to-save
)
405 (loclist (buffer-local-variables))
408 (let ((here (assq (car locals
) loclist
)))
410 (setq ll
(cons here ll
))
411 (if (member (car locals
) loclist
)
412 (setq ll
(cons (car locals
) ll
)))))
413 (setq locals
(cdr locals
)))
417 (buf (get-buffer-create "*desktop*")))
421 (insert desktop-header
422 ";; Created " (current-time-string) "\n"
423 ";; Emacs version " emacs-version
"\n\n"
424 ";; Global section:\n")
425 (mapcar (function desktop-outvar
) desktop-globals-to-save
)
426 (if (memq 'kill-ring desktop-globals-to-save
)
427 (insert "(setq kill-ring-yank-pointer (nthcdr "
429 (- (length kill-ring
) (length kill-ring-yank-pointer
)))
432 (insert "\n;; Buffer section:\n")
434 (function (lambda (l)
435 (if (apply 'desktop-save-buffer-p l
)
437 (insert desktop-create-buffer-form
)
439 (function (lambda (e)
441 (desktop-value-to-string e
))))
445 (setq default-directory dirname
)
446 (if (file-exists-p filename
) (delete-file filename
))
447 (write-region (point-min) (point-max) filename nil
'nomessage
)))
448 (setq desktop-dirname dirname
))
449 ;; ----------------------------------------------------------------------------
450 (defun desktop-remove ()
451 "Delete the Desktop file and inactivate the desktop system."
454 (let ((filename (concat desktop-dirname desktop-basefilename
)))
455 (setq desktop-dirname nil
)
456 (if (file-exists-p filename
)
457 (delete-file filename
)))))
458 ;; ----------------------------------------------------------------------------
459 (defun desktop-read ()
460 "Read the Desktop file and the files it specifies.
461 This is a no-op when Emacs is running in batch mode."
465 (let ((dirs '("./" "~/")))
467 (not (file-exists-p (expand-file-name
470 (setq dirs
(cdr dirs
)))
471 (setq desktop-dirname
(and dirs
(expand-file-name (car dirs
))))
474 (load (expand-file-name desktop-basefilename desktop-dirname
)
476 (run-hooks 'desktop-delay-hook
)
477 (setq desktop-delay-hook nil
)
478 (message "Desktop loaded."))
480 ;; ----------------------------------------------------------------------------
481 (defun desktop-load-default ()
482 "Load the `default' start-up library manually.
483 Also inhibit further loading of it. Call this from your `.emacs' file
484 to provide correct modes for autoloaded files."
485 (if (not inhibit-default-init
) ; safety check
488 (setq inhibit-default-init t
))))
489 ;; ----------------------------------------------------------------------------
490 ;; Note: the following functions use the dynamic variable binding in Lisp.
492 (defun desktop-buffer-info () "Load an info file."
493 (if (eq 'Info-mode desktop-buffer-major-mode
)
496 (Info-find-node (nth 0 desktop-buffer-misc
) (nth 1 desktop-buffer-misc
))
498 ;; ----------------------------------------------------------------------------
499 (defun desktop-buffer-rmail () "Load an RMAIL file."
500 (if (eq 'rmail-mode desktop-buffer-major-mode
)
501 (condition-case error
502 (progn (rmail-input desktop-buffer-file-name
) t
)
504 (kill-buffer (current-buffer))
506 ;; ----------------------------------------------------------------------------
507 (defun desktop-buffer-mh () "Load a folder in the mh system."
508 (if (eq 'mh-folder-mode desktop-buffer-major-mode
)
512 (mh-visit-folder desktop-buffer-name
)
514 ;; ----------------------------------------------------------------------------
515 (defun desktop-buffer-dired () "Load a directory using dired."
516 (if (eq 'dired-mode desktop-buffer-major-mode
)
517 (if (file-directory-p (file-name-directory (car desktop-buffer-misc
)))
519 (dired (car desktop-buffer-misc
))
520 (mapcar 'dired-insert-subdir
(cdr desktop-buffer-misc
))
522 (message "Directory %s no longer exists." (car desktop-buffer-misc
))
525 ;; ----------------------------------------------------------------------------
526 (defun desktop-buffer-file () "Load a file."
527 (if desktop-buffer-file-name
528 (if (or (file-exists-p desktop-buffer-file-name
)
529 (and desktop-missing-file-warning
531 "File \"%s\" no longer exists. Re-create? "
532 desktop-buffer-file-name
))))
533 (progn (find-file desktop-buffer-file-name
) t
)
535 ;; ----------------------------------------------------------------------------
536 ;; Create a buffer, load its file, set is mode, ...; called from Desktop file
538 (defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
539 desktop-buffer-major-mode
540 mim pt mk ro desktop-buffer-misc
&optional locals
)
541 (let ((hlist desktop-buffer-handlers
)
544 (while (and (not result
) hlist
)
545 (setq handler
(car hlist
))
546 (setq result
(funcall handler
))
547 (setq hlist
(cdr hlist
)))
550 (if (not (equal (buffer-name) desktop-buffer-name
))
551 (rename-buffer desktop-buffer-name
))
552 (auto-fill-mode (if (nth 0 mim
) 1 0))
557 (setq mark-active
(car (cdr mk
))))
559 ;; Never override file system if the file really is read-only marked.
560 (if ro
(setq buffer-read-only ro
))
562 (let ((this (car locals
)))
564 ;; an entry of this form `(symbol . value)'
566 (make-local-variable (car this
))
567 (set (car this
) (cdr this
)))
568 ;; an entry of the form `symbol'
569 (make-local-variable this
)
571 (setq locals
(cdr locals
)))
574 ;; Backward compatibility -- update parameters to 205 standards.
575 (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
576 desktop-buffer-major-mode
577 mim pt mk ro tl fc cfs cr desktop-buffer-misc
)
578 (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
579 desktop-buffer-major-mode
(cdr mim
) pt mk ro
581 (list (cons 'truncate-lines tl
)
582 (cons 'fill-column fc
)
583 (cons 'case-fold-search cfs
)
584 (cons 'case-replace cr
)
585 (cons 'overwrite-mode
(car mim
)))))
586 ;; ----------------------------------------------------------------------------
589 ;; desktop.el ends here.