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;
58 * Options parsed from command line arugments.
59 * Overrides what is found in the config file.
63 bool use_current_mode;
69 const struct weston_windowed_output_api *window_api;
70 const struct weston_drm_output_api *drm_api;
71 const struct weston_remoting_api *remoting_api;
73 struct wl_global *agl_shell;
74 struct wl_global *agl_shell_desktop;
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;
94 struct wl_list remote_pending_apps;
96 struct weston_layer hidden;
97 struct weston_layer background;
98 struct weston_layer normal;
99 struct weston_layer panel;
100 struct weston_layer popup;
101 struct weston_layer fullscreen;
107 struct wl_list link; /* ivi_compositor.outputs */
108 struct ivi_compositor *ivi;
111 struct weston_config_section *config;
112 struct weston_output *output;
114 struct ivi_surface *background;
116 struct ivi_surface *top;
117 struct ivi_surface *bottom;
118 struct ivi_surface *left;
119 struct ivi_surface *right;
121 /* for the black surface */
122 struct fullscreen_view {
123 struct ivi_surface *fs;
124 struct wl_listener fs_destroy;
127 struct wl_listener output_destroy;
130 * Usable area for normal clients, i.e. with panels removed.
131 * In output-coorrdinate space.
133 struct weston_geometry area;
134 struct weston_geometry area_saved;
136 struct ivi_surface *active;
137 struct ivi_surface *previous_active;
139 /* Temporary: only used during configuration */
141 struct weston_head *add[8];
146 enum ivi_surface_role {
147 IVI_SURFACE_ROLE_NONE,
148 IVI_SURFACE_ROLE_DESKTOP,
149 IVI_SURFACE_ROLE_BACKGROUND,
150 IVI_SURFACE_ROLE_PANEL,
151 IVI_SURFACE_ROLE_POPUP,
152 IVI_SURFACE_ROLE_FULLSCREEN,
153 IVI_SURFACE_ROLE_SPLIT_V,
154 IVI_SURFACE_ROLE_SPLIT_H,
155 IVI_SURFACE_ROLE_REMOTE,
158 struct pending_popup {
159 struct ivi_output *ioutput;
163 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
166 struct pending_fullscreen {
167 struct ivi_output *ioutput;
169 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
172 struct pending_split {
173 struct ivi_output *ioutput;
175 uint32_t orientation;
176 struct wl_list link; /** ivi_compositor::split_pending_apps */
179 struct pending_remote {
180 struct ivi_output *ioutput;
182 struct wl_list link; /** ivi_compositor::remote_pending_apps */
185 struct ivi_desktop_surface {
186 struct ivi_output *pending_output;
187 struct ivi_output *last_output;
190 struct ivi_background_surface {
191 struct ivi_output *output;
194 struct ivi_popup_surface {
195 struct ivi_output *output;
200 struct ivi_fullscreen_surface {
201 struct ivi_output *output;
204 struct ivi_split_surface {
205 struct ivi_output *output;
206 uint32_t orientation;
209 struct ivi_remote_surface {
210 struct ivi_output *output;
213 struct ivi_panel_surface {
214 struct ivi_output *output;
215 enum agl_shell_edge edge;
218 enum ivi_surface_flags {
219 IVI_SURFACE_PROP_MAP = (1 << 0),
220 /* x, y, width, height */
221 IVI_SURFACE_PROP_POSITION = (1 << 1),
225 struct ivi_compositor *ivi;
226 struct weston_desktop_surface *dsurface;
227 struct weston_view *view;
232 enum ivi_surface_flags flags;
234 int32_t width, height;
236 bool activated_by_default;
238 enum ivi_surface_role role;
240 struct ivi_desktop_surface desktop;
241 struct ivi_background_surface bg;
242 struct ivi_panel_surface panel;
243 struct ivi_popup_surface popup;
244 struct ivi_fullscreen_surface fullscreen;
245 struct ivi_split_surface split;
246 struct ivi_remote_surface remote;
250 struct ivi_shell_client {
256 struct wl_client *client;
258 struct wl_listener client_destroy;
261 struct ivi_compositor *
262 to_ivi_compositor(struct weston_compositor *ec);
266 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
269 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
275 ivi_shell_init(struct ivi_compositor *ivi);
278 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
281 ivi_shell_create_global(struct ivi_compositor *ivi);
284 ivi_launch_shell_client(struct ivi_compositor *ivi);
287 ivi_desktop_init(struct ivi_compositor *ivi);
289 struct ivi_shell_client *
290 ivi_shell_client_from_wl(struct wl_client *client);
293 to_ivi_output(struct weston_output *o);
296 ivi_set_desktop_surface(struct ivi_surface *surface);
299 * removes the pending popup one
302 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
305 ivi_reflow_outputs(struct ivi_compositor *ivi);
308 to_ivi_surface(struct weston_surface *surface);
311 ivi_layout_set_mapped(struct ivi_surface *surface);
314 ivi_layout_set_position(struct ivi_surface *surface,
315 int32_t x, int32_t y,
316 int32_t width, int32_t height);
319 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
322 ivi_layout_commit(struct ivi_compositor *ivi);
325 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
328 ivi_layout_activate(struct ivi_output *output, const char *app_id);
331 ivi_layout_desktop_committed(struct ivi_surface *surf);
334 ivi_layout_popup_committed(struct ivi_surface *surface);
337 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
340 ivi_layout_split_committed(struct ivi_surface *surface);
343 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
346 ivi_layout_desktop_resize(struct ivi_surface *surface,
347 struct weston_geometry area);
350 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
353 insert_black_surface(struct ivi_output *output);
356 remove_black_surface(struct ivi_output *output);
359 ivi_layout_get_surface_role_name(struct ivi_surface *surf);