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