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>
37 #include "agl-shell-server-protocol.h"
39 struct ivi_compositor;
41 struct desktop_client {
42 struct wl_resource *resource;
43 struct ivi_compositor *ivi;
44 struct wl_list link; /* ivi_compositor::desktop_clients */
47 struct ivi_compositor {
48 struct weston_compositor *compositor;
49 struct weston_config *config;
51 struct wl_listener heads_changed;
56 * Options parsed from command line arugments.
57 * Overrides what is found in the config file.
61 bool use_current_mode;
67 const struct weston_windowed_output_api *window_api;
68 const struct weston_drm_output_api *drm_api;
70 struct wl_global *agl_shell;
71 struct wl_global *agl_shell_desktop;
74 struct wl_client *client;
75 struct wl_resource *resource;
79 struct wl_list desktop_clients; /* desktop_client::link */
81 struct wl_list outputs; /* ivi_output.link */
82 struct wl_list surfaces; /* ivi_surface.link */
84 struct weston_desktop *desktop;
85 struct ivi_policy *policy;
87 struct wl_list pending_surfaces;
88 struct wl_list popup_pending_apps;
89 struct wl_list fullscreen_pending_apps;
90 struct wl_list split_pending_apps;
91 struct wl_list remote_pending_apps;
93 struct weston_layer hidden;
94 struct weston_layer background;
95 struct weston_layer normal;
96 struct weston_layer panel;
97 struct weston_layer popup;
98 struct weston_layer fullscreen;
104 struct wl_list link; /* ivi_compositor.outputs */
105 struct ivi_compositor *ivi;
108 struct weston_config_section *config;
109 struct weston_output *output;
111 struct ivi_surface *background;
113 struct ivi_surface *top;
114 struct ivi_surface *bottom;
115 struct ivi_surface *left;
116 struct ivi_surface *right;
118 /* for the black surface */
119 struct fullscreen_view {
120 struct ivi_surface *fs;
121 struct wl_listener fs_destroy;
124 struct wl_listener output_destroy;
127 * Usable area for normal clients, i.e. with panels removed.
128 * In output-coorrdinate space.
130 struct weston_geometry area;
131 struct weston_geometry area_saved;
133 struct ivi_surface *active;
134 struct ivi_surface *previous_active;
136 /* Temporary: only used during configuration */
138 struct weston_head *add[8];
143 enum ivi_surface_role {
144 IVI_SURFACE_ROLE_NONE,
145 IVI_SURFACE_ROLE_DESKTOP,
146 IVI_SURFACE_ROLE_BACKGROUND,
147 IVI_SURFACE_ROLE_PANEL,
148 IVI_SURFACE_ROLE_POPUP,
149 IVI_SURFACE_ROLE_FULLSCREEN,
150 IVI_SURFACE_ROLE_SPLIT_V,
151 IVI_SURFACE_ROLE_SPLIT_H,
152 IVI_SURFACE_ROLE_REMOTE,
155 struct pending_popup {
156 struct ivi_output *ioutput;
160 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
163 struct pending_fullscreen {
164 struct ivi_output *ioutput;
166 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
169 struct pending_split {
170 struct ivi_output *ioutput;
172 uint32_t orientation;
173 struct wl_list link; /** ivi_compositor::split_pending_apps */
176 struct pending_remote {
177 struct ivi_output *ioutput;
179 struct wl_list link; /** ivi_compositor::remote_pending_apps */
182 struct ivi_desktop_surface {
183 struct ivi_output *pending_output;
184 struct ivi_output *last_output;
187 struct ivi_background_surface {
188 struct ivi_output *output;
191 struct ivi_popup_surface {
192 struct ivi_output *output;
197 struct ivi_fullscreen_surface {
198 struct ivi_output *output;
201 struct ivi_split_surface {
202 struct ivi_output *output;
203 uint32_t orientation;
206 struct ivi_remote_surface {
207 struct ivi_output *output;
210 struct ivi_panel_surface {
211 struct ivi_output *output;
212 enum agl_shell_edge edge;
215 enum ivi_surface_flags {
216 IVI_SURFACE_PROP_MAP = (1 << 0),
217 /* x, y, width, height */
218 IVI_SURFACE_PROP_POSITION = (1 << 1),
222 struct ivi_compositor *ivi;
223 struct weston_desktop_surface *dsurface;
224 struct weston_view *view;
229 enum ivi_surface_flags flags;
231 int32_t width, height;
233 bool activated_by_default;
235 enum ivi_surface_role role;
237 struct ivi_desktop_surface desktop;
238 struct ivi_background_surface bg;
239 struct ivi_panel_surface panel;
240 struct ivi_popup_surface popup;
241 struct ivi_fullscreen_surface fullscreen;
242 struct ivi_split_surface split;
243 struct ivi_remote_surface remote;
247 struct ivi_shell_client {
253 struct wl_client *client;
255 struct wl_listener client_destroy;
258 struct ivi_compositor *
259 to_ivi_compositor(struct weston_compositor *ec);
263 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
266 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
272 ivi_shell_init(struct ivi_compositor *ivi);
275 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
278 ivi_shell_create_global(struct ivi_compositor *ivi);
281 ivi_launch_shell_client(struct ivi_compositor *ivi);
284 ivi_desktop_init(struct ivi_compositor *ivi);
286 struct ivi_shell_client *
287 ivi_shell_client_from_wl(struct wl_client *client);
290 to_ivi_output(struct weston_output *o);
293 ivi_set_desktop_surface(struct ivi_surface *surface);
296 * removes the pending popup one
299 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
302 ivi_reflow_outputs(struct ivi_compositor *ivi);
305 to_ivi_surface(struct weston_surface *surface);
308 ivi_layout_set_mapped(struct ivi_surface *surface);
311 ivi_layout_set_position(struct ivi_surface *surface,
312 int32_t x, int32_t y,
313 int32_t width, int32_t height);
316 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
319 ivi_layout_commit(struct ivi_compositor *ivi);
322 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
325 ivi_layout_activate(struct ivi_output *output, const char *app_id);
328 ivi_layout_desktop_committed(struct ivi_surface *surf);
331 ivi_layout_popup_committed(struct ivi_surface *surface);
334 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
337 ivi_layout_split_committed(struct ivi_surface *surface);
340 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
343 ivi_layout_desktop_resize(struct ivi_surface *surface,
344 struct weston_geometry area);
347 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
350 insert_black_surface(struct ivi_output *output);
353 remove_black_surface(struct ivi_output *output);
356 ivi_layout_get_surface_role_name(struct ivi_surface *surf);