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