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 enum agl_shell_bound_status {
54 struct ivi_output_config {
61 struct ivi_compositor {
62 struct weston_compositor *compositor;
63 struct weston_config *config;
64 struct ivi_output_config *parsed_options;
66 struct wl_listener heads_changed;
67 int (*simple_output_configure)(struct weston_output *output);
71 bool activate_by_default;
72 bool keep_pending_surfaces;
75 * Options parsed from command line arugments.
76 * Overrides what is found in the config file.
80 bool use_current_mode;
86 const struct weston_windowed_output_api *window_api;
87 const struct weston_drm_output_api *drm_api;
88 const struct weston_remoting_api *remoting_api;
90 struct wl_global *agl_shell;
91 struct wl_global *agl_shell_desktop;
92 struct wl_global *agl_shell_ext;
95 struct wl_client *client;
96 struct wl_resource *resource;
98 /* this is for another agl-shell client, potentially used by
100 struct wl_resource *resource_ext;
102 enum agl_shell_bound_status status;
106 struct wl_client *client;
107 struct wl_resource *resource;
109 bool doas_requested_pending_bind;
110 enum agl_shell_bound_status status;
113 struct wl_list desktop_clients; /* desktop_client::link */
115 struct wl_list outputs; /* ivi_output.link */
116 struct wl_list saved_outputs; /* ivi_output.link */
117 struct wl_list surfaces; /* ivi_surface.link */
119 struct weston_desktop *desktop;
120 struct wl_listener seat_created_listener;
121 struct ivi_policy *policy;
123 struct wl_list pending_surfaces;
124 struct wl_list popup_pending_apps;
125 struct wl_list fullscreen_pending_apps;
126 struct wl_list split_pending_apps;
127 struct wl_list remote_pending_apps;
129 struct wl_list pending_apps; /** pending_app::link */
131 struct wl_listener destroy_listener;
132 struct wl_listener transform_listener;
133 const struct weston_xwayland_surface_api *xwayland_surface_api;
135 struct weston_layer hidden;
136 struct weston_layer background;
137 struct weston_layer normal;
138 struct weston_layer panel;
139 struct weston_layer popup;
140 struct weston_layer fullscreen;
142 bool need_ivi_output_relayout;
143 struct wl_list child_process_list;
148 enum ivi_output_type {
154 struct wl_list link; /* ivi_compositor.outputs */
155 struct ivi_compositor *ivi;
158 struct weston_config_section *config;
159 struct weston_output *output;
161 struct ivi_surface *background;
163 struct ivi_surface *top;
164 struct ivi_surface *bottom;
165 struct ivi_surface *left;
166 struct ivi_surface *right;
168 /* for the black surface */
169 struct fullscreen_view {
170 struct ivi_surface *fs;
171 struct wl_listener fs_destroy;
174 struct wl_listener output_destroy;
177 * Usable area for normal clients, i.e. with panels removed.
178 * In output-coorrdinate space.
180 struct weston_geometry area;
181 struct weston_geometry area_saved;
183 * Potential user-specified non-default activation area
185 struct weston_geometry area_activation;
187 struct ivi_surface *active;
188 struct ivi_surface *previous_active;
190 /* Temporary: only used during configuration */
192 struct weston_head *add[8];
195 enum ivi_output_type type;
198 enum ivi_surface_role {
199 IVI_SURFACE_ROLE_NONE,
200 IVI_SURFACE_ROLE_DESKTOP,
201 IVI_SURFACE_ROLE_BACKGROUND,
202 IVI_SURFACE_ROLE_PANEL,
203 IVI_SURFACE_ROLE_POPUP,
204 IVI_SURFACE_ROLE_FULLSCREEN,
205 IVI_SURFACE_ROLE_SPLIT_V,
206 IVI_SURFACE_ROLE_SPLIT_H,
207 IVI_SURFACE_ROLE_REMOTE,
208 IVI_SURFACE_ROLE_TILE,
211 struct ivi_bounding_box {
213 int width; int height;
216 struct pending_popup {
217 struct ivi_output *ioutput;
220 struct ivi_bounding_box bb;
222 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
225 struct pending_fullscreen {
226 struct ivi_output *ioutput;
228 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
231 struct pending_split {
232 struct ivi_output *ioutput;
234 uint32_t orientation;
235 struct wl_list link; /** ivi_compositor::split_pending_apps */
238 struct pending_remote {
239 struct ivi_output *ioutput;
241 struct wl_list link; /** ivi_compositor::remote_pending_apps */
245 struct ivi_output *ioutput;
246 enum ivi_surface_role role;
248 struct wl_list link; /** ivi_compositor::pending_apps */
251 struct pending_app_tile {
252 struct pending_app base;
253 uint32_t orientation;
258 struct ivi_desktop_surface {
259 struct ivi_output *pending_output;
260 struct ivi_output *last_output;
263 struct ivi_background_surface {
264 struct ivi_output *output;
267 struct ivi_popup_surface {
268 struct ivi_output *output;
269 int x; int y; /* initial position */
270 struct ivi_bounding_box bb; /* bounding box */
273 struct ivi_fullscreen_surface {
274 struct ivi_output *output;
277 struct ivi_split_surface {
278 struct ivi_output *output;
279 uint32_t orientation;
282 struct ivi_remote_surface {
283 struct ivi_output *output;
286 struct ivi_panel_surface {
287 struct ivi_output *output;
288 enum agl_shell_edge edge;
291 enum ivi_surface_flags {
292 IVI_SURFACE_PROP_MAP = (1 << 0),
293 /* x, y, width, height */
294 IVI_SURFACE_PROP_POSITION = (1 << 1),
299 struct ivi_compositor *ivi;
300 struct weston_desktop_surface *dsurface;
301 struct weston_view *view;
302 struct ivi_output *hidden_layer_output;
303 struct ivi_output *current_completed_output;
307 uint32_t orientation;
311 enum ivi_surface_flags flags;
313 int32_t width, height;
316 bool advertised_on_launch;
317 bool checked_pending;
325 enum ivi_surface_role role;
326 enum ivi_surface_role prev_role;
328 struct ivi_desktop_surface desktop;
329 struct ivi_background_surface bg;
330 struct ivi_panel_surface panel;
331 struct ivi_popup_surface popup;
332 struct ivi_fullscreen_surface fullscreen;
333 struct ivi_split_surface split;
334 struct ivi_remote_surface remote;
337 struct wl_listener listener_advertise_app;
338 struct wl_signal signal_advertise_app;
347 struct ivi_shell_seat {
348 struct weston_seat *seat;
349 struct weston_surface *focused_surface;
354 struct wl_listener seat_destroy_listener;
355 struct wl_listener caps_changed_listener;
356 struct wl_listener keyboard_focus_listener;
357 struct wl_listener pointer_focus_listener;
360 struct ivi_shell_client {
366 struct wl_client *client;
368 struct wl_listener client_destroy;
371 struct ivi_compositor *
372 to_ivi_compositor(struct weston_compositor *ec);
376 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
379 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
385 ivi_shell_init(struct ivi_compositor *ivi);
388 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
391 ivi_shell_create_global(struct ivi_compositor *ivi);
394 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
397 ivi_desktop_init(struct ivi_compositor *ivi);
399 struct ivi_shell_client *
400 ivi_shell_client_from_wl(struct wl_client *client);
403 to_ivi_output(struct weston_output *o);
406 ivi_set_desktop_surface(struct ivi_surface *surface);
409 * removes the pending popup one
412 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
415 ivi_reflow_outputs(struct ivi_compositor *ivi);
418 to_ivi_surface(struct weston_surface *surface);
421 ivi_layout_set_mapped(struct ivi_surface *surface);
424 ivi_layout_set_position(struct ivi_surface *surface,
425 int32_t x, int32_t y,
426 int32_t width, int32_t height);
429 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
432 ivi_layout_commit(struct ivi_compositor *ivi);
435 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
438 ivi_layout_activate(struct ivi_output *output, const char *app_id);
441 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
444 ivi_layout_desktop_committed(struct ivi_surface *surf);
446 ivi_layout_remote_committed(struct ivi_surface *surf);
449 ivi_layout_popup_committed(struct ivi_surface *surface);
452 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
455 ivi_layout_split_committed(struct ivi_surface *surface);
458 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
461 ivi_layout_desktop_resize(struct ivi_surface *surface,
462 struct weston_geometry area);
465 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
468 insert_black_curtain(struct ivi_output *output);
471 remove_black_curtain(struct ivi_output *output);
474 output_has_black_curtain(struct ivi_output *output);
477 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
480 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
484 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
487 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
488 const char *data, uint32_t app_state);
490 ivi_screenshooter_create(struct ivi_compositor *ivi);
493 ivi_seat_init(struct ivi_compositor *ivi);
496 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
499 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
500 struct ivi_surface *surface);
502 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
503 enum ivi_surface_role *role);
506 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
508 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
511 ivi_shell_finalize(struct ivi_compositor *ivi);
514 get_ivi_shell_surface(struct weston_surface *surface);
516 struct ivi_shell_seat *
517 get_ivi_shell_seat(struct weston_seat *seat);
520 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
523 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
524 struct ivi_shell_seat *ivi_seat,
527 sigchld_handler(int signal_number, void *data);
530 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
531 enum agl_shell_app_state state);
533 ivi_layout_destroy_saved_outputs(struct ivi_compositor *ivi);
535 struct weston_output *
536 get_default_output(struct weston_compositor *compositor);
538 struct weston_output *
539 get_focused_output(struct weston_compositor *compositor);
542 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
543 const char *output_name);
545 ivi_surface_count_one(struct ivi_output *ivi_output,
546 enum ivi_surface_role role);
549 parse_activation_area(const char *geometry, struct ivi_output *output);
552 is_shell_surface_xwayland(struct ivi_surface *surf);
555 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
558 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
559 uint32_t orientation, uint32_t width, int32_t sticky,
561 struct ivi_output_config *
562 ivi_init_parsed_options(struct weston_compositor *compositor);