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