src/layers.hpp

   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 #ifndef TMCAGLWM_LAYERS_H
  18 #define TMCAGLWM_LAYERS_H
  19
  20 #include <json.hpp>
  21
  22 #include <regex>
  23 #include <set>
  24 #include <string>
  25
  26 #include "layout.hpp"
  27 #include "result.hpp"
  28 #include "wayland.hpp"
  29
  30 namespace wm {
  31
  32 struct split_layout {
  33    std::string name;
  34    std::string main_match;
  35    std::string sub_match;
  36 };
  37
  38 struct layer {
  39    using json = nlohmann::json;
  40
  41    // A more or less descriptive name?
  42    std::string name = "";
  43    // The actual layer ID
  44    int layer_id = -1;
  45    // The rectangular region surfaces are allowed to draw on
  46    // this layer, note however, width and hieght of the rect
  47    // can be negative, in which case they specify that
  48    // the actual value is computed using MAX + 1 - w
  49    // That is; allow us to specify dimensions dependent on
  50    // e.g. screen dimension, w/o knowing the actual screen size.
  51    genivi::rect rect;
  52    // Specify a role prefix for surfaces that should be
  53    // put on this layer.
  54    std::string role;
  55    // XXX perhaps a zorder is needed here?
  56    std::vector<struct split_layout> layouts;
  57    // XXX need to change the way we store these things...
  58    mutable struct LayoutState state;
  59
  60    explicit layer(nlohmann::json const &j);
  61
  62    json to_json() const;
  63 };
  64
  65 struct layer_map {
  66    using json = nlohmann::json;
  67
  68    using storage_type = std::map<int, struct layer>;
  69    using layers_type = std::vector<uint32_t>;
  70    using role_to_layer_map = std::vector<std::pair<std::string, int>>;
  71    using addsurf_layer_map = std::map<int, int>;
  72
  73    // XXX: we also will need a layer_id to layer map, perhaps
  74    // make this the primary map, and the surface_id->layer a
  75    // secondary map.
  76
  77    storage_type mapping;  // map surface_id to layer
  78    layers_type layers;    // the actual layer IDs we have
  79    int main_surface;
  80    std::string main_surface_name;
  81    role_to_layer_map roles;
  82    addsurf_layer_map surfaces;  // additional surfaces on layers
  83
  84    optional<int> get_layer_id(int surface_id);
  85    optional<int> get_layer_id(std::string const &role);
  86    optional<struct LayoutState*> get_layout_state(int surface_id) {
  87       int layer_id = *this->get_layer_id(surface_id);
  88       auto i = this->mapping.find(layer_id);
  89       return i == this->mapping.end()
  90                 ? nullopt
  91                 : optional<struct LayoutState *>(&i->second.state);
  92    }
  93    optional<struct layer> get_layer(int layer_id) {
  94       auto i = this->mapping.find(layer_id);
  95       return i == this->mapping.end() ? nullopt
  96                                       : optional<struct layer>(i->second);
  97    }
  98
  99    layers_type::size_type get_layers_count() const {
 100       return this->layers.size();
 101    }
 102
 103    void add_surface(int surface_id, int layer_id) {
 104       this->surfaces[surface_id] = layer_id;
 105    }
 106
 107    void remove_surface(int surface_id) {
 108       this->surfaces.erase(surface_id);
 109    }
 110
 111    json to_json() const;
 112 };
 113
 114 struct result<struct layer_map> to_layer_map(nlohmann::json const &j);
 115
 116 }  // namespace wm
 117
 118 #endif  // TMCAGLWM_LAYERS_H