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