Implement surface names

[staging/windowmanager.git] / src / layers.hpp

diff --git a/src/layers.hpp b/src/layers.hpp
index a827928..ae609fc 100644 (file)
--- a/src/layers.hpp
+++ b/src/layers.hpp
@@ -1,6 +1,18 @@
-//
-// Created by m on 7/27/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.
+ */
 
 #ifndef TMCAGLWM_LAYERS_H
 #define TMCAGLWM_LAYERS_H
@@ -9,43 +21,85 @@
 #include <set>
 #include <string>
 
-#include "wayland.hpp"
 #include "result.hpp"
+#include "wayland.hpp"
 
 namespace wm {
 
-struct surface_id_to_layer {
+struct layer {
+   using json = nlohmann::json;
+
+   // Min and max surface ID mapped to this layer
    int id_min = -1;
    int id_max = -1;
+   // A more or less descriptive name?
    std::string name = "";
+   // The actual layer ID
    int layer_id = -1;
+   // The rectangular region surfaces are allowed to draw on
+   // this layer, note however, width and hieght of the rect
+   // can be negative, in which case they specify that
+   // the actual value is computed using MAX + 1 - w
+   // That is; allow us to specify dimensions dependent on
+   // e.g. screen dimension, w/o knowing the actual screen size.
    genivi::rect rect;
+   // Specify a role prefix for surfaces that should be
+   // put on this layer.
+   std::string role;
+   // XXX perhaps a zorder is needed here?
 
-   explicit surface_id_to_layer(nlohmann::json const &j);
+   explicit layer(nlohmann::json const &j);
 
-   bool operator<(struct surface_id_to_layer const &rhs) const {
+   bool operator<(struct layer const &rhs) const {
       return this->id_max < rhs.id_max;
    }
+
+   json to_json() const;
 };
 
-// Actually, we shouldn't need a struct here ... but let's just keep it at that
-// for now, to contain its mapping type and the _single_ useful method.
-struct surface_id_to_layer_map {
-   typedef std::set<struct surface_id_to_layer> surface_to_layer_map_type;
+struct layer_map {
+   using json = nlohmann::json;
+
+   typedef std::set<struct layer> storage_type;
    typedef std::vector<unsigned int> layers_type;
+   typedef std::vector<std::pair<std::string, int>> role_to_layer_map;
+   typedef std::map<unsigned, unsigned> addsurf_layer_map;
+
+   // XXX: we also will need a layer_id to layer map, perhaps
+   // make this the primary map, and the surface_id->layer a
+   // secondary map.
 
-   surface_to_layer_map_type mapping;
-   layers_type layers;
+   storage_type mapping; // map surface_id to layer
+   layers_type layers; // the actual layer IDs we have
+   int main_surface;
+   std::string main_surface_name;
+   role_to_layer_map roles;
+   addsurf_layer_map surfaces; // additional surfaces on layers
 
-   optional<int> get_layer_for_surface(int surface_id);
-   optional<genivi::rect> get_rect_for_surface(int surface_id);
+   optional<int> get_layer_id(int surface_id);
+   optional<int> get_layer_id(std::string const &role);
+   optional<struct layer> get_layer(int layer_id) {
+      auto i = std::find_if(std::cbegin(this->mapping),
+                            std::cend(this->mapping),
+                            [layer_id](struct layer const &l) {
+                               return layer_id == l.layer_id;
+                            });
+      return i == this->mapping.end() ? nullopt : optional<struct layer>(*i);
+   }
+
+   optional<genivi::rect> get_layer_rect(int surface_id);
    layers_type::size_type get_layers_count() const {
       return this->layers.size();
    }
+
+   void add_surface(unsigned surface_id, unsigned layer_id) {
+      this->surfaces[surface_id] = layer_id;
+   }
+
+   json to_json() const;
 };
 
-struct result<struct surface_id_to_layer_map> to_surface_id_to_layer_map(
-   nlohmann::json const &j);
+struct result<struct layer_map> to_layer_map(nlohmann::json const &j);
 
 }  // namespace wm