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