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