desktop.el 35.8 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; desktop.el --- save partial status of Emacs when killed

3 4
;; Copyright (C) 1993, 1994, 1995, 1997, 2000, 2001
;;   Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

;; Author: Morten Welinder <terra@diku.dk>
Dave Love's avatar
Dave Love committed
7
;; Keywords: convenience
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;; Favourite-brand-of-beer: None, I hate beer.
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28

;;; Commentary:

29 30 31 32 33 34 35 36
;; 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
37
;;		- some local variables
Richard M. Stallman's avatar
Richard M. Stallman committed
38

39
;; To use this, first put these two lines in the bottom of your .emacs
40 41 42 43 44
;; file (the later the better):
;;
;;	(desktop-load-default)
;;	(desktop-read)
;;
45 46 47 48
;; Between these two lines 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
49 50 51
;;
;;	(setq desktop-locals-to-save (cons 'foobar desktop-locals-to-save))
;;
52
;; To avoid saving excessive amounts of data you may also wish to add
53 54 55
;; something like the following
;;
;;	(add-hook 'kill-emacs-hook
56
;;		  '(lambda ()
57 58 59 60
;;		     (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
61 62
;; must place this line *after* the `(desktop-load-default)' line.  See also
;; the variable `desktop-save-hook'.
Richard M. Stallman's avatar
Richard M. Stallman committed
63

64 65 66 67 68
;; 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
69
;; left them.  If you save a desktop file in your home directory it will
70
;; act as a default desktop when you start Emacs from a directory that
71 72
;; doesn't have its own.  I never do this, but you may want to.

73 74 75 76 77 78 79 80
;; Some words on minor modes: Most minor modes are controlled by
;; buffer-local variables, which have a standard save / restore
;; mechanism.  To handle all minor modes, we take the following
;; approach: (1) check whether the variable name from
;; `minor-mode-alist' is also a function; and (2) use translation
;; table `desktop-minor-mode-table' in the case where the two names
;; are not the same.

81 82 83 84
;; 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.

85 86 87
;; 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.
88

89 90 91 92 93
;; 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.
94
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
95
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
96 97 98 99 100 101
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Save window configuration.
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103 104

;;; Code:

105 106 107
;; Make the compilation more silent
(eval-when-compile
  ;; We use functions from these modules
108 109
  ;; We can't (require 'mh-e) since that wants to load something.
  (mapcar 'require '(info dired reporter)))
110 111 112 113 114 115

(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.")

116
;; ----------------------------------------------------------------------------
117 118
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
119 120 121 122 123

(defgroup desktop nil
  "Save status of Emacs when you exit."
  :group 'frames)

124 125 126 127 128
(defcustom desktop-enable nil
  "*Non-nil enable Desktop to save the state of Emacs when you exit."
  :group 'desktop
  :type 'boolean
  :require 'desktop
Dan Nicolaescu's avatar
Dan Nicolaescu committed
129 130
  :initialize 'custom-initialize-default
  :version "20.3")
131

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
(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
152
  (convert-standard-filename ".emacs.desktop")
153 154 155
  "File for Emacs desktop, not including the directory name."
  :type 'file
  :group 'desktop)
156
(defvaralias 'desktop-basefilename 'desktop-base-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
157

158 159 160 161 162 163
(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)

164
(defcustom desktop-missing-file-warning nil
Richard M. Stallman's avatar
Richard M. Stallman committed
165
  "*If non-nil then desktop warns when a file no longer exists.
166 167 168
Otherwise it simply ignores that file."
  :type 'boolean
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
(defcustom desktop-no-desktop-file-hook nil
  "Normal hook run after fail of `desktop-read' due to missing desktop file.
May e.g. be used to show a dired buffer."
  :type 'hook
  :group 'desktop)

(defcustom desktop-after-read-hook nil
  "Normal hook run after a sucessful `desktop-read'.
May e.g. be used to show a buffer list."
  :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)
195 196 197 198
  "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
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
\(if the value is a list) before saving the value.
Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'."
  :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)
  "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)
Richard M. Stallman's avatar
Richard M. Stallman committed
240 241
  "List of local variables to save for each buffer.
The variables are saved only when they really are local.")
242
(make-variable-buffer-local 'desktop-locals-to-save)
243

244
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
245
;;         (ftp) files because they require passwords and whatnot.
246
;;         TAGS files to save time (tags-file-name is saved instead).
247
(defcustom desktop-buffers-not-to-save
248 249 250 251
  "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\|^tags\\|^TAGS\\)$"
  "Regexp identifying buffers that are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
252

253
;; Skip ange-ftp files
254
(defcustom desktop-files-not-to-save
255
  "^/[^/:]*:"
256 257 258
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
259

260 261 262 263 264 265 266 267
(defcustom desktop-buffer-modes-to-save
  '(Info-mode rmail-mode)
  "If a buffer is of one of these major modes, save the buffer name.
It is up to the functions in `desktop-buffer-handlers' to decide
whether the buffer should be recreated or not, and how."
  :type '(repeat symbol)
  :group 'desktop)

268 269 270 271 272
(defcustom desktop-modes-not-to-save nil
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

273 274 275 276 277 278 279
(defcustom desktop-file-name-format 'absolute
  "*Format in which desktop file names should be saved.
Possible values are:
   absolute -- Absolute file name.
   tilde    -- Relative to ~.
   local    -- Relative to directory of desktop file."
  :type '(choice (const absolute) (const tilde) (const local))
280
  :group 'desktop)
281

282 283 284 285 286 287 288 289
(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.

290 291 292
File names should formatted using the call
\"(desktop-file-name FILE-NAME dirname)\".

293 294 295 296 297 298 299
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."
  :type '(repeat function)
  :group 'desktop)

300
(defcustom desktop-buffer-handlers
301
  '(desktop-buffer-dired
Richard M. Stallman's avatar
Richard M. Stallman committed
302
    desktop-buffer-rmail
303
    desktop-buffer-mh
Richard M. Stallman's avatar
Richard M. Stallman committed
304 305
    desktop-buffer-info
    desktop-buffer-file)
Richard M. Stallman's avatar
Richard M. Stallman committed
306
  "*List of functions to call in order to create a buffer.
307
The functions are called without explicit parameters but can use the
308 309 310 311 312 313 314 315 316 317 318 319 320
following variables:

   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

321
If one function returns non-nil, no further functions are called.
322 323
If the function returns a buffer, then the saved mode settings
and variable values for that buffer are copied into it."
324 325
  :type '(repeat function)
  :group 'desktop)
326

327 328
(put 'desktop-buffer-handlers 'risky-local-variable t)

329 330 331 332 333 334 335 336 337 338 339 340 341 342
(defcustom desktop-minor-mode-table
  '((auto-fill-function auto-fill-mode)
    (vc-mode nil))
  "Table mapping minor mode variables to minor mode functions.
Each entry has the form (NAME RESTORE-FUNCTION).
NAME is the name of the buffer-local variable indicating that the minor
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
this table."
  :type 'sexp
  :group 'desktop)

343 344
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Richard M. Stallman's avatar
Richard M. Stallman committed
345 346 347
  "The directory in which the current desktop file resides.")

(defconst desktop-header
348 349 350
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
351
" "*Header to place in Desktop file.")
352 353 354

(defvar desktop-delay-hook nil
  "Hooks run after all buffers are loaded; intended for internal use.")
355

356
;; ----------------------------------------------------------------------------
357 358 359 360
(defun desktop-truncate (l n)
  "Truncate LIST to at most N elements destructively."
  (let ((here (nthcdr (1- n) l)))
    (if (consp here)
361
	(setcdr here nil))))
362

363
;; ----------------------------------------------------------------------------
364 365
(defun desktop-clear ()
  "Empty the Desktop.
366 367 368
This kills all buffers except for internal ones and those listed
in `desktop-clear-preserve-buffers'.  Furthermore, it clears the
variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
369
  (interactive)
370 371 372 373
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
374 375
  (let ((buffers (buffer-list)))
    (while buffers
376 377 378 379 380 381 382 383
      (let ((bufname (buffer-name (car buffers))))
         (or
           (null bufname)
           (string-match desktop-clear-preserve-buffers-regexp bufname)
           (member bufname desktop-clear-preserve-buffers)
           ;; Don't kill buffers made for internal purposes.
           (and (not (equal bufname "")) (eq (aref bufname 0) ?\ ))
           (kill-buffer (car buffers))))
384
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
385
  (delete-other-windows))
386

387
;; ----------------------------------------------------------------------------
388
(add-hook 'kill-emacs-hook 'desktop-kill)
389

Richard M. Stallman's avatar
Richard M. Stallman committed
390
(defun desktop-kill ()
391 392 393 394 395 396
  "If `desktop-enable' is non-nil, do what `desktop-save' says to do.
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
  (when
    (and
      desktop-enable
397
      (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))))
398 399 400 401 402 403 404 405 406 407
        (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
408 409 410 411
        (file-name-as-directory
          (expand-file-name
            (call-interactively
              (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
412 413 414 415 416 417
    (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)))))))

418
;; ----------------------------------------------------------------------------
419 420 421 422 423 424 425 426 427 428 429
(defun desktop-list* (&rest args)
  (if (null (cdr args))
      (car args)
    (setq args (nreverse args))
    (let ((value (cons (nth 1 args) (car args))))
      (setq args (cdr (cdr args)))
      (while args
	(setq value (cons (car args) value))
	(setq args (cdr args)))
      value)))

430
;; ----------------------------------------------------------------------------
431
(defun desktop-internal-v2s (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433 434 435
  "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)."
436
  (cond
437
   ((or (numberp val) (null val) (eq t val))
438
    (cons 'may (prin1-to-string val)))
439
   ((stringp val)
440 441 442 443
    (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))))
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
   ((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)
466 467
    (let ((p val)
	  newlist
468
	  use-list*
469 470 471 472 473 474 475 476 477
	  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)))
478 479 480 481 482
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
483 484 485
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
486
		(concat (if use-list* "(desktop-list* "  "(list ")
487 488 489 490 491 492 493 494 495
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
496 497 498 499 500 501 502 503 504 505 506 507
   ((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
508
    (cons 'may "\"Unprintable entity\""))))
509

510
;; ----------------------------------------------------------------------------
511
(defun desktop-value-to-string (val)
Richard M. Stallman's avatar
Richard M. Stallman committed
512 513
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
514 515 516 517 518 519 520 521
  (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)))
522

523
;; ----------------------------------------------------------------------------
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
(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)))
539
	      (desktop-truncate (eval var) size))
540 541 542 543 544
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
545

546
;; ----------------------------------------------------------------------------
547
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
Richard M. Stallman's avatar
Richard M. Stallman committed
548
  "Return t if the desktop should record a particular buffer for next startup.
549
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
550
MODE is the major mode."
551
  (let ((case-fold-search nil))
552 553 554 555 556 557 558 559 560 561
    (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)
562
		  (memq mode desktop-buffer-modes-to-save))))))
563

564
;; ----------------------------------------------------------------------------
565 566 567 568 569 570 571 572 573 574 575 576 577 578
(defun desktop-file-name (filename dirname)
  "Convert FILENAME to format specified in `desktop-file-name-format'.
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))))
579

580
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
581
(defun desktop-save (dirname)
582
  "Save the Desktop file. Parameter DIRNAME specifies where to save desktop."
Richard M. Stallman's avatar
Richard M. Stallman committed
583
  (interactive "DDirectory to save desktop file in: ")
584
  (run-hooks 'desktop-save-hook)
585
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
586
  (save-excursion
587
    (let ((filename (expand-file-name desktop-base-file-name dirname))
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
          (info
            (mapcar
              (function
                (lambda (b)
                  (set-buffer b)
                  (list
                    (desktop-file-name (buffer-file-name) dirname)
                    (buffer-name)
                    major-mode
                    ;; minor modes
                    (let (ret)
                      (mapcar
                        #'(lambda (mim)
                          (and
                            (boundp mim)
                            (symbol-value mim)
                            (setq ret
                              (cons
                                (let ((special (assq mim desktop-minor-mode-table)))
                                  (if special (cadr special) mim))
                                ret))))
                        (mapcar #'car minor-mode-alist))
                      ret)
                    (point)
                    (list (mark t) mark-active)
                    buffer-read-only
                    (run-hook-with-args-until-success 'desktop-buffer-misc-functions)
                    (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))
                            (when (member (car locals) loclist)
                              (setq ll (cons (car locals) ll)))))
                        (setq locals (cdr locals)))
                      ll))))
              (buffer-list)))
          (buf (get-buffer-create "*desktop*")))
Richard M. Stallman's avatar
Richard M. Stallman committed
628 629
      (set-buffer buf)
      (erase-buffer)
630

631 632 633 634 635 636 637
      (insert
        ";; -*- coding: emacs-mule; -*-\n"
        desktop-header
        ";; Created " (current-time-string) "\n"
        ";; Desktop file format version " desktop-file-version "\n"
        ";; Emacs version " emacs-version "\n\n"
        ";; Global section:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
640 641 642 643
        (insert
          "(setq kill-ring-yank-pointer (nthcdr "
          (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer)))
          " kill-ring))\n"))
Richard M. Stallman's avatar
Richard M. Stallman committed
644

645
      (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n")
646
      (mapcar
647 648 649 650 651 652 653 654 655 656 657 658
        (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)
Richard M. Stallman's avatar
Richard M. Stallman committed
659
      (setq default-directory dirname)
660
      (when (file-exists-p filename) (delete-file filename))
661
      (let ((coding-system-for-write 'emacs-mule))
662
        (write-region (point-min) (point-max) filename nil 'nomessage))))
Richard M. Stallman's avatar
Richard M. Stallman committed
663
  (setq desktop-dirname dirname))
664

665
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
666 667 668 669
(defun desktop-remove ()
  "Delete the Desktop file and inactivate the desktop system."
  (interactive)
  (if desktop-dirname
670 671 672 673
      (let ((filename (expand-file-name desktop-base-file-name desktop-dirname)))
    (setq desktop-dirname nil)
    (if (file-exists-p filename)
        (delete-file filename)))))
674
;; ----------------------------------------------------------------------------
675
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
676
(defun desktop-read ()
677
  "Read the Desktop file and the files it specifies.
678 679 680 681
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."
Richard M. Stallman's avatar
Richard M. Stallman committed
682
  (interactive)
683 684 685 686 687 688 689 690
  (unless noninteractive
    (let ((dirs desktop-path))
      (while
        (and
          dirs
          (not
            (file-exists-p (expand-file-name desktop-base-file-name (car dirs)))))
        (setq dirs (cdr dirs)))
691
      (setq desktop-dirname (and dirs (file-name-as-directory (expand-file-name (car dirs)))))
692
      (if desktop-dirname
693
        (let ((desktop-first-buffer nil))
694
          ;; Evaluate desktop buffer.
695
          (load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
696 697 698 699 700 701
          ;; `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))))))
          (switch-to-buffer (car (buffer-list)))
702 703 704 705 706 707 708 709 710 711
          (run-hooks 'desktop-delay-hook)
          (setq desktop-delay-hook nil)
          (run-hooks 'desktop-after-read-hook)
          (message "Desktop loaded.")
          t)
        (desktop-clear)
        (run-hooks 'desktop-no-desktop-file-hook)
        (message "No desktop file.")
        nil))))

712
;; ----------------------------------------------------------------------------
713
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
714
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
715 716 717
  "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."
718
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
719 720 721
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
722 723 724 725 726 727 728 729

;; ----------------------------------------------------------------------------
;;;###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: ")
730
  (setq dir (file-name-as-directory (expand-file-name dir desktop-dirname)))
731 732 733
  (desktop-kill)
  (desktop-clear)
  (setq desktop-enable t)
734 735 736 737 738 739
  (let ((desktop-path (list dir))
        (default-directory dir))
    (desktop-read))
  ;; Set `desktop-dirname' even in no desktop file was found
  (setq desktop-dirname dir))
  ;; ----------------------------------------------------------------------------
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
;;;###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))

758 759 760
;; ----------------------------------------------------------------------------
;; Note: the following functions use the dynamic variable binding in Lisp.
;;
761 762 763 764 765 766 767 768 769 770 771 772 773 774

(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)
)

775 776 777 778 779
(defun desktop-buffer-info-misc-data ()
  (if (eq major-mode 'Info-mode)
      (list Info-current-file
            Info-current-node)))

780
;; ----------------------------------------------------------------------------
781
(defun desktop-buffer-dired-misc-data ()
782 783 784 785 786 787
  (when (eq major-mode 'dired-mode)
    (eval-when-compile (defvar dirname))
    (cons
      ;; dired directory in portable form
      (file-name-as-directory (desktop-file-name dired-directory dirname))
      (cdr (nreverse (mapcar (function car) dired-subdir-alist))))))
788

789
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
790
(defun desktop-buffer-info () "Load an info file."
791
  (if (eq 'Info-mode desktop-buffer-major-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
792
      (progn
793 794 795 796 797 798
	(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))))))
799

800
;; ----------------------------------------------------------------------------
801
(eval-when-compile (defvar rmail-buffer)) ; Just to silence the byte compiler.
Richard M. Stallman's avatar
Richard M. Stallman committed
802
(defun desktop-buffer-rmail () "Load an RMAIL file."
803
  (if (eq 'rmail-mode desktop-buffer-major-mode)
804
      (condition-case error
805 806 807 808
	  (progn (rmail-input desktop-buffer-file-name)
                         (if (eq major-mode 'rmail-mode)
                             (current-buffer)
                           rmail-buffer))
809 810 811
	(file-locked
	 (kill-buffer (current-buffer))
	 'ignored))))
812

813
;; ----------------------------------------------------------------------------
814
(defun desktop-buffer-mh () "Load a folder in the mh system."
815
  (if (eq 'mh-folder-mode desktop-buffer-major-mode)
816 817
      (progn
	(mh-find-path)
818 819
        (mh-visit-folder desktop-buffer-name)
	(current-buffer))))
820

821
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
822
(defun desktop-buffer-dired () "Load a directory using dired."
823
  (if (eq 'dired-mode desktop-buffer-major-mode)
824
      (if (file-directory-p (file-name-directory (car desktop-buffer-misc)))
825
	  (progn
826
            (dired (car desktop-buffer-misc))
827
	    (mapcar 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
828
	    (current-buffer))
829
	(message "Directory %s no longer exists." (car desktop-buffer-misc))
830 831
	(sit-for 1)
	'ignored)))
832

833
;; ----------------------------------------------------------------------------
834 835
(defun desktop-buffer-file ()
  "Load a file."
836 837
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
838
	      (and desktop-missing-file-warning
839 840
		   (y-or-n-p (format
			      "File \"%s\" no longer exists. Re-create? "
841
			      desktop-buffer-file-name))))
842 843 844
	  (let ((buf (find-file-noselect desktop-buffer-file-name)))
	    (condition-case nil
		(switch-to-buffer buf)
845
	      (error (pop-to-buffer buf)))
846 847 848
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
849
	    buf)
Richard M. Stallman's avatar
Richard M. Stallman committed
850
	'ignored)))
851

852 853
;; ----------------------------------------------------------------------------
;; Create a buffer, load its file, set is mode, ...;  called from Desktop file
Richard M. Stallman's avatar
Richard M. Stallman committed
854
;; only.
855

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
(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)
  ;; 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))
      (hlist desktop-buffer-handlers)
      (result)
      (handler)
    )
      ;; Call desktop-buffer-handlers to create buffer.
      (while (and (not result) hlist)
        (setq handler (car hlist))
        (setq result (funcall handler))
        (setq hlist (cdr hlist)))
      (unless (bufferp result) (setq result nil))
887 888
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
889
      (unless (< desktop-file-version 206)
890 891
        (mapcar 'bury-buffer buffer-list)
        (when result (bury-buffer result)))
892
      (when result
893 894
        (unless (or desktop-first-buffer (< desktop-file-version 206))
          (setq desktop-first-buffer result))
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
        (set-buffer result)
        (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)))
        ;; Even though point and mark are non-nil when written by `desktop-save'
911
        ;; they may be modified by handlers wanting to set point or mark themselves.
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
        (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)))))))
932

933
;; ----------------------------------------------------------------------------
934
;; Backward compatibility -- update parameters to 205 standards.
935 936
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
937
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
938
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
939 940
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
941 942 943 944 945
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
946

947
;; ----------------------------------------------------------------------------
948 949 950 951 952 953 954 955 956 957 958 959 960 961
;; When `desktop-enable' is non-nil and "--no-desktop" is not specified on the
;; command line, we do the rest of what it takes to use desktop, but do it
;; after finishing loading the init file.
;; We cannot use `command-switch-alist' to process "--no-desktop" because these
;; functions are processed after `after-init-hook'.
(add-hook
  'after-init-hook
  '(lambda ()
    (let ((key "--no-desktop"))
      (if (member key command-line-args)
        (delete key command-line-args)
        (when desktop-enable
          (desktop-load-default)
          (desktop-read))))))
962

Richard M. Stallman's avatar
Richard M. Stallman committed
963
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
964

965
;;; desktop.el ends here