src/layout.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 "ivi-compositor.h"
  27 #include "policy.h"
  28
  29 #include <assert.h>
  30 #include <string.h>
  31
  32 #include <libweston/libweston.h>
  33 #include <libweston-desktop/libweston-desktop.h>
  34
  35 #include "agl-shell-desktop-server-protocol.h"
  36
  37 #define AGL_COMP_DEBUG
  38
  39 static void
  40 ivi_background_init(struct ivi_compositor *ivi, struct ivi_output *output)
  41 {
  42         struct weston_output *woutput = output->output;
  43         struct ivi_surface *bg = output->background;
  44         struct weston_view *view;
  45
  46         if (!bg) {
  47                 weston_log("WARNING: Output does not have a background\n");
  48                 return;
  49         }
  50
  51         assert(bg->role == IVI_SURFACE_ROLE_BACKGROUND);
  52
  53         view = bg->view;
  54
  55         weston_view_set_output(view, woutput);
  56         weston_view_set_position(view, woutput->x, woutput->y);
  57
  58 #ifdef AGL_COMP_DEBUG
  59         weston_log("(background) position view %p, x %d, y %d\n", view,
  60                         woutput->x, woutput->y);
  61 #endif
  62
  63         view->is_mapped = true;
  64         view->surface->is_mapped = true;
  65
  66         weston_layer_entry_insert(&ivi->background.view_list, &view->layer_link);
  67 }
  68
  69 static void
  70 ivi_panel_init(struct ivi_compositor *ivi, struct ivi_output *output,
  71                struct ivi_surface *panel)
  72 {
  73         struct weston_output *woutput = output->output;
  74         struct weston_desktop_surface *dsurface;
  75         struct weston_view *view;
  76         struct weston_geometry geom;
  77         int x = woutput->x;
  78         int y = woutput->y;
  79
  80         if (!panel)
  81                 return;
  82
  83         assert(panel->role == IVI_SURFACE_ROLE_PANEL);
  84         dsurface = panel->dsurface;
  85         view = panel->view;
  86         geom = weston_desktop_surface_get_geometry(dsurface);
  87 #ifdef AGL_COMP_DEBUG
  88         weston_log("geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
  89                         geom.width, geom.height, geom.x, geom.y);
  90 #endif
  91         switch (panel->panel.edge) {
  92         case AGL_SHELL_EDGE_TOP:
  93                 output->area.y += geom.height;
  94                 output->area.height -= geom.height;
  95                 break;
  96         case AGL_SHELL_EDGE_BOTTOM:
  97                 y += woutput->height - geom.height;
  98                 output->area.height -= geom.height;
  99                 break;
 100         case AGL_SHELL_EDGE_LEFT:
 101                 output->area.x += geom.width;
 102                 output->area.width -= geom.width;
 103                 break;
 104         case AGL_SHELL_EDGE_RIGHT:
 105                 x += woutput->width - geom.width;
 106                 output->area.width -= geom.width;
 107                 break;
 108         }
 109
 110         x -= geom.x;
 111         y -= geom.y;
 112
 113         weston_view_set_output(view, woutput);
 114         weston_view_set_position(view, x, y);
 115 #ifdef AGL_COMP_DEBUG
 116         weston_log("(panel) edge %d position view %p, x %d, y %d\n",
 117                         panel->panel.edge, view, x, y);
 118 #endif
 119
 120         /* this is necessary for cases we already mapped it desktop_committed()
 121          * but we not running the older qtwayland, so we still have a chance
 122          * for this to run at the next test */
 123         if (view->surface->is_mapped) {
 124                 weston_layer_entry_remove(&view->layer_link);
 125
 126                 view->is_mapped = false;
 127                 view->surface->is_mapped = false;
 128         }
 129
 130         /* give ivi_layout_panel_committed() a chance to map the view/surface
 131          * instead */
 132         if ((geom.width == geom.height && geom.width == 0) &&
 133             (geom.x == geom.y && geom.x == 0) &&
 134             panel->panel.edge != AGL_SHELL_EDGE_TOP)
 135                 return;
 136
 137         view->is_mapped = true;
 138         view->surface->is_mapped = true;
 139 #ifdef AGL_COMP_DEBUG
 140         weston_log("panel type %d inited\n", panel->panel.edge);
 141 #endif
 142         weston_layer_entry_insert(&ivi->panel.view_list, &view->layer_link);
 143 }
 144
 145 /*
 146  * Initializes all static parts of the layout, i.e. the background and panels.
 147  */
 148 void
 149 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output)
 150 {
 151         ivi_background_init(ivi, output);
 152
 153         output->area.x = 0;
 154         output->area.y = 0;
 155         output->area.width = output->output->width;
 156         output->area.height = output->output->height;
 157
 158         ivi_panel_init(ivi, output, output->top);
 159         ivi_panel_init(ivi, output, output->bottom);
 160         ivi_panel_init(ivi, output, output->left);
 161         ivi_panel_init(ivi, output, output->right);
 162
 163         weston_compositor_schedule_repaint(ivi->compositor);
 164
 165         weston_log("Usable area: %dx%d+%d,%d\n",
 166                    output->area.width, output->area.height,
 167                    output->area.x, output->area.y);
 168 }
 169
 170 struct ivi_surface *
 171 ivi_find_app(struct ivi_compositor *ivi, const char *app_id)
 172 {
 173         struct ivi_surface *surf;
 174         const char *id;
 175
 176         wl_list_for_each(surf, &ivi->surfaces, link) {
 177                 id = weston_desktop_surface_get_app_id(surf->dsurface);
 178                 if (id && strcmp(app_id, id) == 0)
 179                         return surf;
 180         }
 181
 182         return NULL;
 183 }
 184
 185 static void
 186 ivi_layout_activate_complete(struct ivi_output *output,
 187                              struct ivi_surface *surf)
 188 {
 189         struct ivi_compositor *ivi = output->ivi;
 190         struct weston_output *woutput = output->output;
 191         struct weston_view *view = surf->view;
 192
 193         if (weston_view_is_mapped(view)) {
 194                 weston_layer_entry_remove(&view->layer_link);
 195         }
 196
 197         weston_view_set_output(view, woutput);
 198         weston_view_set_position(view,
 199                                  woutput->x + output->area.x,
 200                                  woutput->y + output->area.y);
 201
 202         view->is_mapped = true;
 203         view->surface->is_mapped = true;
 204
 205         if (output->active) {
 206                 output->active->view->is_mapped = false;
 207                 output->active->view->surface->is_mapped = false;
 208
 209                 weston_layer_entry_remove(&output->active->view->layer_link);
 210         }
 211         output->previous_active = output->active;
 212         output->active = surf;
 213
 214         weston_layer_entry_insert(&ivi->normal.view_list, &view->layer_link);
 215         weston_view_update_transform(view);
 216
 217         /* force repaint of the entire output */
 218         weston_output_damage(output->output);
 219         surf->desktop.last_output = surf->desktop.pending_output;
 220         surf->desktop.pending_output = NULL;
 221 }
 222
 223 static struct ivi_output *
 224 ivi_layout_find_bg_output(struct ivi_compositor *ivi)
 225 {
 226         struct ivi_output *out;
 227
 228         wl_list_for_each(out, &ivi->outputs, link) {
 229                 if (out->background &&
 230                     out->background->role == IVI_SURFACE_ROLE_BACKGROUND)
 231                         return out;
 232         }
 233
 234         return NULL;
 235 }
 236
 237 void
 238 ivi_layout_desktop_committed(struct ivi_surface *surf)
 239 {
 240         struct weston_desktop_surface *dsurf = surf->dsurface;
 241         struct weston_geometry geom = weston_desktop_surface_get_geometry(dsurf);
 242         struct ivi_output *output;
 243
 244         assert(surf->role == IVI_SURFACE_ROLE_DESKTOP);
 245
 246         output = surf->desktop.pending_output;
 247         if (!output) {
 248                 struct ivi_output *ivi_bg_output;
 249                 struct ivi_policy *policy = surf->ivi->policy;
 250
 251                 if (policy && policy->api.surface_activate_by_default)
 252                         if (policy->api.surface_activate_by_default(surf, surf->ivi))
 253                                 goto skip_config_check;
 254
 255                 if (!surf->ivi->quirks.activate_apps_by_default)
 256                         return;
 257
 258 skip_config_check:
 259                 /* we can only activate it again by using the protocol */
 260                 if (surf->activated_by_default)
 261                         return;
 262
 263                 ivi_bg_output = ivi_layout_find_bg_output(surf->ivi);
 264
 265                 /* use the output of the bg to activate the app on start-up by
 266                  * default */
 267                 if (surf->view && ivi_bg_output) {
 268                         const char *app_id =
 269                                 weston_desktop_surface_get_app_id(dsurf);
 270                         if (app_id && ivi_bg_output) {
 271                                 ivi_layout_activate(ivi_bg_output, app_id);
 272                                 surf->activated_by_default = true;
 273                         }
 274                 }
 275
 276                 return;
 277         }
 278
 279         if (!weston_desktop_surface_get_maximized(dsurf) ||
 280             geom.width != output->area.width ||
 281             geom.height != output->area.height)
 282                 return;
 283
 284         ivi_layout_activate_complete(output, surf);
 285 }
 286
 287 void
 288 ivi_layout_popup_committed(struct ivi_surface *surface)
 289 {
 290         struct ivi_compositor *ivi = surface->ivi;
 291
 292         struct weston_desktop_surface *dsurface = surface->dsurface;
 293         struct weston_surface *wsurface =
 294                 weston_desktop_surface_get_surface(dsurface);
 295
 296         struct ivi_output *output = surface->popup.output;
 297         struct weston_output *woutput = output->output;
 298
 299         struct weston_view *view = surface->view;
 300         struct weston_geometry geom;
 301
 302         if (surface->view->is_mapped)
 303                 return;
 304
 305         geom = weston_desktop_surface_get_geometry(dsurface);
 306         weston_log("geom x %d, y %d, width %d, height %d\n", geom.x, geom.y,
 307                         geom.width, geom.height);
 308
 309         assert(surface->role == IVI_SURFACE_ROLE_POPUP);
 310
 311         weston_view_set_output(view, woutput);
 312         if (surface->popup.x || surface->popup.y)
 313                 weston_view_set_position(view, surface->popup.x, surface->popup.y);
 314         else
 315                 weston_view_set_position(view, geom.x, geom.y);
 316         weston_layer_entry_insert(&ivi->popup.view_list, &view->layer_link);
 317
 318         weston_view_update_transform(view);
 319         weston_view_damage_below(view);
 320
 321         wsurface->is_mapped = true;
 322         surface->view->is_mapped = true;
 323 }
 324
 325 static void
 326 ivi_layout_popup_re_add(struct ivi_surface *surface)
 327 {
 328         assert(surface->role == IVI_SURFACE_ROLE_POPUP);
 329         struct weston_view *view = surface->view;
 330         struct ivi_compositor *ivi = surface->ivi;
 331
 332         if (weston_view_is_mapped(view)) {
 333                 struct weston_desktop_surface *dsurface = surface->dsurface;
 334                 struct weston_surface *wsurface =
 335                         weston_desktop_surface_get_surface(dsurface);
 336
 337                 weston_layer_entry_remove(&view->layer_link);
 338
 339                 wsurface->is_mapped = false;
 340                 view->is_mapped = false;
 341         }
 342
 343         ivi_layout_popup_committed(surface);
 344 }
 345
 346 void
 347 ivi_layout_panel_committed(struct ivi_surface *surface)
 348 {
 349         struct ivi_compositor *ivi = surface->ivi;
 350         struct ivi_output *output = surface->bg.output;
 351         struct weston_output *woutput = output->output;
 352         struct weston_desktop_surface *dsurface = surface->dsurface;
 353         struct weston_surface *wsurface =
 354                 weston_desktop_surface_get_surface(dsurface);
 355         struct weston_geometry geom;
 356         int x = woutput->x;
 357         int y = woutput->y;
 358
 359         assert(surface->role == IVI_SURFACE_ROLE_PANEL);
 360
 361         /*
 362          * If the desktop_surface geometry is not set and the panel is not a
 363          * top one, we'll give this a chance to run, as some qtwayland version
 364          * seem to have a 'problem', where the panel initilization part will
 365          * have a desktop surface with 0 as geometry for *all* its members
 366          * (width/height). Doing that will result in the panel not being
 367          * displayed at all.
 368          *
 369          * Later versions of qtwayland do have the correct window geometry for
 370          * the desktop surface so the weston_surface is already mapped in
 371          * ivi_panel_init().
 372          */
 373         if (wsurface->is_mapped)
 374                 return;
 375
 376         geom = weston_desktop_surface_get_geometry(dsurface);
 377
 378 #ifdef AGL_COMP_DEBUG
 379         weston_log("geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
 380                         geom.width, geom.height, geom.x, geom.y);
 381 #endif
 382
 383         switch (surface->panel.edge) {
 384         case AGL_SHELL_EDGE_TOP:
 385                 /* Do nothing */
 386                 break;
 387         case AGL_SHELL_EDGE_BOTTOM:
 388                 y += woutput->height - geom.height;
 389                 break;
 390         case AGL_SHELL_EDGE_LEFT:
 391                 /* Do nothing */
 392                 break;
 393         case AGL_SHELL_EDGE_RIGHT:
 394                 x += woutput->width - geom.width;
 395                 break;
 396         }
 397 #ifndef AGL_COMP_DEBUG
 398         weston_log("panel type %d commited\n", surface->panel.edge);
 399 #endif
 400
 401         weston_view_set_output(surface->view, woutput);
 402         weston_view_set_position(surface->view, x, y);
 403         weston_layer_entry_insert(&ivi->panel.view_list,
 404                                   &surface->view->layer_link);
 405
 406         weston_view_update_transform(surface->view);
 407         weston_view_schedule_repaint(surface->view);
 408
 409         wsurface->is_mapped = true;
 410         surface->view->is_mapped = true;
 411 }
 412
 413 void
 414 ivi_layout_activate(struct ivi_output *output, const char *app_id)
 415 {
 416         struct ivi_compositor *ivi = output->ivi;
 417         struct ivi_surface *surf;
 418         struct weston_desktop_surface *dsurf;
 419         struct weston_view *view;
 420         struct weston_geometry geom;
 421         struct ivi_policy *policy = output->ivi->policy;
 422
 423         surf = ivi_find_app(ivi, app_id);
 424         if (!surf)
 425                 return;
 426
 427         if (policy && policy->api.surface_activate &&
 428             !policy->api.surface_activate(surf, surf->ivi)) {
 429                 return;
 430         }
 431
 432 #ifdef AGL_COMP_DEBUG
 433         weston_log("Found app_id %s\n", app_id);
 434 #endif
 435
 436         if (surf->role == IVI_SURFACE_ROLE_POPUP) {
 437                 ivi_layout_popup_re_add(surf);
 438                 return;
 439         }
 440
 441         if (surf == output->active)
 442                 return;
 443
 444         dsurf = surf->dsurface;
 445         view = surf->view;
 446         geom = weston_desktop_surface_get_geometry(dsurf);
 447
 448         surf->desktop.pending_output = output;
 449         if (weston_desktop_surface_get_maximized(dsurf) &&
 450             geom.width == output->area.width &&
 451             geom.height == output->area.height) {
 452                 ivi_layout_activate_complete(output, surf);
 453                 return;
 454         }
 455
 456         weston_desktop_surface_set_maximized(dsurf, true);
 457         weston_desktop_surface_set_size(dsurf,
 458                                         output->area.width,
 459                                         output->area.height);
 460
 461         /*
 462          * If the view isn't mapped, we put it onto the hidden layer so it will
 463          * start receiving frame events, and will be able to act on our
 464          * configure event.
 465          */
 466         if (!weston_view_is_mapped(view)) {
 467                 view->is_mapped = true;
 468                 view->surface->is_mapped = true;
 469
 470                 weston_view_set_output(view, output->output);
 471                 weston_layer_entry_insert(&ivi->hidden.view_list, &view->layer_link);
 472                 /* force repaint of the entire output */
 473                 weston_output_damage(output->output);
 474         }
 475 }
 476
 477 static struct ivi_output *
 478 ivi_layout_get_output_from_surface(struct ivi_surface *surf)
 479 {
 480         struct ivi_output *ivi_output = NULL;
 481
 482         switch (surf->role) {
 483         case IVI_SURFACE_ROLE_DESKTOP:
 484                 if (surf->desktop.pending_output)
 485                         ivi_output = surf->desktop.pending_output;
 486                 else
 487                         ivi_output = surf->desktop.last_output;
 488                 break;
 489         case IVI_SURFACE_ROLE_POPUP:
 490                 ivi_output = surf->popup.output;
 491                 break;
 492         default:
 493         case IVI_SURFACE_ROLE_BACKGROUND:
 494         case IVI_SURFACE_ROLE_PANEL:
 495         case IVI_SURFACE_ROLE_NONE:
 496                 break;
 497         }
 498
 499         return ivi_output;
 500 }
 501
 502 void
 503 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id)
 504 {
 505         struct ivi_surface *surf;
 506         struct ivi_output *ivi_output;
 507         struct ivi_policy *policy = ivi->policy;
 508
 509         surf = ivi_find_app(ivi, app_id);
 510         if (!surf)
 511                 return;
 512
 513         if (policy && policy->api.surface_deactivate &&
 514             !policy->api.surface_deactivate(surf, surf->ivi)) {
 515                 return;
 516         }
 517
 518         ivi_output = ivi_layout_get_output_from_surface(surf);
 519         weston_log("deactiving %s\n", app_id);
 520
 521         if (surf->role == IVI_SURFACE_ROLE_DESKTOP) {
 522                 struct ivi_surface *previous_active;
 523
 524                 previous_active = ivi_output->previous_active;
 525                 if (!previous_active) {
 526                         /* we don't have a previous active it means we should
 527                          * display the bg */
 528                         if (ivi_output->active) {
 529                                 struct weston_view *view;
 530
 531                                 view = ivi_output->active->view;
 532                                 view->is_mapped = false;
 533                                 view->surface->is_mapped = false;
 534
 535                                 weston_layer_entry_remove(&view->layer_link);
 536                                 weston_output_damage(ivi_output->output);
 537                         }
 538                 } else {
 539                         struct weston_desktop_surface *dsurface;
 540                         const char *previous_active_app_id;
 541
 542                         dsurface = previous_active->dsurface;
 543                         previous_active_app_id =
 544                                 weston_desktop_surface_get_app_id(dsurface);
 545                         ivi_layout_activate(ivi_output, previous_active_app_id);
 546                 }
 547         } else if (surf->role == IVI_SURFACE_ROLE_POPUP) {
 548                 struct weston_view *view  = surf->view;
 549
 550                 weston_layer_entry_remove(&view->layer_link);
 551                 weston_view_damage_below(view);
 552         }
 553 }