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 #ifndef IVI_COMPOSITOR_H
27 #define IVI_COMPOSITOR_H
32 #include <libweston/backend-drm.h>
33 #include <libweston/libweston.h>
34 #include <libweston/windowed-output-api.h>
35 #include <libweston-desktop/libweston-desktop.h>
39 #include "agl-shell-server-protocol.h"
41 struct ivi_compositor;
43 struct desktop_client {
44 struct wl_resource *resource;
45 struct ivi_compositor *ivi;
46 struct wl_list link; /* ivi_compositor::desktop_clients */
49 enum agl_shell_bound_status {
54 struct ivi_compositor {
55 struct weston_compositor *compositor;
56 struct weston_config *config;
58 struct wl_listener heads_changed;
62 bool activate_by_default;
63 bool keep_pending_surfaces;
66 * Options parsed from command line arugments.
67 * Overrides what is found in the config file.
71 bool use_current_mode;
77 const struct weston_windowed_output_api *window_api;
78 const struct weston_drm_output_api *drm_api;
79 const struct weston_remoting_api *remoting_api;
80 const struct weston_transmitter_api *waltham_transmitter_api;
82 struct wl_global *agl_shell;
83 struct wl_global *agl_shell_desktop;
84 struct wl_global *agl_shell_ext;
87 struct wl_client *client;
88 struct wl_resource *resource;
90 /* this is for another agl-shell client, potentially used by
92 struct wl_resource *resource_ext;
94 enum agl_shell_bound_status status;
98 struct wl_client *client;
99 struct wl_resource *resource;
101 enum agl_shell_bound_status status;
104 struct wl_list desktop_clients; /* desktop_client::link */
106 struct wl_list outputs; /* ivi_output.link */
107 struct wl_list surfaces; /* ivi_surface.link */
109 struct weston_desktop *desktop;
110 struct wl_listener seat_created_listener;
111 struct ivi_policy *policy;
113 struct wl_list pending_surfaces;
114 struct wl_list popup_pending_apps;
115 struct wl_list fullscreen_pending_apps;
116 struct wl_list split_pending_apps;
117 struct wl_list remote_pending_apps;
119 struct wl_listener destroy_listener;
121 struct weston_layer hidden;
122 struct weston_layer background;
123 struct weston_layer normal;
124 struct weston_layer panel;
125 struct weston_layer popup;
126 struct weston_layer fullscreen;
128 struct wl_list child_process_list;
133 enum ivi_output_type {
136 /* same as remote but we need to signal the transmitter plug-in
137 * for the surfaces to have to be forwarded to those remoted outputs */
142 struct wl_list link; /* ivi_compositor.outputs */
143 struct ivi_compositor *ivi;
146 struct weston_config_section *config;
147 struct weston_output *output;
149 struct ivi_surface *background;
151 struct ivi_surface *top;
152 struct ivi_surface *bottom;
153 struct ivi_surface *left;
154 struct ivi_surface *right;
156 /* for the black surface */
157 struct fullscreen_view {
158 struct ivi_surface *fs;
159 struct wl_listener fs_destroy;
162 struct wl_listener output_destroy;
165 * Usable area for normal clients, i.e. with panels removed.
166 * In output-coorrdinate space.
168 struct weston_geometry area;
169 struct weston_geometry area_saved;
171 * Potential user-specified non-default activation area
173 struct weston_geometry area_activation;
175 struct ivi_surface *active;
176 struct ivi_surface *previous_active;
178 /* Temporary: only used during configuration */
180 struct weston_head *add[8];
183 enum ivi_output_type type;
186 enum ivi_surface_role {
187 IVI_SURFACE_ROLE_NONE,
188 IVI_SURFACE_ROLE_DESKTOP,
189 IVI_SURFACE_ROLE_BACKGROUND,
190 IVI_SURFACE_ROLE_PANEL,
191 IVI_SURFACE_ROLE_POPUP,
192 IVI_SURFACE_ROLE_FULLSCREEN,
193 IVI_SURFACE_ROLE_SPLIT_V,
194 IVI_SURFACE_ROLE_SPLIT_H,
195 IVI_SURFACE_ROLE_REMOTE,
198 struct ivi_bounding_box {
200 int width; int height;
203 struct pending_popup {
204 struct ivi_output *ioutput;
207 struct ivi_bounding_box bb;
209 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
212 struct pending_fullscreen {
213 struct ivi_output *ioutput;
215 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
218 struct pending_split {
219 struct ivi_output *ioutput;
221 uint32_t orientation;
222 struct wl_list link; /** ivi_compositor::split_pending_apps */
225 struct pending_remote {
226 struct ivi_output *ioutput;
228 struct wl_list link; /** ivi_compositor::remote_pending_apps */
231 struct ivi_desktop_surface {
232 struct ivi_output *pending_output;
233 struct ivi_output *last_output;
236 struct ivi_background_surface {
237 struct ivi_output *output;
240 struct ivi_popup_surface {
241 struct ivi_output *output;
242 int x; int y; /* initial position */
243 struct ivi_bounding_box bb; /* bounding box */
246 struct ivi_fullscreen_surface {
247 struct ivi_output *output;
250 struct ivi_split_surface {
251 struct ivi_output *output;
252 uint32_t orientation;
255 struct ivi_remote_surface {
256 struct ivi_output *output;
259 struct ivi_panel_surface {
260 struct ivi_output *output;
261 enum agl_shell_edge edge;
264 enum ivi_surface_flags {
265 IVI_SURFACE_PROP_MAP = (1 << 0),
266 /* x, y, width, height */
267 IVI_SURFACE_PROP_POSITION = (1 << 1),
270 /* the waltham surface is a pointer type as well and
271 * in order to avoid adding ifdef for waltham use a
272 * generic pointer, which will be only be valid when the
273 * surface is a remote out on a waltham type of output */
274 struct ivi_surface_waltham {
275 void *transmitter_surface;
279 struct ivi_compositor *ivi;
280 struct weston_desktop_surface *dsurface;
281 struct weston_view *view;
282 struct ivi_output *hidden_layer_output;
283 struct ivi_output *current_completed_output;
289 enum ivi_surface_flags flags;
291 int32_t width, height;
294 bool advertised_on_launch;
295 bool checked_pending;
303 enum ivi_surface_role role;
305 struct ivi_desktop_surface desktop;
306 struct ivi_background_surface bg;
307 struct ivi_panel_surface panel;
308 struct ivi_popup_surface popup;
309 struct ivi_fullscreen_surface fullscreen;
310 struct ivi_split_surface split;
311 struct ivi_remote_surface remote;
314 struct ivi_surface_waltham waltham_surface;
315 struct wl_listener listener_advertise_app;
316 struct wl_signal signal_advertise_app;
319 struct ivi_shell_seat {
320 struct weston_seat *seat;
321 struct weston_surface *focused_surface;
326 struct wl_listener seat_destroy_listener;
327 struct wl_listener caps_changed_listener;
328 struct wl_listener keyboard_focus_listener;
329 struct wl_listener pointer_focus_listener;
332 struct ivi_shell_client {
338 struct wl_client *client;
340 struct wl_listener client_destroy;
343 struct ivi_compositor *
344 to_ivi_compositor(struct weston_compositor *ec);
348 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
351 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
357 ivi_shell_init(struct ivi_compositor *ivi);
360 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
363 ivi_shell_create_global(struct ivi_compositor *ivi);
366 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
369 ivi_desktop_init(struct ivi_compositor *ivi);
371 struct ivi_shell_client *
372 ivi_shell_client_from_wl(struct wl_client *client);
375 to_ivi_output(struct weston_output *o);
378 ivi_set_desktop_surface(struct ivi_surface *surface);
381 * removes the pending popup one
384 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
387 ivi_reflow_outputs(struct ivi_compositor *ivi);
390 to_ivi_surface(struct weston_surface *surface);
393 ivi_layout_set_mapped(struct ivi_surface *surface);
396 ivi_layout_set_position(struct ivi_surface *surface,
397 int32_t x, int32_t y,
398 int32_t width, int32_t height);
401 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
404 ivi_layout_commit(struct ivi_compositor *ivi);
407 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
410 ivi_layout_activate(struct ivi_output *output, const char *app_id);
413 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
416 ivi_layout_desktop_committed(struct ivi_surface *surf);
419 ivi_layout_popup_committed(struct ivi_surface *surface);
422 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
425 ivi_layout_split_committed(struct ivi_surface *surface);
428 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
431 ivi_layout_desktop_resize(struct ivi_surface *surface,
432 struct weston_geometry area);
435 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
438 insert_black_curtain(struct ivi_output *output);
441 remove_black_curtain(struct ivi_output *output);
444 output_has_black_curtain(struct ivi_output *output);
447 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
450 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
454 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
457 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
458 const char *data, uint32_t app_state);
460 ivi_screenshooter_create(struct ivi_compositor *ivi);
463 ivi_seat_init(struct ivi_compositor *ivi);
466 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
469 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
470 struct ivi_surface *surface);
472 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
475 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
476 enum ivi_surface_role *role);
479 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
481 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
484 ivi_shell_finalize(struct ivi_compositor *ivi);
487 get_ivi_shell_surface(struct weston_surface *surface);
489 struct ivi_shell_seat *
490 get_ivi_shell_seat(struct weston_seat *seat);
493 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
496 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
497 struct ivi_shell_seat *ivi_seat,
500 sigchld_handler(int signal_number, void *data);
503 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
504 enum agl_shell_app_state state);