emacs: lisp/desktop.el comparison

comparison lisp/desktop.el @ 50507:110c0e29159c

Handle multiple desktop files in different dirs. Other cleanups. Command line option --no-desktop introduced. (desktop-read): Record buffers in the desktop file in the same order as that in the buffer list, (desktop-save): Put buffers in the order given in desktop file, regardless of what handlers do. (desktop-file-version): New variable. Version number of desktop file format. (desktop-create-buffer-form): Variable deleted. (desktop-save): New customizable variable. (desktop-kill): Changed to use `desktop-save'. (desktop-file-name-format): New option: format in which desktop file names should be saved. (desktop-file-name): New function to convert a filename to the format specified in `desktop-file-name-format'. (desktop-create-buffer): Parameters renamed to descriptive systematic names. These parameters are visible to handlers. Renames: ver -> desktop-file-version mim -> desktop-buffer-minor-modes pt -> desktop-buffer-point mk -> desktop-buffer-mark ro -> desktop-buffer-read-only locals -> desktop-buffer-locals (desktop-buffer-major-mode, desktop-buffer-file-name) (desktop-buffer-name): Unused customizable variables deleted. (desktop-buffer-misc): Unused variable deleted. (desktop-save, desktop-buffer-dired-misc-data): Use `desktop-file-name'. (desktop-path): New customizable variable. List of directories in which to lookup the desktop file. Replaces hardcoded list. (desktop-globals-to-clear): New variable replaces hardcoded list. (desktop-clear-preserve-buffers-regexp): New customizable variable. (desktop-after-read-hook): New hook run after a desktop is read. (desktop-no-desktop-file-hook): New hook when no desktop file found. (desktop-change-dir): New function. (desktop-save-in-load-dir): New function. Save desktop in directory from witch it was loaded. (desktop-revert): New function. Revert to the last loaded desktop.

author	Richard M. Stallman <rms@gnu.org>
date	Wed, 09 Apr 2003 01:37:56 +0000
parents	8c7919f99581
children	4737239e4dad

comparison

equal deleted inserted replaced

-:6cc9a6c84a94
+:110c0e29159c
 ;; TODO:
 ;;
 ;; Save window configuration.
 ;; Recognize more minor modes.
 ;; Save mark rings.
-;; Start-up with buffer-menu???
 ;;; Code:
 ;; Make the compilation more silent
 (eval-when-compile
 ;; We use functions from these modules
 ;; We can't (require 'mh-e) since that wants to load something.
 (mapcar 'require '(info dired reporter)))
