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