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 "agl-shell-server-protocol.h"
  38
  39 struct ivi_compositor;
  40
  41 struct desktop_client {
  42         struct wl_resource *resource;
  43         struct ivi_compositor *ivi;
  44         struct wl_list link;    /* ivi_compositor::desktop_clients */
  45 };
  46
  47 struct ivi_compositor {
  48         struct weston_compositor *compositor;
  49         struct weston_config *config;
  50
  51         struct wl_listener heads_changed;
  52
  53         bool init_failed;
  54
  55         /*
  56          * Options parsed from command line arugments.
  57          * Overrides what is found in the config file.
  58          */
  59         struct {
  60                 /* drm */
  61                 bool use_current_mode;
  62                 /* wayland/x11 */
  63                 int width;
  64                 int height;
  65                 int scale;
  66         } cmdline;
  67         const struct weston_windowed_output_api *window_api;
  68         const struct weston_drm_output_api *drm_api;
  69
  70         struct wl_global *agl_shell;
  71         struct wl_global *agl_shell_desktop;
  72         struct {
  73                 bool activate_apps_by_default;  /* switches once xdg top level has been 'created' */
  74         } quirks;
  75
  76         struct {
  77                 struct wl_client *client;
  78                 struct wl_resource *resource;
  79                 bool ready;
  80         } shell_client;
  81
  82         struct wl_list desktop_clients; /* desktop_client::link */
  83
  84         struct wl_list outputs; /* ivi_output.link */
  85         struct wl_list surfaces; /* ivi_surface.link */
  86
  87         struct weston_desktop *desktop;
  88         struct ivi_policy *policy;
  89
  90         struct wl_list pending_surfaces;
  91         struct wl_list popup_pending_apps;
  92         struct wl_list fullscreen_pending_apps;
  93         struct wl_list split_pending_apps;
  94
  95         struct weston_layer hidden;
  96         struct weston_layer background;
  97         struct weston_layer normal;
  98         struct weston_layer panel;
  99         struct weston_layer popup;
 100         struct weston_layer fullscreen;
 101 };
 102
 103 struct ivi_surface;
 104
 105 struct ivi_output {
 106         struct wl_list link; /* ivi_compositor.outputs */
 107         struct ivi_compositor *ivi;
 108
 109         char *name;
 110         struct weston_config_section *config;
 111         struct weston_output *output;
 112
 113         struct ivi_surface *background;
 114         /* Panels */
 115         struct ivi_surface *top;
 116         struct ivi_surface *bottom;
 117         struct ivi_surface *left;
 118         struct ivi_surface *right;
 119
 120         /* for the black surface */
 121         struct fullscreen_view {
 122                 struct ivi_surface *fs;
 123                 struct wl_listener fs_destroy;
 124         } fullscreen_view;
 125
 126         struct wl_listener output_destroy;
 127
 128         /*
 129          * Usable area for normal clients, i.e. with panels removed.
 130          * In output-coorrdinate space.
 131          */
 132         struct weston_geometry area;
 133         struct weston_geometry area_saved;
 134
 135         struct ivi_surface *active;
 136         struct ivi_surface *previous_active;
 137
 138         /* Temporary: only used during configuration */
 139         size_t add_len;
 140         struct weston_head *add[8];
 141 };
 142
 143 enum ivi_surface_role {
 144         IVI_SURFACE_ROLE_NONE,
 145         IVI_SURFACE_ROLE_DESKTOP,
 146         IVI_SURFACE_ROLE_BACKGROUND,
 147         IVI_SURFACE_ROLE_PANEL,
 148         IVI_SURFACE_ROLE_POPUP,
 149         IVI_SURFACE_ROLE_FULLSCREEN,
 150         IVI_SURFACE_ROLE_SPLIT_V,
 151         IVI_SURFACE_ROLE_SPLIT_H,
 152 };
 153
 154 struct pending_popup {
 155         struct ivi_output *ioutput;
 156         char *app_id;
 157         int x; int y;
 158
 159         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 160 };
 161
 162 struct pending_fullscreen {
 163         struct ivi_output *ioutput;
 164         char *app_id;
 165         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 166 };
 167
 168 struct pending_split {
 169         struct ivi_output *ioutput;
 170         char *app_id;
 171         uint32_t orientation;
 172         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 173 };
 174
 175 struct ivi_desktop_surface {
 176         struct ivi_output *pending_output;
 177         struct ivi_output *last_output;
 178 };
 179
 180 struct ivi_background_surface {
 181         struct ivi_output *output;
 182 };
 183
 184 struct ivi_popup_surface {
 185         struct ivi_output *output;
 186         int x;
 187         int y;
 188 };
 189
 190 struct ivi_fullscreen_surface {
 191         struct ivi_output *output;
 192 };
 193
 194 struct ivi_split_surface {
 195         struct ivi_output *output;
 196         uint32_t orientation;
 197 };
 198
 199 struct ivi_panel_surface {
 200         struct ivi_output *output;
 201         enum agl_shell_edge edge;
 202 };
 203
 204 enum ivi_surface_flags {
 205         IVI_SURFACE_PROP_MAP = (1 << 0),
 206         /* x, y, width, height */
 207         IVI_SURFACE_PROP_POSITION = (1 << 1),
 208 };
 209
 210 struct ivi_surface {
 211         struct ivi_compositor *ivi;
 212         struct weston_desktop_surface *dsurface;
 213         struct weston_view *view;
 214
 215         struct wl_list link;
 216
 217         struct {
 218                 enum ivi_surface_flags flags;
 219                 int32_t x, y;
 220                 int32_t width, height;
 221         } pending;
 222         bool activated_by_default;
 223
 224         enum ivi_surface_role role;
 225         union {
 226                 struct ivi_desktop_surface desktop;
 227                 struct ivi_background_surface bg;
 228                 struct ivi_panel_surface panel;
 229                 struct ivi_popup_surface popup;
 230                 struct ivi_fullscreen_surface fullscreen;
 231                 struct ivi_split_surface split;
 232         };
 233 };
 234
 235 struct ivi_shell_client {
 236         struct wl_list link;
 237         char *command;
 238         bool require_ready;
 239
 240         pid_t pid;
 241         struct wl_client *client;
 242
 243         struct wl_listener client_destroy;
 244 };
 245
 246 struct ivi_compositor *
 247 to_ivi_compositor(struct weston_compositor *ec);
 248
 249 #ifdef HAVE_SYSTEMD
 250 int
 251 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 252 #else
 253 static int
 254 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 255 {
 256 }
 257 #endif
 258
 259 int
 260 ivi_shell_init(struct ivi_compositor *ivi);
 261
 262 void
 263 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 264
 265 int
 266 ivi_shell_create_global(struct ivi_compositor *ivi);
 267
 268 int
 269 ivi_launch_shell_client(struct ivi_compositor *ivi);
 270
 271 int
 272 ivi_desktop_init(struct ivi_compositor *ivi);
 273
 274 struct ivi_shell_client *
 275 ivi_shell_client_from_wl(struct wl_client *client);
 276
 277 struct ivi_output *
 278 to_ivi_output(struct weston_output *o);
 279
 280 void
 281 ivi_set_desktop_surface(struct ivi_surface *surface);
 282
 283 /*
 284  * removes the pending popup one
 285  */
 286 void
 287 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 288
 289 void
 290 ivi_reflow_outputs(struct ivi_compositor *ivi);
 291
 292 struct ivi_surface *
 293 to_ivi_surface(struct weston_surface *surface);
 294
 295 void
 296 ivi_layout_set_mapped(struct ivi_surface *surface);
 297
 298 void
 299 ivi_layout_set_position(struct ivi_surface *surface,
 300                         int32_t x, int32_t y,
 301                         int32_t width, int32_t height);
 302
 303 struct ivi_surface *
 304 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 305
 306 void
 307 ivi_layout_commit(struct ivi_compositor *ivi);
 308
 309 void
 310 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 311
 312 void
 313 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 314
 315 void
 316 ivi_layout_desktop_committed(struct ivi_surface *surf);
 317
 318 void
 319 ivi_layout_panel_committed(struct ivi_surface *surface);
 320
 321 void
 322 ivi_layout_popup_committed(struct ivi_surface *surface);
 323
 324 void
 325 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 326
 327 void
 328 ivi_layout_split_committed(struct ivi_surface *surface);
 329
 330 void
 331 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 332
 333 void
 334 ivi_layout_desktop_resize(struct ivi_surface *surface,
 335                           struct weston_geometry area);
 336
 337 struct ivi_output *
 338 ivi_layout_get_output_from_surface(struct ivi_surface *surf);
 339
 340 #endif