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;
59 * Options parsed from command line arugments.
60 * Overrides what is found in the config file.
64 bool use_current_mode;
70 const struct weston_windowed_output_api *window_api;
71 const struct weston_drm_output_api *drm_api;
72 const struct weston_remoting_api *remoting_api;
73 const struct weston_transmitter_api *waltham_transmitter_api;
75 struct wl_global *agl_shell;
76 struct wl_global *agl_shell_desktop;
79 struct wl_client *client;
80 struct wl_resource *resource;
84 struct wl_list desktop_clients; /* desktop_client::link */
86 struct wl_list outputs; /* ivi_output.link */
87 struct wl_list surfaces; /* ivi_surface.link */
89 struct weston_desktop *desktop;
90 struct wl_listener seat_created_listener;
91 struct ivi_policy *policy;
93 struct wl_list pending_surfaces;
94 struct wl_list popup_pending_apps;
95 struct wl_list fullscreen_pending_apps;
96 struct wl_list split_pending_apps;
97 struct wl_list remote_pending_apps;
99 struct weston_layer hidden;
100 struct weston_layer background;
101 struct weston_layer normal;
102 struct weston_layer panel;
103 struct weston_layer popup;
104 struct weston_layer fullscreen;
109 enum ivi_output_type {
112 /* same as remote but we need to signal the transmitter plug-in
113 * for the surfaces to have to be forwarded to those remoted outputs */
118 struct wl_list link; /* ivi_compositor.outputs */
119 struct ivi_compositor *ivi;
122 struct weston_config_section *config;
123 struct weston_output *output;
125 struct ivi_surface *background;
127 struct ivi_surface *top;
128 struct ivi_surface *bottom;
129 struct ivi_surface *left;
130 struct ivi_surface *right;
132 /* for the black surface */
133 struct fullscreen_view {
134 struct ivi_surface *fs;
135 struct wl_listener fs_destroy;
138 struct wl_listener output_destroy;
141 * Usable area for normal clients, i.e. with panels removed.
142 * In output-coorrdinate space.
144 struct weston_geometry area;
145 struct weston_geometry area_saved;
147 struct ivi_surface *active;
148 struct ivi_surface *previous_active;
150 /* Temporary: only used during configuration */
152 struct weston_head *add[8];
155 enum ivi_output_type type;
158 enum ivi_surface_role {
159 IVI_SURFACE_ROLE_NONE,
160 IVI_SURFACE_ROLE_DESKTOP,
161 IVI_SURFACE_ROLE_BACKGROUND,
162 IVI_SURFACE_ROLE_PANEL,
163 IVI_SURFACE_ROLE_POPUP,
164 IVI_SURFACE_ROLE_FULLSCREEN,
165 IVI_SURFACE_ROLE_SPLIT_V,
166 IVI_SURFACE_ROLE_SPLIT_H,
167 IVI_SURFACE_ROLE_REMOTE,
170 struct ivi_bounding_box {
172 int width; int height;
175 struct pending_popup {
176 struct ivi_output *ioutput;
179 struct ivi_bounding_box bb;
181 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
184 struct pending_fullscreen {
185 struct ivi_output *ioutput;
187 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
190 struct pending_split {
191 struct ivi_output *ioutput;
193 uint32_t orientation;
194 struct wl_list link; /** ivi_compositor::split_pending_apps */
197 struct pending_remote {
198 struct ivi_output *ioutput;
200 struct wl_list link; /** ivi_compositor::remote_pending_apps */
203 struct ivi_desktop_surface {
204 struct ivi_output *pending_output;
205 struct ivi_output *last_output;
208 struct ivi_background_surface {
209 struct ivi_output *output;
212 struct ivi_popup_surface {
213 struct ivi_output *output;
214 int x; int y; /* initial position */
215 struct ivi_bounding_box bb; /* bounding box */
218 struct ivi_fullscreen_surface {
219 struct ivi_output *output;
222 struct ivi_split_surface {
223 struct ivi_output *output;
224 uint32_t orientation;
227 struct ivi_remote_surface {
228 struct ivi_output *output;
231 struct ivi_panel_surface {
232 struct ivi_output *output;
233 enum agl_shell_edge edge;
236 enum ivi_surface_flags {
237 IVI_SURFACE_PROP_MAP = (1 << 0),
238 /* x, y, width, height */
239 IVI_SURFACE_PROP_POSITION = (1 << 1),
243 struct ivi_compositor *ivi;
244 struct weston_desktop_surface *dsurface;
245 struct weston_view *view;
251 enum ivi_surface_flags flags;
253 int32_t width, height;
255 bool activated_by_default;
256 bool advertised_on_launch;
258 enum ivi_surface_role role;
260 struct ivi_desktop_surface desktop;
261 struct ivi_background_surface bg;
262 struct ivi_panel_surface panel;
263 struct ivi_popup_surface popup;
264 struct ivi_fullscreen_surface fullscreen;
265 struct ivi_split_surface split;
266 struct ivi_remote_surface remote;
269 struct wl_listener listener_advertise_app;
270 struct wl_signal signal_advertise_app;
273 struct ivi_shell_client {
279 struct wl_client *client;
281 struct wl_listener client_destroy;
284 struct ivi_compositor *
285 to_ivi_compositor(struct weston_compositor *ec);
289 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
292 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
298 ivi_shell_init(struct ivi_compositor *ivi);
301 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
304 ivi_shell_create_global(struct ivi_compositor *ivi);
307 ivi_launch_shell_client(struct ivi_compositor *ivi);
310 ivi_desktop_init(struct ivi_compositor *ivi);
312 struct ivi_shell_client *
313 ivi_shell_client_from_wl(struct wl_client *client);
316 to_ivi_output(struct weston_output *o);
319 ivi_set_desktop_surface(struct ivi_surface *surface);
322 * removes the pending popup one
325 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
328 ivi_reflow_outputs(struct ivi_compositor *ivi);
331 to_ivi_surface(struct weston_surface *surface);
334 ivi_layout_set_mapped(struct ivi_surface *surface);
337 ivi_layout_set_position(struct ivi_surface *surface,
338 int32_t x, int32_t y,
339 int32_t width, int32_t height);
342 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
345 ivi_layout_commit(struct ivi_compositor *ivi);
348 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
351 ivi_layout_activate(struct ivi_output *output, const char *app_id);
354 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
357 ivi_layout_desktop_committed(struct ivi_surface *surf);
360 ivi_layout_popup_committed(struct ivi_surface *surface);
363 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
366 ivi_layout_split_committed(struct ivi_surface *surface);
369 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
372 ivi_layout_desktop_resize(struct ivi_surface *surface,
373 struct weston_geometry area);
376 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
379 insert_black_surface(struct ivi_output *output);
382 remove_black_surface(struct ivi_output *output);
385 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
388 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
392 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
395 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
396 const char *data, uint32_t app_state);
398 ivi_screenshooter_create(struct ivi_compositor *ivi);
401 ivi_seat_init(struct ivi_compositor *ivi);
404 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
407 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
408 struct ivi_surface *surface);