;;; desktop.el --- save partial status of Emacs when killed
-;; Copyright (C) 1993 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
;; Author: Morten Welinder <terra@diku.dk>
-;; Version: 2.05
;; Keywords: customization
;; Favourite-brand-of-beer: None, I hate beer.
;; (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
+;; 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
+;; To avoid saving excessive amounts of data you may also wish to add
;; something like the following
;;
;; (add-hook 'kill-emacs-hook
-;; '(lambda ()
+;; '(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.
+;; must place this line *after* the (load "desktop") line. See also the
+;; variable desktop-save-hook.
;; 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
;; 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
+;; 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
;; `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.
+;; 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.
+;; kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt.
+;; treese@lcs.mit.edu (Win Treese) for ange-ftp tips.
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Make the compilation more silent
(eval-when-compile
;; We use functions from these modules
- (mapcar 'require '(info mh-e dired))
- ;; We handle auto-fill-hook in a way that is ok.
- (put 'auto-fill-hook 'byte-obsolete-variable nil)
- ;; Some things are different in version 18.
- (setq postv18 (string-lessp "19" emacs-version)))
+ ;; We can't (require 'mh-e) since that wants to load something.
+ (mapcar 'require '(info dired reporter)))
;; ----------------------------------------------------------------------------
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
(defconst desktop-basefilename
- (if (equal system-type 'ms-dos)
+ (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt))
"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.")
+ "File for Emacs desktop, not including the directory name.")
(defvar desktop-missing-file-warning t
- "*If non-nil then issue warning if a file no longer exists.
-Otherwise simply ignore the file.")
+ "*If non-nil then desktop warns when a file no longer exists.
+Otherwise it simply ignores that file.")
(defvar desktop-globals-to-save
(list 'desktop-missing-file-warning
'tags-table-list
'search-ring
'regexp-search-ring
+ 'register-alist
;; 'desktop-globals-to-save ; Itself!
)
- "List of global variables to save when killing Emacs.")
+ "List of global variables to save when killing Emacs.
+An element may be variable name (a symbol)
+or a cons cell of the form (VAR . MAX-SIZE),
+which means to truncate VAR's value to at most MAX-SIZE elements
+\(if the value is a list) before saving the value.")
(defvar desktop-locals-to-save
(list 'desktop-locals-to-save ; Itself! Think it over.
'fill-column
'overwrite-mode
'change-log-default-name
+ 'line-number-mode
)
- "List of local variables to save for each buffer. The variables are saved
-only when they really are local.")
+ "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.
+;; (ftp) files because they require passwords and whatnot.
;; TAGS files to save time (tags-file-name is saved instead).
(defvar desktop-buffers-not-to-save
- "\\(\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
+ "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
"Regexp identifying buffers that are to be excluded from saving.")
+;; Skip ange-ftp files
+(defvar desktop-files-not-to-save
+ "^/[^/:]*:"
+ "Regexp identifying files whose buffers are to be excluded from saving.")
+
(defvar desktop-buffer-handlers
'(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 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.")
+ "*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-create-buffer-form "(desktop-create-buffer 205"
"Opening of form for creation of new buffers.")
+
+(defvar desktop-save-hook nil
+ "Hook run before saving the desktop to allow you to cut history lists and
+the like shorter.")
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
"The directory in which the current desktop file resides.")
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
" "*Header to place in Desktop file.")
+
+(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))))
+ (setcdr here nil))))
;; ----------------------------------------------------------------------------
(defun desktop-clear () "Empty the Desktop."
(interactive)
- (setq kill-ring nil)
- (setq kill-ring-yank-pointer nil)
+ (setq kill-ring nil
+ kill-ring-yank-pointer nil
+ search-ring nil
+ search-ring-yank-pointer nil
+ regexp-search-ring nil
+ regexp-search-ring-yank-pointer nil)
(mapcar (function kill-buffer) (buffer-list))
(delete-other-windows))
;; ----------------------------------------------------------------------------
-;; This is a bit dirty for version 18 because that version of Emacs was not
-;; toilet-trained considering hooks.
-(defvar old-kill-emacs)
+(add-hook 'kill-emacs-hook 'desktop-kill)
-(if (eval-when-compile postv18)
- (add-hook 'kill-emacs-hook 'desktop-kill)
- (if (not (boundp 'desktop-kill))
- (setq old-kill-emacs kill-emacs-hook
- kill-emacs-hook
- (function (lambda ()
- (progn (desktop-kill)
- (if (or (null old-kill-emacs)
- (symbolp old-kill-emacs))
- (run-hooks old-kill-emacs)
- (funcall old-kill-emacs))))))))
-;; ----------------------------------------------------------------------------
(defun desktop-kill ()
(if desktop-dirname
- (progn
- (desktop-save desktop-dirname))))
+ (condition-case err
+ (desktop-save desktop-dirname)
+ (file-error
+ (if (yes-or-no-p "Error while saving the desktop. Quit anyway? ")
+ nil
+ (signal (car err) (cdr err)))))))
;; ----------------------------------------------------------------------------
+(defun desktop-internal-v2s (val)
+ "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE.
+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) (null val) (eq t val))
+ (cons 'may (prin1-to-string val)))
+ ((stringp val)
+ (let ((copy (copy-sequence val)))
+ (set-text-properties 0 (length copy) nil copy)
+ ;; Get rid of text properties because we cannot read them
+ (cons 'may (prin1-to-string copy))))
+ ((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 ((p val)
+ newlist
+ anynil)
+ (while (consp p)
+ (let ((q.txt (desktop-internal-v2s (car p))))
+ (or anynil (setq anynil (null (car q.txt))))
+ (setq newlist (cons q.txt newlist)))
+ (setq p (cdr p)))
+ (if p
+ (let ((last (desktop-internal-v2s p))
+ (el (car newlist)))
+ (setcar newlist
+ (if (or anynil (setq anynil (null (car last))))
+ (cons nil
+ (concat "(cons "
+ (if (eq (car el) 'must) "'" "")
+ (cdr el)
+ " "
+ (if (eq (car last) 'must) "'" "")
+ (cdr last)
+ ")"))
+ (cons 'must
+ (concat (cdr el) " . " (cdr last)))))))
+ (setq newlist (nreverse newlist))
+ (if anynil
+ (cons nil
+ (concat "(list "
+ (mapconcat (lambda (el)
+ (if (eq (car el) 'must)
+ (concat "'" (cdr el))
+ (cdr el)))
+ newlist
+ " ")
+ ")"))
+ (cons 'must
+ (concat "(" (mapconcat 'cdr newlist " ") ")")))))
+ ((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
+ (cons 'may "\"Unprintable entity\""))))
+
(defun desktop-value-to-string (val)
- (let ((print-escape-newlines t))
- (concat
- ;; symbols are needed for cons cells and for symbols except
- ;; `t' and `nil'.
- (if (or (consp val)
- (and (symbolp val) val (not (eq t val))))
- "'"
- "")
- (prin1-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)
- (insert "(setq "
- (symbol-name var)
- " "
- (desktop-value-to-string (symbol-value var))
- ")\n")))
+(defun desktop-outvar (varspec)
+ "Output a setq statement for variable VAR to the desktop file.
+The argument VARSPEC may be the variable name VAR (a symbol),
+or a cons cell of the form (VAR . MAX-SIZE),
+which means to truncate VAR's value to at most MAX-SIZE elements
+\(if the value is a list) before saving the value."
+ (let (var size)
+ (if (consp varspec)
+ (setq var (car varspec) size (cdr varspec))
+ (setq var varspec))
+ (if (boundp var)
+ (progn
+ (if (and (integerp size)
+ (> size 0)
+ (listp (eval var)))
+ (desktop-truncate (eval var) size))
+ (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)))))
+ (let ((case-fold-search nil))
+ (or (and filename
+ (not (string-match desktop-buffers-not-to-save bufname))
+ (not (string-match desktop-files-not-to-save filename)))
+ (and (eq mode 'dired-mode)
+ (save-excursion
+ (set-buffer (get-buffer bufname))
+ (not (string-match desktop-files-not-to-save
+ default-directory))))
+ (and (null filename)
+ (memq mode '(Info-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: ")
+ (run-hooks 'desktop-save-hook)
(save-excursion
(let ((filename (expand-file-name
(concat dirname desktop-basefilename)))
(buffer-name)
major-mode
(list ; list explaining minor modes
- (not (null
- (if (eval-when-compile postv18)
- auto-fill-function
- auto-fill-hook))))
+ (not (null auto-fill-function)))
(point)
- (if (eval-when-compile postv18)
- (list (mark t) mark-active)
- (mark))
+ (list (mark t) mark-active)
buffer-read-only
(cond ((eq major-mode 'Info-mode)
(list Info-current-file
Info-current-node))
((eq major-mode 'dired-mode)
- (if (eval-when-compile postv18)
- (nreverse
- (mapcar
- (function car)
- dired-subdir-alist))
- (list default-directory)))
- )
+ (cons
+ (expand-file-name dired-directory)
+ (cdr
+ (nreverse
+ (mapcar
+ (function car)
+ dired-subdir-alist))))))
(let ((locals desktop-locals-to-save)
(loclist (buffer-local-variables))
(ll))
" kill-ring))\n"))
(insert "\n;; Buffer section:\n")
- (let ((print-escape-newlines t))
- (mapcar
- (function (lambda (l)
- (if (apply 'desktop-save-buffer-p l)
- (progn
- (insert desktop-create-buffer-form)
- (mapcar
- (function (lambda (e)
- (insert "\n "
- (desktop-value-to-string e))))
- l)
- (insert ")\n\n")))))
- info))
+ (mapcar
+ (function (lambda (l)
+ (if (apply 'desktop-save-buffer-p l)
+ (progn
+ (insert desktop-create-buffer-form)
+ (mapcar
+ (function (lambda (e)
+ (insert "\n "
+ (desktop-value-to-string e))))
+ l)
+ (insert ")\n\n")))))
+ info)
(setq default-directory dirname)
(if (file-exists-p filename) (delete-file filename))
(write-region (point-min) (point-max) filename nil 'nomessage)))
(interactive)
(if desktop-dirname
(let ((filename (concat desktop-dirname desktop-basefilename)))
- (if (file-exists-p filename) (delete-file filename))
- (setq desktop-dirname nil))))
+ (setq desktop-dirname nil)
+ (if (file-exists-p filename)
+ (delete-file filename)))))
;; ----------------------------------------------------------------------------
(defun desktop-read ()
"Read the Desktop file and the files it specifies."
(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 to provide correct modes for
-autoloaded files."
+ "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)
;; ----------------------------------------------------------------------------
(defun desktop-buffer-rmail () "Load an RMAIL file."
(if (eq 'rmail-mode mam)
- (progn (rmail-input fn) t)))
+ (condition-case error
+ (progn (rmail-input fn) t)
+ (file-locked
+ (kill-buffer (current-buffer))
+ 'ignored))))
;; ----------------------------------------------------------------------------
(defun desktop-buffer-mh () "Load a folder in the mh system."
(if (eq 'mh-folder-mode mam)
;; ----------------------------------------------------------------------------
(defun desktop-buffer-dired () "Load a directory using dired."
(if (eq 'dired-mode mam)
- (progn
- (dired (car misc))
- (mapcar (function dired-maybe-insert-subdir) (cdr misc))
- t)))
+ (if (file-directory-p (file-name-directory (car misc)))
+ (progn
+ (dired (car misc))
+ (mapcar 'dired-insert-subdir (cdr misc))
+ t)
+ (message "Directory %s no longer exists." (car misc))
+ (sit-for 1)
+ 'ignored)))
;; ----------------------------------------------------------------------------
(defun desktop-buffer-file () "Load a file."
(if fn
HCoop / bpt / emacs.git / blobdiff