app: do not use the Qt surface ID shift hack
[staging/windowmanager.git] / src / app.cpp
index 461ac35..c672052 100644 (file)
@@ -1,6 +1,18 @@
-//
-// Created by mfritzsc on 7/11/17.
-//
+/*
+ * Copyright (C) 2017 Mentor Graphics Development (Deutschland) GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 #include "app.hpp"
 #include "json_helper.hpp"
@@ -16,6 +28,7 @@
 
 #include <json-c/json.h>
 
+#include <algorithm>
 #include <bits/signum.h>
 #include <csignal>
 #include <fstream>
@@ -29,22 +42,19 @@ App *g_app;
 using json = nlohmann::json;
 
 struct wm::area area_from_json(json const &j) {
-   DB(j);
    return wm::area{
-      j["name"].get<std::string>(),
+      j["name"],
       {
-         get<int32_t>(j["width"]), get<int32_t>(j["height"]),
-         get<int32_t>(j["x"]), get<int32_t>(j["y"]),
+         j["width"], j["height"], j["x"], j["y"],
       },
-      get<uint32_t>(j["zorder"]),
+      j["zorder"],
    };
 }
 
 result<struct layout> layout_from_json(json const &j) {
-   DB(j);
    auto &ja = j["areas"];
 
-   auto l = layout{j["name"].get<std::string>(), uint32_t(ja.size()), {}};
+   auto l = layout{j["name"], uint32_t(ja.size()), {}};
 
    if (ja.size() > layout::MAX_N_AREAS) {
       return Err<struct layout>("Invalid number of areas in layout");
@@ -69,8 +79,9 @@ result<json> file_to_json(char const *filename) {
    return Ok(j);
 }
 
+// Will throw if parsing fails
 struct result<layouts_type> load_layout(char const *filename) {
-   DB("loading layout from " << filename);
+   logdebug("loading layout from %s", filename);
 
    auto j = file_to_json(filename);
    if (j.is_err()) {
@@ -86,17 +97,17 @@ struct result<layouts_type> load_layout(char const *filename) {
    return Ok(layouts);
 }
 
-struct result<surface_id_to_layer_map>
-   load_layer_ids(char const *filename) {
-   DB("loading IDs from " << filename);
+struct result<layer_map>
+   load_layer_map(char const *filename) {
+   logdebug("loading IDs from %s", filename);
 
    auto j = file_to_json(filename);
    if (j.is_err()) {
-      return Err<surface_id_to_layer_map>(j.unwrap_err());
+      return Err<layer_map>(j.unwrap_err());
    }
    json jids = j.unwrap();
 
-   return to_surface_id_to_layer_map(jids);
+   return to_layer_map(jids);
 }
 
 }  // namespace
@@ -113,27 +124,38 @@ App::App(wl::display *d)
      display{d},
      controller{},
      outputs(),
+     config(),
      layouts(),
-     surface2layer() {
+     layers(),
+     pending(),
+     name_mapping(),
+     id_alloc{},
+     last_active() {
    assert(g_app == nullptr);
    g_app = this;
 
-   {
-      auto l = load_layer_ids("../ids.json");
-      if (l.is_ok()) {
-         this->surface2layer = l.unwrap();
-      } else {
-         logerror("%s", l.err().value());
+   try {
+      {
+         auto l = load_layer_map(
+            this->config.get_string("layers.json").value().c_str());
+         if (l.is_ok()) {
+            this->layers = l.unwrap();
+         } else {
+            logerror("%s", l.err().value());
+         }
       }
-   }
 
-   {
-      auto l = load_layout("../layout.json");
-      if (l.is_ok()) {
-         this->layouts = l.unwrap();
-      } else {
-         logerror("%s", l.err().value());
+      {
+         auto l =
+            load_layout(this->config.get_string("layout.json").value().c_str());
+         if (l.is_ok()) {
+            this->layouts = l.unwrap();
+         } else {
+            logerror("%s", l.err().value());
+         }
       }
+   } catch (std::exception &e) {
+      logerror("Loading of configuration failed: %s", e.what());
    }
 }
 
@@ -144,6 +166,11 @@ int App::init() {
       return -1;
    }
 
+   if (this->layers.mapping.empty()) {
+      logerror("No surface -> layer mapping loaded");
+      return -1;
+   }
+
    this->display->add_global_handler(
       "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
          this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
@@ -151,7 +178,7 @@ int App::init() {
 
    this->display->add_global_handler(
       "ivi_controller", [this](wl_registry *r, uint32_t name, uint32_t v) {
-         this->controller = std::make_unique<genivi::controller>(r, name, v);
+         this->controller = std::make_unique<struct genivi::controller>(r, name, v);
 
          // Init controller hooks
          this->controller->chooks = &this->chooks;
@@ -184,8 +211,7 @@ int App::dispatch_events() {
    this->display->flush();
 
    // execute pending tasks, that is layout changes etc.
-   this->controller->execute_pending();
-   this->display->roundtrip();
+   this->execute_pending();
 
    return 0;
 }
@@ -225,7 +251,7 @@ int App::init_layout() {
    // Quick and dirty setup of layers
    // XXX: This likely needs to be sorted by order (note, we don't (yet?)
    // do any zorder arrangement).
-   for (auto const &i : this->surface2layer.mapping) {
+   for (auto const &i : this->layers.mapping) {
       c->layer_create(i.layer_id, o->width, o->height);
       auto &l = layers[i.layer_id];
       l->set_destination_rectangle(0, 0, o->width, o->height);
@@ -235,7 +261,7 @@ int App::init_layout() {
    }
 
    // Add layers to screen (XXX: are they sorted correctly?)
-   s->set_render_order(this->surface2layer.layers);
+   s->set_render_order(this->layers.layers);
 
    c->commit_changes();
 
@@ -244,6 +270,147 @@ int App::init_layout() {
    return 0;
 }
 
+void App::surface_set_layout(uint32_t surface_id) {
+   if (!this->controller->surface_exists(surface_id)) {
+      logerror("Surface %d does not exist", int(surface_id));
+      return;
+   }
+
+   auto o_layer_id = this->layers.get_layer_id(surface_id);
+
+   if (!o_layer_id) {
+      logerror("Surface %d is not associated with any layer!", int(surface_id));
+      return;
+   }
+
+   uint32_t layer_id = o_layer_id.value();
+   logdebug("surface_set_layout for surface %u on layer %u", surface_id,
+            layer_id);
+
+   auto const &layer = this->layers.get_layer(layer_id);
+   auto rect = layer.value().rect;
+   auto &s = this->controller->surfaces[surface_id];
+
+   int x = rect.x;
+   int y = rect.y;
+   int w = rect.w;
+   int h = rect.h;
+
+   // less-than-0 values refer to MAX + 1 - $VALUE
+   // e.g. MAX is either screen width or height
+   if (w < 0) {
+      w = this->controller->output_size.w + 1 + w;
+   }
+   if (h < 0) {
+      h = this->controller->output_size.h + 1 + h;
+   }
+
+   // configure surface to wxh dimensions
+   s->set_configuration(w, h);
+   // set source reactangle, even if we should not need to set it.
+   s->set_source_rectangle(0, 0, w, h);
+   // set destination to the display rectangle
+   s->set_destination_rectangle(x, y, w, h);
+
+   // XXX: The main_surface will be visible regardless
+   //s->set_visibility(
+   //   surface_id == static_cast<unsigned>(this->layers.main_surface) ? 1 : 0);
+   this->controller->layers[layer_id]->add_surface(s.get());
+
+   if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
+      logdebug("Activating main_surface (%d)", surface_id);
+      this->activate_surface(surface_id);
+   }
+
+   logdebug("Surface %u now on layer %u with rect { %d, %d, %d, %d }",
+            surface_id, layer_id, x, y, w, h);
+}
+
+char const *App::activate_surface(uint32_t surface_id) {
+   if (!this->controller->surface_exists(surface_id)) {
+      return "Surface does not exist";
+   }
+
+   // This should involve a policy check, but as we do not (yet) have
+   // such a thing, we will just switch to this surface.
+   // XXX: input focus missing!!1
+
+   // Make it visible, no (or little effect) if already visible
+   auto &s = this->controller->surfaces[surface_id];
+
+   // Set all others invisible
+   for (auto &i : this->controller->surfaces) {
+      auto &si = this->controller->sprops[i.second->id];
+      if (si.visibility == 1 && si.id != s->id &&
+          int(si.id) != this->layers.main_surface) {
+         i.second->set_visibility(0);
+      }
+   }
+   s->set_visibility(1);
+
+   // commit changes
+   this->controller->commit_changes();
+   this->display->flush();
+
+   // Current active surface is the first in last_active
+   this->last_active.push_front(s->id);
+   /// // XXX: I am not sure I even need 5 elements...
+   /// this->last_active.resize(std::min(int(this->last_active.size()), 5));
+
+   // no error
+   return nullptr;
+}
+
+char const *App::deactivate_surface(uint32_t surface_id) {
+   if (surface_id == this->layers.main_surface) {
+      return "Cannot deactivate main_surface";
+   }
+
+   if (this->last_active.empty()) {
+      return "Cannot deactivate surface (not active)";
+   }
+
+   // XXX: should an active surface not alsways be front() or
+   // front+1() of last_active?!
+
+   // XXX: Should I really be able to deactivate a surface that is not
+   // front() of last_active?
+   auto is = std::find(this->last_active.begin(),
+                       this->last_active.end(),
+                       surface_id);
+
+   if (is == this->last_active.end()) {
+      return "Cannot deactivate surface (not active)";
+   }
+
+   this->last_active.erase(is);
+
+   if (! this->last_active.empty()) {
+      // Should be active already, shouldn't it?
+      this->activate_surface(this->last_active.front());
+   } else {
+      this->activate_surface(this->layers.main_surface);
+   }
+
+   return nullptr;
+}
+
+void App::add_task(char const *name, std::function<void()> &&f) {
+   this->pending.emplace_back(std::make_pair(name, f));
+}
+
+void App::execute_pending() {
+   if (!this->pending.empty()) {
+      for (auto &t : this->pending) {
+         logdebug("executing task '%s'", t.first);
+         t.second();
+      }
+      this->pending.clear();
+      this->controller->commit_changes();
+      this->display->flush();
+   }
+}
+
 //                      _          _   _____                 _
 //  _ __  _ __ _____  _(_) ___  __| | | ____|_   _____ _ __ | |_ ___
 // | '_ \| '__/ _ \ \/ / |/ _ \/ _` | |  _| \ \ / / _ \ '_ \| __/ __|
@@ -251,45 +418,105 @@ int App::init_layout() {
 // | .__/|_|  \___/_/\_\_|\___|\__,_| |_____| \_/ \___|_| |_|\__|___/
 // |_|
 void App::surface_created(uint32_t surface_id) {
-   DB("surface_id is " << surface_id);
-   int layer_id =
-      this->surface2layer.get_layer_for_surface(surface_id).value_or(-1);
-   if (layer_id == -1) {
-      logerror("Surface %d (0x%x) is not part of any layer!", surface_id,
-               surface_id);
-   } else {
-      auto rect = this->surface2layer.get_rect_for_surface(surface_id).value();
-      this->controller->add_task(
-         "fullscreen surface",
-         [layer_id, surface_id, rect](struct genivi::controller *c) {
-            auto &s = c->surfaces[surface_id];
+   //surface_id >>= id_allocator::id_shift;
+
+   logdebug("surface_id is %u", surface_id);
+
+   // We need to execute the surface setup after its creation.
+   this->add_task("surface_set_layout",
+                  [surface_id, this] { this->surface_set_layout(surface_id); });
+}
+
+void App::surface_removed(uint32_t surface_id) {
+   //surface_id >>= id_allocator::id_shift;
+
+   logdebug("surface_id is %u", surface_id);
+
+   this->add_task("remove surface ID",
+                  [surface_id, this] {
+                     this->id_alloc.remove_id(surface_id);
+
+                     // Also remove from last_active, if found
+                     auto i = std::find(this->last_active.begin(),
+                                        this->last_active.end(), surface_id);
+                     if (i != this->last_active.end()) {
+                        this->last_active.erase(i);
+                     }
+                  });
+}
+
+void App::emit_activated(char const *label) {
+   this->api.send_event("activated", json_object_new_string(label));
+}
 
-            int x = rect.x;
-            int y = rect.y;
-            int w = rect.w;
-            int h = rect.h;
+void App::emit_deactivated(char const *label) {
+   this->api.send_event("deactivated", json_object_new_string(label));
+}
 
-            if (w < 0) {
-               w = c->output_size.w + 1 + w;
-            }
-            if (h < 0) {
-               h = c->output_size.h + 1 + h;
-            }
-            logdebug("Computed rect={ %d, %d, %d, %d }", x, y, w, h);
+void App::emit_syncdraw(char const *label) {
+   this->api.send_event("syncdraw", json_object_new_string(label));
+}
 
-            s->set_configuration(w, h);
-            s->set_source_rectangle(0, 0, w, h);
-            s->set_destination_rectangle(x, y, w, h);
+void App::emit_visible(char const *label, bool is_visible) {
+   this->api.send_event(is_visible ? "visible" : "invisible", json_object_new_string(label));
+}
 
-            s->set_visibility(1);
-            c->layers[layer_id]->add_surface(s.get());
-            logdebug("Surface %u now on layer %u", surface_id, layer_id);
-         });
+result<int> App::request_surface(char const *drawing_name) {
+   auto lid = this->layers.get_layer_id(std::string(drawing_name));
+   if (!lid) {
+      // XXX: to we need to put these applications on the App layer?
+      return Err<int>("Drawing name does not match any role");
    }
+
+   auto rname = this->id_alloc.lookup(drawing_name);
+   if (!rname) {
+      // name does not exist yet, allocate surface id...
+      auto id = int(this->id_alloc.generate_id(drawing_name));
+      this->layers.add_surface(id, lid.value());
+
+      // XXX: you should fix this!
+      if (!this->layers.main_surface_name.empty() &&
+          this->layers.main_surface_name == drawing_name) {
+         this->layers.main_surface = id;
+         this->activate_surface(id);
+         logdebug("Set main_surface id to %u", id);
+      }
+
+      return Ok<int>(id);
+   }
+
+   // Check currently registered drawing names if it is already there.
+   return Err<int>("Surface already present");
 }
 
-void App::surface_removed(uint32_t surface_id) {
-   DB("surface_id is " << surface_id);
+char const *App::activate_surface(char const *drawing_name) {
+   auto osid = this->id_alloc.lookup(drawing_name);
+
+   if (osid) {
+      logdebug("ativate surface with name %s and id %u", drawing_name,
+               osid.value());
+      auto ret = this->activate_surface(osid.value());
+      if (!ret) {
+         this->emit_activated(drawing_name);
+      }
+      return ret;
+   }
+
+   logerror("surface %s unknown", drawing_name);
+   return "Surface unknown";
+}
+
+char const *App::deactivate_surface(char const *drawing_name) {
+   auto osid = this->id_alloc.lookup(drawing_name);
+
+   if (osid) {
+      logdebug("deativate surface with name %s and id %u", drawing_name,
+               osid.value());
+      return this->deactivate_surface(osid.value());
+   }
+
+   logerror("surface %s unknown", drawing_name);
+   return "Surface unknown";
 }
 
 //  _     _           _ _                            _   _                 _
@@ -298,23 +525,48 @@ void App::surface_removed(uint32_t surface_id) {
 // | |_) | | | | | (_| | | | | | (_| |  | (_| | |_) | | | | | | | | | |_) | |
 // |_.__/|_|_| |_|\__,_|_|_| |_|\__, |___\__,_| .__/|_| |_|_| |_| |_| .__/|_|
 //                              |___/_____|   |_|                   |_|
-binding_api::result_type binding_api::register_surface(uint32_t appid,
-                                                       uint32_t surfid) {
-   logdebug("%s appid %u surfid %u", __func__, appid, surfid);
-   if (appid > 0xff) {
-      return Err<json_object *>("invalid appid");
+binding_api::result_type binding_api::request_surface(
+   char const *drawing_name) {
+   auto r = this->app->request_surface(drawing_name);
+   if (r.is_err()) {
+      return Err<json_object *>(r.unwrap_err());
    }
+   return Ok(json_object_new_int(r.unwrap()));
+}
 
-   if (surfid > 0xffff) {
-      return Err<json_object *>("invalid surfaceid");
+binding_api::result_type binding_api::activate_surface(
+   char const *drawing_name) {
+   logdebug("%s drawing_name %s", __func__, drawing_name);
+   auto r = this->app->activate_surface(drawing_name);
+   if (r != nullptr) {
+      return Err<json_object *>(r);
    }
+   return Ok(json_object_new_object());
+}
+
+binding_api::result_type binding_api::deactivate_surface(char const* drawing_name) {
+   logdebug("%s drawing_name %s", __func__, drawing_name);
+   auto r = this->app->deactivate_surface(drawing_name);
+   if (r != nullptr) {
+      return Err<json_object *>(r);
+   }
+   return Ok(json_object_new_object());
+}
 
-   return Ok(json_object_new_int((appid << 16) + surfid));
+binding_api::result_type binding_api::enddraw(char const* drawing_name) {
+   logdebug("%s drawing_name %s", __func__, drawing_name);
+   return Err<json_object*>("not implemented");
+}
+
+binding_api::result_type binding_api::list_drawing_names() {
+   logdebug("%s", __func__);
+   json j = this->app->id_alloc.names;
+   return Ok(json_tokener_parse(j.dump().c_str()));
 }
 
 binding_api::result_type binding_api::debug_layers() {
    logdebug("%s", __func__);
-   return Ok(to_json(this->app->controller->lprops));
+   return Ok(json_tokener_parse(this->app->layers.to_json().dump().c_str()));
 }
 
 binding_api::result_type binding_api::debug_surfaces() {
@@ -338,6 +590,24 @@ binding_api::result_type binding_api::debug_terminate() {
    return Ok(json_object_new_object());
 }
 
+binding_api::result_type binding_api::demo_activate_surface(
+   uint32_t surfaceid) {
+   char const *e = this->app->activate_surface(surfaceid);
+   if (e != nullptr) {
+      return Err<json_object *>(e);
+   }
+   return Ok(json_object_new_object());
+}
+
+binding_api::result_type binding_api::demo_activate_all() {
+   for (auto &s : this->app->controller->surfaces) {
+      s.second->set_visibility(1);
+   }
+   this->app->controller->commit_changes();
+   this->app->display->flush();
+   return Ok(json_object_new_object());
+}
+
 //                  _             _ _            _                 _
 //   ___ ___  _ __ | |_ _ __ ___ | | | ___ _ __ | |__   ___   ___ | | _____
 //  / __/ _ \| '_ \| __| '__/ _ \| | |/ _ \ '__|| '_ \ / _ \ / _ \| |/ / __|
@@ -352,4 +622,8 @@ void controller_hooks::surface_removed(uint32_t surface_id) {
    this->app->surface_removed(surface_id);
 }
 
+void controller_hooks::add_task(char const *name, std::function<void()> &&f) {
+   this->app->add_task(name, std::move(f));
+}
+
 }  // namespace wm