;;; desktop.el --- save partial status of Emacs when killed
-;; Copyright (C) 1993 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
;; Author: Morten Welinder <terra@diku.dk>
-;; Version: 2.01
+;; Version: 2.07
+;; Keywords: customization
+;; Favourite-brand-of-beer: None, I hate beer.
;; This file is part of GNU Emacs.
;;; Commentary:
-; 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
-; - buffer-read-only
-; - truncate-lines
-; - case-fold-search
-; - case-replace
-; - fill-column
+;; 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
+;; - some local variables
-; 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)
-;
+;; 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)
+;;
+;; Between the second and the third line you may wish to add something that
+;; updates the variables `desktop-globals-to-save' and/or
+;; `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))
+;;
+;; To avoid saving excessive amounts of data you may also with to add
+;; something like the following
+;;
+;; (add-hook 'kill-emacs-hook
+;; '(lambda ()
+;; (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.
-; 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
-; left them.
-;
-; PLEASE NOTE: When the kill ring is 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.
-;
-; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas.
-; ---------------------------------------------------------------------------
-; HISTORY:
-;
-; Dec , 1992: Version 1.0 written; never released.
-; Jan , 1993: Minor modes now saved: auto-fill-mode, overwrite-mode.
-; Apr 26, 1993: Version 1.1 released.
-; Apr 29, 1993: Now supports RMAIL, Info, and dired modes.
-; Will now search home directory for desktop file.
-; desktop-save asks for directory to save in.
-; May 31, 1993: Version 1.3
-; Now works with Emacs 19.
-; Jun 1, 1993: Minor bug fix.
-;
-; TODO:
-;
-; Save window configuration.
-; Recognize more minor modes.
-; Save mark rings.
-; Start-up with buffer-menu???
+;; 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
+;; left them. If you save a desktop file in your home directory it will
+;; act as a default desktop when you start Emacs from a directory that
+;; 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.
+
+;; 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.
+
+;; 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.
+;; ---------------------------------------------------------------------------
+;; TODO:
+;;
+;; Save window configuration.
+;; Recognize more minor modes.
+;; Save mark rings.
+;; Start-up with buffer-menu???
;;; Code:
-; USER OPTIONS -- settings you might want to play with.
-; -----------------------------------------------------------------------------
-(defconst desktop-basefilename
- (if (equal system-type 'ms-dos)
+;; Make the compilation more silent
+(eval-when-compile
+ ;; We use functions from these modules
+ (mapcar 'require '(info mh-e dired reporter)))
+;; ----------------------------------------------------------------------------
+;; USER OPTIONS -- settings you might want to play with.
+;; ----------------------------------------------------------------------------
+(defconst desktop-basefilename
+ (if (eq system-type 'ms-dos)
"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.")
-(defvar desktop-missing-file-warning t
+(defvar desktop-missing-file-warning t
"*If non-nil then issue warning if a file no longer exists.
Otherwise simply ignore the file.")
-(defvar desktop-globals-to-save
+(defvar desktop-globals-to-save
(list 'desktop-missing-file-warning
- ; 'kill-ring ; Feature: Also saves kill-ring-yank-pointer
- 'desktop-globals-to-save) ; Itself!
+ ;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
+ ;; 'kill-ring
+ 'tags-file-name
+ 'tags-table-list
+ 'search-ring
+ 'regexp-search-ring
+ 'register-alist
+ ;; 'desktop-globals-to-save ; Itself!
+ )
"List of global variables to save when killing Emacs.")
+(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.")
+(make-variable-buffer-local 'desktop-locals-to-save)
+
+;; 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).
(defvar desktop-buffers-not-to-save
- "\\(\\.log\\|(ftp)\\)$"
+ "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
"Regexp identifying buffers that are to be excluded from saving.")
(defvar desktop-buffer-handlers
- '(desktop-buffer-dired
+ '(desktop-buffer-dired
desktop-buffer-rmail
+ desktop-buffer-mh
desktop-buffer-info
desktop-buffer-file)
- "*List of functions to call in order to create a buffer.
-The functions are called without 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.
+ "*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.
If the function returns t then the buffer is considered created.")
-; ---------------------------------------------------------------------------
-(defvar desktop-dirname nil
+
+(defvar desktop-create-buffer-form "(desktop-create-buffer 205"
+ "Opening of form for creation of new buffers.")
+;; ----------------------------------------------------------------------------
+(defvar desktop-dirname nil
"The directory in which the current desktop file resides.")
(defconst desktop-header
-"; ---------------------------------------------------------------------------
-; Desktop File for Emacs
-; ---------------------------------------------------------------------------
+";; --------------------------------------------------------------------------
+;; Desktop File for Emacs
+;; --------------------------------------------------------------------------
" "*Header to place in Desktop file.")
-; ---------------------------------------------------------------------------
-(defconst postv18
- (string-lessp "19" emacs-version)
- "t is Emacs version 19 or later.")
+(defvar desktop-delay-hook nil
+ "Hooks run after all buffers are loaded; intended for internal use.")
+;; ----------------------------------------------------------------------------
+(defun desktop-truncate (l n)
+ "Truncate LIST to at most N elements destructively."
+ (let ((here (nthcdr (1- n) l)))
+ (if (consp here)
+ (setcdr here nil))))
+;; ----------------------------------------------------------------------------
(defun desktop-clear () "Empty the Desktop."
(interactive)
(setq kill-ring nil)
(setq kill-ring-yank-pointer nil)
- (mapcar (function kill-buffer) (buffer-list)))
-; ---------------------------------------------------------------------------
-(if (not (boundp 'desktop-kill))
- (if postv18
- (add-hook 'kill-emacs-hook 'desktop-kill)
- (setq old-kill-emacs kill-emacs-hook)
- (setq kill-emacs-hook
- (function (lambda () (progn (desktop-kill)
- (run-hooks old-kill-emacs)))))))
-; ---------------------------------------------------------------------------
+ (mapcar (function kill-buffer) (buffer-list))
+ (delete-other-windows))
+;; ----------------------------------------------------------------------------
+(add-hook 'kill-emacs-hook 'desktop-kill)
+
(defun desktop-kill ()
- (if desktop-dirname
+ (if desktop-dirname
(progn
(desktop-save desktop-dirname))))
+;; ----------------------------------------------------------------------------
+(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)))))
-;(defun kill-emacs (&optional query)
-; "End this Emacs session.
-;Prefix ARG or optional first ARG non-nil means exit with no questions asked,
-;even if there are unsaved buffers. If Emacs is running non-interactively
-;and ARG is an integer, then Emacs exits with ARG as its exit code.
-;
-;If the variable `desktop-dirname' is non-nil,
-;the function desktop-save will be called first."
-; (interactive "P")
-; (if desktop-dirname (desktop-save desktop-dirname))
-; (original-kill-emacs query))
-; ---------------------------------------------------------------------------
-(defun desktop-outvar (VAR)
+(defun desktop-value-to-string (val)
+ "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)))
+;; ----------------------------------------------------------------------------
+(defun desktop-outvar (var)
"Output a setq statement for VAR to the desktop file."
- (if (boundp VAR)
- (progn
- (insert "(setq ")
- (prin1 VAR (current-buffer))
- (insert " '")
- (prin1 (symbol-value VAR) (current-buffer))
- (insert ")\n"))))
-; ---------------------------------------------------------------------------
-(defun desktop-save-buffer-p (filename bufname mode)
- "Return t if should record a particular buffer for next startup.
-FILENAME is the visited file name, BUFNAME is the buffer name, and
+ (if (boundp var)
+ (insert "(setq "
+ (symbol-name var)
+ " "
+ (desktop-value-to-string (symbol-value var))
+ ")\n")))
+;; ----------------------------------------------------------------------------
+(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
+ "Return t if the desktop should record a particular buffer for next startup.
+FILENAME is the visited file name, BUFNAME is the buffer name, and
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)))))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
(defun desktop-save (dirname)
"Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
(interactive "DDirectory to save desktop file in: ")
(save-excursion
- (let ((filename (expand-file-name
+ (let ((filename (expand-file-name
(concat dirname desktop-basefilename)))
- (info (nreverse
- (mapcar
+ (info (nreverse
+ (mapcar
(function (lambda (b)
(set-buffer b)
- (list
+ (list
(buffer-file-name)
(buffer-name)
- (list 'quote major-mode)
- (list 'quote
- (list overwrite-mode
- (not (null
- (if postv18
- auto-fill-function
- auto-fill-hook)))))
+ major-mode
+ (list ; list explaining minor modes
+ (not (null auto-fill-function)))
(point)
- (if postv18
- (mark t)
- (mark))
+ (list (mark t) mark-active)
buffer-read-only
- truncate-lines
- fill-column
- case-fold-search
- case-replace
- (list
- 'quote
- (cond ((equal major-mode 'Info-mode)
- (list Info-current-file
- Info-current-node))
- ((equal major-mode 'dired-mode)
- (list default-directory))
- ))
+ (cond ((eq major-mode 'Info-mode)
+ (list Info-current-file
+ Info-current-node))
+ ((eq major-mode 'dired-mode)
+ (nreverse
+ (mapcar
+ (function car)
+ dired-subdir-alist)))
+ )
+ (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)
)))
(buffer-list))))
(buf (get-buffer-create "*desktop*")))
(set-buffer buf)
(erase-buffer)
-
- (insert desktop-header
- "; Created " (current-time-string) "\n"
- "; Emacs version " emacs-version "\n\n"
- "; Global section:\n")
+
+ (insert desktop-header
+ ";; Created " (current-time-string) "\n"
+ ";; Emacs version " emacs-version "\n\n"
+ ";; Global section:\n")
(mapcar (function desktop-outvar) desktop-globals-to-save)
(if (memq 'kill-ring desktop-globals-to-save)
- (insert "(setq kill-ring-yank-pointer (nthcdr "
- (int-to-string
+ (insert "(setq kill-ring-yank-pointer (nthcdr "
+ (int-to-string
(- (length kill-ring) (length kill-ring-yank-pointer)))
" kill-ring))\n"))
- (insert "\n; Buffer section:\n")
- (mapcar
+ (insert "\n;; Buffer section:\n")
+ (mapcar
(function (lambda (l)
- (if (desktop-save-buffer-p
- (car l)
- (nth 1 l)
- (nth 1 (nth 2 l)))
+ (if (apply 'desktop-save-buffer-p l)
(progn
- (insert "(desktop-buffer")
- (mapcar
+ (insert desktop-create-buffer-form)
+ (mapcar
(function (lambda (e)
- (insert "\n ")
- (prin1 e (current-buffer))))
+ (insert "\n "
+ (desktop-value-to-string e))))
l)
(insert ")\n\n")))))
info)
(if (file-exists-p filename) (delete-file filename))
(write-region (point-min) (point-max) filename nil 'nomessage)))
(setq desktop-dirname dirname))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
(defun desktop-remove ()
"Delete the Desktop file and inactivate the desktop system."
(interactive)
(let ((filename (concat desktop-dirname desktop-basefilename)))
(if (file-exists-p filename) (delete-file filename))
(setq desktop-dirname nil))))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
(defun desktop-read ()
"Read the Desktop file and the files it specifies."
(interactive)
(if desktop-dirname
(progn
(load (concat desktop-dirname desktop-basefilename) t t t)
+ (run-hooks 'desktop-delay-hook)
(message "Desktop loaded."))
(desktop-clear))))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
(defun desktop-load-default ()
- "Load the `default' start-up library manually.
-Also inhibit further loading of it.
-Call this from your `.emacs' file
-provide correct modes for autoloaded files."
- (if (not inhibit-default-init)
+ "Load the `default' start-up library manually. Also inhibit further loading
+of it. Call this from your `.emacs' file to provide correct modes for
+autoloaded files."
+ (if (not inhibit-default-init) ; safety check
(progn
(load "default" t t)
(setq inhibit-default-init t))))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
+;; Note: the following functions use the dynamic variable binding in Lisp.
+;;
(defun desktop-buffer-info () "Load an info file."
- (if (equal 'Info-mode mam)
+ (if (eq 'Info-mode mam)
(progn
(require 'info)
(Info-find-node (nth 0 misc) (nth 1 misc))
t)))
-; ---------------------------------------------------------------------------
-(defun desktop-buffer-rmail () "Load a RMAIL file."
- (if (equal 'rmail-mode mam)
+;; ----------------------------------------------------------------------------
+(defun desktop-buffer-rmail () "Load an RMAIL file."
+ (if (eq 'rmail-mode mam)
(progn (rmail-input fn) t)))
-; ---------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
+(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)))
+;; ----------------------------------------------------------------------------
(defun desktop-buffer-dired () "Load a directory using dired."
- (if (equal 'dired-mode mam)
- (progn (dired (nth 0 misc)) t)))
-; ---------------------------------------------------------------------------
+ (if (eq 'dired-mode mam)
+ (progn
+ (dired (car misc))
+ (mapcar (function dired-maybe-insert-subdir) (cdr misc))
+ t)))
+;; ----------------------------------------------------------------------------
(defun desktop-buffer-file () "Load a file."
(if fn
(if (or (file-exists-p fn)
(and desktop-missing-file-warning
- (y-or-n-p (format
- "File \"%s\" no longer exists. Re-create? "
+ (y-or-n-p (format
+ "File \"%s\" no longer exists. Re-create? "
fn))))
(progn (find-file fn) t)
'ignored)))
-; ---------------------------------------------------------------------------
-;;Create a buffer, load its file, set is mode, ...; called from Desktop file
+;; ----------------------------------------------------------------------------
+;; Create a buffer, load its file, set is mode, ...; called from Desktop file
;; only.
-(defun desktop-buffer (fn bn mam mim pt mk ro tl fc cfs cr misc)
+(defun desktop-create-buffer (ver fn bn mam mim pt mk ro misc &optional locals)
(let ((hlist desktop-buffer-handlers)
(result)
(handler))
(setq handler (car hlist))
(setq result (funcall handler))
(setq hlist (cdr hlist)))
- (if (equal result t)
+ (if (eq result t)
(progn
(if (not (equal (buffer-name) bn))
(rename-buffer bn))
- (if (nth 0 mim)
- (overwrite-mode 1)
- (overwrite-mode 0))
- (if (nth 1 mim)
- (auto-fill-mode 1)
- (overwrite-mode 0))
+ (auto-fill-mode (if (nth 0 mim) 1 0))
(goto-char pt)
- (set-mark mk)
- (setq buffer-read-only ro)
- (setq truncate-lines tl)
- (setq fill-column fc)
- (setq case-fold-search cfs)
- (setq case-replace cr)
+ (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))
+ (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)))
))))
-; ---------------------------------------------------------------------------
+;; 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)))))
+;; ----------------------------------------------------------------------------
(provide 'desktop)
;; desktop.el ends here.