ivi-shell/ivi-shell.c

   1 /*
   2  * Copyright (C) 2013 DENSO CORPORATION
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation for any purpose is hereby granted without fee, provided
   6  * that the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of the copyright holders not be used in
   9  * advertising or publicity pertaining to distribution of the software
  10  * without specific, written prior permission.  The copyright holders make
  11  * no representations about the suitability of this software for any
  12  * purpose.  It is provided "as is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21  */
  22
  23 /*
  24  * ivi-shell supports a type of shell for In-Vehicle Infotainment system.
  25  * In-Vehicle Infotainment system traditionally manages surfaces with global
  26  * identification. A protocol, ivi_application, supports such a feature
  27  * by implementing a request, ivi_application::surface_creation defined in
  28  * ivi_application.xml.
  29  *
  30  *  The ivi-shell explicitly loads a module to add business logic like how to
  31  *  layout surfaces by using internal ivi-layout APIs.
  32  */
  33 #include "config.h"
  34
  35 #include <sys/wait.h>
  36 #include <unistd.h>
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <string.h>
  40 #include <linux/input.h>
  41 #include <dlfcn.h>
  42 #include <limits.h>
  43 #include <assert.h>
  44
  45 #include "ivi-shell.h"
  46 #include "ivi-application-server-protocol.h"
  47 #include "ivi-layout-private.h"
  48
  49 #include "../shared/os-compatibility.h"
  50
  51 /* Representation of ivi_surface protocol object. */
  52 struct ivi_shell_surface
  53 {
  54         struct wl_resource* resource;
  55         struct ivi_shell *shell;
  56         struct ivi_layout_surface *layout_surface;
  57
  58         struct weston_surface *surface;
  59         struct wl_listener surface_destroy_listener;
  60
  61         uint32_t id_surface;
  62
  63         int32_t width;
  64         int32_t height;
  65
  66         struct wl_list link;
  67
  68         struct wl_listener configured_listener;
  69 };
  70
  71 struct ivi_shell_setting
  72 {
  73         char *ivi_module;
  74 };
  75
  76 /*
  77  * Implementation of ivi_surface
  78  */
  79
  80 static void
  81 surface_configure_notify(struct wl_listener *listener, void *data)
  82 {
  83         struct ivi_layout_surface *layout_surf =
  84                 (struct ivi_layout_surface *)data;
  85
  86         struct ivi_shell_surface *shell_surf =
  87                 container_of(listener,
  88                              struct ivi_shell_surface,
  89                              configured_listener);
  90
  91         int32_t dest_width = 0;
  92         int32_t dest_height = 0;
  93         shell_surf->shell->ivi_layout->get_surface_dimension(layout_surf,
  94                                           &dest_width, &dest_height);
  95
  96         if (shell_surf->resource)
  97                 ivi_surface_send_configure(shell_surf->resource,
  98                                            dest_width, dest_height);
  99 }
 100
 101 static void
 102 ivi_shell_surface_configure(struct weston_surface *, int32_t, int32_t);
 103
 104 static struct ivi_shell_surface *
 105 get_ivi_shell_surface(struct weston_surface *surface)
 106 {
 107         if (surface->configure == ivi_shell_surface_configure)
 108                 return surface->configure_private;
 109
 110         return NULL;
 111 }
 112
 113 static void
 114 ivi_shell_surface_configure(struct weston_surface *surface,
 115                             int32_t sx, int32_t sy)
 116 {
 117         struct ivi_shell_surface *ivisurf = get_ivi_shell_surface(surface);
 118         struct weston_view *view;
 119         float from_x;
 120         float from_y;
 121         float to_x;
 122         float to_y;
 123
 124         if (surface->width == 0 || surface->height == 0 || ivisurf == NULL)
 125                 return;
 126
 127         view = ivisurf->shell->ivi_layout->get_weston_view(ivisurf->layout_surface);
 128         if (view == NULL)
 129                 return;
 130
 131         if (ivisurf->width != surface->width ||
 132             ivisurf->height != surface->height) {
 133                 ivisurf->width  = surface->width;
 134                 ivisurf->height = surface->height;
 135
 136                 weston_view_to_global_float(view, 0, 0, &from_x, &from_y);
 137                 weston_view_to_global_float(view, sx, sy, &to_x, &to_y);
 138
 139                 weston_view_set_position(view,
 140                                          view->geometry.x + to_x - from_x,
 141                                          view->geometry.y + to_y - from_y);
 142                 weston_view_update_transform(view);
 143
 144                 ivisurf->shell->ivi_layout->surface_configure(ivisurf->layout_surface,
 145                                               surface->width, surface->height);
 146         }
 147 }
 148
 149 /*
 150  * The ivi_surface wl_resource destructor.
 151  *
 152  * Gets called via ivi_surface.destroy request or automatic wl_client clean-up.
 153  */
 154 static void
 155 shell_destroy_shell_surface(struct wl_resource *resource)
 156 {
 157         struct ivi_shell_surface *ivisurf = wl_resource_get_user_data(resource);
 158         if (ivisurf != NULL) {
 159                 ivisurf->resource = NULL;
 160         }
 161 }
 162
 163 /* Gets called through the weston_surface destroy signal. */
 164 static void
 165 shell_handle_surface_destroy(struct wl_listener *listener, void *data)
 166 {
 167         struct ivi_shell_surface *ivisurf =
 168                         container_of(listener, struct ivi_shell_surface,
 169                                      surface_destroy_listener);
 170
 171         assert(ivisurf != NULL);
 172
 173         if (ivisurf->surface!=NULL) {
 174                 ivisurf->surface->configure = NULL;
 175                 ivisurf->surface->configure_private = NULL;
 176                 ivisurf->surface = NULL;
 177         }
 178
 179         wl_list_remove(&ivisurf->surface_destroy_listener.link);
 180         wl_list_remove(&ivisurf->link);
 181
 182         if (ivisurf->resource != NULL) {
 183                 wl_resource_set_user_data(ivisurf->resource, NULL);
 184                 ivisurf->resource = NULL;
 185         }
 186         free(ivisurf);
 187
 188 }
 189
 190 /* Gets called, when a client sends ivi_surface.destroy request. */
 191 static void
 192 surface_destroy(struct wl_client *client, struct wl_resource *resource)
 193 {
 194         /*
 195          * Fires the wl_resource destroy signal, and then calls
 196          * ivi_surface wl_resource destructor: shell_destroy_shell_surface()
 197          */
 198         wl_resource_destroy(resource);
 199 }
 200
 201 static const struct ivi_surface_interface surface_implementation = {
 202         surface_destroy,
 203 };
 204
 205 /**
 206  * Request handler for ivi_application.surface_create.
 207  *
 208  * Creates an ivi_surface protocol object associated with the given wl_surface.
 209  * ivi_surface protocol object is represented by struct ivi_shell_surface.
 210  *
 211  * \param client The client.
 212  * \param resource The ivi_application protocol object.
 213  * \param id_surface The IVI surface ID.
 214  * \param surface_resource The wl_surface protocol object.
 215  * \param id The protocol object id for the new ivi_surface protocol object.
 216  *
 217  * The wl_surface is given the ivi_surface role and associated with a unique
 218  * IVI ID which is used to identify the surface in a controller
 219  * (window manager).
 220  */
 221 static void
 222 application_surface_create(struct wl_client *client,
 223                            struct wl_resource *resource,
 224                            uint32_t id_surface,
 225                            struct wl_resource *surface_resource,
 226                            uint32_t id)
 227 {
 228         struct ivi_shell *shell = wl_resource_get_user_data(resource);
 229         struct ivi_shell_surface *ivisurf;
 230         struct ivi_layout_surface *layout_surface;
 231         struct weston_surface *weston_surface =
 232                 wl_resource_get_user_data(surface_resource);
 233         struct wl_resource *res;
 234
 235         if (weston_surface_set_role(weston_surface, "ivi_surface",
 236                                     resource, IVI_APPLICATION_ERROR_ROLE) < 0)
 237                 return;
 238
 239         layout_surface = shell->ivi_layout->surface_create(weston_surface,
 240                                                     id_surface);
 241
 242         /* check if id_ivi is already used for wl_surface*/
 243         if (layout_surface == NULL){
 244                 wl_resource_post_error(resource,
 245                                        IVI_APPLICATION_ERROR_IVI_ID,
 246                                        "surface_id is already assigned "
 247                                        "by another app");
 248                 return;
 249         }
 250
 251         ivisurf = zalloc(sizeof *ivisurf);
 252         if (ivisurf == NULL) {
 253                 wl_resource_post_no_memory(resource);
 254                 return;
 255         }
 256
 257         wl_list_init(&ivisurf->link);
 258         wl_list_insert(&shell->ivi_surface_list, &ivisurf->link);
 259
 260         ivisurf->shell = shell;
 261         ivisurf->id_surface = id_surface;
 262
 263         ivisurf->width = 0;
 264         ivisurf->height = 0;
 265         ivisurf->layout_surface = layout_surface;
 266         ivisurf->configured_listener.notify = surface_configure_notify;
 267         ivisurf->shell->ivi_layout->add_surface_configured_listener(layout_surface,
 268                                                 &ivisurf->configured_listener);
 269
 270         /*
 271          * The following code relies on wl_surface destruction triggering
 272          * immediateweston_surface destruction
 273          */
 274         ivisurf->surface_destroy_listener.notify = shell_handle_surface_destroy;
 275         wl_signal_add(&weston_surface->destroy_signal,
 276                       &ivisurf->surface_destroy_listener);
 277
 278         ivisurf->surface = weston_surface;
 279
 280         weston_surface->configure = ivi_shell_surface_configure;
 281         weston_surface->configure_private = ivisurf;
 282
 283         res = wl_resource_create(client, &ivi_surface_interface, 1, id);
 284         if (res == NULL) {
 285                 wl_client_post_no_memory(client);
 286                 return;
 287         }
 288
 289         ivisurf->resource = res;
 290
 291         wl_resource_set_implementation(res, &surface_implementation,
 292                                        ivisurf, shell_destroy_shell_surface);
 293 }
 294
 295 static const struct ivi_application_interface application_implementation = {
 296         application_surface_create
 297 };
 298
 299 /*
 300  * Handle wl_registry.bind of ivi_application global singleton.
 301  */
 302 static void
 303 bind_ivi_application(struct wl_client *client,
 304                      void *data, uint32_t version, uint32_t id)
 305 {
 306         struct ivi_shell *shell = data;
 307         struct wl_resource *resource;
 308
 309         resource = wl_resource_create(client, &ivi_application_interface,
 310                                       1, id);
 311
 312         wl_resource_set_implementation(resource,
 313                                        &application_implementation,
 314                                        shell, NULL);
 315 }
 316
 317 struct weston_view *
 318 get_default_view(struct weston_surface *surface)
 319 {
 320         struct ivi_shell_surface *shsurf;
 321         struct weston_view *view;
 322
 323         if (!surface || wl_list_empty(&surface->views))
 324                 return NULL;
 325
 326         shsurf = get_ivi_shell_surface(surface);
 327         if (shsurf && shsurf->layout_surface) {
 328                 view = shsurf->shell->ivi_layout->get_weston_view(shsurf->layout_surface);
 329                 if (view)
 330                         return view;
 331         }
 332
 333         wl_list_for_each(view, &surface->views, surface_link) {
 334                 if (weston_view_is_mapped(view))
 335                         return view;
 336         }
 337
 338         return container_of(surface->views.next,
 339                             struct weston_view, surface_link);
 340 }
 341
 342 /*
 343  * Called through the compositor's destroy signal.
 344  */
 345 static void
 346 shell_destroy(struct wl_listener *listener, void *data)
 347 {
 348         struct ivi_shell *shell =
 349                 container_of(listener, struct ivi_shell, destroy_listener);
 350         struct ivi_shell_surface *ivisurf, *next;
 351
 352         input_panel_destroy(shell);
 353
 354         wl_list_for_each_safe(ivisurf, next, &shell->ivi_surface_list, link) {
 355                 wl_list_remove(&ivisurf->link);
 356                 free(ivisurf);
 357         }
 358
 359         free(shell);
 360 }
 361
 362 static void
 363 init_ivi_shell(struct weston_compositor *compositor, struct ivi_shell *shell)
 364 {
 365         shell->compositor = compositor;
 366
 367         wl_list_init(&shell->ivi_surface_list);
 368
 369         weston_layer_init(&shell->input_panel_layer, NULL);
 370 }
 371
 372 static int
 373 ivi_shell_setting_create(struct ivi_shell_setting *dest,
 374                          struct weston_compositor *compositor)
 375 {
 376         int result = 0;
 377         struct weston_config *config = compositor->config;
 378         struct weston_config_section *section;
 379
 380         if (NULL == dest)
 381                 return -1;
 382
 383         section = weston_config_get_section(config, "ivi-shell", NULL, NULL);
 384
 385         if (weston_config_section_get_string(
 386                 section, "ivi-module", &dest->ivi_module, NULL) != 0)
 387         {
 388                 result = -1;
 389         }
 390
 391         return result;
 392 }
 393
 394 /*
 395  * Initialization of ivi-shell.
 396  */
 397 static int
 398 ivi_load_modules(struct weston_compositor *compositor, const char *modules,
 399                  int *argc, char *argv[])
 400 {
 401         const char *p, *end;
 402         char buffer[256];
 403         int (*module_init)(struct weston_compositor *compositor,
 404                            int *argc, char *argv[]);
 405
 406         if (modules == NULL)
 407                 return 0;
 408
 409         p = modules;
 410         while (*p) {
 411                 end = strchrnul(p, ',');
 412                 snprintf(buffer, sizeof buffer, "%.*s", (int)(end - p), p);
 413
 414                 module_init = weston_load_module(buffer, "module_init");
 415                 if (module_init)
 416                         module_init(compositor, argc, argv);
 417
 418                 p = end;
 419                 while (*p == ',')
 420                         p++;
 421         }
 422
 423         return 0;
 424 }
 425
 426 WL_EXPORT int
 427 module_init(struct weston_compositor *compositor,
 428             int *argc, char *argv[])
 429 {
 430         struct ivi_shell *shell;
 431         char ivi_layout_path[PATH_MAX];
 432         void *module;
 433         struct ivi_shell_setting setting = { };
 434
 435         shell = zalloc(sizeof *shell);
 436         if (shell == NULL)
 437                 return -1;
 438
 439         init_ivi_shell(compositor, shell);
 440
 441         shell->destroy_listener.notify = shell_destroy;
 442         wl_signal_add(&compositor->destroy_signal, &shell->destroy_listener);
 443
 444         if (input_panel_setup(shell) < 0)
 445                 return -1;
 446
 447         if (wl_global_create(compositor->wl_display,
 448                              &ivi_application_interface, 1,
 449                              shell, bind_ivi_application) == NULL)
 450                 return -1;
 451
 452         if (ivi_shell_setting_create(&setting, compositor) != 0)
 453                 return -1;
 454
 455         /*
 456          * load module:ivi-layout
 457          * ivi_layout_interface is referred by ivi-shell to use ivi-layout.
 458          * The reason why the following code is written newly without
 459          * using weston_load_module is it doesn't open library with
 460          * RTLD_GLOBAL option.
 461          */
 462         snprintf(ivi_layout_path, sizeof ivi_layout_path,
 463                  "%s/%s", MODULEDIR, "ivi-layout.so");
 464         module = dlopen(ivi_layout_path, RTLD_NOW | RTLD_NOLOAD);
 465         if (module) {
 466                 weston_log("ivi-shell: Module '%s' already loaded\n",
 467                            ivi_layout_path);
 468                 dlclose(module);
 469                 return -1;
 470         }
 471
 472         weston_log("ivi-shell: Loading module '%s'\n", ivi_layout_path);
 473         module = dlopen(ivi_layout_path, RTLD_NOW | RTLD_GLOBAL);
 474         if (!module) {
 475                 weston_log("ivi-shell: Failed to load module: %s\n", dlerror());
 476                 return -1;
 477         }
 478
 479         shell->ivi_layout = dlsym(module,"ivi_layout_interface");
 480         if (!shell->ivi_layout){
 481                 weston_log("ivi-shell: couldn't find ivi_layout_interface in '%s'\n", ivi_layout_path);
 482                 free(setting.ivi_module);
 483                 dlclose(module);
 484                 return -1;
 485         }
 486
 487         shell->ivi_layout->init_with_compositor(compositor);
 488
 489         /* Call module_init of ivi-modules which are defined in weston.ini */
 490         if (ivi_load_modules(compositor, setting.ivi_module, argc, argv) < 0) {
 491                 free(setting.ivi_module);
 492                 dlclose(module);
 493                 return -1;
 494         }
 495
 496         free(setting.ivi_module);
 497         return 0;
 498 }