layout: Do not delay mapping of desktop surface until commit time
[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
28 #include <assert.h>
29 #include <string.h>
30
31 #include <libweston-6/compositor.h>
32 #include <libweston-6/libweston-desktop.h>
33
34 #define AGL_COMP_DEBUG
35
36 static void
37 ivi_background_init(struct ivi_compositor *ivi, struct ivi_output *output)
38 {
39         struct weston_output *woutput = output->output;
40         struct ivi_surface *bg = output->background;
41         struct weston_view *view;
42
43         if (!bg) {
44                 weston_log("WARNING: Output does not have a background\n");
45                 return;
46         }
47
48         assert(bg->role == IVI_SURFACE_ROLE_BACKGROUND);
49
50         view = bg->view;
51
52         weston_view_set_output(view, woutput);
53         weston_view_set_position(view, woutput->x, woutput->y);
54
55 #ifdef AGL_COMP_DEBUG
56         weston_log("(background) position view %p, x %d, y %d\n", view,
57                         woutput->x, woutput->y);
58 #endif
59
60         view->is_mapped = true;
61         view->surface->is_mapped = true;
62
63         weston_layer_entry_insert(&ivi->background.view_list, &view->layer_link);
64 }
65
66 static void
67 ivi_panel_init(struct ivi_compositor *ivi, struct ivi_output *output,
68                struct ivi_surface *panel)
69 {
70         struct weston_output *woutput = output->output;
71         struct weston_desktop_surface *dsurface;
72         struct weston_view *view;
73         struct weston_geometry geom;
74         int x = woutput->x;
75         int y = woutput->y;
76
77         if (!panel)
78                 return;
79
80         assert(panel->role == IVI_SURFACE_ROLE_PANEL);
81         dsurface = panel->dsurface;
82         view = panel->view;
83         geom = weston_desktop_surface_get_geometry(dsurface);
84 #ifdef AGL_COMP_DEBUG
85         weston_log("geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
86                         geom.width, geom.height, geom.x, geom.y);
87 #endif
88         switch (panel->panel.edge) {
89         case AGL_SHELL_EDGE_TOP:
90                 output->area.y += geom.height;
91                 output->area.height -= geom.height;
92                 break;
93         case AGL_SHELL_EDGE_BOTTOM:
94                 y += woutput->height - geom.height;
95                 output->area.height -= geom.height;
96                 break;
97         case AGL_SHELL_EDGE_LEFT:
98                 output->area.x += geom.width;
99                 output->area.width -= geom.width;
100                 break;
101         case AGL_SHELL_EDGE_RIGHT:
102                 x += woutput->width - geom.width;
103                 output->area.width -= geom.width;
104                 break;
105         }
106
107         x -= geom.x;
108         y -= geom.y;
109
110         weston_view_set_output(view, woutput);
111         weston_view_set_position(view, x, y);
112 #ifdef AGL_COMP_DEBUG
113         weston_log("(panel) edge %d position view %p, x %d, y %d\n",
114                         panel->panel.edge, view, x, y);
115 #endif
116
117         /* this is necessary for cases we already mapped it desktop_committed()
118          * but we not running the older qtwayland, so we still have a chance
119          * for this to run at the next test */
120         if (view->surface->is_mapped) {
121                 weston_layer_entry_remove(&view->layer_link);
122
123                 view->is_mapped = false;
124                 view->surface->is_mapped = false;
125         }
126
127         /* give ivi_layout_panel_committed() a chance to map the view/surface
128          * instead */
129         if ((geom.width == geom.height && geom.width == 0) &&
130             (geom.x == geom.y && geom.x == 0) &&
131             panel->panel.edge != AGL_SHELL_EDGE_TOP)
132                 return;
133
134         view->is_mapped = true;
135         view->surface->is_mapped = true;
136 #ifdef AGL_COMP_DEBUG
137         weston_log("panel type %d inited\n", panel->panel.edge);
138 #endif
139         weston_layer_entry_insert(&ivi->panel.view_list, &view->layer_link);
140 }
141
142 /*
143  * Initializes all static parts of the layout, i.e. the background and panels.
144  */
145 void
146 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output)
147 {
148         ivi_background_init(ivi, output);
149
150         output->area.x = 0;
151         output->area.y = 0;
152         output->area.width = output->output->width;
153         output->area.height = output->output->height;
154
155         ivi_panel_init(ivi, output, output->top);
156         ivi_panel_init(ivi, output, output->bottom);
157         ivi_panel_init(ivi, output, output->left);
158         ivi_panel_init(ivi, output, output->right);
159
160         weston_compositor_schedule_repaint(ivi->compositor);
161
162         weston_log("Usable area: %dx%d+%d,%d\n",
163                    output->area.width, output->area.height,
164                    output->area.x, output->area.y);
165 }
166
167 static struct ivi_surface *
168 ivi_find_app(struct ivi_compositor *ivi, const char *app_id)
169 {
170         struct ivi_surface *surf;
171         const char *id;
172
173         wl_list_for_each(surf, &ivi->surfaces, link) {
174                 id = weston_desktop_surface_get_app_id(surf->dsurface);
175                 if (id && strcmp(app_id, id) == 0)
176                         return surf;
177         }
178
179         return NULL;
180 }
181
182 static void
183 ivi_layout_activate_complete(struct ivi_output *output,
184                              struct ivi_surface *surf)
185 {
186         struct ivi_compositor *ivi = output->ivi;
187         struct weston_output *woutput = output->output;
188         struct weston_view *view = surf->view;
189
190         if (weston_view_is_mapped(view)) {
191                 weston_layer_entry_remove(&view->layer_link);
192         }
193
194         weston_view_set_output(view, woutput);
195         weston_view_set_position(view,
196                                  woutput->x + output->area.x,
197                                  woutput->y + output->area.y);
198
199         view->is_mapped = true;
200         view->surface->is_mapped = true;
201
202         if (output->active) {
203                 output->active->view->is_mapped = false;
204                 output->active->view->surface->is_mapped = false;
205
206                 weston_layer_entry_remove(&output->active->view->layer_link);
207         }
208         output->active = surf;
209
210         weston_layer_entry_insert(&ivi->normal.view_list, &view->layer_link);
211         weston_view_update_transform(view);
212
213         /* force repaint of the entire output */
214         weston_output_damage(output->output);
215         surf->desktop.pending_output = NULL;
216 }
217
218 static struct ivi_output *
219 ivi_layout_find_bg_output(struct ivi_compositor *ivi)
220 {
221         struct ivi_output *out;
222
223         wl_list_for_each(out, &ivi->outputs, link) {
224                 if (out->background &&
225                     out->background->role == IVI_SURFACE_ROLE_BACKGROUND)
226                         return out;
227         }
228
229         return NULL;
230 }
231
232 void
233 ivi_layout_desktop_committed(struct ivi_surface *surf)
234 {
235         struct weston_desktop_surface *dsurf = surf->dsurface;
236         struct weston_geometry geom = weston_desktop_surface_get_geometry(dsurf);
237         struct ivi_output *output;
238
239         assert(surf->role == IVI_SURFACE_ROLE_DESKTOP);
240
241         output = surf->desktop.pending_output;
242         if (!output) {
243                 struct ivi_output *ivi_bg_output;
244
245                 /* FIXME: This should be changed to determine if the policy
246                  * database allows that to happen */
247                 if (!surf->ivi->quirks.activate_apps_by_default)
248                         return;
249
250                 ivi_bg_output = ivi_layout_find_bg_output(surf->ivi);
251
252                 /* use the output of the bg to activate the app on start-up by
253                  * default */
254                 if (surf->view && ivi_bg_output) {
255                         const char *app_id =
256                                 weston_desktop_surface_get_app_id(dsurf);
257                         if (app_id && ivi_bg_output)
258                                 ivi_layout_activate(ivi_bg_output, app_id);
259                 }
260
261                 return;
262         }
263
264         if (!weston_desktop_surface_get_maximized(dsurf) ||
265             geom.width != output->area.width ||
266             geom.height != output->area.height)
267                 return;
268
269         ivi_layout_activate_complete(output, surf);
270 }
271
272 void
273 ivi_layout_panel_committed(struct ivi_surface *surface)
274 {
275         struct ivi_compositor *ivi = surface->ivi;
276         struct ivi_output *output = surface->bg.output;
277         struct weston_output *woutput = output->output;
278         struct weston_desktop_surface *dsurface = surface->dsurface;
279         struct weston_surface *wsurface =
280                 weston_desktop_surface_get_surface(dsurface);
281         struct weston_geometry geom;
282         int x = woutput->x;
283         int y = woutput->y;
284
285         assert(surface->role == IVI_SURFACE_ROLE_PANEL);
286
287         /*
288          * If the desktop_surface geometry is not set and the panel is not a
289          * top one, we'll give this a chance to run, as some qtwayland version
290          * seem to have a 'problem', where the panel initilization part will
291          * have a desktop surface with 0 as geometry for *all* its members
292          * (width/height). Doing that will result in the panel not being
293          * displayed at all.
294          *
295          * Later versions of qtwayland do have the correct window geometry for
296          * the desktop surface so the weston_surface is already mapped in
297          * ivi_panel_init().
298          */
299         if (wsurface->is_mapped)
300                 return;
301
302         geom = weston_desktop_surface_get_geometry(dsurface);
303
304 #ifdef AGL_COMP_DEBUG
305         weston_log("geom.width %d, geom.height %d, geom.x %d, geom.y %d\n",
306                         geom.width, geom.height, geom.x, geom.y);
307 #endif
308
309         switch (surface->panel.edge) {
310         case AGL_SHELL_EDGE_TOP:
311                 /* Do nothing */
312                 break;
313         case AGL_SHELL_EDGE_BOTTOM:
314                 y += woutput->height - geom.height;
315                 break;
316         case AGL_SHELL_EDGE_LEFT:
317                 /* Do nothing */
318                 break;
319         case AGL_SHELL_EDGE_RIGHT:
320                 x += woutput->width - geom.width;
321                 break;
322         }
323 #ifndef AGL_COMP_DEBUG
324         weston_log("panel type %d commited\n", surface->panel.edge);
325 #endif
326
327         weston_view_set_output(surface->view, woutput);
328         weston_view_set_position(surface->view, x, y);
329         weston_layer_entry_insert(&ivi->panel.view_list,
330                                   &surface->view->layer_link);
331
332         weston_view_update_transform(surface->view);
333         weston_view_schedule_repaint(surface->view);
334
335         wsurface->is_mapped = true;
336         surface->view->is_mapped = true;
337 }
338
339 void
340 ivi_layout_activate(struct ivi_output *output, const char *app_id)
341 {
342         struct ivi_compositor *ivi = output->ivi;
343         struct ivi_surface *surf;
344         struct weston_desktop_surface *dsurf;
345         struct weston_view *view;
346         struct weston_geometry geom;
347
348         surf = ivi_find_app(ivi, app_id);
349         if (!surf)
350                 return;
351 #ifdef AGL_COMP_DEBUG
352         weston_log("Found app_id %s\n", app_id);
353 #endif
354         if (surf == output->active)
355                 return;
356
357         dsurf = surf->dsurface;
358         view = surf->view;
359         geom = weston_desktop_surface_get_geometry(dsurf);
360
361         if (weston_desktop_surface_get_maximized(dsurf) &&
362             geom.width == output->area.width &&
363             geom.height == output->area.height) {
364                 ivi_layout_activate_complete(output, surf);
365                 return;
366         }
367
368         weston_desktop_surface_set_maximized(dsurf, true);
369         weston_desktop_surface_set_size(dsurf,
370                                         output->area.width,
371                                         output->area.height);
372
373         /*
374          * If the view isn't mapped, we put it onto the hidden layer so it will
375          * start receiving frame events, and will be able to act on our
376          * configure event.
377          */
378         if (!weston_view_is_mapped(view)) {
379                 view->is_mapped = true;
380                 view->surface->is_mapped = true;
381
382                 weston_view_set_output(view, output->output);
383                 weston_layer_entry_insert(&ivi->hidden.view_list, &view->layer_link);
384                 /* force repaint of the entire output */
385                 weston_output_damage(output->output);
386         }
387
388         surf->desktop.pending_output = output;
389 }