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