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