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