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 <weston.h>
  33 #include <libweston/backend-drm.h>
  34 #include <libweston/libweston.h>
  35 #include <libweston/windowed-output-api.h>
  36 #include <libweston/desktop.h>
  37
  38 #include "remote.h"
  39
  40 #include "agl-shell-server-protocol.h"
  41
  42 struct ivi_compositor;
  43
  44 struct desktop_client {
  45         struct wl_resource *resource;
  46         struct ivi_compositor *ivi;
  47         struct wl_list link;    /* ivi_compositor::desktop_clients */
  48 };
  49
  50 enum agl_shell_bound_status {
  51         BOUND_OK,
  52         BOUND_FAILED,
  53 };
  54
  55 struct ivi_output_config {
  56         int width;
  57         int height;
  58         int32_t scale;
  59         uint32_t transform;
  60 };
  61
  62 struct ivi_compositor {
  63         struct weston_compositor *compositor;
  64         struct weston_backend *backend;
  65         struct weston_config *config;
  66         struct ivi_output_config *parsed_options;
  67
  68         struct wl_listener heads_changed;
  69         int (*simple_output_configure)(struct weston_output *output);
  70
  71         bool init_failed;
  72         bool disable_cursor;
  73         bool activate_by_default;
  74         bool keep_pending_surfaces;
  75
  76         /*
  77          * Options parsed from command line arugments.
  78          * Overrides what is found in the config file.
  79          */
  80         struct {
  81                 /* drm */
  82                 bool use_current_mode;
  83                 /* wayland/x11 */
  84                 int width;
  85                 int height;
  86                 int scale;
  87         } cmdline;
  88         const struct weston_windowed_output_api *window_api;
  89         const struct weston_drm_output_api *drm_api;
  90         const struct weston_remoting_api *remoting_api;
  91
  92         struct wl_global *agl_shell;
  93         struct wl_global *agl_shell_desktop;
  94         struct wl_global *agl_shell_ext;
  95
  96         struct {
  97                 struct wl_client *client;
  98                 struct wl_resource *resource;
  99
 100                 /* this is for another agl-shell client, potentially used by
 101                  * the grpc-proxy */
 102                 struct wl_resource *resource_ext;
 103                 bool ready;
 104                 enum agl_shell_bound_status status;
 105         } shell_client;
 106
 107         struct {
 108                 struct wl_client *client;
 109                 struct wl_resource *resource;
 110                 bool doas_requested;
 111                 bool doas_requested_pending_bind;
 112                 enum agl_shell_bound_status status;
 113         } shell_client_ext;
 114
 115         struct wl_list desktop_clients; /* desktop_client::link */
 116
 117         struct wl_list outputs; /* ivi_output.link */
 118         struct wl_list saved_outputs; /* ivi_output.link */
 119         struct wl_list surfaces; /* ivi_surface.link */
 120
 121         struct weston_desktop *desktop;
 122         struct wl_listener seat_created_listener;
 123         struct ivi_policy *policy;
 124
 125         struct wl_list pending_surfaces;
 126         struct wl_list popup_pending_apps;
 127         struct wl_list fullscreen_pending_apps;
 128         struct wl_list split_pending_apps;
 129         struct wl_list remote_pending_apps;
 130
 131         struct wl_list pending_apps;    /** pending_app::link */
 132
 133         struct wl_listener destroy_listener;
 134         struct wl_listener transform_listener;
 135         const struct weston_xwayland_surface_api *xwayland_surface_api;
 136
 137         struct weston_layer hidden;
 138         struct weston_layer background;
 139         struct weston_layer normal;
 140         struct weston_layer panel;
 141         struct weston_layer popup;
 142         struct weston_layer fullscreen;
 143
 144         bool need_ivi_output_relayout;
 145         struct wl_list child_process_list;
 146 };
 147
 148 struct ivi_surface;
 149
 150 enum ivi_output_type {
 151         OUTPUT_LOCAL,
 152         OUTPUT_REMOTE,
 153 };
 154
 155 struct ivi_output {
 156         struct wl_list link; /* ivi_compositor.outputs */
 157         struct ivi_compositor *ivi;
 158
 159         char *name;
 160         struct weston_config_section *config;
 161         struct weston_output *output;
 162
 163         struct ivi_surface *background;
 164         /* Panels */
 165         struct ivi_surface *top;
 166         struct ivi_surface *bottom;
 167         struct ivi_surface *left;
 168         struct ivi_surface *right;
 169
 170         /* for the black surface */
 171         struct fullscreen_view {
 172                 struct ivi_surface *fs;
 173                 struct wl_listener fs_destroy;
 174                 struct weston_buffer_reference *buffer_ref;
 175         } fullscreen_view;
 176
 177         struct wl_listener output_destroy;
 178
 179         /*
 180          * Usable area for normal clients, i.e. with panels removed.
 181          * In output-coorrdinate space.
 182          */
 183         struct weston_geometry area;
 184         struct weston_geometry area_saved;
 185         /*
 186          * Potential user-specified non-default activation area
 187          */
 188         struct weston_geometry area_activation;
 189
 190         struct ivi_surface *active;
 191         struct ivi_surface *previous_active;
 192
 193         /* Temporary: only used during configuration */
 194         size_t add_len;
 195         struct weston_head *add[8];
 196
 197         char *app_ids;
 198         enum ivi_output_type type;
 199 };
 200
 201 enum ivi_surface_role {
 202         IVI_SURFACE_ROLE_NONE,
 203         IVI_SURFACE_ROLE_DESKTOP,
 204         IVI_SURFACE_ROLE_BACKGROUND,
 205         IVI_SURFACE_ROLE_PANEL,
 206         IVI_SURFACE_ROLE_POPUP,
 207         IVI_SURFACE_ROLE_FULLSCREEN,
 208         IVI_SURFACE_ROLE_SPLIT_V,
 209         IVI_SURFACE_ROLE_SPLIT_H,
 210         IVI_SURFACE_ROLE_REMOTE,
 211         IVI_SURFACE_ROLE_TILE,
 212 };
 213
 214 struct ivi_bounding_box {
 215         int x; int y;
 216         int width; int height;
 217 };
 218
 219 struct pending_popup {
 220         struct ivi_output *ioutput;
 221         char *app_id;
 222         int x; int y;
 223         struct ivi_bounding_box bb;
 224
 225         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 226 };
 227
 228 struct pending_fullscreen {
 229         struct ivi_output *ioutput;
 230         char *app_id;
 231         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 232 };
 233
 234 struct pending_split {
 235         struct ivi_output *ioutput;
 236         char *app_id;
 237         uint32_t orientation;
 238         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 239 };
 240
 241 struct pending_remote {
 242         struct ivi_output *ioutput;
 243         char *app_id;
 244         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 245 };
 246
 247 struct pending_app {
 248         struct ivi_output *ioutput;
 249         enum ivi_surface_role role;
 250         char *app_id;
 251         struct wl_list link;    /** ivi_compositor::pending_apps */
 252 };
 253
 254 struct pending_app_tile {
 255         struct pending_app base;
 256         uint32_t orientation;
 257         uint32_t width;
 258         int32_t sticky;
 259 };
 260
 261 struct ivi_desktop_surface {
 262         struct ivi_output *pending_output;
 263         struct ivi_output *last_output;
 264 };
 265
 266 struct ivi_background_surface {
 267         struct ivi_output *output;
 268 };
 269
 270 struct ivi_popup_surface {
 271         struct ivi_output *output;
 272         int x; int y; /* initial position */
 273         struct ivi_bounding_box bb;     /* bounding box */
 274 };
 275
 276 struct ivi_fullscreen_surface {
 277         struct ivi_output *output;
 278 };
 279
 280 struct ivi_split_surface {
 281         struct ivi_output *output;
 282         uint32_t orientation;
 283 };
 284
 285 struct ivi_remote_surface {
 286         struct ivi_output *output;
 287 };
 288
 289 struct ivi_panel_surface {
 290         struct ivi_output *output;
 291         enum agl_shell_edge edge;
 292 };
 293
 294 enum ivi_surface_flags {
 295         IVI_SURFACE_PROP_MAP = (1 << 0),
 296         /* x, y, width, height */
 297         IVI_SURFACE_PROP_POSITION = (1 << 1),
 298 };
 299
 300
 301 struct ivi_surface {
 302         struct ivi_compositor *ivi;
 303         struct weston_desktop_surface *dsurface;
 304         struct weston_view *view;
 305         struct ivi_output *hidden_layer_output;
 306         struct ivi_output *current_completed_output;
 307
 308         struct wl_list link;
 309         int focus_count;
 310         uint32_t orientation;
 311         int32_t sticky;
 312
 313         struct {
 314                 enum ivi_surface_flags flags;
 315                 int32_t x, y;
 316                 int32_t width, height;
 317         } pending;
 318         bool mapped;
 319         bool advertised_on_launch;
 320         bool checked_pending;
 321         enum {
 322                 NORMAL,
 323                 RESIZING,
 324                 FULLSCREEN,
 325                 HIDDEN,
 326         } state;
 327
 328         enum ivi_surface_role role;
 329         enum ivi_surface_role prev_role;
 330         union {
 331                 struct ivi_desktop_surface desktop;
 332                 struct ivi_background_surface bg;
 333                 struct ivi_panel_surface panel;
 334                 struct ivi_popup_surface popup;
 335                 struct ivi_fullscreen_surface fullscreen;
 336                 struct ivi_split_surface split;
 337                 struct ivi_remote_surface remote;
 338         };
 339
 340         struct wl_listener listener_advertise_app;
 341         struct wl_signal signal_advertise_app;
 342
 343         struct {
 344                 bool is_set;
 345                 int32_t x;
 346                 int32_t y;
 347         } xwayland;
 348 };
 349
 350 struct ivi_shell_seat {
 351         struct weston_seat *seat;
 352         struct weston_surface *focused_surface;
 353
 354         bool disable_cursor;
 355         bool new_caps_sent;
 356
 357         struct wl_listener seat_destroy_listener;
 358         struct wl_listener caps_changed_listener;
 359         struct wl_listener keyboard_focus_listener;
 360         struct wl_listener pointer_focus_listener;
 361 };
 362
 363 struct ivi_shell_client {
 364         struct wl_list link;
 365         char *command;
 366         bool require_ready;
 367
 368         pid_t pid;
 369         struct wl_client *client;
 370
 371         struct wl_listener client_destroy;
 372 };
 373
 374 struct ivi_compositor *
 375 to_ivi_compositor(struct weston_compositor *ec);
 376
 377 #ifdef HAVE_SYSTEMD
 378 int
 379 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 380 #else
 381 static int
 382 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 383 {
 384 }
 385 #endif
 386
 387 int
 388 ivi_shell_init(struct ivi_compositor *ivi);
 389
 390 void
 391 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 392
 393 int
 394 ivi_shell_create_global(struct ivi_compositor *ivi);
 395
 396 int
 397 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
 398
 399 int
 400 ivi_desktop_init(struct ivi_compositor *ivi);
 401
 402 struct ivi_shell_client *
 403 ivi_shell_client_from_wl(struct wl_client *client);
 404
 405 struct ivi_output *
 406 to_ivi_output(struct weston_output *o);
 407
 408 void
 409 ivi_set_desktop_surface(struct ivi_surface *surface);
 410
 411 /*
 412  * removes the pending popup one
 413  */
 414 void
 415 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 416
 417 void
 418 ivi_reflow_outputs(struct ivi_compositor *ivi);
 419
 420 struct ivi_surface *
 421 to_ivi_surface(struct weston_surface *surface);
 422
 423 void
 424 ivi_layout_set_mapped(struct ivi_surface *surface);
 425
 426 void
 427 ivi_layout_set_position(struct ivi_surface *surface,
 428                         int32_t x, int32_t y,
 429                         int32_t width, int32_t height);
 430
 431 struct ivi_surface *
 432 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 433
 434 void
 435 ivi_layout_commit(struct ivi_compositor *ivi);
 436
 437 void
 438 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 439
 440 void
 441 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 442
 443 void
 444 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
 445
 446 void
 447 ivi_layout_desktop_committed(struct ivi_surface *surf);
 448 void
 449 ivi_layout_remote_committed(struct ivi_surface *surf);
 450
 451 void
 452 ivi_layout_popup_committed(struct ivi_surface *surface);
 453
 454 void
 455 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 456
 457 void
 458 ivi_layout_split_committed(struct ivi_surface *surface);
 459
 460 void
 461 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 462
 463 void
 464 ivi_layout_desktop_resize(struct ivi_surface *surface,
 465                           struct weston_geometry area);
 466
 467 struct ivi_output *
 468 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 469
 470 void
 471 insert_black_curtain(struct ivi_output *output);
 472
 473 void
 474 remove_black_curtain(struct ivi_output *output);
 475
 476 bool
 477 output_has_black_curtain(struct ivi_output *output);
 478
 479 const char *
 480 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
 481
 482 void
 483 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
 484                 const char *app_id);
 485
 486 struct ivi_output *
 487 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
 488
 489 void
 490 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
 491                           const char *data, uint32_t app_state);
 492 void
 493 ivi_screenshooter_create(struct ivi_compositor *ivi);
 494
 495 void
 496 ivi_seat_init(struct ivi_compositor *ivi);
 497
 498 void
 499 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
 500
 501 void
 502 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
 503                                            struct ivi_surface *surface);
 504 void
 505 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
 506                                   enum ivi_surface_role *role);
 507
 508 struct ivi_output *
 509 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
 510 void
 511 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
 512
 513 void
 514 ivi_shell_finalize(struct ivi_compositor *ivi);
 515
 516 struct ivi_surface *
 517 get_ivi_shell_surface(struct weston_surface *surface);
 518
 519 struct ivi_shell_seat *
 520 get_ivi_shell_seat(struct weston_seat *seat);
 521
 522 struct weston_seat *
 523 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
 524
 525 void
 526 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
 527                           struct ivi_shell_seat *ivi_seat,
 528                           uint32_t flags);
 529 int
 530 sigchld_handler(int signal_number, void *data);
 531
 532 void
 533 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
 534                      enum agl_shell_app_state state);
 535 void
 536 ivi_layout_restore(struct ivi_compositor *ivi, struct ivi_output *n_output);
 537
 538 void
 539 ivi_layout_save(struct ivi_compositor *ivi, struct ivi_output *output);
 540
 541 struct weston_output *
 542 get_default_output(struct weston_compositor *compositor);
 543
 544 struct weston_output *
 545 get_focused_output(struct weston_compositor *compositor);
 546
 547 void
 548 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
 549                          const char *output_name);
 550 bool
 551 ivi_surface_count_one(struct ivi_output *ivi_output,
 552                       enum ivi_surface_role role);
 553
 554 int
 555 parse_activation_area(const char *geometry, struct ivi_output *output);
 556
 557 bool
 558 is_shell_surface_xwayland(struct ivi_surface *surf);
 559
 560 void
 561 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
 562
 563 void
 564 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
 565                              uint32_t orientation, uint32_t width, int32_t sticky,
 566                              bool to_activate);
 567 struct ivi_output_config *
 568 ivi_init_parsed_options(struct weston_compositor *compositor);
 569
 570 void
 571 ivi_process_destroy(struct wet_process *process, int status, bool call_cleanup);
 572
 573 #endif