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