desktop: Group tests for checking against last remote surface
[src/agl-compositor.git] / 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 <libweston/libweston.h>
31 #include <libweston-desktop/libweston-desktop.h>
32
33 #if 0
34 static struct weston_output *
35 get_default_output(struct weston_compositor *compositor)
36 {
37         if (wl_list_empty(&compositor->output_list))
38                 return NULL;
39
40         return wl_container_of(compositor->output_list.next,
41                                struct weston_output, link);
42 }
43 #endif
44
45 static void
46 desktop_advertise_app(struct wl_listener *listener, void *data)
47 {
48         struct ivi_surface *surface;
49
50         surface = wl_container_of(listener, surface, listener_advertise_app);
51
52         agl_shell_desktop_advertise_application_id(surface->ivi, surface);
53 }
54
55 static void
56 desktop_ping_timeout(struct weston_desktop_client *dclient, void *userdata)
57 {
58         /* not supported */
59 }
60
61 static void
62 desktop_pong(struct weston_desktop_client *dclient, void *userdata)
63 {
64         /* not supported */
65 }
66
67 static void
68 desktop_surface_added(struct weston_desktop_surface *dsurface, void *userdata)
69 {
70         struct ivi_compositor *ivi = userdata;
71         struct weston_desktop_client *dclient;
72         struct wl_client *client;
73         struct ivi_surface *surface;
74         struct ivi_output *active_output = NULL;
75         const char *app_id = NULL;
76
77         dclient = weston_desktop_surface_get_client(dsurface);
78         client = weston_desktop_client_get_client(dclient);
79
80         surface = zalloc(sizeof *surface);
81         if (!surface) {
82                 wl_client_post_no_memory(client);
83                 return;
84         }
85
86         surface->view = weston_desktop_surface_create_view(dsurface);
87         if (!surface->view) {
88                 free(surface);
89                 wl_client_post_no_memory(client);
90                 return;
91         }
92
93         surface->ivi = ivi;
94         surface->dsurface = dsurface;
95         surface->role = IVI_SURFACE_ROLE_NONE;
96         surface->activated_by_default = false;
97         surface->advertised_on_launch = false;
98
99         wl_signal_init(&surface->signal_advertise_app);
100
101         surface->listener_advertise_app.notify = desktop_advertise_app;
102         wl_signal_add(&surface->signal_advertise_app,
103                       &surface->listener_advertise_app);
104
105         weston_desktop_surface_set_user_data(dsurface, surface);
106
107         if (ivi->policy && ivi->policy->api.surface_create &&
108             !ivi->policy->api.surface_create(surface, ivi)) {
109                 wl_client_post_no_memory(client);
110                 return;
111         }
112
113
114         app_id = weston_desktop_surface_get_app_id(dsurface);
115
116         if ((active_output = ivi_layout_find_with_app_id(app_id, ivi)))
117                 ivi_set_pending_desktop_surface_remote(active_output, app_id);
118
119         /* reset any caps to make sure we apply the new caps */
120         ivi_seat_reset_caps_sent(ivi);
121
122         if (ivi->shell_client.ready) {
123                 ivi_check_pending_desktop_surface(surface);
124                 weston_log("Added surface %p, app_id %s, role %s\n", surface,
125                                 app_id, ivi_layout_get_surface_role_name(surface));
126         } else {
127                 /*
128                  * We delay creating "normal" desktop surfaces until later, to
129                  * give the shell-client an oppurtunity to set the surface as a
130                  * background/panel.
131                  */
132                 weston_log("Added surface %p, app_id %s to pending list\n",
133                                 surface, app_id);
134                 wl_list_insert(&ivi->pending_surfaces, &surface->link);
135         }
136 }
137
138 static bool
139 desktop_surface_check_last_remote_surfaces(struct ivi_compositor *ivi, enum ivi_surface_role role)
140 {
141         int count = 0;
142         struct ivi_surface *surf;
143
144         wl_list_for_each(surf, &ivi->surfaces, link)
145                 if (surf->role == role)
146                         count++;
147
148         return (count == 1);
149 }
150
151 static void
152 desktop_surface_removed(struct weston_desktop_surface *dsurface, void *userdata)
153 {
154         struct ivi_surface *surface =
155                 weston_desktop_surface_get_user_data(dsurface);
156         struct weston_surface *wsurface =
157                 weston_desktop_surface_get_surface(dsurface);
158
159         struct ivi_output *output = ivi_layout_get_output_from_surface(surface);
160
161         wl_list_remove(&surface->listener_advertise_app.link);
162         surface->listener_advertise_app.notify = NULL;
163
164         /* special corner-case, pending_surfaces which are never activated or
165          * being assigned an output might land here so just remove the surface;
166          *
167          * the DESKTOP role can happen here as well, because we can fall-back 
168          * to that when we try to determine the role type. Application that
169          * do not set the app_id will be land here, when destroyed */
170         if (output == NULL && (surface->role == IVI_SURFACE_ROLE_NONE ||
171                                surface->role == IVI_SURFACE_ROLE_DESKTOP))
172                 goto skip_output_asignment;
173
174         assert(output != NULL);
175
176         /* resize the active surface to the original size */
177         if (surface->role == IVI_SURFACE_ROLE_SPLIT_H ||
178             surface->role == IVI_SURFACE_ROLE_SPLIT_V) {
179                 if (output && output->active) {
180                         ivi_layout_desktop_resize(output->active, output->area_saved);
181                 }
182                 /* restore the area back so we can re-use it again if needed */
183                 output->area = output->area_saved;
184         }
185
186         /* reset the active surface as well */
187         if (output && output->active && output->active == surface) {
188                 output->active->view->is_mapped = false;
189                 output->active->view->surface->is_mapped = false;
190
191                 weston_layer_entry_remove(&output->active->view->layer_link);
192                 output->active = NULL;
193         }
194
195         /* check if there's a last 'remote' surface and insert a black
196          * surface view if there's no background set for that output
197          */
198         if (desktop_surface_check_last_remote_surfaces(output->ivi,
199                 IVI_SURFACE_ROLE_REMOTE) ||
200             desktop_surface_check_last_remote_surfaces(output->ivi,
201                 IVI_SURFACE_ROLE_DESKTOP))
202                 if (!output->background)
203                         insert_black_surface(output);
204
205
206         if (weston_surface_is_mapped(wsurface)) {
207                 weston_desktop_surface_unlink_view(surface->view);
208                 weston_view_destroy(surface->view);
209         }
210
211         /* invalidate agl-shell surfaces so we can re-use them when
212          * binding again */
213         if (surface->role == IVI_SURFACE_ROLE_PANEL) {
214                 switch (surface->panel.edge) {
215                 case AGL_SHELL_EDGE_TOP:
216                         output->top = NULL;
217                         break;
218                 case AGL_SHELL_EDGE_BOTTOM:
219                         output->bottom = NULL;
220                         break;
221                 case AGL_SHELL_EDGE_LEFT:
222                         output->left = NULL;
223                         break;
224                 case AGL_SHELL_EDGE_RIGHT:
225                         output->right = NULL;
226                         break;
227                 default:
228                         assert(!"Invalid edge detected\n");
229                 }
230         } else if (surface->role == IVI_SURFACE_ROLE_BACKGROUND) {
231                 output->background = NULL;
232         }
233
234 skip_output_asignment:
235         weston_log("Removed surface %p, app_id %s, role %s\n", surface,
236                         weston_desktop_surface_get_app_id(dsurface),
237                         ivi_layout_get_surface_role_name(surface));
238
239         /* we weren't added to any list if we are still with 'none' as role */
240         if (surface->role != IVI_SURFACE_ROLE_NONE)
241                 wl_list_remove(&surface->link);
242
243         free(surface);
244 }
245
246 static void
247 desktop_committed(struct weston_desktop_surface *dsurface, 
248                   int32_t sx, int32_t sy, void *userdata)
249 {
250         struct ivi_surface *surface =
251                 weston_desktop_surface_get_user_data(dsurface);
252         struct ivi_policy *policy = surface->ivi->policy;
253
254         if (policy && policy->api.surface_commited &&
255             !policy->api.surface_commited(surface, surface->ivi))
256                 return;
257
258         if (!surface->advertised_on_launch)
259                 wl_signal_emit(&surface->signal_advertise_app, surface);
260
261         weston_compositor_schedule_repaint(surface->ivi->compositor);
262
263         switch (surface->role) {
264         case IVI_SURFACE_ROLE_DESKTOP:
265         case IVI_SURFACE_ROLE_REMOTE:
266                 ivi_layout_desktop_committed(surface);
267                 break;
268         case IVI_SURFACE_ROLE_POPUP:
269                 ivi_layout_popup_committed(surface);
270                 break;
271         case IVI_SURFACE_ROLE_FULLSCREEN:
272                 ivi_layout_fullscreen_committed(surface);
273                 break;
274         case IVI_SURFACE_ROLE_SPLIT_H:
275         case IVI_SURFACE_ROLE_SPLIT_V:
276                 ivi_layout_split_committed(surface);
277                 break;
278         case IVI_SURFACE_ROLE_NONE:
279         case IVI_SURFACE_ROLE_BACKGROUND:
280         case IVI_SURFACE_ROLE_PANEL:
281         default: /* fall through */
282                 break;
283         }
284 }
285
286 static void
287 desktop_show_window_menu(struct weston_desktop_surface *dsurface,
288                          struct weston_seat *seat, int32_t x, int32_t y,
289                          void *userdata)
290 {
291         /* not supported */
292 }
293
294 static void
295 desktop_set_parent(struct weston_desktop_surface *dsurface,
296                    struct weston_desktop_surface *parent, void *userdata)
297 {
298         /* not supported */
299 }
300
301 static void
302 desktop_move(struct weston_desktop_surface *dsurface,
303              struct weston_seat *seat, uint32_t serial, void *userdata)
304 {
305         /* not supported */
306 }
307
308 static void
309 desktop_resize(struct weston_desktop_surface *dsurface,
310                struct weston_seat *seat, uint32_t serial,
311                enum weston_desktop_surface_edge edges, void *user_data)
312 {
313         /* not supported */
314 }
315
316 static void
317 desktop_fullscreen_requested(struct weston_desktop_surface *dsurface,
318                              bool fullscreen, struct weston_output *output,
319                              void *userdata)
320 {
321         /* not supported */
322 }
323
324 static void
325 desktop_maximized_requested(struct weston_desktop_surface *dsurface,
326                             bool maximized, void *userdata)
327 {
328         /* not supported */
329 }
330
331 static void
332 desktop_minimized_requested(struct weston_desktop_surface *dsurface,
333                             void *userdata)
334 {
335         /* not supported */
336 }
337
338 static void
339 desktop_set_xwayland_position(struct weston_desktop_surface *dsurface,
340                               int32_t x, int32_t y, void *userdata)
341 {
342         /* not supported */
343 }
344
345 static const struct weston_desktop_api desktop_api = {
346         .struct_size = sizeof desktop_api,
347         .ping_timeout = desktop_ping_timeout,
348         .pong = desktop_pong,
349         .surface_added = desktop_surface_added,
350         .surface_removed = desktop_surface_removed,
351         .committed = desktop_committed,
352         .show_window_menu = desktop_show_window_menu,
353         .set_parent = desktop_set_parent,
354         .move = desktop_move,
355         .resize = desktop_resize,
356         .fullscreen_requested = desktop_fullscreen_requested,
357         .maximized_requested = desktop_maximized_requested,
358         .minimized_requested = desktop_minimized_requested,
359         .set_xwayland_position = desktop_set_xwayland_position,
360 };
361
362 int
363 ivi_desktop_init(struct ivi_compositor *ivi)
364 {
365         ivi->desktop = weston_desktop_create(ivi->compositor, &desktop_api, ivi);
366         if (!ivi->desktop) {
367                 weston_log("Failed to create desktop globals");
368                 return -1;
369         }
370
371         return 0;
372 }