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