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