src/desktop.c

   1 /*
   2  * Copyright © 2019 Collabora, Ltd.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial
  14  * portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <assert.h>
  27 #include "ivi-compositor.h"
  28 #include "policy.h"
  29
  30 #include "shared/helpers.h"
  31 #include <libweston/libweston.h>
  32 #include <libweston-desktop/libweston-desktop.h>
  33 #ifdef BUILD_XWAYLAND
  34 #include <libweston/xwayland-api.h>
  35 #endif
  36
  37 #include "agl-shell-desktop-server-protocol.h"
  38
  39 static void
  40 desktop_advertise_app(struct wl_listener *listener, void *data)
  41 {
  42         struct ivi_surface *surface;
  43
  44         surface = wl_container_of(listener, surface, listener_advertise_app);
  45
  46         agl_shell_desktop_advertise_application_id(surface->ivi, surface);
  47 }
  48
  49 static void
  50 desktop_ping_timeout(struct weston_desktop_client *dclient, void *userdata)
  51 {
  52         /* not supported */
  53 }
  54
  55 static void
  56 desktop_pong(struct weston_desktop_client *dclient, void *userdata)
  57 {
  58         /* not supported */
  59 }
  60
  61 struct weston_output *
  62 get_default_output(struct weston_compositor *compositor)
  63 {
  64         if (wl_list_empty(&compositor->output_list))
  65                 return NULL;
  66
  67         return container_of(compositor->output_list.next,
  68                         struct weston_output, link);
  69 }
  70
  71 struct weston_output *
  72 get_focused_output(struct weston_compositor *compositor)
  73 {
  74         struct weston_seat *seat;
  75         struct weston_output *output = NULL;
  76
  77         wl_list_for_each(seat, &compositor->seat_list, link) {
  78                 struct weston_touch *touch = weston_seat_get_touch(seat);
  79                 struct weston_pointer *pointer = weston_seat_get_pointer(seat);
  80                 struct weston_keyboard *keyboard =
  81                         weston_seat_get_keyboard(seat);
  82
  83                 if (touch && touch->focus)
  84                         output = touch->focus->output;
  85                 else if (pointer && pointer->focus)
  86                         output = pointer->focus->output;
  87                 else if (keyboard && keyboard->focus)
  88                         output = keyboard->focus->output;
  89
  90                 if (output)
  91                         break;
  92         }
  93
  94         return output;
  95 }
  96
  97 void
  98 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
  99                           struct ivi_shell_seat *ivi_seat,
 100                           uint32_t flags)
 101 {
 102        struct weston_desktop_surface *dsurface = ivi_surf->dsurface;
 103        struct weston_surface *surface =
 104                weston_desktop_surface_get_surface(dsurface);
 105
 106        weston_view_activate_input(ivi_surf->view, ivi_seat->seat, flags);
 107
 108        if (ivi_seat->focused_surface) {
 109                struct ivi_surface *current_focus =
 110                        get_ivi_shell_surface(ivi_seat->focused_surface);
 111                struct weston_desktop_surface *dsurface_focus;
 112                assert(current_focus);
 113
 114                dsurface_focus = current_focus->dsurface;
 115                if (--current_focus->focus_count == 0)
 116                        weston_desktop_surface_set_activated(dsurface_focus, false);
 117        }
 118
 119        ivi_seat->focused_surface = surface;
 120        if (ivi_surf->focus_count++ == 0)
 121                weston_desktop_surface_set_activated(dsurface, true);
 122 }
 123
 124
 125 static void
 126 desktop_surface_added_configure(struct ivi_surface *surface,
 127                                 struct ivi_output *ivi_output)
 128 {
 129         enum ivi_surface_role role = IVI_SURFACE_ROLE_NONE;
 130         struct weston_desktop_surface *dsurface = surface->dsurface;
 131
 132         ivi_check_pending_surface_desktop(surface, &role);
 133         if ((role != IVI_SURFACE_ROLE_DESKTOP &&
 134              role != IVI_SURFACE_ROLE_FULLSCREEN &&
 135              role != IVI_SURFACE_ROLE_REMOTE) ||
 136              role == IVI_SURFACE_ROLE_NONE)
 137                 return;
 138
 139         if (role == IVI_SURFACE_ROLE_FULLSCREEN) {
 140                 struct ivi_output *bg_output =
 141                         ivi_layout_find_bg_output(surface->ivi);
 142                 assert(bg_output);
 143                 weston_desktop_surface_set_fullscreen(dsurface, true);
 144                 weston_desktop_surface_set_size(dsurface,
 145                                                 bg_output->output->width,
 146                                                 bg_output->output->height);
 147                 return;
 148         }
 149
 150         weston_desktop_surface_set_maximized(dsurface, true);
 151         weston_desktop_surface_set_size(dsurface,
 152                                         ivi_output->area.width,
 153                                         ivi_output->area.height);
 154 }
 155
 156
 157 static void
 158 desktop_surface_added(struct weston_desktop_surface *dsurface, void *userdata)
 159 {
 160         struct ivi_compositor *ivi = userdata;
 161         struct weston_desktop_client *dclient;
 162         struct wl_client *client;
 163         struct ivi_surface *surface;
 164         struct ivi_output *active_output = NULL;
 165         struct weston_output *output = NULL;
 166         const char *app_id = NULL;
 167
 168         dclient = weston_desktop_surface_get_client(dsurface);
 169         client = weston_desktop_client_get_client(dclient);
 170
 171         if (ivi->shell_client.resource &&
 172             ivi->shell_client.status == BOUND_FAILED) {
 173                 wl_client_post_implementation_error(client,
 174                                        "agl_shell has already been bound. "
 175                                        "Check out bound_fail event");
 176                 return;
 177         }
 178
 179         surface = zalloc(sizeof *surface);
 180         if (!surface) {
 181                 wl_client_post_no_memory(client);
 182                 return;
 183         }
 184
 185         surface->view = weston_desktop_surface_create_view(dsurface);
 186         if (!surface->view) {
 187                 free(surface);
 188                 wl_client_post_no_memory(client);
 189                 return;
 190         }
 191
 192         surface->ivi = ivi;
 193         surface->dsurface = dsurface;
 194         surface->role = IVI_SURFACE_ROLE_NONE;
 195         surface->mapped = false;
 196         surface->advertised_on_launch = false;
 197         surface->checked_pending = false;
 198         wl_list_init(&surface->link);
 199
 200         wl_signal_init(&surface->signal_advertise_app);
 201
 202         surface->listener_advertise_app.notify = desktop_advertise_app;
 203         wl_signal_add(&surface->signal_advertise_app,
 204                       &surface->listener_advertise_app);
 205
 206         weston_desktop_surface_set_user_data(dsurface, surface);
 207
 208         if (ivi->policy && ivi->policy->api.surface_create &&
 209             !ivi->policy->api.surface_create(surface, ivi)) {
 210                 wl_client_post_no_memory(client);
 211                 return;
 212         }
 213
 214
 215         app_id = weston_desktop_surface_get_app_id(dsurface);
 216
 217         if ((active_output = ivi_layout_find_with_app_id(app_id, ivi))) {
 218                 ivi_set_pending_desktop_surface_remote(active_output, app_id);
 219                 shell_send_app_on_output(ivi, app_id, active_output->output->name);
 220         }
 221
 222         /* reset any caps to make sure we apply the new caps */
 223         ivi_seat_reset_caps_sent(ivi);
 224
 225         output =  get_focused_output(ivi->compositor);
 226         if (!output)
 227                 output = get_default_output(ivi->compositor);
 228
 229         if (output && ivi->shell_client.ready) {
 230                 struct ivi_output *ivi_output = to_ivi_output(output);
 231                 if (active_output)
 232                         desktop_surface_added_configure(surface, active_output);
 233                 else
 234                         desktop_surface_added_configure(surface, ivi_output);
 235         }
 236         /*
 237          * We delay creating "normal" desktop surfaces until later, to
 238          * give the shell-client an oppurtunity to set the surface as a
 239          * background/panel.
 240          * Also delay the creation in order to have a valid app_id
 241          * which will be used to set the proper role.
 242          */
 243         weston_log("Added surface %p, app_id %s to pending list\n",
 244                         surface, app_id);
 245         wl_list_insert(&ivi->pending_surfaces, &surface->link);
 246
 247 }
 248
 249 bool
 250 ivi_surface_count_one(struct ivi_output *ivi_output,
 251                       enum ivi_surface_role role)
 252 {
 253         int count = 0;
 254         struct ivi_surface *surf;
 255
 256         wl_list_for_each(surf, &ivi_output->ivi->surfaces, link)
 257                 if (surf->role == role &&
 258                     surf->current_completed_output == ivi_output)
 259                         count++;
 260
 261         return (count == 1);
 262 }
 263
 264 static void
 265 desktop_surface_removed(struct weston_desktop_surface *dsurface, void *userdata)
 266 {
 267         struct ivi_surface *surface =
 268                 weston_desktop_surface_get_user_data(dsurface);
 269         struct weston_surface *wsurface =
 270                 weston_desktop_surface_get_surface(dsurface);
 271         const char *app_id = NULL;
 272         struct weston_seat *wseat = NULL;
 273         struct ivi_shell_seat *ivi_seat = NULL;
 274         struct ivi_output *output = NULL;
 275
 276         /* we might not have a valid ivi_surface if _added failed due to
 277          * protocol errors */
 278         if (!surface)
 279                 return;
 280
 281         wseat = get_ivi_shell_weston_first_seat(surface->ivi);
 282         if (wseat)
 283                 ivi_seat = get_ivi_shell_seat(wseat);
 284
 285         output = ivi_layout_get_output_from_surface(surface);
 286
 287         wl_list_remove(&surface->listener_advertise_app.link);
 288         surface->listener_advertise_app.notify = NULL;
 289
 290         app_id = weston_desktop_surface_get_app_id(dsurface);
 291
 292         /* special corner-case, pending_surfaces which are never activated or
 293          * being assigned an output might land here so just remove the surface;
 294          *
 295          * the DESKTOP role can happen here as well, because we can fall-back
 296          * to that when we try to determine the role type. Application that
 297          * do not set the app_id will be land here, when destroyed */
 298         if ((output == NULL && (surface->role == IVI_SURFACE_ROLE_NONE ||
 299                                 surface->role == IVI_SURFACE_ROLE_DESKTOP)) ||
 300              output->output == NULL)
 301                 goto skip_output_asignment;
 302
 303         assert(output != NULL);
 304
 305         /* resize the active surface to the original size */
 306         if (surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
 307             surface->role == IVI_SURFACE_ROLE_SPLIT_V) {
 308                 if (output && output->active) {
 309                         ivi_layout_desktop_resize(output->active, output->area_saved);
 310                 }
 311                 /* restore the area back so we can re-use it again if needed */
 312                 output->area = output->area_saved;
 313         }
 314
 315         /* reset the active surface as well */
 316         if (output && output->active && output->active == surface) {
 317                 output->active->view->is_mapped = false;
 318                 output->active->view->surface->is_mapped = false;
 319
 320                 weston_layer_entry_remove(&output->active->view->layer_link);
 321                 output->active = NULL;
 322         }
 323
 324         /* clear out focused_surface to avoid a stale focused_surface. the
 325          * client shell is responsible for keeping track and switch back to the
 326          * last active surface so we don't get do anything at removal, just
 327          * reset it */
 328         if (ivi_seat && ivi_seat->focused_surface == wsurface)
 329                 ivi_seat->focused_surface = NULL;
 330
 331         /* check if there's a last 'remote' surface and insert a black
 332          * surface view if there's no background set for that output
 333          */
 334         if (ivi_surface_count_one(output, IVI_SURFACE_ROLE_REMOTE) ||
 335             ivi_surface_count_one(output, IVI_SURFACE_ROLE_DESKTOP))
 336                 if (!output->background)
 337                         insert_black_curtain(output);
 338
 339
 340         if (weston_surface_is_mapped(wsurface)) {
 341                 weston_desktop_surface_unlink_view(surface->view);
 342                 weston_view_destroy(surface->view);
 343         }
 344
 345         /* invalidate agl-shell surfaces so we can re-use them when
 346          * binding again */
 347         if (surface->role == IVI_SURFACE_ROLE_PANEL) {
 348                 switch (surface->panel.edge) {
 349                 case AGL_SHELL_EDGE_TOP:
 350                         output->top = NULL;
 351                         break;
 352                 case AGL_SHELL_EDGE_BOTTOM:
 353                         output->bottom = NULL;
 354                         break;
 355                 case AGL_SHELL_EDGE_LEFT:
 356                         output->left = NULL;
 357                         break;
 358                 case AGL_SHELL_EDGE_RIGHT:
 359                         output->right = NULL;
 360                         break;
 361                 default:
 362                         assert(!"Invalid edge detected\n");
 363                 }
 364         } else if (surface->role == IVI_SURFACE_ROLE_BACKGROUND) {
 365                 output->background = NULL;
 366         }
 367
 368 skip_output_asignment:
 369         weston_log("Removed surface %p, app_id %s, role %s\n", surface,
 370                         app_id, ivi_layout_get_surface_role_name(surface));
 371
 372         if (app_id && output && output->output) {
 373                 shell_advertise_app_state(output->ivi, app_id,
 374                                           NULL, AGL_SHELL_DESKTOP_APP_STATE_DESTROYED);
 375                 if (output->ivi->shell_client.ready)
 376                         shell_send_app_state(output->ivi, app_id, AGL_SHELL_APP_STATE_TERMINATED);
 377         }
 378
 379         wl_list_remove(&surface->link);
 380
 381         free(surface);
 382 }
 383
 384 static void
 385 desktop_committed(struct weston_desktop_surface *dsurface,
 386                   int32_t sx, int32_t sy, void *userdata)
 387 {
 388         struct ivi_compositor *ivi = userdata;
 389         struct ivi_surface *surface =
 390                 weston_desktop_surface_get_user_data(dsurface);
 391         struct ivi_policy *policy = surface->ivi->policy;
 392
 393         if (policy && policy->api.surface_commited &&
 394             !policy->api.surface_commited(surface, surface->ivi))
 395                 return;
 396
 397         if (ivi->shell_client.ready && !surface->checked_pending) {
 398                 struct ivi_output *remote_output = NULL;
 399                 const char *app_id =    weston_desktop_surface_get_app_id(dsurface);
 400                 weston_log("Checking pending surface %p, app_id %s\n", surface,
 401                         app_id);
 402                 wl_list_remove(&surface->link);
 403                 wl_list_init(&surface->link);
 404
 405                 if ((remote_output = ivi_layout_find_with_app_id(app_id, ivi))) {
 406                         ivi_set_pending_desktop_surface_remote(remote_output, app_id);
 407                         shell_send_app_on_output(ivi, app_id, remote_output->output->name);
 408                 }
 409
 410
 411                 ivi_check_pending_desktop_surface(surface);
 412                 surface->checked_pending = true;
 413
 414                 /* we'll do it now at commit time, because we might not have an
 415                  * appid by the time we've created the weston_desktop_surface
 416                  * */
 417                 shell_send_app_state(ivi, app_id, AGL_SHELL_APP_STATE_STARTED);
 418         }
 419
 420         if (!surface->advertised_on_launch &&
 421             !wl_list_empty(&surface->ivi->desktop_clients))
 422                 wl_signal_emit(&surface->signal_advertise_app, surface);
 423
 424         /* this repaint schedule is needed to allow resizing to work with the
 425          * help of the hidden layer:
 426          *
 427          * 1. add the view in the hidden layer and send out correct dimensions
 428          * 2. clients changes its dimensions
 429          * 3. client commits with the new dimensions
 430          *
 431          * For desktop and fullscreen, desktop_surface_added() sends the
 432          * dimensions from the beginning so applications no need to resize, but
 433          * if that weren't the case we still need this in.
 434          */
 435         weston_compositor_schedule_repaint(surface->ivi->compositor);
 436
 437         switch (surface->role) {
 438         case IVI_SURFACE_ROLE_DESKTOP:
 439                 ivi_layout_desktop_committed(surface);
 440                 break;
 441         case IVI_SURFACE_ROLE_REMOTE:
 442                 ivi_layout_remote_committed(surface);
 443                 break;
 444         case IVI_SURFACE_ROLE_POPUP:
 445                 ivi_layout_popup_committed(surface);
 446                 break;
 447         case IVI_SURFACE_ROLE_FULLSCREEN:
 448                 ivi_layout_fullscreen_committed(surface);
 449                 break;
 450         case IVI_SURFACE_ROLE_SPLIT_H:
 451         case IVI_SURFACE_ROLE_SPLIT_V:
 452                 ivi_layout_split_committed(surface);
 453                 break;
 454         case IVI_SURFACE_ROLE_NONE:
 455         case IVI_SURFACE_ROLE_BACKGROUND:
 456         case IVI_SURFACE_ROLE_PANEL:
 457         default: /* fall through */
 458                 break;
 459         }
 460 }
 461
 462 static void
 463 desktop_show_window_menu(struct weston_desktop_surface *dsurface,
 464                          struct weston_seat *seat, int32_t x, int32_t y,
 465                          void *userdata)
 466 {
 467         /* not supported */
 468 }
 469
 470 static void
 471 desktop_set_parent(struct weston_desktop_surface *dsurface,
 472                    struct weston_desktop_surface *parent, void *userdata)
 473 {
 474         /* not supported */
 475 }
 476
 477 static void
 478 desktop_move(struct weston_desktop_surface *dsurface,
 479              struct weston_seat *seat, uint32_t serial, void *userdata)
 480 {
 481         /* not supported */
 482 }
 483
 484 static void
 485 desktop_resize(struct weston_desktop_surface *dsurface,
 486                struct weston_seat *seat, uint32_t serial,
 487                enum weston_desktop_surface_edge edges, void *user_data)
 488 {
 489         /* not supported */
 490 }
 491
 492 static void
 493 desktop_fullscreen_requested(struct weston_desktop_surface *dsurface,
 494                              bool fullscreen, struct weston_output *output,
 495                              void *userdata)
 496 {
 497         /* not supported */
 498 }
 499
 500 static void
 501 desktop_maximized_requested(struct weston_desktop_surface *dsurface,
 502                             bool maximized, void *userdata)
 503 {
 504         /* not supported */
 505 }
 506
 507 static void
 508 desktop_minimized_requested(struct weston_desktop_surface *dsurface,
 509                             void *userdata)
 510 {
 511         /* not supported */
 512 }
 513
 514 static void
 515 desktop_set_xwayland_position(struct weston_desktop_surface *dsurface,
 516                               int32_t x, int32_t y, void *userdata)
 517 {
 518         struct ivi_surface *ivisurf =
 519                 weston_desktop_surface_get_user_data(dsurface);
 520
 521         ivisurf->xwayland.x = x;
 522         ivisurf->xwayland.y = y;
 523         ivisurf->xwayland.is_set = true;
 524 }
 525
 526 static const struct weston_desktop_api desktop_api = {
 527         .struct_size = sizeof desktop_api,
 528         .ping_timeout = desktop_ping_timeout,
 529         .pong = desktop_pong,
 530         .surface_added = desktop_surface_added,
 531         .surface_removed = desktop_surface_removed,
 532         .committed = desktop_committed,
 533         .show_window_menu = desktop_show_window_menu,
 534         .set_parent = desktop_set_parent,
 535         .move = desktop_move,
 536         .resize = desktop_resize,
 537         .fullscreen_requested = desktop_fullscreen_requested,
 538         .maximized_requested = desktop_maximized_requested,
 539         .minimized_requested = desktop_minimized_requested,
 540         .set_xwayland_position = desktop_set_xwayland_position,
 541 };
 542
 543 static void
 544 ivi_shell_destroy(struct wl_listener *listener, void *data)
 545 {
 546         struct ivi_compositor *ivi = container_of(listener,
 547                                 struct ivi_compositor, destroy_listener);
 548
 549         ivi_shell_finalize(ivi);
 550         ivi_compositor_destroy_pending_surfaces(ivi);
 551         ivi_layout_destroy_saved_outputs(ivi);
 552
 553         weston_desktop_destroy(ivi->desktop);
 554         wl_list_remove(&ivi->transform_listener.link);
 555         wl_list_remove(&listener->link);
 556 }
 557
 558 static void
 559 transform_handler(struct wl_listener *listener, void *data)
 560 {
 561 #ifdef BUILD_XWAYLAND
 562         struct weston_surface *surface = data;
 563         struct ivi_surface *ivisurf = get_ivi_shell_surface(surface);
 564         const struct weston_xwayland_surface_api *api;
 565         int x, y;
 566
 567         if (!ivisurf)
 568                 return;
 569
 570         api = ivisurf->ivi->xwayland_surface_api;
 571         if (!api) {
 572                 api = weston_xwayland_surface_get_api(ivisurf->ivi->compositor);
 573                 ivisurf->ivi->xwayland_surface_api = api;
 574         }
 575
 576         if (!api || !api->is_xwayland_surface(surface))
 577                 return;
 578
 579         if (!weston_view_is_mapped(ivisurf->view))
 580                 return;
 581
 582         x = ivisurf->view->geometry.x;
 583         y = ivisurf->view->geometry.y;
 584
 585         api->send_position(surface, x, y);
 586 #endif
 587 }
 588
 589 bool
 590 is_shell_surface_xwayland(struct ivi_surface *surf)
 591 {
 592 #ifdef BUILD_XWAYLAND
 593         const struct weston_xwayland_surface_api *api;
 594         struct ivi_compositor *ivi = surf->ivi;
 595         struct weston_surface *surface;
 596
 597         api = ivi->xwayland_surface_api;
 598
 599         if (!api)
 600                 return false;
 601
 602         surface = weston_desktop_surface_get_surface(surf->dsurface);
 603         return api->is_xwayland_surface(surface);
 604 #else
 605         return false;
 606 #endif
 607 }
 608
 609 int
 610 ivi_desktop_init(struct ivi_compositor *ivi)
 611 {
 612         ivi->desktop = weston_desktop_create(ivi->compositor, &desktop_api, ivi);
 613         if (!ivi->desktop) {
 614                 weston_log("Failed to create desktop globals");
 615                 return -1;
 616         }
 617
 618         if (!weston_compositor_add_destroy_listener_once(ivi->compositor,
 619                         &ivi->destroy_listener, ivi_shell_destroy)) {
 620                 return -1;
 621         }
 622
 623         ivi->transform_listener.notify = transform_handler;
 624         wl_signal_add(&ivi->compositor->transform_signal,
 625                       &ivi->transform_listener);
 626
 627
 628         return 0;
 629 }