comparison lisp/desktop.el @ 64490:e22e42dbaf76

(desktop-enable, desktop-buffer-modes-to-save, (desktop-buffer-misc-functions, desktop-buffer-handlers, desktop-load-default): Add release to obsolescence info. (desktop-globals-to-clear, desktop-buffer-mode-handlers, desktop-append-buffer-args, desktop-read): Fix typos in docstrings. (desktop-kill): Fix typo in message. (desktop-save): Doc fix.
author Juanma Barranquero <lekktu@gmail.com>
date Tue, 19 Jul 2005 09:52:55 +0000
parents f2bb50c9b2dd
children a9ca2e64f9c1
comparison
equal deleted inserted replaced
64489:86ac75fb6283 64490:e22e42dbaf76
105 :global t 105 :global t
106 :group 'desktop) 106 :group 'desktop)
107 107
108 ;; Maintained for backward compatibility 108 ;; Maintained for backward compatibility
109 (defvaralias 'desktop-enable 'desktop-save-mode) 109 (defvaralias 'desktop-enable 'desktop-save-mode)
110 (make-obsolete-variable 'desktop-enable 'desktop-save-mode) 110 (make-obsolete-variable 'desktop-enable 'desktop-save-mode "22.1")
111 111
112 (defcustom desktop-save 'ask-if-new 112 (defcustom desktop-save 'ask-if-new
113 "*Specifies whether the desktop should be saved when it is killed. 113 "*Specifies whether the desktop should be saved when it is killed.
114 A desktop is killed when the user changes desktop or quits Emacs. 114 A desktop is killed when the user changes desktop or quits Emacs.
115 Possible values are: 115 Possible values are:
118 ask-if-new -- ask if no desktop file exists, otherwise just save. 118 ask-if-new -- ask if no desktop file exists, otherwise just save.
119 ask-if-exists -- ask if desktop file exists, otherwise don't save. 119 ask-if-exists -- ask if desktop file exists, otherwise don't save.
120 if-exists -- save if desktop file exists, otherwise don't save. 120 if-exists -- save if desktop file exists, otherwise don't save.
121 nil -- never save. 121 nil -- never save.
122 The desktop is never saved when `desktop-save-mode' is nil. 122 The desktop is never saved when `desktop-save-mode' is nil.
123 The variables `desktop-directory' and `desktop-base-file-name' 123 The variables `desktop-dirname' and `desktop-base-file-name'
124 determine where the desktop is saved." 124 determine where the desktop is saved."
125 :type '(choice 125 :type '(choice
126 (const :tag "Always save" t) 126 (const :tag "Always save" t)
127 (const :tag "Always ask" ask) 127 (const :tag "Always ask" ask)
128 (const :tag "Ask if desktop file is new, else do save" ask-if-new) 128 (const :tag "Ask if desktop file is new, else do save" ask-if-new)
198 search-ring-yank-pointer 198 search-ring-yank-pointer
199 regexp-search-ring 199 regexp-search-ring
200 regexp-search-ring-yank-pointer) 200 regexp-search-ring-yank-pointer)
201 "List of global variables that `desktop-clear' will clear. 201 "List of global variables that `desktop-clear' will clear.
202 An element may be variable name (a symbol) or a cons cell of the form 202 An element may be variable name (a symbol) or a cons cell of the form
203 \(VAR . FORM). Symbols are set to nil and for cons cells VAR is set 203 \(VAR . FORM). Symbols are set to nil and for cons cells VAR is set
204 to the value obtained by evaluateing FORM." 204 to the value obtained by evaluating FORM."
205 :type '(repeat (restricted-sexp :match-alternatives (symbolp consp))) 205 :type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
206 :group 'desktop 206 :group 'desktop
207 :version "22.1") 207 :version "22.1")
208 208
209 (defcustom desktop-clear-preserve-buffers-regexp 209 (defcustom desktop-clear-preserve-buffers-regexp
303 Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers' 303 Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
304 to restore the buffer, the auxiliary information is passed as the argument 304 to restore the buffer, the auxiliary information is passed as the argument
305 DESKTOP-BUFFER-MISC.") 305 DESKTOP-BUFFER-MISC.")
306 (make-variable-buffer-local 'desktop-save-buffer) 306 (make-variable-buffer-local 'desktop-save-buffer)
307 (make-obsolete-variable 'desktop-buffer-modes-to-save 307 (make-obsolete-variable 'desktop-buffer-modes-to-save
308 'desktop-save-buffer) 308 'desktop-save-buffer "22.1")
309 (make-obsolete-variable 'desktop-buffer-misc-functions 309 (make-obsolete-variable 'desktop-buffer-misc-functions
310 'desktop-save-buffer) 310 'desktop-save-buffer "22.1")
311 311
312 (defcustom desktop-buffer-mode-handlers 312 (defcustom desktop-buffer-mode-handlers
313 '((dired-mode . dired-restore-desktop-buffer) 313 '((dired-mode . dired-restore-desktop-buffer)
314 (rmail-mode . rmail-restore-desktop-buffer) 314 (rmail-mode . rmail-restore-desktop-buffer)
315 (mh-folder-mode . mh-restore-desktop-buffer) 315 (mh-folder-mode . mh-restore-desktop-buffer)
316 (Info-mode . Info-restore-desktop-buffer)) 316 (Info-mode . Info-restore-desktop-buffer))
317 "Alist of major mode specific functions to restore a desktop buffer. 317 "Alist of major mode specific functions to restore a desktop buffer.
318 Functions are called by `desktop-read'. List elements must have the form 318 Functions are called by `desktop-read'. List elements must have the form
319 \(MAJOR-MODE . RESTORE-BUFFER-FUNCTION). 319 \(MAJOR-MODE . RESTORE-BUFFER-FUNCTION).
320 320
321 Buffers with a major mode not specified here, are restored by the default 321 Buffers with a major mode not specified here, are restored by the default
322 handler `desktop-restore-file-buffer'. 322 handler `desktop-restore-file-buffer'.
323 323
340 :type 'alist 340 :type 'alist
341 :group 'desktop) 341 :group 'desktop)
342 342
343 (put 'desktop-buffer-mode-handlers 'risky-local-variable t) 343 (put 'desktop-buffer-mode-handlers 'risky-local-variable t)
344 (make-obsolete-variable 'desktop-buffer-handlers 344 (make-obsolete-variable 'desktop-buffer-handlers
345 'desktop-buffer-mode-handlers) 345 'desktop-buffer-mode-handlers "22.1")
346 346
347 (defcustom desktop-minor-mode-table 347 (defcustom desktop-minor-mode-table
348 '((auto-fill-function auto-fill-mode) 348 '((auto-fill-function auto-fill-mode)
349 (vc-mode nil)) 349 (vc-mode nil))
350 "Table mapping minor mode variables to minor mode functions. 350 "Table mapping minor mode variables to minor mode functions.
430 (call-interactively 430 (call-interactively
431 (lambda (dir) (interactive "DDirectory for desktop file: ") dir)))))) 431 (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
432 (condition-case err 432 (condition-case err
433 (desktop-save desktop-dirname) 433 (desktop-save desktop-dirname)
434 (file-error 434 (file-error
435 (unless (yes-or-no-p "Error while saving the desktop. Ignore? ") 435 (unless (yes-or-no-p "Error while saving the desktop. Ignore? ")
436 (signal (car err) (cdr err))))))) 436 (signal (car err) (cdr err)))))))
437 437
438 ;; ---------------------------------------------------------------------------- 438 ;; ----------------------------------------------------------------------------
439 (defun desktop-list* (&rest args) 439 (defun desktop-list* (&rest args)
440 (if (null (cdr args)) 440 (if (null (cdr args))
709 ;;;###autoload 709 ;;;###autoload
710 (defun desktop-read (&optional dirname) 710 (defun desktop-read (&optional dirname)
711 "Read and process the desktop file in directory DIRNAME. 711 "Read and process the desktop file in directory DIRNAME.
712 Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in 712 Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in
713 directories listed in `desktop-path'. If a desktop file is found, it 713 directories listed in `desktop-path'. If a desktop file is found, it
714 is processed and `desktop-after-read-hook' is run. If no desktop file 714 is processed and `desktop-after-read-hook' is run. If no desktop file
715 is found, clear the desktop and run `desktop-no-desktop-file-hook'. 715 is found, clear the desktop and run `desktop-no-desktop-file-hook'.
716 This function is a no-op when Emacs is running in batch mode. 716 This function is a no-op when Emacs is running in batch mode.
717 It returns t if a desktop file was loaded, nil otherwise." 717 It returns t if a desktop file was loaded, nil otherwise."
718 (interactive) 718 (interactive)
719 (unless noninteractive 719 (unless noninteractive
779 Also inhibit further loading of it." 779 Also inhibit further loading of it."
780 (if (not inhibit-default-init) ; safety check 780 (if (not inhibit-default-init) ; safety check
781 (progn 781 (progn
782 (load "default" t t) 782 (load "default" t t)
783 (setq inhibit-default-init t)))) 783 (setq inhibit-default-init t))))
784 (make-obsolete 'desktop-load-default 'desktop-save-mode) 784 (make-obsolete 'desktop-load-default 'desktop-save-mode "22.1")
785 785
786 ;; ---------------------------------------------------------------------------- 786 ;; ----------------------------------------------------------------------------
787 ;;;###autoload 787 ;;;###autoload
788 (defun desktop-change-dir (dirname) 788 (defun desktop-change-dir (dirname)
789 "Change to desktop saved in DIRNAME. 789 "Change to desktop saved in DIRNAME.
956 (cons 'case-fold-search cfs) 956 (cons 'case-fold-search cfs)
957 (cons 'case-replace cr) 957 (cons 'case-replace cr)
958 (cons 'overwrite-mode (car mim))))) 958 (cons 'overwrite-mode (car mim)))))
959 959
960 (defun desktop-append-buffer-args (&rest args) 960 (defun desktop-append-buffer-args (&rest args)
961 "Append ARGS at end of `desktop-buffer-args-list' 961 "Append ARGS at end of `desktop-buffer-args-list'.
962 ARGS must be an argument list for `desktop-create-buffer'." 962 ARGS must be an argument list for `desktop-create-buffer'."
963 (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args))) 963 (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args)))
964 (unless desktop-lazy-timer 964 (unless desktop-lazy-timer
965 (setq desktop-lazy-timer 965 (setq desktop-lazy-timer
966 (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers)))) 966 (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers))))