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 desktop_client {
  40         struct wl_resource *resource;
  41         struct wl_list link;    /* ivi_compositor::desktop_clients */
  42 };
  43
  44 struct ivi_compositor {
  45         struct weston_compositor *compositor;
  46         struct weston_config *config;
  47
  48         struct wl_listener heads_changed;
  49
  50         bool init_failed;
  51
  52         /*
  53          * Options parsed from command line arugments.
  54          * Overrides what is found in the config file.
  55          */
  56         struct {
  57                 /* drm */
  58                 bool use_current_mode;
  59                 /* wayland/x11 */
  60                 int width;
  61                 int height;
  62                 int scale;
  63         } cmdline;
  64         const struct weston_windowed_output_api *window_api;
  65         const struct weston_drm_output_api *drm_api;
  66
  67         struct wl_global *agl_shell;
  68         struct wl_global *agl_shell_desktop;
  69         struct {
  70                 int activate_apps_by_default;   /* switches once xdg top level has been 'created' */
  71         } quirks;
  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
  86         struct wl_list pending_surfaces;
  87
  88         struct weston_layer hidden;
  89         struct weston_layer background;
  90         struct weston_layer normal;
  91         struct weston_layer panel;
  92         struct weston_layer fullscreen;
  93 };
  94
  95 struct ivi_surface;
  96
  97 struct ivi_output {
  98         struct wl_list link; /* ivi_compositor.outputs */
  99         struct ivi_compositor *ivi;
 100
 101         char *name;
 102         struct weston_config_section *config;
 103         struct weston_output *output;
 104
 105         struct ivi_surface *background;
 106         /* Panels */
 107         struct ivi_surface *top;
 108         struct ivi_surface *bottom;
 109         struct ivi_surface *left;
 110         struct ivi_surface *right;
 111
 112         /* for the black surface */
 113         struct fullscreen_view {
 114                 struct ivi_surface *fs;
 115                 struct wl_listener fs_destroy;
 116         } fullscreen_view;
 117
 118         struct wl_listener output_destroy;
 119
 120         /*
 121          * Usable area for normal clients, i.e. with panels removed.
 122          * In output-coorrdinate space.
 123          */
 124         struct weston_geometry area;
 125
 126         struct ivi_surface *active;
 127
 128         /* Temporary: only used during configuration */
 129         size_t add_len;
 130         struct weston_head *add[8];
 131 };
 132
 133 enum ivi_surface_role {
 134         IVI_SURFACE_ROLE_NONE,
 135         IVI_SURFACE_ROLE_DESKTOP,
 136         IVI_SURFACE_ROLE_BACKGROUND,
 137         IVI_SURFACE_ROLE_PANEL,
 138 };
 139
 140 struct ivi_desktop_surface {
 141         struct ivi_output *pending_output;
 142         struct ivi_output *last_output;
 143 };
 144
 145 struct ivi_background_surface {
 146         struct ivi_output *output;
 147 };
 148
 149 struct ivi_panel_surface {
 150         struct ivi_output *output;
 151         enum agl_shell_edge edge;
 152 };
 153
 154 enum ivi_surface_flags {
 155         IVI_SURFACE_PROP_MAP = (1 << 0),
 156         /* x, y, width, height */
 157         IVI_SURFACE_PROP_POSITION = (1 << 1),
 158 };
 159
 160 struct ivi_surface {
 161         struct ivi_compositor *ivi;
 162         struct weston_desktop_surface *dsurface;
 163         struct weston_view *view;
 164
 165         struct wl_list link;
 166
 167         struct {
 168                 enum ivi_surface_flags flags;
 169                 int32_t x, y;
 170                 int32_t width, height;
 171         } pending;
 172
 173         enum ivi_surface_role role;
 174         union {
 175                 struct ivi_desktop_surface desktop;
 176                 struct ivi_background_surface bg;
 177                 struct ivi_panel_surface panel;
 178         };
 179 };
 180
 181 struct ivi_shell_client {
 182         struct wl_list link;
 183         char *command;
 184         bool require_ready;
 185
 186         pid_t pid;
 187         struct wl_client *client;
 188
 189         struct wl_listener client_destroy;
 190 };
 191
 192 struct ivi_compositor *
 193 to_ivi_compositor(struct weston_compositor *ec);
 194
 195 #ifdef HAVE_SYSTEMD
 196 int
 197 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 198 #else
 199 static int
 200 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 201 {
 202 }
 203 #endif
 204
 205 int
 206 ivi_shell_init(struct ivi_compositor *ivi);
 207
 208 void
 209 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 210
 211 int
 212 ivi_shell_create_global(struct ivi_compositor *ivi);
 213
 214 int
 215 ivi_launch_shell_client(struct ivi_compositor *ivi);
 216
 217 int
 218 ivi_desktop_init(struct ivi_compositor *ivi);
 219
 220 struct ivi_shell_client *
 221 ivi_shell_client_from_wl(struct wl_client *client);
 222
 223 struct ivi_output *
 224 to_ivi_output(struct weston_output *o);
 225
 226 void
 227 ivi_set_desktop_surface(struct ivi_surface *surface);
 228
 229 void
 230 ivi_reflow_outputs(struct ivi_compositor *ivi);
 231
 232 struct ivi_surface *
 233 to_ivi_surface(struct weston_surface *surface);
 234
 235 void
 236 ivi_layout_set_mapped(struct ivi_surface *surface);
 237
 238 void
 239 ivi_layout_set_position(struct ivi_surface *surface,
 240                         int32_t x, int32_t y,
 241                         int32_t width, int32_t height);
 242
 243 void
 244 ivi_layout_commit(struct ivi_compositor *ivi);
 245
 246 void
 247 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 248
 249 void
 250 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 251
 252 void
 253 ivi_layout_desktop_committed(struct ivi_surface *surf);
 254
 255 void
 256 ivi_layout_panel_committed(struct ivi_surface *surface);
 257
 258 #endif