Feature #65: Auxiliary window detection
- Add auxiliary window detection (--detect-transient & --detect-client-leader). Thanks to SmilingHorse for inspiring me. The implementation is not too speed-efficient, and bugs are to be expected. - Known issue: auxiliary window detection may not work too well with windows that are never mapped, for example as client leader.
This commit is contained in:
Richard Grenville
parent
33171e8933
commit
848687b853
|
|
@ -43,6 +43,8 @@ paint-on-overlay = false;
|
|||
sw-opti = false;
|
||||
unredir-if-possible = false;
|
||||
focus-exclude = [ ];
|
||||
detect-transient = true;
|
||||
detect-client-leader = true;
|
||||
|
||||
# Window type settings
|
||||
wintypes:
|
||||
|
|
|
|||
176
src/compton.c
176
src/compton.c
|
|
@ -846,45 +846,6 @@ determine_evmask(session_t *ps, Window wid, win_evmode_t mode) {
|
|||
return evmask;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a window from window id in window linked list of the session.
|
||||
*/
|
||||
static win *
|
||||
find_win(session_t *ps, Window id) {
|
||||
if (!id)
|
||||
return NULL;
|
||||
|
||||
win *w;
|
||||
|
||||
for (w = ps->list; w; w = w->next) {
|
||||
if (w->id == id && !w->destroyed)
|
||||
return w;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find out the WM frame of a client window using existing data.
|
||||
*
|
||||
* @param w window ID
|
||||
* @return struct _win object of the found window, NULL if not found
|
||||
*/
|
||||
static win *
|
||||
find_toplevel(session_t *ps, Window id) {
|
||||
if (!id)
|
||||
return NULL;
|
||||
|
||||
win *w;
|
||||
|
||||
for (w = ps->list; w; w = w->next) {
|
||||
if (w->client_win == id && !w->destroyed)
|
||||
return w;
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find out the WM frame of a client window by querying X.
|
||||
*
|
||||
|
|
@ -1820,7 +1781,6 @@ map_win(session_t *ps, Window id) {
|
|||
focused_real = true;
|
||||
win_set_focused(ps, w, focused_real);
|
||||
|
||||
|
||||
// Call XSelectInput() before reading properties so that no property
|
||||
// changes are lost
|
||||
XSelectInput(ps->dpy, id, determine_evmask(ps, id, WIN_EVMODE_FRAME));
|
||||
|
|
@ -2238,6 +2198,10 @@ win_mark_client(session_t *ps, win *w, Window client) {
|
|||
w->window_type = WINTYPE_DIALOG;
|
||||
}
|
||||
|
||||
// Get window group
|
||||
if (ps->o.track_leader)
|
||||
win_update_leader(ps, w);
|
||||
|
||||
win_update_focused(ps, w);
|
||||
}
|
||||
|
||||
|
|
@ -2382,6 +2346,7 @@ add_win(session_t *ps, Window id, Window prev) {
|
|||
new->focused = false;
|
||||
new->focused_real = false;
|
||||
new->leader = None;
|
||||
new->cache_leader = None;
|
||||
new->destroyed = false;
|
||||
new->need_configure = false;
|
||||
new->window_type = WINTYPE_UNKNOWN;
|
||||
|
|
@ -2739,6 +2704,91 @@ wid_get_prop_window(session_t *ps, Window wid, Atom aprop) {
|
|||
return p;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update leader of a window.
|
||||
*/
|
||||
static void
|
||||
win_update_leader(session_t *ps, win *w) {
|
||||
Window leader = None;
|
||||
|
||||
// Read the leader properties
|
||||
if (ps->o.detect_transient && !leader)
|
||||
leader = wid_get_prop_window(ps, w->client_win, ps->atom_transient);
|
||||
|
||||
if (ps->o.detect_client_leader && !leader)
|
||||
leader = wid_get_prop_window(ps, w->client_win, ps->atom_client_leader);
|
||||
|
||||
win_set_leader(ps, w, leader);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set leader of a window.
|
||||
*/
|
||||
static void
|
||||
win_set_leader(session_t *ps, win *w, Window nleader) {
|
||||
// If the leader changes
|
||||
if (w->leader != nleader) {
|
||||
Window cache_leader_old = win_get_leader(ps, w);
|
||||
|
||||
w->leader = nleader;
|
||||
|
||||
// Forcefully do this to deal with the case when a child window
|
||||
// gets mapped before parent, or when the window is a waypoint
|
||||
clear_cache_win_leaders(ps);
|
||||
|
||||
// Update the old and new window group and active_leader if the window
|
||||
// could affect their state.
|
||||
Window cache_leader = win_get_leader(ps, w);
|
||||
if (w->focused_real && cache_leader_old != cache_leader) {
|
||||
ps->active_leader = cache_leader;
|
||||
|
||||
group_update_focused(ps, cache_leader_old);
|
||||
group_update_focused(ps, cache_leader);
|
||||
}
|
||||
// Otherwise, at most the window itself is affected
|
||||
else {
|
||||
win_update_focused(ps, w);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the leader of a window.
|
||||
*
|
||||
* This function updates w->cache_leader if necessary.
|
||||
*/
|
||||
static Window
|
||||
win_get_leader(session_t *ps, win *w) {
|
||||
return win_get_leader_raw(ps, w, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function of win_get_leader().
|
||||
*/
|
||||
static Window
|
||||
win_get_leader_raw(session_t *ps, win *w, int recursions) {
|
||||
// Rebuild the cache if needed
|
||||
if (!w->cache_leader && (w->client_win || w->leader)) {
|
||||
// Leader defaults to client window
|
||||
if (!(w->cache_leader = w->leader))
|
||||
w->cache_leader = w->client_win;
|
||||
|
||||
// If the leader of this window isn't itself, look for its ancestors
|
||||
if (w->cache_leader && w->cache_leader != w->client_win) {
|
||||
win *wp = find_toplevel(ps, w->cache_leader);
|
||||
if (wp) {
|
||||
// Dead loop?
|
||||
if (recursions > WIN_GET_LEADER_MAX_RECURSION)
|
||||
return None;
|
||||
|
||||
w->cache_leader = win_get_leader_raw(ps, wp, recursions + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return w->cache_leader;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of a text property of a window.
|
||||
*/
|
||||
|
|
@ -3173,10 +3223,10 @@ update_ewmh_active_win(session_t *ps) {
|
|||
|
||||
// Mark the window focused
|
||||
if (w) {
|
||||
win_set_focused(ps, w, true);
|
||||
if (ps->active_win && w != ps->active_win)
|
||||
win_set_focused(ps, ps->active_win, false);
|
||||
ps->active_win = w;
|
||||
win_set_focused(ps, w, true);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -3280,6 +3330,16 @@ ev_property_notify(session_t *ps, XPropertyEvent *ev) {
|
|||
if (w)
|
||||
win_update_attr_shadow(ps, w);
|
||||
}
|
||||
|
||||
// If a leader property changes
|
||||
if ((ps->o.detect_transient && ps->atom_transient == ev->atom)
|
||||
|| (ps->o.detect_client_leader && ps->atom_client_leader == ev->atom)) {
|
||||
win *w = find_toplevel(ps, ev->window);
|
||||
if (w) {
|
||||
win_update_leader(ps, w);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
inline static void
|
||||
|
|
@ -3558,6 +3618,13 @@ usage(void) {
|
|||
" considered focused.\n"
|
||||
"--inactive-dim-fixed\n"
|
||||
" Use fixed inactive dim value.\n"
|
||||
"--detect-transient\n"
|
||||
" Use WM_TRANSIENT_FOR to group windows, and consider windows in\n"
|
||||
" the same group focused at the same time.\n"
|
||||
"--detect-client-leader\n"
|
||||
" Use WM_CLIENT_LEADER to group windows, and consider windows in\n"
|
||||
" the same group focused at the same time. WM_TRANSIENT_FOR has\n"
|
||||
" higher priority if --detect-transient is enabled, too.\n"
|
||||
"\n"
|
||||
"Format of a condition:\n"
|
||||
"\n"
|
||||
|
|
@ -3955,6 +4022,11 @@ parse_config(session_t *ps, char *cpath, struct options_tmp *pcfgtmp) {
|
|||
&ps->o.unredir_if_possible);
|
||||
// --inactive-dim-fixed
|
||||
lcfg_lookup_bool(&cfg, "inactive-dim-fixed", &ps->o.inactive_dim_fixed);
|
||||
// --detect-transient
|
||||
lcfg_lookup_bool(&cfg, "detect-transient", &ps->o.detect_transient);
|
||||
// --detect-client-leader
|
||||
lcfg_lookup_bool(&cfg, "detect-client-leader",
|
||||
&ps->o.detect_client_leader);
|
||||
// --shadow-exclude
|
||||
parse_cfg_condlst(&cfg, &ps->o.shadow_blacklist, "shadow-exclude");
|
||||
// --focus-exclude
|
||||
|
|
@ -4016,6 +4088,8 @@ get_cfg(session_t *ps, int argc, char *const *argv) {
|
|||
{ "unredir-if-possible", no_argument, NULL, 278 },
|
||||
{ "focus-exclude", required_argument, NULL, 279 },
|
||||
{ "inactive-dim-fixed", no_argument, NULL, 280 },
|
||||
{ "detect-transient", no_argument, NULL, 281 },
|
||||
{ "detect-client-leader", no_argument, NULL, 282 },
|
||||
// Must terminate with a NULL entry
|
||||
{ NULL, 0, NULL, 0 },
|
||||
};
|
||||
|
|
@ -4225,6 +4299,14 @@ get_cfg(session_t *ps, int argc, char *const *argv) {
|
|||
// --inactive-dim-fixed
|
||||
ps->o.inactive_dim_fixed = true;
|
||||
break;
|
||||
case 281:
|
||||
// --detect-transient
|
||||
ps->o.detect_transient = true;
|
||||
break;
|
||||
case 282:
|
||||
// --detect-client-leader
|
||||
ps->o.detect_client_leader = true;
|
||||
break;
|
||||
default:
|
||||
usage();
|
||||
}
|
||||
|
|
@ -4274,6 +4356,12 @@ get_cfg(session_t *ps, int argc, char *const *argv) {
|
|||
if (ps->o.shadow_blacklist || ps->o.fade_blacklist
|
||||
|| ps->o.focus_blacklist)
|
||||
ps->o.track_wdata = true;
|
||||
|
||||
// Determine whether we track window grouping
|
||||
if (ps->o.detect_transient || ps->o.detect_client_leader) {
|
||||
ps->o.track_leader = true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -4289,6 +4377,7 @@ init_atoms(session_t *ps) {
|
|||
ps->atom_class = XA_WM_CLASS;
|
||||
ps->atom_role = XInternAtom(ps->dpy, "WM_WINDOW_ROLE", False);
|
||||
ps->atom_transient = XA_WM_TRANSIENT_FOR;
|
||||
ps->atom_client_leader = XInternAtom(ps->dpy, "WM_CLIENT_LEADER", False);
|
||||
ps->atom_ewmh_active_win = XInternAtom(ps->dpy, "_NET_ACTIVE_WINDOW", False);
|
||||
ps->atom_compton_shadow = XInternAtom(ps->dpy, "_COMPTON_SHADOW", False);
|
||||
|
||||
|
|
@ -4759,9 +4848,12 @@ session_init(session_t *ps_old, int argc, char **argv) {
|
|||
.wintype_focus = { false },
|
||||
.use_ewmh_active_win = false,
|
||||
.focus_blacklist = NULL,
|
||||
.detect_transient = false,
|
||||
.detect_client_leader = false,
|
||||
|
||||
.track_focus = false,
|
||||
.track_wdata = false,
|
||||
.track_leader = false,
|
||||
},
|
||||
|
||||
.all_damage = None,
|
||||
|
|
@ -4782,6 +4874,8 @@ session_init(session_t *ps_old, int argc, char **argv) {
|
|||
|
||||
.list = NULL,
|
||||
.active_win = NULL,
|
||||
.active_leader = None,
|
||||
|
||||
.black_picture = None,
|
||||
.cshadow_picture = None,
|
||||
.gaussian_map = NULL,
|
||||
|
|
|
|||
156
src/compton.h
156
src/compton.h
|
|
@ -109,6 +109,7 @@
|
|||
|
||||
#define FADE_DELTA_TOLERANCE 0.2
|
||||
#define SW_OPTI_TOLERANCE 1000
|
||||
#define WIN_GET_LEADER_MAX_RECURSION 20
|
||||
|
||||
#define NS_PER_SEC 1000000000L
|
||||
#define US_PER_SEC 1000000L
|
||||
|
|
@ -332,12 +333,18 @@ typedef struct {
|
|||
bool use_ewmh_active_win;
|
||||
/// A list of windows always to be considered focused.
|
||||
wincond_t *focus_blacklist;
|
||||
/// Whether to do window grouping with <code>WM_TRANSIENT_FOR</code>.
|
||||
bool detect_transient;
|
||||
/// Whether to do window grouping with <code>WM_CLIENT_LEADER</code>.
|
||||
bool detect_client_leader;
|
||||
|
||||
// === Calculated ===
|
||||
/// Whether compton needs to track focus changes.
|
||||
bool track_focus;
|
||||
/// Whether compton needs to track window name and class.
|
||||
bool track_wdata;
|
||||
/// Whether compton needs to track window leaders.
|
||||
bool track_leader;
|
||||
|
||||
} options_t;
|
||||
|
||||
|
|
@ -424,6 +431,9 @@ typedef struct {
|
|||
/// case the WM does something extraordinary, but caching the pointer
|
||||
/// means another layer of complexity.
|
||||
struct _win *active_win;
|
||||
/// Window ID of leader window of currently active window. Used for
|
||||
/// subsidiary window detection.
|
||||
Window active_leader;
|
||||
|
||||
// === Shadow/dimming related ===
|
||||
/// 1x1 black Picture.
|
||||
|
|
@ -527,6 +537,8 @@ typedef struct {
|
|||
Atom atom_role;
|
||||
/// Atom of property <code>WM_TRANSIENT_FOR</code>.
|
||||
Atom atom_transient;
|
||||
/// Atom of property <code>WM_CLIENT_LEADER</code>.
|
||||
Atom atom_client_leader;
|
||||
/// Atom of property <code>_NET_ACTIVE_WINDOW</code>.
|
||||
Atom atom_ewmh_active_win;
|
||||
/// Atom of property <code>_COMPTON_SHADOW</code>.
|
||||
|
|
@ -566,6 +578,8 @@ typedef struct _win {
|
|||
bool focused_real;
|
||||
/// Leader window ID of the window.
|
||||
Window leader;
|
||||
/// Cached topmost window ID of the window.
|
||||
Window cache_leader;
|
||||
/// Whether the window has been destroyed.
|
||||
bool destroyed;
|
||||
/// Cached width/height of the window including border.
|
||||
|
|
@ -1360,15 +1374,81 @@ condlst_add(wincond_t **pcondlst, const char *pattern);
|
|||
static long
|
||||
determine_evmask(session_t *ps, Window wid, win_evmode_t mode);
|
||||
|
||||
static win *
|
||||
find_win(session_t *ps, Window id);
|
||||
/**
|
||||
* Find a window from window id in window linked list of the session.
|
||||
*/
|
||||
static inline win *
|
||||
find_win(session_t *ps, Window id) {
|
||||
if (!id)
|
||||
return NULL;
|
||||
|
||||
static win *
|
||||
find_toplevel(session_t *ps, Window id);
|
||||
win *w;
|
||||
|
||||
for (w = ps->list; w; w = w->next) {
|
||||
if (w->id == id && !w->destroyed)
|
||||
return w;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find out the WM frame of a client window using existing data.
|
||||
*
|
||||
* @param w window ID
|
||||
* @return struct _win object of the found window, NULL if not found
|
||||
*/
|
||||
static inline win *
|
||||
find_toplevel(session_t *ps, Window id) {
|
||||
if (!id)
|
||||
return NULL;
|
||||
|
||||
for (win *w = ps->list; w; w = w->next) {
|
||||
if (w->client_win == id && !w->destroyed)
|
||||
return w;
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear leader cache of all windows.
|
||||
*/
|
||||
static void
|
||||
clear_cache_win_leaders(session_t *ps) {
|
||||
for (win *w = ps->list; w; w = w->next)
|
||||
w->cache_leader = None;
|
||||
}
|
||||
|
||||
static win *
|
||||
find_toplevel2(session_t *ps, Window wid);
|
||||
|
||||
static Window
|
||||
win_get_leader(session_t *ps, win *w);
|
||||
|
||||
static Window
|
||||
win_get_leader_raw(session_t *ps, win *w, int recursions);
|
||||
|
||||
/**
|
||||
* Return whether a window group is really focused.
|
||||
*
|
||||
* @param leader leader window ID
|
||||
* @return true if the window group is focused, false otherwise
|
||||
*/
|
||||
static inline bool
|
||||
group_is_focused(session_t *ps, Window leader) {
|
||||
if (!leader)
|
||||
return false;
|
||||
|
||||
for (win *w = ps->list; w; w = w->next) {
|
||||
if (win_get_leader(ps, w) == leader && !w->destroyed
|
||||
&& w->focused_real)
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
static win *
|
||||
recheck_focus(session_t *ps);
|
||||
|
||||
|
|
@ -1449,6 +1529,15 @@ calc_opacity(session_t *ps, win *w);
|
|||
static void
|
||||
calc_dim(session_t *ps, win *w);
|
||||
|
||||
static Window
|
||||
wid_get_prop_window(session_t *ps, Window wid, Atom aprop);
|
||||
|
||||
static void
|
||||
win_update_leader(session_t *ps, win *w);
|
||||
|
||||
static void
|
||||
win_set_leader(session_t *ps, win *w, Window leader);
|
||||
|
||||
/**
|
||||
* Update focused state of a window.
|
||||
*/
|
||||
|
|
@ -1467,10 +1556,35 @@ win_update_focused(session_t *ps, win *w) {
|
|||
|| win_match(w, ps->o.focus_blacklist, &w->cache_fcblst))
|
||||
w->focused = true;
|
||||
|
||||
// If window grouping detection is enabled, mark the window active if
|
||||
// its group is
|
||||
if (ps->o.track_leader && ps->active_leader
|
||||
&& win_get_leader(ps, w) == ps->active_leader) {
|
||||
w->focused = true;
|
||||
}
|
||||
|
||||
if (w->focused != focused_old)
|
||||
w->flags |= WFLAG_OPCT_CHANGE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run win_update_focused() on all windows with the same leader window.
|
||||
*
|
||||
* @param leader leader window ID
|
||||
*/
|
||||
static inline void
|
||||
group_update_focused(session_t *ps, Window leader) {
|
||||
if (!leader)
|
||||
return;
|
||||
|
||||
for (win *w = ps->list; w; w = w->next) {
|
||||
if (win_get_leader(ps, w) == leader && !w->destroyed)
|
||||
win_update_focused(ps, w);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set real focused state of a window.
|
||||
*/
|
||||
|
|
@ -1480,8 +1594,38 @@ win_set_focused(session_t *ps, win *w, bool focused) {
|
|||
if (IsUnmapped == w->a.map_state)
|
||||
return;
|
||||
|
||||
w->focused_real = focused;
|
||||
win_update_focused(ps, w);
|
||||
if (w->focused_real != focused) {
|
||||
w->focused_real = focused;
|
||||
|
||||
// If window grouping detection is enabled
|
||||
if (ps->o.track_leader && win_get_leader(ps, w)) {
|
||||
Window leader = win_get_leader(ps, w);
|
||||
|
||||
// If the window gets focused, replace the old active_leader
|
||||
if (w->focused_real && leader != ps->active_leader) {
|
||||
Window active_leader_old = ps->active_leader;
|
||||
|
||||
ps->active_leader = leader;
|
||||
|
||||
group_update_focused(ps, active_leader_old);
|
||||
group_update_focused(ps, leader);
|
||||
}
|
||||
// If the group get unfocused, remove it from active_leader
|
||||
else if (!w->focused_real && leader == ps->active_leader
|
||||
&& !group_is_focused(ps, leader)) {
|
||||
ps->active_leader = None;
|
||||
group_update_focused(ps, leader);
|
||||
}
|
||||
else {
|
||||
// The window itself must be updated anyway
|
||||
win_update_focused(ps, w);
|
||||
}
|
||||
}
|
||||
// Otherwise, only update the window itself
|
||||
else {
|
||||
win_update_focused(ps, w);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void
|
||||
|
|
|
|||
Loading…
Reference in New Issue