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 disable_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         struct wl_global *agl_shell_ext;
  85
  86         struct {
  87                 struct wl_client *client;
  88                 struct wl_resource *resource;
  89
  90                 /* this is for another agl-shell client, potentially used by
  91                  * the grpc-proxy */
  92                 struct wl_resource *resource_ext;
  93                 bool ready;
  94                 enum agl_shell_bound_status status;
  95         } shell_client;
  96
  97         struct {
  98                 struct wl_client *client;
  99                 struct wl_resource *resource;
 100                 bool doas_requested;
 101                 enum agl_shell_bound_status status;
 102         } shell_client_ext;
 103
 104         struct wl_list desktop_clients; /* desktop_client::link */
 105
 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 */
 109
 110         struct weston_desktop *desktop;
 111         struct wl_listener seat_created_listener;
 112         struct ivi_policy *policy;
 113
 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;
 119
 120         struct wl_listener destroy_listener;
 121         struct wl_listener transform_listener;
 122         const struct weston_xwayland_surface_api *xwayland_surface_api;
 123
 124         struct weston_layer hidden;
 125         struct weston_layer background;
 126         struct weston_layer normal;
 127         struct weston_layer panel;
 128         struct weston_layer popup;
 129         struct weston_layer fullscreen;
 130
 131         bool need_ivi_output_relayout;
 132         struct wl_list child_process_list;
 133 };
 134
 135 struct ivi_surface;
 136
 137 enum ivi_output_type {
 138         OUTPUT_LOCAL,
 139         OUTPUT_REMOTE,
 140         /* same as remote but we need to signal the transmitter plug-in
 141          * for the surfaces to have to be forwarded to those remoted outputs */
 142         OUTPUT_WALTHAM,
 143 };
 144
 145 struct ivi_output {
 146         struct wl_list link; /* ivi_compositor.outputs */
 147         struct ivi_compositor *ivi;
 148
 149         char *name;
 150         struct weston_config_section *config;
 151         struct weston_output *output;
 152
 153         struct ivi_surface *background;
 154         /* Panels */
 155         struct ivi_surface *top;
 156         struct ivi_surface *bottom;
 157         struct ivi_surface *left;
 158         struct ivi_surface *right;
 159
 160         /* for the black surface */
 161         struct fullscreen_view {
 162                 struct ivi_surface *fs;
 163                 struct wl_listener fs_destroy;
 164         } fullscreen_view;
 165
 166         struct wl_listener output_destroy;
 167
 168         /*
 169          * Usable area for normal clients, i.e. with panels removed.
 170          * In output-coorrdinate space.
 171          */
 172         struct weston_geometry area;
 173         struct weston_geometry area_saved;
 174         /*
 175          * Potential user-specified non-default activation area
 176          */
 177         struct weston_geometry area_activation;
 178
 179         struct ivi_surface *active;
 180         struct ivi_surface *previous_active;
 181
 182         /* Temporary: only used during configuration */
 183         size_t add_len;
 184         struct weston_head *add[8];
 185
 186         char *app_ids;
 187         enum ivi_output_type type;
 188 };
 189
 190 enum ivi_surface_role {
 191         IVI_SURFACE_ROLE_NONE,
 192         IVI_SURFACE_ROLE_DESKTOP,
 193         IVI_SURFACE_ROLE_BACKGROUND,
 194         IVI_SURFACE_ROLE_PANEL,
 195         IVI_SURFACE_ROLE_POPUP,
 196         IVI_SURFACE_ROLE_FULLSCREEN,
 197         IVI_SURFACE_ROLE_SPLIT_V,
 198         IVI_SURFACE_ROLE_SPLIT_H,
 199         IVI_SURFACE_ROLE_REMOTE,
 200 };
 201
 202 struct ivi_bounding_box {
 203         int x; int y;
 204         int width; int height;
 205 };
 206
 207 struct pending_popup {
 208         struct ivi_output *ioutput;
 209         char *app_id;
 210         int x; int y;
 211         struct ivi_bounding_box bb;
 212
 213         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 214 };
 215
 216 struct pending_fullscreen {
 217         struct ivi_output *ioutput;
 218         char *app_id;
 219         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 220 };
 221
 222 struct pending_split {
 223         struct ivi_output *ioutput;
 224         char *app_id;
 225         uint32_t orientation;
 226         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 227 };
 228
 229 struct pending_remote {
 230         struct ivi_output *ioutput;
 231         char *app_id;
 232         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 233 };
 234
 235 struct ivi_desktop_surface {
 236         struct ivi_output *pending_output;
 237         struct ivi_output *last_output;
 238 };
 239
 240 struct ivi_background_surface {
 241         struct ivi_output *output;
 242 };
 243
 244 struct ivi_popup_surface {
 245         struct ivi_output *output;
 246         int x; int y; /* initial position */
 247         struct ivi_bounding_box bb;     /* bounding box */
 248 };
 249
 250 struct ivi_fullscreen_surface {
 251         struct ivi_output *output;
 252 };
 253
 254 struct ivi_split_surface {
 255         struct ivi_output *output;
 256         uint32_t orientation;
 257 };
 258
 259 struct ivi_remote_surface {
 260         struct ivi_output *output;
 261 };
 262
 263 struct ivi_panel_surface {
 264         struct ivi_output *output;
 265         enum agl_shell_edge edge;
 266 };
 267
 268 enum ivi_surface_flags {
 269         IVI_SURFACE_PROP_MAP = (1 << 0),
 270         /* x, y, width, height */
 271         IVI_SURFACE_PROP_POSITION = (1 << 1),
 272 };
 273
 274 /* the waltham surface is a pointer type as well and
 275  * in order to avoid adding ifdef for waltham use a
 276  * generic pointer, which will be only be valid when the
 277  * surface is a remote out on a waltham type of output */
 278 struct ivi_surface_waltham {
 279         void *transmitter_surface;
 280 };
 281
 282 struct ivi_surface {
 283         struct ivi_compositor *ivi;
 284         struct weston_desktop_surface *dsurface;
 285         struct weston_view *view;
 286         struct ivi_output *hidden_layer_output;
 287         struct ivi_output *current_completed_output;
 288
 289         struct wl_list link;
 290         int focus_count;
 291
 292         struct {
 293                 enum ivi_surface_flags flags;
 294                 int32_t x, y;
 295                 int32_t width, height;
 296         } pending;
 297         bool mapped;
 298         bool advertised_on_launch;
 299         bool checked_pending;
 300         enum {
 301                 NORMAL,
 302                 RESIZING,
 303                 FULLSCREEN,
 304                 HIDDEN,
 305         } state;
 306
 307         enum ivi_surface_role role;
 308         union {
 309                 struct ivi_desktop_surface desktop;
 310                 struct ivi_background_surface bg;
 311                 struct ivi_panel_surface panel;
 312                 struct ivi_popup_surface popup;
 313                 struct ivi_fullscreen_surface fullscreen;
 314                 struct ivi_split_surface split;
 315                 struct ivi_remote_surface remote;
 316         };
 317
 318         struct ivi_surface_waltham waltham_surface;
 319         struct wl_listener listener_advertise_app;
 320         struct wl_signal signal_advertise_app;
 321
 322         struct {
 323                 bool is_set;
 324                 int32_t x;
 325                 int32_t y;
 326         } xwayland;
 327 };
 328
 329 struct ivi_shell_seat {
 330         struct weston_seat *seat;
 331         struct weston_surface *focused_surface;
 332
 333         bool disable_cursor;
 334         bool new_caps_sent;
 335
 336         struct wl_listener seat_destroy_listener;
 337         struct wl_listener caps_changed_listener;
 338         struct wl_listener keyboard_focus_listener;
 339         struct wl_listener pointer_focus_listener;
 340 };
 341
 342 struct ivi_shell_client {
 343         struct wl_list link;
 344         char *command;
 345         bool require_ready;
 346
 347         pid_t pid;
 348         struct wl_client *client;
 349
 350         struct wl_listener client_destroy;
 351 };
 352
 353 struct ivi_compositor *
 354 to_ivi_compositor(struct weston_compositor *ec);
 355
 356 #ifdef HAVE_SYSTEMD
 357 int
 358 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 359 #else
 360 static int
 361 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 362 {
 363 }
 364 #endif
 365
 366 int
 367 ivi_shell_init(struct ivi_compositor *ivi);
 368
 369 void
 370 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 371
 372 int
 373 ivi_shell_create_global(struct ivi_compositor *ivi);
 374
 375 int
 376 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
 377
 378 int
 379 ivi_desktop_init(struct ivi_compositor *ivi);
 380
 381 struct ivi_shell_client *
 382 ivi_shell_client_from_wl(struct wl_client *client);
 383
 384 struct ivi_output *
 385 to_ivi_output(struct weston_output *o);
 386
 387 void
 388 ivi_set_desktop_surface(struct ivi_surface *surface);
 389
 390 /*
 391  * removes the pending popup one
 392  */
 393 void
 394 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 395
 396 void
 397 ivi_reflow_outputs(struct ivi_compositor *ivi);
 398
 399 struct ivi_surface *
 400 to_ivi_surface(struct weston_surface *surface);
 401
 402 void
 403 ivi_layout_set_mapped(struct ivi_surface *surface);
 404
 405 void
 406 ivi_layout_set_position(struct ivi_surface *surface,
 407                         int32_t x, int32_t y,
 408                         int32_t width, int32_t height);
 409
 410 struct ivi_surface *
 411 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 412
 413 void
 414 ivi_layout_commit(struct ivi_compositor *ivi);
 415
 416 void
 417 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 418
 419 void
 420 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 421
 422 void
 423 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
 424
 425 void
 426 ivi_layout_desktop_committed(struct ivi_surface *surf);
 427 void
 428 ivi_layout_remote_committed(struct ivi_surface *surf);
 429
 430 void
 431 ivi_layout_popup_committed(struct ivi_surface *surface);
 432
 433 void
 434 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 435
 436 void
 437 ivi_layout_split_committed(struct ivi_surface *surface);
 438
 439 void
 440 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 441
 442 void
 443 ivi_layout_desktop_resize(struct ivi_surface *surface,
 444                           struct weston_geometry area);
 445
 446 struct ivi_output *
 447 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 448
 449 void
 450 insert_black_curtain(struct ivi_output *output);
 451
 452 void
 453 remove_black_curtain(struct ivi_output *output);
 454
 455 bool
 456 output_has_black_curtain(struct ivi_output *output);
 457
 458 const char *
 459 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
 460
 461 void
 462 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
 463                 const char *app_id);
 464
 465 struct ivi_output *
 466 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
 467
 468 void
 469 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
 470                           const char *data, uint32_t app_state);
 471 void
 472 ivi_screenshooter_create(struct ivi_compositor *ivi);
 473
 474 void
 475 ivi_seat_init(struct ivi_compositor *ivi);
 476
 477 void
 478 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
 479
 480 void
 481 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
 482                                            struct ivi_surface *surface);
 483 void
 484 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
 485
 486 void
 487 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
 488                                   enum ivi_surface_role *role);
 489
 490 struct ivi_output *
 491 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
 492 void
 493 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
 494
 495 void
 496 ivi_shell_finalize(struct ivi_compositor *ivi);
 497
 498 struct ivi_surface *
 499 get_ivi_shell_surface(struct weston_surface *surface);
 500
 501 struct ivi_shell_seat *
 502 get_ivi_shell_seat(struct weston_seat *seat);
 503
 504 struct weston_seat *
 505 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
 506
 507 void
 508 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
 509                           struct ivi_shell_seat *ivi_seat,
 510                           uint32_t flags);
 511 int
 512 sigchld_handler(int signal_number, void *data);
 513
 514 void
 515 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
 516                      enum agl_shell_app_state state);
 517 void
 518 ivi_layout_destroy_saved_outputs(struct ivi_compositor *ivi);
 519
 520 struct weston_output *
 521 get_default_output(struct weston_compositor *compositor);
 522
 523 struct weston_output *
 524 get_focused_output(struct weston_compositor *compositor);
 525
 526 void
 527 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
 528                          const char *output_name);
 529 bool
 530 ivi_surface_count_one(struct ivi_output *ivi_output,
 531                       enum ivi_surface_role role);
 532
 533 #endif