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_compositor {
55 struct weston_compositor *compositor;
56 struct weston_config *config;
58 struct wl_listener heads_changed;
62 bool activate_by_default;
63 bool keep_pending_surfaces;
66 * Options parsed from command line arugments.
67 * Overrides what is found in the config file.
71 bool use_current_mode;
77 const struct weston_windowed_output_api *window_api;
78 const struct weston_drm_output_api *drm_api;
79 const struct weston_remoting_api *remoting_api;
80 const struct weston_transmitter_api *waltham_transmitter_api;
82 struct wl_global *agl_shell;
83 struct wl_global *agl_shell_desktop;
84 struct wl_global *agl_shell_ext;
87 struct wl_client *client;
88 struct wl_resource *resource;
90 /* this is for another agl-shell client, potentially used by
92 struct wl_resource *resource_ext;
94 enum agl_shell_bound_status status;
98 struct wl_client *client;
99 struct wl_resource *resource;
101 enum agl_shell_bound_status status;
104 struct wl_list desktop_clients; /* desktop_client::link */
106 struct wl_list outputs; /* ivi_output.link */
107 struct wl_list saved_outputs; /* ivi_output.link */
108 struct wl_list surfaces; /* ivi_surface.link */
110 struct weston_desktop *desktop;
111 struct wl_listener seat_created_listener;
112 struct ivi_policy *policy;
114 struct wl_list pending_surfaces;
115 struct wl_list popup_pending_apps;
116 struct wl_list fullscreen_pending_apps;
117 struct wl_list split_pending_apps;
118 struct wl_list remote_pending_apps;
120 struct wl_listener destroy_listener;
122 struct weston_layer hidden;
123 struct weston_layer background;
124 struct weston_layer normal;
125 struct weston_layer panel;
126 struct weston_layer popup;
127 struct weston_layer fullscreen;
129 bool need_ivi_output_relayout;
130 struct wl_list child_process_list;
135 enum ivi_output_type {
138 /* same as remote but we need to signal the transmitter plug-in
139 * for the surfaces to have to be forwarded to those remoted outputs */
144 struct wl_list link; /* ivi_compositor.outputs */
145 struct ivi_compositor *ivi;
148 struct weston_config_section *config;
149 struct weston_output *output;
151 struct ivi_surface *background;
153 struct ivi_surface *top;
154 struct ivi_surface *bottom;
155 struct ivi_surface *left;
156 struct ivi_surface *right;
158 /* for the black surface */
159 struct fullscreen_view {
160 struct ivi_surface *fs;
161 struct wl_listener fs_destroy;
164 struct wl_listener output_destroy;
167 * Usable area for normal clients, i.e. with panels removed.
168 * In output-coorrdinate space.
170 struct weston_geometry area;
171 struct weston_geometry area_saved;
173 * Potential user-specified non-default activation area
175 struct weston_geometry area_activation;
177 struct ivi_surface *active;
178 struct ivi_surface *previous_active;
180 /* Temporary: only used during configuration */
182 struct weston_head *add[8];
185 enum ivi_output_type type;
188 enum ivi_surface_role {
189 IVI_SURFACE_ROLE_NONE,
190 IVI_SURFACE_ROLE_DESKTOP,
191 IVI_SURFACE_ROLE_BACKGROUND,
192 IVI_SURFACE_ROLE_PANEL,
193 IVI_SURFACE_ROLE_POPUP,
194 IVI_SURFACE_ROLE_FULLSCREEN,
195 IVI_SURFACE_ROLE_SPLIT_V,
196 IVI_SURFACE_ROLE_SPLIT_H,
197 IVI_SURFACE_ROLE_REMOTE,
200 struct ivi_bounding_box {
202 int width; int height;
205 struct pending_popup {
206 struct ivi_output *ioutput;
209 struct ivi_bounding_box bb;
211 struct wl_list link; /** ivi_compositor::popup_pending_surfaces */
214 struct pending_fullscreen {
215 struct ivi_output *ioutput;
217 struct wl_list link; /** ivi_compositor::fullscreen_pending_apps */
220 struct pending_split {
221 struct ivi_output *ioutput;
223 uint32_t orientation;
224 struct wl_list link; /** ivi_compositor::split_pending_apps */
227 struct pending_remote {
228 struct ivi_output *ioutput;
230 struct wl_list link; /** ivi_compositor::remote_pending_apps */
233 struct ivi_desktop_surface {
234 struct ivi_output *pending_output;
235 struct ivi_output *last_output;
238 struct ivi_background_surface {
239 struct ivi_output *output;
242 struct ivi_popup_surface {
243 struct ivi_output *output;
244 int x; int y; /* initial position */
245 struct ivi_bounding_box bb; /* bounding box */
248 struct ivi_fullscreen_surface {
249 struct ivi_output *output;
252 struct ivi_split_surface {
253 struct ivi_output *output;
254 uint32_t orientation;
257 struct ivi_remote_surface {
258 struct ivi_output *output;
261 struct ivi_panel_surface {
262 struct ivi_output *output;
263 enum agl_shell_edge edge;
266 enum ivi_surface_flags {
267 IVI_SURFACE_PROP_MAP = (1 << 0),
268 /* x, y, width, height */
269 IVI_SURFACE_PROP_POSITION = (1 << 1),
272 /* the waltham surface is a pointer type as well and
273 * in order to avoid adding ifdef for waltham use a
274 * generic pointer, which will be only be valid when the
275 * surface is a remote out on a waltham type of output */
276 struct ivi_surface_waltham {
277 void *transmitter_surface;
281 struct ivi_compositor *ivi;
282 struct weston_desktop_surface *dsurface;
283 struct weston_view *view;
284 struct ivi_output *hidden_layer_output;
285 struct ivi_output *current_completed_output;
291 enum ivi_surface_flags flags;
293 int32_t width, height;
296 bool advertised_on_launch;
297 bool checked_pending;
305 enum ivi_surface_role role;
307 struct ivi_desktop_surface desktop;
308 struct ivi_background_surface bg;
309 struct ivi_panel_surface panel;
310 struct ivi_popup_surface popup;
311 struct ivi_fullscreen_surface fullscreen;
312 struct ivi_split_surface split;
313 struct ivi_remote_surface remote;
316 struct ivi_surface_waltham waltham_surface;
317 struct wl_listener listener_advertise_app;
318 struct wl_signal signal_advertise_app;
321 struct ivi_shell_seat {
322 struct weston_seat *seat;
323 struct weston_surface *focused_surface;
328 struct wl_listener seat_destroy_listener;
329 struct wl_listener caps_changed_listener;
330 struct wl_listener keyboard_focus_listener;
331 struct wl_listener pointer_focus_listener;
334 struct ivi_shell_client {
340 struct wl_client *client;
342 struct wl_listener client_destroy;
345 struct ivi_compositor *
346 to_ivi_compositor(struct weston_compositor *ec);
350 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
353 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
359 ivi_shell_init(struct ivi_compositor *ivi);
362 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
365 ivi_shell_create_global(struct ivi_compositor *ivi);
368 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
371 ivi_desktop_init(struct ivi_compositor *ivi);
373 struct ivi_shell_client *
374 ivi_shell_client_from_wl(struct wl_client *client);
377 to_ivi_output(struct weston_output *o);
380 ivi_set_desktop_surface(struct ivi_surface *surface);
383 * removes the pending popup one
386 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
389 ivi_reflow_outputs(struct ivi_compositor *ivi);
392 to_ivi_surface(struct weston_surface *surface);
395 ivi_layout_set_mapped(struct ivi_surface *surface);
398 ivi_layout_set_position(struct ivi_surface *surface,
399 int32_t x, int32_t y,
400 int32_t width, int32_t height);
403 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
406 ivi_layout_commit(struct ivi_compositor *ivi);
409 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
412 ivi_layout_activate(struct ivi_output *output, const char *app_id);
415 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
418 ivi_layout_desktop_committed(struct ivi_surface *surf);
420 ivi_layout_remote_committed(struct ivi_surface *surf);
423 ivi_layout_popup_committed(struct ivi_surface *surface);
426 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
429 ivi_layout_split_committed(struct ivi_surface *surface);
432 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
435 ivi_layout_desktop_resize(struct ivi_surface *surface,
436 struct weston_geometry area);
439 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
442 insert_black_curtain(struct ivi_output *output);
445 remove_black_curtain(struct ivi_output *output);
448 output_has_black_curtain(struct ivi_output *output);
451 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
454 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
458 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
461 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
462 const char *data, uint32_t app_state);
464 ivi_screenshooter_create(struct ivi_compositor *ivi);
467 ivi_seat_init(struct ivi_compositor *ivi);
470 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
473 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
474 struct ivi_surface *surface);
476 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
479 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
480 enum ivi_surface_role *role);
483 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
485 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
488 ivi_shell_finalize(struct ivi_compositor *ivi);
491 get_ivi_shell_surface(struct weston_surface *surface);
493 struct ivi_shell_seat *
494 get_ivi_shell_seat(struct weston_seat *seat);
497 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
500 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
501 struct ivi_shell_seat *ivi_seat,
504 sigchld_handler(int signal_number, void *data);
507 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
508 enum agl_shell_app_state state);
510 ivi_layout_destroy_saved_outputs(struct ivi_compositor *ivi);
512 struct weston_output *
513 get_default_output(struct weston_compositor *compositor);
515 struct weston_output *
516 get_focused_output(struct weston_compositor *compositor);
519 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
520 const char *output_name);
522 ivi_surface_count_one(struct ivi_output *ivi_output,
523 enum ivi_surface_role role);