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>
Juanma Barranquero's avatar
Juanma Barranquero committed
7
;; Maintainter: Lars Hansen <larsh@math.ku.dk>
Dave Love's avatar
Dave Love committed
8
;; Keywords: convenience
Richard M. Stallman's avatar
Richard M. Stallman committed
9
;; Favourite-brand-of-beer: None, I hate beer.
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; 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
24 25 26
;; 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
27 28 29

;;; Commentary:

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

Lars Hansen's avatar
Lars Hansen committed
40 41
;; To use this, use customize to turn on desktop-save-mode or add the
;; following line somewhere in your .emacs file:
42
;;
Lars Hansen's avatar
Lars Hansen committed
43
;;	(desktop-save-mode 1)
44
;;
Lars Hansen's avatar
Lars Hansen committed
45 46 47 48 49 50 51 52
;; For further usage information, look at the section
;; "Saving Emacs Sessions" in the GNU Emacs Manual.

;; When the desktop module is loaded, the function `desktop-kill' is
;; added to the `kill-emacs-hook'. This function is responsible for
;; saving the desktop when Emacs is killed.  Furthermore an anonymous
;; function is added to the `after-init-hook'. This function is
;; responsible for loading the desktop when Emacs is started.
53

54 55 56 57 58 59 60 61
;; 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.

62 63 64 65
;; 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.

66 67 68
;; 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.
69

70 71 72 73 74
;; 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.
75
;;            treese@lcs.mit.edu (Win Treese)        for ange-ftp tips.
76
;;            pot@cnuce.cnr.it (Francesco Potorti`)  for misc. tips.
77 78 79 80 81 82
;; ---------------------------------------------------------------------------
;; TODO:
;;
;; Save window configuration.
;; Recognize more minor modes.
;; Save mark rings.
Richard M. Stallman's avatar
Richard M. Stallman committed
83 84 85

;;; Code:

