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.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                 struct weston_buffer_reference *buffer_ref;
 173         } fullscreen_view;
 174
 175         struct wl_listener output_destroy;
 176
 177         /*
 178          * Usable area for normal clients, i.e. with panels removed.
 179          * In output-coorrdinate space.
 180          */
 181         struct weston_geometry area;
 182         struct weston_geometry area_saved;
 183         /*
 184          * Potential user-specified non-default activation area
 185          */
 186         struct weston_geometry area_activation;
 187
 188         struct ivi_surface *active;
 189         struct ivi_surface *previous_active;
 190
 191         /* Temporary: only used during configuration */
 192         size_t add_len;
 193         struct weston_head *add[8];
 194
 195         char *app_ids;
 196         enum ivi_output_type type;
 197 };
 198
 199 enum ivi_surface_role {
 200         IVI_SURFACE_ROLE_NONE,
 201         IVI_SURFACE_ROLE_DESKTOP,
 202         IVI_SURFACE_ROLE_BACKGROUND,
 203         IVI_SURFACE_ROLE_PANEL,
 204         IVI_SURFACE_ROLE_POPUP,
 205         IVI_SURFACE_ROLE_FULLSCREEN,
 206         IVI_SURFACE_ROLE_SPLIT_V,
 207         IVI_SURFACE_ROLE_SPLIT_H,
 208         IVI_SURFACE_ROLE_REMOTE,
 209         IVI_SURFACE_ROLE_TILE,
 210 };
 211
 212 struct ivi_bounding_box {
 213         int x; int y;
 214         int width; int height;
 215 };
 216
 217 struct pending_popup {
 218         struct ivi_output *ioutput;
 219         char *app_id;
 220         int x; int y;
 221         struct ivi_bounding_box bb;
 222
 223         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 224 };
 225
 226 struct pending_fullscreen {
 227         struct ivi_output *ioutput;
 228         char *app_id;
 229         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 230 };
 231
 232 struct pending_split {
 233         struct ivi_output *ioutput;
 234         char *app_id;
 235         uint32_t orientation;
 236         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 237 };
 238
 239 struct pending_remote {
 240         struct ivi_output *ioutput;
 241         char *app_id;
 242         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 243 };
 244
 245 struct pending_app {
 246         struct ivi_output *ioutput;
 247         enum ivi_surface_role role;
 248         char *app_id;
 249         struct wl_list link;    /** ivi_compositor::pending_apps */
 250 };
 251
 252 struct pending_app_tile {
 253         struct pending_app base;
 254         uint32_t orientation;
 255         uint32_t width;
 256         int32_t sticky;
 257 };
 258
 259 struct ivi_desktop_surface {
 260         struct ivi_output *pending_output;
 261         struct ivi_output *last_output;
 262 };
 263
 264 struct ivi_background_surface {
 265         struct ivi_output *output;
 266 };
 267
 268 struct ivi_popup_surface {
 269         struct ivi_output *output;
 270         int x; int y; /* initial position */
 271         struct ivi_bounding_box bb;     /* bounding box */
 272 };
 273
 274 struct ivi_fullscreen_surface {
 275         struct ivi_output *output;
 276 };
 277
 278 struct ivi_split_surface {
 279         struct ivi_output *output;
 280         uint32_t orientation;
 281 };
 282
 283 struct ivi_remote_surface {
 284         struct ivi_output *output;
 285 };
 286
 287 struct ivi_panel_surface {
 288         struct ivi_output *output;
 289         enum agl_shell_edge edge;
 290 };
 291
 292 enum ivi_surface_flags {
 293         IVI_SURFACE_PROP_MAP = (1 << 0),
 294         /* x, y, width, height */
 295         IVI_SURFACE_PROP_POSITION = (1 << 1),
 296 };
 297
 298
 299 struct ivi_surface {
 300         struct ivi_compositor *ivi;
 301         struct weston_desktop_surface *dsurface;
 302         struct weston_view *view;
 303         struct ivi_output *hidden_layer_output;
 304         struct ivi_output *current_completed_output;
 305
 306         struct wl_list link;
 307         int focus_count;
 308         uint32_t orientation;
 309         int32_t sticky;
 310
 311         struct {
 312                 enum ivi_surface_flags flags;
 313                 int32_t x, y;
 314                 int32_t width, height;
 315         } pending;
 316         bool mapped;
 317         bool advertised_on_launch;
 318         bool checked_pending;
 319         enum {
 320                 NORMAL,
 321                 RESIZING,
 322                 FULLSCREEN,
 323                 HIDDEN,
 324         } state;
 325
 326         enum ivi_surface_role role;
 327         enum ivi_surface_role prev_role;
 328         union {
 329                 struct ivi_desktop_surface desktop;
 330                 struct ivi_background_surface bg;
 331                 struct ivi_panel_surface panel;
 332                 struct ivi_popup_surface popup;
 333                 struct ivi_fullscreen_surface fullscreen;
 334                 struct ivi_split_surface split;
 335                 struct ivi_remote_surface remote;
 336         };
 337
 338         struct wl_listener listener_advertise_app;
 339         struct wl_signal signal_advertise_app;
 340
 341         struct {
 342                 bool is_set;
 343                 int32_t x;
 344                 int32_t y;
 345         } xwayland;
 346 };
 347
 348 struct ivi_shell_seat {
 349         struct weston_seat *seat;
 350         struct weston_surface *focused_surface;
 351
 352         bool disable_cursor;
 353         bool new_caps_sent;
 354
 355         struct wl_listener seat_destroy_listener;
 356         struct wl_listener caps_changed_listener;
 357         struct wl_listener keyboard_focus_listener;
 358         struct wl_listener pointer_focus_listener;
 359 };
 360
 361 struct ivi_shell_client {
 362         struct wl_list link;
 363         char *command;
 364         bool require_ready;
 365
 366         pid_t pid;
 367         struct wl_client *client;
 368
 369         struct wl_listener client_destroy;
 370 };
 371
 372 struct ivi_compositor *
 373 to_ivi_compositor(struct weston_compositor *ec);
 374
 375 #ifdef HAVE_SYSTEMD
 376 int
 377 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 378 #else
 379 static int
 380 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 381 {
 382 }
 383 #endif
 384
 385 int
 386 ivi_shell_init(struct ivi_compositor *ivi);
 387
 388 void
 389 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 390
 391 int
 392 ivi_shell_create_global(struct ivi_compositor *ivi);
 393
 394 int
 395 ivi_launch_shell_client(struct ivi_compositor *ivi, const char *cmd_section, struct wl_client **client);
 396
 397 int
 398 ivi_desktop_init(struct ivi_compositor *ivi);
 399
 400 struct ivi_shell_client *
 401 ivi_shell_client_from_wl(struct wl_client *client);
 402
 403 struct ivi_output *
 404 to_ivi_output(struct weston_output *o);
 405
 406 void
 407 ivi_set_desktop_surface(struct ivi_surface *surface);
 408
 409 /*
 410  * removes the pending popup one
 411  */
 412 void
 413 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 414
 415 void
 416 ivi_reflow_outputs(struct ivi_compositor *ivi);
 417
 418 struct ivi_surface *
 419 to_ivi_surface(struct weston_surface *surface);
 420
 421 void
 422 ivi_layout_set_mapped(struct ivi_surface *surface);
 423
 424 void
 425 ivi_layout_set_position(struct ivi_surface *surface,
 426                         int32_t x, int32_t y,
 427                         int32_t width, int32_t height);
 428
 429 struct ivi_surface *
 430 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 431
 432 void
 433 ivi_layout_commit(struct ivi_compositor *ivi);
 434
 435 void
 436 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 437
 438 void
 439 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 440
 441 void
 442 ivi_layout_activate_by_surf(struct ivi_output *output, struct ivi_surface *surf);
 443
 444 void
 445 ivi_layout_desktop_committed(struct ivi_surface *surf);
 446 void
 447 ivi_layout_remote_committed(struct ivi_surface *surf);
 448
 449 void
 450 ivi_layout_popup_committed(struct ivi_surface *surface);
 451
 452 void
 453 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 454
 455 void
 456 ivi_layout_split_committed(struct ivi_surface *surface);
 457
 458 void
 459 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 460
 461 void
 462 ivi_layout_desktop_resize(struct ivi_surface *surface,
 463                           struct weston_geometry area);
 464
 465 struct ivi_output *
 466 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 467
 468 void
 469 insert_black_curtain(struct ivi_output *output);
 470
 471 void
 472 remove_black_curtain(struct ivi_output *output);
 473
 474 bool
 475 output_has_black_curtain(struct ivi_output *output);
 476
 477 const char *
 478 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
 479
 480 void
 481 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
 482                 const char *app_id);
 483
 484 struct ivi_output *
 485 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
 486
 487 void
 488 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
 489                           const char *data, uint32_t app_state);
 490 void
 491 ivi_screenshooter_create(struct ivi_compositor *ivi);
 492
 493 void
 494 ivi_seat_init(struct ivi_compositor *ivi);
 495
 496 void
 497 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
 498
 499 void
 500 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
 501                                            struct ivi_surface *surface);
 502 void
 503 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
 504                                   enum ivi_surface_role *role);
 505
 506 struct ivi_output *
 507 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
 508 void
 509 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
 510
 511 void
 512 ivi_shell_finalize(struct ivi_compositor *ivi);
 513
 514 struct ivi_surface *
 515 get_ivi_shell_surface(struct weston_surface *surface);
 516
 517 struct ivi_shell_seat *
 518 get_ivi_shell_seat(struct weston_seat *seat);
 519
 520 struct weston_seat *
 521 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
 522
 523 void
 524 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
 525                           struct ivi_shell_seat *ivi_seat,
 526                           uint32_t flags);
 527 int
 528 sigchld_handler(int signal_number, void *data);
 529
 530 void
 531 shell_send_app_state(struct ivi_compositor *ivi, const char *app_id,
 532                      enum agl_shell_app_state state);
 533 void
 534 ivi_layout_destroy_saved_outputs(struct ivi_compositor *ivi);
 535
 536 struct weston_output *
 537 get_default_output(struct weston_compositor *compositor);
 538
 539 struct weston_output *
 540 get_focused_output(struct weston_compositor *compositor);
 541
 542 void
 543 shell_send_app_on_output(struct ivi_compositor *ivi, const char *app_id,
 544                          const char *output_name);
 545 bool
 546 ivi_surface_count_one(struct ivi_output *ivi_output,
 547                       enum ivi_surface_role role);
 548
 549 int
 550 parse_activation_area(const char *geometry, struct ivi_output *output);
 551
 552 bool
 553 is_shell_surface_xwayland(struct ivi_surface *surf);
 554
 555 void
 556 ivi_layout_reset_split_surfaces(struct ivi_compositor *ivi);
 557
 558 void
 559 _ivi_set_shell_surface_split(struct ivi_surface *surface, struct ivi_output *output,
 560                              uint32_t orientation, uint32_t width, int32_t sticky,
 561                              bool to_activate);
 562 struct ivi_output_config *
 563 ivi_init_parsed_options(struct weston_compositor *compositor);
 564
 565 #endif