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;
76 struct wl_listener screenshot_auth;
79 * Options parsed from command line arugments.
80 * Overrides what is found in the config file.
84 bool use_current_mode;
90 const struct weston_windowed_output_api *window_api;
91 const struct weston_drm_output_api *drm_api;
92 const struct weston_remoting_api *remoting_api;
94 struct wl_global *agl_shell;
95 struct wl_global *agl_shell_desktop;
96 struct wl_global *agl_shell_ext;
99 struct wl_client *client;
100 struct wl_resource *resource;
102 /* this is for another agl-shell client, potentially used by
104 struct wl_resource *resource_ext;
106 enum agl_shell_bound_status status;
110 struct wl_client *client;
111 struct wl_resource *resource;
113 bool doas_requested_pending_bind;
114 enum agl_shell_bound_status status;
117 struct wl_list desktop_clients; /* desktop_client::link */
119 struct wl_list outputs; /* ivi_output.link */
120 struct wl_list saved_outputs; /* ivi_output.link */
121 struct wl_list surfaces; /* ivi_surface.link */
123 struct weston_desktop *desktop;
124 struct wl_listener seat_created_listener;
125 struct ivi_policy *policy;
127 struct wl_list pending_surfaces;
128 struct wl_list popup_pending_apps;
129 struct wl_list fullscreen_pending_apps;
130 struct wl_list split_pending_apps;
131 struct wl_list remote_pending_apps;
133 struct wl_list pending_apps; /** pending_app::link */
135 struct wl_listener destroy_listener;
136 struct wl_listener transform_listener;
137 const struct weston_xwayland_surface_api *xwayland_surface_api;
139 struct weston_layer hidden;
140 struct weston_layer background;
141 struct weston_layer normal;
142 struct weston_layer panel;
143 struct weston_layer popup;
144 struct weston_layer fullscreen;
146 bool need_ivi_output_relayout;
147 struct wl_list child_process_list;
152 enum ivi_output_type {
158 struct wl_list link; /* ivi_compositor.outputs */
159 struct ivi_compositor *ivi;
162 struct weston_config_section *config;
163 struct weston_output *output;
165 struct ivi_surface *background;
167 struct ivi_surface *top;
168 struct ivi_surface *bottom;
169 struct ivi_surface *left;
170 struct ivi_surface *right;
172 /* for the black surface */
173 struct fullscreen_view {
174 struct ivi_surface *fs;
175 struct wl_listener fs_destroy;
176 struct weston_buffer_reference *buffer_ref;
179 struct wl_listener output_destroy;
182 * Usable area for normal clients, i.e. with panels removed.
183 * In output-coorrdinate space.
185 struct weston_geometry area;
186 struct weston_geometry area_saved;
188 * Potential user-specified non-default activation area
190 struct weston_geometry area_activation;
192 struct ivi_surface *active;
193 struct ivi_surface *previous_active;
195 /* Temporary: only used during configuration */
197 struct weston_head *add[8];
200 enum ivi_output_type type;
203 enum ivi_surface_role {
204 IVI_SURFACE_ROLE_NONE,
205 IVI_SURFACE_ROLE_DESKTOP,
206 IVI_SURFACE_ROLE_BACKGROUND,
207 IVI_SURFACE_ROLE_PANEL,
208 IVI_SURFACE_ROLE_POPUP,
209 IVI_SURFACE_ROLE_FULLSCREEN,
210 IVI_SURFACE_ROLE_SPLIT_V,
211 IVI_SURFACE_ROLE_SPLIT_H,
212 IVI_SURFACE_ROLE_REMOTE,
213 IVI_SURFACE_ROLE_TILE,
216 struct ivi_bounding_box {
218 int width; int height;
221 struct pending_popup {
222 struct ivi_output *ioutput;
225 struct ivi_bounding_box bb;
227 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
230 struct pending_fullscreen {
231 struct ivi_output *ioutput;
233 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
236 struct pending_split {
237 struct ivi_output *ioutput;
239 uint32_t orientation;
240 struct wl_list link; /** ivi_compositor::split_pending_apps */
243 struct pending_remote {
244 struct ivi_output *ioutput;
246 struct wl_list link; /** ivi_compositor::remote_pending_apps */
250 struct ivi_output *ioutput;
251 enum ivi_surface_role role;
253 struct wl_list link; /** ivi_compositor::pending_apps */
256 struct pending_app_tile {
257 struct pending_app base;
258 uint32_t orientation;
263 struct ivi_desktop_surface {
264 struct ivi_output *pending_output;
265 struct ivi_output *last_output;
268 struct ivi_background_surface {
269 struct ivi_output *output;
272 struct ivi_popup_surface {
273 struct ivi_output *output;
274 int x; int y; /* initial position */
275 struct ivi_bounding_box bb; /* bounding box */
278 struct ivi_fullscreen_surface {
279 struct ivi_output *output;
282 struct ivi_split_surface {
283 struct ivi_output *output;
284 uint32_t orientation;
287 struct ivi_remote_surface {
288 struct ivi_output *output;
291 struct ivi_panel_surface {
292 struct ivi_output *output;
293 enum agl_shell_edge edge;
296 enum ivi_surface_flags {
297 IVI_SURFACE_PROP_MAP = (1 << 0),
298 /* x, y, width, height */
299 IVI_SURFACE_PROP_POSITION = (1 << 1),
304 struct ivi_compositor *ivi;
305 struct weston_desktop_surface *dsurface;
306 struct weston_view *view;
307 struct ivi_output *hidden_layer_output;
308 struct ivi_output *current_completed_output;
312 uint32_t orientation;
316 enum ivi_surface_flags flags;
318 int32_t width, height;
321 bool advertised_on_launch;
322 bool checked_pending;
330 enum ivi_surface_role role;
331 enum ivi_surface_role prev_role;
333 struct ivi_desktop_surface desktop;
334 struct ivi_background_surface bg;
335 struct ivi_panel_surface panel;
336 struct ivi_popup_surface popup;
337 struct ivi_fullscreen_surface fullscreen;
338 struct ivi_split_surface split;
339 struct ivi_remote_surface remote;
342 struct wl_listener listener_advertise_app;
343 struct wl_signal signal_advertise_app;
352 struct ivi_shell_seat {
353 struct weston_seat *seat;
354 struct weston_surface *focused_surface;
359 struct wl_listener seat_destroy_listener;
360 struct wl_listener caps_changed_listener;
361 struct wl_listener keyboard_focus_listener;
362 struct wl_listener pointer_focus_listener;
365 struct ivi_shell_client {
371 struct wl_client *client;
373 struct wl_listener client_destroy;
376 struct ivi_compositor *
377 to_ivi_compositor(struct weston_compositor *ec);
381 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
384 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
390 ivi_shell_init(struct ivi_compositor *ivi);
393 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
396 ivi_shell_create_global(struct ivi_compositor *ivi);
399 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
402 ivi_desktop_init(struct ivi_compositor *ivi);
404 struct ivi_shell_client *
405 ivi_shell_client_from_wl(struct wl_client *client);
408 to_ivi_output(struct weston_output *o);
411 ivi_set_desktop_surface(struct ivi_surface *surface);
414 * removes the pending popup one
417 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
420 ivi_reflow_outputs(struct ivi_compositor *ivi);
423 to_ivi_surface(struct weston_surface *surface);
426 ivi_layout_set_mapped(struct ivi_surface *surface);
429 ivi_layout_set_position(struct ivi_surface *surface,
430 int32_t x, int32_t y,
431 int32_t width, int32_t height);
434 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
437 ivi_layout_commit(struct ivi_compositor *ivi);
440 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
443 ivi_layout_activate(struct ivi_output *output, const char *app_id);
446 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
449 ivi_layout_desktop_committed(struct ivi_surface *surf);
451 ivi_layout_remote_committed(struct ivi_surface *surf);
454 ivi_layout_popup_committed(struct ivi_surface *surface);
457 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
460 ivi_layout_split_committed(struct ivi_surface *surface);
463 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
466 ivi_layout_desktop_resize(struct ivi_surface *surface,
467 struct weston_geometry area);
470 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
473 insert_black_curtain(struct ivi_output *output);
476 remove_black_curtain(struct ivi_output *output);
479 output_has_black_curtain(struct ivi_output *output);
482 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
485 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
489 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
492 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
493 const char *data, uint32_t app_state);
495 ivi_screenshooter_create(struct ivi_compositor *ivi);
498 ivi_seat_init(struct ivi_compositor *ivi);
501 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
504 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
505 struct ivi_surface *surface);
507 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
508 enum ivi_surface_role *role);
511 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
513 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
516 ivi_shell_finalize(struct ivi_compositor *ivi);
519 get_ivi_shell_surface(struct weston_surface *surface);
521 struct ivi_shell_seat *
522 get_ivi_shell_seat(struct weston_seat *seat);
525 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
528 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
529 struct ivi_shell_seat *ivi_seat,
532 sigchld_handler(int signal_number, void *data);
535 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
536 enum agl_shell_app_state state);
538 ivi_layout_restore(struct ivi_compositor *ivi, struct ivi_output *n_output);
541 ivi_layout_save(struct ivi_compositor *ivi, struct ivi_output *output);
543 struct weston_output *
544 get_default_output(struct weston_compositor *compositor);
546 struct weston_output *
547 get_focused_output(struct weston_compositor *compositor);
550 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
551 const char *output_name);
553 ivi_surface_count_one(struct ivi_output *ivi_output,
554 enum ivi_surface_role role);
557 parse_activation_area(const char *geometry, struct ivi_output *output);
560 is_shell_surface_xwayland(struct ivi_surface *surf);
563 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
566 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
567 uint32_t orientation, uint32_t width, int32_t sticky,
569 struct ivi_output_config *
570 ivi_init_parsed_options(struct weston_compositor *compositor);
573 ivi_process_destroy(struct wet_process *process, int status, bool call_cleanup);