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