1 ;;; frameset.el --- save and restore frame and window setup -*- lexical-binding: t -*-
3 ;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
5 ;; Author: Juanma Barranquero <lekktu@gmail.com>
6 ;; Keywords: convenience
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; This file provides a set of operations to save a frameset (the state
26 ;; of all or a subset of the existing frames and windows), both
27 ;; in-session and persistently, and restore it at some point in the
30 ;; It should be noted that restoring the frames' windows depends on
31 ;; the buffers they are displaying, but this package does not provide
32 ;; any way to save and restore sets of buffers (see desktop.el for
33 ;; that). So, it's up to the user of frameset.el to make sure that
34 ;; any relevant buffer is loaded before trying to restore a frameset.
35 ;; When a window is restored and a buffer is missing, the window will
36 ;; be deleted unless it is the last one in the frame, in which case
37 ;; some previous buffer will be shown instead.
44 (cl-defstruct (frameset (:type vector
) :named
45 (:constructor frameset--make
)
46 ;; Copier is defined below.
49 "A frameset encapsulates a serializable view of a set of frames and windows.
51 It contains the following slots, which can be accessed with
52 \(frameset-SLOT fs) and set with (setf (frameset-SLOT fs) VALUE):
54 version A read-only version number, identifying the format
55 of the frameset struct. Currently its value is 1.
56 timestamp A read-only timestamp, the output of `current-time'.
57 app A symbol, or a list whose first element is a symbol, which
58 identifies the creator of the frameset and related info;
59 for example, desktop.el sets this slot to a list
60 `(desktop . ,desktop-file-version).
61 name A string, the name of the frameset instance.
62 description A string, a description for user consumption (to show in
63 menus, messages, etc).
64 properties A property list, to store both frameset-specific and
65 user-defined serializable data.
66 states A list of items (FRAME-PARAMETERS . WINDOW-STATE), in no
67 particular order. Each item represents a frame to be
68 restored. FRAME-PARAMETERS is a frame's parameter alist,
69 extracted with (frame-parameters FRAME) and filtered
70 through `frameset-filter-params'.
71 WINDOW-STATE is the output of `window-state-get' applied
72 to the root window of the frame.
74 To avoid collisions, it is recommended that applications wanting to add
75 private serializable data to `properties' either store all info under a
76 single, distinctive name, or use property names with a well-chosen prefix.
78 A frameset is intended to be used through the following simple API:
80 - `frameset-save', the type's constructor, captures all or a subset of the
81 live frames, and returns a serializable snapshot of them (a frameset).
82 - `frameset-restore' takes a frameset, and restores the frames and windows
83 it describes, as faithfully as possible.
84 - `frameset-p' is the predicate for the frameset type.
85 - `frameset-valid-p' checks a frameset's validity.
86 - `frameset-copy' returns a deep copy of a frameset.
87 - `frameset-prop' is a `setf'able accessor for the contents of the
89 - The `frameset-SLOT' accessors described above."
91 (version 1 :read-only t
)
92 (timestamp (current-time) :read-only t
)
99 ;; Add nicer docstrings for built-in predicate and accessors.
100 (put 'frameset-p
'function-documentation
101 "Return non-nil if OBJECT is a frameset, nil otherwise.\n\n(fn OBJECT)")
102 (put 'frameset-version
'function-documentation
103 "Return the version number of FRAMESET.\n
104 It is an integer that identifies the format of the frameset struct.
105 This slot cannot be modified.\n\n(fn FRAMESET)")
106 (put 'frameset-timestamp
'function-documentation
107 "Return the creation timestamp of FRAMESET.\n
108 The value is in the format returned by `current-time'.
109 This slot cannot be modified.\n\n(fn FRAMESET)")
110 (put 'frameset-app
'function-documentation
111 "Return the application identifier for FRAMESET.\n
112 The value is either a symbol, like `my-app', or a list
113 \(my-app ADDITIONAL-DATA...).\n\n(fn FRAMESET)")
114 (put 'frameset-name
'function-documentation
115 "Return the name of FRAMESET (a string).\n\n(fn FRAMESET)")
116 (put 'frameset-description
'function-documentation
117 "Return the description of FRAMESET (a string).\n\n(fn FRAMESET)")
118 (put 'frameset-properties
'function-documentation
119 "Return the property list of FRAMESET.\n
120 This list is useful to store both frameset-specific and user-defined
121 serializable data. The simplest way to access and modify it is
122 through `frameset-prop' (which see).\n\n(fn FRAMESET)")
123 (put 'frameset-states
'function-documentation
124 "Return the list of frame states of FRAMESET.\n
125 A frame state is a pair (FRAME-PARAMETERS . WINDOW-STATE), where
126 FRAME-PARAMETERS is a frame's parameter alist, extracted with
127 \(frame-parameters FRAME) and filtered through `frameset-filter-params',
128 and WINDOW-STATE is the output of `window-state-get' applied to the
129 root window of the frame.\n
130 IMPORTANT: Modifying this slot may cause frameset functions to fail,
131 unless the type constraints defined above are respected.\n\n(fn FRAMESET)")
133 ;; We autoloaded this for use in register.el, but now that we use registerv
134 ;; objects, this autoload is not useful any more.
135 ;; ;;;###autoload (autoload 'frameset-p "frameset"
136 ;; ;;;###autoload "Return non-nil if OBJECT is a frameset, nil otherwise." nil)
138 (defun frameset-copy (frameset)
139 "Return a deep copy of FRAMESET.
140 FRAMESET is copied with `copy-tree'."
141 (copy-tree frameset t
))
143 (defun frameset-valid-p (object)
144 "Return non-nil if OBJECT is a valid frameset, nil otherwise."
145 (and (frameset-p object
)
146 (integerp (frameset-version object
))
147 (consp (frameset-timestamp object
))
148 (let ((app (frameset-app object
)))
149 (or (null app
) ; APP is nil
150 (symbolp app
) ; or a symbol
151 (and (consp app
) ; or a list
152 (symbolp (car app
))))) ; starting with a symbol
153 (stringp (or (frameset-name object
) ""))
154 (stringp (or (frameset-description object
) ""))
155 (listp (frameset-properties object
))
156 (let ((states (frameset-states object
)))
158 (cl-every #'consp
(frameset-states object
))))
159 (frameset-version object
))) ; And VERSION is non-nil.
161 (defun frameset--prop-setter (frameset property value
)
162 "Setter function for `frameset-prop'. Internal use only."
163 (setf (frameset-properties frameset
)
164 (plist-put (frameset-properties frameset
) property value
))
167 ;; A setf'able accessor to the frameset's properties
168 (defun frameset-prop (frameset property
)
169 "Return the value for FRAMESET of PROPERTY.
171 Properties can be set with
173 (setf (frameset-prop FRAMESET PROPERTY) NEW-VALUE)"
174 (declare (gv-setter frameset--prop-setter
))
175 (plist-get (frameset-properties frameset
) property
))
180 ;; What's the deal with these "filter alists"?
182 ;; Let's say that Emacs' frame parameters were never designed as a tool to
183 ;; precisely record (or restore) a frame's state. They grew organically,
184 ;; and their uses and behaviors reflect their history. In using them to
185 ;; implement framesets, the unwary implementer, or the prospective package
186 ;; writer willing to use framesets in their code, might fall victim of some
187 ;; unexpected... oddities.
189 ;; You can find frame parameters that:
191 ;; - can be used to get and set some data from the frame's current state
192 ;; (`height', `width')
193 ;; - can be set at creation time, and setting them afterwards has no effect
194 ;; (`window-state', `minibuffer')
195 ;; - can be set at creation time, and setting them afterwards will fail with
196 ;; an error, *unless* you set it to the same value, a noop (`border-width')
197 ;; - act differently when passed at frame creation time, and when set
198 ;; afterwards (`height')
199 ;; - affect the value of other parameters (`name', `visibility')
200 ;; - can be ignored by window managers (most positional args, like `height',
201 ;; `width', `left' and `top', and others, like `auto-raise', `auto-lower')
202 ;; - can be set externally in X resources or Window registry (again, most
203 ;; positional parameters, and also `toolbar-lines', `menu-bar-lines' etc.)
204 ;, - can contain references to live objects (`buffer-list', `minibuffer') or
205 ;; code (`buffer-predicate')
206 ;; - are set automatically, and cannot be changed (`window-id', `parent-id'),
207 ;; but setting them produces no error
208 ;; - have a noticeable effect in some window managers, and are ignored in
209 ;; others (`menu-bar-lines')
210 ;; - can not be safely set in a tty session and then copied back to a GUI
211 ;; session (`font', `background-color', `foreground-color')
215 ;; Which means that, in order to save a parameter alist to disk and read it
216 ;; back later to reconstruct a frame, some processing must be done. That's
217 ;; what `frameset-filter-params' and the `frameset-*-filter-alist' variables
220 ;; First, a clarification. The word "filter" in these names refers to both
221 ;; common meanings of filter: to filter out (i.e., to remove), and to pass
222 ;; through a transformation function (think `filter-buffer-substring').
224 ;; `frameset-filter-params' takes a parameter alist PARAMETERS, a filtering
225 ;; alist FILTER-ALIST, and a flag SAVING to indicate whether we are filtering
226 ;; parameters with the intent of saving a frame or restoring it. It then
227 ;; accumulates an output alist, FILTERED, by checking each parameter in
228 ;; PARAMETERS against FILTER-ALIST and obeying any rule found there. The
229 ;; absence of a rule just means the parameter/value pair (called CURRENT in
230 ;; filtering functions) is copied to FILTERED as is. Keyword values :save,
231 ;; :restore and :never tell the function to copy CURRENT to FILTERED in the
232 ;; respective situations, that is, when saving, restoring, or never at all.
233 ;; Values :save and :restore are not used in this package, because usually if
234 ;; you don't want to save a parameter, you don't want to restore it either.
235 ;; But they can be useful, for example, if you already have a saved frameset
236 ;; created with some intent, and want to reuse it for a different objective
237 ;; where the expected parameter list has different requirements.
239 ;; Finally, the value can also be a filtering function, or a filtering
240 ;; function plus some arguments. The function is called for each matching
241 ;; parameter, and receives CURRENT (the parameter/value pair being processed),
242 ;; FILTERED (the output alist so far), PARAMETERS (the full parameter alist),
243 ;; SAVING (the save/restore flag), plus any additional ARGS set along the
244 ;; function in the `frameset-*-filter-alist' entry. The filtering function
245 ;; then has the possibility to pass along CURRENT, or reject it altogether,
246 ;; or pass back a (NEW-PARAM . NEW-VALUE) pair, which does not even need to
247 ;; refer to the same parameter (so you can filter `width' and return `height'
248 ;; and vice versa, if you're feeling silly and want to mess with the user's
249 ;; mind). As a help in deciding what to do, the filtering function has
250 ;; access to PARAMETERS, but must not change it in any way. It also has
251 ;; access to FILTERED, which can be modified at will. This allows two or
252 ;; more filters to coordinate themselves, because in general there's no way
253 ;; to predict the order in which they will be run.
255 ;; So, which parameters are filtered by default, and why? Let's see.
257 ;; - `buffer-list', `buried-buffer-list', `buffer-predicate': They contain
258 ;; references to live objects, or in the case of `buffer-predicate', it
259 ;; could also contain an fbound symbol (a predicate function) that could
260 ;; not be defined in a later session.
262 ;; - `window-id', `outer-window-id', `parent-id': They are assigned
263 ;; automatically and cannot be set, so keeping them is harmless, but they
264 ;; add clutter. `window-system' is similar: it's assigned at frame
265 ;; creation, and does not serve any useful purpose later.
267 ;; - `left', `top': Only problematic when saving an iconified frame, because
268 ;; when the frame is iconified they are set to (- 32000), which doesn't
269 ;; really help in restoring the frame. Better to remove them and let the
270 ;; window manager choose a default position for the frame.
272 ;; - `background-color', `foreground-color': In tty frames they can be set
273 ;; to "unspecified-bg" and "unspecified-fg", which aren't understood on
274 ;; GUI sessions. They have to be filtered out when switching from tty to
275 ;; a graphical display.
277 ;; - `tty', `tty-type': These are tty-specific. When switching to a GUI
278 ;; display they do no harm, but they clutter the parameter alist.
280 ;; - `minibuffer': It can contain a reference to a live window, which cannot
281 ;; be serialized. Because of Emacs' idiosyncratic treatment of this
282 ;; parameter, frames created with (minibuffer . t) have a parameter
283 ;; (minibuffer . #<window...>), while frames created with
284 ;; (minibuffer . #<window...>) have (minibuffer . nil), which is madness
285 ;; but helps to differentiate between minibufferless and "normal" frames.
286 ;; So, changing (minibuffer . #<window...>) to (minibuffer . t) allows
287 ;; Emacs to set up the new frame correctly. Nice, uh?
289 ;; - `name': If this parameter is directly set, `explicit-name' is
290 ;; automatically set to t, and then `name' no longer changes dynamically.
291 ;; So, in general, not saving `name' is the right thing to do, though
292 ;; surely there are applications that will want to override this filter.
294 ;; - `font', `fullscreen', `height' and `width': These parameters suffer
295 ;; from the fact that they are badly mangled when going through a
296 ;; tty session, though not all in the same way. When saving a GUI frame
297 ;; and restoring it in a tty, the height and width of the new frame are
298 ;; those of the tty screen (let's say 80x25, for example); going back
299 ;; to a GUI session means getting frames of the tty screen size (so all
300 ;; your frames are 80 cols x 25 rows). For `fullscreen' there's a
301 ;; similar problem, because a tty frame cannot really be fullscreen or
302 ;; maximized, so the state is lost. The problem with `font' is a bit
303 ;; different, because a valid GUI font spec in `font' turns into
304 ;; (font . "tty") in a tty frame, and when read back into a GUI session
305 ;; it fails because `font's value is no longer a valid font spec.
307 ;; In most cases, the filtering functions just do the obvious thing: remove
308 ;; CURRENT when it is meaningless to keep it, or pass a modified copy if
309 ;; that helps (as in the case of `minibuffer').
311 ;; The exception are the parameters in the last set, which should survive
312 ;; the roundtrip though tty-land. The answer is to add "stashing
313 ;; parameters", working in pairs, to shelve the GUI-specific contents and
314 ;; restore it once we're back in pixel country. That's what functions
315 ;; `frameset-filter-shelve-param' and `frameset-filter-unshelve-param' do.
317 ;; Basically, if you set `frameset-filter-shelve-param' as the filter for
318 ;; a parameter P, it will detect when it is restoring a GUI frame into a
319 ;; tty session, and save P's value in the custom parameter X:P, but only
320 ;; if X:P does not exist already (so it is not overwritten if you enter
321 ;; the tty session more than once). If you're not switching to a tty
322 ;; frame, the filter just passes CURRENT along.
324 ;; The parameter X:P, on the other hand, must have been setup to be
325 ;; filtered by `frameset-filter-unshelve-param', which unshelves the
326 ;; value: if we're entering a GUI session, returns P instead of CURRENT,
327 ;; while in other cases it just passes it along.
329 ;; The only additional trick is that `frameset-filter-shelve-param' does
330 ;; not set P if switching back to GUI and P already has a value, because
331 ;; it assumes that `frameset-filter-unshelve-param' did set it up. And
332 ;; `frameset-filter-unshelve-param', when unshelving P, must look into
333 ;; FILTERED to determine if P has already been set and if so, modify it;
334 ;; else just returns P.
336 ;; Currently, the value of X in X:P is `GUI', but you can use any prefix,
337 ;; by passing its symbol as argument in the filter:
339 ;; (my-parameter frameset-filter-shelve-param MYPREFIX)
343 ;; (my-parameter . frameset-filter-shelve-param)
345 ;; Note that `frameset-filter-unshelve-param' does not need MYPREFIX
346 ;; because it is available from the parameter name in CURRENT. Also note
347 ;; that the colon between the prefix and the parameter name is hardcoded.
348 ;; The reason is that X:P is quite readable, and that the colon is a
349 ;; very unusual character in symbol names, other than in initial position
350 ;; in keywords (emacs -Q has only two such symbols, and one of them is a
351 ;; URL). So the probability of a collision with existing or future
352 ;; symbols is quite insignificant.
354 ;; Now, what about the filter alist variables? There are three of them,
355 ;; though only two sets of parameters:
357 ;; - `frameset-session-filter-alist' contains these filters that allow to
358 ;; save and restore framesets in-session, without the need to serialize
359 ;; the frameset or save it to disk (for example, to save a frameset in a
360 ;; register and restore it later). Filters in this list do not remove
361 ;; live objects, except in `minibuffer', which is dealt especially by
362 ;; `frameset-save' / `frameset-restore'.
364 ;; - `frameset-persistent-filter-alist' is the whole deal. It does all
365 ;; the filtering described above, and the result is ready to be saved on
366 ;; disk without loss of information. That's the format used by the
367 ;; desktop.el package, for example.
369 ;; IMPORTANT: These variables share structure and should NEVER be modified.
371 ;; - `frameset-filter-alist': The value of this variable is the default
372 ;; value for the FILTERS arguments of `frameset-save' and
373 ;; `frameset-restore'. It is set to `frameset-persistent-filter-alist',
374 ;; though it can be changed by specific applications.
378 ;; The simplest way is just do nothing. The default should work
379 ;; reasonably and sensibly enough. But, what if you really need a
380 ;; customized filter alist? Then you can create your own variable
382 ;; (defvar my-filter-alist
383 ;; '((my-param1 . :never)
384 ;; (my-param2 . :save)
385 ;; (my-param3 . :restore)
386 ;; (my-param4 . my-filtering-function-without-args)
387 ;; (my-param5 my-filtering-function-with arg1 arg2)
388 ;; ;;; many other parameters
390 ;; "My customized parameter filter alist.")
392 ;; or, if you're only changing a few items,
394 ;; (defvar my-filter-alist
395 ;; (nconc '((my-param1 . :never)
396 ;; (my-param2 . my-filtering-function))
397 ;; frameset-filter-alist)
398 ;; "My brief customized parameter filter alist.")
400 ;; and pass it to the FILTER arg of the save/restore functions,
401 ;; ALWAYS taking care of not modifying the original lists; if you're
402 ;; going to do any modifying of my-filter-alist, please use
404 ;; (nconc '((my-param1 . :never) ...)
405 ;; (copy-sequence frameset-filter-alist))
407 ;; One thing you shouldn't forget is that they are alists, so searching
408 ;; in them is sequential. If you just want to change the default of
409 ;; `name' to allow it to be saved, you can set (name . nil) in your
410 ;; customized filter alist; it will take precedence over the latter
411 ;; setting. In case you decide that you *always* want to save `name',
412 ;; you can add it to `frameset-filter-alist':
414 ;; (push '(name . nil) frameset-filter-alist)
416 ;; In certain applications, having a parameter filtering function like
417 ;; `frameset-filter-params' can be useful, even if you're not using
418 ;; framesets. The interface of `frameset-filter-params' is generic
419 ;; and does not depend of global state, with one exception: it uses
420 ;; the internal variable `frameset--target-display' to decide if, and
421 ;; how, to modify the `display' parameter of FILTERED. But that
422 ;; should not represent any problem, because it's only meaningful
423 ;; when restoring, and customized uses of `frameset-filter-params'
424 ;; are likely to use their own filter alist and just call
426 ;; (setq my-filtered (frameset-filter-params my-params my-filters t))
428 ;; In case you want to use it with the standard filters, you can
429 ;; wrap the call to `frameset-filter-params' in a let form to bind
430 ;; `frameset--target-display' to nil or the desired value.
434 (defvar frameset-session-filter-alist
436 (left . frameset-filter-iconified
)
437 (minibuffer . frameset-filter-minibuffer
)
438 (top . frameset-filter-iconified
))
439 "Minimum set of parameters to filter for live (on-session) framesets.
440 DO NOT MODIFY. See `frameset-filter-alist' for a full description.")
443 (defvar frameset-persistent-filter-alist
445 '((background-color . frameset-filter-sanitize-color
)
446 (buffer-list .
:never
)
447 (buffer-predicate .
:never
)
448 (buried-buffer-list .
:never
)
449 (font . frameset-filter-shelve-param
)
450 (foreground-color . frameset-filter-sanitize-color
)
451 (fullscreen . frameset-filter-shelve-param
)
452 (GUI:font . frameset-filter-unshelve-param
)
453 (GUI:fullscreen . frameset-filter-unshelve-param
)
454 (GUI:height . frameset-filter-unshelve-param
)
455 (GUI:width . frameset-filter-unshelve-param
)
456 (height . frameset-filter-shelve-param
)
457 (outer-window-id .
:never
)
459 (tty . frameset-filter-tty-to-GUI
)
460 (tty-type . frameset-filter-tty-to-GUI
)
461 (width . frameset-filter-shelve-param
)
463 (window-system .
:never
))
464 frameset-session-filter-alist
)
465 "Parameters to filter for persistent framesets.
466 DO NOT MODIFY. See `frameset-filter-alist' for a full description.")
469 (defvar frameset-filter-alist frameset-persistent-filter-alist
470 "Alist of frame parameters and filtering functions.
472 This alist is the default value of the FILTERS argument of
473 `frameset-save' and `frameset-restore' (which see).
475 Initially, `frameset-filter-alist' is set to, and shares the value of,
476 `frameset-persistent-filter-alist'. You can override any item in
477 this alist by `push'ing a new item onto it. If, for some reason, you
478 intend to modify existing values, do
480 (setq frameset-filter-alist (copy-tree frameset-filter-alist))
482 before changing anything.
484 On saving, PARAMETERS is the parameter alist of each frame processed,
485 and FILTERED is the parameter alist that gets saved to the frameset.
487 On restoring, PARAMETERS is the parameter alist extracted from the
488 frameset, and FILTERED is the resulting frame parameter alist used
489 to restore the frame.
491 Elements of `frameset-filter-alist' are conses (PARAM . ACTION),
492 where PARAM is a parameter name (a symbol identifying a frame
493 parameter), and ACTION can be:
495 nil The parameter is copied to FILTERED.
496 :never The parameter is never copied to FILTERED.
497 :save The parameter is copied only when saving the frame.
498 :restore The parameter is copied only when restoring the frame.
499 FILTER A filter function.
501 FILTER can be a symbol FILTER-FUN, or a list (FILTER-FUN ARGS...).
502 FILTER-FUN is invoked with
504 (apply FILTER-FUN CURRENT FILTERED PARAMETERS SAVING ARGS)
508 CURRENT A cons (PARAM . VALUE), where PARAM is the one being
509 filtered and VALUE is its current value.
510 FILTERED The resulting alist (so far).
511 PARAMETERS The complete alist of parameters being filtered,
512 SAVING Non-nil if filtering before saving state, nil if filtering
514 ARGS Any additional arguments specified in the ACTION.
516 FILTER-FUN is allowed to modify items in FILTERED, but no other arguments.
518 nil Skip CURRENT (do not add it to FILTERED).
519 t Add CURRENT to FILTERED as is.
520 (NEW-PARAM . NEW-VALUE) Add this to FILTERED instead of CURRENT.
522 Frame parameters not on this alist are passed intact, as if they were
523 defined with ACTION = nil.")
525 (defvar frameset--target-display nil
526 ;; Either (minibuffer . VALUE) or nil.
527 ;; This refers to the current frame config being processed inside
528 ;; `frameset-restore' and its auxiliary functions (like filtering).
529 ;; If nil, there is no need to change the display.
530 ;; If non-nil, display parameter to use when creating the frame.
531 "Internal use only.")
533 (defun frameset-switch-to-gui-p (parameters)
534 "True when switching to a graphic display.
535 Return non-nil if the parameter alist PARAMETERS describes a frame on a
536 text-only terminal, and the frame is being restored on a graphic display;
537 otherwise return nil. Only meaningful when called from a filtering
538 function in `frameset-filter-alist'."
539 (and frameset--target-display
; we're switching
540 (null (cdr (assq 'display parameters
))) ; from a tty
541 (cdr frameset--target-display
))) ; to a GUI display
543 (defun frameset-switch-to-tty-p (parameters)
544 "True when switching to a text-only terminal.
545 Return non-nil if the parameter alist PARAMETERS describes a frame on a
546 graphic display, and the frame is being restored on a text-only terminal;
547 otherwise return nil. Only meaningful when called from a filtering
548 function in `frameset-filter-alist'."
549 (and frameset--target-display
; we're switching
550 (cdr (assq 'display parameters
)) ; from a GUI display
551 (null (cdr frameset--target-display
)))) ; to a tty
553 (defun frameset-filter-tty-to-GUI (_current _filtered parameters saving
)
554 "Remove CURRENT when switching from tty to a graphic display.
556 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
557 see `frameset-filter-alist'."
559 (not (frameset-switch-to-gui-p parameters
))))
561 (defun frameset-filter-sanitize-color (current _filtered parameters saving
)
562 "When switching to a GUI frame, remove \"unspecified\" colors.
563 Useful as a filter function for tty-specific parameters.
565 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
566 see `frameset-filter-alist'."
568 (not (frameset-switch-to-gui-p parameters
))
569 (not (stringp (cdr current
)))
570 (not (string-match-p "^unspecified-[fb]g$" (cdr current
)))))
572 (defun frameset-filter-minibuffer (current filtered _parameters saving
)
573 "Force the minibuffer parameter to have a sensible value.
575 When saving, convert (minibuffer . #<window>) to (minibuffer . t).
576 When restoring, if there are two copies, keep the one pointing to
579 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
580 see `frameset-filter-alist'."
581 (let ((value (cdr current
)) mini
)
583 (if (windowp value
) '(minibuffer . t
) t
))
584 ((setq mini
(assq 'minibuffer filtered
))
585 (when (windowp value
) (setcdr mini value
))
589 (defun frameset-filter-shelve-param (current _filtered parameters saving
591 "When switching to a tty frame, save parameter P as PREFIX:P.
592 The parameter can be later restored with `frameset-filter-unshelve-param'.
593 PREFIX defaults to `GUI'.
595 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
596 see `frameset-filter-alist'."
597 (unless prefix
(setq prefix
'GUI
))
599 ((frameset-switch-to-tty-p parameters
)
600 (let ((prefix:p
(intern (format "%s:%s" prefix
(car current
)))))
601 (if (assq prefix
:p parameters
)
603 (cons prefix
:p
(cdr current
)))))
604 ((frameset-switch-to-gui-p parameters
)
605 (not (assq (intern (format "%s:%s" prefix
(car current
))) parameters
)))
608 (defun frameset-filter-unshelve-param (current filtered parameters saving
)
609 "When switching to a GUI frame, restore PREFIX:P parameter as P.
610 CURRENT must be of the form (PREFIX:P . value).
612 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
613 see `frameset-filter-alist'."
615 (not (frameset-switch-to-gui-p parameters
))
616 (let* ((prefix:p
(symbol-name (car current
)))
617 (p (intern (substring prefix
:p
618 (1+ (string-match-p ":" prefix
:p
)))))
620 (found (assq p filtered
)))
626 (defun frameset-filter-iconified (_current _filtered parameters saving
)
627 "Remove CURRENT when saving an iconified frame.
628 This is used for positional parameters `left' and `top', which are
629 meaningless in an iconified frame, so the frame is restored in a
632 For the meaning of CURRENT, FILTERED, PARAMETERS and SAVING,
633 see `frameset-filter-alist'."
634 (not (and saving
(eq (cdr (assq 'visibility parameters
)) 'icon
))))
636 (defun frameset-filter-params (parameters filter-alist saving
)
637 "Filter parameter alist PARAMETERS and return a filtered alist.
638 FILTER-ALIST is an alist of parameter filters, in the format of
639 `frameset-filter-alist' (which see).
640 SAVING is non-nil while filtering parameters to save a frameset,
641 nil while the filtering is done to restore it."
642 (let ((filtered nil
))
643 (dolist (current parameters
)
644 ;; When saving, the parameter alist is temporary, so modifying it
645 ;; is not a problem. When restoring, the parameter alist is part
646 ;; of a frameset, so we must copy parameters to avoid inadvertent
648 (pcase (cdr (assq (car current
) filter-alist
))
650 (push (if saving current
(copy-tree current
)) filtered
))
654 (unless saving
(push (copy-tree current
) filtered
)))
656 (when saving
(push current filtered
)))
657 ((or `(,fun .
,args
) (and fun
(pred fboundp
)))
658 (let* ((this (apply fun current filtered parameters saving args
))
659 (val (if (eq this t
) current this
)))
661 (push (if saving val
(copy-tree val
)) filtered
))))
663 (delay-warning 'frameset
(format "Unknown filter %S" other
) :error
))))
664 ;; Set the display parameter after filtering, so that filter functions
665 ;; have access to its original value.
666 (when frameset--target-display
667 (let ((display (assq 'display filtered
)))
669 (setcdr display
(cdr frameset--target-display
))
670 (push frameset--target-display filtered
))))
676 (defun frameset--set-id (frame)
677 "Set FRAME's id if not yet set.
679 (unless (frame-parameter frame
'frameset--id
)
680 (set-frame-parameter frame
682 (mapconcat (lambda (n) (format "%04X" n
))
683 (cl-loop repeat
4 collect
(random 65536))
686 (defun frameset-frame-id (frame)
687 "Return the frame id of FRAME, if it has one; else, return nil.
688 A frame id is a string that uniquely identifies a frame.
689 It is persistent across `frameset-save' / `frameset-restore'
690 invocations, and once assigned is never changed unless the same
691 frame is duplicated (via `frameset-restore'), in which case the
692 newest frame keeps the id and the old frame's is set to nil."
693 (frame-parameter frame
'frameset--id
))
696 (defun frameset-frame-id-equal-p (frame id
)
697 "Return non-nil if FRAME's id matches ID."
698 (string= (frameset-frame-id frame
) id
))
701 (defun frameset-frame-with-id (id &optional frame-list
)
702 "Return the live frame with id ID, if exists; else nil.
703 If FRAME-LIST is a list of frames, check these frames only.
704 If nil, check all live frames."
705 (cl-find-if (lambda (f)
706 (and (frame-live-p f
)
707 (frameset-frame-id-equal-p f id
)))
708 (or frame-list
(frame-list))))
713 (defun frameset--record-minibuffer-relationships (frame-list)
714 "Process FRAME-LIST and record minibuffer relationships.
715 FRAME-LIST is a list of frames. Internal use only."
716 ;; Record frames with their own minibuffer
717 (dolist (frame (minibuffer-frame-list))
718 (when (memq frame frame-list
)
719 (frameset--set-id frame
)
720 ;; For minibuffer-owning frames, frameset--mini is a cons
721 ;; (t . DEFAULT?), where DEFAULT? is a boolean indicating whether
722 ;; the frame is the one pointed out by `default-minibuffer-frame'.
723 (set-frame-parameter frame
725 (cons t
(eq frame default-minibuffer-frame
)))))
726 ;; Now link minibufferless frames with their minibuffer frames
727 (dolist (frame frame-list
)
728 (unless (frame-parameter frame
'frameset--mini
)
729 (frameset--set-id frame
)
730 (let ((mb-frame (window-frame (minibuffer-window frame
))))
731 ;; For minibufferless frames, frameset--mini is a cons
732 ;; (nil . FRAME-ID), where FRAME-ID is the frameset--id of
733 ;; the frame containing its minibuffer window.
734 ;; FRAME-ID can be set to nil, if FRAME-LIST doesn't contain
735 ;; the minibuffer frame of a minibufferless frame; we allow
736 ;; it without trying to second-guess the user.
737 (set-frame-parameter frame
741 (frameset-frame-id mb-frame
))))))))
744 (cl-defun frameset-save (frame-list
745 &key app name description
746 filters predicate properties
)
747 "Return a frameset for FRAME-LIST, a list of frames.
748 Dead frames and non-frame objects are silently removed from the list.
749 If nil, FRAME-LIST defaults to the output of `frame-list' (all live frames).
750 APP, NAME and DESCRIPTION are optional data; see the docstring of the
751 `frameset' defstruct for details.
752 FILTERS is an alist of parameter filters; if nil, the value of the variable
753 `frameset-filter-alist' is used instead.
754 PREDICATE is a predicate function, which must return non-nil for frames that
755 should be saved; if PREDICATE is nil, all frames from FRAME-LIST are saved.
756 PROPERTIES is a user-defined property list to add to the frameset."
757 (let* ((list (or (copy-sequence frame-list
) (frame-list)))
758 (frames (cl-delete-if-not #'frame-live-p
760 (cl-delete-if-not predicate list
)
763 (frameset--record-minibuffer-relationships frames
)
764 (setq fs
(frameset--make
767 :description description
768 :properties properties
772 (frameset-filter-params (frame-parameters frame
)
774 frameset-filter-alist
)
776 (window-state-get (frame-root-window frame
) t
)))
778 (cl-assert (frameset-valid-p fs
))
782 ;; Restoring framesets
784 (defvar frameset--reuse-list nil
785 "The list of frames potentially reusable.
786 Its value is only meaningful during execution of `frameset-restore'.
789 (defun frameset-compute-pos (value left
/top right
/bottom
)
790 "Return an absolute positioning value for a frame.
791 VALUE is the value of a positional frame parameter (`left' or `top').
792 If VALUE is relative to the screen edges (like (+ -35) or (-200), it is
793 converted to absolute by adding it to the corresponding edge; if it is
794 an absolute position, it is returned unmodified.
795 LEFT/TOP and RIGHT/BOTTOM indicate the dimensions of the screen in
796 pixels along the relevant direction: either the position of the left
797 and right edges for a `left' positional parameter, or the position of
798 the top and bottom edges for a `top' parameter."
800 (`(+ ,val
) (+ left
/top val
))
801 (`(- ,val
) (+ right
/bottom val
))
804 (defun frameset-move-onscreen (frame force-onscreen
)
805 "If FRAME is offscreen, move it back onscreen and, if necessary, resize it.
806 For the description of FORCE-ONSCREEN, see `frameset-restore'.
807 When forced onscreen, frames wider than the monitor's workarea are converted
808 to fullwidth, and frames taller than the workarea are converted to fullheight.
809 NOTE: This only works for non-iconified frames."
810 (pcase-let* ((`(,left
,top
,width
,height
) (cl-cdadr (frame-monitor-attributes frame
)))
811 (right (+ left width -
1))
812 (bottom (+ top height -
1))
813 (fr-left (frameset-compute-pos (frame-parameter frame
'left
) left right
))
814 (fr-top (frameset-compute-pos (frame-parameter frame
'top
) top bottom
))
815 (ch-width (frame-char-width frame
))
816 (ch-height (frame-char-height frame
))
817 (fr-width (max (frame-pixel-width frame
) (* ch-width
(frame-width frame
))))
818 (fr-height (max (frame-pixel-height frame
) (* ch-height
(frame-height frame
))))
819 (fr-right (+ fr-left fr-width -
1))
820 (fr-bottom (+ fr-top fr-height -
1)))
821 (when (pcase force-onscreen
824 (funcall force-onscreen
826 (list fr-left fr-top fr-width fr-height
)
827 (list left top width height
)))
828 ;; Any corner is outside the screen.
829 (:all
(or (< fr-bottom top
) (> fr-bottom bottom
)
830 (< fr-left left
) (> fr-left right
)
831 (< fr-right left
) (> fr-right right
)
832 (< fr-top top
) (> fr-top bottom
)))
833 ;; Displaced to the left, right, above or below the screen.
834 (`t
(or (> fr-left right
)
838 ;; Fully inside, no need to do anything.
840 (let ((fullwidth (> fr-width width
))
841 (fullheight (> fr-height height
))
843 ;; Position frame horizontally.
845 (push `(left .
,left
) params
))
847 (push `(left .
,(+ left
(- width fr-width
))) params
))
849 (push `(left .
,left
) params
)))
850 ;; Position frame vertically.
852 (push `(top .
,top
) params
))
853 ((> fr-bottom bottom
)
854 (push `(top .
,(+ top
(- height fr-height
))) params
))
856 (push `(top .
,top
) params
)))
857 ;; Compute fullscreen state, if required.
858 (when (or fullwidth fullheight
)
859 (push (cons 'fullscreen
860 (cond ((not fullwidth
) 'fullheight
)
861 ((not fullheight
) 'fullwidth
)
864 ;; Finally, move the frame back onscreen.
866 (modify-frame-parameters frame params
))))))
868 (defun frameset--find-frame-if (predicate display
&rest args
)
869 "Find a frame in `frameset--reuse-list' satisfying PREDICATE.
870 Look through available frames whose display property matches DISPLAY
871 and return the first one for which (PREDICATE frame ARGS) returns t.
872 If PREDICATE is nil, it is always satisfied. Internal use only."
873 (cl-find-if (lambda (frame)
874 (and (equal (frame-parameter frame
'display
) display
)
876 (apply predicate frame args
))))
877 frameset--reuse-list
))
879 (defun frameset--reuse-frame (display parameters
)
880 "Return an existing frame to reuse, or nil if none found.
881 DISPLAY is the display where the frame will be shown, and PARAMETERS
882 is the parameter alist of the frame being restored. Internal use only."
885 ;; There are no fancy heuristics there. We could implement some
886 ;; based on frame size and/or position, etc., but it is not clear
887 ;; that any "gain" (in the sense of reduced flickering, etc.) is
888 ;; worth the added complexity. In fact, the code below mainly
889 ;; tries to work nicely when M-x desktop-read is used after a
890 ;; desktop session has already been loaded. The other main use
891 ;; case, which is the initial desktop-read upon starting Emacs,
892 ;; will usually have only one frame, and should already work.
893 (cond ((null display
)
894 ;; When the target is tty, every existing frame is reusable.
895 (setq frame
(frameset--find-frame-if nil display
)))
896 ((car (setq mini
(cdr (assq 'frameset--mini parameters
))))
897 ;; If the frame has its own minibuffer, let's see whether
898 ;; that frame has already been loaded (which can happen after
899 ;; M-x desktop-read).
900 (setq frame
(frameset--find-frame-if
902 (frameset-frame-id-equal-p f id
))
903 display
(cdr (assq 'frameset--id parameters
))))
904 ;; If it has not been loaded, and it is not a minibuffer-only frame,
905 ;; let's look for an existing non-minibuffer-only frame to reuse.
906 (unless (or frame
(eq (cdr (assq 'minibuffer parameters
)) 'only
))
907 (setq frame
(frameset--find-frame-if
909 (let ((w (frame-parameter f
'minibuffer
)))
910 (and (window-live-p w
)
911 (window-minibuffer-p w
)
912 (eq (window-frame w
) f
))))
915 ;; For minibufferless frames, check whether they already exist,
916 ;; and that they are linked to the right minibuffer frame.
917 (setq frame
(frameset--find-frame-if
918 (lambda (f id mini-id
)
919 (and (frameset-frame-id-equal-p f id
)
920 (or (null mini-id
) ; minibuffer frame not saved
921 (frameset-frame-id-equal-p
922 (window-frame (minibuffer-window f
))
925 (cdr (assq 'frameset--id parameters
)) (cdr mini
))))
927 ;; Default to just finding a frame in the same display.
928 (setq frame
(frameset--find-frame-if nil display
))))
929 ;; If found, remove from the list.
931 (setq frameset--reuse-list
(delq frame frameset--reuse-list
)))
934 (defun frameset--initial-params (parameters)
935 "Return a list of PARAMETERS that must be set when creating the frame.
936 Setting position and size parameters as soon as possible helps reducing
937 flickering; other parameters, like `minibuffer' and `border-width', can
938 not be changed once the frame has been created. Internal use only."
939 (cl-loop for param in
'(left top with height border-width minibuffer
)
940 collect
(assq param parameters
)))
942 (defun frameset--restore-frame (parameters window-state filters force-onscreen
)
943 "Set up and return a frame according to its saved state.
944 That means either reusing an existing frame or creating one anew.
945 PARAMETERS is the frame's parameter alist; WINDOW-STATE is its window state.
946 For the meaning of FILTERS and FORCE-ONSCREEN, see `frameset-restore'.
948 (let* ((fullscreen (cdr (assq 'fullscreen parameters
)))
949 (lines (assq 'tool-bar-lines parameters
))
950 (filtered-cfg (frameset-filter-params parameters filters nil
))
951 (display (cdr (assq 'display filtered-cfg
))) ;; post-filtering
954 ;; This works around bug#14795 (or feature#14795, if not a bug :-)
955 (setq filtered-cfg
(assq-delete-all 'tool-bar-lines filtered-cfg
))
956 (push '(tool-bar-lines .
0) filtered-cfg
)
959 ;; Currently Emacs has the limitation that it does not record the size
960 ;; and position of a frame before maximizing it, so we cannot save &
961 ;; restore that info. Instead, when restoring, we resort to creating
962 ;; invisible "fullscreen" frames of default size and then maximizing them
963 ;; (and making them visible) which at least is somewhat user-friendly
964 ;; when these frames are later de-maximized.
965 (let ((width (and (eq fullscreen
'fullheight
) (cdr (assq 'width filtered-cfg
))))
966 (height (and (eq fullscreen
'fullwidth
) (cdr (assq 'height filtered-cfg
))))
967 (visible (assq 'visibility filtered-cfg
)))
968 (setq filtered-cfg
(cl-delete-if (lambda (p)
969 (memq p
'(visibility fullscreen width height
)))
970 filtered-cfg
:key
#'car
))
972 (setq filtered-cfg
(append `((user-size . t
) (width .
,width
))
975 (setq filtered-cfg
(append `((user-size . t
) (height .
,height
))
977 ;; These are parameters to apply after creating/setting the frame.
978 (push visible alt-cfg
)
979 (push (cons 'fullscreen fullscreen
) alt-cfg
)))
981 ;; Time to find or create a frame an apply the big bunch of parameters.
982 ;; If a frame needs to be created and it falls partially or fully offscreen,
983 ;; sometimes it gets "pushed back" onscreen; however, moving it afterwards is
984 ;; allowed. So we create the frame as invisible and then reapply the full
985 ;; parameter alist (including position and size parameters).
986 (setq frame
(or (and frameset--reuse-list
987 (frameset--reuse-frame display filtered-cfg
))
988 (make-frame-on-display display
990 (frameset--initial-params filtered-cfg
)))))
991 (modify-frame-parameters frame
992 (if (eq (frame-parameter frame
'fullscreen
) fullscreen
)
993 ;; Workaround for bug#14949
994 (assq-delete-all 'fullscreen filtered-cfg
)
997 ;; If requested, force frames to be onscreen.
998 (when (and force-onscreen
999 ;; FIXME: iconified frames should be checked too,
1000 ;; but it is impossible without deiconifying them.
1001 (not (eq (frame-parameter frame
'visibility
) 'icon
)))
1002 (frameset-move-onscreen frame force-onscreen
))
1004 ;; Let's give the finishing touches (visibility, tool-bar, maximization).
1005 (when lines
(push lines alt-cfg
))
1006 (when alt-cfg
(modify-frame-parameters frame alt-cfg
))
1007 ;; Now restore window state.
1008 (window-state-put window-state
(frame-root-window frame
) 'safe
)
1011 (defun frameset--minibufferless-last-p (state1 state2
)
1012 "Predicate to sort frame states in an order suitable for creating frames.
1013 It sorts minibuffer-owning frames before minibufferless ones.
1015 (pcase-let ((`(,hasmini1
,id-def1
) (assq 'frameset--mini
(car state1
)))
1016 (`(,hasmini2
,id-def2
) (assq 'frameset--mini
(car state2
))))
1017 (cond ((eq id-def1 t
) t
)
1018 ((eq id-def2 t
) nil
)
1019 ((not (eq hasmini1 hasmini2
)) (eq hasmini1 t
))
1020 ((eq hasmini1 nil
) (or id-def1 id-def2
))
1023 (defun frameset-keep-original-display-p (force-display)
1024 "True if saved frames' displays should be honored.
1025 For the meaning of FORCE-DISPLAY, see `frameset-restore'."
1027 ((eq system-type
'windows-nt
) nil
) ;; Does ns support more than one display?
1028 (t (not force-display
))))
1030 (defun frameset-minibufferless-first-p (frame1 _frame2
)
1031 "Predicate to sort minibufferless frames before other frames."
1032 (not (frame-parameter frame1
'minibuffer
)))
1035 (cl-defun frameset-restore (frameset
1036 &key predicate filters reuse-frames
1037 force-display force-onscreen
)
1038 "Restore a FRAMESET into the current display(s).
1040 PREDICATE is a function called with two arguments, the parameter alist
1041 and the window-state of the frame being restored, in that order (see
1042 the docstring of the `frameset' defstruct for additional details).
1043 If PREDICATE returns nil, the frame described by that parameter alist
1044 and window-state is not restored.
1046 FILTERS is an alist of parameter filters; if nil, the value of
1047 `frameset-filter-alist' is used instead.
1049 REUSE-FRAMES selects the policy to use to reuse frames when restoring:
1050 t Reuse existing frames if possible, and delete those not reused.
1051 nil Restore frameset in new frames and delete existing frames.
1052 :keep Restore frameset in new frames and keep the existing ones.
1053 LIST A list of frames to reuse; only these are reused (if possible).
1054 Remaining frames in this list are deleted; other frames not
1055 included on the list are left untouched.
1057 FORCE-DISPLAY can be:
1058 t Frames are restored in the current display.
1059 nil Frames are restored, if possible, in their original displays.
1060 :delete Frames in other displays are deleted instead of restored.
1061 PRED A function called with two arguments, the parameter alist and
1062 the window state (in that order). It must return t, nil or
1063 `:delete', as above but affecting only the frame that will
1064 be created from that parameter alist.
1066 FORCE-ONSCREEN can be:
1067 t Force onscreen only those frames that are fully offscreen.
1068 nil Do not force any frame back onscreen.
1069 :all Force onscreen any frame fully or partially offscreen.
1070 PRED A function called with three arguments,
1071 - the live frame just restored,
1072 - a list (LEFT TOP WIDTH HEIGHT), describing the frame,
1073 - a list (LEFT TOP WIDTH HEIGHT), describing the workarea.
1074 It must return non-nil to force the frame onscreen, nil otherwise.
1076 Note the timing and scope of the operations described above: REUSE-FRAMES
1077 affects existing frames; PREDICATE, FILTERS and FORCE-DISPLAY affect the frame
1078 being restored before that happens; and FORCE-ONSCREEN affects the frame once
1079 it has been restored.
1081 All keyword parameters default to nil."
1083 (cl-assert (frameset-valid-p frameset
))
1087 ;; frameset--reuse-list is a list of frames potentially reusable. Later we
1088 ;; will decide which ones can be reused, and how to deal with any leftover.
1091 (setq frameset--reuse-list nil
1092 other-frames
(frame-list)))
1094 (setq frameset--reuse-list
(copy-sequence reuse-frames
)
1095 other-frames
(cl-delete-if (lambda (frame)
1096 (memq frame frameset--reuse-list
))
1099 (setq frameset--reuse-list
(frame-list)
1102 ;; Sort saved states to guarantee that minibufferless frames will be created
1103 ;; after the frames that contain their minibuffer windows.
1104 (dolist (state (sort (copy-sequence (frameset-states frameset
))
1105 #'frameset--minibufferless-last-p
))
1106 (pcase-let ((`(,frame-cfg .
,window-cfg
) state
))
1107 (when (or (null predicate
) (funcall predicate frame-cfg window-cfg
))
1108 (condition-case-unless-debug err
1109 (let* ((d-mini (cdr (assq 'frameset--mini frame-cfg
)))
1110 (mb-id (cdr d-mini
))
1111 (default (and (car d-mini
) mb-id
))
1112 (force-display (if (functionp force-display
)
1113 (funcall force-display frame-cfg window-cfg
)
1116 ;; Only set target if forcing displays and the target display is different.
1117 (cond ((frameset-keep-original-display-p force-display
)
1118 (setq frameset--target-display nil
))
1119 ((eq (frame-parameter nil
'display
) (cdr (assq 'display frame-cfg
)))
1120 (setq frameset--target-display nil
))
1122 (setq frameset--target-display
(cons 'display
1123 (frame-parameter nil
'display
))
1124 to-tty
(null (cdr frameset--target-display
)))))
1125 ;; Time to restore frames and set up their minibuffers as they were.
1126 ;; We only skip a frame (thus deleting it) if either:
1127 ;; - we're switching displays, and the user chose the option to delete, or
1128 ;; - we're switching to tty, and the frame to restore is minibuffer-only.
1129 (unless (and frameset--target-display
1130 (or (eq force-display
:delete
)
1132 (eq (cdr (assq 'minibuffer frame-cfg
)) 'only
))))
1133 ;; If keeping non-reusable frames, and the frameset--id of one of them
1134 ;; matches the id of a frame being restored (because, for example, the
1135 ;; frameset has already been read in the same session), remove the
1136 ;; frameset--id from the non-reusable frame, which is not useful anymore.
1137 (when (and other-frames
1138 (or (eq reuse-frames
:keep
) (consp reuse-frames
)))
1139 (let ((dup (frameset-frame-with-id (cdr (assq 'frameset--id frame-cfg
))
1142 (set-frame-parameter dup
'frameset--id nil
))))
1143 ;; Restore minibuffers. Some of this stuff could be done in a filter
1144 ;; function, but it would be messy because restoring minibuffers affects
1145 ;; global state; it's best to do it here than add a bunch of global
1146 ;; variables to pass info back-and-forth to/from the filter function.
1148 ((null d-mini
)) ;; No frameset--mini. Process as normal frame.
1149 (to-tty) ;; Ignore minibuffer stuff and process as normal frame.
1150 ((car d-mini
) ;; Frame has minibuffer (or it is minibuffer-only).
1151 (when (eq (cdr (assq 'minibuffer frame-cfg
)) 'only
)
1152 (setq frame-cfg
(append '((tool-bar-lines .
0) (menu-bar-lines .
0))
1154 (t ;; Frame depends on other frame's minibuffer window.
1156 (let ((mb-frame (frameset-frame-with-id mb-id
))
1159 (delay-warning 'frameset
1160 (format "Minibuffer frame %S not found" mb-id
)
1162 (setq mb-window
(minibuffer-window mb-frame
))
1163 (unless (and (window-live-p mb-window
)
1164 (window-minibuffer-p mb-window
))
1165 (delay-warning 'frameset
1166 (format "Not a minibuffer window %s" mb-window
)
1168 (setq mb-window nil
)))
1170 (push (cons 'minibuffer mb-window
) frame-cfg
))))))
1171 ;; OK, we're ready at last to create (or reuse) a frame and
1172 ;; restore the window config.
1173 (setq frame
(frameset--restore-frame frame-cfg window-cfg
1174 (or filters frameset-filter-alist
)
1176 ;; Set default-minibuffer if required.
1177 (when default
(setq default-minibuffer-frame frame
))))
1179 (delay-warning 'frameset
(error-message-string err
) :error
))))))
1181 ;; In case we try to delete the initial frame, we want to make sure that
1182 ;; other frames are already visible (discussed in thread for bug#14841).
1185 ;; Delete remaining frames, but do not fail if some resist being deleted.
1186 (unless (eq reuse-frames
:keep
)
1187 (dolist (frame (sort (nconc (if (listp reuse-frames
) nil other-frames
)
1188 frameset--reuse-list
)
1189 ;; Minibufferless frames must go first to avoid
1190 ;; errors when attempting to delete a frame whose
1191 ;; minibuffer window is used by another frame.
1192 #'frameset-minibufferless-first-p
))
1194 (delete-frame frame
)
1196 (delay-warning 'frameset
(error-message-string err
))))))
1197 (setq frameset--reuse-list nil
1198 frameset--target-display nil
)
1200 ;; Make sure there's at least one visible frame.
1201 (unless (or (daemonp) (visible-frame-list))
1202 (make-frame-visible (car (frame-list))))))
1207 (defun frameset--jump-to-register (data)
1208 "Restore frameset from DATA stored in register.
1209 Called from `jump-to-register'. Internal use only."
1210 (let* ((delete (and current-prefix-arg t
))
1211 (iconify-list (if delete nil
(frame-list))))
1212 (frameset-restore (aref data
0)
1213 :filters frameset-session-filter-alist
1214 :reuse-frames
(if delete t
:keep
))
1215 (mapc #'iconify-frame iconify-list
)
1216 (let ((frame (frameset-frame-with-id (aref data
1)))
1219 (select-frame-set-input-focus frame
)
1220 (when (and (buffer-live-p (setq buffer
(marker-buffer (aref data
2))))
1221 (window-live-p (setq window
(get-buffer-window buffer frame
))))
1222 (set-frame-selected-window frame window
)
1223 (with-current-buffer buffer
(goto-char (aref data
2))))))))
1226 (defun frameset-to-register (register)
1227 "Store the current frameset in register REGISTER.
1228 Use \\[jump-to-register] to restore the frameset.
1229 Argument is a character, naming the register.
1231 Interactively, reads the register using `register-read-with-preview'."
1232 (interactive (list (register-read-with-preview "Frameset to register: ")))
1233 (set-register register
1235 (vector (frameset-save nil
1237 :filters frameset-session-filter-alist
)
1238 ;; frameset-save does not include the value of point
1239 ;; in the current buffer, so record that separately.
1240 (frameset-frame-id nil
)
1242 :print-func
(lambda (_data) (princ "a frameset."))
1243 :jump-func
#'frameset--jump-to-register
)))
1247 ;;; frameset.el ends here