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;
74 struct wl_global *agl_shell;
75 struct wl_global *agl_shell_desktop;
78 struct wl_client *client;
79 struct wl_resource *resource;
83 struct wl_list desktop_clients; /* desktop_client::link */
85 struct wl_list outputs; /* ivi_output.link */
86 struct wl_list surfaces; /* ivi_surface.link */
88 struct weston_desktop *desktop;
89 struct wl_listener seat_created_listener;
90 struct ivi_policy *policy;
92 struct wl_list pending_surfaces;
93 struct wl_list popup_pending_apps;
94 struct wl_list fullscreen_pending_apps;
95 struct wl_list split_pending_apps;
96 struct wl_list remote_pending_apps;
98 struct weston_layer hidden;
99 struct weston_layer background;
100 struct weston_layer normal;
101 struct weston_layer panel;
102 struct weston_layer popup;
103 struct weston_layer fullscreen;
109 struct wl_list link; /* ivi_compositor.outputs */
110 struct ivi_compositor *ivi;
113 struct weston_config_section *config;
114 struct weston_output *output;
116 struct ivi_surface *background;
118 struct ivi_surface *top;
119 struct ivi_surface *bottom;
120 struct ivi_surface *left;
121 struct ivi_surface *right;
123 /* for the black surface */
124 struct fullscreen_view {
125 struct ivi_surface *fs;
126 struct wl_listener fs_destroy;
129 struct wl_listener output_destroy;
132 * Usable area for normal clients, i.e. with panels removed.
133 * In output-coorrdinate space.
135 struct weston_geometry area;
136 struct weston_geometry area_saved;
138 struct ivi_surface *active;
139 struct ivi_surface *previous_active;
141 /* Temporary: only used during configuration */
143 struct weston_head *add[8];
148 enum ivi_surface_role {
149 IVI_SURFACE_ROLE_NONE,
150 IVI_SURFACE_ROLE_DESKTOP,
151 IVI_SURFACE_ROLE_BACKGROUND,
152 IVI_SURFACE_ROLE_PANEL,
153 IVI_SURFACE_ROLE_POPUP,
154 IVI_SURFACE_ROLE_FULLSCREEN,
155 IVI_SURFACE_ROLE_SPLIT_V,
156 IVI_SURFACE_ROLE_SPLIT_H,
157 IVI_SURFACE_ROLE_REMOTE,
160 struct ivi_bounding_box {
162 int width; int height;
165 struct pending_popup {
166 struct ivi_output *ioutput;
169 struct ivi_bounding_box bb;
171 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
174 struct pending_fullscreen {
175 struct ivi_output *ioutput;
177 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
180 struct pending_split {
181 struct ivi_output *ioutput;
183 uint32_t orientation;
184 struct wl_list link; /** ivi_compositor::split_pending_apps */
187 struct pending_remote {
188 struct ivi_output *ioutput;
190 struct wl_list link; /** ivi_compositor::remote_pending_apps */
193 struct ivi_desktop_surface {
194 struct ivi_output *pending_output;
195 struct ivi_output *last_output;
198 struct ivi_background_surface {
199 struct ivi_output *output;
202 struct ivi_popup_surface {
203 struct ivi_output *output;
204 int x; int y; /* initial position */
205 struct ivi_bounding_box bb; /* bounding box */
208 struct ivi_fullscreen_surface {
209 struct ivi_output *output;
212 struct ivi_split_surface {
213 struct ivi_output *output;
214 uint32_t orientation;
217 struct ivi_remote_surface {
218 struct ivi_output *output;
221 struct ivi_panel_surface {
222 struct ivi_output *output;
223 enum agl_shell_edge edge;
226 enum ivi_surface_flags {
227 IVI_SURFACE_PROP_MAP = (1 << 0),
228 /* x, y, width, height */
229 IVI_SURFACE_PROP_POSITION = (1 << 1),
233 struct ivi_compositor *ivi;
234 struct weston_desktop_surface *dsurface;
235 struct weston_view *view;
241 enum ivi_surface_flags flags;
243 int32_t width, height;
245 bool activated_by_default;
247 enum ivi_surface_role role;
249 struct ivi_desktop_surface desktop;
250 struct ivi_background_surface bg;
251 struct ivi_panel_surface panel;
252 struct ivi_popup_surface popup;
253 struct ivi_fullscreen_surface fullscreen;
254 struct ivi_split_surface split;
255 struct ivi_remote_surface remote;
259 struct ivi_shell_client {
265 struct wl_client *client;
267 struct wl_listener client_destroy;
270 struct ivi_compositor *
271 to_ivi_compositor(struct weston_compositor *ec);
275 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
278 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
284 ivi_shell_init(struct ivi_compositor *ivi);
287 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
290 ivi_shell_create_global(struct ivi_compositor *ivi);
293 ivi_launch_shell_client(struct ivi_compositor *ivi);
296 ivi_desktop_init(struct ivi_compositor *ivi);
298 struct ivi_shell_client *
299 ivi_shell_client_from_wl(struct wl_client *client);
302 to_ivi_output(struct weston_output *o);
305 ivi_set_desktop_surface(struct ivi_surface *surface);
308 * removes the pending popup one
311 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
314 ivi_reflow_outputs(struct ivi_compositor *ivi);
317 to_ivi_surface(struct weston_surface *surface);
320 ivi_layout_set_mapped(struct ivi_surface *surface);
323 ivi_layout_set_position(struct ivi_surface *surface,
324 int32_t x, int32_t y,
325 int32_t width, int32_t height);
328 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
331 ivi_layout_commit(struct ivi_compositor *ivi);
334 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
337 ivi_layout_activate(struct ivi_output *output, const char *app_id);
340 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
343 ivi_layout_desktop_committed(struct ivi_surface *surf);
346 ivi_layout_popup_committed(struct ivi_surface *surface);
349 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
352 ivi_layout_split_committed(struct ivi_surface *surface);
355 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
358 ivi_layout_desktop_resize(struct ivi_surface *surface,
359 struct weston_geometry area);
362 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
365 insert_black_surface(struct ivi_output *output);
368 remove_black_surface(struct ivi_output *output);
371 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
374 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
378 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
381 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
382 const char *data, uint32_t app_state);
384 ivi_screenshooter_create(struct ivi_compositor *ivi);
387 ivi_seat_init(struct ivi_compositor *ivi);
390 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);