]> code.delx.au - gnu-emacs/blob - lisp/desktop.el
Fix Filofax year output so that it's the correct size.
[gnu-emacs] / lisp / desktop.el
1 ;;; desktop.el --- save partial status of Emacs when killed
2
3 ;; Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
4
5 ;; Author: Morten Welinder <terra@diku.dk>
6 ;; Keywords: customization
7 ;; Favourite-brand-of-beer: None, I hate beer.
8
9 ;; This file is part of GNU Emacs.
10
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)
14 ;; any later version.
15
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.
20
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.
25
26 ;;; Commentary:
27
28 ;; Save the Desktop, i.e.,
29 ;; - some global variables
30 ;; - the list of buffers with associated files. For each buffer also
31 ;; - the major mode
32 ;; - the default directory
33 ;; - the point
34 ;; - the mark & mark-active
35 ;; - buffer-read-only
36 ;; - some local variables
37
38 ;; To use this, first put these three lines in the bottom of your .emacs
39 ;; file (the later the better):
40 ;;
41 ;; (load "desktop")
42 ;; (desktop-load-default)
43 ;; (desktop-read)
44 ;;
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
49 ;; the line
50 ;;
51 ;; (setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
52 ;;
53 ;; To avoid saving excessive amounts of data you may also wish to add
54 ;; something like the following
55 ;;
56 ;; (add-hook 'kill-emacs-hook
57 ;; '(lambda ()
58 ;; (desktop-truncate search-ring 3)
59 ;; (desktop-truncate regexp-search-ring 3)))
60 ;;
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.
64
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.
73
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.
77
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.
81
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 ;; ---------------------------------------------------------------------------
90 ;; TODO:
91 ;;
92 ;; Save window configuration.
93 ;; Recognize more minor modes.
94 ;; Save mark rings.
95 ;; Start-up with buffer-menu???
96
97 ;;; Code:
98
99 ;; Make the compilation more silent
100 (eval-when-compile
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
110 ".emacs.desktop")
111 "File for Emacs desktop, not including the directory name.")
112
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.")
116
117 (defvar desktop-globals-to-save
118 (list 'desktop-missing-file-warning
119 ;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
120 ;; 'kill-ring
121 'tags-file-name
122 'tags-table-list
123 'search-ring
124 'regexp-search-ring
125 'register-alist
126 ;; 'desktop-globals-to-save ; Itself!
127 )
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.")
133
134 (defvar desktop-locals-to-save
135 (list 'desktop-locals-to-save ; Itself! Think it over.
136 'truncate-lines
137 'case-fold-search
138 'case-replace
139 'fill-column
140 'overwrite-mode
141 'change-log-default-name
142 'line-number-mode
143 )
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)
147
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.")
154
155 ;; Skip ange-ftp files
156 (defvar desktop-files-not-to-save
157 "^/[^/:]*:"
158 "Regexp identifying files whose buffers are to be excluded from saving.")
159
160 (defvar desktop-buffer-major-mode nil
161 "When desktop creates a buffer, this holds the desired Major mode.")
162
163 (defvar desktop-buffer-file-name nil
164 "When desktop creates a buffer, this holds the file name to visit.")
165
166 (defvar desktop-buffer-name nil
167 "When desktop creates a buffer, this holds the desired buffer name.")
168
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.")
172
173 (defvar desktop-buffer-handlers
174 '(desktop-buffer-dired
175 desktop-buffer-rmail
176 desktop-buffer-mh
177 desktop-buffer-info
178 desktop-buffer-file)
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.")
185
186 (defvar desktop-create-buffer-form "(desktop-create-buffer 205"
187 "Opening of form for creation of new buffers.")
188
189 (defvar desktop-save-hook nil
190 "Hook run before saving the desktop to allow you to cut history lists and
191 the like shorter.")
192 ;; ----------------------------------------------------------------------------
193 (defvar desktop-dirname nil
194 "The directory in which the current desktop file resides.")
195
196 (defconst desktop-header
197 ";; --------------------------------------------------------------------------
198 ;; Desktop File for Emacs
199 ;; --------------------------------------------------------------------------
200 " "*Header to place in Desktop file.")
201
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)))
208 (if (consp here)
209 (setcdr here nil))))
210 ;; ----------------------------------------------------------------------------
211 (defun desktop-clear () "Empty the Desktop."
212 (interactive)
213 (setq kill-ring nil
214 kill-ring-yank-pointer nil
215 search-ring 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)
223
224 (defun desktop-kill ()
225 (if desktop-dirname
226 (condition-case err
227 (desktop-save desktop-dirname)
228 (file-error
229 (if (yes-or-no-p "Error while saving the desktop. Quit anyway? ")
230 nil
231 (signal (car err) (cdr err)))))))
232 ;; ----------------------------------------------------------------------------
233 (defun desktop-list* (&rest args)
234 (if (null (cdr args))
235 (car args)
236 (setq args (nreverse args))
237 (let ((value (cons (nth 1 args) (car args))))
238 (setq args (cdr (cdr args)))
239 (while args
240 (setq value (cons (car args) value))
241 (setq args (cdr args)))
242 value)))
243
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)."
249 (cond
250 ((or (numberp val) (null val) (eq t val))
251 (cons 'may (prin1-to-string val)))
252 ((stringp 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))))
257 ((symbolp val)
258 (cons 'must (prin1-to-string val)))
259 ((vectorp val)
260 (let* ((special nil)
261 (pass1 (mapcar
262 (lambda (el)
263 (let ((res (desktop-internal-v2s el)))
264 (if (null (car res))
265 (setq special t))
266 res))
267 val)))
268 (if special
269 (cons nil (concat "(vector "
270 (mapconcat (lambda (el)
271 (if (eq (car el) 'must)
272 (concat "'" (cdr el))
273 (cdr el)))
274 pass1
275 " ")
276 ")"))
277 (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]")))))
278 ((consp val)
279 (let ((p val)
280 newlist
281 use-list*
282 anynil)
283 (while (consp p)
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)))
287 (setq p (cdr p)))
288 (if p
289 (let ((last (desktop-internal-v2s p))
290 (el (car newlist)))
291 (or anynil (setq anynil (null (car last))))
292 (or anynil
293 (setq newlist (cons '(must . ".") newlist)))
294 (setq use-list* t)
295 (setq newlist (cons last newlist))))
296 (setq newlist (nreverse newlist))
297 (if anynil
298 (cons nil
299 (concat (if use-list* "(desktop-list* " "(list ")
300 (mapconcat (lambda (el)
301 (if (eq (car el) 'must)
302 (concat "'" (cdr el))
303 (cdr el)))
304 newlist
305 " ")
306 ")"))
307 (cons 'must
308 (concat "(" (mapconcat 'cdr newlist " ") ")")))))
309 ((subrp val)
310 (cons nil (concat "(symbol-function '"
311 (substring (prin1-to-string val) 7 -1)
312 ")")))
313 ((markerp val)
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)"))))
320 (t ; save as text
321 (cons 'may "\"Unprintable entity\""))))
322
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)))
331 (if (eq quote 'must)
332 (concat "'" txt)
333 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."
341 (let (var size)
342 (if (consp varspec)
343 (setq var (car varspec) size (cdr varspec))
344 (setq var varspec))
345 (if (boundp var)
346 (progn
347 (if (and (integerp size)
348 (> size 0)
349 (listp (eval var)))
350 (desktop-truncate (eval var) size))
351 (insert "(setq "
352 (symbol-name var)
353 " "
354 (desktop-value-to-string (symbol-value var))
355 ")\n")))))
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))
362 (or (and filename
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)
366 (save-excursion
367 (set-buffer (get-buffer bufname))
368 (not (string-match desktop-files-not-to-save
369 default-directory))))
370 (and (null filename)
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)
377 (save-excursion
378 (let ((filename (expand-file-name
379 (concat dirname desktop-basefilename)))
380 (info (nreverse
381 (mapcar
382 (function (lambda (b)
383 (set-buffer b)
384 (list
385 (buffer-file-name)
386 (buffer-name)
387 major-mode
388 (list ; list explaining minor modes
389 (not (null auto-fill-function)))
390 (point)
391 (list (mark t) mark-active)
392 buffer-read-only
393 (cond ((eq major-mode 'Info-mode)
394 (list Info-current-file
395 Info-current-node))
396 ((eq major-mode 'dired-mode)
397 (cons
398 (expand-file-name dired-directory)
399 (cdr
400 (nreverse
401 (mapcar
402 (function car)
403 dired-subdir-alist))))))
404 (let ((locals desktop-locals-to-save)
405 (loclist (buffer-local-variables))
406 (ll))
407 (while locals
408 (let ((here (assq (car locals) loclist)))
409 (if here
410 (setq ll (cons here ll))
411 (if (member (car locals) loclist)
412 (setq ll (cons (car locals) ll)))))
413 (setq locals (cdr locals)))
414 ll)
415 )))
416 (buffer-list))))
417 (buf (get-buffer-create "*desktop*")))
418 (set-buffer buf)
419 (erase-buffer)
420
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 "
428 (int-to-string
429 (- (length kill-ring) (length kill-ring-yank-pointer)))
430 " kill-ring))\n"))
431
432 (insert "\n;; Buffer section:\n")
433 (mapcar
434 (function (lambda (l)
435 (if (apply 'desktop-save-buffer-p l)
436 (progn
437 (insert desktop-create-buffer-form)
438 (mapcar
439 (function (lambda (e)
440 (insert "\n "
441 (desktop-value-to-string e))))
442 l)
443 (insert ")\n\n")))))
444 info)
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."
452 (interactive)
453 (if desktop-dirname
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."
462 (interactive)
463 (if noninteractive
464 nil
465 (let ((dirs '("./" "~/")))
466 (while (and dirs
467 (not (file-exists-p (expand-file-name
468 desktop-basefilename
469 (car dirs)))))
470 (setq dirs (cdr dirs)))
471 (setq desktop-dirname (and dirs (expand-file-name (car dirs))))
472 (if desktop-dirname
473 (progn
474 (load (expand-file-name desktop-basefilename desktop-dirname)
475 t t t)
476 (run-hooks 'desktop-delay-hook)
477 (setq desktop-delay-hook nil)
478 (message "Desktop loaded."))
479 (desktop-clear)))))
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
486 (progn
487 (load "default" t t)
488 (setq inhibit-default-init t))))
489 ;; ----------------------------------------------------------------------------
490 ;; Note: the following functions use the dynamic variable binding in Lisp.
491 ;;
492 (defun desktop-buffer-info () "Load an info file."
493 (if (eq 'Info-mode desktop-buffer-major-mode)
494 (progn
495 (require 'info)
496 (Info-find-node (nth 0 desktop-buffer-misc) (nth 1 desktop-buffer-misc))
497 t)))
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)
503 (file-locked
504 (kill-buffer (current-buffer))
505 'ignored))))
506 ;; ----------------------------------------------------------------------------
507 (defun desktop-buffer-mh () "Load a folder in the mh system."
508 (if (eq 'mh-folder-mode desktop-buffer-major-mode)
509 (progn
510 (require 'mh-e)
511 (mh-find-path)
512 (mh-visit-folder desktop-buffer-name)
513 t)))
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)))
518 (progn
519 (dired (car desktop-buffer-misc))
520 (mapcar 'dired-insert-subdir (cdr desktop-buffer-misc))
521 t)
522 (message "Directory %s no longer exists." (car desktop-buffer-misc))
523 (sit-for 1)
524 'ignored)))
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
530 (y-or-n-p (format
531 "File \"%s\" no longer exists. Re-create? "
532 desktop-buffer-file-name))))
533 (progn (find-file desktop-buffer-file-name) t)
534 'ignored)))
535 ;; ----------------------------------------------------------------------------
536 ;; Create a buffer, load its file, set is mode, ...; called from Desktop file
537 ;; only.
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)
542 (result)
543 (handler))
544 (while (and (not result) hlist)
545 (setq handler (car hlist))
546 (setq result (funcall handler))
547 (setq hlist (cdr hlist)))
548 (if (eq result t)
549 (progn
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))
553 (goto-char pt)
554 (if (consp mk)
555 (progn
556 (set-mark (car mk))
557 (setq mark-active (car (cdr mk))))
558 (set-mark mk))
559 ;; Never override file system if the file really is read-only marked.
560 (if ro (setq buffer-read-only ro))
561 (while locals
562 (let ((this (car locals)))
563 (if (consp this)
564 ;; an entry of this form `(symbol . value)'
565 (progn
566 (make-local-variable (car this))
567 (set (car this) (cdr this)))
568 ;; an entry of the form `symbol'
569 (make-local-variable this)
570 (makunbound this)))
571 (setq locals (cdr locals)))
572 ))))
573
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
580 desktop-buffer-misc
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 ;; ----------------------------------------------------------------------------
587 (provide 'desktop)
588
589 ;; desktop.el ends here.