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
33 #include <libweston/backend-drm.h>
34 #include <libweston/libweston.h>
35 #include <libweston/windowed-output-api.h>
36 #include <libweston/desktop.h>
40 #include "agl-shell-server-protocol.h"
42 struct ivi_compositor;
44 struct desktop_client {
45 struct wl_resource *resource;
46 struct ivi_compositor *ivi;
47 struct wl_list link; /* ivi_compositor::desktop_clients */
50 enum agl_shell_bound_status {
55 struct ivi_output_config {
62 struct ivi_compositor {
63 struct weston_compositor *compositor;
64 struct weston_backend *backend;
65 struct weston_config *config;
66 struct ivi_output_config *parsed_options;
68 struct wl_listener heads_changed;
69 int (*simple_output_configure)(struct weston_output *output);
73 bool activate_by_default;
74 bool keep_pending_surfaces;
77 * Options parsed from command line arugments.
78 * Overrides what is found in the config file.
82 bool use_current_mode;
88 const struct weston_windowed_output_api *window_api;
89 const struct weston_drm_output_api *drm_api;
90 const struct weston_remoting_api *remoting_api;
92 struct wl_global *agl_shell;
93 struct wl_global *agl_shell_desktop;
94 struct wl_global *agl_shell_ext;
97 struct wl_client *client;
98 struct wl_resource *resource;
100 /* this is for another agl-shell client, potentially used by
102 struct wl_resource *resource_ext;
104 enum agl_shell_bound_status status;
108 struct wl_client *client;
109 struct wl_resource *resource;
111 bool doas_requested_pending_bind;
112 enum agl_shell_bound_status status;
115 struct wl_list desktop_clients; /* desktop_client::link */
117 struct wl_list outputs; /* ivi_output.link */
118 struct wl_list saved_outputs; /* ivi_output.link */
119 struct wl_list surfaces; /* ivi_surface.link */
121 struct weston_desktop *desktop;
122 struct wl_listener seat_created_listener;
123 struct ivi_policy *policy;
125 struct wl_list pending_surfaces;
126 struct wl_list popup_pending_apps;
127 struct wl_list fullscreen_pending_apps;
128 struct wl_list split_pending_apps;
129 struct wl_list remote_pending_apps;
131 struct wl_list pending_apps; /** pending_app::link */
133 struct wl_listener destroy_listener;
134 struct wl_listener transform_listener;
135 const struct weston_xwayland_surface_api *xwayland_surface_api;
137 struct weston_layer hidden;
138 struct weston_layer background;
139 struct weston_layer normal;
140 struct weston_layer panel;
141 struct weston_layer popup;
142 struct weston_layer fullscreen;
144 bool need_ivi_output_relayout;
145 struct wl_list child_process_list;
150 enum ivi_output_type {
156 struct wl_list link; /* ivi_compositor.outputs */
157 struct ivi_compositor *ivi;
160 struct weston_config_section *config;
161 struct weston_output *output;
163 struct ivi_surface *background;
165 struct ivi_surface *top;
166 struct ivi_surface *bottom;
167 struct ivi_surface *left;
168 struct ivi_surface *right;
170 /* for the black surface */
171 struct fullscreen_view {
172 struct ivi_surface *fs;
173 struct wl_listener fs_destroy;
174 struct weston_buffer_reference *buffer_ref;
177 struct wl_listener output_destroy;
180 * Usable area for normal clients, i.e. with panels removed.
181 * In output-coorrdinate space.
183 struct weston_geometry area;
184 struct weston_geometry area_saved;
186 * Potential user-specified non-default activation area
188 struct weston_geometry area_activation;
190 struct ivi_surface *active;
191 struct ivi_surface *previous_active;
193 /* Temporary: only used during configuration */
195 struct weston_head *add[8];
198 enum ivi_output_type type;
201 enum ivi_surface_role {
202 IVI_SURFACE_ROLE_NONE,
203 IVI_SURFACE_ROLE_DESKTOP,
204 IVI_SURFACE_ROLE_BACKGROUND,
205 IVI_SURFACE_ROLE_PANEL,
206 IVI_SURFACE_ROLE_POPUP,
207 IVI_SURFACE_ROLE_FULLSCREEN,
208 IVI_SURFACE_ROLE_SPLIT_V,
209 IVI_SURFACE_ROLE_SPLIT_H,
210 IVI_SURFACE_ROLE_REMOTE,
211 IVI_SURFACE_ROLE_TILE,
214 struct ivi_bounding_box {
216 int width; int height;
219 struct pending_popup {
220 struct ivi_output *ioutput;
223 struct ivi_bounding_box bb;
225 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
228 struct pending_fullscreen {
229 struct ivi_output *ioutput;
231 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
234 struct pending_split {
235 struct ivi_output *ioutput;
237 uint32_t orientation;
238 struct wl_list link; /** ivi_compositor::split_pending_apps */
241 struct pending_remote {
242 struct ivi_output *ioutput;
244 struct wl_list link; /** ivi_compositor::remote_pending_apps */
248 struct ivi_output *ioutput;
249 enum ivi_surface_role role;
251 struct wl_list link; /** ivi_compositor::pending_apps */
254 struct pending_app_tile {
255 struct pending_app base;
256 uint32_t orientation;
261 struct ivi_desktop_surface {
262 struct ivi_output *pending_output;
263 struct ivi_output *last_output;
266 struct ivi_background_surface {
267 struct ivi_output *output;
270 struct ivi_popup_surface {
271 struct ivi_output *output;
272 int x; int y; /* initial position */
273 struct ivi_bounding_box bb; /* bounding box */
276 struct ivi_fullscreen_surface {
277 struct ivi_output *output;
280 struct ivi_split_surface {
281 struct ivi_output *output;
282 uint32_t orientation;
285 struct ivi_remote_surface {
286 struct ivi_output *output;
289 struct ivi_panel_surface {
290 struct ivi_output *output;
291 enum agl_shell_edge edge;
294 enum ivi_surface_flags {
295 IVI_SURFACE_PROP_MAP = (1 << 0),
296 /* x, y, width, height */
297 IVI_SURFACE_PROP_POSITION = (1 << 1),
302 struct ivi_compositor *ivi;
303 struct weston_desktop_surface *dsurface;
304 struct weston_view *view;
305 struct ivi_output *hidden_layer_output;
306 struct ivi_output *current_completed_output;
310 uint32_t orientation;
314 enum ivi_surface_flags flags;
316 int32_t width, height;
319 bool advertised_on_launch;
320 bool checked_pending;
328 enum ivi_surface_role role;
329 enum ivi_surface_role prev_role;
331 struct ivi_desktop_surface desktop;
332 struct ivi_background_surface bg;
333 struct ivi_panel_surface panel;
334 struct ivi_popup_surface popup;
335 struct ivi_fullscreen_surface fullscreen;
336 struct ivi_split_surface split;
337 struct ivi_remote_surface remote;
340 struct wl_listener listener_advertise_app;
341 struct wl_signal signal_advertise_app;
350 struct ivi_shell_seat {
351 struct weston_seat *seat;
352 struct weston_surface *focused_surface;
357 struct wl_listener seat_destroy_listener;
358 struct wl_listener caps_changed_listener;
359 struct wl_listener keyboard_focus_listener;
360 struct wl_listener pointer_focus_listener;
363 struct ivi_shell_client {
369 struct wl_client *client;
371 struct wl_listener client_destroy;
374 struct ivi_compositor *
375 to_ivi_compositor(struct weston_compositor *ec);
379 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
382 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
388 ivi_shell_init(struct ivi_compositor *ivi);
391 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
394 ivi_shell_create_global(struct ivi_compositor *ivi);
397 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
400 ivi_desktop_init(struct ivi_compositor *ivi);
402 struct ivi_shell_client *
403 ivi_shell_client_from_wl(struct wl_client *client);
406 to_ivi_output(struct weston_output *o);
409 ivi_set_desktop_surface(struct ivi_surface *surface);
412 * removes the pending popup one
415 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
418 ivi_reflow_outputs(struct ivi_compositor *ivi);
421 to_ivi_surface(struct weston_surface *surface);
424 ivi_layout_set_mapped(struct ivi_surface *surface);
427 ivi_layout_set_position(struct ivi_surface *surface,
428 int32_t x, int32_t y,
429 int32_t width, int32_t height);
432 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
435 ivi_layout_commit(struct ivi_compositor *ivi);
438 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
441 ivi_layout_activate(struct ivi_output *output, const char *app_id);
444 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
447 ivi_layout_desktop_committed(struct ivi_surface *surf);
449 ivi_layout_remote_committed(struct ivi_surface *surf);
452 ivi_layout_popup_committed(struct ivi_surface *surface);
455 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
458 ivi_layout_split_committed(struct ivi_surface *surface);
461 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
464 ivi_layout_desktop_resize(struct ivi_surface *surface,
465 struct weston_geometry area);
468 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
471 insert_black_curtain(struct ivi_output *output);
474 remove_black_curtain(struct ivi_output *output);
477 output_has_black_curtain(struct ivi_output *output);
480 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
483 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
487 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
490 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
491 const char *data, uint32_t app_state);
493 ivi_screenshooter_create(struct ivi_compositor *ivi);
496 ivi_seat_init(struct ivi_compositor *ivi);
499 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
502 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
503 struct ivi_surface *surface);
505 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
506 enum ivi_surface_role *role);
509 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
511 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
514 ivi_shell_finalize(struct ivi_compositor *ivi);
517 get_ivi_shell_surface(struct weston_surface *surface);
519 struct ivi_shell_seat *
520 get_ivi_shell_seat(struct weston_seat *seat);
523 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
526 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
527 struct ivi_shell_seat *ivi_seat,
530 sigchld_handler(int signal_number, void *data);
533 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
534 enum agl_shell_app_state state);
536 ivi_layout_restore(struct ivi_compositor *ivi, struct ivi_output *n_output);
539 ivi_layout_save(struct ivi_compositor *ivi, struct ivi_output *output);
541 struct weston_output *
542 get_default_output(struct weston_compositor *compositor);
544 struct weston_output *
545 get_focused_output(struct weston_compositor *compositor);
548 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
549 const char *output_name);
551 ivi_surface_count_one(struct ivi_output *ivi_output,
552 enum ivi_surface_role role);
555 parse_activation_area(const char *geometry, struct ivi_output *output);
558 is_shell_surface_xwayland(struct ivi_surface *surf);
561 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
564 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
565 uint32_t orientation, uint32_t width, int32_t sticky,
567 struct ivi_output_config *
568 ivi_init_parsed_options(struct weston_compositor *compositor);
571 ivi_process_destroy(struct wet_process *process, int status, bool call_cleanup);