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->pending_events.load(std::memory_order_consume)) {
 151       this->pending_events.store(false, std::memory_order_release);
 152       return this->display->dispatch_pending();
 153    }
 154
 155    int ret = this->display->dispatch();
 156    if (ret == -1) {
 157       logerror("wl_display_dipatch() returned error %d",
 158                this->display->get_error());
 159       return -1;
 160    }
 161    this->display->flush();
 162
 163    // execute pending tasks, that is layout changes etc.
 164    // this->execute_pending();
 165
 166    return 0;
 167 }
 168
 169 //  _       _ _       _                         _    ____
 170 // (_)_ __ (_) |_    | | __ _ _   _  ___  _   _| |_ / /\ \
 171 // | | '_ \| | __|   | |/ _` | | | |/ _ \| | | | __| |  | |
 172 // | | | | | | |_    | | (_| | |_| | (_) | |_| | |_| |  | |
 173 // |_|_| |_|_|\__|___|_|\__,_|\__, |\___/ \__,_|\__| |  | |
 174 //              |_____|       |___/                 \_\/_/
 175 int App::init_layers() {
 176    if (!this->controller) {
 177       logerror("ivi_controller global not available");
 178       return -1;
 179    }
 180
 181    if (this->outputs.empty()) {
 182       logerror("no output was set up!");
 183       return -1;
 184    }
 185
 186    auto &c = this->controller;
 187
 188    auto &o = this->outputs.front();
 189    auto &s = c->screens.begin()->second;
 190    auto &layers = c->layers;
 191
 192    // XXX: Write output dimensions to ivi controller...
 193    c->output_size = genivi::size{uint32_t(o->width), uint32_t(o->height)};
 194
 195    // Clear scene
 196    layers.clear();
 197
 198    // Clear screen
 199    s->clear();
 200
 201    // Quick and dirty setup of layers
 202    // XXX: This likely needs to be sorted by order (note, we don't (yet?)
 203    // do any zorder arrangement).
 204    for (auto const &i : this->layers.mapping) {
 205       c->layer_create(i.layer_id, o->width, o->height);
 206       auto &l = layers[i.layer_id];
 207       l->set_destination_rectangle(0, 0, o->width, o->height);
 208       l->set_visibility(1);
 209       logdebug("Setting up layer %s (%d) for surfaces %d-%d and role match \"%s\"", i.name.c_str(),
 210                i.layer_id, i.id_min, i.id_max, i.role.c_str());
 211       this->layouts[l->id] = LayoutState{};
 212    }
 213
 214    // Add layers to screen (XXX: are they sorted correctly?)
 215    s->set_render_order(this->layers.layers);
 216
 217    c->commit_changes();
 218
 219    this->display->flush();
 220
 221    return 0;
 222 }
 223
 224 namespace {
 225
 226 // This can fix the HomeScreen...
 227 void redraw_fix(App *app, std::unique_ptr<genivi::surface> &s, int x, int y,
 228                 int w, int h) {
 229    {  // XXX: Work around weston redraw issues
 230       // trigger an update by changing the source dimensions!
 231       s->set_configuration(w + 1, h);
 232       s->set_source_rectangle(0, 0, w + 1, h);
 233       s->set_destination_rectangle(x, y, w + 1, h);
 234       app->controller->commit_changes();
 235       app->display->roundtrip();
 236
 237       // wait some time, for the process to do its thing...
 238       using namespace std::chrono_literals;
 239       std::this_thread::sleep_for(100ms);
 240
 241       // Set a different size then what we actually want.
 242       s->set_configuration(w, h);
 243       s->set_source_rectangle(0, 0, w, h);
 244       s->set_destination_rectangle(x, y, w, h);
 245       app->controller->commit_changes();
 246       app->display->roundtrip();
 247    }
 248 }
 249
 250 }  // namespace
 251
 252 void App::surface_set_layout_full(uint32_t surface_id) {
 253    if (!this->controller->surface_exists(surface_id)) {
 254       logerror("Surface %d does not exist", int(surface_id));
 255       return;
 256    }
 257
 258    auto o_layer_id = this->layers.get_layer_id(surface_id);
 259
 260    if (!o_layer_id) {
 261       logerror("Surface %d is not associated with any layer!", int(surface_id));
 262       return;
 263    }
 264
 265    uint32_t layer_id = o_layer_id.value();
 266    logdebug("surface_set_layout for surface %u on layer %u", surface_id,
 267             layer_id);
 268
 269    auto const &layer = this->layers.get_layer(layer_id);
 270    auto rect = layer.value().rect;
 271    auto &s = this->controller->surfaces[surface_id];
 272
 273    int x = rect.x;
 274    int y = rect.y;
 275    int w = rect.w;
 276    int h = rect.h;
 277
 278    // less-than-0 values refer to MAX + 1 - $VALUE
 279    // e.g. MAX is either screen width or height
 280    if (w < 0) {
 281       w = this->controller->output_size.w + 1 + w;
 282    }
 283    if (h < 0) {
 284       h = this->controller->output_size.h + 1 + h;
 285    }
 286
 287    // configure surface to wxh dimensions
 288    s->set_configuration(w, h);
 289
 290    // set source reactangle, even if we should not need to set it.
 291    s->set_source_rectangle(0, 0, w, h);
 292
 293    // set destination to the display rectangle
 294    s->set_destination_rectangle(x, y, w, h);
 295
 296    s->set_visibility(0);
 297    s->set_opacity(256);
 298
 299    this->controller->commit_changes();
 300    this->display->roundtrip();
 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    this->state.main = surface_id;
 336    this->state.sub = sub_surface_id;
 337    this->state.state = LayoutState::LayoutSplit;
 338
 339    // less-than-0 values refer to MAX + 1 - $VALUE
 340    // e.g. MAX is either screen width or height
 341    if (w < 0) {
 342       w = this->controller->output_size.w + 1 + w;
 343    }
 344    if (h < 0) {
 345       h = this->controller->output_size.h + 1 + h;
 346    }
 347
 348    int x_off = 0;
 349    int y_off = 0;
 350
 351    // split along major axis
 352    if (w > h) {
 353       w /= 2;
 354       x_off = w;
 355    } else {
 356       h /= 2;
 357       y_off = h;
 358    }
 359
 360    // configure surface to wxh dimensions
 361    s->set_configuration(w, h);
 362    // set source reactangle, even if we should not need to set it.
 363    s->set_source_rectangle(0, 0, w, h);
 364    // set destination to the display rectangle
 365    s->set_destination_rectangle(x, y, w, h);
 366
 367    s->set_visibility(1);
 368    s->set_opacity(256);
 369
 370    // configure surface to wxh dimensions
 371    ss->set_configuration(w, h);
 372    // set source reactangle, even if we should not need to set it.
 373    ss->set_source_rectangle(0, 0, w, h);
 374    // set destination to the display rectangle
 375    ss->set_destination_rectangle(x+x_off, y+y_off, w, h);
 376
 377    ss->set_visibility(1);
 378    ss->set_opacity(256);
 379
 380    this->controller->commit_changes();
 381    this->display->roundtrip();
 382
 383    //redraw_fix(this, s, x, y, w, h);
 384    //redraw_fix(this, ss, x+x_off, y+y_off, w, h);
 385
 386    logdebug("Surface %u now on layer %u with rect { %d, %d, %d, %d }",
 387             surface_id, layer_id, x, y, w, h);
 388 }
 389
 390 char const *App::activate_surface(char const *drawing_name) {
 391    int surface_id = -1;
 392
 393    {
 394       auto oid = this->lookup_id(drawing_name);
 395       if (oid) {
 396          surface_id = oid.value();
 397       } else {
 398          return "Surface does not exist";
 399       }
 400    }
 401
 402    if (!this->controller->surface_exists(surface_id)) {
 403       return "Surface does not exist";
 404    }
 405
 406    if (this->state.main == surface_id || this->state.sub == surface_id) {
 407       return "Surface already active";
 408    }
 409
 410    // This should involve a policy check, but as we do not (yet) have
 411    // such a thing, we will just switch to this surface.
 412    // XXX: input focus missing!!1
 413
 414    if (this->state != LayoutState{}) {
 415       switch (this->state.state) {
 416          case LayoutState::LayoutSingle:
 417             if (this->can_split(surface_id)) {
 418                this->surface_set_layout_split(this->state.main, surface_id);
 419                return nullptr;
 420             }
 421             break;
 422
 423          case LayoutState::LayoutSplit:
 424             if (this->can_split(surface_id)) {
 425                this->deactivate(this->state.sub);
 426                this->surface_set_layout_split(this->state.main, surface_id);
 427             }
 428
 429          case LayoutState::LayoutNone:
 430             break;
 431       }
 432    }
 433
 434    // Make it visible, no (or little effect) if already visible
 435    auto &s = this->controller->surfaces[surface_id];
 436
 437    // Set all others invisible
 438    for (auto &i : this->controller->surfaces) {
 439       auto &si = this->controller->sprops[i.second->id];
 440       if (si.id != s->id && si.visibility != 0 &&
 441           int(si.id) != this->layers.main_surface) {
 442          this->deactivate(si.id);
 443       }
 444    }
 445    this->activate(s->id);
 446
 447    // commit changes
 448    this->controller->commit_changes();
 449    this->display->flush();
 450
 451    this->state.main = surface_id;
 452    this->state.state = LayoutState::LayoutSingle;
 453
 454    // no error
 455    return nullptr;
 456 }
 457
 458 char const *App::deactivate_surface(char const *drawing_name) {
 459    int surface_id = -1;
 460
 461    {
 462       auto oid = this->lookup_id(drawing_name);
 463       if (oid) {
 464          surface_id = oid.value();
 465       } else {
 466          return "Surface does not exist";
 467       }
 468    }
 469
 470    if (surface_id == this->layers.main_surface) {
 471       return "Cannot deactivate main_surface";
 472    }
 473
 474    switch (this->state.state) {
 475       case LayoutState::LayoutSplit:
 476          if (surface_id == this->state.main) {
 477             this->deactivate(surface_id);
 478             this->surface_set_layout_full(this->state.main);
 479
 480             this->deactivate(this->state.sub);
 481             this->surface_set_layout_full(this->state.sub);
 482
 483             this->state.main = -1;
 484             this->state.sub = -1;
 485             this->state.state = LayoutState::LayoutSingle;
 486          } else if (surface_id == this->state.sub) {
 487             this->deactivate(surface_id);
 488             this->surface_set_layout_full(this->state.sub);
 489             this->surface_set_layout_full(this->state.main);
 490
 491             // XXX send syndraw events....
 492
 493             this->state.sub = -1;
 494             this->state.state = LayoutState::LayoutSingle;
 495          }
 496          break;
 497
 498       case LayoutState::LayoutSingle:
 499          this->deactivate(surface_id);
 500          this->state.main = -1;
 501          this->state.sub = -1;
 502          break;
 503
 504       case LayoutState::LayoutNone:
 505          break;
 506    }
 507
 508
 509    this->controller->commit_changes();
 510    this->display->flush();
 511
 512    return nullptr;
 513 }
 514
 515 //                      _          _   _____                 _
 516 //  _ __  _ __ _____  _(_) ___  __| | | ____|_   _____ _ __ | |_ ___
 517 // | '_ \| '__/ _ \ \/ / |/ _ \/ _` | |  _| \ \ / / _ \ '_ \| __/ __|
 518 // | |_) | | | (_) >  <| |  __/ (_| | | |___ \ V /  __/ | | | |_\__ \
 519 // | .__/|_|  \___/_/\_\_|\___|\__,_| |_____| \_/ \___|_| |_|\__|___/
 520 // |_|
 521 void App::surface_created(uint32_t surface_id) {
 522    logdebug("surface_id is %u", surface_id);
 523
 524    this->surface_set_layout_full(surface_id);
 525
 526    this->controller->layers[this->layers.get_layer_id(surface_id).value()]
 527            ->add_surface(this->controller->surfaces[surface_id].get());
 528
 529    // activate the main_surface right away
 530    if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
 531       logdebug("Activating main_surface (%d)", surface_id);
 532
 533       this->activate_surface(
 534               this->lookup_name(surface_id).value_or("unknown-name").c_str());
 535    }
 536 }
 537
 538 void App::surface_removed(uint32_t surface_id) {
 539    logdebug("surface_id is %u", surface_id);
 540
 541    this->id_alloc.remove_id(surface_id);
 542 }
 543
 544 void App::emit_activated(char const *label) {
 545    this->api.send_event("activated", label);
 546 }
 547
 548 void App::emit_deactivated(char const *label) {
 549    this->api.send_event("deactivated", label);
 550 }
 551
 552 void App::emit_syncdraw(char const *label) {
 553    this->api.send_event("syncdraw", label);
 554 }
 555
 556 void App::emit_flushdraw(char const *label) {
 557    this->api.send_event("syncdraw", label);
 558 }
 559
 560 void App::emit_visible(char const *label, bool is_visible) {
 561    this->api.send_event(is_visible ? "visible" : "invisible", label);
 562 }
 563
 564 void App::emit_invisible(char const *label) { return emit_visible(label, 0); }
 565
 566 void App::emit_visible(char const *label) { return emit_visible(label, 1); }
 567
 568 result<int> App::request_surface(char const *drawing_name) {
 569    auto lid = this->layers.get_layer_id(std::string(drawing_name));
 570    if (!lid) {
 571       // XXX: to we need to put these applications on the App layer?
 572       return Err<int>("Drawing name does not match any role");
 573    }
 574
 575    auto rname = this->lookup_id(drawing_name);
 576    if (!rname) {
 577       // name does not exist yet, allocate surface id...
 578       auto id = int(this->id_alloc.generate_id(drawing_name));
 579       this->layers.add_surface(id, lid.value());
 580
 581       // XXX: we set the main_surface[_name] here and now,
 582       // not sure if we want this, but it worked so far.
 583       if (!this->layers.main_surface_name.empty() &&
 584           this->layers.main_surface_name == drawing_name) {
 585          this->layers.main_surface = id;
 586          logdebug("Set main_surface id to %u", id);
 587       }
 588
 589       return Ok<int>(id);
 590    }
 591
 592    // Check currently registered drawing names if it is already there.
 593    return Err<int>("Surface already present");
 594 }
 595
 596 void App::activate(unsigned id) {
 597    if (this->controller->sprops[id].visibility == 0) {
 598       this->controller->surfaces[id]->set_visibility(1);
 599       char const *label =
 600          this->lookup_name(id).value_or("unknown-name").c_str();
 601       this->emit_activated(label);
 602       this->emit_visible(label);
 603    }
 604 }
 605
 606 void App::deactivate(unsigned id) {
 607    if (this->controller->sprops[id].visibility != 0) {
 608       this->controller->surfaces[id]->set_visibility(0);
 609       char const *label =
 610          this->lookup_name(id).value_or("unknown-name").c_str();
 611       this->emit_deactivated(label);
 612       this->emit_invisible(label);
 613    }
 614 }
 615
 616 bool App::can_split(unsigned new_id) {
 617    if (this->state.state == LayoutState::LayoutSingle) {
 618       auto new_id_layer = this->layers.get_layer_id(new_id).value();
 619       auto current_id_layer =
 620          this->layers.get_layer_id(this->state.main).value();
 621
 622       // surfaces are on separate layers, don't bother.
 623       if (new_id_layer != current_id_layer) {
 624          return false;
 625       }
 626
 627       std::string const &new_id_str = this->lookup_name(new_id).value();
 628       std::string const &cur_id_str =
 629          this->lookup_name(this->state.main).value();
 630
 631       auto const &layer = this->layers.get_layer(new_id_layer);
 632
 633       logdebug("layer info name: %s", layer->name.c_str());
 634
 635       if (layer->layouts.empty()) {
 636          return false;
 637       }
 638
 639       for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++) {
 640          logdebug("%d main_match '%s'", new_id_layer, i->main_match.c_str());
 641          auto rem = std::regex(i->main_match);
 642          if (std::regex_match(cur_id_str, rem)) {
 643             // build the second one only if the first already matched
 644             logdebug("%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
 645             auto res = std::regex(i->sub_match);
 646             if (std::regex_match(new_id_str, res)) {
 647                return true;
 648             }
 649          }
 650       }
 651    }
 652
 653    return false;
 654 }
 655
 656 //                  _             _ _            _                 _
 657 //   ___ ___  _ __ | |_ _ __ ___ | | | ___ _ __ | |__   ___   ___ | | _____
 658 //  / __/ _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|| '_ \ / _ \ / _ \| |/ / __|
 659 // | (_| (_) | | | | |_| | | (_) | | |  __/ |   | | | | (_) | (_) |   <\__ \
 660 //  \___\___/|_| |_|\__|_|  \___/|_|_|\___|_|___|_| |_|\___/ \___/|_|\_\___/
 661 //                                         |_____|
 662 void controller_hooks::surface_created(uint32_t surface_id) {
 663    this->app->surface_created(surface_id);
 664 }
 665
 666 void controller_hooks::surface_removed(uint32_t surface_id) {
 667    this->app->surface_removed(surface_id);
 668 }
 669
 670 }  // namespace wm