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
  34 #include "agl-shell-desktop-server-protocol.h"
  35
  36 static void
  37 desktop_advertise_app(struct wl_listener *listener, void *data)
  38 {
  39         struct ivi_surface *surface;
  40
  41         surface = wl_container_of(listener, surface, listener_advertise_app);
  42
  43         agl_shell_desktop_advertise_application_id(surface->ivi, surface);
  44 }
  45
  46 static void
  47 desktop_ping_timeout(struct weston_desktop_client *dclient, void *userdata)
  48 {
  49         /* not supported */
  50 }
  51
  52 static void
  53 desktop_pong(struct weston_desktop_client *dclient, void *userdata)
  54 {
  55         /* not supported */
  56 }
  57
  58 struct weston_output *
  59 get_default_output(struct weston_compositor *compositor)
  60 {
  61         if (wl_list_empty(&compositor->output_list))
  62                 return NULL;
  63
  64         return container_of(compositor->output_list.next,
  65                         struct weston_output, link);
  66 }
  67
  68 struct weston_output *
  69 get_focused_output(struct weston_compositor *compositor)
  70 {
  71         struct weston_seat *seat;
  72         struct weston_output *output = NULL;
  73
  74         wl_list_for_each(seat, &compositor->seat_list, link) {
  75                 struct weston_touch *touch = weston_seat_get_touch(seat);
  76                 struct weston_pointer *pointer = weston_seat_get_pointer(seat);
  77                 struct weston_keyboard *keyboard =
  78                         weston_seat_get_keyboard(seat);
  79
  80                 if (touch && touch->focus)
  81                         output = touch->focus->output;
  82                 else if (pointer && pointer->focus)
  83                         output = pointer->focus->output;
  84                 else if (keyboard && keyboard->focus)
  85                         output = keyboard->focus->output;
  86
  87                 if (output)
  88                         break;
  89         }
  90
  91         return output;
  92 }
  93
  94 void
  95 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
  96                           struct ivi_shell_seat *ivi_seat,
  97                           uint32_t flags)
  98 {
  99        struct weston_desktop_surface *dsurface = ivi_surf->dsurface;
 100        struct weston_surface *surface =
 101                weston_desktop_surface_get_surface(dsurface);
 102
 103        weston_view_activate_input(ivi_surf->view, ivi_seat->seat, flags);
 104
 105        if (ivi_seat->focused_surface) {
 106                struct ivi_surface *current_focus =
 107                        get_ivi_shell_surface(ivi_seat->focused_surface);
 108                struct weston_desktop_surface *dsurface_focus;
 109                assert(current_focus);
 110
 111                dsurface_focus = current_focus->dsurface;
 112                if (--current_focus->focus_count == 0)
 113                        weston_desktop_surface_set_activated(dsurface_focus, false);
 114        }
 115
 116        ivi_seat->focused_surface = surface;
 117        if (ivi_surf->focus_count++ == 0)
 118                weston_desktop_surface_set_activated(dsurface, true);
 119 }
 120
 121
 122 static void
 123 desktop_surface_added_configure(struct ivi_surface *surface,
 124                                 struct ivi_output *ivi_output)
 125 {
 126         enum ivi_surface_role role = IVI_SURFACE_ROLE_NONE;
 127         struct weston_desktop_surface *dsurface = surface->dsurface;
 128
 129         ivi_check_pending_surface_desktop(surface, &role);
 130         if ((role != IVI_SURFACE_ROLE_DESKTOP &&
 131              role != IVI_SURFACE_ROLE_FULLSCREEN &&
 132              role != IVI_SURFACE_ROLE_REMOTE) ||
 133              role == IVI_SURFACE_ROLE_NONE)
 134                 return;
 135
 136         if (role == IVI_SURFACE_ROLE_FULLSCREEN) {
 137                 struct ivi_output *bg_output =
 138                         ivi_layout_find_bg_output(surface->ivi);
 139                 assert(bg_output);
 140                 weston_desktop_surface_set_fullscreen(dsurface, true);
 141                 weston_desktop_surface_set_size(dsurface,
 142                                                 bg_output->output->width,
 143                                                 bg_output->output->height);
 144                 return;
 145         }
 146
 147         weston_desktop_surface_set_maximized(dsurface, true);
 148         weston_desktop_surface_set_size(dsurface,
 149                                         ivi_output->area.width,
 150                                         ivi_output->area.height);
 151 }
 152
 153
 154 static void
 155 desktop_surface_added(struct weston_desktop_surface *dsurface, void *userdata)
 156 {
 157         struct ivi_compositor *ivi = userdata;
 158         struct weston_desktop_client *dclient;
 159         struct wl_client *client;
 160         struct ivi_surface *surface;
 161         struct ivi_output *active_output = NULL;
 162         struct weston_output *output = NULL;
 163         const char *app_id = NULL;
 164
 165         dclient = weston_desktop_surface_get_client(dsurface);
 166         client = weston_desktop_client_get_client(dclient);
 167
 168         if (ivi->shell_client.resource &&
 169             ivi->shell_client.status == BOUND_FAILED) {
 170                 wl_client_post_implementation_error(client,
 171                                        "agl_shell has already been bound. "
 172                                        "Check out bound_fail event");
 173                 return;
 174         }
 175
 176         surface = zalloc(sizeof *surface);
 177         if (!surface) {
 178                 wl_client_post_no_memory(client);
 179                 return;
 180         }
 181
 182         surface->view = weston_desktop_surface_create_view(dsurface);
 183         if (!surface->view) {
 184                 free(surface);
 185                 wl_client_post_no_memory(client);
 186                 return;
 187         }
 188
 189         surface->ivi = ivi;
 190         surface->dsurface = dsurface;
 191         surface->role = IVI_SURFACE_ROLE_NONE;
 192         surface->mapped = false;
 193         surface->advertised_on_launch = false;
 194         surface->checked_pending = false;
 195         wl_list_init(&surface->link);
 196
 197         wl_signal_init(&surface->signal_advertise_app);
 198
 199         surface->listener_advertise_app.notify = desktop_advertise_app;
 200         wl_signal_add(&surface->signal_advertise_app,
 201                       &surface->listener_advertise_app);
 202
 203         weston_desktop_surface_set_user_data(dsurface, surface);
 204
 205         if (ivi->policy && ivi->policy->api.surface_create &&
 206             !ivi->policy->api.surface_create(surface, ivi)) {
 207                 wl_client_post_no_memory(client);
 208                 return;
 209         }
 210
 211
 212         app_id = weston_desktop_surface_get_app_id(dsurface);
 213
 214         if ((active_output = ivi_layout_find_with_app_id(app_id, ivi))) {
 215                 ivi_set_pending_desktop_surface_remote(active_output, app_id);
 216                 shell_send_app_on_output(ivi, app_id, active_output->output->name);
 217         }
 218
 219         /* reset any caps to make sure we apply the new caps */
 220         ivi_seat_reset_caps_sent(ivi);
 221
 222         output =  get_focused_output(ivi->compositor);
 223         if (!output)
 224                 output = get_default_output(ivi->compositor);
 225
 226         if (output && ivi->shell_client.ready) {
 227                 struct ivi_output *ivi_output = to_ivi_output(output);
 228                 if (active_output)
 229                         desktop_surface_added_configure(surface, active_output);
 230                 else
 231                         desktop_surface_added_configure(surface, ivi_output);
 232         }
 233         /*
 234          * We delay creating "normal" desktop surfaces until later, to
 235          * give the shell-client an oppurtunity to set the surface as a
 236          * background/panel.
 237          * Also delay the creation in order to have a valid app_id
 238          * which will be used to set the proper role.
 239          */
 240         weston_log("Added surface %p, app_id %s to pending list\n",
 241                         surface, app_id);
 242         wl_list_insert(&ivi->pending_surfaces, &surface->link);
 243
 244 }
 245
 246 static bool
 247 desktop_surface_check_last_surfaces(struct ivi_output *ivi_output, enum ivi_surface_role role)
 248 {
 249         int count = 0;
 250         struct ivi_surface *surf;
 251
 252         wl_list_for_each(surf, &ivi_output->ivi->surfaces, link)
 253                 if (surf->role == role &&
 254                     surf->current_completed_output == ivi_output)
 255                         count++;
 256
 257         return (count == 1);
 258 }
 259
 260 static void
 261 desktop_surface_removed(struct weston_desktop_surface *dsurface, void *userdata)
 262 {
 263         struct ivi_surface *surface =
 264                 weston_desktop_surface_get_user_data(dsurface);
 265         struct weston_surface *wsurface =
 266                 weston_desktop_surface_get_surface(dsurface);
 267         const char *app_id = NULL;
 268         struct weston_seat *wseat = NULL;
 269         struct ivi_shell_seat *ivi_seat = NULL;
 270         struct ivi_output *output = NULL;
 271
 272         /* we might not have a valid ivi_surface if _added failed due to
 273          * protocol errors */
 274         if (!surface)
 275                 return;
 276
 277         wseat = get_ivi_shell_weston_first_seat(surface->ivi);
 278         if (wseat)
 279                 ivi_seat = get_ivi_shell_seat(wseat);
 280
 281         output = ivi_layout_get_output_from_surface(surface);
 282
 283         wl_list_remove(&surface->listener_advertise_app.link);
 284         surface->listener_advertise_app.notify = NULL;
 285
 286         app_id = weston_desktop_surface_get_app_id(dsurface);
 287
 288         /* special corner-case, pending_surfaces which are never activated or
 289          * being assigned an output might land here so just remove the surface;
 290          *
 291          * the DESKTOP role can happen here as well, because we can fall-back
 292          * to that when we try to determine the role type. Application that
 293          * do not set the app_id will be land here, when destroyed */
 294         if ((output == NULL && (surface->role == IVI_SURFACE_ROLE_NONE ||
 295                                 surface->role == IVI_SURFACE_ROLE_DESKTOP)) ||
 296              output->output == NULL)
 297                 goto skip_output_asignment;
 298
 299         assert(output != NULL);
 300
 301         /* resize the active surface to the original size */
 302         if (surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
 303             surface->role == IVI_SURFACE_ROLE_SPLIT_V) {
 304                 if (output && output->active) {
 305                         ivi_layout_desktop_resize(output->active, output->area_saved);
 306                 }
 307                 /* restore the area back so we can re-use it again if needed */
 308                 output->area = output->area_saved;
 309         }
 310
 311         /* reset the active surface as well */
 312         if (output && output->active && output->active == surface) {
 313                 output->active->view->is_mapped = false;
 314                 output->active->view->surface->is_mapped = false;
 315
 316                 weston_layer_entry_remove(&output->active->view->layer_link);
 317                 output->active = NULL;
 318         }
 319
 320         /* clear out focused_surface to avoid a stale focused_surface. the
 321          * client shell is responsible for keeping track and switch back to the
 322          * last active surface so we don't get do anything at removal, just
 323          * reset it */
 324         if (ivi_seat && ivi_seat->focused_surface == wsurface)
 325                 ivi_seat->focused_surface = NULL;
 326
 327         if (surface->role == IVI_SURFACE_ROLE_REMOTE &&
 328             output->type == OUTPUT_REMOTE)
 329                 ivi_destroy_waltham_destroy(surface);
 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 (desktop_surface_check_last_surfaces(output, IVI_SURFACE_ROLE_REMOTE) ||
 335             desktop_surface_check_last_surfaces(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         /* not supported */
 519 }
 520
 521 static const struct weston_desktop_api desktop_api = {
 522         .struct_size = sizeof desktop_api,
 523         .ping_timeout = desktop_ping_timeout,
 524         .pong = desktop_pong,
 525         .surface_added = desktop_surface_added,
 526         .surface_removed = desktop_surface_removed,
 527         .committed = desktop_committed,
 528         .show_window_menu = desktop_show_window_menu,
 529         .set_parent = desktop_set_parent,
 530         .move = desktop_move,
 531         .resize = desktop_resize,
 532         .fullscreen_requested = desktop_fullscreen_requested,
 533         .maximized_requested = desktop_maximized_requested,
 534         .minimized_requested = desktop_minimized_requested,
 535         .set_xwayland_position = desktop_set_xwayland_position,
 536 };
 537
 538 static void
 539 ivi_shell_destroy(struct wl_listener *listener, void *data)
 540 {
 541         struct ivi_compositor *ivi = container_of(listener,
 542                                 struct ivi_compositor, destroy_listener);
 543
 544         ivi_shell_finalize(ivi);
 545         ivi_compositor_destroy_pending_surfaces(ivi);
 546         ivi_layout_destroy_saved_outputs(ivi);
 547
 548         weston_desktop_destroy(ivi->desktop);
 549         wl_list_remove(&listener->link);
 550 }
 551
 552 int
 553 ivi_desktop_init(struct ivi_compositor *ivi)
 554 {
 555         ivi->desktop = weston_desktop_create(ivi->compositor, &desktop_api, ivi);
 556         if (!ivi->desktop) {
 557                 weston_log("Failed to create desktop globals");
 558                 return -1;
 559         }
 560
 561         if (!weston_compositor_add_destroy_listener_once(ivi->compositor,
 562                         &ivi->destroy_listener, ivi_shell_destroy)) {
 563                 return -1;
 564         }
 565
 566         return 0;
 567 }