src/app.cpp

   1 /*
   2  * Copyright (C) 2017 Mentor Graphics Development (Deutschland) GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include "app.hpp"
  18 #include "json_helper.hpp"
  19 #include "layers.hpp"
  20 #include "layout.hpp"
  21 #include "util.hpp"
  22 #include "wayland.hpp"
  23
  24 #include <cstdio>
  25 #include <memory>
  26
  27 #include <cassert>
  28
  29 #include <json-c/json.h>
  30
  31 #include <algorithm>
  32 #include <bits/signum.h>
  33 #include <csignal>
  34 #include <fstream>
  35 #include <json.hpp>
  36 #include <regex>
  37 #include <thread>
  38
  39 namespace wm {
  40
  41 namespace {
  42 App *g_app;
  43
  44 using nlohmann::json;
  45
  46 result<json> file_to_json(char const *filename) {
  47    std::ifstream i(filename);
  48    if (i.fail()) {
  49       return Err<json>("Could not open config file");
  50    }
  51    json j;
  52    i >> j;
  53    return Ok(j);
  54 }
  55
  56 struct result<layer_map>
  57    load_layer_map(char const *filename) {
  58    logdebug("loading IDs from %s", filename);
  59
  60    auto j = file_to_json(filename);
  61    if (j.is_err()) {
  62       return Err<layer_map>(j.unwrap_err());
  63    }
  64    json jids = j.unwrap();
  65
  66    return to_layer_map(jids);
  67 }
  68
  69 }  // namespace
  70
  71 //       _                    _                  _                 _
  72 //   ___| | __ _ ___ ___     / \   _ __  _ __   (_)_ __ ___  _ __ | |
  73 //  / __| |/ _` / __/ __|   / _ \ | '_ \| '_ \  | | '_ ` _ \| '_ \| |
  74 // | (__| | (_| \__ \__ \  / ___ \| |_) | |_) | | | | | | | | |_) | |
  75 //  \___|_|\__,_|___/___/ /_/   \_\ .__/| .__/  |_|_| |_| |_| .__/|_|
  76 //                                |_|   |_|                 |_|
  77 App::App(wl::display *d)
  78    : api{this},
  79      chooks{this},
  80      display{d},
  81      controller{},
  82      outputs(),
  83      config(),
  84      layouts(),
  85      layers(),
  86      id_alloc{},
  87      pending_events(false) {
  88    assert(g_app == nullptr);
  89    g_app = this;
  90
  91    try {
  92       {
  93          auto l = load_layer_map(
  94             this->config.get_string("layers.json").value().c_str());
  95          if (l.is_ok()) {
  96             this->layers = l.unwrap();
  97          } else {
  98             logerror("%s", l.err().value());
  99          }
 100       }
 101    } catch (std::exception &e) {
 102       logerror("Loading of configuration failed: %s", e.what());
 103    }
 104 }
 105
 106 App::~App() { g_app = nullptr; }
 107
 108 int App::init() {
 109    if (!this->display->ok()) {
 110       return -1;
 111    }
 112
 113    if (this->layers.mapping.empty()) {
 114       logerror("No surface -> layer mapping loaded");
 115       return -1;
 116    }
 117
 118    this->display->add_global_handler(
 119       "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
 120          this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
 121       });
 122
 123    this->display->add_global_handler(
 124       "ivi_controller", [this](wl_registry *r, uint32_t name, uint32_t v) {
 125          this->controller =
 126             std::make_unique<struct genivi::controller>(r, name, v);
 127
 128          // Init controller hooks
 129          this->controller->chooks = &this->chooks;
 130
 131          // XXX: This protocol needs the output, so lets just add our mapping
 132          // here...
 133          this->controller->add_proxy_to_id_mapping(
 134             this->outputs.back()->proxy.get(),
 135             wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
 136                this->outputs.back()->proxy.get())));
 137       });
 138
 139    // First level objects
 140    this->display->roundtrip();
 141    // Second level objects
 142    this->display->roundtrip();
 143    // Third level objects
 144    this->display->roundtrip();
 145
 146    return init_layers();
 147 }
 148
 149 int App::dispatch_events() {
 150    if (this->dispatch_events() == 0) {
 151       return 0;
 152    }
 153
 154    int ret = this->display->dispatch();
 155    if (ret == -1) {
 156       logerror("wl_display_dipatch() returned error %d",
 157                this->display->get_error());
 158       return -1;
 159    }
 160    this->display->flush();
 161
 162    return 0;
 163 }
 164
 165 int App::dispatch_pending_events() {
 166    if (this->pop_pending_events()) {
 167       this->display->dispatch_pending();
 168       return 0;
 169    }
 170    return -1;
 171 }
 172
 173 //  _       _ _       _                         _    ____
 174 // (_)_ __ (_) |_    | | __ _ _   _  ___  _   _| |_ / /\ \
 175 // | | '_ \| | __|   | |/ _` | | | |/ _ \| | | | __| |  | |
 176 // | | | | | | |_    | | (_| | |_| | (_) | |_| | |_| |  | |
 177 // |_|_| |_|_|\__|___|_|\__,_|\__, |\___/ \__,_|\__| |  | |
 178 //              |_____|       |___/                 \_\/_/
 179 int App::init_layers() {
 180    if (!this->controller) {
 181       logerror("ivi_controller global not available");
 182       return -1;
 183    }
 184
 185    if (this->outputs.empty()) {
 186       logerror("no output was set up!");
 187       return -1;
 188    }
 189
 190    auto &c = this->controller;
 191
 192    auto &o = this->outputs.front();
 193    auto &s = c->screens.begin()->second;
 194    auto &layers = c->layers;
 195
 196    // XXX: Write output dimensions to ivi controller...
 197    c->output_size = genivi::size{uint32_t(o->width), uint32_t(o->height)};
 198
 199    // Clear scene
 200    layers.clear();
 201
 202    // Clear screen
 203    s->clear();
 204
 205    // Quick and dirty setup of layers
 206    // XXX: This likely needs to be sorted by order (note, we don't (yet?)
 207    // do any zorder arrangement).
 208    for (auto const &i : this->layers.mapping) {
 209       c->layer_create(i.layer_id, o->width, o->height);
 210       auto &l = layers[i.layer_id];
 211       l->set_destination_rectangle(0, 0, o->width, o->height);
 212       l->set_visibility(1);
 213       logdebug("Setting up layer %s (%d) for surfaces %d-%d and role match \"%s\"", i.name.c_str(),
 214                i.layer_id, i.id_min, i.id_max, i.role.c_str());
 215       this->layouts[l->id] = LayoutState{};
 216    }
 217
 218    // Add layers to screen (XXX: are they sorted correctly?)
 219    s->set_render_order(this->layers.layers);
 220
 221    c->commit_changes();
 222
 223    this->display->flush();
 224
 225    return 0;
 226 }
 227
 228 namespace {
 229
 230 #ifdef WE_LIKE_NOT_TO_USE_THIS
 231 // This can fix the HomeScreen...
 232 void redraw_fix(App *app, std::unique_ptr<genivi::surface> &s, int x, int y,
 233                 int w, int h) {
 234    {  // XXX: Work around weston redraw issues
 235       // trigger an update by changing the source dimensions!
 236       s->set_configuration(w + 1, h);
 237       s->set_source_rectangle(0, 0, w + 1, h);
 238       s->set_destination_rectangle(x, y, w + 1, h);
 239       app->controller->commit_changes();
 240       app->display->roundtrip();
 241
 242       // wait some time, for the process to do its thing...
 243       using namespace std::chrono_literals;
 244       std::this_thread::sleep_for(100ms);
 245
 246       // Set a different size then what we actually want.
 247       s->set_configuration(w, h);
 248       s->set_source_rectangle(0, 0, w, h);
 249       s->set_destination_rectangle(x, y, w, h);
 250       app->controller->commit_changes();
 251       app->display->roundtrip();
 252    }
 253 }
 254 #endif
 255
 256 }  // namespace
 257
 258 void App::surface_set_layout_full(uint32_t surface_id) {
 259    if (!this->controller->surface_exists(surface_id)) {
 260       logerror("Surface %d does not exist", int(surface_id));
 261       return;
 262    }
 263
 264    auto o_layer_id = this->layers.get_layer_id(surface_id);
 265
 266    if (!o_layer_id) {
 267       logerror("Surface %d is not associated with any layer!", int(surface_id));
 268       return;
 269    }
 270
 271    uint32_t layer_id = o_layer_id.value();
 272    logdebug("surface_set_layout for surface %u on layer %u", surface_id,
 273             layer_id);
 274
 275    auto const &layer = this->layers.get_layer(layer_id);
 276    auto rect = layer.value().rect;
 277    auto &s = this->controller->surfaces[surface_id];
 278
 279    int x = rect.x;
 280    int y = rect.y;
 281    int w = rect.w;
 282    int h = rect.h;
 283
 284    // less-than-0 values refer to MAX + 1 - $VALUE
 285    // e.g. MAX is either screen width or height
 286    if (w < 0) {
 287       w = this->controller->output_size.w + 1 + w;
 288    }
 289    if (h < 0) {
 290       h = this->controller->output_size.h + 1 + h;
 291    }
 292
 293    // configure surface to wxh dimensions
 294    s->set_configuration(w, h);
 295
 296    // set source reactangle, even if we should not need to set it.
 297    s->set_source_rectangle(0, 0, w, h);
 298
 299    // set destination to the display rectangle
 300    s->set_destination_rectangle(x, y, w, h);
 301
 302    //redraw_fix(this, s, x, y, w, h);
 303
 304    logdebug("Surface %u now with rect { %d, %d, %d, %d }",
 305             surface_id, x, y, w, h);
 306 }
 307
 308 void App::surface_set_layout_split(uint32_t surface_id, uint32_t sub_surface_id) {
 309    if (!this->controller->surface_exists(surface_id)) {
 310       logerror("Surface %d does not exist", int(surface_id));
 311       return;
 312    }
 313
 314    auto o_layer_id = this->layers.get_layer_id(surface_id);
 315
 316    if (!o_layer_id) {
 317       logerror("Surface %d is not associated with any layer!", int(surface_id));
 318       return;
 319    }
 320
 321    uint32_t layer_id = o_layer_id.value();
 322    logdebug("surface_set_layout for surface %u on layer %u", surface_id,
 323             layer_id);
 324
 325    auto const &layer = this->layers.get_layer(layer_id);
 326    auto rect = layer.value().rect;
 327    auto &s = this->controller->surfaces[surface_id];
 328    auto &ss = this->controller->surfaces[sub_surface_id];
 329
 330    int x = rect.x;
 331    int y = rect.y;
 332    int w = rect.w;
 333    int h = rect.h;
 334
 335    // less-than-0 values refer to MAX + 1 - $VALUE
 336    // e.g. MAX is either screen width or height
 337    if (w < 0) {
 338       w = this->controller->output_size.w + 1 + w;
 339    }
 340    if (h < 0) {
 341       h = this->controller->output_size.h + 1 + h;
 342    }
 343
 344    int x_off = 0;
 345    int y_off = 0;
 346
 347    // split along major axis
 348    if (w > h) {
 349       w /= 2;
 350       x_off = w;
 351    } else {
 352       h /= 2;
 353       y_off = h;
 354    }
 355
 356    // configure surface to wxh dimensions
 357    s->set_configuration(w, h);
 358    // set source reactangle, even if we should not need to set it.
 359    s->set_source_rectangle(0, 0, w, h);
 360    // set destination to the display rectangle
 361    s->set_destination_rectangle(x, y, w, h);
 362
 363    // configure surface to wxh dimensions
 364    ss->set_configuration(w, h);
 365    // set source reactangle, even if we should not need to set it.
 366    ss->set_source_rectangle(0, 0, w, h);
 367    // set destination to the display rectangle
 368    ss->set_destination_rectangle(x+x_off, y+y_off, w, h);
 369
 370    //redraw_fix(this, s, x, y, w, h);
 371    //redraw_fix(this, ss, x+x_off, y+y_off, w, h);
 372
 373    logdebug("Surface %u now on layer %u with rect { %d, %d, %d, %d }",
 374             surface_id, layer_id, x, y, w, h);
 375 }
 376
 377 char const *App::activate_surface(char const *drawing_name) {
 378    ST();
 379    auto const &surface_id = this->lookup_id(drawing_name);
 380
 381    if (!surface_id) {
 382       return "Surface does not exist";
 383    }
 384
 385    if (!this->controller->surface_exists(*surface_id)) {
 386       return "Surface does not exist in controller!";
 387    }
 388
 389    auto layer_id = this->layers.get_layer_id(*surface_id);
 390
 391    if (! layer_id) {
 392       return "Surface is not on any layer!";
 393    }
 394
 395    struct LayoutState &state = **this->layers.get_layout_state(*surface_id);
 396
 397    // disable layers that are above our current layer
 398    for (auto const &l : this->layers.mapping) {
 399       if (l.layer_id <= *layer_id) {
 400          continue;
 401       }
 402
 403       bool flush = false;
 404       if (l.state.main != -1) {
 405          this->deactivate(l.state.main);
 406          l.state.main = -1;
 407          flush = true;
 408       }
 409
 410       if (l.state.sub != -1) {
 411          this->deactivate(l.state.sub);
 412          l.state.sub = -1;
 413          flush = true;
 414       }
 415
 416       l.state.s = LayoutState::Single;
 417
 418       if (flush) {
 419          this->controller->commit_changes();
 420          this->display->flush();
 421       }
 422    }
 423
 424    if (state.main == *surface_id || state.sub == *surface_id) {
 425       return "Surface already active";
 426    }
 427
 428    // This should involve a policy check, but as we do not (yet) have
 429    // such a thing, we will just switch to this surface.
 430    // XXX: input focus missing!!1
 431
 432    if (state.main == -1) {
 433       this->emit_syncdraw(drawing_name);
 434
 435       this->surface_set_layout_full(*surface_id);
 436       this->activate(*surface_id);
 437       state.main = *surface_id;
 438       state.sub = -1;
 439       state.s = LayoutState::Single;
 440
 441       this->emit_flushdraw(drawing_name);
 442    } else {
 443       bool can_split = this->can_split(state, *surface_id);
 444
 445       if (state.sub == -1) {
 446          if (can_split) {
 447             if (state.main != *surface_id) {
 448                std::string main = *this->lookup_name(state.main);
 449                this->emit_syncdraw(drawing_name);
 450                this->emit_syncdraw(main.c_str());
 451
 452                this->surface_set_layout_split(state.main, *surface_id);
 453                this->activate(*surface_id);
 454                state.sub = *surface_id;
 455
 456                // Should wait for EndDraw event...
 457                this->emit_flushdraw(drawing_name);
 458                this->emit_flushdraw(main.c_str());
 459             }
 460          } else {
 461             this->emit_syncdraw(drawing_name);
 462
 463             this->surface_set_layout_full(*surface_id);
 464             this->deactivate(state.main);
 465             this->activate(*surface_id);
 466             this->deactivate(state.sub);
 467             state.main = *surface_id;
 468             state.sub = -1;
 469             state.s = LayoutState::Single;
 470
 471             this->emit_flushdraw(drawing_name);
 472          }
 473       }
 474    }
 475
 476    // commit changes
 477    this->controller->commit_changes();
 478    this->display->flush();
 479
 480    // no error
 481    return nullptr;
 482 }
 483
 484 char const *App::deactivate_surface(char const *drawing_name) {
 485    ST();
 486    auto const &surface_id = this->lookup_id(drawing_name);
 487
 488    if (!surface_id) {
 489       return "Surface does not exist";
 490    }
 491
 492    if (*surface_id == this->layers.main_surface) {
 493       return "Cannot deactivate main_surface";
 494    }
 495
 496    auto o_state = *this->layers.get_layout_state(*surface_id);
 497
 498    if (! o_state) {
 499       return "Could not find layer for surface";
 500    }
 501
 502    struct LayoutState &state = *o_state;
 503
 504    if (state.main == -1) {
 505       return "No surface active";
 506    }
 507
 508    if (*surface_id == this->layers.main_surface) {
 509       logdebug("Refusing to deactivate main_surface %d", *surface_id);
 510       return nullptr;
 511    }
 512
 513    if (state.main == *surface_id) {
 514       if (state.sub != -1) {
 515          std::string sub = *this->lookup_name(state.sub);
 516          this->emit_syncdraw(sub.c_str());
 517
 518          this->deactivate(*surface_id);
 519          this->surface_set_layout_full(state.sub);
 520          state.main = state.sub;
 521          state.sub = -1;
 522          state.s = LayoutState::Single;
 523
 524          this->emit_flushdraw(sub.c_str());
 525       } else {
 526          this->deactivate(*surface_id);
 527          state.main = -1;
 528       }
 529    }else if (state.sub == *surface_id) {
 530       std::string main = *this->lookup_name(state.main);
 531       this->emit_syncdraw(main.c_str());
 532
 533       this->deactivate(*surface_id);
 534       this->deactivate(*surface_id);
 535       this->surface_set_layout_full(state.main);
 536       state.sub = -1;
 537       state.s = LayoutState::Single;
 538
 539       this->emit_flushdraw(main.c_str());
 540    } else {
 541       return "Surface is not active";
 542    }
 543
 544    this->controller->commit_changes();
 545    this->display->flush();
 546
 547    return nullptr;
 548 }
 549
 550 //                      _          _   _____                 _
 551 //  _ __  _ __ _____  _(_) ___  __| | | ____|_   _____ _ __ | |_ ___
 552 // | '_ \| '__/ _ \ \/ / |/ _ \/ _` | |  _| \ \ / / _ \ '_ \| __/ __|
 553 // | |_) | | | (_) >  <| |  __/ (_| | | |___ \ V /  __/ | | | |_\__ \
 554 // | .__/|_|  \___/_/\_\_|\___|\__,_| |_____| \_/ \___|_| |_|\__|___/
 555 // |_|
 556 void App::surface_created(uint32_t surface_id) {
 557    auto layer_id = this->layers.get_layer_id(surface_id);
 558    if (! layer_id) {
 559       logdebug("Newly created surfce %d is not associated with any layer!", surface_id);
 560       return;
 561    }
 562
 563    logdebug("surface_id is %u, layer_id is %u", surface_id, *layer_id);
 564
 565    this->controller->layers[*layer_id]
 566            ->add_surface(this->controller->surfaces[surface_id].get());
 567
 568    // activate the main_surface right away
 569    if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
 570       logdebug("Activating main_surface (%d)", surface_id);
 571
 572       this->activate_surface(
 573               this->lookup_name(surface_id).value_or("unknown-name").c_str());
 574    }
 575 }
 576
 577 void App::surface_removed(uint32_t surface_id) {
 578    logdebug("surface_id is %u", surface_id);
 579
 580    this->id_alloc.remove_id(surface_id);
 581 }
 582
 583 void App::emit_activated(char const *label) {
 584    this->api.send_event("activated", label);
 585 }
 586
 587 void App::emit_deactivated(char const *label) {
 588    this->api.send_event("deactivated", label);
 589 }
 590
 591 void App::emit_syncdraw(char const *label) {
 592    this->api.send_event("syncdraw", label);
 593 }
 594
 595 void App::emit_flushdraw(char const *label) {
 596    this->api.send_event("flushdraw", label);
 597 }
 598
 599 void App::emit_visible(char const *label, bool is_visible) {
 600    this->api.send_event(is_visible ? "visible" : "invisible", label);
 601 }
 602
 603 void App::emit_invisible(char const *label) { return emit_visible(label, false); }
 604
 605 void App::emit_visible(char const *label) { return emit_visible(label, true); }
 606
 607 result<int> App::request_surface(char const *drawing_name) {
 608    auto lid = this->layers.get_layer_id(std::string(drawing_name));
 609    if (!lid) {
 610       // XXX: to we need to put these applications on the App layer?
 611       return Err<int>("Drawing name does not match any role");
 612    }
 613
 614    auto rname = this->lookup_id(drawing_name);
 615    if (!rname) {
 616       // name does not exist yet, allocate surface id...
 617       auto id = int(this->id_alloc.generate_id(drawing_name));
 618       this->layers.add_surface(id, *lid);
 619
 620       // XXX: we set the main_surface[_name] here and now,
 621       // not sure if we want this, but it worked so far.
 622       if (!this->layers.main_surface_name.empty() &&
 623           this->layers.main_surface_name == drawing_name) {
 624          this->layers.main_surface = id;
 625          logdebug("Set main_surface id to %u", id);
 626       }
 627
 628       return Ok<int>(id);
 629    }
 630
 631    // Check currently registered drawing names if it is already there.
 632    return Err<int>("Surface already present");
 633 }
 634
 635 void App::activate(int id) {
 636    if (this->controller->sprops[id].visibility == 0) {
 637       this->controller->surfaces[id]->set_visibility(1);
 638       char const *label =
 639          this->lookup_name(id).value_or("unknown-name").c_str();
 640       this->emit_activated(label);
 641       this->emit_visible(label);
 642    }
 643 }
 644
 645 void App::deactivate(int id) {
 646    if (this->controller->sprops[id].visibility != 0) {
 647       this->controller->surfaces[id]->set_visibility(0);
 648       char const *label =
 649          this->lookup_name(id).value_or("unknown-name").c_str();
 650       this->emit_deactivated(label);
 651       this->emit_invisible(label);
 652    }
 653 }
 654
 655 bool App::can_split(struct LayoutState const &state, int new_id) {
 656    if (state.main != -1 && state.main != new_id) {
 657       auto new_id_layer = this->layers.get_layer_id(new_id).value();
 658       auto current_id_layer =
 659          this->layers.get_layer_id(state.main).value();
 660
 661       // surfaces are on separate layers, don't bother.
 662       if (new_id_layer != current_id_layer) {
 663          return false;
 664       }
 665
 666       std::string const &new_id_str = this->lookup_name(new_id).value();
 667       std::string const &cur_id_str =
 668          this->lookup_name(state.main).value();
 669
 670       auto const &layer = this->layers.get_layer(new_id_layer);
 671
 672       logdebug("layer info name: %s", layer->name.c_str());
 673
 674       if (layer->layouts.empty()) {
 675          return false;
 676       }
 677
 678       for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++) {
 679          logdebug("%d main_match '%s'", new_id_layer, i->main_match.c_str());
 680          auto rem = std::regex(i->main_match);
 681          if (std::regex_match(cur_id_str, rem)) {
 682             // build the second one only if the first already matched
 683             logdebug("%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
 684             auto res = std::regex(i->sub_match);
 685             if (std::regex_match(new_id_str, res)) {
 686                logdebug("layout matched!");
 687                return true;
 688             }
 689          }
 690       }
 691    }
 692
 693    return false;
 694 }
 695
 696 //                  _             _ _            _                 _
 697 //   ___ ___  _ __ | |_ _ __ ___ | | | ___ _ __ | |__   ___   ___ | | _____
 698 //  / __/ _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|| '_ \ / _ \ / _ \| |/ / __|
 699 // | (_| (_) | | | | |_| | | (_) | | |  __/ |   | | | | (_) | (_) |   <\__ \
 700 //  \___\___/|_| |_|\__|_|  \___/|_|_|\___|_|___|_| |_|\___/ \___/|_|\_\___/
 701 //                                         |_____|
 702 void controller_hooks::surface_created(uint32_t surface_id) {
 703    this->app->surface_created(surface_id);
 704 }
 705
 706 void controller_hooks::surface_removed(uint32_t surface_id) {
 707    this->app->surface_removed(surface_id);
 708 }
 709
 710 }  // namespace wm