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