2 * Copyright © 2019 Collabora, Ltd.
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:
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.
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
26 #include "ivi-compositor.h"
28 #include "shared/helpers.h"
33 #include <libweston/libweston.h>
34 #include <libweston-desktop/libweston-desktop.h>
36 #include "agl-shell-desktop-server-protocol.h"
38 #define AGL_COMP_DEBUG
40 static const char *ivi_roles_as_string[] = {
41 [IVI_SURFACE_ROLE_NONE] = "NONE",
42 [IVI_SURFACE_ROLE_BACKGROUND] = "BACKGROUND",
43 [IVI_SURFACE_ROLE_PANEL] = "PANEL",
44 [IVI_SURFACE_ROLE_DESKTOP] = "DESKTOP",
45 [IVI_SURFACE_ROLE_POPUP] = "POPUP",
46 [IVI_SURFACE_ROLE_SPLIT_H] = "SPLIT_H",
47 [IVI_SURFACE_ROLE_SPLIT_V] = "SPLIT_V",
48 [IVI_SURFACE_ROLE_FULLSCREEN] = "FULLSCREEN",
49 [IVI_SURFACE_ROLE_REMOTE] = "REMOTE",
53 ivi_layout_get_surface_role_name(struct ivi_surface *surf)
55 if (surf->role < 0 || surf->role >= ARRAY_LENGTH(ivi_roles_as_string))
56 return " unknown surface role";
58 return ivi_roles_as_string[surf->role];
62 ivi_background_init(struct ivi_compositor *ivi, struct ivi_output *output)
64 struct weston_output *woutput = output->output;
65 struct ivi_surface *bg = output->background;
66 struct weston_view *view;
69 weston_log("WARNING: Output does not have a background\n");
73 assert(bg->role == IVI_SURFACE_ROLE_BACKGROUND);
77 weston_view_set_output(view, woutput);
78 weston_view_set_position(view, woutput->x, woutput->y);
80 weston_log("(background) position view %p, x %d, y %d, on output %s\n", view,
81 woutput->x, woutput->y, output->name);
83 view->is_mapped = true;
84 view->surface->is_mapped = true;
86 weston_layer_entry_insert(&ivi->background.view_list, &view->layer_link);
90 ivi_panel_init(struct ivi_compositor *ivi, struct ivi_output *output,
91 struct ivi_surface *panel)
93 struct weston_output *woutput = output->output;
94 struct weston_desktop_surface *dsurface;
95 struct weston_view *view;
96 struct weston_geometry geom;
103 assert(panel->role == IVI_SURFACE_ROLE_PANEL);
104 dsurface = panel->dsurface;
106 geom = weston_desktop_surface_get_geometry(dsurface);
108 weston_log("(panel) geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
109 geom.width, geom.height, geom.x, geom.y);
111 switch (panel->panel.edge) {
112 case AGL_SHELL_EDGE_TOP:
113 output->area.y += geom.height;
114 output->area.height -= geom.height;
116 case AGL_SHELL_EDGE_BOTTOM:
117 y += woutput->height - geom.height;
118 output->area.height -= geom.height;
120 case AGL_SHELL_EDGE_LEFT:
121 output->area.x += geom.width;
122 output->area.width -= geom.width;
124 case AGL_SHELL_EDGE_RIGHT:
125 x += woutput->width - geom.width;
126 output->area.width -= geom.width;
133 weston_view_set_output(view, woutput);
134 weston_view_set_position(view, x, y);
136 weston_log("(panel) edge %d position view %p, x %d, y %d\n",
137 panel->panel.edge, view, x, y);
139 view->is_mapped = true;
140 view->surface->is_mapped = true;
142 weston_log("panel type %d inited on output %s\n", panel->panel.edge,
145 weston_layer_entry_insert(&ivi->panel.view_list, &view->layer_link);
149 * Initializes all static parts of the layout, i.e. the background and panels.
152 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output)
154 ivi_background_init(ivi, output);
158 output->area.width = output->output->width;
159 output->area.height = output->output->height;
161 ivi_panel_init(ivi, output, output->top);
162 ivi_panel_init(ivi, output, output->bottom);
163 ivi_panel_init(ivi, output, output->left);
164 ivi_panel_init(ivi, output, output->right);
166 weston_compositor_schedule_repaint(ivi->compositor);
168 weston_log("Usable area: %dx%d+%d,%d\n",
169 output->area.width, output->area.height,
170 output->area.x, output->area.y);
174 ivi_find_app(struct ivi_compositor *ivi, const char *app_id)
176 struct ivi_surface *surf;
179 wl_list_for_each(surf, &ivi->surfaces, link) {
180 id = weston_desktop_surface_get_app_id(surf->dsurface);
181 if (id && strcmp(app_id, id) == 0)
189 ivi_layout_activate_complete(struct ivi_output *output,
190 struct ivi_surface *surf)
192 struct ivi_compositor *ivi = output->ivi;
193 struct weston_output *woutput = output->output;
194 struct weston_view *view = surf->view;
196 if (weston_view_is_mapped(view)) {
197 weston_layer_entry_remove(&view->layer_link);
200 weston_view_set_output(view, woutput);
201 weston_view_set_position(view,
202 woutput->x + output->area.x,
203 woutput->y + output->area.y);
205 view->is_mapped = true;
206 view->surface->is_mapped = true;
208 if (output->active) {
209 output->active->view->is_mapped = false;
210 output->active->view->surface->is_mapped = false;
212 weston_layer_entry_remove(&output->active->view->layer_link);
214 output->previous_active = output->active;
215 output->active = surf;
217 weston_layer_entry_insert(&ivi->normal.view_list, &view->layer_link);
218 weston_view_update_transform(view);
220 /* force repaint of the entire output */
221 weston_output_damage(output->output);
224 * the 'remote' role now makes use of this part so make sure we don't
225 * trip the enum such that we might end up with a modified output for
228 if (surf->role == IVI_SURFACE_ROLE_DESKTOP) {
229 if (surf->desktop.pending_output)
230 surf->desktop.last_output = surf->desktop.pending_output;
231 surf->desktop.pending_output = NULL;
234 weston_log("Activation completed for app_id %s, role %s, output %s\n",
235 weston_desktop_surface_get_app_id(surf->dsurface),
236 ivi_layout_get_surface_role_name(surf), output->name);
240 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi)
242 struct ivi_output *out;
244 wl_list_for_each(out, &ivi->outputs, link) {
248 if (!strcmp(app_id, out->app_id))
256 static struct ivi_output *
257 ivi_layout_find_bg_output(struct ivi_compositor *ivi)
259 struct ivi_output *out;
261 wl_list_for_each(out, &ivi->outputs, link) {
262 if (out->background &&
263 out->background->role == IVI_SURFACE_ROLE_BACKGROUND)
271 ivi_layout_desktop_committed(struct ivi_surface *surf)
273 struct weston_desktop_surface *dsurf = surf->dsurface;
274 struct weston_geometry geom = weston_desktop_surface_get_geometry(dsurf);
275 struct ivi_policy *policy = surf->ivi->policy;
276 struct ivi_output *output;
277 const char *app_id = weston_desktop_surface_get_app_id(dsurf);
279 assert(surf->role == IVI_SURFACE_ROLE_DESKTOP ||
280 surf->role == IVI_SURFACE_ROLE_REMOTE);
283 * we can't make use here of the ivi_layout_get_output_from_surface()
284 * due to the fact that we'll always land here when a surface performs
285 * a commit and pending_output will not bet set. This works in tandem
286 * with 'activated_by_default' at this point to avoid tripping over
287 * to a surface that continuously updates its content
289 if (surf->role == IVI_SURFACE_ROLE_DESKTOP)
290 output = surf->desktop.pending_output;
292 output = surf->remote.output;
294 if (surf->role == IVI_SURFACE_ROLE_DESKTOP && !output) {
295 struct ivi_output *r_output;
297 if (policy && policy->api.surface_activate_by_default &&
298 !policy->api.surface_activate_by_default(surf, surf->ivi))
301 /* we can only activate it again by using the protocol */
302 if (surf->activated_by_default)
305 /* check first if there aren't any outputs being set */
306 r_output = ivi_layout_find_with_app_id(app_id, surf->ivi);
309 struct weston_view *view = r_output->fullscreen_view.fs->view;
310 if (view->is_mapped || view->surface->is_mapped)
311 remove_black_surface(r_output);
315 /* try finding an output with a background and use that */
317 r_output = ivi_layout_find_bg_output(surf->ivi);
319 /* if we couldn't still find an output by this point, there's
320 * something wrong so we abort with a protocol error */
322 wl_resource_post_error(surf->ivi->shell_client.resource,
323 AGL_SHELL_ERROR_INVALID_ARGUMENT,
324 "No valid output found to activate surface by default");
328 /* use the output of the bg to activate the app on start-up by
330 if (surf->view && r_output) {
331 if (app_id && r_output) {
332 weston_log("Surface with app_id %s, role %s activating by default\n",
333 weston_desktop_surface_get_app_id(surf->dsurface),
334 ivi_layout_get_surface_role_name(surf));
335 ivi_layout_activate(r_output, app_id);
336 surf->activated_by_default = true;
343 if (surf->role == IVI_SURFACE_ROLE_REMOTE && output) {
344 if (policy && policy->api.surface_activate_by_default &&
345 !policy->api.surface_activate_by_default(surf, surf->ivi))
348 /* we can only activate it again by using the protocol, but
349 * additionally the output is not reset when
350 * ivi_layout_activate_complete() terminates so we use the
351 * current active surface to avoid hitting this again and again
353 if (surf->activated_by_default && output->active == surf)
357 weston_log("Surface with app_id %s, role %s activating by default\n",
358 weston_desktop_surface_get_app_id(surf->dsurface),
359 ivi_layout_get_surface_role_name(surf));
360 ivi_layout_activate(output, app_id);
361 surf->activated_by_default = true;
366 if (!weston_desktop_surface_get_maximized(dsurf) ||
367 geom.width != output->area.width ||
368 geom.height != output->area.height)
371 ivi_layout_activate_complete(output, surf);
375 ivi_layout_fullscreen_committed(struct ivi_surface *surface)
377 struct ivi_compositor *ivi = surface->ivi;
378 struct ivi_policy *policy = ivi->policy;
380 struct weston_desktop_surface *dsurface = surface->dsurface;
381 struct weston_surface *wsurface =
382 weston_desktop_surface_get_surface(dsurface);
383 const char *app_id = weston_desktop_surface_get_app_id(dsurface);
385 struct ivi_output *output = surface->split.output;
386 struct weston_output *woutput = output->output;
388 struct weston_view *view = surface->view;
389 struct weston_geometry geom;
391 if (policy && policy->api.surface_activate_by_default &&
392 !policy->api.surface_activate_by_default(surface, surface->ivi) &&
393 !surface->activated_by_default)
396 if (surface->view->is_mapped)
399 geom = weston_desktop_surface_get_geometry(dsurface);
400 weston_log("(fs) geom x %d, y %d, width %d, height %d\n", geom.x, geom.y,
401 geom.width, geom.height);
403 assert(surface->role == IVI_SURFACE_ROLE_FULLSCREEN);
405 weston_desktop_surface_set_fullscreen(dsurface, true);
407 weston_view_set_output(view, woutput);
408 weston_view_set_position(view, woutput->x, woutput->y);
409 weston_layer_entry_insert(&ivi->fullscreen.view_list, &view->layer_link);
411 weston_view_update_transform(view);
412 weston_view_damage_below(view);
414 wsurface->is_mapped = true;
415 surface->view->is_mapped = true;
417 shell_advertise_app_state(ivi, app_id,
418 NULL, AGL_SHELL_DESKTOP_APP_STATE_ACTIVATED);
420 weston_log("Activation completed for app_id %s, role %s, output %s\n",
421 app_id, ivi_layout_get_surface_role_name(surface), output->name);
425 ivi_layout_desktop_resize(struct ivi_surface *surface,
426 struct weston_geometry area)
428 struct weston_desktop_surface *dsurf = surface->dsurface;
429 struct weston_view *view = surface->view;
433 int width = area.width;
434 int height = area.height;
436 weston_desktop_surface_set_size(dsurf,
439 weston_view_set_position(view, x, y);
440 weston_view_update_transform(view);
441 weston_view_damage_below(view);
445 ivi_layout_split_committed(struct ivi_surface *surface)
447 struct ivi_compositor *ivi = surface->ivi;
448 struct ivi_policy *policy = ivi->policy;
450 struct weston_desktop_surface *dsurface = surface->dsurface;
451 struct weston_surface *wsurface =
452 weston_desktop_surface_get_surface(dsurface);
453 const char *app_id = weston_desktop_surface_get_app_id(dsurface);
455 struct ivi_output *output = surface->split.output;
456 struct weston_output *woutput = output->output;
458 struct weston_view *view = surface->view;
459 struct weston_geometry geom;
467 if (policy && policy->api.surface_activate_by_default &&
468 !policy->api.surface_activate_by_default(surface, surface->ivi) &&
469 !surface->activated_by_default)
472 if (surface->view->is_mapped)
475 geom = weston_desktop_surface_get_geometry(dsurface);
477 assert(surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
478 surface->role == IVI_SURFACE_ROLE_SPLIT_V);
480 /* save the previous area in order to recover it back when if this kind
481 * of surface is being destroyed/removed */
482 output->area_saved = output->area;
484 switch (surface->role) {
485 case IVI_SURFACE_ROLE_SPLIT_V:
486 if (geom.width == woutput->width &&
487 geom.height == woutput->height)
488 geom.width = (output->area.width / 2);
490 x += woutput->width - geom.width;
491 output->area.width -= geom.width;
493 width = woutput->width - x;
494 height = output->area.height;
498 case IVI_SURFACE_ROLE_SPLIT_H:
499 if (geom.width == woutput->width &&
500 geom.height == woutput->height)
501 geom.height = (output->area.height / 2);
504 output->area.y += geom.height;
505 output->area.height -= geom.height;
507 width = output->area.width;
508 height = output->area.height;
514 assert(!"Invalid split orientation\n");
517 weston_desktop_surface_set_size(dsurface,
520 /* resize the active surface first, output->area already contains
521 * correct area to resize to */
523 ivi_layout_desktop_resize(output->active, output->area);
525 weston_view_set_output(view, woutput);
526 weston_view_set_position(view, x, y);
527 weston_layer_entry_insert(&ivi->normal.view_list, &view->layer_link);
529 weston_view_update_transform(view);
530 weston_view_damage_below(view);
532 wsurface->is_mapped = true;
533 surface->view->is_mapped = true;
535 shell_advertise_app_state(ivi, app_id,
536 NULL, AGL_SHELL_DESKTOP_APP_STATE_ACTIVATED);
538 weston_log("Activation completed for app_id %s, role %s, output %s\n",
539 app_id, ivi_layout_get_surface_role_name(surface), output->name);
543 ivi_layout_popup_committed(struct ivi_surface *surface)
545 struct ivi_compositor *ivi = surface->ivi;
546 struct ivi_policy *policy = ivi->policy;
548 struct weston_desktop_surface *dsurface = surface->dsurface;
549 struct weston_surface *wsurface =
550 weston_desktop_surface_get_surface(dsurface);
551 const char *app_id = weston_desktop_surface_get_app_id(dsurface);
553 struct ivi_output *output = surface->popup.output;
554 struct weston_output *woutput = output->output;
556 struct weston_view *view = surface->view;
558 if (policy && policy->api.surface_activate_by_default &&
559 !policy->api.surface_activate_by_default(surface, surface->ivi) &&
560 !surface->activated_by_default)
563 if (surface->view->is_mapped)
566 assert(surface->role == IVI_SURFACE_ROLE_POPUP);
568 weston_view_set_output(view, woutput);
569 weston_view_set_position(view, surface->popup.x, surface->popup.y);
571 /* only clip the pop-up dialog window if we have a valid
572 * width and height being passed on. Users might not want to have one
573 * set-up so only enfore it is really passed on. */
574 if (surface->popup.bb.width > 0 && surface->popup.bb.height > 0)
575 weston_view_set_mask(view, surface->popup.bb.x, surface->popup.bb.y,
576 surface->popup.bb.width, surface->popup.bb.height);
578 weston_layer_entry_insert(&ivi->popup.view_list, &view->layer_link);
580 weston_view_update_transform(view);
581 weston_view_damage_below(view);
583 wsurface->is_mapped = true;
584 surface->view->is_mapped = true;
586 shell_advertise_app_state(ivi, app_id,
587 NULL, AGL_SHELL_DESKTOP_APP_STATE_ACTIVATED);
589 weston_log("Activation completed for app_id %s, role %s, output %s\n",
590 app_id, ivi_layout_get_surface_role_name(surface), output->name);
594 ivi_layout_popup_re_add(struct ivi_surface *surface)
596 assert(surface->role == IVI_SURFACE_ROLE_POPUP);
597 struct weston_view *view = surface->view;
599 if (weston_view_is_mapped(view)) {
600 struct weston_desktop_surface *dsurface = surface->dsurface;
601 struct weston_surface *wsurface =
602 weston_desktop_surface_get_surface(dsurface);
604 weston_layer_entry_remove(&view->layer_link);
606 wsurface->is_mapped = false;
607 view->is_mapped = false;
610 /* reset the activate by default in order to (still) allow the surface
611 * to be activaved using the request */
612 if (!surface->activated_by_default)
613 surface->activated_by_default = true;
615 ivi_layout_popup_committed(surface);
619 ivi_layout_surface_is_split_or_fullscreen(struct ivi_surface *surf)
621 struct ivi_compositor *ivi = surf->ivi;
622 struct ivi_surface *is;
624 if (surf->role != IVI_SURFACE_ROLE_SPLIT_H &&
625 surf->role != IVI_SURFACE_ROLE_SPLIT_V &&
626 surf->role != IVI_SURFACE_ROLE_FULLSCREEN)
629 /* reset the activate by default in order to (still) allow the surface
630 * to be activaved using the request */
631 if (!surf->activated_by_default)
632 surf->activated_by_default = true;
634 wl_list_for_each(is, &ivi->surfaces, link)
642 ivi_layout_activate(struct ivi_output *output, const char *app_id)
644 struct ivi_compositor *ivi = output->ivi;
645 struct ivi_surface *surf;
646 struct weston_desktop_surface *dsurf;
647 struct weston_view *view;
648 struct weston_geometry geom;
649 struct ivi_policy *policy = output->ivi->policy;
651 surf = ivi_find_app(ivi, app_id);
655 if (policy && policy->api.surface_activate &&
656 !policy->api.surface_activate(surf, surf->ivi)) {
660 #ifdef AGL_COMP_DEBUG
661 weston_log("Activating app_id %s, type %s\n", app_id,
662 ivi_layout_get_surface_role_name(surf));
665 if (surf->role == IVI_SURFACE_ROLE_POPUP) {
666 ivi_layout_popup_re_add(surf);
670 /* do not 're'-activate surfaces that are split or active */
671 if (surf == output->active ||
672 ivi_layout_surface_is_split_or_fullscreen(surf))
675 if (surf->role == IVI_SURFACE_ROLE_REMOTE) {
676 struct ivi_output *remote_output =
677 ivi_layout_find_with_app_id(app_id, ivi);
679 /* if already active on a remote output do not
680 * attempt to activate it again */
681 if (remote_output && remote_output->active == surf)
686 dsurf = surf->dsurface;
688 geom = weston_desktop_surface_get_geometry(dsurf);
690 if (surf->role == IVI_SURFACE_ROLE_DESKTOP)
691 surf->desktop.pending_output = output;
692 if (weston_desktop_surface_get_maximized(dsurf) &&
693 geom.width == output->area.width &&
694 geom.height == output->area.height) {
695 ivi_layout_activate_complete(output, surf);
699 weston_desktop_surface_set_maximized(dsurf, true);
700 weston_desktop_surface_set_size(dsurf,
702 output->area.height);
704 weston_log("Setting app_id %s, role %s, set to maximized (%dx%d)\n",
705 app_id, ivi_layout_get_surface_role_name(surf),
706 output->area.width, output->area.height);
708 * If the view isn't mapped, we put it onto the hidden layer so it will
709 * start receiving frame events, and will be able to act on our
712 if (!weston_view_is_mapped(view)) {
713 view->is_mapped = true;
714 view->surface->is_mapped = true;
716 weston_view_set_output(view, output->output);
717 weston_layer_entry_insert(&ivi->hidden.view_list, &view->layer_link);
718 /* force repaint of the entire output */
720 weston_log("Placed app_id %s, type %s in hidden layer\n",
721 app_id, ivi_layout_get_surface_role_name(surf));
722 weston_output_damage(output->output);
727 ivi_layout_get_output_from_surface(struct ivi_surface *surf)
729 struct ivi_output *ivi_output = NULL;
731 switch (surf->role) {
732 case IVI_SURFACE_ROLE_DESKTOP:
733 if (surf->desktop.pending_output)
734 ivi_output = surf->desktop.pending_output;
736 ivi_output = surf->desktop.last_output;
738 case IVI_SURFACE_ROLE_POPUP:
739 ivi_output = surf->popup.output;
741 case IVI_SURFACE_ROLE_BACKGROUND:
742 ivi_output = surf->bg.output;
744 case IVI_SURFACE_ROLE_PANEL:
745 ivi_output = surf->panel.output;
747 case IVI_SURFACE_ROLE_FULLSCREEN:
748 ivi_output = surf->fullscreen.output;
750 case IVI_SURFACE_ROLE_SPLIT_H:
751 case IVI_SURFACE_ROLE_SPLIT_V:
752 ivi_output = surf->split.output;
754 case IVI_SURFACE_ROLE_REMOTE:
755 ivi_output = surf->remote.output;
757 case IVI_SURFACE_ROLE_NONE:
766 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id)
768 struct ivi_surface *surf;
769 struct ivi_output *ivi_output;
770 struct ivi_policy *policy = ivi->policy;
772 surf = ivi_find_app(ivi, app_id);
776 if (policy && policy->api.surface_deactivate &&
777 !policy->api.surface_deactivate(surf, surf->ivi)) {
781 ivi_output = ivi_layout_get_output_from_surface(surf);
782 weston_log("Deactiving %s, role %s\n", app_id,
783 ivi_layout_get_surface_role_name(surf));
785 if (surf->role == IVI_SURFACE_ROLE_DESKTOP) {
786 struct ivi_surface *previous_active;
788 previous_active = ivi_output->previous_active;
789 if (!previous_active) {
790 /* we don't have a previous active it means we should
792 if (ivi_output->active) {
793 struct weston_view *view;
795 view = ivi_output->active->view;
796 view->is_mapped = false;
797 view->surface->is_mapped = false;
799 weston_layer_entry_remove(&view->layer_link);
800 weston_output_damage(ivi_output->output);
803 struct weston_desktop_surface *dsurface;
804 const char *previous_active_app_id;
806 dsurface = previous_active->dsurface;
807 previous_active_app_id =
808 weston_desktop_surface_get_app_id(dsurface);
809 ivi_layout_activate(ivi_output, previous_active_app_id);
811 } else if (surf->role == IVI_SURFACE_ROLE_POPUP) {
812 struct weston_view *view = surf->view;
814 weston_layer_entry_remove(&view->layer_link);
815 weston_view_damage_below(view);