Verified Commit f2f9048e authored by Sebastian Krzyszkowiak's avatar Sebastian Krzyszkowiak
Browse files

Use wlr-foreign-toplevel-management instead of private protocol

Introduces PhoshToplevelManager and PhoshToplevel classes for
managing and representing toplevel surfaces.

Thanks to that:
 - it doesn't match the window to close via its title or app id,
   always trying to close the correct window instead
 - it removes the window from the overview only after it really got
   closed - which is especially noticable in case of windows that
   refuse to be closed
 - it updates the list automatically as the changes happen, without
   having to close and open the overview back again

Closes #37
parent 33e3e8f6
Pipeline #25066 passed with stages
in 6 minutes and 40 seconds
......@@ -15,6 +15,7 @@ wl_protos = [
'gamma-control.xml',
'idle.xml',
'phosh-private.xml',
'wlr-foreign-toplevel-management-unstable-v1.xml',
'wlr-input-inhibitor-unstable-v1.xml',
'wlr-layer-shell-unstable-v1.xml',
'wlr-output-management-unstable-v1.xml',
......
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="wlr_foreign_toplevel_management_unstable_v1">
<copyright>
Copyright © 2018 Ilia Bozhinov
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
the copyright holders not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. The copyright holders make no
representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied
warranty.
THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
</copyright>
<interface name="zwlr_foreign_toplevel_manager_v1" version="2">
<description summary="list and control opened apps">
The purpose of this protocol is to enable the creation of taskbars
and docks by providing them with a list of opened applications and
letting them request certain actions on them, like maximizing, etc.
After a client binds the zwlr_foreign_toplevel_manager_v1, each opened
toplevel window will be sent via the toplevel event
</description>
<event name="toplevel">
<description summary="a toplevel has been created">
This event is emitted whenever a new toplevel window is created. It
is emitted for all toplevels, regardless of the app that has created
them.
All initial details of the toplevel(title, app_id, states, etc.) will
be sent immediately after this event via the corresponding events in
zwlr_foreign_toplevel_handle_v1.
</description>
<arg name="toplevel" type="new_id" interface="zwlr_foreign_toplevel_handle_v1"/>
</event>
<request name="stop">
<description summary="stop sending events">
Indicates the client no longer wishes to receive events for new toplevels.
However the compositor may emit further toplevel_created events, until
the finished event is emitted.
The client must not send any more requests after this one.
</description>
</request>
<event name="finished">
<description summary="the compositor has finished with the toplevel manager">
This event indicates that the compositor is done sending events to the
zwlr_foreign_toplevel_manager_v1. The server will destroy the object
immediately after sending this request, so it will become invalid and
the client should free any resources associated with it.
</description>
</event>
</interface>
<interface name="zwlr_foreign_toplevel_handle_v1" version="2">
<description summary="an opened toplevel">
A zwlr_foreign_toplevel_handle_v1 object represents an opened toplevel
window. Each app may have multiple opened toplevels.
Each toplevel has a list of outputs it is visible on, conveyed to the
client with the output_enter and output_leave events.
</description>
<event name="title">
<description summary="title change">
This event is emitted whenever the title of the toplevel changes.
</description>
<arg name="title" type="string"/>
</event>
<event name="app_id">
<description summary="app-id change">
This event is emitted whenever the app-id of the toplevel changes.
</description>
<arg name="app_id" type="string"/>
</event>
<event name="output_enter">
<description summary="toplevel entered an output">
This event is emitted whenever the toplevel becomes visible on
the given output. A toplevel may be visible on multiple outputs.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<event name="output_leave">
<description summary="toplevel left an output">
This event is emitted whenever the toplevel stops being visible on
the given output. It is guaranteed that an entered-output event
with the same output has been emitted before this event.
</description>
<arg name="output" type="object" interface="wl_output"/>
</event>
<request name="set_maximized">
<description summary="requests that the toplevel be maximized">
Requests that the toplevel be maximized. If the maximized state actually
changes, this will be indicated by the state event.
</description>
</request>
<request name="unset_maximized">
<description summary="requests that the toplevel be unmaximized">
Requests that the toplevel be unmaximized. If the maximized state actually
changes, this will be indicated by the state event.
</description>
</request>
<request name="set_minimized">
<description summary="requests that the toplevel be minimized">
Requests that the toplevel be minimized. If the minimized state actually
changes, this will be indicated by the state event.
</description>
</request>
<request name="unset_minimized">
<description summary="requests that the toplevel be unminimized">
Requests that the toplevel be unminimized. If the minimized state actually
changes, this will be indicated by the state event.
</description>
</request>
<request name="activate">
<description summary="activate the toplevel">
Request that this toplevel be activated on the given seat.
There is no guarantee the toplevel will be actually activated.
</description>
<arg name="seat" type="object" interface="wl_seat"/>
</request>
<enum name="state">
<description summary="types of states on the toplevel">
The different states that a toplevel can have. These have the same meaning
as the states with the same names defined in xdg-toplevel
</description>
<entry name="maximized" value="0" summary="the toplevel is maximized"/>
<entry name="minimized" value="1" summary="the toplevel is minimized"/>
<entry name="activated" value="2" summary="the toplevel is active"/>
<entry name="fullscreen" value="3" summary="the toplevel is fullscreen" since="2"/>
</enum>
<event name="state">
<description summary="the toplevel state changed">
This event is emitted immediately after the zlw_foreign_toplevel_handle_v1
is created and each time the toplevel state changes, either because of a
compositor action or because of a request in this protocol.
</description>
<arg name="state" type="array"/>
</event>
<event name="done">
<description summary="all information about the toplevel has been sent">
This event is sent after all changes in the toplevel state have been
sent.
This allows changes to the zwlr_foreign_toplevel_handle_v1 properties
to be seen as atomic, even if they happen via multiple events.
</description>
</event>
<request name="close">
<description summary="request that the toplevel be closed">
Send a request to the toplevel to close itself. The compositor would
typically use a shell-specific method to carry out this request, for
example by sending the xdg_toplevel.close event. However, this gives
no guarantees the toplevel will actually be destroyed. If and when
this happens, the zwlr_foreign_toplevel_handle_v1.closed event will
be emitted.
</description>
</request>
<request name="set_rectangle">
<description summary="the rectangle which represents the toplevel">
The rectangle of the surface specified in this request corresponds to
the place where the app using this protocol represents the given toplevel.
It can be used by the compositor as a hint for some operations, e.g
minimizing. The client is however not required to set this, in which
case the compositor is free to decide some default value.
If the client specifies more than one rectangle, only the last one is
considered.
The dimensions are given in surface-local coordinates.
Setting width=height=0 removes the already-set rectangle.
</description>
<arg name="surface" type="object" interface="wl_surface"/>
<arg name="x" type="int"/>
<arg name="y" type="int"/>
<arg name="width" type="int"/>
<arg name="height" type="int"/>
</request>
<enum name="error">
<entry name="invalid_rectangle" value="0"
summary="the provided rectangle is invalid"/>
</enum>
<event name="closed">
<description summary="this toplevel has been destroyed">
This event means the toplevel has been destroyed. It is guaranteed there
won't be any more events for this zwlr_foreign_toplevel_handle_v1. The
toplevel itself becomes inert so any requests will be ignored except the
destroy request.
</description>
</event>
<request name="destroy" type="destructor">
<description summary="destroy the zwlr_foreign_toplevel_handle_v1 object">
Destroys the zwlr_foreign_toplevel_handle_v1 object.
This request should be called either when the client does not want to
use the toplevel anymore or after the closed event to finalize the
destruction of the object.
</description>
</request>
<!-- Version 2 additions -->
<request name="set_fullscreen" since="2">
<description summary="request that the toplevel be fullscreened">
Requests that the toplevel be fullscreened on the given output. If the
fullscreen state and/or the outputs the toplevel is visible on actually
change, this will be indicated by the state and output_enter/leave
events.
The output parameter is only a hint to the compositor. Also, if output
is NULL, the compositor should decide which output the toplevel will be
fullscreened on, if at all.
</description>
<arg name="output" type="object" interface="wl_output" allow-null="true"/>
</request>
<request name="unset_fullscreen" since="2">
<description summary="request that the toplevel be unfullscreened">
Requests that the toplevel be unfullscreened. If the fullscreen state
actually changes, this will be indicated by the state event.
</description>
</request>
</interface>
</protocol>
......@@ -16,6 +16,7 @@
#include "app.h"
#include "shell.h"
#include "util.h"
#include "toplevel-manager.h"
#include "phosh-private-client-protocol.h"
#include "phosh-wayland.h"
......@@ -57,71 +58,69 @@ G_DEFINE_TYPE_WITH_PRIVATE(PhoshFavorites, phosh_favorites, GTK_TYPE_BIN)
static void
app_clicked_cb (GtkButton *btn, gpointer user_data)
app_clicked_cb (PhoshFavorites *self, PhoshApp *app)
{
PhoshFavorites *self = PHOSH_FAVORITES (user_data);
PhoshFavoritesPrivate *priv;
PhoshApp *app = PHOSH_APP (btn);
PhoshToplevel *toplevel;
g_return_if_fail (PHOSH_IS_FAVORITES (self));
priv = phosh_favorites_get_instance_private (self);
g_return_if_fail (priv->xdg_switcher);
g_return_if_fail (PHOSH_IS_APP (app));
toplevel = g_object_get_data(G_OBJECT(app), "toplevel");
g_return_if_fail (PHOSH_IS_TOPLEVEL (toplevel));
g_debug("Will raise %s (%s)",
phosh_app_get_app_id (app),
phosh_app_get_title (app));
phosh_private_xdg_switcher_raise_xdg_surface (priv->xdg_switcher,
phosh_app_get_app_id (app),
phosh_app_get_title (app));
phosh_toplevel_raise (toplevel, phosh_wayland_get_wl_seat (phosh_wayland_get_default()));
g_signal_emit(self, signals[APP_RAISED], 0);
}
static void
on_app_closed (PhoshFavorites *self, PhoshApp *app)
app_closed_cb (PhoshFavorites *self, PhoshApp *app)
{
PhoshFavoritesPrivate *priv;
PhoshToplevel *toplevel;
g_return_if_fail (PHOSH_IS_FAVORITES (self));
g_return_if_fail (PHOSH_IS_APP (app));
priv = phosh_favorites_get_instance_private (self);
g_return_if_fail (priv->xdg_switcher);
toplevel = g_object_get_data(G_OBJECT(app), "toplevel");
g_return_if_fail (PHOSH_IS_TOPLEVEL (toplevel));
g_debug("Will close %s (%s)",
phosh_app_get_app_id (app),
phosh_app_get_title (app));
phosh_private_xdg_switcher_close_xdg_surface (priv->xdg_switcher,
phosh_app_get_app_id (app),
phosh_app_get_title (app));
gtk_widget_destroy (GTK_WIDGET (app));
phosh_toplevel_close (toplevel);
g_signal_emit(self, signals[APP_CLOSED], 0);
}
static void
handle_xdg_switcher_xdg_surface (
void *data,
struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
const char *app_id,
const char *title)
toplevel_closed_cb (PhoshToplevel *toplevel, PhoshApp *app)
{
g_return_if_fail (PHOSH_IS_TOPLEVEL (toplevel));
g_return_if_fail (PHOSH_IS_APP (app));
gtk_widget_destroy (GTK_WIDGET (app));
}
static void add_app (PhoshFavorites *self, PhoshToplevel *toplevel)
{
PhoshMonitor *monitor = phosh_shell_get_primary_monitor (phosh_shell_get_default());
PhoshFavorites *self = data;
PhoshFavoritesPrivate *priv;
GtkWidget *app;
int max_width = 0;
int box_height = 0;
const gchar *app_id, *title;
g_return_if_fail (PHOSH_IS_FAVORITES (self));
priv = phosh_favorites_get_instance_private (self);
max_width = ((gdouble) monitor->width / (gdouble) monitor->scale) * 0.75;
max_width = MIN (max_width, 450);
box_height = gtk_widget_get_allocated_height (priv->evbox_running_apps);
app_id = phosh_toplevel_get_app_id (toplevel);
title = phosh_toplevel_get_title (toplevel);
g_debug ("Building activator for '%s' (%s)", app_id, title);
app = phosh_app_new (app_id, title);
g_object_set (app,
......@@ -130,50 +129,38 @@ handle_xdg_switcher_xdg_surface (
"max-height", APP_MAX_HEIGHT (box_height),
"max-width", max_width,
NULL);
g_object_set_data(G_OBJECT(app), "toplevel", toplevel);
gtk_box_pack_end (GTK_BOX (priv->box_running_apps), app, FALSE, FALSE, 0);
gtk_widget_show (app);
g_signal_connect (app, "clicked", G_CALLBACK (app_clicked_cb), self);
g_signal_connect_swapped (app, "app-closed", G_CALLBACK (on_app_closed), self);
gtk_widget_show (GTK_WIDGET (self));
}
g_signal_connect_swapped (app, "clicked", G_CALLBACK (app_clicked_cb), self);
g_signal_connect_swapped (app, "app-closed", G_CALLBACK (app_closed_cb), self);
static void
handle_xdg_switcher_list_xdg_surfaces_done(
void *data,
struct phosh_private_xdg_switcher *phosh_private_xdg_switcher)
{
g_debug ("Got all apps");
g_signal_connect (toplevel, "closed", G_CALLBACK (toplevel_closed_cb), app);
}
static const struct phosh_private_xdg_switcher_listener xdg_switcher_listener = {
handle_xdg_switcher_xdg_surface,
handle_xdg_switcher_list_xdg_surfaces_done,
};
static void
get_running_apps (PhoshFavorites *self)
{
PhoshFavoritesPrivate *priv = phosh_favorites_get_instance_private (self);
struct phosh_private *phosh_private;
phosh_private = phosh_wayland_get_phosh_private (
phosh_wayland_get_default ());
PhoshToplevelManager *toplevel_manager = phosh_shell_get_toplevel_manager (phosh_shell_get_default());
guint toplevels_num = phosh_toplevel_manager_get_num_toplevels (toplevel_manager);
if (!phosh_private) {
g_debug ("Skipping app list due to missing phosh_private protocol extension");
return;
for (guint i = 0; i < toplevels_num; i++) {
PhoshToplevel *toplevel = phosh_toplevel_manager_get_toplevel (toplevel_manager, i);
add_app (self, toplevel);
}
}
priv->xdg_switcher = phosh_private_get_xdg_switcher (phosh_private);
phosh_private_xdg_switcher_add_listener (priv->xdg_switcher, &xdg_switcher_listener, self);
phosh_private_xdg_switcher_list_xdg_surfaces (priv->xdg_switcher);
static void
toplevel_added_cb (PhoshFavorites *self, PhoshToplevel *toplevel, PhoshToplevelManager *manager)
{
g_return_if_fail (PHOSH_IS_FAVORITES (self));
g_return_if_fail (PHOSH_IS_TOPLEVEL (toplevel));
g_return_if_fail (PHOSH_IS_TOPLEVEL_MANAGER (manager));
add_app (self, toplevel);
}
static void
set_max_height (GtkWidget *widget,
gpointer user_data)
......@@ -293,6 +280,8 @@ phosh_favorites_constructed (GObject *object)
{
PhoshFavorites *self = PHOSH_FAVORITES (object);
PhoshFavoritesPrivate *priv = phosh_favorites_get_instance_private (self);
PhoshToplevelManager *toplevel_manager =
phosh_shell_get_toplevel_manager (phosh_shell_get_default ());
G_OBJECT_CLASS (phosh_favorites_parent_class)->constructed (object);
......@@ -314,10 +303,15 @@ phosh_favorites_constructed (GObject *object)
gtk_widget_set_events (priv->evbox_running_apps, GDK_BUTTON_PRESS_MASK);
get_running_apps (self);
g_signal_connect_swapped (toplevel_manager, "toplevel-added",
G_CALLBACK (toplevel_added_cb),
self);
g_signal_connect (priv->evbox_running_apps,
"size-allocate",
G_CALLBACK (running_apps_resized),
self);
gtk_widget_show_all (GTK_WIDGET(self));
}
......@@ -383,21 +377,3 @@ phosh_favorites_new (void)
{
return g_object_new (PHOSH_TYPE_FAVORITES, NULL);
}
void
phosh_favorites_refresh_running_apps (PhoshFavorites *self)
{
PhoshFavoritesPrivate *priv;
g_return_if_fail (PHOSH_IS_FAVORITES (self));
priv = phosh_favorites_get_instance_private (self);
g_return_if_fail (priv->xdg_switcher);
gtk_container_foreach (GTK_CONTAINER (priv->box_running_apps),
(GtkCallback)gtk_widget_destroy,
NULL);
phosh_private_xdg_switcher_list_xdg_surfaces (priv->xdg_switcher);
}
......@@ -13,4 +13,3 @@
G_DECLARE_FINAL_TYPE (PhoshFavorites, phosh_favorites, PHOSH, FAVORITES, GtkBin)
GtkWidget * phosh_favorites_new (void);
void phosh_favorites_refresh_running_apps (PhoshFavorites *self);
......@@ -237,9 +237,6 @@ phosh_home_set_state (PhoshHome *self, PhoshHomeState state)
if (state == PHOSH_HOME_STATE_UNFOLDED) {
int height;
/* Until we switched to wlr-foreign-toplevel-management */
phosh_favorites_refresh_running_apps (PHOSH_FAVORITES (self->favorites));
phosh_shell_get_usable_area (phosh_shell_get_default (), NULL, NULL, NULL, &height);
phosh_layer_surface_set_size (PHOSH_LAYER_SURFACE (self), -1, PHOSH_HOME_BUTTON_HEIGHT + height);
} else {
......
......@@ -32,6 +32,10 @@ libphosh_sources = [
'app.h',
'favorites.c',
'favorites.h',
'toplevel.c',
'toplevel.h',
'toplevel-manager.c',
'toplevel-manager.h',
phosh_resources,
wl_proto_sources,
]
......
......@@ -40,6 +40,7 @@ typedef struct {
struct zwlr_layer_shell_v1 *layer_shell;
struct zxdg_output_manager_v1 *zxdg_output_manager_v1;
struct zwlr_output_manager_v1 *zwlr_output_manager_v1;
struct zwlr_foreign_toplevel_manager_v1 *zwlr_foreign_toplevel_manager_v1;
GHashTable *wl_outputs;
} PhoshWaylandPrivate;
......@@ -123,6 +124,12 @@ registry_handle_global (void *data,
name,
&zwlr_output_manager_v1_interface,
1);
} else if (!strcmp (interface, zwlr_foreign_toplevel_manager_v1_interface.name)) {
priv->zwlr_foreign_toplevel_manager_v1 = wl_registry_bind(
registry,
name,
&zwlr_foreign_toplevel_manager_v1_interface,
2);
}
}
......@@ -226,6 +233,10 @@ phosh_wayland_constructed (GObject *object)
priv->zxdg_output_manager_v1,
priv->zwlr_output_manager_v1);
}
if (!priv->zwlr_foreign_toplevel_manager_v1) {
g_info ("Could not find wlr_foreign_toplevel_management interface, "
"window mangement won't be possible");
}
if (!priv->phosh_private) {
g_info ("Could not find phosh private interface, disabling some features");
}
......@@ -357,6 +368,14 @@ phosh_wayland_get_zwlr_output_manager_v1 (PhoshWayland *self)
}
struct zwlr_foreign_toplevel_manager_v1*
phosh_wayland_get_zwlr_foreign_toplevel_manager_v1 (PhoshWayland *self)
{
PhoshWaylandPrivate *priv = phosh_wayland_get_instance_private (self);
return priv->zwlr_foreign_toplevel_manager_v1;
}
GHashTable*
phosh_wayland_get_wl_outputs (PhoshWayland *self)
{
......
......@@ -14,6 +14,7 @@
#include "xdg-shell-client-protocol.h"
#include "xdg-output-unstable-v1-client-protocol.h"
#include "wlr-output-management-unstable-v1-client-protocol.h"
#include "wlr-foreign-toplevel-management-unstable-v1-client-protocol.h"
#include <glib-object.h>
......@@ -34,4 +35,5 @@ struct zwlr_input_inhibit_manager_v1 *phosh_wayland_get_zwlr_input_inhibit_manag
struct zwlr_layer_shell_v1 *phosh_wayland_get_zwlr_layer_shell_v1 (PhoshWayland *self);
struct zxdg_output_manager_v1 *phosh_wayland_get_zxdg_output_manager_v1 (PhoshWayland *self);
struct zwlr_output_manager_v1 *phosh_wayland_get_zwlr_output_manager_v1 (PhoshWayland *self);
struct zwlr_foreign_toplevel_manager_v1 *phosh_wayland_get_zwlr_foreign_toplevel_manager_v1 (PhoshWayland *self);
void phosh_wayland_roundtrip (PhoshWayland *self);
......@@ -69,6 +69,7 @@ typedef struct
PhoshLockscreenManager *lockscreen_manager;
PhoshIdleManager *idle_manager;
PhoshOskManager *osk_manager;
PhoshToplevelManager *toplevel_manager;
PhoshWifiManager *wifi_manager;
PhoshPolkitAuthAgent *polkit_auth_agent;
} PhoshShellPrivate;
......@@ -377,6 +378,7 @@ phosh_shell_dispose (GObject *object)
panels_dispose (self);
g_clear_object (&priv->lockscreen_manager);
g_clear_object (&priv->monitor_manager);
g_clear_object (&priv->toplevel_manager);
g_clear_object (&priv->wifi_manager);
g_clear_object (&priv->osk_manager);
g_clear_object (&priv->polkit_auth_agent);
......@@ -433,6 +435,8 @@ phosh_shell_constructed (GObject *object)
priv->lockscreen_manager = phosh_lockscreen_manager_new ();
priv->idle_manager = phosh_idle_manager_get_default();
priv->toplevel_manager = phosh_toplevel_manager_new ();
phosh_session_register ("sm.puri.Phosh");
phosh_system_prompter_register ();
priv->polkit_auth_agent = phosh_polkit_auth_agent_new ();
......@@ -625,6 +629,19 @@ phosh_shell_get_osk_manager (PhoshShell *self)
return priv->osk_manager;
}
PhoshToplevelManager *
phosh_shell_get_toplevel_manager (PhoshShell *self)
{
PhoshShellPrivate *priv;
g_return_val_if_fail (PHOSH_IS_SHELL (self), NULL);
priv = phosh_shell_get_instance_private (self);
g_return_val_if_fail (PHOSH_IS_TOPLEVEL_MANAGER (priv->toplevel_manager), NULL);
return priv->toplevel_manager;
}