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         char *app_id;
 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         IVI_SURFACE_ROLE_REMOTE,
 153 };
 154
 155 struct pending_popup {
 156         struct ivi_output *ioutput;
 157         char *app_id;
 158         int x; int y;
 159
 160         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 161 };
 162
 163 struct pending_fullscreen {
 164         struct ivi_output *ioutput;
 165         char *app_id;
 166         struct wl_list link;    /** ivi_compositor::fullscreen_pending_apps */
 167 };
 168
 169 struct pending_split {
 170         struct ivi_output *ioutput;
 171         char *app_id;
 172         uint32_t orientation;
 173         struct wl_list link;    /** ivi_compositor::split_pending_apps */
 174 };
 175
 176 struct pending_remote {
 177         struct ivi_output *ioutput;
 178         char *app_id;
 179         struct wl_list link;    /** ivi_compositor::remote_pending_apps */
 180 };
 181
 182 struct ivi_desktop_surface {
 183         struct ivi_output *pending_output;
 184         struct ivi_output *last_output;
 185 };
 186
 187 struct ivi_background_surface {
 188         struct ivi_output *output;
 189 };
 190
 191 struct ivi_popup_surface {
 192         struct ivi_output *output;
 193         int x;
 194         int y;
 195 };
 196
 197 struct ivi_fullscreen_surface {
 198         struct ivi_output *output;
 199 };
 200
 201 struct ivi_split_surface {
 202         struct ivi_output *output;
 203         uint32_t orientation;
 204 };
 205
 206 struct ivi_remote_surface {
 207         struct ivi_output *output;
 208 };
 209
 210 struct ivi_panel_surface {
 211         struct ivi_output *output;
 212         enum agl_shell_edge edge;
 213 };
 214
 215 enum ivi_surface_flags {
 216         IVI_SURFACE_PROP_MAP = (1 << 0),
 217         /* x, y, width, height */
 218         IVI_SURFACE_PROP_POSITION = (1 << 1),
 219 };
 220
 221 struct ivi_surface {
 222         struct ivi_compositor *ivi;
 223         struct weston_desktop_surface *dsurface;
 224         struct weston_view *view;
 225
 226         struct wl_list link;
 227
 228         struct {
 229                 enum ivi_surface_flags flags;
 230                 int32_t x, y;
 231                 int32_t width, height;
 232         } pending;
 233         bool activated_by_default;
 234
 235         enum ivi_surface_role role;
 236         union {
 237                 struct ivi_desktop_surface desktop;
 238                 struct ivi_background_surface bg;
 239                 struct ivi_panel_surface panel;
 240                 struct ivi_popup_surface popup;
 241                 struct ivi_fullscreen_surface fullscreen;
 242                 struct ivi_split_surface split;
 243                 struct ivi_remote_surface remote;
 244         };
 245 };
 246
 247 struct ivi_shell_client {
 248         struct wl_list link;
 249         char *command;
 250         bool require_ready;
 251
 252         pid_t pid;
 253         struct wl_client *client;
 254
 255         struct wl_listener client_destroy;
 256 };
 257
 258 struct ivi_compositor *
 259 to_ivi_compositor(struct weston_compositor *ec);
 260
 261 #ifdef HAVE_SYSTEMD
 262 int
 263 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 264 #else
 265 static int
 266 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 267 {
 268 }
 269 #endif
 270
 271 int
 272 ivi_shell_init(struct ivi_compositor *ivi);
 273
 274 void
 275 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 276
 277 int
 278 ivi_shell_create_global(struct ivi_compositor *ivi);
 279
 280 int
 281 ivi_launch_shell_client(struct ivi_compositor *ivi);
 282
 283 int
 284 ivi_desktop_init(struct ivi_compositor *ivi);
 285
 286 struct ivi_shell_client *
 287 ivi_shell_client_from_wl(struct wl_client *client);
 288
 289 struct ivi_output *
 290 to_ivi_output(struct weston_output *o);
 291
 292 void
 293 ivi_set_desktop_surface(struct ivi_surface *surface);
 294
 295 /*
 296  * removes the pending popup one
 297  */
 298 void
 299 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 300
 301 void
 302 ivi_reflow_outputs(struct ivi_compositor *ivi);
 303
 304 struct ivi_surface *
 305 to_ivi_surface(struct weston_surface *surface);
 306
 307 void
 308 ivi_layout_set_mapped(struct ivi_surface *surface);
 309
 310 void
 311 ivi_layout_set_position(struct ivi_surface *surface,
 312                         int32_t x, int32_t y,
 313                         int32_t width, int32_t height);
 314
 315 struct ivi_surface *
 316 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 317
 318 void
 319 ivi_layout_commit(struct ivi_compositor *ivi);
 320
 321 void
 322 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 323
 324 void
 325 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 326
 327 void
 328 ivi_layout_desktop_committed(struct ivi_surface *surf);
 329
 330 void
 331 ivi_layout_panel_committed(struct ivi_surface *surface);
 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 #endif