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