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
 134         struct ivi_surface *active;
 135         struct ivi_surface *previous_active;
 136
 137         /* Temporary: only used during configuration */
 138         size_t add_len;
 139         struct weston_head *add[8];
 140 };
 141
 142 enum ivi_surface_role {
 143         IVI_SURFACE_ROLE_NONE,
 144         IVI_SURFACE_ROLE_DESKTOP,
 145         IVI_SURFACE_ROLE_BACKGROUND,
 146         IVI_SURFACE_ROLE_PANEL,
 147         IVI_SURFACE_ROLE_POPUP,
 148         IVI_SURFACE_ROLE_FULLSCREEN,
 149         IVI_SURFACE_ROLE_SPLIT_V,
 150         IVI_SURFACE_ROLE_SPLIT_H,
 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 ivi_desktop_surface {
 175         struct ivi_output *pending_output;
 176         struct ivi_output *last_output;
 177 };
 178
 179 struct ivi_background_surface {
 180         struct ivi_output *output;
 181 };
 182
 183 struct ivi_popup_surface {
 184         struct ivi_output *output;
 185         int x;
 186         int y;
 187 };
 188
 189 struct ivi_fullscreen_surface {
 190         struct ivi_output *output;
 191 };
 192
 193 struct ivi_split_surface {
 194         struct ivi_output *output;
 195         uint32_t orientation;
 196 };
 197
 198 struct ivi_panel_surface {
 199         struct ivi_output *output;
 200         enum agl_shell_edge edge;
 201 };
 202
 203 enum ivi_surface_flags {
 204         IVI_SURFACE_PROP_MAP = (1 << 0),
 205         /* x, y, width, height */
 206         IVI_SURFACE_PROP_POSITION = (1 << 1),
 207 };
 208
 209 struct ivi_surface {
 210         struct ivi_compositor *ivi;
 211         struct weston_desktop_surface *dsurface;
 212         struct weston_view *view;
 213
 214         struct wl_list link;
 215
 216         struct {
 217                 enum ivi_surface_flags flags;
 218                 int32_t x, y;
 219                 int32_t width, height;
 220         } pending;
 221         bool activated_by_default;
 222
 223         enum ivi_surface_role role;
 224         union {
 225                 struct ivi_desktop_surface desktop;
 226                 struct ivi_background_surface bg;
 227                 struct ivi_panel_surface panel;
 228                 struct ivi_popup_surface popup;
 229                 struct ivi_fullscreen_surface fullscreen;
 230                 struct ivi_split_surface split;
 231         };
 232 };
 233
 234 struct ivi_shell_client {
 235         struct wl_list link;
 236         char *command;
 237         bool require_ready;
 238
 239         pid_t pid;
 240         struct wl_client *client;
 241
 242         struct wl_listener client_destroy;
 243 };
 244
 245 struct ivi_compositor *
 246 to_ivi_compositor(struct weston_compositor *ec);
 247
 248 #ifdef HAVE_SYSTEMD
 249 int
 250 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 251 #else
 252 static int
 253 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 254 {
 255 }
 256 #endif
 257
 258 int
 259 ivi_shell_init(struct ivi_compositor *ivi);
 260
 261 void
 262 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 263
 264 int
 265 ivi_shell_create_global(struct ivi_compositor *ivi);
 266
 267 int
 268 ivi_launch_shell_client(struct ivi_compositor *ivi);
 269
 270 int
 271 ivi_desktop_init(struct ivi_compositor *ivi);
 272
 273 struct ivi_shell_client *
 274 ivi_shell_client_from_wl(struct wl_client *client);
 275
 276 struct ivi_output *
 277 to_ivi_output(struct weston_output *o);
 278
 279 void
 280 ivi_set_desktop_surface(struct ivi_surface *surface);
 281
 282 /*
 283  * removes the pending popup one
 284  */
 285 void
 286 ivi_check_pending_desktop_surface(struct ivi_surface *surface);
 287
 288 void
 289 ivi_reflow_outputs(struct ivi_compositor *ivi);
 290
 291 struct ivi_surface *
 292 to_ivi_surface(struct weston_surface *surface);
 293
 294 void
 295 ivi_layout_set_mapped(struct ivi_surface *surface);
 296
 297 void
 298 ivi_layout_set_position(struct ivi_surface *surface,
 299                         int32_t x, int32_t y,
 300                         int32_t width, int32_t height);
 301
 302 struct ivi_surface *
 303 ivi_find_app(struct ivi_compositor *ivi, const char *app_id);
 304
 305 void
 306 ivi_layout_commit(struct ivi_compositor *ivi);
 307
 308 void
 309 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 310
 311 void
 312 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 313
 314 void
 315 ivi_layout_desktop_committed(struct ivi_surface *surf);
 316
 317 void
 318 ivi_layout_panel_committed(struct ivi_surface *surface);
 319
 320 void
 321 ivi_layout_popup_committed(struct ivi_surface *surface);
 322
 323 void
 324 ivi_layout_fullscreen_committed(struct ivi_surface *surface);
 325
 326 void
 327 ivi_layout_split_committed(struct ivi_surface *surface);
 328
 329 void
 330 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 331
 332 #endif