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 struct ivi_compositor {
50 struct weston_compositor *compositor;
51 struct weston_config *config;
53 struct wl_listener heads_changed;
57 bool activate_by_default;
58 bool keep_pending_surfaces;
61 * Options parsed from command line arugments.
62 * Overrides what is found in the config file.
66 bool use_current_mode;
72 const struct weston_windowed_output_api *window_api;
73 const struct weston_drm_output_api *drm_api;
74 const struct weston_remoting_api *remoting_api;
75 const struct weston_transmitter_api *waltham_transmitter_api;
77 struct wl_global *agl_shell;
78 struct wl_global *agl_shell_desktop;
81 struct wl_client *client;
82 struct wl_resource *resource;
86 struct wl_list desktop_clients; /* desktop_client::link */
88 struct wl_list outputs; /* ivi_output.link */
89 struct wl_list surfaces; /* ivi_surface.link */
91 struct weston_desktop *desktop;
92 struct wl_listener seat_created_listener;
93 struct ivi_policy *policy;
95 struct wl_list pending_surfaces;
96 struct wl_list popup_pending_apps;
97 struct wl_list fullscreen_pending_apps;
98 struct wl_list split_pending_apps;
99 struct wl_list remote_pending_apps;
101 struct wl_listener destroy_listener;
103 struct weston_layer hidden;
104 struct weston_layer background;
105 struct weston_layer normal;
106 struct weston_layer panel;
107 struct weston_layer popup;
108 struct weston_layer fullscreen;
113 enum ivi_output_type {
116 /* same as remote but we need to signal the transmitter plug-in
117 * for the surfaces to have to be forwarded to those remoted outputs */
122 struct wl_list link; /* ivi_compositor.outputs */
123 struct ivi_compositor *ivi;
126 struct weston_config_section *config;
127 struct weston_output *output;
129 struct ivi_surface *background;
131 struct ivi_surface *top;
132 struct ivi_surface *bottom;
133 struct ivi_surface *left;
134 struct ivi_surface *right;
136 /* for the black surface */
137 struct fullscreen_view {
138 struct ivi_surface *fs;
139 struct wl_listener fs_destroy;
142 struct wl_listener output_destroy;
145 * Usable area for normal clients, i.e. with panels removed.
146 * In output-coorrdinate space.
148 struct weston_geometry area;
149 struct weston_geometry area_saved;
151 struct ivi_surface *active;
152 struct ivi_surface *previous_active;
154 /* Temporary: only used during configuration */
156 struct weston_head *add[8];
159 enum ivi_output_type type;
162 enum ivi_surface_role {
163 IVI_SURFACE_ROLE_NONE,
164 IVI_SURFACE_ROLE_DESKTOP,
165 IVI_SURFACE_ROLE_BACKGROUND,
166 IVI_SURFACE_ROLE_PANEL,
167 IVI_SURFACE_ROLE_POPUP,
168 IVI_SURFACE_ROLE_FULLSCREEN,
169 IVI_SURFACE_ROLE_SPLIT_V,
170 IVI_SURFACE_ROLE_SPLIT_H,
171 IVI_SURFACE_ROLE_REMOTE,
174 struct ivi_bounding_box {
176 int width; int height;
179 struct pending_popup {
180 struct ivi_output *ioutput;
183 struct ivi_bounding_box bb;
185 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
188 struct pending_fullscreen {
189 struct ivi_output *ioutput;
191 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
194 struct pending_split {
195 struct ivi_output *ioutput;
197 uint32_t orientation;
198 struct wl_list link; /** ivi_compositor::split_pending_apps */
201 struct pending_remote {
202 struct ivi_output *ioutput;
204 struct wl_list link; /** ivi_compositor::remote_pending_apps */
207 struct ivi_desktop_surface {
208 struct ivi_output *pending_output;
209 struct ivi_output *last_output;
212 struct ivi_background_surface {
213 struct ivi_output *output;
216 struct ivi_popup_surface {
217 struct ivi_output *output;
218 int x; int y; /* initial position */
219 struct ivi_bounding_box bb; /* bounding box */
222 struct ivi_fullscreen_surface {
223 struct ivi_output *output;
226 struct ivi_split_surface {
227 struct ivi_output *output;
228 uint32_t orientation;
231 struct ivi_remote_surface {
232 struct ivi_output *output;
235 struct ivi_panel_surface {
236 struct ivi_output *output;
237 enum agl_shell_edge edge;
240 enum ivi_surface_flags {
241 IVI_SURFACE_PROP_MAP = (1 << 0),
242 /* x, y, width, height */
243 IVI_SURFACE_PROP_POSITION = (1 << 1),
246 /* the waltham surface is a pointer type as well and
247 * in order to avoid adding ifdef for waltham use a
248 * generic pointer, which will be only be valid when the
249 * surface is a remote out on a waltham type of output */
250 struct ivi_surface_waltham {
251 void *transmitter_surface;
255 struct ivi_compositor *ivi;
256 struct weston_desktop_surface *dsurface;
257 struct weston_view *view;
263 enum ivi_surface_flags flags;
265 int32_t width, height;
268 bool advertised_on_launch;
269 bool checked_pending;
276 enum ivi_surface_role role;
278 struct ivi_desktop_surface desktop;
279 struct ivi_background_surface bg;
280 struct ivi_panel_surface panel;
281 struct ivi_popup_surface popup;
282 struct ivi_fullscreen_surface fullscreen;
283 struct ivi_split_surface split;
284 struct ivi_remote_surface remote;
287 struct ivi_surface_waltham waltham_surface;
288 struct wl_listener listener_advertise_app;
289 struct wl_signal signal_advertise_app;
292 struct ivi_shell_seat {
293 struct weston_seat *seat;
294 struct weston_surface *focused_surface;
299 struct wl_listener seat_destroy_listener;
300 struct wl_listener caps_changed_listener;
301 struct wl_listener keyboard_focus_listener;
302 struct wl_listener pointer_focus_listener;
305 struct ivi_shell_client {
311 struct wl_client *client;
313 struct wl_listener client_destroy;
316 struct ivi_compositor *
317 to_ivi_compositor(struct weston_compositor *ec);
321 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
324 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
330 ivi_shell_init(struct ivi_compositor *ivi);
333 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
336 ivi_shell_create_global(struct ivi_compositor *ivi);
339 ivi_launch_shell_client(struct ivi_compositor *ivi);
342 ivi_desktop_init(struct ivi_compositor *ivi);
344 struct ivi_shell_client *
345 ivi_shell_client_from_wl(struct wl_client *client);
348 to_ivi_output(struct weston_output *o);
351 ivi_set_desktop_surface(struct ivi_surface *surface);
354 * removes the pending popup one
357 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
360 ivi_reflow_outputs(struct ivi_compositor *ivi);
363 to_ivi_surface(struct weston_surface *surface);
366 ivi_layout_set_mapped(struct ivi_surface *surface);
369 ivi_layout_set_position(struct ivi_surface *surface,
370 int32_t x, int32_t y,
371 int32_t width, int32_t height);
374 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
377 ivi_layout_commit(struct ivi_compositor *ivi);
380 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
383 ivi_layout_activate(struct ivi_output *output, const char *app_id);
386 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
389 ivi_layout_desktop_committed(struct ivi_surface *surf);
392 ivi_layout_popup_committed(struct ivi_surface *surface);
395 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
398 ivi_layout_split_committed(struct ivi_surface *surface);
401 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
404 ivi_layout_desktop_resize(struct ivi_surface *surface,
405 struct weston_geometry area);
408 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
411 insert_black_surface(struct ivi_output *output);
414 remove_black_surface(struct ivi_output *output);
417 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
420 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
424 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
427 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
428 const char *data, uint32_t app_state);
430 ivi_screenshooter_create(struct ivi_compositor *ivi);
433 ivi_seat_init(struct ivi_compositor *ivi);
436 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
439 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
440 struct ivi_surface *surface);
442 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
445 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
446 enum ivi_surface_role *role);
449 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
451 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
454 ivi_shell_finalize(struct ivi_compositor *ivi);
457 get_ivi_shell_surface(struct weston_surface *surface);
459 struct ivi_shell_seat *
460 get_ivi_shell_seat(struct weston_seat *seat);
463 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);