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;
73 bool activate_apps_by_default; /* switches once xdg top level has been 'created' */
77 struct wl_client *client;
78 struct wl_resource *resource;
82 struct wl_list desktop_clients; /* desktop_client::link */
84 struct wl_list outputs; /* ivi_output.link */
85 struct wl_list surfaces; /* ivi_surface.link */
87 struct weston_desktop *desktop;
88 struct ivi_policy *policy;
90 struct wl_list pending_surfaces;
91 struct wl_list popup_pending_apps;
92 struct wl_list fullscreen_pending_apps;
93 struct wl_list split_pending_apps;
95 struct weston_layer hidden;
96 struct weston_layer background;
97 struct weston_layer normal;
98 struct weston_layer panel;
99 struct weston_layer popup;
100 struct weston_layer fullscreen;
106 struct wl_list link; /* ivi_compositor.outputs */
107 struct ivi_compositor *ivi;
110 struct weston_config_section *config;
111 struct weston_output *output;
113 struct ivi_surface *background;
115 struct ivi_surface *top;
116 struct ivi_surface *bottom;
117 struct ivi_surface *left;
118 struct ivi_surface *right;
120 /* for the black surface */
121 struct fullscreen_view {
122 struct ivi_surface *fs;
123 struct wl_listener fs_destroy;
126 struct wl_listener output_destroy;
129 * Usable area for normal clients, i.e. with panels removed.
130 * In output-coorrdinate space.
132 struct weston_geometry area;
133 struct weston_geometry area_saved;
135 struct ivi_surface *active;
136 struct ivi_surface *previous_active;
138 /* Temporary: only used during configuration */
140 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,
150 IVI_SURFACE_ROLE_SPLIT_V,
151 IVI_SURFACE_ROLE_SPLIT_H,
154 struct pending_popup {
155 struct ivi_output *ioutput;
159 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
162 struct pending_fullscreen {
163 struct ivi_output *ioutput;
165 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
168 struct pending_split {
169 struct ivi_output *ioutput;
171 uint32_t orientation;
172 struct wl_list link; /** ivi_compositor::split_pending_apps */
175 struct ivi_desktop_surface {
176 struct ivi_output *pending_output;
177 struct ivi_output *last_output;
180 struct ivi_background_surface {
181 struct ivi_output *output;
184 struct ivi_popup_surface {
185 struct ivi_output *output;
190 struct ivi_fs_surface {
191 struct ivi_output *output;
194 struct ivi_split_surface {
195 struct ivi_output *output;
196 uint32_t orientation;
199 struct ivi_panel_surface {
200 struct ivi_output *output;
201 enum agl_shell_edge edge;
204 enum ivi_surface_flags {
205 IVI_SURFACE_PROP_MAP = (1 << 0),
206 /* x, y, width, height */
207 IVI_SURFACE_PROP_POSITION = (1 << 1),
211 struct ivi_compositor *ivi;
212 struct weston_desktop_surface *dsurface;
213 struct weston_view *view;
218 enum ivi_surface_flags flags;
220 int32_t width, height;
222 bool activated_by_default;
224 enum ivi_surface_role role;
226 struct ivi_desktop_surface desktop;
227 struct ivi_background_surface bg;
228 struct ivi_panel_surface panel;
229 struct ivi_popup_surface popup;
230 struct ivi_fs_surface fs;
231 struct ivi_split_surface split;
235 struct ivi_shell_client {
241 struct wl_client *client;
243 struct wl_listener client_destroy;
246 struct ivi_compositor *
247 to_ivi_compositor(struct weston_compositor *ec);
251 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
254 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
260 ivi_shell_init(struct ivi_compositor *ivi);
263 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
266 ivi_shell_create_global(struct ivi_compositor *ivi);
269 ivi_launch_shell_client(struct ivi_compositor *ivi);
272 ivi_desktop_init(struct ivi_compositor *ivi);
274 struct ivi_shell_client *
275 ivi_shell_client_from_wl(struct wl_client *client);
278 to_ivi_output(struct weston_output *o);
281 ivi_set_desktop_surface(struct ivi_surface *surface);
284 * removes the pending popup one
287 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
290 ivi_reflow_outputs(struct ivi_compositor *ivi);
293 to_ivi_surface(struct weston_surface *surface);
296 ivi_layout_set_mapped(struct ivi_surface *surface);
299 ivi_layout_set_position(struct ivi_surface *surface,
300 int32_t x, int32_t y,
301 int32_t width, int32_t height);
304 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
307 ivi_layout_commit(struct ivi_compositor *ivi);
310 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
313 ivi_layout_activate(struct ivi_output *output, const char *app_id);
316 ivi_layout_desktop_committed(struct ivi_surface *surf);
319 ivi_layout_panel_committed(struct ivi_surface *surface);
322 ivi_layout_popup_committed(struct ivi_surface *surface);
325 ivi_layout_fs_committed(struct ivi_surface *surface);
328 ivi_layout_split_committed(struct ivi_surface *surface);
331 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
334 ivi_layout_desktop_resize(struct ivi_surface *surface,
335 struct weston_geometry area);