src/ivi-compositor.h

   1 /*
   2  * Copyright © 2019 Collabora, Ltd.
   3  *
   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:
  11  *
  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.
  15  *
  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
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef IVI_COMPOSITOR_H
  27 #define IVI_COMPOSITOR_H
  28
  29 #include <stdbool.h>
  30 #include "config.h"
  31
  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>
  36
  37 #include "remote.h"
  38
  39 #include "agl-shell-server-protocol.h"
  40
  41 struct ivi_compositor;
  42
  43 struct desktop_client {
  44         struct wl_resource *resource;
  45         struct ivi_compositor *ivi;
  46         struct wl_list link;    /* ivi_compositor::desktop_clients */
  47 };
  48
  49 enum agl_shell_bound_status {
  50         BOUND_OK,
  51         BOUND_FAILED,
  52 };
  53
  54 struct ivi_compositor {
  55         struct weston_compositor *compositor;
  56         struct weston_config *config;
  57
  58         struct wl_listener heads_changed;
  59
  60         bool init_failed;
  61         bool hide_cursor;
  62         bool activate_by_default;
  63         bool keep_pending_surfaces;
  64
  65         /*
  66          * Options parsed from command line arugments.
  67          * Overrides what is found in the config file.
  68          */
  69         struct {
  70                 /* drm */
  71                 bool use_current_mode;
  72                 /* wayland/x11 */
  73                 int width;
  74                 int height;
  75                 int scale;
  76         } cmdline;
  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;
  81
  82         struct wl_global *agl_shell;
  83         struct wl_global *agl_shell_desktop;
  84
  85         struct {
  86                 struct wl_client *client;
  87                 struct wl_resource *resource;
  88                 bool ready;
  89                 enum agl_shell_bound_status status;
  90         } shell_client;
  91
  92         struct wl_list desktop_clients; /* desktop_client::link */
  93
  94         struct wl_list outputs; /* ivi_output.link */
  95         struct wl_list surfaces; /* ivi_surface.link */
  96
  97         struct weston_desktop *desktop;
  98         struct wl_listener seat_created_listener;
  99         struct ivi_policy *policy;
 100
 101         struct wl_list pending_surfaces;
 102         struct wl_list popup_pending_apps;
 103         struct wl_list fullscreen_pending_apps;
 104         struct wl_list split_pending_apps;
 105         struct wl_list remote_pending_apps;
 106
 107         struct wl_listener destroy_listener;
 108
 109         struct weston_layer hidden;
 110         struct weston_layer background;
 111         struct weston_layer normal;
 112         struct weston_layer panel;
 113         struct weston_layer popup;
 114         struct weston_layer fullscreen;
 115
 116         struct wl_list child_process_list;
 117 };
 118
 119 struct ivi_surface;
 120
 121 enum ivi_output_type {
 122         OUTPUT_LOCAL,
 123         OUTPUT_REMOTE,
 124         /* same as remote but we need to signal the transmitter plug-in
 125          * for the surfaces to have to be forwarded to those remoted outputs */
 126         OUTPUT_WALTHAM,
 127 };
 128
 129 struct ivi_output {
 130         struct wl_list link; /* ivi_compositor.outputs */
 131         struct ivi_compositor *ivi;
 132
 133         char *name;
 134         struct weston_config_section *config;
 135         struct weston_output *output;
 136
 137         struct ivi_surface *background;
 138         /* Panels */
 139         struct ivi_surface *top;
 140         struct ivi_surface *bottom;
 141         struct ivi_surface *left;
 142         struct ivi_surface *right;
 143
 144         /* for the black surface */
 145         struct fullscreen_view {
 146                 struct ivi_surface *fs;
 147                 struct wl_listener fs_destroy;
 148         } fullscreen_view;
 149
 150         struct wl_listener output_destroy;
 151
 152         /*
 153          * Usable area for normal clients, i.e. with panels removed.
 154          * In output-coorrdinate space.
 155          */
 156         struct weston_geometry area;
 157         struct weston_geometry area_saved;
 158
 159         struct ivi_surface *active;
 160         struct ivi_surface *previous_active;
 161
 162         /* Temporary: only used during configuration */
 163         size_t add_len;
 164         struct weston_head *add[8];
 165
 166         char *app_id;
 167         enum ivi_output_type type;
 168 };
 169
 170 enum ivi_surface_role {
 171         IVI_SURFACE_ROLE_NONE,
 172         IVI_SURFACE_ROLE_DESKTOP,
 173         IVI_SURFACE_ROLE_BACKGROUND,
 174         IVI_SURFACE_ROLE_PANEL,
 175         IVI_SURFACE_ROLE_POPUP,
 176         IVI_SURFACE_ROLE_FULLSCREEN,
 177         IVI_SURFACE_ROLE_SPLIT_V,
 178         IVI_SURFACE_ROLE_SPLIT_H,
 179         IVI_SURFACE_ROLE_REMOTE,
 180 };
 181
 182 struct ivi_bounding_box {
 183         int x; int y;
 184         int width; int height;
 185 };
 186
 187 struct pending_popup {
 188         struct ivi_output *ioutput;
 189         char *app_id;
 190         int x; int y;
 191         struct ivi_bounding_box bb;
 192
 193         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 194 };
 195
 196 struct pending_fullscreen {
 197         struct ivi_output *ioutput;
 198         char *app_id;
 199         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 200 };
 201
 202 struct pending_split {
 203         struct ivi_output *ioutput;
 204         char *app_id;
 205         uint32_t orientation;
 206         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 207 };
 208
 209 struct pending_remote {
 210         struct ivi_output *ioutput;
 211         char *app_id;
 212         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 213 };
 214
 215 struct ivi_desktop_surface {
 216         struct ivi_output *pending_output;
 217         struct ivi_output *last_output;
 218 };
 219
 220 struct ivi_background_surface {
 221         struct ivi_output *output;
 222 };
 223
 224 struct ivi_popup_surface {
 225         struct ivi_output *output;
 226         int x; int y; /* initial position */
 227         struct ivi_bounding_box bb;     /* bounding box */
 228 };
 229
 230 struct ivi_fullscreen_surface {
 231         struct ivi_output *output;
 232 };
 233
 234 struct ivi_split_surface {
 235         struct ivi_output *output;
 236         uint32_t orientation;
 237 };
 238
 239 struct ivi_remote_surface {
 240         struct ivi_output *output;
 241 };
 242
 243 struct ivi_panel_surface {
 244         struct ivi_output *output;
 245         enum agl_shell_edge edge;
 246 };
 247
 248 enum ivi_surface_flags {
 249         IVI_SURFACE_PROP_MAP = (1 << 0),
 250         /* x, y, width, height */
 251         IVI_SURFACE_PROP_POSITION = (1 << 1),
 252 };
 253
 254 /* the waltham surface is a pointer type as well and
 255  * in order to avoid adding ifdef for waltham use a
 256  * generic pointer, which will be only be valid when the
 257  * surface is a remote out on a waltham type of output */
 258 struct ivi_surface_waltham {
 259         void *transmitter_surface;
 260 };
 261
 262 struct ivi_surface {
 263         struct ivi_compositor *ivi;
 264         struct weston_desktop_surface *dsurface;
 265         struct weston_view *view;
 266         struct ivi_output *hidden_layer_output;
 267         struct ivi_output *current_completed_output;
 268
 269         struct wl_list link;
 270         int focus_count;
 271
 272         struct {
 273                 enum ivi_surface_flags flags;
 274                 int32_t x, y;
 275                 int32_t width, height;
 276         } pending;
 277         bool mapped;
 278         bool advertised_on_launch;
 279         bool checked_pending;
 280         enum {
 281                 NORMAL,
 282                 RESIZING,
 283                 FULLSCREEN,
 284                 HIDDEN,
 285         } state;
 286
 287         enum ivi_surface_role role;
 288         union {
 289                 struct ivi_desktop_surface desktop;
 290                 struct ivi_background_surface bg;
 291                 struct ivi_panel_surface panel;
 292                 struct ivi_popup_surface popup;
 293                 struct ivi_fullscreen_surface fullscreen;
 294                 struct ivi_split_surface split;
 295                 struct ivi_remote_surface remote;
 296         };
 297
 298         struct ivi_surface_waltham waltham_surface;
 299         struct wl_listener listener_advertise_app;
 300         struct wl_signal signal_advertise_app;
 301 };
 302
 303 struct ivi_shell_seat {
 304         struct weston_seat *seat;
 305         struct weston_surface *focused_surface;
 306
 307         bool hide_cursor;
 308         bool new_caps_sent;
 309
 310         struct wl_listener seat_destroy_listener;
 311         struct wl_listener caps_changed_listener;
 312         struct wl_listener keyboard_focus_listener;
 313         struct wl_listener pointer_focus_listener;
 314 };
 315
 316 struct ivi_shell_client {
 317         struct wl_list link;
 318         char *command;
 319         bool require_ready;
 320
 321         pid_t pid;
 322         struct wl_client *client;
 323
 324         struct wl_listener client_destroy;
 325 };
 326
 327 struct ivi_compositor *
 328 to_ivi_compositor(struct weston_compositor *ec);
 329
 330 #ifdef HAVE_SYSTEMD
 331 int
 332 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 333 #else
 334 static int
 335 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 336 {
 337 }
 338 #endif
 339
 340 int
 341 ivi_shell_init(struct ivi_compositor *ivi);
 342
 343 void
 344 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 345
 346 int
 347 ivi_shell_create_global(struct ivi_compositor *ivi);
 348
 349 int
 350 ivi_launch_shell_client(struct ivi_compositor *ivi);
 351
 352 int
 353 ivi_desktop_init(struct ivi_compositor *ivi);
 354
 355 struct ivi_shell_client *
 356 ivi_shell_client_from_wl(struct wl_client *client);
 357
 358 struct ivi_output *
 359 to_ivi_output(struct weston_output *o);
 360
 361 void
 362 ivi_set_desktop_surface(struct ivi_surface *surface);
 363
 364 /*
 365  * removes the pending popup one
 366  */
 367 void
 368 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 369
 370 void
 371 ivi_reflow_outputs(struct ivi_compositor *ivi);
 372
 373 struct ivi_surface *
 374 to_ivi_surface(struct weston_surface *surface);
 375
 376 void
 377 ivi_layout_set_mapped(struct ivi_surface *surface);
 378
 379 void
 380 ivi_layout_set_position(struct ivi_surface *surface,
 381                         int32_t x, int32_t y,
 382                         int32_t width, int32_t height);
 383
 384 struct ivi_surface *
 385 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 386
 387 void
 388 ivi_layout_commit(struct ivi_compositor *ivi);
 389
 390 void
 391 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 392
 393 void
 394 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 395
 396 void
 397 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
 398
 399 void
 400 ivi_layout_desktop_committed(struct ivi_surface *surf);
 401
 402 void
 403 ivi_layout_popup_committed(struct ivi_surface *surface);
 404
 405 void
 406 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 407
 408 void
 409 ivi_layout_split_committed(struct ivi_surface *surface);
 410
 411 void
 412 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 413
 414 void
 415 ivi_layout_desktop_resize(struct ivi_surface *surface,
 416                           struct weston_geometry area);
 417
 418 struct ivi_output *
 419 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 420
 421 void
 422 insert_black_curtain(struct ivi_output *output);
 423
 424 void
 425 remove_black_curtain(struct ivi_output *output);
 426
 427 bool
 428 output_has_black_curtain(struct ivi_output *output);
 429
 430 const char *
 431 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
 432
 433 void
 434 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
 435                 const char *app_id);
 436
 437 struct ivi_output *
 438 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
 439
 440 void
 441 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
 442                           const char *data, uint32_t app_state);
 443 void
 444 ivi_screenshooter_create(struct ivi_compositor *ivi);
 445
 446 void
 447 ivi_seat_init(struct ivi_compositor *ivi);
 448
 449 void
 450 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
 451
 452 void
 453 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
 454                                            struct ivi_surface *surface);
 455 void
 456 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
 457
 458 void
 459 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
 460                                   enum ivi_surface_role *role);
 461
 462 struct ivi_output *
 463 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
 464 void
 465 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
 466
 467 void
 468 ivi_shell_finalize(struct ivi_compositor *ivi);
 469
 470 struct ivi_surface *
 471 get_ivi_shell_surface(struct weston_surface *surface);
 472
 473 struct ivi_shell_seat *
 474 get_ivi_shell_seat(struct weston_seat *seat);
 475
 476 struct weston_seat *
 477 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
 478
 479 void
 480 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
 481                           struct ivi_shell_seat *ivi_seat,
 482                           uint32_t flags);
 483 int
 484 sigchld_handler(int signal_number, void *data);
 485
 486 #endif