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                 bool 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         struct ivi_policy *policy;
  86
  87         struct wl_list pending_surfaces;
  88         struct wl_list popup_pending_apps;
  89
  90         struct weston_layer hidden;
  91         struct weston_layer background;
  92         struct weston_layer normal;
  93         struct weston_layer panel;
  94         struct weston_layer popup;
  95         struct weston_layer fullscreen;
  96 };
  97
  98 struct ivi_surface;
  99
 100 struct ivi_output {
 101         struct wl_list link; /* ivi_compositor.outputs */
 102         struct ivi_compositor *ivi;
 103
 104         char *name;
 105         struct weston_config_section *config;
 106         struct weston_output *output;
 107
 108         struct ivi_surface *background;
 109         /* Panels */
 110         struct ivi_surface *top;
 111         struct ivi_surface *bottom;
 112         struct ivi_surface *left;
 113         struct ivi_surface *right;
 114
 115         /* for the black surface */
 116         struct fullscreen_view {
 117                 struct ivi_surface *fs;
 118                 struct wl_listener fs_destroy;
 119         } fullscreen_view;
 120
 121         struct wl_listener output_destroy;
 122
 123         /*
 124          * Usable area for normal clients, i.e. with panels removed.
 125          * In output-coorrdinate space.
 126          */
 127         struct weston_geometry area;
 128
 129         struct ivi_surface *active;
 130
 131         /* Temporary: only used during configuration */
 132         size_t add_len;
 133         struct weston_head *add[8];
 134 };
 135
 136 enum ivi_surface_role {
 137         IVI_SURFACE_ROLE_NONE,
 138         IVI_SURFACE_ROLE_DESKTOP,
 139         IVI_SURFACE_ROLE_BACKGROUND,
 140         IVI_SURFACE_ROLE_PANEL,
 141         IVI_SURFACE_ROLE_POPUP,
 142 };
 143
 144 struct pending_popup {
 145         struct ivi_output *ioutput;
 146         char *app_id;
 147         int x; int y;
 148
 149         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 150 };
 151
 152 struct ivi_desktop_surface {
 153         struct ivi_output *pending_output;
 154         struct ivi_output *last_output;
 155 };
 156
 157 struct ivi_background_surface {
 158         struct ivi_output *output;
 159 };
 160
 161 struct ivi_popup_surface {
 162         struct ivi_output *output;
 163         int x;
 164         int y;
 165 };
 166
 167 struct ivi_panel_surface {
 168         struct ivi_output *output;
 169         enum agl_shell_edge edge;
 170 };
 171
 172 enum ivi_surface_flags {
 173         IVI_SURFACE_PROP_MAP = (1 << 0),
 174         /* x, y, width, height */
 175         IVI_SURFACE_PROP_POSITION = (1 << 1),
 176 };
 177
 178 struct ivi_surface {
 179         struct ivi_compositor *ivi;
 180         struct weston_desktop_surface *dsurface;
 181         struct weston_view *view;
 182
 183         struct wl_list link;
 184
 185         struct {
 186                 enum ivi_surface_flags flags;
 187                 int32_t x, y;
 188                 int32_t width, height;
 189         } pending;
 190         bool activated_by_default;
 191
 192         enum ivi_surface_role role;
 193         union {
 194                 struct ivi_desktop_surface desktop;
 195                 struct ivi_background_surface bg;
 196                 struct ivi_panel_surface panel;
 197                 struct ivi_popup_surface popup;
 198         };
 199 };
 200
 201 struct ivi_shell_client {
 202         struct wl_list link;
 203         char *command;
 204         bool require_ready;
 205
 206         pid_t pid;
 207         struct wl_client *client;
 208
 209         struct wl_listener client_destroy;
 210 };
 211
 212 struct ivi_compositor *
 213 to_ivi_compositor(struct weston_compositor *ec);
 214
 215 #ifdef HAVE_SYSTEMD
 216 int
 217 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 218 #else
 219 static int
 220 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 221 {
 222 }
 223 #endif
 224
 225 int
 226 ivi_shell_init(struct ivi_compositor *ivi);
 227
 228 void
 229 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 230
 231 int
 232 ivi_shell_create_global(struct ivi_compositor *ivi);
 233
 234 int
 235 ivi_launch_shell_client(struct ivi_compositor *ivi);
 236
 237 int
 238 ivi_desktop_init(struct ivi_compositor *ivi);
 239
 240 struct ivi_shell_client *
 241 ivi_shell_client_from_wl(struct wl_client *client);
 242
 243 struct ivi_output *
 244 to_ivi_output(struct weston_output *o);
 245
 246 void
 247 ivi_set_desktop_surface(struct ivi_surface *surface);
 248
 249 /*
 250  * removes the pending popup one
 251  */
 252 bool
 253 ivi_check_pending_desktop_surface_popup(struct ivi_surface *surface);
 254
 255 void
 256 ivi_set_desktop_surface_popup(struct ivi_surface *surface);
 257
 258 void
 259 ivi_reflow_outputs(struct ivi_compositor *ivi);
 260
 261 struct ivi_surface *
 262 to_ivi_surface(struct weston_surface *surface);
 263
 264 void
 265 ivi_layout_set_mapped(struct ivi_surface *surface);
 266
 267 void
 268 ivi_layout_set_position(struct ivi_surface *surface,
 269                         int32_t x, int32_t y,
 270                         int32_t width, int32_t height);
 271
 272 void
 273 ivi_layout_commit(struct ivi_compositor *ivi);
 274
 275 void
 276 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 277
 278 void
 279 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 280
 281 void
 282 ivi_layout_desktop_committed(struct ivi_surface *surf);
 283
 284 void
 285 ivi_layout_panel_committed(struct ivi_surface *surface);
 286
 287 void
 288 ivi_layout_popup_committed(struct ivi_surface *surface);
 289
 290 #endif