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
  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
 132         struct ivi_surface *active;
 133         struct ivi_surface *previous_active;
 134
 135         /* Temporary: only used during configuration */
 136         size_t add_len;
 137         struct weston_head *add[8];
 138 };
 139
 140 enum ivi_surface_role {
 141         IVI_SURFACE_ROLE_NONE,
 142         IVI_SURFACE_ROLE_DESKTOP,
 143         IVI_SURFACE_ROLE_BACKGROUND,
 144         IVI_SURFACE_ROLE_PANEL,
 145         IVI_SURFACE_ROLE_POPUP,
 146 };
 147
 148 struct pending_popup {
 149         struct ivi_output *ioutput;
 150         char *app_id;
 151         int x; int y;
 152
 153         struct wl_list link;    /** ivi_compositor::popup_pending_surfaces */
 154 };
 155
 156 struct ivi_desktop_surface {
 157         struct ivi_output *pending_output;
 158         struct ivi_output *last_output;
 159 };
 160
 161 struct ivi_background_surface {
 162         struct ivi_output *output;
 163 };
 164
 165 struct ivi_popup_surface {
 166         struct ivi_output *output;
 167         int x;
 168         int y;
 169 };
 170
 171 struct ivi_panel_surface {
 172         struct ivi_output *output;
 173         enum agl_shell_edge edge;
 174 };
 175
 176 enum ivi_surface_flags {
 177         IVI_SURFACE_PROP_MAP = (1 << 0),
 178         /* x, y, width, height */
 179         IVI_SURFACE_PROP_POSITION = (1 << 1),
 180 };
 181
 182 struct ivi_surface {
 183         struct ivi_compositor *ivi;
 184         struct weston_desktop_surface *dsurface;
 185         struct weston_view *view;
 186
 187         struct wl_list link;
 188
 189         struct {
 190                 enum ivi_surface_flags flags;
 191                 int32_t x, y;
 192                 int32_t width, height;
 193         } pending;
 194         bool activated_by_default;
 195
 196         enum ivi_surface_role role;
 197         union {
 198                 struct ivi_desktop_surface desktop;
 199                 struct ivi_background_surface bg;
 200                 struct ivi_panel_surface panel;
 201                 struct ivi_popup_surface popup;
 202         };
 203 };
 204
 205 struct ivi_shell_client {
 206         struct wl_list link;
 207         char *command;
 208         bool require_ready;
 209
 210         pid_t pid;
 211         struct wl_client *client;
 212
 213         struct wl_listener client_destroy;
 214 };
 215
 216 struct ivi_compositor *
 217 to_ivi_compositor(struct weston_compositor *ec);
 218
 219 #ifdef HAVE_SYSTEMD
 220 int
 221 ivi_agl_systemd_notify(struct ivi_compositor *ivi);
 222 #else
 223 static int
 224 ivi_agl_systemd_notify(struct ivi_compositor *ivi)
 225 {
 226 }
 227 #endif
 228
 229 int
 230 ivi_shell_init(struct ivi_compositor *ivi);
 231
 232 void
 233 ivi_shell_init_black_fs(struct ivi_compositor *ivi);
 234
 235 int
 236 ivi_shell_create_global(struct ivi_compositor *ivi);
 237
 238 int
 239 ivi_launch_shell_client(struct ivi_compositor *ivi);
 240
 241 int
 242 ivi_desktop_init(struct ivi_compositor *ivi);
 243
 244 struct ivi_shell_client *
 245 ivi_shell_client_from_wl(struct wl_client *client);
 246
 247 struct ivi_output *
 248 to_ivi_output(struct weston_output *o);
 249
 250 void
 251 ivi_set_desktop_surface(struct ivi_surface *surface);
 252
 253 /*
 254  * removes the pending popup one
 255  */
 256 bool
 257 ivi_check_pending_desktop_surface_popup(struct ivi_surface *surface);
 258
 259 void
 260 ivi_set_desktop_surface_popup(struct ivi_surface *surface);
 261
 262 void
 263 ivi_reflow_outputs(struct ivi_compositor *ivi);
 264
 265 struct ivi_surface *
 266 to_ivi_surface(struct weston_surface *surface);
 267
 268 void
 269 ivi_layout_set_mapped(struct ivi_surface *surface);
 270
 271 void
 272 ivi_layout_set_position(struct ivi_surface *surface,
 273                         int32_t x, int32_t y,
 274                         int32_t width, int32_t height);
 275
 276 void
 277 ivi_layout_commit(struct ivi_compositor *ivi);
 278
 279 void
 280 ivi_layout_init(struct ivi_compositor *ivi, struct ivi_output *output);
 281
 282 void
 283 ivi_layout_activate(struct ivi_output *output, const char *app_id);
 284
 285 void
 286 ivi_layout_desktop_committed(struct ivi_surface *surf);
 287
 288 void
 289 ivi_layout_panel_committed(struct ivi_surface *surface);
 290
 291 void
 292 ivi_layout_popup_committed(struct ivi_surface *surface);
 293
 294 void
 295 ivi_layout_deactivate(struct ivi_compositor *ivi, const char *app_id);
 296
 297 #endif