+(defvar desktop-file-version "206"
+"Verion number of desktop file format.
+Written into the desktop file and used at desktop read to provide
+backward compatibility.")
 ;; ----------------------------------------------------------------------------
 ;; USER OPTIONS -- settings you might want to play with.
 ;; ----------------------------------------------------------------------------
 (defgroup desktop nil
 :type 'boolean
 :require 'desktop
 :initialize 'custom-initialize-default
 :version "20.3")
-(defcustom desktop-basefilename
+(defcustom desktop-save 'ask-if-new
+"*When the user changes desktop or quits emacs, should the desktop be saved?
+\(in the current desktop directory)
+t             -- always save.
+ask           -- always ask.
+ask-if-new    -- ask if no desktop file exists, otherwise just save.
+ask-if-exists -- ask if desktop file exists, otherwise don't save.
+if-exists     -- save if desktop file exists, otherwise don't save.
+nil           -- never save.
+The desktop is never saved when `desktop-enable' is nil."
+:type '(choice
+(const :tag "Always save" t)
+(const :tag "Always ask" ask)
+(const :tag "Ask if desktop file is new, else do save" ask-if-new)
+(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)
+(defcustom desktop-base-file-name
 (convert-standard-filename ".emacs.desktop")
 "File for Emacs desktop, not including the directory name."
 :type 'file
+:group 'desktop)
+(defcustom desktop-path '("." "~")
+"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)
 (defcustom desktop-missing-file-warning nil
 "*If non-nil then desktop warns when a file no longer exists.
 Otherwise it simply ignores that file."
 :type 'boolean
 :group 'desktop)
-(defvar desktop-globals-to-save
+(defcustom desktop-no-desktop-file-hook nil
-(list 'desktop-missing-file-warning
+"Normal hook run after fail of `desktop-read' due to missing desktop file.
-	;; Feature: saving kill-ring implies saving kill-ring-yank-pointer
+May e.g. be used to show a dired buffer."
-	;; 'kill-ring
+:type 'hook
-	'tags-file-name
+:group 'desktop)
-	'tags-table-list
-	'search-ring
+(defcustom desktop-after-read-hook nil
-	'regexp-search-ring
+"Normal hook run after a sucessful `desktop-read'.
-	'register-alist
+May e.g. be used to show a buffer list."
-	;; 'desktop-globals-to-save	; Itself!
+:type 'hook
-	)
+:group 'desktop)
+(defcustom desktop-save-hook nil
+"Hook run before desktop saves the state of Emacs.
+This is useful for truncating history lists, for example."
+: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)
 "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.")
+\(if the value is a list) before saving the value.
+Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
-(defvar desktop-locals-to-save
+:type '(repeat (restricted-sexp :match-alternatives (symbolp consp)))
-(list 'desktop-locals-to-save		; Itself!  Think it over.
+:group 'desktop)
-'truncate-lines
-	'case-fold-search
+(defcustom desktop-globals-to-clear '(
-	'case-replace
+kill-ring
-	'fill-column
+kill-ring-yank-pointer
-	'overwrite-mode
+search-ring
-	'change-log-default-name
+search-ring-yank-pointer
-	'line-number-mode
+regexp-search-ring
-	)
+regexp-search-ring-yank-pointer)
+"List of global variables set 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)
+(defcustom desktop-clear-preserve-buffers-regexp
+"^\\*tramp/.+\\*$"
+"Regexp identifying buffers that `desktop-clear' should not delete."
+:type 'regexp
+:group 'desktop)
+;; Maintained for backward compatibility
+(defcustom desktop-clear-preserve-buffers
+'("*scratch*" "*Messages*")
+"*List of buffer names that `desktop-clear' should not delete."
+:type '(repeat string)
+:group 'desktop)
+(defvar 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)
 "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 whatnot.
 ;;         TAGS files to save time (tags-file-name is saved instead).
 (defcustom desktop-buffers-not-to-save
 "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
 "Regexp identifying buffers that are to be excluded from saving."
 :type 'regexp
 :group 'desktop)
 ;; Skip ange-ftp files
 (defcustom desktop-files-not-to-save
 "^/[^/:]*:"
 "Regexp identifying files whose buffers are to be excluded from saving."
 (defcustom desktop-modes-not-to-save nil
 "List of major modes whose buffers should not be saved."
 :type '(repeat symbol)
 :group 'desktop)
-(defcustom desktop-buffer-major-mode nil
+(defcustom desktop-file-name-format 'absolute
-"When desktop creates a buffer, this holds the desired Major mode."
+"*Format in which desktop file names should be saved.
-:type 'symbol
+Possible values are:
-:group 'desktop)
+absolute -- Absolute file name.
+tilde    -- Relative to ~.
-(defcustom desktop-buffer-file-name nil
+local    -- Relative to directory of desktop file."
-"When desktop creates a buffer, this holds the file name to visit."
+:type '(choice (const absolute) (const tilde) (const local))
-:type '(choice file (const nil))
+:group 'desktop)
-:group 'desktop)
-(defcustom desktop-buffer-name nil
-"When desktop creates a buffer, this holds the desired buffer name."
-:type '(choice string (const nil))
-:group 'desktop)
-(defvar desktop-buffer-misc nil
-"When desktop creates a buffer, this holds a list of misc info.
-It is used by the `desktop-buffer-handlers' functions.")
 (defcustom desktop-buffer-misc-functions
 '(desktop-buffer-info-misc-data
 desktop-buffer-dired-misc-data)
 "*Functions used to determine auxiliary information for a buffer.
 These functions are called in order, with no arguments.  If a function
 returns non-nil, its value is saved along with the desktop buffer for
 which it was called; no further functions will be called.
+File names should formatted using the call
+\"(desktop-file-name FILE-NAME dirname)\".
 Later, when desktop.el restores the buffers it has saved, each of the
 `desktop-buffer-handlers' functions will have access to a buffer local
 variable, named `desktop-buffer-misc', whose value is what the
 \"misc\" function returned previously."
 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 can use the
-variables `desktop-buffer-major-mode', `desktop-buffer-file-name',
+following variables:
-`desktop-buffer-name'.
+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
+desktop-buffer-locals
 If one function returns non-nil, no further functions are called.
 If the function returns a buffer, then the saved mode settings
 and variable values for that buffer are copied into it."
 :type '(repeat function)
 :group 'desktop)
 (put 'desktop-buffer-handlers 'risky-local-variable t)
-(defvar desktop-create-buffer-form "(desktop-create-buffer 205"
-"Opening of form for creation of new buffers.")
-(defcustom desktop-save-hook nil
-"Hook run before desktop saves the state of Emacs.
-This is useful for truncating history lists, for example."
-:type 'hook
-:group 'desktop)
 (defcustom desktop-minor-mode-table
 '((auto-fill-function auto-fill-mode)
 (vc-mode nil))
 "Table mapping minor mode variables to minor mode functions.
 (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))))
-;; ----------------------------------------------------------------------------
-(defcustom desktop-clear-preserve-buffers
+;; ----------------------------------------------------------------------------
-'("*scratch*" "*Messages*")
-"*Buffer names that `desktop-clear' should not delete."
-:type '(repeat string)
-:group 'desktop)
 (defun desktop-clear ()
 "Empty the Desktop.
-This kills all buffers except for internal ones
+This kills all buffers except for internal ones and those listed
-and those listed in `desktop-clear-preserve-buffers'."
+in `desktop-clear-preserve-buffers'.  Furthermore, it clears the
+variables listed in `desktop-globals-to-clear'."
 (interactive)
-(setq kill-ring nil
+(dolist (var desktop-globals-to-clear)
-	kill-ring-yank-pointer nil
+(if (symbolp var)
-	search-ring nil
+(eval `(setq-default ,var nil))
-	search-ring-yank-pointer nil
+(eval `(setq-default ,(car var) ,(cdr var)))))
-	regexp-search-ring nil
-	regexp-search-ring-yank-pointer nil)
 (let ((buffers (buffer-list)))
 (while buffers
-(or (member (buffer-name (car buffers)) desktop-clear-preserve-buffers)
+(let ((bufname (buffer-name (car buffers))))
-	  (null (buffer-name (car buffers)))
+(or
-	  ;; Don't kill buffers made for internal purposes.
+(null bufname)
-	  (and (not (equal (buffer-name (car buffers)) ""))
+(string-match desktop-clear-preserve-buffers-regexp bufname)
-	       (eq (aref (buffer-name (car buffers)) 0) ?\ ))
+(member bufname desktop-clear-preserve-buffers)
-	  (kill-buffer (car buffers)))
+;; Don't kill buffers made for internal purposes.
+(and (not (equal bufname "")) (eq (aref bufname 0) ?\ ))
+(kill-buffer (car buffers))))
 (setq buffers (cdr buffers))))
 (delete-other-windows))
 ;; ----------------------------------------------------------------------------
 (add-hook 'kill-emacs-hook 'desktop-kill)
 (defun desktop-kill ()
-(if desktop-dirname
+"If `desktop-enable' is non-nil, do what `desktop-save' says to do.
-(condition-case err
+If the desktop should be saved and `desktop-dirname'
-	  (desktop-save desktop-dirname)
+is nil, ask the user where to save the desktop."
-	(file-error
+(when
-	 (if (yes-or-no-p "Error while saving the desktop.  Quit anyway? ")
+(and
-	     nil
+desktop-enable
-	   (signal (car err) (cdr err)))))))
+(let ((exists (file-exists-p (concat desktop-dirname desktop-base-file-name))))
+(or
+(eq desktop-save 't)
+(and exists (memq desktop-save '(ask-if-new if-exists)))
+(and
+(or
+(memq desktop-save '(ask ask-if-new))
+(and exists (eq desktop-save 'ask-if-exists)))
+(y-or-n-p "Save desktop? ")))))
+(unless desktop-dirname
+(setq desktop-dirname
+(expand-file-name
+(call-interactively
+(lambda (dir) (interactive "DDirectory for desktop file: ") dir)))))
+(condition-case err
+(desktop-save desktop-dirname)
+(file-error
+(unless (yes-or-no-p "Error while saving the desktop. Ignore? ")
+(signal (car err) (cdr err)))))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-list* (&rest args)
 (if (null (cdr args))
 (car args)
 (setq args (nreverse args))
 (while args
 	(setq value (cons (car args) value))
 	(setq args (cdr args)))
 value)))
+;; ----------------------------------------------------------------------------
 (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)."
 			" (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)
 "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 (car quote.txt))
 	 (txt (cdr quote.txt)))
 (if (eq quote 'must)
 	(concat "'" txt)
 txt)))
 ;; ----------------------------------------------------------------------------
 (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),
 	  (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."
 		    (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))))))
-;; ----------------------------------------------------------------------------
-(defcustom desktop-relative-file-names nil
+;; ----------------------------------------------------------------------------
-"*Store relative file names in the desktop file."
+(defun desktop-file-name (filename dirname)
-:type 'boolean
+"Convert FILENAME to format specified in `desktop-file-name-format'.
-:group 'desktop)
+DIRNAME must be the directory in which the desktop file will be saved."
+(cond
+((not filename) nil)
+((eq desktop-file-name-format 'tilde)
+(let ((relative-name (file-relative-name (expand-file-name filename) "~")))
+(cond
+((file-name-absolute-p relative-name) relative-name)
+((string= "./" relative-name) "~/")
+((string= "." relative-name) "~")
+(t (concat "~/" relative-name)))))
+((eq desktop-file-name-format 'local) (file-relative-name filename dirname))
+(t (expand-file-name filename))))
+;; ----------------------------------------------------------------------------
 (defun desktop-save (dirname)
-"Save the Desktop file.  Parameter DIRNAME specifies where to save desktop."
+"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 desktop-basefilename dirname))
+(let ((filename (expand-file-name desktop-base-file-name dirname))
-	  (info (nreverse
+(info
-		 (mapcar
+(mapcar
-		  (function
+(function
-		   (lambda (b)
+(lambda (b)
 (set-buffer b)
 (list
-(let ((bn (buffer-file-name)))
+(desktop-file-name (buffer-file-name) dirname)
-(if bn
+(buffer-name)
-(if desktop-relative-file-names
+major-mode
-(file-relative-name bn dirname)
+;; minor modes
-bn)))
+(let (ret)
-(buffer-name)
+(mapcar
-major-mode
+#'(lambda (mim)
-;; minor modes
+(and
-(let (ret)
+(boundp mim)
-(mapcar
+(symbol-value mim)
-#'(lambda (mim)
+(setq
-(and (boundp mim)
+ret
-(symbol-value mim)
+(cons
-(setq ret
+(let (
-(cons (let ((special (assq mim desktop-minor-mode-table)))
+(special (assq mim desktop-minor-mode-table))
-(if special
+)
-(cadr special)
+(if special (cadr special) mim))
-mim))
+ret))))
-ret))))
+(mapcar #'car minor-mode-alist))
-(mapcar #'car minor-mode-alist))
+ret)
-ret)
+(point)
-(point)
+(list (mark t) mark-active)
-(list (mark t) mark-active)
+buffer-read-only
-buffer-read-only
+(run-hook-with-args-until-success 'desktop-buffer-misc-functions)
-(run-hook-with-args-until-success
+(let (
-'desktop-buffer-misc-functions)
+(locals desktop-locals-to-save)
-(let ((locals desktop-locals-to-save)
+(loclist (buffer-local-variables))
-(loclist (buffer-local-variables))
+(ll)
-(ll))
+)
 (while locals
 (let ((here (assq (car locals) loclist)))
 (if here
 (setq ll (cons here ll))
-(if (member (car locals) loclist)
+(when (member (car locals) loclist)
 (setq ll (cons (car locals) ll)))))
 (setq locals (cdr locals)))
-ll)
+ll))))
-)))
+(buffer-list)))
-		  (buffer-list))))
+(buf (get-buffer-create "*desktop*")))
-	  (buf (get-buffer-create "*desktop*")))
 (set-buffer buf)
 (erase-buffer)
-(insert ";; -*- coding: emacs-mule; -*-\n"
+(insert
-	      desktop-header
+";; -*- coding: emacs-mule; -*-\n"
-	      ";; Created " (current-time-string) "\n"
+desktop-header
-	      ";; Emacs version " emacs-version "\n\n"
+";; Created " (current-time-string) "\n"
-	      ";; Global section:\n")
+";; 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)
 (if (memq 'kill-ring desktop-globals-to-save)
-	  (insert "(setq kill-ring-yank-pointer (nthcdr "
+(insert
-		  (int-to-string
+"(setq kill-ring-yank-pointer (nthcdr "
-		   (- (length kill-ring) (length kill-ring-yank-pointer)))
+(int-to-string (- (length kill-ring) (length kill-ring-yank-pointer)))
-		  " kill-ring))\n"))
+" kill-ring))\n"))
-(insert "\n;; Buffer section:\n")
+(insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
 (mapcar
-(function (lambda (l)
+(function
-(if (apply 'desktop-save-buffer-p l)
+(lambda (l)
-(progn
+(if (apply 'desktop-save-buffer-p l)
-(insert desktop-create-buffer-form)
+(progn
-(mapcar
+(insert "(desktop-create-buffer " desktop-file-version)
-(function (lambda (e)
+(mapcar
-(insert "\n  "
+(function
-(desktop-value-to-string e))))
+(lambda (e)
-l)
+(insert "\n  " (desktop-value-to-string e))))
-(insert ")\n\n")))))
+l)
-info)
+(insert ")\n\n")))))
+info)
 (setq default-directory dirname)
-(if (file-exists-p filename) (delete-file filename))
+(when (file-exists-p filename) (delete-file filename))
 (let ((coding-system-for-write 'emacs-mule))
-	(write-region (point-min) (point-max) filename nil 'nomessage))))
+(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)
 (if desktop-dirname
-(let ((filename (concat desktop-dirname desktop-basefilename)))
+(let ((filename (concat desktop-dirname desktop-base-file-name)))
 	(setq desktop-dirname nil)
 	(if (file-exists-p filename)
 	    (delete-file filename)))))
 ;; ----------------------------------------------------------------------------
 ;;;###autoload
 (defun desktop-read ()
 "Read the Desktop file and the files it specifies.
-This is a no-op when Emacs is running in batch mode."
+This is a no-op when Emacs is running in batch mode.
+Look for the desktop file according to the variables `desktop-base-file-name'
+and `desktop-path'.  If no desktop file is found, clear the desktop.
+Returns t if it has read a desktop file, nil otherwise."
 (interactive)
-(if noninteractive
+(unless noninteractive
-nil
+(let ((dirs desktop-path))
-(let ((dirs '("./" "~/")))
+(while
-(while (and dirs
+(and
-		  (not (file-exists-p (expand-file-name
+dirs
-				       desktop-basefilename
+(not
-				       (car dirs)))))
+(file-exists-p (expand-file-name desktop-base-file-name (car dirs)))))
-	(setq dirs (cdr dirs)))
+(setq dirs (cdr dirs)))
 (setq desktop-dirname (and dirs (expand-file-name (car dirs))))
 (if desktop-dirname
-	  (let ((desktop-last-buffer nil))
+(let ((desktop-first-buffer nil))
-	    ;; `load-with-code-conversion' calls `eval-buffer' which
+;; `desktop-create-buffer' sets `desktop-first-buffer' to the first
-	    ;; contains a `save-excursion', so we end up with the same
+;; buffer in the desktop file (the last for desktop files written
-	    ;; buffer before and after the load.  This is a problem
+;; by desktop version prior to 206).
-	    ;; when the desktop is read initially when Emacs starts up
+(load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
-	    ;; because, if we still are in *scratch* after running
+(when desktop-first-buffer (switch-to-buffer desktop-first-buffer))
-	    ;; `after-init-hook', the splash screen will be displayed.
+(run-hooks 'desktop-delay-hook)
-	    (load (expand-file-name desktop-basefilename desktop-dirname)
+(setq desktop-delay-hook nil)
-		  t t t)
+(run-hooks 'desktop-after-read-hook)
-	    (when desktop-last-buffer
+(message "Desktop loaded.")
-	      (switch-to-buffer desktop-last-buffer))
+t)
-	    (run-hooks 'desktop-delay-hook)
+(desktop-clear)
-	    (setq desktop-delay-hook nil)
+(run-hooks 'desktop-no-desktop-file-hook)
-	    (message "Desktop loaded."))
+(message "No desktop file.")
-	(desktop-clear)))))
+nil))))
 ;; ----------------------------------------------------------------------------
 ;;;###autoload
 (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."
 (if (not inhibit-default-init)	; safety check
 (progn
 	(load "default" t t)
 	(setq inhibit-default-init t))))
+;; ----------------------------------------------------------------------------
+;;;###autoload
+(defun desktop-change-dir (dir)
+"Save and clear the desktop, then load the desktop from directory DIR.
+However, if `desktop-enable' was nil at call, don't save the old desktop.
+This function always sets `desktop-enable' to t."
+(interactive "DNew directory: ")
+(desktop-kill)
+(desktop-clear)
+(cd dir)
+(setq desktop-enable t)
+(let ((desktop-path '(".")))
+(desktop-read)
+;; Set `desktop-dirname' even in no desktop file was found
+(setq desktop-dirname (expand-file-name dir))))
+;; ----------------------------------------------------------------------------
+;;;###autoload
+(defun desktop-save-in-load-dir ()
+"Save desktop in directory from which it was loaded."
+(interactive)
+(if desktop-dirname
+(desktop-save desktop-dirname)
+(call-interactively 'desktop-save))
+(message "Desktop saved in %s" desktop-dirname))
+;; ----------------------------------------------------------------------------
+;;;###autoload
+(defun desktop-revert ()
+"Revert to the last loaded desktop."
+(interactive)
+(unless desktop-dirname (error "No desktop has been loaded"))
+(setq desktop-enable nil)
+(desktop-change-dir desktop-dirname))
 ;; ----------------------------------------------------------------------------
 ;; Note: the following functions use the dynamic variable binding in Lisp.
 ;;
+(eval-when-compile ; Just to silence the byte compiler
+(defvar desktop-file-version)
+(defvar desktop-buffer-file-name)
+(defvar desktop-buffer-name)
+(defvar desktop-buffer-major-mode)
+(defvar desktop-buffer-minor-modes)
+(defvar desktop-buffer-point)
+(defvar desktop-buffer-mark)
+(defvar desktop-buffer-read-only)
+(defvar desktop-buffer-misc)
+(defvar desktop-buffer-locals)
+)
 (defun desktop-buffer-info-misc-data ()
 (if (eq major-mode 'Info-mode)
 (list Info-current-file
 Info-current-node)))
+;; ----------------------------------------------------------------------------
 (defun desktop-buffer-dired-misc-data ()
-(if (eq major-mode 'dired-mode)
+(when (eq major-mode 'dired-mode)
-(cons
+(eval-when-compile (defvar dirname))
-(expand-file-name dired-directory)
+(cons
-(cdr
+;; dired directory in portable form
-(nreverse
+(file-name-as-directory (desktop-file-name dired-directory dirname))
-(mapcar
+(cdr (nreverse (mapcar (function car) dired-subdir-alist))))))
-(function car)
-dired-subdir-alist))))))
+;; ----------------------------------------------------------------------------
 (defun desktop-buffer-info () "Load an info file."
 (if (eq 'Info-mode desktop-buffer-major-mode)
 (progn
 	(let ((first (nth 0 desktop-buffer-misc))
 	      (second (nth 1 desktop-buffer-misc)))
 	(when (and first second)
 	  (require 'info)
 	  (Info-find-node first second)
 	  (current-buffer))))))
-;; ----------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
+(eval-when-compile (defvar rmail-buffer)) ; Just to silence the byte compiler.
 (defun desktop-buffer-rmail () "Load an RMAIL file."
 (if (eq 'rmail-mode desktop-buffer-major-mode)
 (condition-case error
 	  (progn (rmail-input desktop-buffer-file-name)
 (if (eq major-mode 'rmail-mode)
 (current-buffer)
 rmail-buffer))
 	(file-locked
 	 (kill-buffer (current-buffer))
 	 'ignored))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-mh () "Load a folder in the mh system."
 (if (eq 'mh-folder-mode desktop-buffer-major-mode)
 (progn
-	(require 'mh-e)
+(eval-and-compile (require 'mh-e))
 	(mh-find-path)
 (mh-visit-folder desktop-buffer-name)
 	(current-buffer))))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-dired () "Load a directory using dired."
 (if (eq 'dired-mode desktop-buffer-major-mode)
 (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
 	  (progn
 	    (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
 	    (current-buffer))
 	(message "Directory %s no longer exists." (car desktop-buffer-misc))
 	(sit-for 1)
 	'ignored)))
 ;; ----------------------------------------------------------------------------
 (defun desktop-buffer-file () "Load a file."
 (if desktop-buffer-file-name
 (if (or (file-exists-p desktop-buffer-file-name)
 	      (and desktop-missing-file-warning
 	    (condition-case nil
 		(switch-to-buffer buf)
 	      (error (pop-to-buffer buf)))
 	    buf)
 	'ignored)))
 ;; ----------------------------------------------------------------------------
 ;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
 ;; only.
-(defvar desktop-last-buffer nil
+(eval-when-compile ; Just to silence the byte compiler
-"Last buffer read.  Dynamically bound in `desktop-read'.")
+(defvar desktop-first-buffer) ;; Dynamically bound in `desktop-read'
+)
-(defun desktop-create-buffer (ver desktop-buffer-file-name desktop-buffer-name
-				  desktop-buffer-major-mode
+(defun desktop-create-buffer (
-				  mim pt mk ro desktop-buffer-misc
+desktop-file-version
-				  &optional locals)
+desktop-buffer-file-name
-(let ((hlist desktop-buffer-handlers)
+desktop-buffer-name
-	(result)
+desktop-buffer-major-mode
-	(handler))
+desktop-buffer-minor-modes
-(while (and (not result) hlist)
+desktop-buffer-point
-(setq handler (car hlist))
+desktop-buffer-mark
-(setq result (funcall handler))
+desktop-buffer-read-only
-(setq hlist (cdr hlist)))
+desktop-buffer-misc
-(when (bufferp result)
+&optional
-(setq desktop-last-buffer result)
+desktop-buffer-locals)
-(set-buffer result)
+;; To make desktop files with relative file names possible, we cannot
-(if (not (equal (buffer-name) desktop-buffer-name))
+;; allow `default-directory' to change. Therefore we save current buffer.
-	  (rename-buffer desktop-buffer-name))
+(save-current-buffer
-;; minor modes
+(let (
-(cond ((equal '(t) mim)   (auto-fill-mode 1))	; backwards compatible
+(buffer-list (buffer-list))
-	    ((equal '(nil) mim) (auto-fill-mode 0))
+(hlist desktop-buffer-handlers)
-	    (t (mapcar #'(lambda (minor-mode)
+(result)
-			   (when (functionp minor-mode)
+(handler)
-			     (funcall minor-mode 1)))
+)
-		       mim)))
+;; Call desktop-buffer-handlers to create buffer.
-(goto-char pt)
+(while (and (not result) hlist)
-(if (consp mk)
+(setq handler (car hlist))
-	  (progn
+(setq result (funcall handler))
-	    (set-mark (car mk))
+(setq hlist (cdr hlist)))
-	    (setq mark-active (car (cdr mk))))
+(unless (bufferp result) (setq result nil))
-	(set-mark mk))
+(unless (< desktop-file-version 206)
-;; Never override file system if the file really is read-only marked.
+(when result (setq buffer-list (cons result buffer-list)))
-(if ro (setq buffer-read-only ro))
+(mapcar 'bury-buffer buffer-list))
-(while locals
+(when result
-	(let ((this (car locals)))
+(if (< desktop-file-version 206)
-	  (if (consp this)
+(setq desktop-first-buffer result)
-	      ;; an entry of this form `(symbol . value)'
+(bury-buffer result))
-	      (progn
+(unless desktop-first-buffer (setq desktop-first-buffer result))
-		(make-local-variable (car this))
+(set-buffer result)
-		(set (car this) (cdr this)))
+(unless (equal (buffer-name) desktop-buffer-name)
-	    ;; an entry of the form `symbol'
+(rename-buffer desktop-buffer-name))
-	    (make-local-variable this)
+;; minor modes
-	    (makunbound this)))
+(cond (
-	(setq locals (cdr locals))))))
+;; 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)))
+;; Even though point and mark are non-nil when written by `desktop-save'
+;; they may be modified by mandlers wanting to set point or mark themselves.
+(when desktop-buffer-point (goto-char desktop-buffer-point))
+(when desktop-buffer-mark
+(if (consp desktop-buffer-mark)
+(progn
+(set-mark (car desktop-buffer-mark))
+(setq mark-active (car (cdr desktop-buffer-mark))))
+(set-mark desktop-buffer-mark)))
+;; Never override file system if the file really is read-only marked.
+(if desktop-buffer-read-only (setq buffer-read-only desktop-buffer-read-only))
+(while desktop-buffer-locals
+(let ((this (car desktop-buffer-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 desktop-buffer-locals (cdr desktop-buffer-locals)))))))
+;; ----------------------------------------------------------------------------
 ;; Backward compatibility -- update parameters to 205 standards.
 (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
 		       desktop-buffer-major-mode
 		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
 (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
 			 (list (cons 'truncate-lines tl)
 			       (cons 'fill-column fc)
 			       (cons 'case-fold-search cfs)
 			       (cons 'case-replace cr)
 			       (cons 'overwrite-mode (car mim)))))
-;; ----------------------------------------------------------------------------
+;; ----------------------------------------------------------------------------
-;; If the user set desktop-enable to t with Custom,
+;; When `desktop-enable' is non-nil and "--no-desktop" is not specified on the
-;; do the rest of what it takes to use desktop,
+;; command line, we do the rest of what it takes to use desktop, but do it
-;; but do it after finishing loading the init file.
+;; after finishing loading the init file.
-(add-hook 'after-init-hook
+;; We cannot use `command-switch-alist' to process "--no-desktop" because these
-	  '(lambda ()
+;; functions are processed after `after-init-hook'.
-	     (when desktop-enable
+(add-hook
-	       (desktop-load-default)
+'after-init-hook
-	       (desktop-read))))
+'(lambda ()
+(let ((key "--no-desktop"))
+(if (member key command-line-args)
+(delete key command-line-args)
+(when desktop-enable
+(desktop-load-default)
+(desktop-read))))))
 (provide 'desktop)
 ;;; desktop.el ends here

Mercurial > emacs

comparison lisp/desktop.el @ 50507:110c0e29159c