src/window_manager.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 WINDOW_MANAGER_HPP
  18 #define WINDOW_MANAGER_HPP
  19
  20 #include <atomic>
  21 #include <memory>
  22 #include <unordered_map>
  23 #include <experimental/optional>
  24 #include "result.hpp"
  25 #include "pm_wrapper.hpp"
  26 #include "util.hpp"
  27 #include "request.hpp"
  28 #include "wm_error.hpp"
  29 #include "wm_layer_control.hpp"
  30 extern "C"
  31 {
  32 #include <afb/afb-binding.h>
  33 }
  34
  35 struct json_object;
  36
  37 namespace wm
  38 {
  39
  40 using std::experimental::optional;
  41
  42 /* DrawingArea name used by "{layout}.{area}" */
  43 extern const char kNameLayoutNormal[];
  44 extern const char kNameLayoutSplit[];
  45 extern const char kNameAreaFull[];
  46 extern const char kNameAreaMain[];
  47 extern const char kNameAreaSub[];
  48
  49 /* Key for json obejct */
  50 extern const char kKeyDrawingName[];
  51 extern const char kKeyDrawingArea[];
  52 extern const char kKeyDrawingRect[];
  53 extern const char kKeyX[];
  54 extern const char kKeyY[];
  55 extern const char kKeyWidth[];
  56 extern const char kKeyHeigh[];
  57 extern const char kKeyWidthPixel[];
  58 extern const char kKeyHeightPixel[];
  59 extern const char kKeyWidthMm[];
  60 extern const char kKeyHeightMm[];
  61 extern const char kKeyScale[];
  62 extern const char kKeyIds[];
  63
  64 struct id_allocator
  65 {
  66     unsigned next = 1;
  67
  68     // Surfaces that where requested but not yet created
  69     std::unordered_map<unsigned, std::string> id2name;
  70     std::unordered_map<std::string, unsigned> name2id;
  71
  72     id_allocator(id_allocator const &) = delete;
  73     id_allocator(id_allocator &&) = delete;
  74     id_allocator &operator=(id_allocator const &);
  75     id_allocator &operator=(id_allocator &&) = delete;
  76
  77     // Insert and return a new ID
  78     unsigned generate_id(std::string const &name)
  79     {
  80         unsigned sid = this->next++;
  81         this->id2name[sid] = name;
  82         this->name2id[name] = sid;
  83         HMI_DEBUG("allocated new id %u with name %s", sid, name.c_str());
  84         return sid;
  85     }
  86
  87     // Insert a new ID which defined outside
  88     void register_name_id(std::string const &name, unsigned sid)
  89     {
  90         this->id2name[sid] = name;
  91         this->name2id[name] = sid;
  92         HMI_DEBUG("register id %u with name %s", sid, name.c_str());
  93         return;
  94     }
  95
  96     // Lookup by ID or by name
  97     optional<unsigned> lookup(std::string const &name) const
  98     {
  99         auto i = this->name2id.find(name);
 100         return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
 101     }
 102
 103     optional<std::string> lookup(unsigned id) const
 104     {
 105         auto i = this->id2name.find(id);
 106         return i == this->id2name.end() ? nullopt
 107                                         : optional<std::string>(i->second);
 108     }
 109
 110     // Remove a surface id and name
 111     void remove_id(std::string const &name)
 112     {
 113         auto i = this->name2id.find(name);
 114         if (i != this->name2id.end())
 115         {
 116             this->id2name.erase(i->second);
 117             this->name2id.erase(i);
 118         }
 119     }
 120
 121     void remove_id(unsigned id)
 122     {
 123         auto i = this->id2name.find(id);
 124         if (i != this->id2name.end())
 125         {
 126             this->name2id.erase(i->second);
 127             this->id2name.erase(i);
 128         }
 129     }
 130 };
 131
 132 struct TmpClient
 133 {
 134     std::string   appid;
 135     unsigned pid;
 136 };
 137
 138 class WindowManager
 139 {
 140   public:
 141     typedef std::unordered_map<uint32_t, struct rect> rect_map;
 142     typedef std::function<void(const char *err_msg)> reply_func;
 143
 144     enum EventType
 145     {
 146         Event_Val_Min = 0,
 147
 148         Event_Active = Event_Val_Min,
 149         Event_Inactive,
 150
 151         Event_Visible,
 152         Event_Invisible,
 153
 154         Event_SyncDraw,
 155         Event_FlushDraw,
 156
 157         Event_ScreenUpdated,
 158
 159         Event_Error,
 160
 161         Event_Val_Max = Event_Error,
 162     };
 163
 164     explicit WindowManager();
 165     ~WindowManager() = default;
 166
 167     WindowManager(WindowManager const &) = delete;
 168     WindowManager &operator=(WindowManager const &) = delete;
 169     WindowManager(WindowManager &&) = delete;
 170     WindowManager &operator=(WindowManager &&) = delete;
 171
 172     int init();
 173
 174     result<int> api_request_surface(char const *appid, char const *role);
 175     char const *api_request_surface(char const *appid, char const *role, char const *ivi_id);
 176     bool api_set_role(char const *appid, char const *role, unsigned pid);
 177     void api_activate_surface(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
 178     void api_deactivate_surface(char const *appid, char const *role, const reply_func &reply);
 179     void api_enddraw(char const *appid, char const *role);
 180     result<json_object *> api_get_display_info();
 181     result<json_object *> api_get_area_info(char const *role);
 182     void send_event(char const *evname, char const *label);
 183     void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h);
 184
 185     // Events from the compositor we are interested in
 186     void surface_created(unsigned pid, unsigned surface_id);
 187     void surface_removed(unsigned surface_id);
 188
 189     void removeClient(const std::string &appid);
 190     void exceptionProcessForTransition();
 191     const char* convertRoleOldToNew(char const *role);
 192
 193     // Do not use this function
 194     void timerHandler();
 195     void startTransitionWrapper(std::vector<WMAction> &actions);
 196     void processError(WMError error);
 197
 198     const std::vector<const char *> kListEventName{
 199         "active",
 200         "inactive",
 201         "visible",
 202         "invisible",
 203         "syncDraw",
 204         "flushDraw",
 205         "screenUpdated",
 206         "error"};
 207     std::map<const char *, struct afb_event> map_afb_event;
 208
 209   private:
 210     // WM Events to clients
 211     void emit_activated(char const *label);
 212     void emit_deactivated(char const *label);
 213     void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h);
 214     void emit_syncdraw(const std::string &role, const std::string &area);
 215     void emit_flushdraw(char const *label);
 216     void emit_visible(char const *label, bool is_visible);
 217     void emit_invisible(char const *label);
 218     void emit_visible(char const *label);
 219
 220     void activate(int id);
 221     void deactivate(int id);
 222     WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
 223                              Task task, unsigned *req_num);
 224     WMError checkPolicy(unsigned req_num);
 225     WMError startTransition(unsigned req_num);
 226
 227     WMError doEndDraw(unsigned req_num);
 228     void    emitScreenUpdated(unsigned req_num);
 229
 230     void setTimer();
 231     void stopTimer();
 232     void processNextRequest();
 233
 234     int loadOldRoleDb();
 235
 236     const char *check_surface_exist(const char *role);
 237
 238   private:
 239     std::unordered_map<std::string, std::string> roleold2new;
 240     std::unordered_map<std::string, std::string> rolenew2old;
 241     std::shared_ptr<LayerControl> lc;
 242     PMWrapper pmw;
 243
 244     // ID allocation and proxy methods for lookup
 245     struct id_allocator id_alloc;
 246     // Surface are info (x, y, w, h)
 247     rect_map area_info;
 248     // FOR CES DEMO
 249     std::unordered_map<unsigned, struct TmpClient> tmp_surface2app;
 250     std::vector<struct TmpClient> tmp_apps;
 251     static const char* kDefaultOldRoleDb;
 252 };
 253
 254 } // namespace wm
 255
 256 #endif // WINDOW_MANAGER_HPP