86
(defvar desktop-file-version "206"
87
  "Version number of desktop file format.
88 89 90
Written into the desktop file and used at desktop read to provide
backward compatibility.")

91
;; ----------------------------------------------------------------------------
92 93
;; USER OPTIONS -- settings you might want to play with.
;; ----------------------------------------------------------------------------
94 95 96 97 98

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

Lars Hansen's avatar
Lars Hansen committed
99 100 101 102 103 104 105 106 107 108 109 110
;;;###autoload
(define-minor-mode desktop-save-mode
  "Toggle desktop saving mode.
With numeric ARG, turn desktop saving on if ARG is positive, off
otherwise.  See variable `desktop-save' for a description of when the
desktop is saved."
  :global t
  :group 'desktop)

;; Maintained for backward compatibility
(defvaralias 'desktop-enable 'desktop-save-mode)
(make-obsolete-variable 'desktop-enable 'desktop-save-mode)
111

112
(defcustom desktop-save 'ask-if-new
Lars Hansen's avatar
Lars Hansen committed
113 114 115
  "*Specifies whether the desktop should be saved when it is killed.
A desktop is killed when the user changes desktop or quits Emacs.
Possible values are:
116 117 118 119 120 121
   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.
Lars Hansen's avatar
Lars Hansen committed
122 123 124
The desktop is never saved when `desktop-save-mode' is nil.
The variables `desktop-directory' and `desktop-base-file-name'
determine where the desktop is saved."
125 126 127 128 129 130 131 132 133 134
  :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
135
  (convert-standard-filename ".emacs.desktop")
Lars Hansen's avatar
Lars Hansen committed
136
  "Name of file for Emacs desktop, excluding the directory part."
137 138
  :type 'file
  :group 'desktop)
139
(defvaralias 'desktop-basefilename 'desktop-base-file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
140

141 142 143 144 145 146
(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)

147
(defcustom desktop-missing-file-warning nil
148 149 150 151 152
  "*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."
153 154
  :type 'boolean
  :group 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
155

156
(defcustom desktop-no-desktop-file-hook nil
Lars Hansen's avatar
Lars Hansen committed
157
  "Normal hook run when `desktop-read' can't find a desktop file.
158 159 160 161 162
May e.g. be used to show a dired buffer."
  :type 'hook
  :group 'desktop)

(defcustom desktop-after-read-hook nil
163
  "Normal hook run after a successful `desktop-read'.
164 165 166 167 168
May e.g. be used to show a buffer list."
  :type 'hook
  :group 'desktop)

(defcustom desktop-save-hook nil
Lars Hansen's avatar
Lars Hansen committed
169
  "Normal hook run before the desktop is saved in a desktop file.
170 171 172 173 174 175 176 177 178 179 180
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)
Lars Hansen's avatar
Lars Hansen committed
181 182 183 184
  "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
MAX-SIZE elements (if the value is a list) before saving the value.
185 186 187 188 189 190 191 192 193 194 195
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)
Lars Hansen's avatar
Lars Hansen committed
196
  "List of global variables to clear by `desktop-clear'.
197 198 199 200 201 202 203
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
Lars Hansen's avatar
Lars Hansen committed
204
  "^\\(\\*scratch\\*\\|\\*Messages\\*\\|\\*tramp/.+\\*\\)$"
205 206 207 208 209
  "Regexp identifying buffers that `desktop-clear' should not delete."
  :type 'regexp
  :group 'desktop)

;; Maintained for backward compatibility
Lars Hansen's avatar
Lars Hansen committed
210 211
(defcustom desktop-clear-preserve-buffers nil
  "*List of buffer names that `desktop-clear' should not delete.
212
This variable is maintained for backward compatibility only."
213 214
  :type '(repeat string)
  :group 'desktop)
Lars Hansen's avatar
Lars Hansen committed
215 216
(make-obsolete-variable 'desktop-clear-preserve-buffers
                        'desktop-clear-preserve-buffers-regexp)
217

Lars Hansen's avatar
Lars Hansen committed
218
(defcustom desktop-locals-to-save '(
219 220 221 222 223 224 225
  desktop-locals-to-save  ; Itself!  Think it over.
  truncate-lines
  case-fold-search
  case-replace
  fill-column
  overwrite-mode
  change-log-default-name
226 227
  line-number-mode
  buffer-file-coding-system)
Richard M. Stallman's avatar
Richard M. Stallman committed
228
  "List of local variables to save for each buffer.
Lars Hansen's avatar
Lars Hansen committed
229 230 231
The variables are saved only when they really are local."
  :type '(repeat symbol)
  :group 'desktop)
232
(make-variable-buffer-local 'desktop-locals-to-save)
233

234
;; We skip .log files because they are normally temporary.
Karl Heuer's avatar
Karl Heuer committed
235
;;         (ftp) files because they require passwords and whatnot.
236
;;         TAGS files to save time (tags-file-name is saved instead).
237
(defcustom desktop-buffers-not-to-save
238 239 240 241
  "\\(^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
242

Lars Hansen's avatar
Lars Hansen committed
243
;; Skip tramp and ange-ftp files
244
(defcustom desktop-files-not-to-save
245
  "^/[^/:]*:"
246 247 248
  "Regexp identifying files whose buffers are to be excluded from saving."
  :type 'regexp
  :group 'desktop)
249

250 251 252 253 254
(defcustom desktop-modes-not-to-save nil
  "List of major modes whose buffers should not be saved."
  :type '(repeat symbol)
  :group 'desktop)

255 256 257 258 259 260 261
(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))
262
  :group 'desktop)
263

264
;;;###autoload
265 266
(defvar desktop-save-buffer nil
  "When non-nil, save buffer status in desktop file.
267
This variable becomes buffer local when set.
268 269 270 271

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.
272

Lars Hansen's avatar
Lars Hansen committed
273
When file names are returned, they should be formatted using the call
274
\"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\".
275

276
Later, when `desktop-read' calls a function in `desktop-buffer-mode-handlers'
277 278 279 280 281
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)
282
(make-obsolete-variable 'desktop-buffer-misc-functions
283
                        'desktop-save-buffer)
284

285 286 287 288 289 290 291 292 293 294 295 296 297
(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).

Buffers with a major mode not specified here, are restored by the default
handler `desktop-restore-file-buffer'.

Handlers are called with parameters
298 299 300

   desktop-buffer-file-name
   desktop-buffer-name
301 302 303 304 305
   desktop-buffer-misc

Furthermore, they may use the following variables:

   desktop-file-version
306 307 308 309 310 311 312
   desktop-buffer-major-mode
   desktop-buffer-minor-modes
   desktop-buffer-point
   desktop-buffer-mark
   desktop-buffer-read-only
   desktop-buffer-locals

313
If a handler returns a buffer, then the saved mode settings
314
and variable values for that buffer are copied into it."
315
  :type 'alist
316
  :group 'desktop)
317

318 319 320
(put 'desktop-buffer-mode-handlers 'risky-local-variable t)
(make-obsolete-variable 'desktop-buffer-handlers
                        'desktop-buffer-mode-handlers)
321

322 323 324 325 326 327 328 329 330 331 332 333 334 335
(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)

336 337
;; ----------------------------------------------------------------------------
(defvar desktop-dirname nil
Lars Hansen's avatar
Lars Hansen committed
338
  "The directory in which the desktop file should be saved.")
Richard M. Stallman's avatar
Richard M. Stallman committed
339 340

(defconst desktop-header
341 342 343
";; --------------------------------------------------------------------------
;; Desktop File for Emacs
;; --------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
344
" "*Header to place in Desktop file.")
345 346 347

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

349
;; ----------------------------------------------------------------------------
350
(defun desktop-truncate (list n)
351
  "Truncate LIST to at most N elements destructively."
352
  (let ((here (nthcdr (1- n) list)))
353
    (if (consp here)
354
	(setcdr here nil))))
355

356
;; ----------------------------------------------------------------------------
357 358
(defun desktop-clear ()
  "Empty the Desktop.
Lars Hansen's avatar
Lars Hansen committed
359 360 361
This kills all buffers except for internal ones and those matching
`desktop-clear-preserve-buffers-regexp' or listed in
`desktop-clear-preserve-buffers'.  Furthermore, it clears the
362
variables listed in `desktop-globals-to-clear'."
Richard M. Stallman's avatar
Richard M. Stallman committed
363
  (interactive)
364 365 366 367
  (dolist (var desktop-globals-to-clear)
    (if (symbolp var)
      (eval `(setq-default ,var nil))
      (eval `(setq-default ,(car var) ,(cdr var)))))
368 369
  (let ((buffers (buffer-list)))
    (while buffers
370 371 372 373 374 375 376 377
      (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))))
378
      (setq buffers (cdr buffers))))
Richard M. Stallman's avatar
Richard M. Stallman committed
379
  (delete-other-windows))
380

381
;; ----------------------------------------------------------------------------
382
(add-hook 'kill-emacs-hook 'desktop-kill)
383

Richard M. Stallman's avatar
Richard M. Stallman committed
384
(defun desktop-kill ()
Lars Hansen's avatar
Lars Hansen committed
385
  "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do.
386 387 388 389
If the desktop should be saved and `desktop-dirname'
is nil, ask the user where to save the desktop."
  (when
    (and
Lars Hansen's avatar
Lars Hansen committed
390
      desktop-save-mode
391
      (let ((exists (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))))
392
        (or
Alex Schroeder's avatar
Alex Schroeder committed
393
          (eq desktop-save t)
394 395 396 397 398 399 400 401
          (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
402 403 404 405
        (file-name-as-directory
          (expand-file-name
            (call-interactively
              (lambda (dir) (interactive "DDirectory for desktop file: ") dir))))))
406 407 408 409 410 411
    (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)))))))

412
;; ----------------------------------------------------------------------------
413 414 415 416 417 418 419 420 421 422 423
(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)))

424
;; ----------------------------------------------------------------------------
425
(defun desktop-internal-v2s (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
426 427 428 429
  "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)."
430
  (cond
431 432 433 434
   ((or (numberp value) (null value) (eq t value))
    (cons 'may (prin1-to-string value)))
   ((stringp value)
    (let ((copy (copy-sequence value)))
435 436 437
      (set-text-properties 0 (length copy) nil copy)
      ;; Get rid of text properties because we cannot read them
      (cons 'may (prin1-to-string copy))))
438 439 440
   ((symbolp value)
    (cons 'must (prin1-to-string value)))
   ((vectorp value)
441 442 443 444 445 446 447
    (let* ((special nil)
	   (pass1 (mapcar
		   (lambda (el)
		     (let ((res (desktop-internal-v2s el)))
		       (if (null (car res))
			   (setq special t))
		       res))
448
		   value)))
449 450 451 452 453 454 455 456 457 458
      (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 " ") "]")))))
459 460
   ((consp value)
    (let ((p value)
461
	  newlist
462
	  use-list*
463 464 465 466 467 468 469 470 471
	  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)))
472 473 474 475 476
	    (or anynil (setq anynil (null (car last))))
	    (or anynil
		(setq newlist (cons '(must . ".") newlist)))
	    (setq use-list* t)
	    (setq newlist (cons last newlist))))
477 478 479
      (setq newlist (nreverse newlist))
      (if anynil
	  (cons nil
480
		(concat (if use-list* "(desktop-list* "  "(list ")
481 482 483 484 485 486 487 488 489
			(mapconcat (lambda (el)
				     (if (eq (car el) 'must)
					 (concat "'" (cdr el))
				       (cdr el)))
				   newlist
				   " ")
			")"))
	(cons 'must
	      (concat "(" (mapconcat 'cdr newlist " ") ")")))))
490
   ((subrp value)
491
    (cons nil (concat "(symbol-function '"
492
		      (substring (prin1-to-string value) 7 -1)
493
		      ")")))
494 495 496
   ((markerp value)
    (let ((pos (prin1-to-string (marker-position value)))
	  (buf (prin1-to-string (buffer-name (marker-buffer value)))))
497 498 499 500 501
      (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
502
    (cons 'may "\"Unprintable entity\""))))
503

504
;; ----------------------------------------------------------------------------
505
(defun desktop-value-to-string (value)
Richard M. Stallman's avatar
Richard M. Stallman committed
506 507
  "Convert VALUE to a string that when read evaluates to the same value.
Not all types of values are supported."
508 509
  (let* ((print-escape-newlines t)
	 (float-output-format nil)
510
	 (quote.txt (desktop-internal-v2s value))
511 512 513 514 515
	 (quote (car quote.txt))
	 (txt (cdr quote.txt)))
    (if (eq quote 'must)
	(concat "'" txt)
      txt)))
516

517
;; ----------------------------------------------------------------------------
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
(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)))
533
	      (desktop-truncate (eval var) size))
534 535 536 537 538
	  (insert "(setq "
		  (symbol-name var)
		  " "
		  (desktop-value-to-string (symbol-value var))
		  ")\n")))))
539

540
;; ----------------------------------------------------------------------------
541
(defun desktop-save-buffer-p (filename bufname mode &rest dummy)
542
  "Return t if buffer should have its state saved in the desktop file.
543
FILENAME is the visited file name, BUFNAME is the buffer name, and
Richard M. Stallman's avatar
Richard M. Stallman committed
544
MODE is the major mode."
545
  (let ((case-fold-search nil))
546
    (and (not (string-match desktop-buffers-not-to-save bufname))
547 548 549 550 551 552 553 554 555
         (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))))))
556

557
;; ----------------------------------------------------------------------------
558 559 560 561 562 563 564 565 566 567 568 569 570 571
(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))))
572

573
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
574
(defun desktop-save (dirname)
Lars Hansen's avatar
Lars Hansen committed
575 576 577
  "Save the desktop in a desktop file.
Parameter DIRNAME specifies where to save the desktop file.
See also `desktop-base-file-name'."
Richard M. Stallman's avatar
Richard M. Stallman committed
578
  (interactive "DDirectory to save desktop file in: ")
579
  (run-hooks 'desktop-save-hook)
580
  (setq dirname (file-name-as-directory (expand-file-name dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
581
  (save-excursion
582
    (let ((filename (expand-file-name desktop-base-file-name dirname))
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
          (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
609
                    ;; Auxiliary information
610 611
                    (when (functionp desktop-save-buffer)
                      (funcall desktop-save-buffer dirname))
612 613 614 615 616 617 618 619 620 621 622 623 624
                    (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
625 626
      (set-buffer buf)
      (erase-buffer)
627

628 629 630 631 632 633 634
      (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
635 636
      (mapcar (function desktop-outvar) desktop-globals-to-save)
      (if (memq 'kill-ring desktop-globals-to-save)
637 638 639 640
        (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
641

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

662
;; ----------------------------------------------------------------------------
Richard M. Stallman's avatar
Richard M. Stallman committed
663
(defun desktop-remove ()
Lars Hansen's avatar
Lars Hansen committed
664 665
  "Delete desktop file in `desktop-dirname'.
This function also sets `desktop-dirname' to nil."
Richard M. Stallman's avatar
Richard M. Stallman committed
666
  (interactive)
Lars Hansen's avatar
Lars Hansen committed
667 668 669 670
  (when desktop-dirname
    (let ((filename (expand-file-name desktop-base-file-name desktop-dirname)))
      (setq desktop-dirname nil)
      (when (file-exists-p filename)
671
        (delete-file filename)))))
Lars Hansen's avatar
Lars Hansen committed
672

673
;; ----------------------------------------------------------------------------
674
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
675 676 677 678 679 680 681 682
(defun desktop-read (&optional dirname)
  "Read and process the desktop file in directory DIRNAME.
Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in
directories listed in `desktop-path'.  If a desktop file is found, it
is processed and `desktop-after-read-hook' is run. If no desktop file
is found, clear the desktop and run `desktop-no-desktop-file-hook'.
This function is a no-op when Emacs is running in batch mode.
It returns t if a desktop file was loaded, nil otherwise."
Richard M. Stallman's avatar
Richard M. Stallman committed
683
  (interactive)
684
  (unless noninteractive
Lars Hansen's avatar
Lars Hansen committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
    (setq desktop-dirname
      (file-name-as-directory
        (expand-file-name
          (or
            ;; If DIRNAME is specified, use it.
            (and (< 0 (length dirname)) dirname)
            ;; Otherwise search desktop file in desktop-path.
            (let ((dirs desktop-path))
              (while
                (and
                  dirs
                  (not
                    (file-exists-p (expand-file-name desktop-base-file-name (car dirs)))))
                (setq dirs (cdr dirs)))
              (and dirs (car dirs)))
            ;; If not found and `desktop-path' is non-nil, use its first element.
            (and desktop-path (car desktop-path))
            ;; Default: Home directory.
            "~"))))
    (if (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))
      ;; Desktop file found, process it.
706 707 708
      (let ((desktop-first-buffer nil)
            (desktop-buffer-ok-count 0)
            (desktop-buffer-fail-count 0))
Lars Hansen's avatar
Lars Hansen committed
709 710 711 712 713 714 715 716 717 718 719
        ;; Evaluate desktop buffer.
        (load (expand-file-name desktop-base-file-name desktop-dirname) t t t)
        ;; `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)))
        (run-hooks 'desktop-delay-hook)
        (setq desktop-delay-hook nil)
        (run-hooks 'desktop-after-read-hook)
720 721 722 723 724 725
        (message "Desktop: %d buffer%s restored%s."
                 desktop-buffer-ok-count
                 (if (= 1 desktop-buffer-ok-count) "" "s")
                 (if (< 0 desktop-buffer-fail-count)
                     (format ", %d failed to restore" desktop-buffer-fail-count)
                   ""))
Lars Hansen's avatar
Lars Hansen committed
726 727 728 729 730 731 732
        t)
      ;; No desktop file found.
      (desktop-clear)
      (let ((default-directory desktop-dirname))
        (run-hooks 'desktop-no-desktop-file-hook))
      (message "No desktop file.")
      nil)))
733

734
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
735
;; Maintained for backward compatibility
736
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
737
(defun desktop-load-default ()
Richard M. Stallman's avatar
Richard M. Stallman committed
738
  "Load the `default' start-up library manually.
Lars Hansen's avatar
Lars Hansen committed
739
Also inhibit further loading of it."
740
  (if (not inhibit-default-init)	; safety check
Richard M. Stallman's avatar
Richard M. Stallman committed
741 742 743
      (progn
	(load "default" t t)
	(setq inhibit-default-init t))))
Lars Hansen's avatar
Lars Hansen committed
744
(make-obsolete 'desktop-load-default 'desktop-save-mode)
745 746 747

;; ----------------------------------------------------------------------------
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
748 749 750 751 752 753 754
(defun desktop-change-dir (dirname)
  "Change to desktop saved in DIRNAME.
Kill the desktop as specified by variables `desktop-save-mode' and
`desktop-save', then clear the desktop and load the desktop file in
directory DIRNAME."
  (interactive "DChange to directory: ")
  (setq dirname (file-name-as-directory (expand-file-name dirname desktop-dirname)))
755 756
  (desktop-kill)
  (desktop-clear)
Lars Hansen's avatar
Lars Hansen committed
757 758 759
  (desktop-read dirname))
  
;; ----------------------------------------------------------------------------
760
;;;###autoload
Lars Hansen's avatar
Lars Hansen committed
761 762
(defun desktop-save-in-desktop-dir ()
  "Save the desktop in directory `desktop-dirname'."
763 764 765 766 767 768 769 770 771 772 773
  (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)
Lars Hansen's avatar
Lars Hansen committed
774 775 776 777 778 779
  (unless desktop-dirname
    (error "Unknown desktop directory"))
  (unless (file-exists-p (expand-file-name desktop-base-file-name desktop-dirname))
    (error "No desktop file found"))
  (desktop-clear)
  (desktop-read desktop-dirname))
780

781
;; ----------------------------------------------------------------------------
782 783 784 785 786 787 788
(defun desktop-restore-file-buffer (desktop-buffer-file-name
                                    desktop-buffer-name
                                    desktop-buffer-misc)
  "Restore a file buffer."
  (eval-when-compile ; Just to silence the byte compiler
    (defvar desktop-buffer-major-mode)
    (defvar desktop-buffer-locals))
789 790
  (if desktop-buffer-file-name
      (if (or (file-exists-p desktop-buffer-file-name)
791 792 793 794 795 796
              (let ((msg (format "Desktop: File \"%s\" no longer exists."
                                 desktop-buffer-file-name)))
                 (if desktop-missing-file-warning
		     (y-or-n-p (concat msg " Re-create? "))
                   (message msg)
                   nil)))
797 798 799 800 801 802
	  (let* ((auto-insert nil) ; Disable auto insertion
		 (coding-system-for-read
		  (or coding-system-for-read
		      (cdr (assq 'buffer-file-coding-system
				 desktop-buffer-locals))))
		 (buf (find-file-noselect desktop-buffer-file-name)))
803 804
	    (condition-case nil
		(switch-to-buffer buf)
805
	      (error (pop-to-buffer buf)))
806 807 808
	    (and (not (eq major-mode desktop-buffer-major-mode))
		 (functionp desktop-buffer-major-mode)
		 (funcall desktop-buffer-major-mode))
809
	    buf)
810
	nil)))
811

812
;; ----------------------------------------------------------------------------
Juri Linkov's avatar
Juri Linkov committed
813 814
;; Create a buffer, load its file, set its mode, ...;
;; called from Desktop file only.
815

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
(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)
832 833 834 835
  ;; Just to silence the byte compiler. Bound locally in `desktop-read'.
  (eval-when-compile
    (defvar desktop-buffer-ok-count)
    (defvar desktop-buffer-fail-count))
836 837 838 839 840
  ;; 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))
841 842 843 844 845 846 847 848 849 850 851 852
      (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)))
853
    )
854 855 856 857
      (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))
858
      (unless (bufferp result) (setq result nil))
859 860
      ;; Restore buffer list order with new buffer at end. Don't change
      ;; the order for old desktop files (old desktop module behaviour).
861
      (unless (< desktop-file-version 206)
862 863
        (mapcar 'bury-buffer buffer-list)
        (when result (bury-buffer result)))
864
      (when result
865 866
        (unless (or desktop-first-buffer (< desktop-file-version 206))
          (setq desktop-first-buffer result))
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
        (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'
883
        ;; they may be modified by handlers wanting to set point or mark themselves.
884 885 886 887 888 889
        (when desktop-buffer-point
          (goto-char
            (condition-case err
                ;; Evaluate point. Thus point can be something like '(search-forward ...
                (eval desktop-buffer-point)
              (error (message "%s" (error-message-string err)) 1))))
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
        (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)))))))
909

910
;; ----------------------------------------------------------------------------
911
;; Backward compatibility -- update parameters to 205 standards.
912 913
(defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name
		       desktop-buffer-major-mode
914
		       mim pt mk ro tl fc cfs cr desktop-buffer-misc)
915
  (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name
916 917
			 desktop-buffer-major-mode (cdr mim) pt mk ro
			 desktop-buffer-misc
918 919 920 921 922
			 (list (cons 'truncate-lines tl)
			       (cons 'fill-column fc)
			       (cons 'case-fold-search cfs)
			       (cons 'case-replace cr)
			       (cons 'overwrite-mode (car mim)))))
923

924
;; ----------------------------------------------------------------------------
Lars Hansen's avatar
Lars Hansen committed
925
;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the
926 927 928 929 930 931 932 933 934 935
;; 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)
Lars Hansen's avatar
Lars Hansen committed
936
        (when desktop-save-mode (desktop-read))))))
937

Richard M. Stallman's avatar
Richard M. Stallman committed
938
(provide 'desktop)
Richard M. Stallman's avatar
Richard M. Stallman committed
939

Miles Bader's avatar
Miles Bader committed
940
;;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9
941
;;; desktop.el ends here