Commit | Line | Data |
---|---|---|
6343ed61 RS |
1 | ;;; desktop.el --- save partial status of Emacs when killed |
2 | ||
0d30b337 | 3 | ;; Copyright (C) 1993, 1994, 1995, 1997, 2000, 2001, 2002, 2003, |
409cc4a3 | 4 | ;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
6343ed61 RS |
5 | |
6 | ;; Author: Morten Welinder <terra@diku.dk> | |
3ea96cac | 7 | ;; Keywords: convenience |
b6105c76 | 8 | ;; Favourite-brand-of-beer: None, I hate beer. |
6343ed61 RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
b4aa6026 | 14 | ;; the Free Software Foundation; either version 3, or (at your option) |
6343ed61 RS |
15 | ;; any later version. |
16 | ||
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
25 | ;; Boston, MA 02110-1301, USA. | |
6343ed61 RS |
26 | |
27 | ;;; Commentary: | |
28 | ||
0b9bd504 RS |
29 | ;; Save the Desktop, i.e., |
30 | ;; - some global variables | |
31 | ;; - the list of buffers with associated files. For each buffer also | |
32 | ;; - the major mode | |
33 | ;; - the default directory | |
34 | ;; - the point | |
35 | ;; - the mark & mark-active | |
36 | ;; - buffer-read-only | |
ec4c6f22 | 37 | ;; - some local variables |
6343ed61 | 38 | |
6b61353c KH |
39 | ;; To use this, use customize to turn on desktop-save-mode or add the |
40 | ;; following line somewhere in your .emacs file: | |
0b9bd504 | 41 | ;; |
6b61353c | 42 | ;; (desktop-save-mode 1) |
0b9bd504 | 43 | ;; |
6b61353c KH |
44 | ;; For further usage information, look at the section |
45 | ;; "Saving Emacs Sessions" in the GNU Emacs Manual. | |
46 | ||
47 | ;; When the desktop module is loaded, the function `desktop-kill' is | |
341c2f07 | 48 | ;; added to the `kill-emacs-hook'. This function is responsible for |
6b61353c | 49 | ;; saving the desktop when Emacs is killed. Furthermore an anonymous |
341c2f07 | 50 | ;; function is added to the `after-init-hook'. This function is |
6b61353c | 51 | ;; responsible for loading the desktop when Emacs is started. |
ec4c6f22 | 52 | |
0f4804e7 LH |
53 | ;; Special handling. |
54 | ;; ----------------- | |
55 | ;; Variables `desktop-buffer-mode-handlers' and `desktop-minor-mode-handlers' | |
56 | ;; are supplied to handle special major and minor modes respectively. | |
57 | ;; `desktop-buffer-mode-handlers' is an alist of major mode specific functions | |
341c2f07 | 58 | ;; to restore a desktop buffer. Elements must have the form |
be617bbf | 59 | ;; |
0f4804e7 | 60 | ;; (MAJOR-MODE . RESTORE-BUFFER-FUNCTION). |
be617bbf | 61 | ;; |
0f4804e7 | 62 | ;; Functions listed are called by `desktop-create-buffer' when `desktop-read' |
341c2f07 | 63 | ;; evaluates the desktop file. Buffers with a major mode not specified here, |
0f4804e7 LH |
64 | ;; are restored by the default handler `desktop-restore-file-buffer'. |
65 | ;; `desktop-minor-mode-handlers' is an alist of functions to restore | |
66 | ;; non-standard minor modes. Elements must have the form | |
be617bbf | 67 | ;; |
0f4804e7 | 68 | ;; (MINOR-MODE . RESTORE-FUNCTION). |
be617bbf | 69 | ;; |
0f4804e7 LH |
70 | ;; Functions are called by `desktop-create-buffer' to restore minor modes. |
71 | ;; Minor modes not specified here, are restored by the standard minor mode | |
72 | ;; function. If you write a module that defines a major or minor mode that | |
73 | ;; needs a special handler, then place code like | |
74 | ||
75 | ;; (defun foo-restore-desktop-buffer | |
76 | ;; ... | |
77 | ;; (add-to-list 'desktop-buffer-mode-handlers | |
78 | ;; '(foo-mode . foo-restore-desktop-buffer)) | |
79 | ||
80 | ;; or | |
81 | ||
82 | ;; (defun bar-desktop-restore | |
83 | ;; ... | |
84 | ;; (add-to-list 'desktop-minor-mode-handlers | |
85 | ;; '(bar-mode . bar-desktop-restore)) | |
86 | ||
87 | ;; in the module itself, and make shure that the mode function is | |
341c2f07 | 88 | ;; autoloaded. See the docstrings of `desktop-buffer-mode-handlers' and |
0f4804e7 LH |
89 | ;; `desktop-minor-mode-handlers' for more info. |
90 | ||
91 | ;; Minor modes. | |
92 | ;; ------------ | |
93 | ;; Conventional minor modes (see node "Minor Mode Conventions" in the elisp | |
94 | ;; manual) are handled in the following way: | |
95 | ;; When `desktop-save' saves the state of a buffer to the desktop file, it | |
96 | ;; saves as `desktop-minor-modes' the list of names of those variables in | |
97 | ;; `minor-mode-alist' that have a non-nil value. | |
98 | ;; When `desktop-create' restores the buffer, each of the symbols in | |
99 | ;; `desktop-minor-modes' is called as function with parameter 1. | |
100 | ;; The variables `desktop-minor-mode-table' and `desktop-minor-mode-handlers' | |
101 | ;; are used to handle non-conventional minor modes. `desktop-save' uses | |
102 | ;; `desktop-minor-mode-table' to map minor mode variables to minor mode | |
341c2f07 | 103 | ;; functions before writing `desktop-minor-modes'. If a minor mode has a |
0f4804e7 LH |
104 | ;; variable name that is different form its function name, an entry |
105 | ||
106 | ;; (NAME RESTORE-FUNCTION) | |
107 | ||
108 | ;; should be added to `desktop-minor-mode-table'. If a minor mode should not | |
109 | ;; be restored, RESTORE-FUNCTION should be set to nil. `desktop-create' uses | |
110 | ;; `desktop-minor-mode-handlers' to lookup minor modes that needs a restore | |
111 | ;; function different from the usual minor mode function. | |
112 | ;; --------------------------------------------------------------------------- | |
47640244 | 113 | |
ec4c6f22 RS |
114 | ;; By the way: don't use desktop.el to customize Emacs -- the file .emacs |
115 | ;; in your home directory is used for that. Saving global default values | |
116 | ;; for buffers is an example of misuse. | |
117 | ||
0b9bd504 RS |
118 | ;; PLEASE NOTE: The kill ring can be saved as specified by the variable |
119 | ;; `desktop-globals-to-save' (by default it isn't). This may result in saving | |
120 | ;; things you did not mean to keep. Use M-x desktop-clear RET. | |
ec4c6f22 | 121 | |
fa379636 KH |
122 | ;; Thanks to hetrick@phys.uva.nl (Jim Hetrick) for useful ideas. |
123 | ;; avk@rtsg.mot.com (Andrew V. Klein) for a dired tip. | |
124 | ;; chris@tecc.co.uk (Chris Boucher) for a mark tip. | |
125 | ;; f89-kam@nada.kth.se (Klas Mellbourn) for a mh-e tip. | |
126 | ;; kifer@sbkifer.cs.sunysb.edu (M. Kifer) for a bug hunt. | |
f4c73d07 | 127 | ;; treese@lcs.mit.edu (Win Treese) for ange-ftp tips. |
253406b9 | 128 | ;; pot@cnuce.cnr.it (Francesco Potorti`) for misc. tips. |
0b9bd504 RS |
129 | ;; --------------------------------------------------------------------------- |
130 | ;; TODO: | |
131 | ;; | |
132 | ;; Save window configuration. | |
133 | ;; Recognize more minor modes. | |
134 | ;; Save mark rings. | |
6343ed61 RS |
135 | |
136 | ;;; Code: | |
137 | ||
4a2fce7a | 138 | (defvar desktop-file-version "206" |
6b61353c | 139 | "Version number of desktop file format. |
4a2fce7a RS |
140 | Written into the desktop file and used at desktop read to provide |
141 | backward compatibility.") | |
142 | ||
ec4c6f22 | 143 | ;; ---------------------------------------------------------------------------- |
0b9bd504 RS |
144 | ;; USER OPTIONS -- settings you might want to play with. |
145 | ;; ---------------------------------------------------------------------------- | |
bbf5eb28 RS |
146 | |
147 | (defgroup desktop nil | |
148 | "Save status of Emacs when you exit." | |
149 | :group 'frames) | |
150 | ||
6b61353c KH |
151 | ;;;###autoload |
152 | (define-minor-mode desktop-save-mode | |
153 | "Toggle desktop saving mode. | |
154 | With numeric ARG, turn desktop saving on if ARG is positive, off | |
11425834 LH |
155 | otherwise. If desktop saving is turned on, the state of Emacs is |
156 | saved from one session to another. See variable `desktop-save' | |
157 | and function `desktop-read' for details." | |
6b61353c KH |
158 | :global t |
159 | :group 'desktop) | |
160 | ||
161 | ;; Maintained for backward compatibility | |
b89c5a72 JB |
162 | (define-obsolete-variable-alias 'desktop-enable |
163 | 'desktop-save-mode "22.1") | |
813dbb2d | 164 | |
e88110db JB |
165 | (defun desktop-save-mode-off () |
166 | "Disable `desktop-save-mode'. Provided for use in hooks." | |
167 | (desktop-save-mode 0)) | |
168 | ||
4a2fce7a | 169 | (defcustom desktop-save 'ask-if-new |
6b61353c KH |
170 | "*Specifies whether the desktop should be saved when it is killed. |
171 | A desktop is killed when the user changes desktop or quits Emacs. | |
172 | Possible values are: | |
4a2fce7a RS |
173 | t -- always save. |
174 | ask -- always ask. | |
175 | ask-if-new -- ask if no desktop file exists, otherwise just save. | |
176 | ask-if-exists -- ask if desktop file exists, otherwise don't save. | |
177 | if-exists -- save if desktop file exists, otherwise don't save. | |
178 | nil -- never save. | |
6b61353c | 179 | The desktop is never saved when `desktop-save-mode' is nil. |
cc8b76bf | 180 | The variables `desktop-dirname' and `desktop-base-file-name' |
6b61353c | 181 | determine where the desktop is saved." |
11425834 LH |
182 | :type |
183 | '(choice | |
4a2fce7a RS |
184 | (const :tag "Always save" t) |
185 | (const :tag "Always ask" ask) | |
186 | (const :tag "Ask if desktop file is new, else do save" ask-if-new) | |
187 | (const :tag "Ask if desktop file exists, else don't save" ask-if-exists) | |
188 | (const :tag "Save if desktop file exists, else don't" if-exists) | |
189 | (const :tag "Never save" nil)) | |
af61551b | 190 | :group 'desktop |
bf247b6e | 191 | :version "22.1") |
4a2fce7a | 192 | |
1f7efe1b JB |
193 | (defcustom desktop-load-locked-desktop 'ask |
194 | "Specifies whether the desktop should be loaded if locked. | |
195 | Possible values are: | |
196 | t -- load anyway. | |
197 | nil -- don't load. | |
198 | ask -- ask the user. | |
199 | If the value is nil, or `ask' and the user chooses not to load the desktop, | |
200 | the normal hook `desktop-not-loaded-hook' is run." | |
201 | :type | |
202 | '(choice | |
203 | (const :tag "Load anyway" t) | |
204 | (const :tag "Don't load" nil) | |
205 | (const :tag "Ask the user" ask)) | |
206 | :group 'desktop | |
8f3f313d | 207 | :version "22.2") |
1f7efe1b | 208 | |
4a2fce7a | 209 | (defcustom desktop-base-file-name |
fc715501 | 210 | (convert-standard-filename ".emacs.desktop") |
6b61353c | 211 | "Name of file for Emacs desktop, excluding the directory part." |
813dbb2d RS |
212 | :type 'file |
213 | :group 'desktop) | |
b89c5a72 JB |
214 | (define-obsolete-variable-alias 'desktop-basefilename |
215 | 'desktop-base-file-name "22.1") | |
6343ed61 | 216 | |
e88110db JB |
217 | (defcustom desktop-base-lock-name |
218 | (convert-standard-filename ".emacs.desktop.lock") | |
219 | "Name of lock file for Emacs desktop, excluding the directory part." | |
220 | :type 'file | |
221 | :group 'desktop | |
8f3f313d | 222 | :version "22.2") |
e88110db | 223 | |
4a2fce7a RS |
224 | (defcustom desktop-path '("." "~") |
225 | "List of directories to search for the desktop file. | |
226 | The base name of the file is specified in `desktop-base-file-name'." | |
227 | :type '(repeat directory) | |
af61551b | 228 | :group 'desktop |
bf247b6e | 229 | :version "22.1") |
4a2fce7a | 230 | |
bbf5eb28 | 231 | (defcustom desktop-missing-file-warning nil |
6c27fdb9 | 232 | "If non-nil, offer to recreate the buffer of a deleted file. |
ebb39555 LH |
233 | Also pause for a moment to display message about errors signaled in |
234 | `desktop-buffer-mode-handlers'. | |
235 | ||
236 | If nil, just print error messages in the message buffer." | |
bbf5eb28 | 237 | :type 'boolean |
af61551b | 238 | :group 'desktop |
bf247b6e | 239 | :version "22.1") |
6343ed61 | 240 | |
4a2fce7a | 241 | (defcustom desktop-no-desktop-file-hook nil |
6b61353c | 242 | "Normal hook run when `desktop-read' can't find a desktop file. |
11425834 | 243 | Run in the directory in which the desktop file was sought. |
8649a87b | 244 | May be used to show a dired buffer." |
4a2fce7a | 245 | :type 'hook |
af61551b | 246 | :group 'desktop |
bf247b6e | 247 | :version "22.1") |
4a2fce7a | 248 | |
e88110db JB |
249 | (defcustom desktop-not-loaded-hook nil |
250 | "Normal hook run when the user declines to re-use a desktop file. | |
251 | Run in the directory in which the desktop file was found. | |
252 | May be used to deal with accidental multiple Emacs jobs." | |
253 | :type 'hook | |
254 | :group 'desktop | |
255 | :options '(desktop-save-mode-off save-buffers-kill-emacs) | |
8f3f313d | 256 | :version "22.2") |
e88110db | 257 | |
4a2fce7a | 258 | (defcustom desktop-after-read-hook nil |
6b61353c | 259 | "Normal hook run after a successful `desktop-read'. |
8649a87b | 260 | May be used to show a buffer list." |
4a2fce7a | 261 | :type 'hook |
af61551b | 262 | :group 'desktop |
11425834 | 263 | :options '(list-buffers) |
bf247b6e | 264 | :version "22.1") |
4a2fce7a RS |
265 | |
266 | (defcustom desktop-save-hook nil | |
6b61353c | 267 | "Normal hook run before the desktop is saved in a desktop file. |
11425834 LH |
268 | Run with the desktop buffer current with only the header present. |
269 | May be used to add to the desktop code or to truncate history lists, | |
270 | for example." | |
4a2fce7a RS |
271 | :type 'hook |
272 | :group 'desktop) | |
273 | ||
340db502 LH |
274 | (defcustom desktop-globals-to-save |
275 | '(desktop-missing-file-warning | |
276 | tags-file-name | |
277 | tags-table-list | |
278 | search-ring | |
279 | regexp-search-ring | |
280 | register-alist) | |
6b61353c KH |
281 | "List of global variables saved by `desktop-save'. |
282 | An element may be variable name (a symbol) or a cons cell of the form | |
283 | \(VAR . MAX-SIZE), which means to truncate VAR's value to at most | |
284 | MAX-SIZE elements (if the value is a list) before saving the value. | |
4a2fce7a RS |
285 | Feature: Saving `kill-ring' implies saving `kill-ring-yank-pointer'." |
286 | :type '(repeat (restricted-sexp :match-alternatives (symbolp consp))) | |
287 | :group 'desktop) | |
288 | ||
340db502 LH |
289 | (defcustom desktop-globals-to-clear |
290 | '(kill-ring | |
291 | kill-ring-yank-pointer | |
292 | search-ring | |
293 | search-ring-yank-pointer | |
294 | regexp-search-ring | |
295 | regexp-search-ring-yank-pointer) | |
150f39ee | 296 | "List of global variables that `desktop-clear' will clear. |
4a2fce7a | 297 | An element may be variable name (a symbol) or a cons cell of the form |
cc8b76bf JB |
298 | \(VAR . FORM). Symbols are set to nil and for cons cells VAR is set |
299 | to the value obtained by evaluating FORM." | |
4a2fce7a | 300 | :type '(repeat (restricted-sexp :match-alternatives (symbolp consp))) |
af61551b | 301 | :group 'desktop |
bf247b6e | 302 | :version "22.1") |
4a2fce7a | 303 | |
0f4804e7 LH |
304 | (defcustom desktop-clear-preserve-buffers |
305 | '("\\*scratch\\*" "\\*Messages\\*" "\\*server\\*" "\\*tramp/.+\\*") | |
306 | "*List of buffers that `desktop-clear' should not delete. | |
307 | Each element is a regular expression. Buffers with a name matched by any of | |
308 | these won't be deleted." | |
4a2fce7a RS |
309 | :type '(repeat string) |
310 | :group 'desktop) | |
340db502 | 311 | |
0f4804e7 | 312 | ;;;###autoload |
340db502 LH |
313 | (defcustom desktop-locals-to-save |
314 | '(desktop-locals-to-save ; Itself! Think it over. | |
315 | truncate-lines | |
316 | case-fold-search | |
317 | case-replace | |
318 | fill-column | |
319 | overwrite-mode | |
320 | change-log-default-name | |
321 | line-number-mode | |
0f4804e7 LH |
322 | column-number-mode |
323 | size-indication-mode | |
324 | buffer-file-coding-system | |
325 | indent-tabs-mode | |
11425834 | 326 | tab-width |
0f4804e7 LH |
327 | indicate-buffer-boundaries |
328 | indicate-empty-lines | |
329 | show-trailing-whitespace) | |
577ed2b2 | 330 | "List of local variables to save for each buffer. |
0f4804e7 LH |
331 | The variables are saved only when they really are local. Conventional minor |
332 | modes are restored automatically; they should not be listed here." | |
6b61353c KH |
333 | :type '(repeat symbol) |
334 | :group 'desktop) | |
ec4c6f22 | 335 | |
0b9bd504 | 336 | ;; We skip .log files because they are normally temporary. |
a7acbbe4 | 337 | ;; (ftp) files because they require passwords and whatnot. |
bbf5eb28 | 338 | (defcustom desktop-buffers-not-to-save |
df410295 | 339 | "\\(^nn\\.a[0-9]+\\|\\.log\\|(ftp)\\)$" |
4a2fce7a RS |
340 | "Regexp identifying buffers that are to be excluded from saving." |
341 | :type 'regexp | |
342 | :group 'desktop) | |
6343ed61 | 343 | |
6b61353c | 344 | ;; Skip tramp and ange-ftp files |
bbf5eb28 | 345 | (defcustom desktop-files-not-to-save |
fa379636 | 346 | "^/[^/:]*:" |
bbf5eb28 RS |
347 | "Regexp identifying files whose buffers are to be excluded from saving." |
348 | :type 'regexp | |
349 | :group 'desktop) | |
fa379636 | 350 | |
df410295 JL |
351 | ;; We skip TAGS files to save time (tags-file-name is saved instead). |
352 | (defcustom desktop-modes-not-to-save | |
353 | '(tags-table-mode) | |
80f9f3db SM |
354 | "List of major modes whose buffers should not be saved." |
355 | :type '(repeat symbol) | |
356 | :group 'desktop) | |
357 | ||
4a2fce7a RS |
358 | (defcustom desktop-file-name-format 'absolute |
359 | "*Format in which desktop file names should be saved. | |
360 | Possible values are: | |
361 | absolute -- Absolute file name. | |
362 | tilde -- Relative to ~. | |
363 | local -- Relative to directory of desktop file." | |
364 | :type '(choice (const absolute) (const tilde) (const local)) | |
af61551b | 365 | :group 'desktop |
bf247b6e | 366 | :version "22.1") |
569c754e | 367 | |
150f39ee LH |
368 | (defcustom desktop-restore-eager t |
369 | "Number of buffers to restore immediately. | |
370 | Remaining buffers are restored lazily (when Emacs is idle). | |
371 | If value is t, all buffers are restored immediately." | |
0ba9bc53 | 372 | :type '(choice (const t) integer) |
150f39ee | 373 | :group 'desktop |
bf247b6e | 374 | :version "22.1") |
150f39ee LH |
375 | |
376 | (defcustom desktop-lazy-verbose t | |
377 | "Verbose reporting of lazily created buffers." | |
378 | :type 'boolean | |
379 | :group 'desktop | |
bf247b6e | 380 | :version "22.1") |
150f39ee LH |
381 | |
382 | (defcustom desktop-lazy-idle-delay 5 | |
383 | "Idle delay before starting to create buffers. | |
384 | See `desktop-restore-eager'." | |
385 | :type 'integer | |
386 | :group 'desktop | |
bf247b6e | 387 | :version "22.1") |
150f39ee | 388 | |
e5780ae1 | 389 | ;;;###autoload |
ebb39555 LH |
390 | (defvar desktop-save-buffer nil |
391 | "When non-nil, save buffer status in desktop file. | |
e5780ae1 | 392 | This variable becomes buffer local when set. |
ebb39555 | 393 | |
b89c5a72 JB |
394 | If the value is a function, it is called by `desktop-save' with argument |
395 | DESKTOP-DIRNAME to obtain auxiliary information to save in the desktop | |
ebb39555 | 396 | file along with the state of the buffer for which it was called. |
b6b70cda | 397 | |
6b61353c | 398 | When file names are returned, they should be formatted using the call |
e5780ae1 | 399 | \"(desktop-file-name FILE-NAME DESKTOP-DIRNAME)\". |
4a2fce7a | 400 | |
0f4804e7 LH |
401 | Later, when `desktop-read' evaluates the desktop file, auxiliary information |
402 | is passed as the argument DESKTOP-BUFFER-MISC to functions in | |
403 | `desktop-buffer-mode-handlers'.") | |
ebb39555 LH |
404 | (make-variable-buffer-local 'desktop-save-buffer) |
405 | (make-obsolete-variable 'desktop-buffer-modes-to-save | |
cc8b76bf | 406 | 'desktop-save-buffer "22.1") |
e5780ae1 | 407 | (make-obsolete-variable 'desktop-buffer-misc-functions |
cc8b76bf | 408 | 'desktop-save-buffer "22.1") |
b6b70cda | 409 | |
0f4804e7 LH |
410 | ;;;###autoload |
411 | (defvar desktop-buffer-mode-handlers | |
412 | nil | |
e5780ae1 | 413 | "Alist of major mode specific functions to restore a desktop buffer. |
0f4804e7 LH |
414 | Functions listed are called by `desktop-create-buffer' when `desktop-read' |
415 | evaluates the desktop file. List elements must have the form | |
416 | ||
417 | (MAJOR-MODE . RESTORE-BUFFER-FUNCTION). | |
e5780ae1 LH |
418 | |
419 | Buffers with a major mode not specified here, are restored by the default | |
420 | handler `desktop-restore-file-buffer'. | |
421 | ||
55775448 | 422 | Handlers are called with argument list |
4a2fce7a | 423 | |
9bcabb45 | 424 | (DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC) |
e5780ae1 LH |
425 | |
426 | Furthermore, they may use the following variables: | |
4a2fce7a RS |
427 | |
428 | desktop-file-version | |
4a2fce7a RS |
429 | desktop-buffer-major-mode |
430 | desktop-buffer-minor-modes | |
431 | desktop-buffer-point | |
432 | desktop-buffer-mark | |
433 | desktop-buffer-read-only | |
4a2fce7a RS |
434 | desktop-buffer-locals |
435 | ||
e5780ae1 | 436 | If a handler returns a buffer, then the saved mode settings |
0f4804e7 LH |
437 | and variable values for that buffer are copied into it. |
438 | ||
439 | Modules that define a major mode that needs a special handler should contain | |
440 | code like | |
ec4c6f22 | 441 | |
0f4804e7 LH |
442 | (defun foo-restore-desktop-buffer |
443 | ... | |
444 | (add-to-list 'desktop-buffer-mode-handlers | |
445 | '(foo-mode . foo-restore-desktop-buffer)) | |
446 | ||
447 | Furthermore the major mode function must be autoloaded.") | |
ec4c6f22 | 448 | |
498eb267 | 449 | ;;;###autoload |
e5780ae1 LH |
450 | (put 'desktop-buffer-mode-handlers 'risky-local-variable t) |
451 | (make-obsolete-variable 'desktop-buffer-handlers | |
cc8b76bf | 452 | 'desktop-buffer-mode-handlers "22.1") |
b6b70cda | 453 | |
47640244 GM |
454 | (defcustom desktop-minor-mode-table |
455 | '((auto-fill-function auto-fill-mode) | |
5fff0265 | 456 | (vc-mode nil) |
f2168a4c MO |
457 | (vc-dired-mode nil) |
458 | (erc-track-minor-mode nil)) | |
47640244 GM |
459 | "Table mapping minor mode variables to minor mode functions. |
460 | Each entry has the form (NAME RESTORE-FUNCTION). | |
461 | NAME is the name of the buffer-local variable indicating that the minor | |
462 | mode is active. RESTORE-FUNCTION is the function to activate the minor mode. | |
7d6ee4df | 463 | RESTORE-FUNCTION nil means don't try to restore the minor mode. |
47640244 | 464 | Only minor modes for which the name of the buffer-local variable |
7bfa55b3 | 465 | and the name of the minor mode function are different have to be added to |
0f4804e7 | 466 | this table. See also `desktop-minor-mode-handlers'." |
47640244 GM |
467 | :type 'sexp |
468 | :group 'desktop) | |
469 | ||
0f4804e7 LH |
470 | ;;;###autoload |
471 | (defvar desktop-minor-mode-handlers | |
472 | nil | |
473 | "Alist of functions to restore non-standard minor modes. | |
474 | Functions are called by `desktop-create-buffer' to restore minor modes. | |
475 | List elements must have the form | |
476 | ||
477 | (MINOR-MODE . RESTORE-FUNCTION). | |
478 | ||
479 | Minor modes not specified here, are restored by the standard minor mode | |
480 | function. | |
481 | ||
482 | Handlers are called with argument list | |
483 | ||
484 | (DESKTOP-BUFFER-LOCALS) | |
485 | ||
486 | Furthermore, they may use the following variables: | |
487 | ||
488 | desktop-file-version | |
489 | desktop-buffer-file-name | |
490 | desktop-buffer-name | |
491 | desktop-buffer-major-mode | |
492 | desktop-buffer-minor-modes | |
493 | desktop-buffer-point | |
494 | desktop-buffer-mark | |
495 | desktop-buffer-read-only | |
496 | desktop-buffer-misc | |
497 | ||
498 | When a handler is called, the buffer has been created and the major mode has | |
499 | been set, but local variables listed in desktop-buffer-locals has not yet been | |
500 | created and set. | |
501 | ||
502 | Modules that define a minor mode that needs a special handler should contain | |
503 | code like | |
504 | ||
505 | (defun foo-desktop-restore | |
506 | ... | |
507 | (add-to-list 'desktop-minor-mode-handlers | |
508 | '(foo-mode . foo-desktop-restore)) | |
509 | ||
510 | Furthermore the minor mode function must be autoloaded. | |
511 | ||
512 | See also `desktop-minor-mode-table'.") | |
513 | ||
498eb267 | 514 | ;;;###autoload |
0f4804e7 LH |
515 | (put 'desktop-minor-mode-handlers 'risky-local-variable t) |
516 | ||
0b9bd504 RS |
517 | ;; ---------------------------------------------------------------------------- |
518 | (defvar desktop-dirname nil | |
6b61353c | 519 | "The directory in which the desktop file should be saved.") |
6343ed61 | 520 | |
11425834 LH |
521 | (defun desktop-full-file-name (&optional dirname) |
522 | "Return the full name of the desktop file in DIRNAME. | |
523 | DIRNAME omitted or nil means use `desktop-dirname'." | |
524 | (expand-file-name desktop-base-file-name (or dirname desktop-dirname))) | |
525 | ||
e88110db JB |
526 | (defun desktop-full-lock-name (&optional dirname) |
527 | "Return the full name of the desktop lock file in DIRNAME. | |
528 | DIRNAME omitted or nil means use `desktop-dirname'." | |
529 | (expand-file-name desktop-base-lock-name (or dirname desktop-dirname))) | |
530 | ||
6343ed61 | 531 | (defconst desktop-header |
0b9bd504 RS |
532 | ";; -------------------------------------------------------------------------- |
533 | ;; Desktop File for Emacs | |
534 | ;; -------------------------------------------------------------------------- | |
6343ed61 | 535 | " "*Header to place in Desktop file.") |
de9e2828 RS |
536 | |
537 | (defvar desktop-delay-hook nil | |
538 | "Hooks run after all buffers are loaded; intended for internal use.") | |
813dbb2d | 539 | |
e88110db JB |
540 | ;; ---------------------------------------------------------------------------- |
541 | ;; Desktop file conflict detection | |
542 | (defvar desktop-file-modtime nil | |
543 | "When the desktop file was last modified to the knowledge of this Emacs. | |
544 | Used to detect desktop file conflicts.") | |
545 | ||
546 | (defun desktop-owner (&optional dirname) | |
547 | "Return the PID of the Emacs process that owns the desktop file in DIRNAME. | |
548 | Return nil if no desktop file found or no Emacs process is using it. | |
549 | DIRNAME omitted or nil means use `desktop-dirname'." | |
550 | (let (owner) | |
551 | (and (file-exists-p (desktop-full-lock-name dirname)) | |
552 | (condition-case nil | |
553 | (with-temp-buffer | |
554 | (insert-file-contents-literally (desktop-full-lock-name dirname)) | |
555 | (goto-char (point-min)) | |
556 | (setq owner (read (current-buffer))) | |
557 | (integerp owner)) | |
558 | (error nil)) | |
559 | owner))) | |
560 | ||
561 | (defun desktop-claim-lock (&optional dirname) | |
562 | "Record this Emacs process as the owner of the desktop file in DIRNAME. | |
563 | DIRNAME omitted or nil means use `desktop-dirname'." | |
564 | (write-region (number-to-string (emacs-pid)) nil | |
565 | (desktop-full-lock-name dirname))) | |
566 | ||
567 | (defun desktop-release-lock (&optional dirname) | |
568 | "Remove the lock file for the desktop in DIRNAME. | |
569 | DIRNAME omitted or nil means use `desktop-dirname'." | |
570 | (let ((file (desktop-full-lock-name dirname))) | |
571 | (when (file-exists-p file) (delete-file file)))) | |
572 | ||
0b9bd504 | 573 | ;; ---------------------------------------------------------------------------- |
6b61353c | 574 | (defun desktop-truncate (list n) |
ec4c6f22 | 575 | "Truncate LIST to at most N elements destructively." |
6b61353c | 576 | (let ((here (nthcdr (1- n) list))) |
1f7efe1b JB |
577 | (when (consp here) |
578 | (setcdr here nil)))) | |
f9be4574 | 579 | |
4a2fce7a | 580 | ;; ---------------------------------------------------------------------------- |
11425834 | 581 | ;;;###autoload |
f9be4574 RS |
582 | (defun desktop-clear () |
583 | "Empty the Desktop. | |
0f4804e7 LH |
584 | This kills all buffers except for internal ones and those with names matched by |
585 | a regular expression in the list `desktop-clear-preserve-buffers'. | |
586 | Furthermore, it clears the variables listed in `desktop-globals-to-clear'." | |
6343ed61 | 587 | (interactive) |
150f39ee | 588 | (desktop-lazy-abort) |
4a2fce7a RS |
589 | (dolist (var desktop-globals-to-clear) |
590 | (if (symbolp var) | |
1f7efe1b | 591 | (eval `(setq-default ,var nil)) |
4a2fce7a | 592 | (eval `(setq-default ,(car var) ,(cdr var))))) |
0f4804e7 LH |
593 | (let ((buffers (buffer-list)) |
594 | (preserve-regexp (concat "^\\(" | |
595 | (mapconcat (lambda (regexp) | |
596 | (concat "\\(" regexp "\\)")) | |
597 | desktop-clear-preserve-buffers | |
598 | "\\|") | |
599 | "\\)$"))) | |
f9be4574 | 600 | (while buffers |
4a2fce7a RS |
601 | (let ((bufname (buffer-name (car buffers)))) |
602 | (or | |
603 | (null bufname) | |
0f4804e7 | 604 | (string-match preserve-regexp bufname) |
4a2fce7a | 605 | ;; Don't kill buffers made for internal purposes. |
3f32d6a3 | 606 | (and (not (equal bufname "")) (eq (aref bufname 0) ?\s)) |
4a2fce7a | 607 | (kill-buffer (car buffers)))) |
f9be4574 | 608 | (setq buffers (cdr buffers)))) |
b6105c76 | 609 | (delete-other-windows)) |
4a2fce7a | 610 | |
0b9bd504 | 611 | ;; ---------------------------------------------------------------------------- |
de9e2828 | 612 | (add-hook 'kill-emacs-hook 'desktop-kill) |
ec4c6f22 | 613 | |
6343ed61 | 614 | (defun desktop-kill () |
6b61353c | 615 | "If `desktop-save-mode' is non-nil, do what `desktop-save' says to do. |
4a2fce7a RS |
616 | If the desktop should be saved and `desktop-dirname' |
617 | is nil, ask the user where to save the desktop." | |
11425834 LH |
618 | (when (and desktop-save-mode |
619 | (let ((exists (file-exists-p (desktop-full-file-name)))) | |
620 | (or (eq desktop-save t) | |
621 | (and exists (memq desktop-save '(ask-if-new if-exists))) | |
622 | (and | |
623 | (or (memq desktop-save '(ask ask-if-new)) | |
624 | (and exists (eq desktop-save 'ask-if-exists))) | |
625 | (y-or-n-p "Save desktop? "))))) | |
4a2fce7a RS |
626 | (unless desktop-dirname |
627 | (setq desktop-dirname | |
11425834 LH |
628 | (file-name-as-directory |
629 | (expand-file-name | |
794855ca | 630 | (read-directory-name "Directory for desktop file: " nil nil t))))) |
4a2fce7a | 631 | (condition-case err |
e88110db | 632 | (desktop-save desktop-dirname t) |
4a2fce7a | 633 | (file-error |
11425834 | 634 | (unless (yes-or-no-p "Error while saving the desktop. Ignore? ") |
e88110db JB |
635 | (signal (car err) (cdr err)))))) |
636 | ;; If we own it, we don't anymore. | |
637 | (when (eq (emacs-pid) (desktop-owner)) (desktop-release-lock))) | |
4a2fce7a | 638 | |
0b9bd504 | 639 | ;; ---------------------------------------------------------------------------- |
ed2f7fc8 RS |
640 | (defun desktop-list* (&rest args) |
641 | (if (null (cdr args)) | |
642 | (car args) | |
643 | (setq args (nreverse args)) | |
644 | (let ((value (cons (nth 1 args) (car args)))) | |
645 | (setq args (cdr (cdr args))) | |
646 | (while args | |
647 | (setq value (cons (car args) value)) | |
648 | (setq args (cdr args))) | |
649 | value))) | |
650 | ||
e88110db JB |
651 | ;; ---------------------------------------------------------------------------- |
652 | (defun desktop-buffer-info (buffer) | |
653 | (set-buffer buffer) | |
654 | (list | |
a8049a30 JB |
655 | ;; base name of the buffer; replaces the buffer name if managed by uniquify |
656 | (and (fboundp 'uniquify-buffer-base-name) (uniquify-buffer-base-name)) | |
e88110db | 657 | ;; basic information |
9e29c91c | 658 | (desktop-file-name (buffer-file-name) desktop-dirname) |
a8049a30 | 659 | (buffer-name) |
e88110db JB |
660 | major-mode |
661 | ;; minor modes | |
662 | (let (ret) | |
663 | (mapc | |
664 | #'(lambda (minor-mode) | |
665 | (and (boundp minor-mode) | |
666 | (symbol-value minor-mode) | |
667 | (let* ((special (assq minor-mode desktop-minor-mode-table)) | |
668 | (value (cond (special (cadr special)) | |
669 | ((functionp minor-mode) minor-mode)))) | |
670 | (when value (add-to-list 'ret value))))) | |
671 | (mapcar #'car minor-mode-alist)) | |
672 | ret) | |
673 | ;; point and mark, and read-only status | |
674 | (point) | |
675 | (list (mark t) mark-active) | |
676 | buffer-read-only | |
677 | ;; auxiliary information | |
678 | (when (functionp desktop-save-buffer) | |
9e29c91c | 679 | (funcall desktop-save-buffer desktop-dirname)) |
e88110db JB |
680 | ;; local variables |
681 | (let ((locals desktop-locals-to-save) | |
682 | (loclist (buffer-local-variables)) | |
683 | (ll)) | |
684 | (while locals | |
685 | (let ((here (assq (car locals) loclist))) | |
686 | (if here | |
687 | (setq ll (cons here ll)) | |
688 | (when (member (car locals) loclist) | |
689 | (setq ll (cons (car locals) ll))))) | |
690 | (setq locals (cdr locals))) | |
691 | ll))) | |
692 | ||
4a2fce7a | 693 | ;; ---------------------------------------------------------------------------- |
6b61353c | 694 | (defun desktop-internal-v2s (value) |
577ed2b2 RS |
695 | "Convert VALUE to a pair (QUOTE . TXT); (eval (read TXT)) gives VALUE. |
696 | TXT is a string that when read and evaluated yields value. | |
697 | QUOTE may be `may' (value may be quoted), | |
698 | `must' (values must be quoted), or nil (value may not be quoted)." | |
de9e2828 | 699 | (cond |
1f7efe1b JB |
700 | ((or (numberp value) (null value) (eq t value) (keywordp value)) |
701 | (cons 'may (prin1-to-string value))) | |
702 | ((stringp value) | |
703 | (let ((copy (copy-sequence value))) | |
704 | (set-text-properties 0 (length copy) nil copy) | |
705 | ;; Get rid of text properties because we cannot read them | |
706 | (cons 'may (prin1-to-string copy)))) | |
707 | ((symbolp value) | |
708 | (cons 'must (prin1-to-string value))) | |
709 | ((vectorp value) | |
710 | (let* ((special nil) | |
711 | (pass1 (mapcar | |
712 | (lambda (el) | |
713 | (let ((res (desktop-internal-v2s el))) | |
714 | (if (null (car res)) | |
715 | (setq special t)) | |
716 | res)) | |
717 | value))) | |
718 | (if special | |
719 | (cons nil (concat "(vector " | |
720 | (mapconcat (lambda (el) | |
721 | (if (eq (car el) 'must) | |
722 | (concat "'" (cdr el)) | |
723 | (cdr el))) | |
724 | pass1 | |
725 | " ") | |
726 | ")")) | |
727 | (cons 'may (concat "[" (mapconcat 'cdr pass1 " ") "]"))))) | |
728 | ((consp value) | |
729 | (let ((p value) | |
730 | newlist | |
731 | use-list* | |
732 | anynil) | |
733 | (while (consp p) | |
734 | (let ((q.txt (desktop-internal-v2s (car p)))) | |
735 | (or anynil (setq anynil (null (car q.txt)))) | |
736 | (setq newlist (cons q.txt newlist))) | |
737 | (setq p (cdr p))) | |
738 | (if p | |
739 | (let ((last (desktop-internal-v2s p))) | |
740 | (or anynil (setq anynil (null (car last)))) | |
741 | (or anynil | |
742 | (setq newlist (cons '(must . ".") newlist))) | |
743 | (setq use-list* t) | |
744 | (setq newlist (cons last newlist)))) | |
745 | (setq newlist (nreverse newlist)) | |
746 | (if anynil | |
747 | (cons nil | |
748 | (concat (if use-list* "(desktop-list* " "(list ") | |
749 | (mapconcat (lambda (el) | |
750 | (if (eq (car el) 'must) | |
751 | (concat "'" (cdr el)) | |
752 | (cdr el))) | |
753 | newlist | |
754 | " ") | |
755 | ")")) | |
756 | (cons 'must | |
757 | (concat "(" (mapconcat 'cdr newlist " ") ")"))))) | |
758 | ((subrp value) | |
759 | (cons nil (concat "(symbol-function '" | |
760 | (substring (prin1-to-string value) 7 -1) | |
761 | ")"))) | |
762 | ((markerp value) | |
763 | (let ((pos (prin1-to-string (marker-position value))) | |
764 | (buf (prin1-to-string (buffer-name (marker-buffer value))))) | |
765 | (cons nil (concat "(let ((mk (make-marker)))" | |
766 | " (add-hook 'desktop-delay-hook" | |
767 | " (list 'lambda '() (list 'set-marker mk " | |
768 | pos " (get-buffer " buf ")))) mk)")))) | |
769 | (t ; save as text | |
770 | (cons 'may "\"Unprintable entity\"")))) | |
de9e2828 | 771 | |
4a2fce7a | 772 | ;; ---------------------------------------------------------------------------- |
6b61353c | 773 | (defun desktop-value-to-string (value) |
577ed2b2 RS |
774 | "Convert VALUE to a string that when read evaluates to the same value. |
775 | Not all types of values are supported." | |
de9e2828 RS |
776 | (let* ((print-escape-newlines t) |
777 | (float-output-format nil) | |
6b61353c | 778 | (quote.txt (desktop-internal-v2s value)) |
de9e2828 RS |
779 | (quote (car quote.txt)) |
780 | (txt (cdr quote.txt))) | |
781 | (if (eq quote 'must) | |
782 | (concat "'" txt) | |
783 | txt))) | |
4a2fce7a | 784 | |
ec4c6f22 | 785 | ;; ---------------------------------------------------------------------------- |
0e7c8611 RS |
786 | (defun desktop-outvar (varspec) |
787 | "Output a setq statement for variable VAR to the desktop file. | |
788 | The argument VARSPEC may be the variable name VAR (a symbol), | |
be617bbf | 789 | or a cons cell of the form (VAR . MAX-SIZE), |
0e7c8611 RS |
790 | which means to truncate VAR's value to at most MAX-SIZE elements |
791 | \(if the value is a list) before saving the value." | |
792 | (let (var size) | |
793 | (if (consp varspec) | |
794 | (setq var (car varspec) size (cdr varspec)) | |
795 | (setq var varspec)) | |
1f7efe1b JB |
796 | (when (boundp var) |
797 | (when (and (integerp size) | |
798 | (> size 0) | |
799 | (listp (eval var))) | |
800 | (desktop-truncate (eval var) size)) | |
801 | (insert "(setq " | |
802 | (symbol-name var) | |
803 | " " | |
804 | (desktop-value-to-string (symbol-value var)) | |
805 | ")\n")))) | |
4a2fce7a | 806 | |
0b9bd504 | 807 | ;; ---------------------------------------------------------------------------- |
ec4c6f22 | 808 | (defun desktop-save-buffer-p (filename bufname mode &rest dummy) |
ebb39555 | 809 | "Return t if buffer should have its state saved in the desktop file. |
0b9bd504 | 810 | FILENAME is the visited file name, BUFNAME is the buffer name, and |
be617bbf JB |
811 | MODE is the major mode. |
812 | \n\(fn FILENAME BUFNAME MODE)" | |
fa379636 | 813 | (let ((case-fold-search nil)) |
80f9f3db | 814 | (and (not (string-match desktop-buffers-not-to-save bufname)) |
ebb39555 LH |
815 | (not (memq mode desktop-modes-not-to-save)) |
816 | (or (and filename | |
817 | (not (string-match desktop-files-not-to-save filename))) | |
818 | (and (eq mode 'dired-mode) | |
819 | (with-current-buffer bufname | |
820 | (not (string-match desktop-files-not-to-save | |
821 | default-directory)))) | |
822 | (and (null filename) | |
823 | (with-current-buffer bufname desktop-save-buffer)))))) | |
4a2fce7a | 824 | |
0b9bd504 | 825 | ;; ---------------------------------------------------------------------------- |
4a2fce7a RS |
826 | (defun desktop-file-name (filename dirname) |
827 | "Convert FILENAME to format specified in `desktop-file-name-format'. | |
828 | DIRNAME must be the directory in which the desktop file will be saved." | |
829 | (cond | |
830 | ((not filename) nil) | |
831 | ((eq desktop-file-name-format 'tilde) | |
832 | (let ((relative-name (file-relative-name (expand-file-name filename) "~"))) | |
833 | (cond | |
834 | ((file-name-absolute-p relative-name) relative-name) | |
835 | ((string= "./" relative-name) "~/") | |
836 | ((string= "." relative-name) "~") | |
837 | (t (concat "~/" relative-name))))) | |
838 | ((eq desktop-file-name-format 'local) (file-relative-name filename dirname)) | |
839 | (t (expand-file-name filename)))) | |
e5714620 | 840 | |
b3615392 | 841 | |
4a2fce7a | 842 | ;; ---------------------------------------------------------------------------- |
11425834 | 843 | ;;;###autoload |
e88110db | 844 | (defun desktop-save (dirname &optional release) |
6b61353c KH |
845 | "Save the desktop in a desktop file. |
846 | Parameter DIRNAME specifies where to save the desktop file. | |
e88110db | 847 | Optional parameter RELEASE says whether we're done with this desktop. |
6b61353c | 848 | See also `desktop-base-file-name'." |
6343ed61 | 849 | (interactive "DDirectory to save desktop file in: ") |
e88110db | 850 | (setq desktop-dirname (file-name-as-directory (expand-file-name dirname))) |
6343ed61 | 851 | (save-excursion |
e88110db JB |
852 | (let ((eager desktop-restore-eager) |
853 | (new-modtime (nth 5 (file-attributes (desktop-full-file-name))))) | |
854 | (when | |
855 | (or (not new-modtime) ; nothing to overwrite | |
856 | (equal desktop-file-modtime new-modtime) | |
857 | (yes-or-no-p (if desktop-file-modtime | |
858 | (if (> (float-time new-modtime) (float-time desktop-file-modtime)) | |
859 | "Desktop file is more recent than the one loaded. Save anyway? " | |
860 | "Desktop file isn't the one loaded. Overwrite it? ") | |
861 | "Current desktop was not loaded from a file. Overwrite this desktop file? ")) | |
862 | (unless release (error "Desktop file conflict"))) | |
863 | ||
864 | ;; If we're done with it, release the lock. | |
865 | ;; Otherwise, claim it if it's unclaimed or if we created it. | |
866 | (if release | |
867 | (desktop-release-lock) | |
868 | (unless (and new-modtime (desktop-owner)) (desktop-claim-lock))) | |
869 | ||
870 | (with-temp-buffer | |
871 | (insert | |
872 | ";; -*- mode: emacs-lisp; coding: emacs-mule; -*-\n" | |
873 | desktop-header | |
874 | ";; Created " (current-time-string) "\n" | |
875 | ";; Desktop file format version " desktop-file-version "\n" | |
876 | ";; Emacs version " emacs-version "\n") | |
877 | (save-excursion (run-hooks 'desktop-save-hook)) | |
878 | (goto-char (point-max)) | |
879 | (insert "\n;; Global section:\n") | |
880 | (mapc (function desktop-outvar) desktop-globals-to-save) | |
881 | (when (memq 'kill-ring desktop-globals-to-save) | |
882 | (insert | |
883 | "(setq kill-ring-yank-pointer (nthcdr " | |
884 | (int-to-string (- (length kill-ring) (length kill-ring-yank-pointer))) | |
885 | " kill-ring))\n")) | |
886 | ||
887 | (insert "\n;; Buffer section -- buffers listed in same order as in buffer list:\n") | |
888 | (dolist (l (mapcar 'desktop-buffer-info (buffer-list))) | |
a8049a30 JB |
889 | (let ((base (pop l))) |
890 | (when (apply 'desktop-save-buffer-p l) | |
891 | (insert "(" | |
892 | (if (or (not (integerp eager)) | |
893 | (if (zerop eager) | |
894 | nil | |
895 | (setq eager (1- eager)))) | |
896 | "desktop-create-buffer" | |
897 | "desktop-append-buffer-args") | |
898 | " " | |
899 | desktop-file-version) | |
ae4370a8 JB |
900 | ;; If there's a non-empty base name, we save it instead of the buffer name |
901 | (when (and base (not (string= base ""))) | |
902 | (setcar (nthcdr 1 l) base)) | |
a8049a30 JB |
903 | (dolist (e l) |
904 | (insert "\n " (desktop-value-to-string e))) | |
905 | (insert ")\n\n")))) | |
e88110db | 906 | |
9e29c91c | 907 | (setq default-directory desktop-dirname) |
e88110db JB |
908 | (let ((coding-system-for-write 'emacs-mule)) |
909 | (write-region (point-min) (point-max) (desktop-full-file-name) nil 'nomessage)) | |
910 | ;; We remember when it was modified (which is presumably just now). | |
911 | (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name))))))))) | |
4a2fce7a | 912 | |
0b9bd504 | 913 | ;; ---------------------------------------------------------------------------- |
11425834 | 914 | ;;;###autoload |
6343ed61 | 915 | (defun desktop-remove () |
6b61353c KH |
916 | "Delete desktop file in `desktop-dirname'. |
917 | This function also sets `desktop-dirname' to nil." | |
6343ed61 | 918 | (interactive) |
6b61353c | 919 | (when desktop-dirname |
11425834 | 920 | (let ((filename (desktop-full-file-name))) |
6b61353c KH |
921 | (setq desktop-dirname nil) |
922 | (when (file-exists-p filename) | |
73b0b745 | 923 | (delete-file filename))))) |
6b61353c | 924 | |
150f39ee LH |
925 | (defvar desktop-buffer-args-list nil |
926 | "List of args for `desktop-create-buffer'.") | |
927 | ||
928 | (defvar desktop-lazy-timer nil) | |
929 | ||
0b9bd504 | 930 | ;; ---------------------------------------------------------------------------- |
478653c9 | 931 | ;;;###autoload |
6b61353c KH |
932 | (defun desktop-read (&optional dirname) |
933 | "Read and process the desktop file in directory DIRNAME. | |
934 | Look for a desktop file in DIRNAME, or if DIRNAME is omitted, look in | |
935 | directories listed in `desktop-path'. If a desktop file is found, it | |
cc8b76bf | 936 | is processed and `desktop-after-read-hook' is run. If no desktop file |
6b61353c KH |
937 | is found, clear the desktop and run `desktop-no-desktop-file-hook'. |
938 | This function is a no-op when Emacs is running in batch mode. | |
939 | It returns t if a desktop file was loaded, nil otherwise." | |
6343ed61 | 940 | (interactive) |
4a2fce7a | 941 | (unless noninteractive |
6b61353c | 942 | (setq desktop-dirname |
11425834 LH |
943 | (file-name-as-directory |
944 | (expand-file-name | |
945 | (or | |
946 | ;; If DIRNAME is specified, use it. | |
947 | (and (< 0 (length dirname)) dirname) | |
948 | ;; Otherwise search desktop file in desktop-path. | |
949 | (let ((dirs desktop-path)) | |
950 | (while (and dirs | |
951 | (not (file-exists-p | |
952 | (desktop-full-file-name (car dirs))))) | |
953 | (setq dirs (cdr dirs))) | |
954 | (and dirs (car dirs))) | |
955 | ;; If not found and `desktop-path' is non-nil, use its first element. | |
956 | (and desktop-path (car desktop-path)) | |
957 | ;; Default: Home directory. | |
958 | "~")))) | |
959 | (if (file-exists-p (desktop-full-file-name)) | |
e88110db JB |
960 | ;; Desktop file found, but is it already in use? |
961 | (let ((desktop-first-buffer nil) | |
962 | (desktop-buffer-ok-count 0) | |
963 | (desktop-buffer-fail-count 0) | |
964 | (owner (desktop-owner)) | |
965 | ;; Avoid desktop saving during evaluation of desktop buffer. | |
966 | (desktop-save nil)) | |
967 | (if (and owner | |
1f7efe1b JB |
968 | (memq desktop-load-locked-desktop '(nil ask)) |
969 | (or (null desktop-load-locked-desktop) | |
970 | (not (y-or-n-p (format "Warning: desktop file appears to be in use by PID %s.\n\ | |
971 | Using it may cause conflicts. Use it anyway? " owner))))) | |
c41cf130 | 972 | (let ((default-directory desktop-dirname)) |
794855ca | 973 | (setq desktop-dirname nil) |
c41cf130 JB |
974 | (run-hooks 'desktop-not-loaded-hook) |
975 | (unless desktop-dirname | |
976 | (message "Desktop file in use; not loaded."))) | |
e88110db JB |
977 | (desktop-lazy-abort) |
978 | ;; Evaluate desktop buffer and remember when it was modified. | |
979 | (load (desktop-full-file-name) t t t) | |
980 | (setq desktop-file-modtime (nth 5 (file-attributes (desktop-full-file-name)))) | |
981 | ;; If it wasn't already, mark it as in-use, to bother other | |
982 | ;; desktop instances. | |
983 | (unless owner | |
984 | (condition-case nil | |
985 | (desktop-claim-lock) | |
986 | (file-error (message "Couldn't record use of desktop file") | |
987 | (sit-for 1)))) | |
988 | ||
989 | ;; `desktop-create-buffer' puts buffers at end of the buffer list. | |
990 | ;; We want buffers existing prior to evaluating the desktop (and | |
991 | ;; not reused) to be placed at the end of the buffer list, so we | |
992 | ;; move them here. | |
993 | (mapc 'bury-buffer | |
994 | (nreverse (cdr (memq desktop-first-buffer (nreverse (buffer-list)))))) | |
995 | (switch-to-buffer (car (buffer-list))) | |
996 | (run-hooks 'desktop-delay-hook) | |
997 | (setq desktop-delay-hook nil) | |
998 | (run-hooks 'desktop-after-read-hook) | |
999 | (message "Desktop: %d buffer%s restored%s%s." | |
1000 | desktop-buffer-ok-count | |
1001 | (if (= 1 desktop-buffer-ok-count) "" "s") | |
1002 | (if (< 0 desktop-buffer-fail-count) | |
1003 | (format ", %d failed to restore" desktop-buffer-fail-count) | |
1004 | "") | |
1005 | (if desktop-buffer-args-list | |
1006 | (format ", %d to restore lazily" | |
1007 | (length desktop-buffer-args-list)) | |
1008 | "")) | |
1009 | t)) | |
6b61353c KH |
1010 | ;; No desktop file found. |
1011 | (desktop-clear) | |
1012 | (let ((default-directory desktop-dirname)) | |
1013 | (run-hooks 'desktop-no-desktop-file-hook)) | |
1014 | (message "No desktop file.") | |
1015 | nil))) | |
4a2fce7a | 1016 | |
0b9bd504 | 1017 | ;; ---------------------------------------------------------------------------- |
6b61353c | 1018 | ;; Maintained for backward compatibility |
478653c9 | 1019 | ;;;###autoload |
6343ed61 | 1020 | (defun desktop-load-default () |
577ed2b2 | 1021 | "Load the `default' start-up library manually. |
6b61353c | 1022 | Also inhibit further loading of it." |
b89c5a72 JB |
1023 | (unless inhibit-default-init ; safety check |
1024 | (load "default" t t) | |
1025 | (setq inhibit-default-init t))) | |
1026 | (make-obsolete 'desktop-load-default | |
1027 | 'desktop-save-mode "22.1") | |
4a2fce7a RS |
1028 | |
1029 | ;; ---------------------------------------------------------------------------- | |
1030 | ;;;###autoload | |
6b61353c KH |
1031 | (defun desktop-change-dir (dirname) |
1032 | "Change to desktop saved in DIRNAME. | |
1033 | Kill the desktop as specified by variables `desktop-save-mode' and | |
1034 | `desktop-save', then clear the desktop and load the desktop file in | |
1035 | directory DIRNAME." | |
1036 | (interactive "DChange to directory: ") | |
1037 | (setq dirname (file-name-as-directory (expand-file-name dirname desktop-dirname))) | |
4a2fce7a RS |
1038 | (desktop-kill) |
1039 | (desktop-clear) | |
6b61353c | 1040 | (desktop-read dirname)) |
bf247b6e | 1041 | |
6b61353c | 1042 | ;; ---------------------------------------------------------------------------- |
4a2fce7a | 1043 | ;;;###autoload |
6b61353c KH |
1044 | (defun desktop-save-in-desktop-dir () |
1045 | "Save the desktop in directory `desktop-dirname'." | |
4a2fce7a RS |
1046 | (interactive) |
1047 | (if desktop-dirname | |
b89c5a72 | 1048 | (desktop-save desktop-dirname) |
4a2fce7a RS |
1049 | (call-interactively 'desktop-save)) |
1050 | (message "Desktop saved in %s" desktop-dirname)) | |
1051 | ||
1052 | ;; ---------------------------------------------------------------------------- | |
1053 | ;;;###autoload | |
1054 | (defun desktop-revert () | |
1055 | "Revert to the last loaded desktop." | |
1056 | (interactive) | |
6b61353c KH |
1057 | (unless desktop-dirname |
1058 | (error "Unknown desktop directory")) | |
11425834 | 1059 | (unless (file-exists-p (desktop-full-file-name)) |
6b61353c KH |
1060 | (error "No desktop file found")) |
1061 | (desktop-clear) | |
1062 | (desktop-read desktop-dirname)) | |
4a2fce7a | 1063 | |
341c2f07 SM |
1064 | (defvar desktop-buffer-major-mode) |
1065 | (defvar desktop-buffer-locals) | |
0b9bd504 | 1066 | ;; ---------------------------------------------------------------------------- |
e5780ae1 LH |
1067 | (defun desktop-restore-file-buffer (desktop-buffer-file-name |
1068 | desktop-buffer-name | |
1069 | desktop-buffer-misc) | |
1070 | "Restore a file buffer." | |
1f7efe1b JB |
1071 | (when desktop-buffer-file-name |
1072 | (if (or (file-exists-p desktop-buffer-file-name) | |
1073 | (let ((msg (format "Desktop: File \"%s\" no longer exists." | |
1074 | desktop-buffer-file-name))) | |
1075 | (if desktop-missing-file-warning | |
1076 | (y-or-n-p (concat msg " Re-create buffer? ")) | |
1077 | (message "%s" msg) | |
1078 | nil))) | |
1079 | (let* ((auto-insert nil) ; Disable auto insertion | |
1080 | (coding-system-for-read | |
1081 | (or coding-system-for-read | |
1082 | (cdr (assq 'buffer-file-coding-system | |
1083 | desktop-buffer-locals)))) | |
1084 | (buf (find-file-noselect desktop-buffer-file-name))) | |
1085 | (condition-case nil | |
1086 | (switch-to-buffer buf) | |
1087 | (error (pop-to-buffer buf))) | |
1088 | (and (not (eq major-mode desktop-buffer-major-mode)) | |
1089 | (functionp desktop-buffer-major-mode) | |
1090 | (funcall desktop-buffer-major-mode)) | |
1091 | buf) | |
1092 | nil))) | |
4a2fce7a | 1093 | |
0f4804e7 LH |
1094 | (defun desktop-load-file (function) |
1095 | "Load the file where auto loaded FUNCTION is defined." | |
97b3a214 | 1096 | (when function |
07696982 | 1097 | (let ((fcell (and (fboundp function) (symbol-function function)))) |
97b3a214 LH |
1098 | (when (and (listp fcell) |
1099 | (eq 'autoload (car fcell))) | |
1100 | (load (cadr fcell)))))) | |
0f4804e7 | 1101 | |
0b9bd504 | 1102 | ;; ---------------------------------------------------------------------------- |
eb982898 JL |
1103 | ;; Create a buffer, load its file, set its mode, ...; |
1104 | ;; called from Desktop file only. | |
1d500ca6 | 1105 | |
0f4804e7 | 1106 | ;; Just to silence the byte compiler. |
341c2f07 SM |
1107 | |
1108 | (defvar desktop-first-buffer) ; Dynamically bound in `desktop-read' | |
1109 | ||
1110 | ;; Bound locally in `desktop-read'. | |
1111 | (defvar desktop-buffer-ok-count) | |
1112 | (defvar desktop-buffer-fail-count) | |
4a2fce7a | 1113 | |
340db502 LH |
1114 | (defun desktop-create-buffer |
1115 | (desktop-file-version | |
1116 | desktop-buffer-file-name | |
1117 | desktop-buffer-name | |
1118 | desktop-buffer-major-mode | |
1119 | desktop-buffer-minor-modes | |
1120 | desktop-buffer-point | |
1121 | desktop-buffer-mark | |
1122 | desktop-buffer-read-only | |
1123 | desktop-buffer-misc | |
1124 | &optional | |
1125 | desktop-buffer-locals) | |
4a2fce7a RS |
1126 | ;; To make desktop files with relative file names possible, we cannot |
1127 | ;; allow `default-directory' to change. Therefore we save current buffer. | |
1128 | (save-current-buffer | |
0f4804e7 LH |
1129 | ;; Give major mode module a chance to add a handler. |
1130 | (desktop-load-file desktop-buffer-major-mode) | |
340db502 LH |
1131 | (let ((buffer-list (buffer-list)) |
1132 | (result | |
116d5bc7 | 1133 | (condition-case-no-debug err |
340db502 LH |
1134 | (funcall (or (cdr (assq desktop-buffer-major-mode |
1135 | desktop-buffer-mode-handlers)) | |
1136 | 'desktop-restore-file-buffer) | |
1137 | desktop-buffer-file-name | |
1138 | desktop-buffer-name | |
1139 | desktop-buffer-misc) | |
1140 | (error | |
1141 | (message "Desktop: Can't load buffer %s: %s" | |
1142 | desktop-buffer-name | |
1143 | (error-message-string err)) | |
1144 | (when desktop-missing-file-warning (sit-for 1)) | |
1145 | nil)))) | |
e5780ae1 LH |
1146 | (if (bufferp result) |
1147 | (setq desktop-buffer-ok-count (1+ desktop-buffer-ok-count)) | |
1148 | (setq desktop-buffer-fail-count (1+ desktop-buffer-fail-count)) | |
1149 | (setq result nil)) | |
7bcbf3c2 JB |
1150 | ;; Restore buffer list order with new buffer at end. Don't change |
1151 | ;; the order for old desktop files (old desktop module behaviour). | |
4a2fce7a | 1152 | (unless (< desktop-file-version 206) |
48aa4dfc | 1153 | (mapc 'bury-buffer buffer-list) |
7bcbf3c2 | 1154 | (when result (bury-buffer result))) |
4a2fce7a | 1155 | (when result |
7bcbf3c2 JB |
1156 | (unless (or desktop-first-buffer (< desktop-file-version 206)) |
1157 | (setq desktop-first-buffer result)) | |
4a2fce7a RS |
1158 | (set-buffer result) |
1159 | (unless (equal (buffer-name) desktop-buffer-name) | |
93c5a976 | 1160 | (rename-buffer desktop-buffer-name t)) |
4a2fce7a | 1161 | ;; minor modes |
340db502 LH |
1162 | (cond ((equal '(t) desktop-buffer-minor-modes) ; backwards compatible |
1163 | (auto-fill-mode 1)) | |
1164 | ((equal '(nil) desktop-buffer-minor-modes) ; backwards compatible | |
1165 | (auto-fill-mode 0)) | |
1166 | (t | |
341c2f07 SM |
1167 | (dolist (minor-mode desktop-buffer-minor-modes) |
1168 | ;; Give minor mode module a chance to add a handler. | |
1169 | (desktop-load-file minor-mode) | |
1170 | (let ((handler (cdr (assq minor-mode desktop-minor-mode-handlers)))) | |
1171 | (if handler | |
1172 | (funcall handler desktop-buffer-locals) | |
1173 | (when (functionp minor-mode) | |
1174 | (funcall minor-mode 1))))))) | |
1175 | ;; Even though point and mark are non-nil when written by | |
1176 | ;; `desktop-save', they may be modified by handlers wanting to set | |
1177 | ;; point or mark themselves. | |
e5780ae1 LH |
1178 | (when desktop-buffer-point |
1179 | (goto-char | |
1180 | (condition-case err | |
341c2f07 SM |
1181 | ;; Evaluate point. Thus point can be something like |
1182 | ;; '(search-forward ... | |
e5780ae1 LH |
1183 | (eval desktop-buffer-point) |
1184 | (error (message "%s" (error-message-string err)) 1)))) | |
4a2fce7a RS |
1185 | (when desktop-buffer-mark |
1186 | (if (consp desktop-buffer-mark) | |
1f7efe1b JB |
1187 | (progn |
1188 | (set-mark (car desktop-buffer-mark)) | |
1189 | (setq mark-active (car (cdr desktop-buffer-mark)))) | |
4a2fce7a RS |
1190 | (set-mark desktop-buffer-mark))) |
1191 | ;; Never override file system if the file really is read-only marked. | |
1f7efe1b | 1192 | (when desktop-buffer-read-only (setq buffer-read-only desktop-buffer-read-only)) |
4a2fce7a RS |
1193 | (while desktop-buffer-locals |
1194 | (let ((this (car desktop-buffer-locals))) | |
1195 | (if (consp this) | |
1f7efe1b JB |
1196 | ;; an entry of this form `(symbol . value)' |
1197 | (progn | |
1198 | (make-local-variable (car this)) | |
1199 | (set (car this) (cdr this))) | |
4a2fce7a RS |
1200 | ;; an entry of the form `symbol' |
1201 | (make-local-variable this) | |
1202 | (makunbound this))) | |
1203 | (setq desktop-buffer-locals (cdr desktop-buffer-locals))))))) | |
ec4c6f22 | 1204 | |
4a2fce7a | 1205 | ;; ---------------------------------------------------------------------------- |
ec4c6f22 | 1206 | ;; Backward compatibility -- update parameters to 205 standards. |
569c754e RS |
1207 | (defun desktop-buffer (desktop-buffer-file-name desktop-buffer-name |
1208 | desktop-buffer-major-mode | |
2699e23e | 1209 | mim pt mk ro tl fc cfs cr desktop-buffer-misc) |
569c754e | 1210 | (desktop-create-buffer 205 desktop-buffer-file-name desktop-buffer-name |
2699e23e RS |
1211 | desktop-buffer-major-mode (cdr mim) pt mk ro |
1212 | desktop-buffer-misc | |
ec4c6f22 RS |
1213 | (list (cons 'truncate-lines tl) |
1214 | (cons 'fill-column fc) | |
1215 | (cons 'case-fold-search cfs) | |
1216 | (cons 'case-replace cr) | |
1217 | (cons 'overwrite-mode (car mim))))) | |
84b538ec | 1218 | |
150f39ee | 1219 | (defun desktop-append-buffer-args (&rest args) |
cc8b76bf | 1220 | "Append ARGS at end of `desktop-buffer-args-list'. |
150f39ee LH |
1221 | ARGS must be an argument list for `desktop-create-buffer'." |
1222 | (setq desktop-buffer-args-list (nconc desktop-buffer-args-list (list args))) | |
1223 | (unless desktop-lazy-timer | |
1224 | (setq desktop-lazy-timer | |
1225 | (run-with-idle-timer desktop-lazy-idle-delay t 'desktop-idle-create-buffers)))) | |
1226 | ||
1227 | (defun desktop-lazy-create-buffer () | |
1228 | "Pop args from `desktop-buffer-args-list', create buffer and bury it." | |
1229 | (when desktop-buffer-args-list | |
1230 | (let* ((remaining (length desktop-buffer-args-list)) | |
1231 | (args (pop desktop-buffer-args-list)) | |
1232 | (buffer-name (nth 2 args)) | |
1233 | (msg (format "Desktop lazily opening %s (%s remaining)..." | |
1234 | buffer-name remaining))) | |
1235 | (when desktop-lazy-verbose | |
8a26c165 | 1236 | (message "%s" msg)) |
150f39ee LH |
1237 | (let ((desktop-first-buffer nil) |
1238 | (desktop-buffer-ok-count 0) | |
1239 | (desktop-buffer-fail-count 0)) | |
1240 | (apply 'desktop-create-buffer args) | |
1241 | (run-hooks 'desktop-delay-hook) | |
1242 | (setq desktop-delay-hook nil) | |
1243 | (bury-buffer (get-buffer buffer-name)) | |
1244 | (when desktop-lazy-verbose | |
1245 | (message "%s%s" msg (if (> desktop-buffer-ok-count 0) "done" "failed"))))))) | |
1246 | ||
1247 | (defun desktop-idle-create-buffers () | |
1248 | "Create buffers until the user does something, then stop. | |
1249 | If there are no buffers left to create, kill the timer." | |
1250 | (let ((repeat 1)) | |
1251 | (while (and repeat desktop-buffer-args-list) | |
1252 | (save-window-excursion | |
1253 | (desktop-lazy-create-buffer)) | |
1254 | (setq repeat (sit-for 0.2)) | |
1255 | (unless desktop-buffer-args-list | |
1256 | (cancel-timer desktop-lazy-timer) | |
1257 | (setq desktop-lazy-timer nil) | |
1258 | (message "Lazy desktop load complete") | |
1259 | (sit-for 3) | |
1260 | (message ""))))) | |
1261 | ||
1262 | (defun desktop-lazy-complete () | |
1263 | "Run the desktop load to completion." | |
1264 | (interactive) | |
1265 | (let ((desktop-lazy-verbose t)) | |
1266 | (while desktop-buffer-args-list | |
1267 | (save-window-excursion | |
1268 | (desktop-lazy-create-buffer))) | |
1269 | (message "Lazy desktop load complete"))) | |
1270 | ||
1271 | (defun desktop-lazy-abort () | |
1272 | "Abort lazy loading of the desktop." | |
1273 | (interactive) | |
1274 | (when desktop-lazy-timer | |
1275 | (cancel-timer desktop-lazy-timer) | |
1276 | (setq desktop-lazy-timer nil)) | |
1277 | (when desktop-buffer-args-list | |
1278 | (setq desktop-buffer-args-list nil) | |
1279 | (when (interactive-p) | |
1280 | (message "Lazy desktop load aborted")))) | |
1281 | ||
0b9bd504 | 1282 | ;; ---------------------------------------------------------------------------- |
6b61353c | 1283 | ;; When `desktop-save-mode' is non-nil and "--no-desktop" is not specified on the |
4a2fce7a RS |
1284 | ;; command line, we do the rest of what it takes to use desktop, but do it |
1285 | ;; after finishing loading the init file. | |
1286 | ;; We cannot use `command-switch-alist' to process "--no-desktop" because these | |
1287 | ;; functions are processed after `after-init-hook'. | |
1288 | (add-hook | |
1289 | 'after-init-hook | |
341c2f07 | 1290 | (lambda () |
4a2fce7a | 1291 | (let ((key "--no-desktop")) |
4b217d46 LH |
1292 | (when (member key command-line-args) |
1293 | (setq command-line-args (delete key command-line-args)) | |
1294 | (setq desktop-save-mode nil))) | |
54d22a6f JL |
1295 | (when desktop-save-mode |
1296 | (desktop-read) | |
1297 | (setq inhibit-startup-screen t)))) | |
813dbb2d | 1298 | |
ab1d55ea | 1299 | (provide 'desktop) |
6343ed61 | 1300 | |
341c2f07 | 1301 | ;; arch-tag: 221907c3-1771-4fd3-9c2e-c6f700c6ede9 |
80f9f3db | 1302 | ;;; desktop.el ends here |