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