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 hide_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         const struct weston_transmitter_api *waltham_transmitter_api;
  81
  82         struct wl_global *agl_shell;
  83         struct wl_global *agl_shell_desktop;
  84         struct wl_global *agl_shell_ext;
  85
  86         struct {
  87                 struct wl_client *client;
  88                 struct wl_resource *resource;
  89
  90                 struct wl_client *client_ext;
  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_resource *resource;
  98                 bool doas_requested;
  99                 enum agl_shell_bound_status status;
 100         } shell_client_ext;
 101
 102         struct wl_list desktop_clients; /* desktop_client::link */
 103
 104         struct wl_list outputs; /* ivi_output.link */
 105         struct wl_list surfaces; /* ivi_surface.link */
 106
 107         struct weston_desktop *desktop;
 108         struct wl_listener seat_created_listener;
 109         struct ivi_policy *policy;
 110
 111         struct wl_list pending_surfaces;
 112         struct wl_list popup_pending_apps;
 113         struct wl_list fullscreen_pending_apps;
 114         struct wl_list split_pending_apps;
 115         struct wl_list remote_pending_apps;
 116
 117         struct wl_listener destroy_listener;
 118
 119         struct weston_layer hidden;
 120         struct weston_layer background;
 121         struct weston_layer normal;
 122         struct weston_layer panel;
 123         struct weston_layer popup;
 124         struct weston_layer fullscreen;
 125
 126         struct wl_list child_process_list;
 127 };
 128
 129 struct ivi_surface;
 130
 131 enum ivi_output_type {
 132         OUTPUT_LOCAL,
 133         OUTPUT_REMOTE,
 134         /* same as remote but we need to signal the transmitter plug-in
 135          * for the surfaces to have to be forwarded to those remoted outputs */
 136         OUTPUT_WALTHAM,
 137 };
 138
 139 struct ivi_output {
 140         struct wl_list link; /* ivi_compositor.outputs */
 141         struct ivi_compositor *ivi;
 142
 143         char *name;
 144         struct weston_config_section *config;
 145         struct weston_output *output;
 146
 147         struct ivi_surface *background;
 148         /* Panels */
 149         struct ivi_surface *top;
 150         struct ivi_surface *bottom;
 151         struct ivi_surface *left;
 152         struct ivi_surface *right;
 153
 154         /* for the black surface */
 155         struct fullscreen_view {
 156                 struct ivi_surface *fs;
 157                 struct wl_listener fs_destroy;
 158         } fullscreen_view;
 159
 160         struct wl_listener output_destroy;
 161
 162         /*
 163          * Usable area for normal clients, i.e. with panels removed.
 164          * In output-coorrdinate space.
 165          */
 166         struct weston_geometry area;
 167         struct weston_geometry area_saved;
 168         /*
 169          * Potential user-specified non-default activation area
 170          */
 171         struct weston_geometry area_activation;
 172
 173         struct ivi_surface *active;
 174         struct ivi_surface *previous_active;
 175
 176         /* Temporary: only used during configuration */
 177         size_t add_len;
 178         struct weston_head *add[8];
 179
 180         char *app_id;
 181         enum ivi_output_type type;
 182 };
 183
 184 enum ivi_surface_role {
 185         IVI_SURFACE_ROLE_NONE,
 186         IVI_SURFACE_ROLE_DESKTOP,
 187         IVI_SURFACE_ROLE_BACKGROUND,
 188         IVI_SURFACE_ROLE_PANEL,
 189         IVI_SURFACE_ROLE_POPUP,
 190         IVI_SURFACE_ROLE_FULLSCREEN,
 191         IVI_SURFACE_ROLE_SPLIT_V,
 192         IVI_SURFACE_ROLE_SPLIT_H,
 193         IVI_SURFACE_ROLE_REMOTE,
 194 };
 195
 196 struct ivi_bounding_box {
 197         int x; int y;
 198         int width; int height;
 199 };
 200
 201 struct pending_popup {
 202         struct ivi_output *ioutput;
 203         char *app_id;
 204         int x; int y;
 205         struct ivi_bounding_box bb;
 206
 207         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 208 };
 209
 210 struct pending_fullscreen {
 211         struct ivi_output *ioutput;
 212         char *app_id;
 213         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 214 };
 215
 216 struct pending_split {
 217         struct ivi_output *ioutput;
 218         char *app_id;
 219         uint32_t orientation;
 220         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 221 };
 222
 223 struct pending_remote {
 224         struct ivi_output *ioutput;
 225         char *app_id;
 226         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 227 };
 228
 229 struct ivi_desktop_surface {
 230         struct ivi_output *pending_output;
 231         struct ivi_output *last_output;
 232 };
 233
 234 struct ivi_background_surface {
 235         struct ivi_output *output;
 236 };
 237
 238 struct ivi_popup_surface {
 239         struct ivi_output *output;
 240         int x; int y; /* initial position */
 241         struct ivi_bounding_box bb;     /* bounding box */
 242 };
 243
 244 struct ivi_fullscreen_surface {
 245         struct ivi_output *output;
 246 };
 247
 248 struct ivi_split_surface {
 249         struct ivi_output *output;
 250         uint32_t orientation;
 251 };
 252
 253 struct ivi_remote_surface {
 254         struct ivi_output *output;
 255 };
 256
 257 struct ivi_panel_surface {
 258         struct ivi_output *output;
 259         enum agl_shell_edge edge;
 260 };
 261
 262 enum ivi_surface_flags {
 263         IVI_SURFACE_PROP_MAP = (1 << 0),
 264         /* x, y, width, height */
 265         IVI_SURFACE_PROP_POSITION = (1 << 1),
 266 };
 267
 268 /* the waltham surface is a pointer type as well and
 269  * in order to avoid adding ifdef for waltham use a
 270  * generic pointer, which will be only be valid when the
 271  * surface is a remote out on a waltham type of output */
 272 struct ivi_surface_waltham {
 273         void *transmitter_surface;
 274 };
 275
 276 struct ivi_surface {
 277         struct ivi_compositor *ivi;
 278         struct weston_desktop_surface *dsurface;
 279         struct weston_view *view;
 280         struct ivi_output *hidden_layer_output;
 281         struct ivi_output *current_completed_output;
 282
 283         struct wl_list link;
 284         int focus_count;
 285
 286         struct {
 287                 enum ivi_surface_flags flags;
 288                 int32_t x, y;
 289                 int32_t width, height;
 290         } pending;
 291         bool mapped;
 292         bool advertised_on_launch;
 293         bool checked_pending;
 294         enum {
 295                 NORMAL,
 296                 RESIZING,
 297                 FULLSCREEN,
 298                 HIDDEN,
 299         } state;
 300
 301         enum ivi_surface_role role;
 302         union {
 303                 struct ivi_desktop_surface desktop;
 304                 struct ivi_background_surface bg;
 305                 struct ivi_panel_surface panel;
 306                 struct ivi_popup_surface popup;
 307                 struct ivi_fullscreen_surface fullscreen;
 308                 struct ivi_split_surface split;
 309                 struct ivi_remote_surface remote;
 310         };
 311
 312         struct ivi_surface_waltham waltham_surface;
 313         struct wl_listener listener_advertise_app;
 314         struct wl_signal signal_advertise_app;
 315 };
 316
 317 struct ivi_shell_seat {
 318         struct weston_seat *seat;
 319         struct weston_surface *focused_surface;
 320
 321         bool hide_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);
 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
 416 void
 417 ivi_layout_popup_committed(struct ivi_surface *surface);
 418
 419 void
 420 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 421
 422 void
 423 ivi_layout_split_committed(struct ivi_surface *surface);
 424
 425 void
 426 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 427
 428 void
 429 ivi_layout_desktop_resize(struct ivi_surface *surface,
 430                           struct weston_geometry area);
 431
 432 struct ivi_output *
 433 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 434
 435 void
 436 insert_black_curtain(struct ivi_output *output);
 437
 438 void
 439 remove_black_curtain(struct ivi_output *output);
 440
 441 bool
 442 output_has_black_curtain(struct ivi_output *output);
 443
 444 const char *
 445 ivi_layout_get_surface_role_name(struct ivi_surface *surf);
 446
 447 void
 448 ivi_set_pending_desktop_surface_remote(struct ivi_output *ioutput,
 449                 const char *app_id);
 450
 451 struct ivi_output *
 452 ivi_layout_find_with_app_id(const char *app_id, struct ivi_compositor *ivi);
 453
 454 void
 455 shell_advertise_app_state(struct ivi_compositor *ivi, const char *app_id,
 456                           const char *data, uint32_t app_state);
 457 void
 458 ivi_screenshooter_create(struct ivi_compositor *ivi);
 459
 460 void
 461 ivi_seat_init(struct ivi_compositor *ivi);
 462
 463 void
 464 ivi_seat_reset_caps_sent(struct ivi_compositor *ivi);
 465
 466 void
 467 agl_shell_desktop_advertise_application_id(struct ivi_compositor *ivi,
 468                                            struct ivi_surface *surface);
 469 void
 470 ivi_destroy_waltham_destroy(struct ivi_surface *surface);
 471
 472 void
 473 ivi_check_pending_surface_desktop(struct ivi_surface *surface,
 474                                   enum ivi_surface_role *role);
 475
 476 struct ivi_output *
 477 ivi_layout_find_bg_output(struct ivi_compositor *ivi);
 478 void
 479 ivi_compositor_destroy_pending_surfaces(struct ivi_compositor *ivi);
 480
 481 void
 482 ivi_shell_finalize(struct ivi_compositor *ivi);
 483
 484 struct ivi_surface *
 485 get_ivi_shell_surface(struct weston_surface *surface);
 486
 487 struct ivi_shell_seat *
 488 get_ivi_shell_seat(struct weston_seat *seat);
 489
 490 struct weston_seat *
 491 get_ivi_shell_weston_first_seat(struct ivi_compositor *ivi);
 492
 493 void
 494 ivi_shell_activate_surface(struct ivi_surface *ivi_surf,
 495                           struct ivi_shell_seat *ivi_seat,
 496                           uint32_t flags);
 497 int
 498 sigchld_handler(int signal_number, void *data);
 499
 500 #endif