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.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 enum agl_shell_bound_status {
54 struct ivi_output_config {
61 struct ivi_compositor {
62 struct weston_compositor *compositor;
63 struct weston_backend *backend;
64 struct weston_config *config;
65 struct ivi_output_config *parsed_options;
67 struct wl_listener heads_changed;
68 int (*simple_output_configure)(struct weston_output *output);
72 bool activate_by_default;
73 bool keep_pending_surfaces;
76 * Options parsed from command line arugments.
77 * Overrides what is found in the config file.
81 bool use_current_mode;
87 const struct weston_windowed_output_api *window_api;
88 const struct weston_drm_output_api *drm_api;
89 const struct weston_remoting_api *remoting_api;
91 struct wl_global *agl_shell;
92 struct wl_global *agl_shell_desktop;
93 struct wl_global *agl_shell_ext;
96 struct wl_client *client;
97 struct wl_resource *resource;
99 /* this is for another agl-shell client, potentially used by
101 struct wl_resource *resource_ext;
103 enum agl_shell_bound_status status;
107 struct wl_client *client;
108 struct wl_resource *resource;
110 bool doas_requested_pending_bind;
111 enum agl_shell_bound_status status;
114 struct wl_list desktop_clients; /* desktop_client::link */
116 struct wl_list outputs; /* ivi_output.link */
117 struct wl_list saved_outputs; /* ivi_output.link */
118 struct wl_list surfaces; /* ivi_surface.link */
120 struct weston_desktop *desktop;
121 struct wl_listener seat_created_listener;
122 struct ivi_policy *policy;
124 struct wl_list pending_surfaces;
125 struct wl_list popup_pending_apps;
126 struct wl_list fullscreen_pending_apps;
127 struct wl_list split_pending_apps;
128 struct wl_list remote_pending_apps;
130 struct wl_list pending_apps; /** pending_app::link */
132 struct wl_listener destroy_listener;
133 struct wl_listener transform_listener;
134 const struct weston_xwayland_surface_api *xwayland_surface_api;
136 struct weston_layer hidden;
137 struct weston_layer background;
138 struct weston_layer normal;
139 struct weston_layer panel;
140 struct weston_layer popup;
141 struct weston_layer fullscreen;
143 bool need_ivi_output_relayout;
144 struct wl_list child_process_list;
149 enum ivi_output_type {
155 struct wl_list link; /* ivi_compositor.outputs */
156 struct ivi_compositor *ivi;
159 struct weston_config_section *config;
160 struct weston_output *output;
162 struct ivi_surface *background;
164 struct ivi_surface *top;
165 struct ivi_surface *bottom;
166 struct ivi_surface *left;
167 struct ivi_surface *right;
169 /* for the black surface */
170 struct fullscreen_view {
171 struct ivi_surface *fs;
172 struct wl_listener fs_destroy;
173 struct weston_buffer_reference *buffer_ref;
176 struct wl_listener output_destroy;
179 * Usable area for normal clients, i.e. with panels removed.
180 * In output-coorrdinate space.
182 struct weston_geometry area;
183 struct weston_geometry area_saved;
185 * Potential user-specified non-default activation area
187 struct weston_geometry area_activation;
189 struct ivi_surface *active;
190 struct ivi_surface *previous_active;
192 /* Temporary: only used during configuration */
194 struct weston_head *add[8];
197 enum ivi_output_type type;
200 enum ivi_surface_role {
201 IVI_SURFACE_ROLE_NONE,
202 IVI_SURFACE_ROLE_DESKTOP,
203 IVI_SURFACE_ROLE_BACKGROUND,
204 IVI_SURFACE_ROLE_PANEL,
205 IVI_SURFACE_ROLE_POPUP,
206 IVI_SURFACE_ROLE_FULLSCREEN,
207 IVI_SURFACE_ROLE_SPLIT_V,
208 IVI_SURFACE_ROLE_SPLIT_H,
209 IVI_SURFACE_ROLE_REMOTE,
210 IVI_SURFACE_ROLE_TILE,
213 struct ivi_bounding_box {
215 int width; int height;
218 struct pending_popup {
219 struct ivi_output *ioutput;
222 struct ivi_bounding_box bb;
224 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
227 struct pending_fullscreen {
228 struct ivi_output *ioutput;
230 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
233 struct pending_split {
234 struct ivi_output *ioutput;
236 uint32_t orientation;
237 struct wl_list link; /** ivi_compositor::split_pending_apps */
240 struct pending_remote {
241 struct ivi_output *ioutput;
243 struct wl_list link; /** ivi_compositor::remote_pending_apps */
247 struct ivi_output *ioutput;
248 enum ivi_surface_role role;
250 struct wl_list link; /** ivi_compositor::pending_apps */
253 struct pending_app_tile {
254 struct pending_app base;
255 uint32_t orientation;
260 struct ivi_desktop_surface {
261 struct ivi_output *pending_output;
262 struct ivi_output *last_output;
265 struct ivi_background_surface {
266 struct ivi_output *output;
269 struct ivi_popup_surface {
270 struct ivi_output *output;
271 int x; int y; /* initial position */
272 struct ivi_bounding_box bb; /* bounding box */
275 struct ivi_fullscreen_surface {
276 struct ivi_output *output;
279 struct ivi_split_surface {
280 struct ivi_output *output;
281 uint32_t orientation;
284 struct ivi_remote_surface {
285 struct ivi_output *output;
288 struct ivi_panel_surface {
289 struct ivi_output *output;
290 enum agl_shell_edge edge;
293 enum ivi_surface_flags {
294 IVI_SURFACE_PROP_MAP = (1 << 0),
295 /* x, y, width, height */
296 IVI_SURFACE_PROP_POSITION = (1 << 1),
301 struct ivi_compositor *ivi;
302 struct weston_desktop_surface *dsurface;
303 struct weston_view *view;
304 struct ivi_output *hidden_layer_output;
305 struct ivi_output *current_completed_output;
309 uint32_t orientation;
313 enum ivi_surface_flags flags;
315 int32_t width, height;
318 bool advertised_on_launch;
319 bool checked_pending;
327 enum ivi_surface_role role;
328 enum ivi_surface_role prev_role;
330 struct ivi_desktop_surface desktop;
331 struct ivi_background_surface bg;
332 struct ivi_panel_surface panel;
333 struct ivi_popup_surface popup;
334 struct ivi_fullscreen_surface fullscreen;
335 struct ivi_split_surface split;
336 struct ivi_remote_surface remote;
339 struct wl_listener listener_advertise_app;
340 struct wl_signal signal_advertise_app;
349 struct ivi_shell_seat {
350 struct weston_seat *seat;
351 struct weston_surface *focused_surface;
356 struct wl_listener seat_destroy_listener;
357 struct wl_listener caps_changed_listener;
358 struct wl_listener keyboard_focus_listener;
359 struct wl_listener pointer_focus_listener;
362 struct ivi_shell_client {
368 struct wl_client *client;
370 struct wl_listener client_destroy;
373 struct ivi_compositor *
374 to_ivi_compositor(struct weston_compositor *ec);
378 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
381 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
387 ivi_shell_init(struct ivi_compositor *ivi);
390 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
393 ivi_shell_create_global(struct ivi_compositor *ivi);
396 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
399 ivi_desktop_init(struct ivi_compositor *ivi);
401 struct ivi_shell_client *
402 ivi_shell_client_from_wl(struct wl_client *client);
405 to_ivi_output(struct weston_output *o);
408 ivi_set_desktop_surface(struct ivi_surface *surface);
411 * removes the pending popup one
414 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
417 ivi_reflow_outputs(struct ivi_compositor *ivi);
420 to_ivi_surface(struct weston_surface *surface);
423 ivi_layout_set_mapped(struct ivi_surface *surface);
426 ivi_layout_set_position(struct ivi_surface *surface,
427 int32_t x, int32_t y,
428 int32_t width, int32_t height);
431 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
434 ivi_layout_commit(struct ivi_compositor *ivi);
437 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
440 ivi_layout_activate(struct ivi_output *output, const char *app_id);
443 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
446 ivi_layout_desktop_committed(struct ivi_surface *surf);
448 ivi_layout_remote_committed(struct ivi_surface *surf);
451 ivi_layout_popup_committed(struct ivi_surface *surface);
454 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
457 ivi_layout_split_committed(struct ivi_surface *surface);
460 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
463 ivi_layout_desktop_resize(struct ivi_surface *surface,
464 struct weston_geometry area);
467 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
470 insert_black_curtain(struct ivi_output *output);
473 remove_black_curtain(struct ivi_output *output);
476 output_has_black_curtain(struct ivi_output *output);
479 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
482 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
486 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
489 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
490 const char *data, uint32_t app_state);
492 ivi_screenshooter_create(struct ivi_compositor *ivi);
495 ivi_seat_init(struct ivi_compositor *ivi);
498 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
501 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
502 struct ivi_surface *surface);
504 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
505 enum ivi_surface_role *role);
508 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
510 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
513 ivi_shell_finalize(struct ivi_compositor *ivi);
516 get_ivi_shell_surface(struct weston_surface *surface);
518 struct ivi_shell_seat *
519 get_ivi_shell_seat(struct weston_seat *seat);
522 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
525 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
526 struct ivi_shell_seat *ivi_seat,
529 sigchld_handler(int signal_number, void *data);
532 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
533 enum agl_shell_app_state state);
535 ivi_layout_restore(struct ivi_compositor *ivi, struct ivi_output *n_output);
538 ivi_layout_save(struct ivi_compositor *ivi, struct ivi_output *output);
540 struct weston_output *
541 get_default_output(struct weston_compositor *compositor);
543 struct weston_output *
544 get_focused_output(struct weston_compositor *compositor);
547 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
548 const char *output_name);
550 ivi_surface_count_one(struct ivi_output *ivi_output,
551 enum ivi_surface_role role);
554 parse_activation_area(const char *geometry, struct ivi_output *output);
557 is_shell_surface_xwayland(struct ivi_surface *surf);
560 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
563 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
564 uint32_t orientation, uint32_t width, int32_t sticky,
566 struct ivi_output_config *
567 ivi_init_parsed_options(struct weston_compositor *compositor);