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