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