layout: Do not attempt to activate a split or a fs surface
[src/agl-compositor.git] / 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_fullscreen_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->split.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("(fs) 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_FULLSCREEN);
310
311         weston_desktop_surface_set_fullscreen(dsurface, true);
312
313         weston_view_set_output(view, woutput);
314         weston_view_set_position(view, woutput->x, woutput->y);
315         weston_layer_entry_insert(&ivi->fullscreen.view_list, &view->layer_link);
316
317         weston_view_update_transform(view);
318         weston_view_damage_below(view);
319
320         wsurface->is_mapped = true;
321         surface->view->is_mapped = true;
322 }
323
324 void
325 ivi_layout_desktop_resize(struct ivi_surface *surface,
326                           struct weston_geometry area)
327 {
328         struct weston_desktop_surface *dsurf = surface->dsurface;
329         struct weston_view *view = surface->view;
330
331         int x = area.x;
332         int y = area.y;
333         int width = area.width;
334         int height = area.height;
335
336         weston_desktop_surface_set_size(dsurf,
337                                         width, height);
338
339         weston_view_set_position(view, x, y);
340         weston_view_update_transform(view);
341         weston_view_damage_below(view);
342 }
343
344 void
345 ivi_layout_split_committed(struct ivi_surface *surface)
346 {
347         struct ivi_compositor *ivi = surface->ivi;
348
349         struct weston_desktop_surface *dsurface = surface->dsurface;
350         struct weston_surface *wsurface =
351                 weston_desktop_surface_get_surface(dsurface);
352
353         struct ivi_output *output = surface->split.output;
354         struct weston_output *woutput = output->output;
355
356         struct weston_view *view = surface->view;
357         struct weston_geometry geom;
358
359         int x, y;
360         int width, height;
361
362         x = woutput->x;
363         y = woutput->y;
364
365         if (surface->view->is_mapped)
366                 return;
367
368         geom = weston_desktop_surface_get_geometry(dsurface);
369
370         assert(surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
371                surface->role == IVI_SURFACE_ROLE_SPLIT_V);
372
373         /* save the previous area in order to recover it back when if this kind
374          * of surface is being destroyed/removed */
375         output->area_saved = output->area;
376
377         switch (surface->role) {
378         case IVI_SURFACE_ROLE_SPLIT_V:
379                 if (geom.width == woutput->width &&
380                     geom.height == woutput->height)
381                         geom.width = (output->area.width / 2);
382
383                 x += woutput->width - geom.width;
384                 output->area.width -= geom.width;
385
386                 width = woutput->width - x;
387                 height = output->area.height;
388                 y = output->area.y;
389
390                 break;
391         case IVI_SURFACE_ROLE_SPLIT_H:
392                 if (geom.width == woutput->width &&
393                     geom.height == woutput->height)
394                         geom.height = (output->area.height / 2);
395
396                 y = output->area.y;
397                 output->area.y += geom.height;
398                 output->area.height -= geom.height;
399
400                 width = output->area.width;
401                 height = output->area.height;
402
403                 x = output->area.x;
404
405                 break;
406         default:
407                 assert(!"Invalid split orientation\n");
408         }
409
410         weston_desktop_surface_set_size(dsurface,
411                                         width, height);
412
413         /* resize the active surface first, output->area already contains
414          * correct area to resize to */
415         if (output->active)
416                 ivi_layout_desktop_resize(output->active, output->area);
417
418         weston_view_set_output(view, woutput);
419         weston_view_set_position(view, x, y);
420         weston_layer_entry_insert(&ivi->normal.view_list, &view->layer_link);
421
422         weston_view_update_transform(view);
423         weston_view_damage_below(view);
424
425         wsurface->is_mapped = true;
426         surface->view->is_mapped = true;
427 }
428
429 void
430 ivi_layout_popup_committed(struct ivi_surface *surface)
431 {
432         struct ivi_compositor *ivi = surface->ivi;
433
434         struct weston_desktop_surface *dsurface = surface->dsurface;
435         struct weston_surface *wsurface =
436                 weston_desktop_surface_get_surface(dsurface);
437
438         struct ivi_output *output = surface->popup.output;
439         struct weston_output *woutput = output->output;
440
441         struct weston_view *view = surface->view;
442         struct weston_geometry geom;
443
444         if (surface->view->is_mapped)
445                 return;
446
447         geom = weston_desktop_surface_get_geometry(dsurface);
448         weston_log("geom x %d, y %d, width %d, height %d\n", geom.x, geom.y,
449                         geom.width, geom.height);
450
451         assert(surface->role == IVI_SURFACE_ROLE_POPUP);
452
453         weston_view_set_output(view, woutput);
454         if (surface->popup.x || surface->popup.y)
455                 weston_view_set_position(view, surface->popup.x, surface->popup.y);
456         else
457                 weston_view_set_position(view, geom.x, geom.y);
458         weston_layer_entry_insert(&ivi->popup.view_list, &view->layer_link);
459
460         weston_view_update_transform(view);
461         weston_view_damage_below(view);
462
463         wsurface->is_mapped = true;
464         surface->view->is_mapped = true;
465 }
466
467 static void
468 ivi_layout_popup_re_add(struct ivi_surface *surface)
469 {
470         assert(surface->role == IVI_SURFACE_ROLE_POPUP);
471         struct weston_view *view = surface->view;
472
473         if (weston_view_is_mapped(view)) {
474                 struct weston_desktop_surface *dsurface = surface->dsurface;
475                 struct weston_surface *wsurface =
476                         weston_desktop_surface_get_surface(dsurface);
477
478                 weston_layer_entry_remove(&view->layer_link);
479
480                 wsurface->is_mapped = false;
481                 view->is_mapped = false;
482         }
483
484         ivi_layout_popup_committed(surface);
485 }
486
487 void
488 ivi_layout_panel_committed(struct ivi_surface *surface)
489 {
490         struct ivi_compositor *ivi = surface->ivi;
491         struct ivi_output *output = surface->bg.output;
492         struct weston_output *woutput = output->output;
493         struct weston_desktop_surface *dsurface = surface->dsurface;
494         struct weston_surface *wsurface =
495                 weston_desktop_surface_get_surface(dsurface);
496         struct weston_geometry geom;
497         int x = woutput->x;
498         int y = woutput->y;
499
500         assert(surface->role == IVI_SURFACE_ROLE_PANEL);
501
502         /*
503          * If the desktop_surface geometry is not set and the panel is not a
504          * top one, we'll give this a chance to run, as some qtwayland version
505          * seem to have a 'problem', where the panel initilization part will
506          * have a desktop surface with 0 as geometry for *all* its members
507          * (width/height). Doing that will result in the panel not being
508          * displayed at all.
509          *
510          * Later versions of qtwayland do have the correct window geometry for
511          * the desktop surface so the weston_surface is already mapped in
512          * ivi_panel_init().
513          */
514         if (wsurface->is_mapped)
515                 return;
516
517         geom = weston_desktop_surface_get_geometry(dsurface);
518
519 #ifdef AGL_COMP_DEBUG
520         weston_log("geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
521                         geom.width, geom.height, geom.x, geom.y);
522 #endif
523
524         switch (surface->panel.edge) {
525         case AGL_SHELL_EDGE_TOP:
526                 /* Do nothing */
527                 break;
528         case AGL_SHELL_EDGE_BOTTOM:
529                 y += woutput->height - geom.height;
530                 break;
531         case AGL_SHELL_EDGE_LEFT:
532                 /* Do nothing */
533                 break;
534         case AGL_SHELL_EDGE_RIGHT:
535                 x += woutput->width - geom.width;
536                 break;
537         }
538 #ifndef AGL_COMP_DEBUG
539         weston_log("panel type %d commited\n", surface->panel.edge);
540 #endif
541
542         weston_view_set_output(surface->view, woutput);
543         weston_view_set_position(surface->view, x, y);
544         weston_layer_entry_insert(&ivi->panel.view_list,
545                                   &surface->view->layer_link);
546
547         weston_view_update_transform(surface->view);
548         weston_view_schedule_repaint(surface->view);
549
550         wsurface->is_mapped = true;
551         surface->view->is_mapped = true;
552 }
553
554 static bool
555 ivi_layout_surface_is_split_or_fullscreen(struct ivi_surface *surf)
556 {
557         struct ivi_compositor *ivi = surf->ivi;
558         struct ivi_surface *is;
559
560         if (surf->role != IVI_SURFACE_ROLE_SPLIT_H &&
561             surf->role != IVI_SURFACE_ROLE_SPLIT_V &&
562             surf->role != IVI_SURFACE_ROLE_FULLSCREEN)
563                 return false;
564
565         wl_list_for_each(is, &ivi->surfaces, link)
566                 if (is == surf)
567                         return true;
568
569         return false;
570 }
571
572 void
573 ivi_layout_activate(struct ivi_output *output, const char *app_id)
574 {
575         struct ivi_compositor *ivi = output->ivi;
576         struct ivi_surface *surf;
577         struct weston_desktop_surface *dsurf;
578         struct weston_view *view;
579         struct weston_geometry geom;
580         struct ivi_policy *policy = output->ivi->policy;
581
582         surf = ivi_find_app(ivi, app_id);
583         if (!surf)
584                 return;
585
586         if (policy && policy->api.surface_activate &&
587             !policy->api.surface_activate(surf, surf->ivi)) {
588                 return;
589         }
590
591 #ifdef AGL_COMP_DEBUG
592         weston_log("Found app_id %s\n", app_id);
593 #endif
594
595         if (surf->role == IVI_SURFACE_ROLE_POPUP) {
596                 ivi_layout_popup_re_add(surf);
597                 return;
598         }
599
600         /* do not 're'-activate surfaces that are split or active */
601         if (surf == output->active ||
602             ivi_layout_surface_is_split_or_fullscreen(surf))
603                 return;
604
605
606         dsurf = surf->dsurface;
607         view = surf->view;
608         geom = weston_desktop_surface_get_geometry(dsurf);
609
610         surf->desktop.pending_output = output;
611         if (weston_desktop_surface_get_maximized(dsurf) &&
612             geom.width == output->area.width &&
613             geom.height == output->area.height) {
614                 ivi_layout_activate_complete(output, surf);
615                 return;
616         }
617
618         weston_desktop_surface_set_maximized(dsurf, true);
619         weston_desktop_surface_set_size(dsurf,
620                                         output->area.width,
621                                         output->area.height);
622
623         /*
624          * If the view isn't mapped, we put it onto the hidden layer so it will
625          * start receiving frame events, and will be able to act on our
626          * configure event.
627          */
628         if (!weston_view_is_mapped(view)) {
629                 view->is_mapped = true;
630                 view->surface->is_mapped = true;
631
632                 weston_view_set_output(view, output->output);
633                 weston_layer_entry_insert(&ivi->hidden.view_list, &view->layer_link);
634                 /* force repaint of the entire output */
635                 weston_output_damage(output->output);
636         }
637 }
638
639 static struct ivi_output *
640 ivi_layout_get_output_from_surface(struct ivi_surface *surf)
641 {
642         struct ivi_output *ivi_output = NULL;
643
644         switch (surf->role) {
645         case IVI_SURFACE_ROLE_DESKTOP:
646                 if (surf->desktop.pending_output)
647                         ivi_output = surf->desktop.pending_output;
648                 else
649                         ivi_output = surf->desktop.last_output;
650                 break;
651         case IVI_SURFACE_ROLE_POPUP:
652                 ivi_output = surf->popup.output;
653                 break;
654         default:
655         case IVI_SURFACE_ROLE_BACKGROUND:
656         case IVI_SURFACE_ROLE_PANEL:
657         case IVI_SURFACE_ROLE_NONE:
658                 break;
659         }
660
661         return ivi_output;
662 }
663
664 void
665 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id)
666 {
667         struct ivi_surface *surf;
668         struct ivi_output *ivi_output;
669         struct ivi_policy *policy = ivi->policy;
670
671         surf = ivi_find_app(ivi, app_id);
672         if (!surf)
673                 return;
674
675         if (policy && policy->api.surface_deactivate &&
676             !policy->api.surface_deactivate(surf, surf->ivi)) {
677                 return;
678         }
679
680         ivi_output = ivi_layout_get_output_from_surface(surf);
681         weston_log("deactiving %s\n", app_id);
682
683         if (surf->role == IVI_SURFACE_ROLE_DESKTOP) {
684                 struct ivi_surface *previous_active;
685
686                 previous_active = ivi_output->previous_active;
687                 if (!previous_active) {
688                         /* we don't have a previous active it means we should
689                          * display the bg */
690                         if (ivi_output->active) {
691                                 struct weston_view *view;
692
693                                 view = ivi_output->active->view;
694                                 view->is_mapped = false;
695                                 view->surface->is_mapped = false;
696
697                                 weston_layer_entry_remove(&view->layer_link);
698                                 weston_output_damage(ivi_output->output);
699                         }
700                 } else {
701                         struct weston_desktop_surface *dsurface;
702                         const char *previous_active_app_id;
703
704                         dsurface = previous_active->dsurface;
705                         previous_active_app_id =
706                                 weston_desktop_surface_get_app_id(dsurface);
707                         ivi_layout_activate(ivi_output, previous_active_app_id);
708                 }
709         } else if (surf->role == IVI_SURFACE_ROLE_POPUP) {
710                 struct weston_view *view  = surf->view;
711
712                 weston_layer_entry_remove(&view->layer_link);
713                 weston_view_damage_below(view);
714         }
715 }