1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
#include "gtk-shell-protocol.h"
#include "wayfire/core.hpp"
#include "wayfire/object.hpp"
#include <map>
#include <string>
#include <wayfire/util.hpp>
#include <wayfire/view.hpp>
#include <wayfire/signal-definitions.hpp>
#include <wayfire/nonstd/wlroots-full.hpp>
#include <wayfire/plugin.hpp>
#include <wayfire/toplevel-view.hpp>
#include <wayfire/window-manager.hpp>
#include "gtk-shell.hpp"
#define GTK_SHELL_VERSION 3
class wf_gtk_shell : public wf::custom_data_t
{
public:
std::map<wl_resource*, std::string> surface_app_id;
};
struct wf_gtk_surface
{
wl_resource *resource;
wl_resource *wl_surface;
wf::wl_listener_wrapper on_configure;
wf::wl_listener_wrapper on_destroy;
};
/**
* In gnome-shell/mutter/meta windows/views keep track of the properties
* specified as arguments here.
* Currently only the app_id is implemented / required.
*/
static void handle_gtk_surface_set_dbus_properties(wl_client *client,
wl_resource *resource,
const char *application_id, const char *app_menu_path, const char *menubar_path,
const char *window_object_path, const char *application_object_path,
const char *unique_bus_name)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
if (application_id)
{
wf::get_core().get_data_safe<wf_gtk_shell>()->surface_app_id[surface->wl_surface] = application_id;
}
}
/**
* Modal dialogs may be handled differently than non-modal dialogs.
* It is a hint that this should be attached to the parent surface.
* In gnome this does not affect input-focus.
* This function sets the modal hint.
*/
static void handle_gtk_surface_set_modal(wl_client *client, wl_resource *resource)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
wayfire_view view = wf::wl_surface_to_wayfire_view(surface->wl_surface);
if (view)
{
view->store_data(std::make_unique<wf::custom_data_t>(), "gtk-shell-modal");
}
}
/**
* Modal dialogs may be handled differently than non-modal dialogs.
* It is a hint that this should be attached to the parent surface.
* In gnome this does not affect input-focus.
* This function removes the modal hint.
*/
static void handle_gtk_surface_unset_modal(wl_client *client, wl_resource *resource)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
wayfire_view view = wf::wl_surface_to_wayfire_view(surface->wl_surface);
if (view)
{
view->erase_data("gtk-shell-modal");
}
}
/**
* The surface requests focus, for example single instance applications like
* gnome-control-center, gnome-clocks, dconf-editor are single instance and if
* they are already running and launched again, this will request that they get
* focused.
* This function is superseded by handle_gtk_surface_request_focus a newer
* equivalelent
* used by gtk-applications now. This function is for compatibility reasons.
*/
static void handle_gtk_surface_present(wl_client *client, wl_resource *resource,
uint32_t time)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
wayfire_toplevel_view view = toplevel_cast(wf::wl_surface_to_wayfire_view(surface->wl_surface));
if (view)
{
wf::get_core().default_wm->focus_request(view, true);
}
}
/**
* The surface requests focus, for example single instance applications like
* gnome-control-center, gnome-clocks, dconf-editor are single instance and if
* they are already running and launched again, this will request that they get
* focused.
*/
static void handle_gtk_surface_request_focus(struct wl_client *client,
struct wl_resource *resource,
const char *startup_id)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
wayfire_toplevel_view view = toplevel_cast(wf::wl_surface_to_wayfire_view(surface->wl_surface));
if (view)
{
wf::get_core().default_wm->focus_request(view, true);
}
}
/**
* Helper function used by send_gtk_surface_configure
* and send_gtk_surface_configure_edges
*/
static void append_to_array(wl_array *array, uint32_t value)
{
uint32_t *tmp;
tmp = (uint32_t*)wl_array_add(array, sizeof(*tmp));
*tmp = value;
}
/**
* Tells the client about the window state in more detail than xdg_surface.
* This currently only includes which edges are tiled.
*/
static void send_gtk_surface_configure(wf_gtk_surface *surface, wayfire_toplevel_view view)
{
int version = wl_resource_get_version(surface->resource);
wl_array states;
wl_array_init(&states);
if (view->pending_tiled_edges())
{
append_to_array(&states, GTK_SURFACE1_STATE_TILED);
}
if ((version >= GTK_SURFACE1_STATE_TILED_TOP_SINCE_VERSION) &&
(view->pending_tiled_edges() & WLR_EDGE_TOP))
{
append_to_array(&states, GTK_SURFACE1_STATE_TILED_TOP);
}
if ((version >= GTK_SURFACE1_STATE_TILED_RIGHT_SINCE_VERSION) &&
(view->pending_tiled_edges() & WLR_EDGE_RIGHT))
{
append_to_array(&states, GTK_SURFACE1_STATE_TILED_RIGHT);
}
if ((version >= GTK_SURFACE1_STATE_TILED_BOTTOM_SINCE_VERSION) &&
(view->pending_tiled_edges() & WLR_EDGE_BOTTOM))
{
append_to_array(&states, GTK_SURFACE1_STATE_TILED_BOTTOM);
}
if ((version >= GTK_SURFACE1_STATE_TILED_LEFT_SINCE_VERSION) &&
(view->pending_tiled_edges() & WLR_EDGE_LEFT))
{
append_to_array(&states, GTK_SURFACE1_STATE_TILED_LEFT);
}
gtk_surface1_send_configure(surface->resource, &states);
wl_array_release(&states);
}
/**
* Tells gtk which edges should be resizable.
*/
static void send_gtk_surface_configure_edges(wf_gtk_surface *surface, wayfire_toplevel_view view)
{
wl_array edges;
wl_array_init(&edges);
if (!view->pending_tiled_edges())
{
append_to_array(&edges, GTK_SURFACE1_EDGE_CONSTRAINT_RESIZABLE_TOP);
append_to_array(&edges, GTK_SURFACE1_EDGE_CONSTRAINT_RESIZABLE_RIGHT);
append_to_array(&edges, GTK_SURFACE1_EDGE_CONSTRAINT_RESIZABLE_BOTTOM);
append_to_array(&edges, GTK_SURFACE1_EDGE_CONSTRAINT_RESIZABLE_LEFT);
}
gtk_surface1_send_configure_edges(surface->resource, &edges);
wl_array_release(&edges);
}
/**
* Augments xdg_surface's configure with additional gtk-specific information.
*/
static void handle_xdg_surface_on_configure(wf_gtk_surface *surface)
{
wayfire_toplevel_view view = wf::toplevel_cast(wf::wl_surface_to_wayfire_view(surface->wl_surface));
if (view)
{
send_gtk_surface_configure(surface, view);
if (wl_resource_get_version(surface->resource) >=
GTK_SURFACE1_CONFIGURE_EDGES_SINCE_VERSION)
{
send_gtk_surface_configure_edges(surface, view);
}
}
}
/**
* Prevents a race condition where the xdg_surface is destroyed before
* the gtk_surface's resource and the gtk_surface's destructor tries to
* disconnect these signals which causes a use-after-free
*/
static void handle_xdg_surface_on_destroy(wf_gtk_surface *surface)
{
surface->on_configure.disconnect();
surface->on_destroy.disconnect();
}
/**
* Destroys the gtk_surface object.
*/
static void handle_gtk_surface_destroy(wl_resource *resource)
{
auto surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(resource));
delete surface;
}
/**
* Supported functions of the gtk_surface_interface implementation
*/
const struct gtk_surface1_interface gtk_surface1_impl = {
.set_dbus_properties = handle_gtk_surface_set_dbus_properties,
.set_modal = handle_gtk_surface_set_modal,
.unset_modal = handle_gtk_surface_unset_modal,
.present = handle_gtk_surface_present,
.request_focus = handle_gtk_surface_request_focus,
};
/**
* Initializes a gtk_surface object and passes it to the client.
*/
static void handle_gtk_shell_get_gtk_surface(wl_client *client, wl_resource *resource,
uint32_t id, wl_resource *surface)
{
wf_gtk_surface *gtk_surface = new wf_gtk_surface;
gtk_surface->resource = wl_resource_create(client, >k_surface1_interface,
wl_resource_get_version(resource), id);
gtk_surface->wl_surface = surface;
wl_resource_set_implementation(gtk_surface->resource, >k_surface1_impl,
gtk_surface, handle_gtk_surface_destroy);
wlr_surface *wlr_surface = wlr_surface_from_resource(surface);
if (wlr_xdg_surface *xdg_surface = wlr_xdg_surface_try_from_wlr_surface(wlr_surface))
{
gtk_surface->on_configure.set_callback([=] (void*)
{
handle_xdg_surface_on_configure(gtk_surface);
});
gtk_surface->on_configure.connect(&xdg_surface->events.configure);
gtk_surface->on_destroy.set_callback([=] (void*)
{
handle_xdg_surface_on_destroy(gtk_surface);
});
gtk_surface->on_destroy.connect(&xdg_surface->events.destroy);
}
}
/**
* Supplements the request_focus() and present()
* to prevent focus stealing if user interaction happened
* between the time application was called and request_focus was received.
* Not implemented.
*/
static void handle_gtk_shell_notify_launch(wl_client *client, wl_resource *resource,
const char *startup_id)
{}
/**
* A view could use this to receive notification when the surface is ready.
* Gets the DESKTOP_STARTUP_ID from environment and unsets this env var afterwards
* so any child processes don't inherit it.
* Not implemented.
*/
static void handle_gtk_shell_set_startup_id(wl_client *client, wl_resource *resource,
const char *startup_id)
{}
/**
* A view could use this to invoke the system bell, be it aural, visual or none at
* all.
*/
static void handle_gtk_shell_system_bell(wl_client *client, wl_resource *resource,
wl_resource *surface)
{
wf::view_system_bell_signal data;
if (surface)
{
auto gtk_surface = static_cast<wf_gtk_surface*>(wl_resource_get_user_data(surface));
data.view = wf::wl_surface_to_wayfire_view(gtk_surface->wl_surface);
}
wf::get_core().emit(&data);
}
/**
* Supported functions of the gtk_shell_interface implementation
*/
static const struct gtk_shell1_interface gtk_shell1_impl = {
.get_gtk_surface = handle_gtk_shell_get_gtk_surface,
.set_startup_id = handle_gtk_shell_set_startup_id,
.system_bell = handle_gtk_shell_system_bell,
.notify_launch = handle_gtk_shell_notify_launch,
};
/**
* Destroy the gtk_shell object.
* gtk_shell exists as long as the compositor runs.
*/
static void handle_gtk_shell1_destroy(wl_resource *resource)
{}
/**
* Binds the gtk_shell to wayland.
*/
void bind_gtk_shell1(wl_client *client, void *data, uint32_t version, uint32_t id)
{
auto resource = wl_resource_create(client, >k_shell1_interface, GTK_SHELL_VERSION, id);
wl_resource_set_implementation(resource, >k_shell1_impl, data, handle_gtk_shell1_destroy);
}
class wayfire_gtk_shell_impl : public wf::plugin_interface_t
{
public:
void init() override
{
auto display = wf::get_core().display;
wl_global_create(display, >k_shell1_interface, GTK_SHELL_VERSION, NULL, bind_gtk_shell1);
wf::get_core().connect(&on_app_id_query);
}
bool is_unloadable() override
{
return false;
}
wf::signal::connection_t<gtk_shell_app_id_query_signal> on_app_id_query =
[=] (gtk_shell_app_id_query_signal *ev)
{
if (auto surface = ev->view->get_wlr_surface())
{
auto shell = wf::get_core().get_data_safe<wf_gtk_shell>();
ev->app_id = shell->surface_app_id[surface->resource];
}
};
};
DECLARE_WAYFIRE_PLUGIN(wayfire_gtk_shell_impl);
|