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