BitHeaven
/
picom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #238 from yshui/window-updates 

Window updates
This commit is contained in:
yshui 2019-09-20 01:29:43 +00:00 committed by GitHub
parent 3060fe8f2c 3766aa2c79
commit b38a5ae366
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 400 additions and 259 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/backend/backend.c
View File

@ -137,6 +137,8 @@ void paint_all_new(session_t *ps, struct managed_win *t, bool ignore_damage) {
for (auto w = t; w; w = w->prev_trans) { for (auto w = t; w; w = w->prev_trans) {
pixman_region32_subtract(&reg_visible, &ps->screen_reg, w->reg_ignore); pixman_region32_subtract(&reg_visible, &ps->screen_reg, w->reg_ignore);
assert(!(w->flags & WIN_FLAGS_IMAGE_ERROR)); assert(!(w->flags & WIN_FLAGS_IMAGE_ERROR));
assert(!(w->flags & WIN_FLAGS_PIXMAP_STALE));
assert(!(w->flags & WIN_FLAGS_PIXMAP_NONE));
// The bounding shape of the window, in global/target coordinates // The bounding shape of the window, in global/target coordinates
// reminder: bounding shape contains the WM frame // reminder: bounding shape contains the WM frame
@ -201,6 +203,7 @@ void paint_all_new(session_t *ps, struct managed_win *t, bool ignore_damage) {
// Draw shadow on target // Draw shadow on target
if (w->shadow) { if (w->shadow) {
assert(!(w->flags & WIN_FLAGS_SHADOW_NONE));
// Clip region for the shadow // Clip region for the shadow
// reg_shadow \in reg_paint // reg_shadow \in reg_paint
auto reg_shadow = win_extents_by_val(w); auto reg_shadow = win_extents_by_val(w);

78
src/compton.c
View File

@ -662,7 +662,7 @@ static void destroy_backend(session_t *ps) {
if (ps->backend_data) { if (ps->backend_data) {
if (w->state == WSTATE_MAPPED) { if (w->state == WSTATE_MAPPED) {
win_release_image(ps->backend_data, w); win_release_images(ps->backend_data, w);
} else { } else {
assert(!w->win_image); assert(!w->win_image);
assert(!w->shadow_image); assert(!w->shadow_image);
@ -752,10 +752,14 @@ static bool initialize_backend(session_t *ps) {
continue; continue;
} }
auto w = (struct managed_win *)_w; auto w = (struct managed_win *)_w;
if (w->a.map_state == XCB_MAP_STATE_VIEWABLE) { assert(w->state == WSTATE_MAPPED || w->state == WSTATE_UNMAPPED);
if (!win_bind_image(ps, w)) { if (w->state == WSTATE_MAPPED) {
w->flags |= WIN_FLAGS_IMAGE_ERROR; // We need to reacquire image
} log_debug("Marking window %#010x (%s) for update after "
"redirection",
w->base.id, w->name);
w->flags |= WIN_FLAGS_IMAGES_STALE;
ps->pending_updates = true;
} }
} }
} }
@ -1269,7 +1273,10 @@ static void handle_new_windows(session_t *ps) {
} }
auto mw = (struct managed_win *)new_w; auto mw = (struct managed_win *)new_w;
if (mw->a.map_state == XCB_MAP_STATE_VIEWABLE) { if (mw->a.map_state == XCB_MAP_STATE_VIEWABLE) {
map_win(ps, mw); // Have to map immediately instead of queue window update
// because we need the window's extent right now.
// We can do this because we are in the critical section.
map_win_start(ps, mw);
// This window might be damaged before we called fill_win // This window might be damaged before we called fill_win
// and created the damage handle. And there is no way for // and created the damage handle. And there is no way for
@ -1281,21 +1288,15 @@ static void handle_new_windows(session_t *ps) {
} }
} }
static void refresh_windows(session_t *ps) {
win_stack_foreach_managed_safe(w, &ps->window_stack) {
win_process_updates(ps, w);
}
}
static void refresh_stale_images(session_t *ps) { static void refresh_stale_images(session_t *ps) {
win_stack_foreach_managed(w, &ps->window_stack) { win_stack_foreach_managed(w, &ps->window_stack) {
if ((w->flags & WIN_FLAGS_IMAGE_STALE) != 0 && win_process_flags(ps, w);
(w->flags & WIN_FLAGS_IMAGE_ERROR) == 0) {
// Image needs to be updated, update it.
w->flags &= ~WIN_FLAGS_IMAGE_STALE;
if (w->state != WSTATE_UNMAPPING &&
w->state != WSTATE_DESTROYING && ps->backend_data) {
// Rebind image only when the window does have an image
// available
if (!win_try_rebind_image(ps, w)) {
w->flags |= WIN_FLAGS_IMAGE_ERROR;
}
}
}
} }
} }
@ -1313,7 +1314,7 @@ static void fade_timer_callback(EV_P attr_unused, ev_timer *w, int revents attr_
queue_redraw(ps); queue_redraw(ps);
} }
static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) { static void handle_pending_updates(EV_P_ struct session *ps) {
if (ps->pending_updates) { if (ps->pending_updates) {
log_debug("Delayed handling of events, entering critical section"); log_debug("Delayed handling of events, entering critical section");
auto e = xcb_request_check(ps->c, xcb_grab_server_checked(ps->c)); auto e = xcb_request_check(ps->c, xcb_grab_server_checked(ps->c));
@ -1337,10 +1338,14 @@ static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) {
recheck_focus(ps); recheck_focus(ps);
} }
// Refresh pixmaps // Process window updates
refresh_windows(ps);
// Refresh pixmaps and shadows
refresh_stale_images(ps); refresh_stale_images(ps);
ps->server_grabbed = false; // Handle screen changes
handle_root_flags(ps);
e = xcb_request_check(ps->c, xcb_ungrab_server_checked(ps->c)); e = xcb_request_check(ps->c, xcb_ungrab_server_checked(ps->c));
if (e) { if (e) {
@ -1350,9 +1355,14 @@ static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) {
return quit_compton(ps); return quit_compton(ps);
} }
ps->server_grabbed = false;
ps->pending_updates = false; ps->pending_updates = false;
log_debug("Exiting critical section"); log_debug("Exited critical section");
} }
}
static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) {
handle_pending_updates(EV_A_ ps);
if (ps->o.benchmark) { if (ps->o.benchmark) {
if (ps->o.benchmark_wid) { if (ps->o.benchmark_wid) {
@ -1367,11 +1377,6 @@ static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) {
} }
} }
// TODO xcb_grab_server
// TODO clean up event queue
handle_root_flags(ps);
// TODO have a stripped down version of paint_preprocess that is used when screen // TODO have a stripped down version of paint_preprocess that is used when screen
// is not redirected. its sole purpose should be to decide whether the screen // is not redirected. its sole purpose should be to decide whether the screen
// should be redirected. // should be redirected.
@ -1382,11 +1387,14 @@ static void _draw_callback(EV_P_ session_t *ps, int revents attr_unused) {
if (!was_redirected && ps->redirected) { if (!was_redirected && ps->redirected) {
// paint_preprocess redirected the screen, which might change the state of // paint_preprocess redirected the screen, which might change the state of
// some of the windows (e.g. the window image might fail to bind, and the // some of the windows (e.g. the window image might become stale).
// window would be put into an error state). so we rerun paint_preprocess // so we rerun _draw_callback to make sure the rendering decision we make
// here to make sure the rendering decision we make is up-to-date // is up-to-date, and all the new flags got handled.
log_debug("Re-run paint_preprocess"); //
bottom = paint_preprocess(ps, &fade_running); // TODO This is not ideal, we should try to avoid setting window flags in
// paint_preprocess.
log_debug("Re-run _draw_callback");
return _draw_callback(EV_A_ ps, revents);
} }
// Start/stop fade timer depends on whether window are fading // Start/stop fade timer depends on whether window are fading
@ -2022,9 +2030,9 @@ static session_t *session_init(int argc, char **argv, Display *dpy,
free(query_tree_reply); free(query_tree_reply);
} }
log_trace("Initial stack:"); log_debug("Initial stack:");
list_foreach(struct win, w, &ps->window_stack, stack_neighbour) { list_foreach(struct win, w, &ps->window_stack, stack_neighbour) {
log_trace("%#010x", w->id); log_debug("%#010x", w->id);
} }
ps->pending_updates = true; ps->pending_updates = true;

40
src/event.c
View File

@ -262,16 +262,31 @@ static inline void ev_configure_notify(session_t *ps, xcb_configure_notify_event
static inline void ev_destroy_notify(session_t *ps, xcb_destroy_notify_event_t *ev) { static inline void ev_destroy_notify(session_t *ps, xcb_destroy_notify_event_t *ev) {
auto w = find_win(ps, ev->window); auto w = find_win(ps, ev->window);
if (w) { if (w) {
if (w->managed) { auto _ attr_unused = destroy_win_start(ps, w);
auto _ attr_unused = unmap_win(ps, (struct managed_win *)w, true);
} else {
destroy_unmanaged_win(ps, w);
}
} }
} }
static inline void ev_map_notify(session_t *ps, xcb_map_notify_event_t *ev) { static inline void ev_map_notify(session_t *ps, xcb_map_notify_event_t *ev) {
map_win_by_id(ps, ev->window); // Unmap overlay window if it got mapped but we are currently not
// in redirected state.
if (ps->overlay && ev->window == ps->overlay && !ps->redirected) {
log_debug("Overlay is mapped while we are not redirected");
auto e = xcb_request_check(ps->c, xcb_unmap_window(ps->c, ps->overlay));
if (e) {
log_error("Failed to unmap the overlay window");
free(e);
}
// We don't track the overlay window, so we can return
return;
}
auto w = find_managed_win(ps, ev->window);
if (!w) {
return;
}
win_queue_update(w, WIN_UPDATE_MAP);
// FocusIn/Out may be ignored when the window is unmapped, so we must // FocusIn/Out may be ignored when the window is unmapped, so we must
// recheck focus here // recheck focus here
ps->pending_updates = true; // to update focus ps->pending_updates = true; // to update focus
@ -280,7 +295,7 @@ static inline void ev_map_notify(session_t *ps, xcb_map_notify_event_t *ev) {
static inline void ev_unmap_notify(session_t *ps, xcb_unmap_notify_event_t *ev) { static inline void ev_unmap_notify(session_t *ps, xcb_unmap_notify_event_t *ev) {
auto w = find_managed_win(ps, ev->window); auto w = find_managed_win(ps, ev->window);
if (w) { if (w) {
auto _ attr_unused = unmap_win(ps, w, false); unmap_win_start(ps, w);
} }
} }
@ -303,13 +318,10 @@ static inline void ev_reparent_notify(session_t *ps, xcb_reparent_notify_event_t
} }
} else { } else {
// otherwise, find and destroy the window first // otherwise, find and destroy the window first
{
auto w = find_win(ps, ev->window); auto w = find_win(ps, ev->window);
if (w) { if (w) {
if (w->managed) { auto _ attr_unused = destroy_win_start(ps, w);
auto _ attr_unused =
unmap_win(ps, (struct managed_win *)w, true);
} else {
destroy_unmanaged_win(ps, w);
} }
} }
@ -534,8 +546,8 @@ static inline void ev_property_notify(session_t *ps, xcb_property_notify_event_t
} }
static inline void repair_win(session_t *ps, struct managed_win *w) { static inline void repair_win(session_t *ps, struct managed_win *w) {
if (w->a.map_state != XCB_MAP_STATE_VIEWABLE) // Only mapped window can receive damages
return; assert(win_is_mapped_in_x(w));
region_t parts; region_t parts;
pixman_region32_init(&parts); pixman_region32_init(&parts);

422
src/win.c
View File

@ -43,6 +43,14 @@
#include "win.h" #include "win.h"
// TODO Make more window states internal
struct managed_win_internal {
struct managed_win base;
/// A bit mask of unhandled window updates
uint_fast32_t pending_updates;
};
#define OPAQUE (0xffffffff) #define OPAQUE (0xffffffff)
static const int WIN_GET_LEADER_MAX_RECURSION = 20; static const int WIN_GET_LEADER_MAX_RECURSION = 20;
static const int ROUNDED_PIXELS = 1; static const int ROUNDED_PIXELS = 1;
@ -241,64 +249,120 @@ void add_damage_from_win(session_t *ps, const struct managed_win *w) {
} }
/// Release the images attached to this window /// Release the images attached to this window
void win_release_image(backend_t *base, struct managed_win *w) { static inline void win_release_pixmap(backend_t *base, struct managed_win *w) {
log_debug("Releasing image of window %#010x (%s)", w->base.id, w->name); log_debug("Releasing pixmap of window %#010x (%s)", w->base.id, w->name);
assert(w->win_image || (w->flags & WIN_FLAGS_IMAGE_ERROR)); assert(w->win_image);
if (w->win_image) { if (w->win_image) {
base->ops->release_image(base, w->win_image); base->ops->release_image(base, w->win_image);
w->win_image = NULL; w->win_image = NULL;
w->flags |= WIN_FLAGS_PIXMAP_NONE;
} }
if (w->shadow) { }
assert(w->shadow_image || (w->flags & WIN_FLAGS_IMAGE_ERROR)); static inline void win_release_shadow(backend_t *base, struct managed_win *w) {
log_debug("Releasing shadow of window %#010x (%s)", w->base.id, w->name);
assert(w->shadow_image);
if (w->shadow_image) { if (w->shadow_image) {
base->ops->release_image(base, w->shadow_image); base->ops->release_image(base, w->shadow_image);
w->shadow_image = NULL; w->shadow_image = NULL;
} w->flags |= WIN_FLAGS_SHADOW_NONE;
} }
} }
static inline bool static inline bool win_bind_pixmap(struct backend_base *b, struct managed_win *w) {
_win_bind_image(session_t *ps, struct managed_win *w, void **win_image, void **shadow_image) { assert(!w->win_image);
auto pixmap = x_new_id(ps->c); auto pixmap = x_new_id(b->c);
auto e = xcb_request_check( auto e = xcb_request_check(
ps->c, xcb_composite_name_window_pixmap_checked(ps->c, w->base.id, pixmap)); b->c, xcb_composite_name_window_pixmap_checked(b->c, w->base.id, pixmap));
if (e) { if (e) {
log_error("Failed to get named pixmap for window %#010x(%s)", w->base.id, log_error("Failed to get named pixmap for window %#010x(%s)", w->base.id,
w->name); w->name);
free(e); free(e);
return false; return false;
} }
log_trace("New named pixmap for %#010x (%s) : %#010x", w->base.id, w->name, pixmap); log_debug("New named pixmap for %#010x (%s) : %#010x", w->base.id, w->name, pixmap);
*win_image = ps->backend_data->ops->bind_pixmap( w->win_image =
ps->backend_data, pixmap, x_get_visual_info(ps->c, w->a.visual), true); b->ops->bind_pixmap(b, pixmap, x_get_visual_info(b->c, w->a.visual), true);
if (!*win_image) { if (!w->win_image) {
log_error("Failed to bind pixmap");
w->flags |= WIN_FLAGS_IMAGE_ERROR;
return false; return false;
} }
if (w->shadow) {
*shadow_image = ps->backend_data->ops->render_shadow( w->flags &= ~WIN_FLAGS_PIXMAP_NONE;
ps->backend_data, w->widthb, w->heightb, ps->gaussian_map, ps->o.shadow_red,
ps->o.shadow_green, ps->o.shadow_blue, ps->o.shadow_opacity);
if (!*shadow_image) {
log_error("Failed to bind shadow image");
ps->backend_data->ops->release_image(ps->backend_data, *win_image);
*win_image = NULL;
return false;
}
}
return true; return true;
} }
bool win_bind_image(session_t *ps, struct managed_win *w) { static inline bool win_bind_shadow(struct backend_base *b, struct managed_win *w,
assert(!w->win_image && !w->shadow_image); struct color c, struct conv *kernel) {
return _win_bind_image(ps, w, &w->win_image, &w->shadow_image); assert(!w->shadow_image);
assert(w->shadow);
w->shadow_image = b->ops->render_shadow(b, w->widthb, w->heightb, kernel, c.red,
c.green, c.blue, c.alpha);
if (!w->shadow_image) {
log_error("Failed to bind shadow image");
w->flags |= WIN_FLAGS_IMAGE_ERROR;
return false;
} }
bool win_try_rebind_image(session_t *ps, struct managed_win *w) { log_debug("New shadow for %#010x (%s)", w->base.id, w->name);
log_trace("Freeing old window image"); w->flags &= ~WIN_FLAGS_SHADOW_NONE;
// Must release first, otherwise breaks NVIDIA driver return true;
win_release_image(ps->backend_data, w); }
return win_bind_image(ps, w); void win_release_images(struct backend_base *backend, struct managed_win *w) {
// we don't want to consider what we should do if the image we want to release is
// stale (do we clear the stale flags or not?)
assert((w->flags & WIN_FLAGS_IMAGES_STALE) == 0);
if ((w->flags & WIN_FLAGS_PIXMAP_NONE) == 0) {
win_release_pixmap(backend, w);
}
if ((w->flags & WIN_FLAGS_SHADOW_NONE) == 0) {
win_release_shadow(backend, w);
}
}
void win_process_flags(session_t *ps, struct managed_win *w) {
if (!w->flags || (w->flags & WIN_FLAGS_IMAGE_ERROR) != 0) {
return;
}
// Not a loop
while ((w->flags & WIN_FLAGS_IMAGES_STALE) != 0) {
// Image needs to be updated, update it.
if (w->state == WSTATE_UNMAPPING || w->state == WSTATE_DESTROYING ||
!ps->backend_data) {
// Window is already gone, or we are using the legacy backend
// we cannot rebind image
break;
}
// Must release images first, otherwise breaks NVIDIA driver
if ((w->flags & WIN_FLAGS_PIXMAP_STALE) != 0) {
if ((w->flags & WIN_FLAGS_PIXMAP_NONE) == 0) {
win_release_pixmap(ps->backend_data, w);
}
win_bind_pixmap(ps->backend_data, w);
}
if ((w->flags & WIN_FLAGS_SHADOW_STALE) != 0) {
if ((w->flags & WIN_FLAGS_SHADOW_NONE) == 0) {
win_release_shadow(ps->backend_data, w);
}
if (w->shadow) {
win_bind_shadow(ps->backend_data, w,
(struct color){.red = ps->o.shadow_red,
.green = ps->o.shadow_green,
.blue = ps->o.shadow_blue,
.alpha = ps->o.shadow_opacity},
ps->gaussian_map);
}
}
// Flags are cleared here, loop always run only once
w->flags &= ~WIN_FLAGS_IMAGES_STALE;
}
} }
/** /**
@ -629,18 +693,10 @@ static void win_set_shadow(session_t *ps, struct managed_win *w, bool shadow_new
if (w->shadow) { if (w->shadow) {
win_extents(w, &extents); win_extents(w, &extents);
add_damage_from_win(ps, w); add_damage_from_win(ps, w);
if (ps->backend_data && w->state != WSTATE_UNMAPPED && if (w->state != WSTATE_UNMAPPED) {
!(w->flags & WIN_FLAGS_IMAGE_ERROR)) {
assert(!w->shadow_image); assert(!w->shadow_image);
// Create shadow image // Delayed creation of shadow image
w->shadow_image = ps->backend_data->ops->render_shadow( w->flags |= WIN_FLAGS_SHADOW_STALE;
ps->backend_data, w->widthb, w->heightb, ps->gaussian_map,
ps->o.shadow_red, ps->o.shadow_green, ps->o.shadow_blue,
ps->o.shadow_opacity);
if (!w->shadow_image) {
log_error("Failed to bind shadow image");
w->shadow_force = OFF;
}
} }
} }
pixman_region32_fini(&extents); pixman_region32_fini(&extents);
@ -850,7 +906,7 @@ void win_on_win_size_change(session_t *ps, struct managed_win *w) {
// Invalidate the shadow we built // Invalidate the shadow we built
if (w->state == WSTATE_MAPPED || w->state == WSTATE_MAPPING || if (w->state == WSTATE_MAPPED || w->state == WSTATE_MAPPING ||
w->state == WSTATE_FADING) { w->state == WSTATE_FADING) {
w->flags |= WIN_FLAGS_IMAGE_STALE; w->flags |= WIN_FLAGS_IMAGES_STALE;
ps->pending_updates = true; ps->pending_updates = true;
} else { } else {
assert(w->state == WSTATE_UNMAPPED); assert(w->state == WSTATE_UNMAPPED);
@ -1082,7 +1138,7 @@ struct win *fill_win(session_t *ps, struct win *w) {
.in_openclose = true, // set to false after first map is done, .in_openclose = true, // set to false after first map is done,
// true here because window is just created // true here because window is just created
.reg_ignore_valid = false, // set to true when damaged .reg_ignore_valid = false, // set to true when damaged
.flags = 0, // updated by property/attributes/etc change .flags = WIN_FLAGS_IMAGES_NONE, // updated by property/attributes/etc change
// Runtime variables, updated by dbus // Runtime variables, updated by dbus
.fade_force = UNSET, .fade_force = UNSET,
@ -1180,7 +1236,9 @@ struct win *fill_win(session_t *ps, struct win *w) {
} }
// Allocate and initialize the new win structure // Allocate and initialize the new win structure
auto new = cmalloc(struct managed_win); auto new_internal = cmalloc(struct managed_win_internal);
auto new = (struct managed_win *)new_internal;
new_internal->pending_updates = 0;
// Fill structure // Fill structure
// We only need to initialize the part that are not initialized // We only need to initialize the part that are not initialized
@ -1489,7 +1547,7 @@ void win_update_bounding_shape(session_t *ps, struct managed_win *w) {
// Note we only do this when screen is redirected, because // Note we only do this when screen is redirected, because
// otherwise win_data is not valid // otherwise win_data is not valid
assert(w->state != WSTATE_UNMAPPING && w->state != WSTATE_DESTROYING); assert(w->state != WSTATE_UNMAPPING && w->state != WSTATE_DESTROYING);
w->flags |= WIN_FLAGS_IMAGE_STALE; w->flags |= WIN_FLAGS_IMAGES_STALE;
ps->pending_updates = true; ps->pending_updates = true;
} }
free_paint(ps, &w->paint); free_paint(ps, &w->paint);
@ -1586,84 +1644,88 @@ void win_ev_stop(session_t *ps, const struct win *w) {
/// Finish the unmapping of a window (e.g. after fading has finished). /// Finish the unmapping of a window (e.g. after fading has finished).
/// Doesn't free `w` /// Doesn't free `w`
static void finish_unmap_win(session_t *ps, struct managed_win *w) { static void unmap_win_finish(session_t *ps, struct managed_win *w) {
w->ever_damaged = false; w->ever_damaged = false;
w->reg_ignore_valid = false; w->reg_ignore_valid = false;
w->state = WSTATE_UNMAPPED; w->state = WSTATE_UNMAPPED;
// We are in unmap_win, this window definitely was viewable // We are in unmap_win, this window definitely was viewable
if (ps->backend_data) { if (ps->backend_data) {
win_release_image(ps->backend_data, w); win_release_images(ps->backend_data, w);
} else {
assert(!w->win_image);
assert(!w->shadow_image);
} }
free_paint(ps, &w->paint); free_paint(ps, &w->paint);
free_paint(ps, &w->shadow_paint); free_paint(ps, &w->shadow_paint);
w->flags = 0; // Try again at binding images when the window is mapped next time
w->flags &= ~WIN_FLAGS_IMAGE_ERROR;
} }
/// Finish the destruction of a window (e.g. after fading has finished). /// Finish the destruction of a window (e.g. after fading has finished).
/// Frees `w` /// Frees `w`
static void finish_destroy_win(session_t *ps, struct managed_win *w) { static void destroy_win_finish(session_t *ps, struct win *w) {
log_trace("Trying to finish destroying (%#010x)", w->base.id); log_trace("Trying to finish destroying (%#010x)", w->id);
if (w->state != WSTATE_UNMAPPED) { auto next_w = win_stack_find_next_managed(ps, &w->stack_neighbour);
list_remove(&w->stack_neighbour);
if (w->managed) {
auto mw = (struct managed_win *)w;
if (mw->state != WSTATE_UNMAPPED) {
// Only UNMAPPED state has window resources freed, otherwise // Only UNMAPPED state has window resources freed, otherwise
// we need to call finish_unmap_win to free them. // we need to call unmap_win_finish to free them.
finish_unmap_win(ps, w); // XXX actually we unmap_win_finish only frees the rendering
// resources, we still need to call free_win_res. will fix
// later.
unmap_win_finish(ps, mw);
} }
// Invalidate reg_ignore of windows below this one // Invalidate reg_ignore of windows below this one
// TODO what if w->next is not mapped?? // TODO what if next_w is not mapped??
// TODO seriously figure out how reg_ignore behaves. // TODO seriously figure out how reg_ignore behaves.
// I think if `w` is unmapped, and destroyed after // I think if `w` is unmapped, and destroyed after
// paint happened at least once, w->reg_ignore_valid would // paint happened at least once, w->reg_ignore_valid would
// be true, and there is no need to invalid w->next->reg_ignore // be true, and there is no need to invalid w->next->reg_ignore
// when w is destroyed. // when w is destroyed.
auto next_w = win_stack_find_next_managed(ps, &w->base.stack_neighbour);
if (next_w) { if (next_w) {
rc_region_unref(&next_w->reg_ignore); rc_region_unref(&next_w->reg_ignore);
next_w->reg_ignore_valid = false; next_w->reg_ignore_valid = false;
} }
log_trace("Trying to destroy (%#010x)", w->base.id); if (mw == ps->active_win) {
list_remove(&w->base.stack_neighbour); // Usually, the window cannot be the focused at destruction.
// FocusOut should be generated before the window is destroyed. We
if (w == ps->active_win) { // do this check just to be completely sure we don't have dangling
// Usually, the window cannot be the focused at destruction. FocusOut
// should be generated before the window is destroyed.
// We do this check just to be completely sure we don't have dangling
// references. // references.
log_debug("window %#010x (%s) is destroyed while being focused", log_debug("window %#010x (%s) is destroyed while being focused",
w->base.id, w->name); w->id, mw->name);
ps->active_win = NULL; ps->active_win = NULL;
} }
free_win_res(ps, w); free_win_res(ps, mw);
// Drop w from all prev_trans to avoid accessing freed memory in // Drop w from all prev_trans to avoid accessing freed memory in
// repair_win() // repair_win()
// TODO there can only be one prev_trans pointing to w // TODO there can only be one prev_trans pointing to w
win_stack_foreach_managed(w2, &ps->window_stack) { win_stack_foreach_managed(w2, &ps->window_stack) {
if (w == w2->prev_trans) { if (mw == w2->prev_trans) {
w2->prev_trans = NULL; w2->prev_trans = NULL;
} }
} }
}
free(w); free(w);
} }
static void finish_map_win(struct managed_win *w) { static void map_win_finish(struct managed_win *w) {
w->in_openclose = false; w->in_openclose = false;
w->state = WSTATE_MAPPED; w->state = WSTATE_MAPPED;
} }
void destroy_unmanaged_win(session_t *ps, struct win *w) {
assert(!w->managed);
assert(!w->destroyed);
list_remove(&w->stack_neighbour);
HASH_DEL(ps->windows, w);
free(w);
}
/// Move window `w` so it's before `next` in the list /// Move window `w` so it's before `next` in the list
static inline void restack_win(session_t *ps, struct win *w, struct list_node *next) { static inline void restack_win(session_t *ps, struct win *w, struct list_node *next) {
struct managed_win *mw = NULL; struct managed_win *mw = NULL;
@ -1747,86 +1809,98 @@ void restack_top(session_t *ps, struct win *w) {
restack_win(ps, w, ps->window_stack.next); restack_win(ps, w, ps->window_stack.next);
} }
/// Unmap or destroy a window /// Start destroying a window. Windows cannot always be destroyed immediately
/// @return whether the window is destroyed and freed /// because of fading and such.
bool unmap_win(session_t *ps, struct managed_win *w, bool destroy) { ///
winstate_t target_state = destroy ? WSTATE_DESTROYING : WSTATE_UNMAPPING; /// @return whether the window has finished destroying and is freed
bool destroy_win_start(session_t *ps, struct win *w) {
auto mw = (struct managed_win *)w;
assert(w);
log_debug("Destroying %#010x \"%s\", managed = %d", w->id,
(w->managed ? mw->name : NULL), w->managed);
// Delete destroyed window from the hash table, even though the window might still
// be rendered for a while. We need to make sure future window with the same
// window id won't confuse us. Keep the window in the window stack if it's managed
// and mapped, since we might still need to render it (e.g. fading out). Window
// will be removed from the stack when it finishes destroying.
HASH_DEL(ps->windows, w);
if (!w->managed || mw->state == WSTATE_UNMAPPED) {
// Window is already unmapped, or is an unmanged window, just destroy it
destroy_win_finish(ps, w);
return true;
}
if (w->managed) {
// Update state flags of a managed window
mw->state = WSTATE_DESTROYING;
mw->a.map_state = XCB_MAP_STATE_UNMAPPED;
mw->in_openclose = true;
}
// don't need win_ev_stop because the window is gone anyway
#ifdef CONFIG_DBUS
// Send D-Bus signal
if (ps->o.dbus) {
cdbus_ev_win_destroyed(ps, w);
}
#endif
if (!ps->redirected) {
// Skip transition if we are not rendering
return win_skip_fading(ps, mw);
}
if (unlikely(!w)) {
return false; return false;
} }
if (!destroy && w->a._class == XCB_WINDOW_CLASS_INPUT_ONLY) { void unmap_win_start(session_t *ps, struct managed_win *w) {
// We don't care about mapping / unmapping of Input Only windows. auto internal_w = (struct managed_win_internal *)w;
// But we need to remember to destroy them, so future window with assert(w);
// the same id won't be handled incorrectly. assert(w->base.managed);
// Issue #119 was caused by this. assert(w->a._class != XCB_WINDOW_CLASS_INPUT_ONLY);
return false;
}
log_trace("Unmapping %#010x \"%s\", destroy = %d", w->base.id, log_debug("Unmapping %#010x \"%s\"", w->base.id, w->name);
(w ? w->name : NULL), destroy);
if (unlikely(w->state == WSTATE_DESTROYING && !destroy)) { if (unlikely(w->state == WSTATE_DESTROYING)) {
log_warn("Trying to undestroy a window?"); log_warn("Trying to undestroy a window?");
assert(false); assert(false);
} }
// If the window is already in the state we want if (unlikely(w->state == WSTATE_UNMAPPING || w->state == WSTATE_UNMAPPED)) {
if (unlikely(w->state == target_state)) { if (internal_w->pending_updates & WIN_UPDATE_MAP) {
log_warn("%s a window twice", destroy ? "Destroying" : "Unmapping"); internal_w->pending_updates &= ~(unsigned long)WIN_UPDATE_MAP;
return false; } else {
} log_warn("Trying to unmapping an already unmapped window %#010x "
"\"%s\"",
if (destroy) {
// Delete destroyed window from the hash table, so future window with the
// same window id won't confuse us.
// Keep the window in the window stack, since we might still need to
// render it (fading out). Window will be removed from the stack when
// fading finishes.
HASH_DEL(ps->windows, &w->base);
}
if (unlikely(w->state == WSTATE_UNMAPPED) || w->a._class == XCB_WINDOW_CLASS_INPUT_ONLY) {
if (unlikely(!destroy)) {
log_warn("Unmapping an already unmapped window %#010x %s twice",
w->base.id, w->name); w->base.id, w->name);
return false; assert(false);
} }
// Window is already unmapped, or is an Input Only window, just destroy it return;
finish_destroy_win(ps, w);
return true;
} }
// Note we don't update focused window here. This will either be // Note we don't update focused window here. This will either be
// triggered by subsequence Focus{In, Out} event, or by recheck_focus // triggered by subsequence Focus{In, Out} event, or by recheck_focus
w->a.map_state = XCB_MAP_STATE_UNMAPPED; w->a.map_state = XCB_MAP_STATE_UNMAPPED;
w->state = target_state; w->state = WSTATE_UNMAPPING;
w->opacity_target = win_calc_opacity_target(ps, w, false); w->opacity_target = win_calc_opacity_target(ps, w, false);
w->in_openclose = destroy;
// don't care about properties anymore // don't care about properties anymore
if (!destroy) {
win_ev_stop(ps, &w->base); win_ev_stop(ps, &w->base);
}
#ifdef CONFIG_DBUS #ifdef CONFIG_DBUS
// Send D-Bus signal // Send D-Bus signal
if (ps->o.dbus) { if (ps->o.dbus) {
if (destroy) {
cdbus_ev_win_destroyed(ps, &w->base);
} else {
cdbus_ev_win_unmapped(ps, &w->base); cdbus_ev_win_unmapped(ps, &w->base);
} }
}
#endif #endif
if (!ps->redirected) { if (!ps->redirected) {
return win_skip_fading(ps, w); CHECK(!win_skip_fading(ps, w));
} }
return false;
} }
/** /**
@ -1842,9 +1916,9 @@ bool win_check_fade_finished(session_t *ps, struct managed_win *w) {
} }
if (w->opacity == w->opacity_target) { if (w->opacity == w->opacity_target) {
switch (w->state) { switch (w->state) {
case WSTATE_UNMAPPING: finish_unmap_win(ps, w); return false; case WSTATE_UNMAPPING: unmap_win_finish(ps, w); return false;
case WSTATE_DESTROYING: finish_destroy_win(ps, w); return true; case WSTATE_DESTROYING: destroy_win_finish(ps, &w->base); return true;
case WSTATE_MAPPING: finish_map_win(w); return false; case WSTATE_MAPPING: map_win_finish(w); return false;
case WSTATE_FADING: w->state = WSTATE_MAPPED; break; case WSTATE_FADING: w->state = WSTATE_MAPPED; break;
default: unreachable; default: unreachable;
} }
@ -1862,7 +1936,7 @@ bool win_skip_fading(session_t *ps, struct managed_win *w) {
assert(w->opacity_target == w->opacity); assert(w->opacity_target == w->opacity);
return false; return false;
} }
log_trace("Skipping fading process of window %#010x (%s)", w->base.id, w->name); log_debug("Skipping fading process of window %#010x (%s)", w->base.id, w->name);
w->opacity = w->opacity_target; w->opacity = w->opacity_target;
return win_check_fade_finished(ps, w); return win_check_fade_finished(ps, w);
} }
@ -1889,7 +1963,8 @@ void win_update_screen(session_t *ps, struct managed_win *w) {
} }
/// Map an already registered window /// Map an already registered window
void map_win(session_t *ps, struct managed_win *w) { void map_win_start(session_t *ps, struct managed_win *w) {
assert(ps->server_grabbed);
assert(w); assert(w);
// Don't care about window mapping if it's an InputOnly window // Don't care about window mapping if it's an InputOnly window
@ -1909,11 +1984,18 @@ void map_win(session_t *ps, struct managed_win *w) {
if (w->state == WSTATE_UNMAPPING) { if (w->state == WSTATE_UNMAPPING) {
CHECK(!win_skip_fading(ps, w)); CHECK(!win_skip_fading(ps, w));
// We skipped the unmapping process, the window was rendered, now it is // We skipped the unmapping process, the window was rendered, now it is
// not anymore. So we need to mark then unmapping window as damaged. // not anymore. So we need to mark the then unmapping window as damaged.
//
// Solves problem when, for example, a window is unmapped then mapped in a
// different location
add_damage_from_win(ps, w); add_damage_from_win(ps, w);
assert(w); assert(w);
} }
assert(w->state == WSTATE_UNMAPPED);
assert((w->flags & WIN_FLAGS_IMAGES_NONE) == WIN_FLAGS_IMAGES_NONE ||
!ps->o.experimental_backends);
// We stopped processing window size change when we were unmapped, refresh the // We stopped processing window size change when we were unmapped, refresh the
// size of the window // size of the window
xcb_get_geometry_cookie_t gcookie = xcb_get_geometry(ps->c, w->base.id); xcb_get_geometry_cookie_t gcookie = xcb_get_geometry(ps->c, w->base.id);
@ -1992,27 +2074,21 @@ void map_win(session_t *ps, struct managed_win *w) {
win_determine_blur_background(ps, w); win_determine_blur_background(ps, w);
w->ever_damaged = false; // Cannot set w->ever_damaged = false here, since window mapping could be
// delayed, so a damage event might have already arrived before this function
// is called. But this should be unnecessary in the first place, since
// ever_damaged is set to false in unmap_win_finish anyway.
// We stopped listening on ShapeNotify events // We stopped listening on ShapeNotify events
// when the window is unmapped (XXX we shouldn't), // when the window is unmapped (XXX we shouldn't),
// so the shape of the window might have changed, // so the shape of the window might have changed,
// update. (Issue #35) // update. (Issue #35)
//
// Also this sets the WIN_FLAGS_IMAGES_STALE flag so later in the critical section
// the window's image will be bound
win_update_bounding_shape(ps, w); win_update_bounding_shape(ps, w);
// Reset the STALE_IMAGE flag set by win_update_bounding_shape. Because we are assert((w->flags & WIN_FLAGS_IMAGES_STALE) == WIN_FLAGS_IMAGES_STALE);
// just about to bind the image, no way that's stale.
//
// Also because NVIDIA driver doesn't like seeing the same pixmap under different
// ids, so avoid naming the pixmap again when it didn't actually change.
w->flags &= ~WIN_FLAGS_IMAGE_STALE;
// Bind image after update_bounding_shape, so the shadow has the correct size.
if (ps->backend_data) {
if (!win_bind_image(ps, w)) {
w->flags |= WIN_FLAGS_IMAGE_ERROR;
}
}
#ifdef CONFIG_DBUS #ifdef CONFIG_DBUS
// Send D-Bus signal // Send D-Bus signal
@ -2023,32 +2099,9 @@ void map_win(session_t *ps, struct managed_win *w) {
if (!ps->redirected) { if (!ps->redirected) {
CHECK(!win_skip_fading(ps, w)); CHECK(!win_skip_fading(ps, w));
assert(w);
} }
} }
void map_win_by_id(session_t *ps, xcb_window_t id) {
// Unmap overlay window if it got mapped but we are currently not
// in redirected state.
if (ps->overlay && id == ps->overlay && !ps->redirected) {
log_debug("Overlay is mapped while we are not redirected");
auto e = xcb_request_check(ps->c, xcb_unmap_window(ps->c, ps->overlay));
if (e) {
log_error("Failed to unmap the overlay window");
free(e);
}
// We don't track the overlay window, so we can return
return;
}
auto w = find_managed_win(ps, id);
if (!w) {
return;
}
map_win(ps, w);
}
/** /**
* Find a managed window from window id in window linked list of the session. * Find a managed window from window id in window linked list of the session.
*/ */
@ -2169,6 +2222,32 @@ win_is_fullscreen_xcb(xcb_connection_t *c, const struct atom *a, const xcb_windo
return false; return false;
} }
/// Queue an update on a window. A series of sanity checks are performed
void win_queue_update(struct managed_win *_w, enum win_update update) {
auto w = (struct managed_win_internal *)_w;
assert(popcount(update) == 1);
if (unlikely(_w->state == WSTATE_DESTROYING)) {
log_error("Updates queued on a destroyed window %#010x (%s)", _w->base.id,
_w->name);
return;
}
w->pending_updates |= WIN_UPDATE_MAP;
}
/// Process pending updates on a window. Has to be called in X critical section
void win_process_updates(struct session *ps, struct managed_win *_w) {
assert(ps->server_grabbed);
auto w = (struct managed_win_internal *)_w;
if (w->pending_updates & WIN_UPDATE_MAP) {
map_win_start(ps, _w);
}
w->pending_updates = 0;
}
/** /**
* Check if a window is a fullscreen window. * Check if a window is a fullscreen window.
* *
@ -2200,3 +2279,10 @@ win_stack_find_next_managed(const session_t *ps, const struct list_node *i) {
} }
return NULL; return NULL;
} }
/// Return whether this window is mapped on the X server side
bool win_is_mapped_in_x(const struct managed_win *w) {
auto iw = (const struct managed_win_internal *)w;
return w->state == WSTATE_MAPPING || w->state == WSTATE_FADING ||
w->state == WSTATE_MAPPED || (iw->pending_updates & WIN_UPDATE_MAP);
}

36
src/win.h
View File

@ -250,11 +250,28 @@ struct managed_win {
#endif #endif
}; };
void win_release_image(struct backend_base *base, struct managed_win *w); /// Process pending updates on a window. Has to be called in X critical section
bool must_use win_bind_image(session_t *ps, struct managed_win *w); void win_process_updates(struct session *ps, struct managed_win *_w);
/// Process pending images flags on a window. Has to be called in X critical section
void win_process_flags(session_t *ps, struct managed_win *w);
/// Queue an update on a window. A series of sanity checks are performed
void win_queue_update(struct managed_win *_w, enum win_update update);
/// Attempt a rebind of window's images. If that failed, the original images are kept. /// Start the unmap of a window. We cannot unmap immediately since we might need to fade
bool must_use win_try_rebind_image(session_t *ps, struct managed_win *w); /// the window out.
void unmap_win_start(struct session *, struct managed_win *);
/// Start the mapping of a window. We cannot map immediately since we might need to fade
/// the window in.
void map_win_start(struct session *, struct managed_win *);
/// Start the destroying of a window. Windows cannot always be destroyed immediately
/// because of fading and such.
bool must_use destroy_win_start(session_t *ps, struct win *w);
/// Release images bound with a window, set the *_NONE flags on the window. Only to be
/// used when de-initializing the backend outside of win.c
void win_release_images(struct backend_base *base, struct managed_win *w);
int win_get_name(session_t *ps, struct managed_win *w); int win_get_name(session_t *ps, struct managed_win *w);
int win_get_role(session_t *ps, struct managed_win *w); int win_get_role(session_t *ps, struct managed_win *w);
winmode_t attr_pure win_calc_mode(const struct managed_win *w); winmode_t attr_pure win_calc_mode(const struct managed_win *w);
@ -355,14 +372,6 @@ void restack_above(session_t *ps, struct win *w, xcb_window_t below);
void restack_bottom(session_t *ps, struct win *w); void restack_bottom(session_t *ps, struct win *w);
/// Move window `w` to the top of the stack /// Move window `w` to the top of the stack
void restack_top(session_t *ps, struct win *w); void restack_top(session_t *ps, struct win *w);
/// Unmap or destroy a window
/// @return whether the window is destroyed and freed
bool must_use unmap_win(session_t *ps, struct managed_win *, bool destroy);
/// Destroy and free an unmanaged window
void destroy_unmanaged_win(session_t *ps, struct win *w);
void map_win(session_t *ps, struct managed_win *w);
void map_win_by_id(session_t *ps, xcb_window_t id);
/** /**
* Execute fade callback of a window if fading finished. * Execute fade callback of a window if fading finished.
@ -410,6 +419,9 @@ bool attr_pure win_has_alpha(const struct managed_win *w);
/// check if reg_ignore_valid is true for all windows above us /// check if reg_ignore_valid is true for all windows above us
bool attr_pure win_is_region_ignore_valid(session_t *ps, const struct managed_win *w); bool attr_pure win_is_region_ignore_valid(session_t *ps, const struct managed_win *w);
/// Whether a given window is mapped on the X server side
bool win_is_mapped_in_x(const struct managed_win *w);
// Find the managed window immediately below `w` in the window stack // Find the managed window immediately below `w` in the window stack
struct managed_win *attr_pure win_stack_find_next_managed(const session_t *ps, struct managed_win *attr_pure win_stack_find_next_managed(const session_t *ps,
const struct list_node *w); const struct list_node *w);

26
src/win_defs.h
View File

@ -1,4 +1,5 @@
#pragma once #pragma once
#include <stdint.h>
typedef enum { typedef enum {
WINTYPE_UNKNOWN, WINTYPE_UNKNOWN,
@ -26,6 +27,11 @@ typedef enum {
WMODE_SOLID, // The window is opaque including the frame WMODE_SOLID, // The window is opaque including the frame
} winmode_t; } winmode_t;
/// Pending window updates
enum win_update {
WIN_UPDATE_MAP = 1,
};
/// Transition table: /// Transition table:
/// (DESTROYED is when the win struct is destroyed and freed) /// (DESTROYED is when the win struct is destroyed and freed)
/// ('o' means in all other cases) /// ('o' means in all other cases)
@ -67,8 +73,22 @@ typedef enum {
} winstate_t; } winstate_t;
enum win_flags { enum win_flags {
/// win_image/shadow_image is out of date // Note: *_NONE flags are mostly redudant and meant for detecting logical errors
WIN_FLAGS_IMAGE_STALE = 1, // in the code
/// pixmap is out of date, will be update in win_process_flags
WIN_FLAGS_PIXMAP_STALE = 1,
/// window does not have pixmap bound
WIN_FLAGS_PIXMAP_NONE = 2,
/// there was an error trying to bind the images /// there was an error trying to bind the images
WIN_FLAGS_IMAGE_ERROR = 2, WIN_FLAGS_IMAGE_ERROR = 4,
/// shadow is out of date, will be updated in win_process_flags
WIN_FLAGS_SHADOW_STALE = 8,
/// shadow has not been generated
WIN_FLAGS_SHADOW_NONE = 16,
}; };
static const int_fast16_t WIN_FLAGS_IMAGES_STALE =
WIN_FLAGS_PIXMAP_STALE | WIN_FLAGS_SHADOW_STALE;
static const int_fast16_t WIN_FLAGS_IMAGES_NONE = WIN_FLAGS_PIXMAP_NONE | WIN_FLAGS_SHADOW_NONE;