(const :tag "Ask if desktop file exists, else don't save" ask-if-exists)
(const :tag "Save if desktop file exists, else don't" if-exists)
(const :tag "Never save" nil))
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-base-file-name
(convert-standard-filename ".emacs.desktop")
"List of directories to search for the desktop file.
The base name of the file is specified in `desktop-base-file-name'."
:type '(repeat directory)
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-missing-file-warning nil
- "*If non-nil then `desktop-read' warns when a file no longer exists.
-Otherwise it simply ignores that file."
+ "*If non-nil then `desktop-read' asks if a non-existent file should be recreated.
+Also pause for a moment to display message about errors signaled in
+`desktop-buffer-mode-handlers'.
+
+If nil, just print error messages in the message buffer."
:type 'boolean
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-no-desktop-file-hook nil
"Normal hook run when `desktop-read' can't find a desktop file.
May e.g. be used to show a dired buffer."
:type 'hook
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-after-read-hook nil
"Normal hook run after a successful `desktop-read'.
May e.g. be used to show a buffer list."
:type 'hook
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-save-hook nil
"Normal hook run before the desktop is saved in a desktop file.
:type 'hook
:group 'desktop)
-(defcustom desktop-globals-to-save '(
- desktop-missing-file-warning
- tags-file-name
- tags-table-list
- search-ring
- regexp-search-ring
- register-alist)
+(defcustom desktop-globals-to-save
+ '(desktop-missing-file-warning
+ tags-file-name
+ tags-table-list
+ search-ring
+ regexp-search-ring
+ register-alist)
"List of global variables saved by `desktop-save'.
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
:type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
:group 'desktop)
-(defcustom desktop-globals-to-clear '(
- kill-ring
- kill-ring-yank-pointer
- search-ring
- search-ring-yank-pointer
- regexp-search-ring
- regexp-search-ring-yank-pointer)
+(defcustom desktop-globals-to-clear
+ '(kill-ring
+ kill-ring-yank-pointer
+ search-ring
+ search-ring-yank-pointer
+ regexp-search-ring
+ regexp-search-ring-yank-pointer)
"List of global variables to clear by `desktop-clear'.
An element may be variable name (a symbol) or a cons cell of the form
\(VAR . FORM). Symbols are set to nil and for cons cells VAR is set
to the value obtained by evaluateing FORM."
:type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
(defcustom desktop-clear-preserve-buffers-regexp
"^\\(\\*scratch\\*\\|\\*Messages\\*\\|\\*tramp/.+\\*\\)$"
- "Regexp identifying buffers that `desktop-clear' should not delete."
+ "Regexp identifying buffers that `desktop-clear' should not delete.
+See also `desktop-clear-preserve-buffers'."
:type 'regexp
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
-;; Maintained for backward compatibility
(defcustom desktop-clear-preserve-buffers nil
"*List of buffer names that `desktop-clear' should not delete.
-This variable is maintained for backward compatibility only."
+See also `desktop-clear-preserve-buffers-regexp'."
:type '(repeat string)
:group 'desktop)
-(make-obsolete-variable 'desktop-clear-preserve-buffers
- 'desktop-clear-preserve-buffers-regexp)
-
-(defcustom desktop-locals-to-save '(
- desktop-locals-to-save ; Itself! Think it over.
- truncate-lines
- case-fold-search
- case-replace
- fill-column
- overwrite-mode
- change-log-default-name
- line-number-mode
- buffer-file-coding-system)
+
+(defcustom desktop-locals-to-save
+ '(desktop-locals-to-save ; Itself! Think it over.
+ truncate-lines
+ case-fold-search
+ case-replace
+ fill-column
+ overwrite-mode
+ change-log-default-name
+ line-number-mode
+ buffer-file-coding-system)
"List of local variables to save for each buffer.
The variables are saved only when they really are local."
:type '(repeat symbol)
:type 'regexp
:group 'desktop)
-(defcustom desktop-buffer-modes-to-save
- '(Info-mode rmail-mode)
- "If a buffer is of one of these major modes, save the buffer state.
-This applies to buffers not visiting a file and not beeing a dired buffer.
-Modes specified here must have a handler in `desktop-buffer-mode-handlers'
-to be restored."
- :type '(repeat symbol)
- :group 'desktop)
-
(defcustom desktop-modes-not-to-save nil
"List of major modes whose buffers should not be saved."
:type '(repeat symbol)
tilde -- Relative to ~.
local -- Relative to directory of desktop file."
:type '(choice (const absolute) (const tilde) (const local))
- :group 'desktop)
+ :group 'desktop
+ :version "21.4")
;;;###autoload
-(defvar desktop-buffer-misc-data-function nil
- "Function returning major mode specific data for desktop file.
+(defvar desktop-save-buffer nil
+ "When non-nil, save buffer status in desktop file.
This variable becomes buffer local when set.
-The function specified is called by `desktop-save', with argument
-DESKTOP-DIRNAME. If it returns non-nil, its value is saved along
-with the state of the buffer for which it was called.
+
+If the value is a function, it called by `desktop-save' with argument
+DESKTOP-DIRNAME to obtain auxiliary information to saved in the desktop
+file along with the state of the buffer for which it was called.
When file names are returned, they should be formatted using the call
\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
-to restore the buffer, the auxiliary information is passed as argument.")
-(make-variable-buffer-local 'desktop-buffer-misc-data-function)
+to restore the buffer, the auxiliary information is passed as the argument
+DESKTOP-BUFFER-MISC.")
+(make-variable-buffer-local 'desktop-save-buffer)
+(make-obsolete-variable 'desktop-buffer-modes-to-save
+ 'desktop-save-buffer)
(make-obsolete-variable 'desktop-buffer-misc-functions
- 'desktop-buffer-misc-data-function)
+ 'desktop-save-buffer)
-(defcustom desktop-buffer-mode-handlers '(
- (dired-mode . dired-restore-desktop-buffer)
- (rmail-mode . rmail-restore-desktop-buffer)
- (mh-folder-mode . mh-restore-desktop-buffer)
- (Info-mode . Info-restore-desktop-buffer))
+(defcustom desktop-buffer-mode-handlers
+ '((dired-mode . dired-restore-desktop-buffer)
+ (rmail-mode . rmail-restore-desktop-buffer)
+ (mh-folder-mode . mh-restore-desktop-buffer)
+ (Info-mode . Info-restore-desktop-buffer))
"Alist of major mode specific functions to restore a desktop buffer.
Functions are called by `desktop-read'. List elements must have the form
-\(MAJOR-MODE . FUNCTION).
+\(MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
Buffers with a major mode not specified here, are restored by the default
handler `desktop-restore-file-buffer'.
-Handlers are called with parameters
+Handlers are called with argument list
- desktop-buffer-file-name
- desktop-buffer-name
- desktop-buffer-misc
+ (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
Furthermore, they may use the following variables:
mode is active. RESTORE-FUNCTION is the function to activate the minor mode.
called. RESTORE-FUNCTION nil means don't try to restore the minor mode.
Only minor modes for which the name of the buffer-local variable
-and the name of the minor mode function are different have to added to
+and the name of the minor mode function are different have to be added to
this table."
:type 'sexp
:group 'desktop)
;; ----------------------------------------------------------------------------
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
- "Return t if the desktop should record a particular buffer for next startup.
+ "Return t if buffer should have its state saved in the desktop file.
FILENAME is the visited file name, BUFNAME is the buffer name, and
MODE is the major mode."
(let ((case-fold-search nil))
(and (not (string-match desktop-buffers-not-to-save bufname))
- (not (memq mode desktop-modes-not-to-save))
- (or (and filename
- (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 desktop-buffer-modes-to-save))))))
+ (not (memq mode desktop-modes-not-to-save))
+ (or (and filename
+ (not (string-match desktop-files-not-to-save filename)))
+ (and (eq mode 'dired-mode)
+ (with-current-buffer bufname
+ (not (string-match desktop-files-not-to-save
+ default-directory))))
+ (and (null filename)
+ (with-current-buffer bufname desktop-save-buffer))))))
;; ----------------------------------------------------------------------------
(defun desktop-file-name (filename dirname)
(let ((filename (expand-file-name desktop-base-file-name dirname))
(info
(mapcar
- (function
- (lambda (b)
+ #'(lambda (b)
(set-buffer b)
(list
(desktop-file-name (buffer-file-name) dirname)
major-mode
;; minor modes
(let (ret)
- (mapcar
- #'(lambda (mim)
+ (mapc
+ #'(lambda (minor-mode)
(and
- (boundp mim)
- (symbol-value mim)
- (setq ret
- (cons
- (let ((special (assq mim desktop-minor-mode-table)))
- (if special (cadr special) mim))
- ret))))
+ (boundp minor-mode)
+ (symbol-value minor-mode)
+ (let ((special (assq minor-mode desktop-minor-mode-table)))
+ (when (or special (functionp minor-mode))
+ (setq ret
+ (cons
+ (if special (cadr special) minor-mode)
+ ret))))))
(mapcar #'car minor-mode-alist))
ret)
(point)
(list (mark t) mark-active)
buffer-read-only
;; Auxiliary information
- (when desktop-buffer-misc-data-function
- (funcall desktop-buffer-misc-data-function dirname))
+ (when (functionp desktop-save-buffer)
+ (funcall desktop-save-buffer dirname))
(let ((locals desktop-locals-to-save)
(loclist (buffer-local-variables))
(ll))
(when (member (car locals) loclist)
(setq ll (cons (car locals) ll)))))
(setq locals (cdr locals)))
- ll))))
+ ll)))
(buffer-list)))
(buf (get-buffer-create "*desktop*")))
(set-buffer buf)
";; Desktop file format version " desktop-file-version "\n"
";; Emacs version " emacs-version "\n\n"
";; Global section:\n")
- (mapcar (function desktop-outvar) desktop-globals-to-save)
+ (mapc (function desktop-outvar) desktop-globals-to-save)
(if (memq 'kill-ring desktop-globals-to-save)
(insert
"(setq kill-ring-yank-pointer (nthcdr "
" kill-ring))\n"))
(insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
- (mapcar
- (function
- (lambda (l)
- (if (apply 'desktop-save-buffer-p l)
- (progn
- (insert "(desktop-create-buffer " desktop-file-version)
- (mapcar
- (function
- (lambda (e)
- (insert "\n " (desktop-value-to-string e))))
- l)
- (insert ")\n\n")))))
- info)
+ (mapc #'(lambda (l)
+ (if (apply 'desktop-save-buffer-p l)
+ (progn
+ (insert "(desktop-create-buffer " desktop-file-version)
+ (mapc #'(lambda (e)
+ (insert "\n " (desktop-value-to-string e)))
+ l)
+ (insert ")\n\n"))))
+ info)
(setq default-directory dirname)
(when (file-exists-p filename) (delete-file filename))
(let ((coding-system-for-write 'emacs-mule))
;; `desktop-create-buffer' puts buffers at end of the buffer list.
;; We want buffers existing prior to evaluating the desktop (and not reused)
;; to be placed at the end of the buffer list, so we move them here.
- (mapcar 'bury-buffer
- (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
+ (mapc 'bury-buffer
+ (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list))))))
(switch-to-buffer (car (buffer-list)))
(run-hooks 'desktop-delay-hook)
(setq desktop-delay-hook nil)
nil)))
;; ----------------------------------------------------------------------------
-;; Create a buffer, load its file, set is mode, ...; called from Desktop file
-;; only.
+;; Create a buffer, load its file, set its mode, ...;
+;; called from Desktop file only.
(eval-when-compile ; Just to silence the byte compiler
(defvar desktop-first-buffer) ;; Dynamically bound in `desktop-read'
)
-(defun desktop-create-buffer (
- desktop-file-version
- desktop-buffer-file-name
- desktop-buffer-name
- desktop-buffer-major-mode
- desktop-buffer-minor-modes
- desktop-buffer-point
- desktop-buffer-mark
- desktop-buffer-read-only
- desktop-buffer-misc
- &optional
- desktop-buffer-locals)
+(defun desktop-create-buffer
+ (desktop-file-version
+ desktop-buffer-file-name
+ desktop-buffer-name
+ desktop-buffer-major-mode
+ desktop-buffer-minor-modes
+ desktop-buffer-point
+ desktop-buffer-mark
+ desktop-buffer-read-only
+ desktop-buffer-misc
+ &optional
+ desktop-buffer-locals)
;; Just to silence the byte compiler. Bound locally in `desktop-read'.
(eval-when-compile
(defvar desktop-buffer-ok-count)
;; To make desktop files with relative file names possible, we cannot
;; allow `default-directory' to change. Therefore we save current buffer.
(save-current-buffer
- (let (
- (buffer-list (buffer-list))
- (result
- (condition-case err
- (funcall (or (cdr (assq desktop-buffer-major-mode desktop-buffer-mode-handlers))
- 'desktop-restore-file-buffer)
- desktop-buffer-file-name
- desktop-buffer-name
- desktop-buffer-misc)
- (error
- (message "Desktop: Can't load buffer %s: %s"
- desktop-buffer-name (error-message-string err))
- (when desktop-missing-file-warning (sit-for 1))
- nil)))
- )
+ (let ((buffer-list (buffer-list))
+ (result
+ (condition-case err
+ (funcall (or (cdr (assq desktop-buffer-major-mode
+ desktop-buffer-mode-handlers))
+ 'desktop-restore-file-buffer)
+ desktop-buffer-file-name
+ desktop-buffer-name
+ desktop-buffer-misc)
+ (error
+ (message "Desktop: Can't load buffer %s: %s"
+ desktop-buffer-name
+ (error-message-string err))
+ (when desktop-missing-file-warning (sit-for 1))
+ nil))))
(if (bufferp result)
(setq desktop-buffer-ok-count (1+ desktop-buffer-ok-count))
(setq desktop-buffer-fail-count (1+ desktop-buffer-fail-count))
(setq result nil))
- (unless (bufferp result) (setq result nil))
;; Restore buffer list order with new buffer at end. Don't change
;; the order for old desktop files (old desktop module behaviour).
(unless (< desktop-file-version 206)
- (mapcar 'bury-buffer buffer-list)
+ (mapc 'bury-buffer buffer-list)
(when result (bury-buffer result)))
(when result
(unless (or desktop-first-buffer (< desktop-file-version 206))
(unless (equal (buffer-name) desktop-buffer-name)
(rename-buffer desktop-buffer-name))
;; minor modes
- (cond (
- ;; backwards compatible
- (equal '(t) desktop-buffer-minor-modes)
- (auto-fill-mode 1))(
- (equal '(nil) desktop-buffer-minor-modes)
- (auto-fill-mode 0))(
- t
- (mapcar
- #'(lambda (minor-mode)
- (when (functionp minor-mode) (funcall minor-mode 1)))
- desktop-buffer-minor-modes)))
+ (cond ((equal '(t) desktop-buffer-minor-modes) ; backwards compatible
+ (auto-fill-mode 1))
+ ((equal '(nil) desktop-buffer-minor-modes) ; backwards compatible
+ (auto-fill-mode 0))
+ (t
+ (mapc #'(lambda (minor-mode)
+ (when (functionp minor-mode) (funcall minor-mode 1)))
+ desktop-buffer-minor-modes)))
;; Even though point and mark are non-nil when written by `desktop-save'
;; they may be modified by handlers wanting to set point or mark themselves.
(when desktop-buffer-point