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