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_NONE)
 133                 return;
 134
 135         if (role == IVI_SURFACE_ROLE_FULLSCREEN) {
 136                 struct ivi_output *bg_output =
 137                         ivi_layout_find_bg_output(surface->ivi);
 138                 assert(bg_output);
 139                 weston_desktop_surface_set_fullscreen(dsurface, true);
 140                 weston_desktop_surface_set_size(dsurface,
 141                                                 bg_output->output->width,
 142                                                 bg_output->output->height);
 143                 return;
 144         }
 145
 146         weston_desktop_surface_set_maximized(dsurface, true);
 147         weston_desktop_surface_set_size(dsurface,
 148                                         ivi_output->area.width,
 149                                         ivi_output->area.height);
 150 }
 151
 152
 153 static void
 154 desktop_surface_added(struct weston_desktop_surface *dsurface, void *userdata)
 155 {
 156         struct ivi_compositor *ivi = userdata;
 157         struct weston_desktop_client *dclient;
 158         struct wl_client *client;
 159         struct ivi_surface *surface;
 160         struct ivi_output *active_output = NULL;
 161         struct weston_output *output = NULL;
 162         const char *app_id = NULL;
 163
 164         dclient = weston_desktop_surface_get_client(dsurface);
 165         client = weston_desktop_client_get_client(dclient);
 166
 167         if (ivi->shell_client.resource &&
 168             ivi->shell_client.status == BOUND_FAILED) {
 169                 wl_client_post_implementation_error(client,
 170                                        "agl_shell has already been bound. "
 171                                        "Check out bound_fail event");
 172                 return;
 173         }
 174
 175         surface = zalloc(sizeof *surface);
 176         if (!surface) {
 177                 wl_client_post_no_memory(client);
 178                 return;
 179         }
 180
 181         surface->view = weston_desktop_surface_create_view(dsurface);
 182         if (!surface->view) {
 183                 free(surface);
 184                 wl_client_post_no_memory(client);
 185                 return;
 186         }
 187
 188         surface->ivi = ivi;
 189         surface->dsurface = dsurface;
 190         surface->role = IVI_SURFACE_ROLE_NONE;
 191         surface->mapped = false;
 192         surface->advertised_on_launch = false;
 193         surface->checked_pending = false;
 194         wl_list_init(&surface->link);
 195
 196         wl_signal_init(&surface->signal_advertise_app);
 197
 198         surface->listener_advertise_app.notify = desktop_advertise_app;
 199         wl_signal_add(&surface->signal_advertise_app,
 200                       &surface->listener_advertise_app);
 201
 202         weston_desktop_surface_set_user_data(dsurface, surface);
 203
 204         if (ivi->policy && ivi->policy->api.surface_create &&
 205             !ivi->policy->api.surface_create(surface, ivi)) {
 206                 wl_client_post_no_memory(client);
 207                 return;
 208         }
 209
 210
 211         app_id = weston_desktop_surface_get_app_id(dsurface);
 212
 213         if ((active_output = ivi_layout_find_with_app_id(app_id, ivi)))
 214                 ivi_set_pending_desktop_surface_remote(active_output, app_id);
 215
 216         /* reset any caps to make sure we apply the new caps */
 217         ivi_seat_reset_caps_sent(ivi);
 218
 219         output =  get_focused_output(ivi->compositor);
 220         if (!output)
 221                 output = get_default_output(ivi->compositor);
 222
 223         if (output && ivi->shell_client.ready) {
 224                 struct ivi_output *ivi_output = to_ivi_output(output);
 225                 desktop_surface_added_configure(surface, ivi_output);
 226         }
 227         /*
 228          * We delay creating "normal" desktop surfaces until later, to
 229          * give the shell-client an oppurtunity to set the surface as a
 230          * background/panel.
 231          * Also delay the creation in order to have a valid app_id
 232          * which will be used to set the proper role.
 233          */
 234         weston_log("Added surface %p, app_id %s to pending list\n",
 235                         surface, app_id);
 236         wl_list_insert(&ivi->pending_surfaces, &surface->link);
 237
 238 }
 239
 240 static bool
 241 desktop_surface_check_last_remote_surfaces(struct ivi_compositor *ivi, enum ivi_surface_role role)
 242 {
 243         int count = 0;
 244         struct ivi_surface *surf;
 245
 246         wl_list_for_each(surf, &ivi->surfaces, link)
 247                 if (surf->role == role)
 248                         count++;
 249
 250         return (count == 1);
 251 }
 252
 253 static void
 254 desktop_surface_removed(struct weston_desktop_surface *dsurface, void *userdata)
 255 {
 256         struct ivi_surface *surface =
 257                 weston_desktop_surface_get_user_data(dsurface);
 258         struct weston_surface *wsurface =
 259                 weston_desktop_surface_get_surface(dsurface);
 260         const char *app_id = NULL;
 261         struct weston_seat *wseat = NULL;
 262         struct ivi_shell_seat *ivi_seat = NULL;
 263         struct ivi_output *output = NULL;
 264
 265         /* we might not have a valid ivi_surface if _added failed due to
 266          * protocol errors */
 267         if (!surface)
 268                 return;
 269
 270         wseat = get_ivi_shell_weston_first_seat(surface->ivi);
 271         if (wseat)
 272                 ivi_seat = get_ivi_shell_seat(wseat);
 273
 274         output = ivi_layout_get_output_from_surface(surface);
 275
 276         wl_list_remove(&surface->listener_advertise_app.link);
 277         surface->listener_advertise_app.notify = NULL;
 278
 279         app_id = weston_desktop_surface_get_app_id(dsurface);
 280
 281         /* special corner-case, pending_surfaces which are never activated or
 282          * being assigned an output might land here so just remove the surface;
 283          *
 284          * the DESKTOP role can happen here as well, because we can fall-back
 285          * to that when we try to determine the role type. Application that
 286          * do not set the app_id will be land here, when destroyed */
 287         if (output == NULL && (surface->role == IVI_SURFACE_ROLE_NONE ||
 288                                surface->role == IVI_SURFACE_ROLE_DESKTOP))
 289                 goto skip_output_asignment;
 290
 291         assert(output != NULL);
 292
 293         /* resize the active surface to the original size */
 294         if (surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
 295             surface->role == IVI_SURFACE_ROLE_SPLIT_V) {
 296                 if (output && output->active) {
 297                         ivi_layout_desktop_resize(output->active, output->area_saved);
 298                 }
 299                 /* restore the area back so we can re-use it again if needed */
 300                 output->area = output->area_saved;
 301         }
 302
 303         /* reset the active surface as well */
 304         if (output && output->active && output->active == surface) {
 305                 output->active->view->is_mapped = false;
 306                 output->active->view->surface->is_mapped = false;
 307
 308                 weston_layer_entry_remove(&output->active->view->layer_link);
 309                 output->active = NULL;
 310         }
 311
 312         /* clear out focused_surface to avoid a stale focused_surface. the
 313          * client shell is responsible for keeping track and switch back to the
 314          * last active surface so we don't get do anything at removal, just
 315          * reset it */
 316         if (ivi_seat && ivi_seat->focused_surface == wsurface)
 317                 ivi_seat->focused_surface = NULL;
 318
 319         if (surface->role == IVI_SURFACE_ROLE_REMOTE &&
 320             output->type == OUTPUT_REMOTE)
 321                 ivi_destroy_waltham_destroy(surface);
 322
 323         /* check if there's a last 'remote' surface and insert a black
 324          * surface view if there's no background set for that output
 325          */
 326         if ((desktop_surface_check_last_remote_surfaces(output->ivi,
 327                 IVI_SURFACE_ROLE_REMOTE) ||
 328             desktop_surface_check_last_remote_surfaces(output->ivi,
 329                 IVI_SURFACE_ROLE_DESKTOP)) && output->type == OUTPUT_REMOTE)
 330                 if (!output->background)
 331                         insert_black_surface(output);
 332
 333
 334         if (weston_surface_is_mapped(wsurface)) {
 335                 weston_desktop_surface_unlink_view(surface->view);
 336                 weston_view_destroy(surface->view);
 337         }
 338
 339         /* invalidate agl-shell surfaces so we can re-use them when
 340          * binding again */
 341         if (surface->role == IVI_SURFACE_ROLE_PANEL) {
 342                 switch (surface->panel.edge) {
 343                 case AGL_SHELL_EDGE_TOP:
 344                         output->top = NULL;
 345                         break;
 346                 case AGL_SHELL_EDGE_BOTTOM:
 347                         output->bottom = NULL;
 348                         break;
 349                 case AGL_SHELL_EDGE_LEFT:
 350                         output->left = NULL;
 351                         break;
 352                 case AGL_SHELL_EDGE_RIGHT:
 353                         output->right = NULL;
 354                         break;
 355                 default:
 356                         assert(!"Invalid edge detected\n");
 357                 }
 358         } else if (surface->role == IVI_SURFACE_ROLE_BACKGROUND) {
 359                 output->background = NULL;
 360         }
 361
 362 skip_output_asignment:
 363         weston_log("Removed surface %p, app_id %s, role %s\n", surface,
 364                         app_id, ivi_layout_get_surface_role_name(surface));
 365
 366         if (app_id && output)
 367                 shell_advertise_app_state(output->ivi, app_id,
 368                                           NULL, AGL_SHELL_DESKTOP_APP_STATE_DESTROYED);
 369
 370         wl_list_remove(&surface->link);
 371
 372         free(surface);
 373 }
 374
 375 static void
 376 desktop_committed(struct weston_desktop_surface *dsurface,
 377                   int32_t sx, int32_t sy, void *userdata)
 378 {
 379         struct ivi_compositor *ivi = userdata;
 380         struct ivi_surface *surface =
 381                 weston_desktop_surface_get_user_data(dsurface);
 382         struct ivi_policy *policy = surface->ivi->policy;
 383
 384         if (policy && policy->api.surface_commited &&
 385             !policy->api.surface_commited(surface, surface->ivi))
 386                 return;
 387
 388         if (ivi->shell_client.ready && !surface->checked_pending) {
 389                 const char * app_id =   weston_desktop_surface_get_app_id(dsurface);
 390                 weston_log("Checking pending surface %p, app_id %s\n", surface,
 391                         app_id);
 392                 wl_list_remove(&surface->link);
 393                 wl_list_init(&surface->link);
 394                 ivi_check_pending_desktop_surface(surface);
 395                 surface->checked_pending = true;
 396         }
 397
 398         if (!surface->advertised_on_launch &&
 399             !wl_list_empty(&surface->ivi->desktop_clients))
 400                 wl_signal_emit(&surface->signal_advertise_app, surface);
 401
 402         /* this repaint schedule is needed to allow resizing to work with the
 403          * help of the hidden layer:
 404          *
 405          * 1. add the view in the hidden layer and send out correct dimensions
 406          * 2. clients changes its dimensions
 407          * 3. client commits with the new dimensions
 408          *
 409          * For desktop and fullscreen, desktop_surface_added() sends the
 410          * dimensions from the beginning so applications no need to resize, but
 411          * if that weren't the case we still need this in.
 412          */
 413         weston_compositor_schedule_repaint(surface->ivi->compositor);
 414
 415         switch (surface->role) {
 416         case IVI_SURFACE_ROLE_DESKTOP:
 417         case IVI_SURFACE_ROLE_REMOTE:
 418                 ivi_layout_desktop_committed(surface);
 419                 break;
 420         case IVI_SURFACE_ROLE_POPUP:
 421                 ivi_layout_popup_committed(surface);
 422                 break;
 423         case IVI_SURFACE_ROLE_FULLSCREEN:
 424                 ivi_layout_fullscreen_committed(surface);
 425                 break;
 426         case IVI_SURFACE_ROLE_SPLIT_H:
 427         case IVI_SURFACE_ROLE_SPLIT_V:
 428                 ivi_layout_split_committed(surface);
 429                 break;
 430         case IVI_SURFACE_ROLE_NONE:
 431         case IVI_SURFACE_ROLE_BACKGROUND:
 432         case IVI_SURFACE_ROLE_PANEL:
 433         default: /* fall through */
 434                 break;
 435         }
 436 }
 437
 438 static void
 439 desktop_show_window_menu(struct weston_desktop_surface *dsurface,
 440                          struct weston_seat *seat, int32_t x, int32_t y,
 441                          void *userdata)
 442 {
 443         /* not supported */
 444 }
 445
 446 static void
 447 desktop_set_parent(struct weston_desktop_surface *dsurface,
 448                    struct weston_desktop_surface *parent, void *userdata)
 449 {
 450         /* not supported */
 451 }
 452
 453 static void
 454 desktop_move(struct weston_desktop_surface *dsurface,
 455              struct weston_seat *seat, uint32_t serial, void *userdata)
 456 {
 457         /* not supported */
 458 }
 459
 460 static void
 461 desktop_resize(struct weston_desktop_surface *dsurface,
 462                struct weston_seat *seat, uint32_t serial,
 463                enum weston_desktop_surface_edge edges, void *user_data)
 464 {
 465         /* not supported */
 466 }
 467
 468 static void
 469 desktop_fullscreen_requested(struct weston_desktop_surface *dsurface,
 470                              bool fullscreen, struct weston_output *output,
 471                              void *userdata)
 472 {
 473         /* not supported */
 474 }
 475
 476 static void
 477 desktop_maximized_requested(struct weston_desktop_surface *dsurface,
 478                             bool maximized, void *userdata)
 479 {
 480         /* not supported */
 481 }
 482
 483 static void
 484 desktop_minimized_requested(struct weston_desktop_surface *dsurface,
 485                             void *userdata)
 486 {
 487         /* not supported */
 488 }
 489
 490 static void
 491 desktop_set_xwayland_position(struct weston_desktop_surface *dsurface,
 492                               int32_t x, int32_t y, void *userdata)
 493 {
 494         /* not supported */
 495 }
 496
 497 static const struct weston_desktop_api desktop_api = {
 498         .struct_size = sizeof desktop_api,
 499         .ping_timeout = desktop_ping_timeout,
 500         .pong = desktop_pong,
 501         .surface_added = desktop_surface_added,
 502         .surface_removed = desktop_surface_removed,
 503         .committed = desktop_committed,
 504         .show_window_menu = desktop_show_window_menu,
 505         .set_parent = desktop_set_parent,
 506         .move = desktop_move,
 507         .resize = desktop_resize,
 508         .fullscreen_requested = desktop_fullscreen_requested,
 509         .maximized_requested = desktop_maximized_requested,
 510         .minimized_requested = desktop_minimized_requested,
 511         .set_xwayland_position = desktop_set_xwayland_position,
 512 };
 513
 514 static void
 515 ivi_shell_destroy(struct wl_listener *listener, void *data)
 516 {
 517         struct ivi_compositor *ivi = container_of(listener,
 518                                 struct ivi_compositor, destroy_listener);
 519
 520         ivi_shell_finalize(ivi);
 521         ivi_compositor_destroy_pending_surfaces(ivi);
 522
 523         weston_desktop_destroy(ivi->desktop);
 524         wl_list_remove(&listener->link);
 525 }
 526
 527 int
 528 ivi_desktop_init(struct ivi_compositor *ivi)
 529 {
 530         ivi->desktop = weston_desktop_create(ivi->compositor, &desktop_api, ivi);
 531         if (!ivi->desktop) {
 532                 weston_log("Failed to create desktop globals");
 533                 return -1;
 534         }
 535
 536         if (!weston_compositor_add_destroy_listener_once(ivi->compositor,
 537                         &ivi->destroy_listener, ivi_shell_destroy)) {
 538                 return -1;
 539         }
 540
 541         return 0;
 542 }