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