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;
86 struct wl_client *client;
87 struct wl_resource *resource;
89 enum agl_shell_bound_status status;
92 struct wl_list desktop_clients; /* desktop_client::link */
94 struct wl_list outputs; /* ivi_output.link */
95 struct wl_list surfaces; /* ivi_surface.link */
97 struct weston_desktop *desktop;
98 struct wl_listener seat_created_listener;
99 struct ivi_policy *policy;
101 struct wl_list pending_surfaces;
102 struct wl_list popup_pending_apps;
103 struct wl_list fullscreen_pending_apps;
104 struct wl_list split_pending_apps;
105 struct wl_list remote_pending_apps;
107 struct wl_list pending_apps; /** pending_app::link */
109 struct wl_listener destroy_listener;
111 struct weston_layer hidden;
112 struct weston_layer background;
113 struct weston_layer normal;
114 struct weston_layer panel;
115 struct weston_layer popup;
116 struct weston_layer fullscreen;
121 enum ivi_output_type {
124 /* same as remote but we need to signal the transmitter plug-in
125 * for the surfaces to have to be forwarded to those remoted outputs */
130 struct wl_list link; /* ivi_compositor.outputs */
131 struct ivi_compositor *ivi;
134 struct weston_config_section *config;
135 struct weston_output *output;
137 struct ivi_surface *background;
139 struct ivi_surface *top;
140 struct ivi_surface *bottom;
141 struct ivi_surface *left;
142 struct ivi_surface *right;
144 /* for the black surface */
145 struct fullscreen_view {
146 struct ivi_surface *fs;
147 struct wl_listener fs_destroy;
150 struct wl_listener output_destroy;
153 * Usable area for normal clients, i.e. with panels removed.
154 * In output-coorrdinate space.
156 struct weston_geometry area;
157 struct weston_geometry area_saved;
159 struct ivi_surface *active;
160 struct ivi_surface *previous_active;
162 /* Temporary: only used during configuration */
164 struct weston_head *add[8];
167 enum ivi_output_type type;
170 enum ivi_surface_role {
171 IVI_SURFACE_ROLE_NONE,
172 IVI_SURFACE_ROLE_DESKTOP,
173 IVI_SURFACE_ROLE_BACKGROUND,
174 IVI_SURFACE_ROLE_PANEL,
175 IVI_SURFACE_ROLE_POPUP,
176 IVI_SURFACE_ROLE_FULLSCREEN,
177 IVI_SURFACE_ROLE_SPLIT_V,
178 IVI_SURFACE_ROLE_SPLIT_H,
179 IVI_SURFACE_ROLE_REMOTE,
180 IVI_SURFACE_ROLE_TILE,
183 struct ivi_bounding_box {
185 int width; int height;
189 struct ivi_output *ioutput;
190 enum ivi_surface_role role;
192 struct wl_list link; /** ivi_compositor::pending_apps */
195 struct pending_app_tile {
196 struct pending_app base;
197 uint32_t orientation;
200 struct pending_popup {
201 struct ivi_output *ioutput;
204 struct ivi_bounding_box bb;
206 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
209 struct pending_fullscreen {
210 struct ivi_output *ioutput;
212 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
215 struct pending_split {
216 struct ivi_output *ioutput;
218 uint32_t orientation;
219 struct wl_list link; /** ivi_compositor::split_pending_apps */
222 struct pending_remote {
223 struct ivi_output *ioutput;
225 struct wl_list link; /** ivi_compositor::remote_pending_apps */
228 struct ivi_desktop_surface {
229 struct ivi_output *pending_output;
230 struct ivi_output *last_output;
233 struct ivi_background_surface {
234 struct ivi_output *output;
237 struct ivi_popup_surface {
238 struct ivi_output *output;
239 int x; int y; /* initial position */
240 struct ivi_bounding_box bb; /* bounding box */
243 struct ivi_fullscreen_surface {
244 struct ivi_output *output;
247 struct ivi_split_surface {
248 struct ivi_output *output;
249 uint32_t orientation;
252 struct ivi_remote_surface {
253 struct ivi_output *output;
256 struct ivi_panel_surface {
257 struct ivi_output *output;
258 enum agl_shell_edge edge;
261 enum ivi_surface_flags {
262 IVI_SURFACE_PROP_MAP = (1 << 0),
263 /* x, y, width, height */
264 IVI_SURFACE_PROP_POSITION = (1 << 1),
267 /* the waltham surface is a pointer type as well and
268 * in order to avoid adding ifdef for waltham use a
269 * generic pointer, which will be only be valid when the
270 * surface is a remote out on a waltham type of output */
271 struct ivi_surface_waltham {
272 void *transmitter_surface;
276 struct ivi_compositor *ivi;
277 struct weston_desktop_surface *dsurface;
278 struct weston_view *view;
284 enum ivi_surface_flags flags;
286 int32_t width, height;
289 bool advertised_on_launch;
290 bool checked_pending;
298 uint32_t orientation;
300 enum ivi_surface_role role;
302 struct ivi_desktop_surface desktop;
303 struct ivi_background_surface bg;
304 struct ivi_panel_surface panel;
305 struct ivi_popup_surface popup;
306 struct ivi_fullscreen_surface fullscreen;
307 struct ivi_split_surface split;
308 struct ivi_remote_surface remote;
311 struct ivi_surface_waltham waltham_surface;
312 struct wl_listener listener_advertise_app;
313 struct wl_signal signal_advertise_app;
316 struct ivi_shell_seat {
317 struct weston_seat *seat;
318 struct weston_surface *focused_surface;
323 struct wl_listener seat_destroy_listener;
324 struct wl_listener caps_changed_listener;
325 struct wl_listener keyboard_focus_listener;
326 struct wl_listener pointer_focus_listener;
329 struct ivi_shell_client {
335 struct wl_client *client;
337 struct wl_listener client_destroy;
340 struct ivi_compositor *
341 to_ivi_compositor(struct weston_compositor *ec);
345 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
348 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
354 ivi_shell_init(struct ivi_compositor *ivi);
357 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
360 ivi_shell_create_global(struct ivi_compositor *ivi);
363 ivi_launch_shell_client(struct ivi_compositor *ivi);
366 ivi_desktop_init(struct ivi_compositor *ivi);
368 struct ivi_shell_client *
369 ivi_shell_client_from_wl(struct wl_client *client);
372 to_ivi_output(struct weston_output *o);
375 ivi_set_desktop_surface(struct ivi_surface *surface);
378 * removes the pending popup one
381 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
384 ivi_reflow_outputs(struct ivi_compositor *ivi);
387 to_ivi_surface(struct weston_surface *surface);
390 ivi_layout_set_mapped(struct ivi_surface *surface);
393 ivi_layout_set_position(struct ivi_surface *surface,
394 int32_t x, int32_t y,
395 int32_t width, int32_t height);
398 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
401 ivi_layout_commit(struct ivi_compositor *ivi);
404 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
407 ivi_layout_activate(struct ivi_output *output, const char *app_id);
410 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
413 ivi_layout_desktop_committed(struct ivi_surface *surf);
416 ivi_layout_popup_committed(struct ivi_surface *surface);
419 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
422 ivi_layout_split_committed(struct ivi_surface *surface);
425 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
428 ivi_layout_desktop_resize(struct ivi_surface *surface,
429 struct weston_geometry area);
432 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
435 insert_black_surface(struct ivi_output *output);
438 remove_black_surface(struct ivi_output *output);
441 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
444 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
448 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
451 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
452 const char *data, uint32_t app_state);
454 ivi_screenshooter_create(struct ivi_compositor *ivi);
457 ivi_seat_init(struct ivi_compositor *ivi);
460 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
463 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
464 struct ivi_surface *surface);
466 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
469 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
470 enum ivi_surface_role *role);
473 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
475 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
478 ivi_shell_finalize(struct ivi_compositor *ivi);
481 get_ivi_shell_surface(struct weston_surface *surface);
483 struct ivi_shell_seat *
484 get_ivi_shell_seat(struct weston_seat *seat);
487 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
490 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
491 struct ivi_shell_seat *ivi_seat,