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