src/layers.hpp

   1 /*
   2  * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
   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    compositor::rect rect;
  52    // Specify a role prefix for surfaces that should be
  53    // put on this layer.
  54    std::string role;
  55    // TODO: perhaps a zorder is needed here?
  56    std::vector<struct split_layout> layouts;
  57
  58    mutable struct LayoutState state;
  59
  60   // Flag of normal layout only
  61    bool is_normal_layout_only;
  62
  63    explicit layer(nlohmann::json const &j);
  64
  65    json to_json() const;
  66 };
  67
  68 struct layer_map {
  69    using json = nlohmann::json;
  70
  71    using storage_type = std::map<int, struct layer>;
  72    using layers_type = std::vector<uint32_t>;
  73    using role_to_layer_map = std::vector<std::pair<std::string, int>>;
  74    using addsurf_layer_map = std::map<int, int>;
  75
  76    storage_type mapping;  // map surface_id to layer
  77    layers_type layers;    // the actual layer IDs we have
  78    int main_surface;
  79    std::string main_surface_name;
  80    int main_surface_width;
  81    int main_surface_height;
  82    bool scaling_keep_aspect = true;
  83    role_to_layer_map roles;
  84    addsurf_layer_map surfaces;  // additional surfaces on layers
  85
  86    optional<int> get_layer_id(int surface_id);
  87    optional<int> get_layer_id(std::string const &role);
  88    optional<struct LayoutState*> get_layout_state(int surface_id) {
  89       int layer_id = *this->get_layer_id(surface_id);
  90       auto i = this->mapping.find(layer_id);
  91       return i == this->mapping.end()
  92                 ? nullopt
  93                 : optional<struct LayoutState *>(&i->second.state);
  94    }
  95    optional<struct layer> get_layer(int layer_id) {
  96       auto i = this->mapping.find(layer_id);
  97       return i == this->mapping.end() ? nullopt
  98                                       : optional<struct layer>(i->second);
  99    }
 100
 101    layers_type::size_type get_layers_count() const {
 102       return this->layers.size();
 103    }
 104
 105    void add_surface(int surface_id, int layer_id) {
 106       this->surfaces[surface_id] = layer_id;
 107    }
 108
 109    void remove_surface(int surface_id) {
 110       this->surfaces.erase(surface_id);
 111    }
 112
 113    json to_json() const;
 114 };
 115
 116 struct result<struct layer_map> to_layer_map(nlohmann::json const &j);
 117
 118 static const nlohmann::json default_layers_json = {
 119    {"main_surface", {
 120       {"surface_role", "HomeScreen"}
 121    }},
 122    {"mappings", {
 123       {
 124          {"role", "^HomeScreen$"},
 125          {"name", "HomeScreen"},
 126          {"layer_id", 1000},
 127          {"area", {
 128             {"type", "full"}
 129          }}
 130       },
 131       {
 132          {"role", "MediaPlayer|Radio|Phone|Navigation|HVAC|Settings|Dashboard|POI|Mixer"},
 133          {"name", "apps"},
 134          {"layer_id", 1001},
 135          {"area", {
 136             {"type", "rect"},
 137             {"rect", {
 138                {"x", 0},
 139                {"y", 218},
 140                {"width", -1},
 141                {"height", -433}
 142             }}
 143          }}
 144       },
 145       {
 146          {"role", "^OnScreen.*"},
 147          {"name", "popups"},
 148          {"layer_id", 9999},
 149          {"area", {
 150             {"type", "rect"},
 151             {"rect", {
 152                {"x", 0},
 153                {"y", 760},
 154                {"width", -1},
 155                {"height", 400}
 156             }}
 157          }}
 158       }
 159    }}
 160 };
 161 }  // namespace wm
 162
 163 #endif  // TMCAGLWM_LAYERS_H