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 "controller_hooks.hpp"
  25 #include "layers.hpp"
  26 #include "layout.hpp"
  27 #include "wayland_ivi_wm.hpp"
  28 #include "hmi-debug.h"
  29 #include "request.hpp"
  30 #include "wm_error.hpp"
  31
  32 struct json_object;
  33
  34 namespace wl
  35 {
  36 struct display;
  37 }
  38
  39 namespace compositor
  40 {
  41 struct controller;
  42 }
  43
  44 namespace wm
  45 {
  46
  47 using std::experimental::optional;
  48
  49 /* DrawingArea name used by "{layout}.{area}" */
  50 extern const char kNameLayoutNormal[];
  51 extern const char kNameLayoutSplit[];
  52 extern const char kNameAreaFull[];
  53 extern const char kNameAreaMain[];
  54 extern const char kNameAreaSub[];
  55
  56 /* Key for json obejct */
  57 extern const char kKeyDrawingName[];
  58 extern const char kKeyDrawingArea[];
  59 extern const char kKeyDrawingRect[];
  60 extern const char kKeyX[];
  61 extern const char kKeyY[];
  62 extern const char kKeyWidth[];
  63 extern const char kKeyHeigh[];
  64 extern const char kKeyWidthPixel[];
  65 extern const char kKeyHeightPixel[];
  66 extern const char kKeyWidthMm[];
  67 extern const char kKeyHeightMm[];
  68 extern const char kKeyIds[];
  69
  70 struct id_allocator
  71 {
  72     unsigned next = 1;
  73
  74     // Surfaces that where requested but not yet created
  75     std::unordered_map<unsigned, std::string> id2name;
  76     std::unordered_map<std::string, unsigned> name2id;
  77
  78     id_allocator(id_allocator const &) = delete;
  79     id_allocator(id_allocator &&) = delete;
  80     id_allocator &operator=(id_allocator const &);
  81     id_allocator &operator=(id_allocator &&) = delete;
  82
  83     // Insert and return a new ID
  84     unsigned generate_id(std::string const &name)
  85     {
  86         unsigned sid = this->next++;
  87         this->id2name[sid] = name;
  88         this->name2id[name] = sid;
  89         HMI_DEBUG("wm", "allocated new id %u with name %s", sid, name.c_str());
  90         return sid;
  91     }
  92
  93     // Insert a new ID which defined outside
  94     void register_name_id(std::string const &name, unsigned sid)
  95     {
  96         this->id2name[sid] = name;
  97         this->name2id[name] = sid;
  98         HMI_DEBUG("wm", "register id %u with name %s", sid, name.c_str());
  99         return;
 100     }
 101
 102     // Lookup by ID or by name
 103     optional<unsigned> lookup(std::string const &name) const
 104     {
 105         auto i = this->name2id.find(name);
 106         return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
 107     }
 108
 109     optional<std::string> lookup(unsigned id) const
 110     {
 111         auto i = this->id2name.find(id);
 112         return i == this->id2name.end() ? nullopt
 113                                         : optional<std::string>(i->second);
 114     }
 115
 116     // Remove a surface id and name
 117     void remove_id(std::string const &name)
 118     {
 119         auto i = this->name2id.find(name);
 120         if (i != this->name2id.end())
 121         {
 122             this->id2name.erase(i->second);
 123             this->name2id.erase(i);
 124         }
 125     }
 126
 127     void remove_id(unsigned id)
 128     {
 129         auto i = this->id2name.find(id);
 130         if (i != this->id2name.end())
 131         {
 132             this->name2id.erase(i->second);
 133             this->id2name.erase(i);
 134         }
 135     }
 136 };
 137
 138 class WindowManager
 139 {
 140   public:
 141     typedef std::unordered_map<uint32_t, struct compositor::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     const std::vector<const char *> kListEventName{
 165         "active",
 166         "inactive",
 167         "visible",
 168         "invisible",
 169         "syncDraw",
 170         "flushDraw",
 171         "screenUpdated",
 172         "error"};
 173
 174     struct controller_hooks chooks;
 175
 176     // This is the one thing, we do not own.
 177     struct wl::display *display;
 178
 179     std::unique_ptr<struct compositor::controller> controller;
 180     std::vector<std::unique_ptr<struct wl::output>> outputs;
 181
 182     // track current layouts separately
 183     layer_map layers;
 184
 185     // ID allocation and proxy methods for lookup
 186     struct id_allocator id_alloc;
 187
 188     // Set by AFB API when wayland events need to be dispatched
 189     std::atomic<bool> pending_events;
 190
 191     std::map<const char *, struct afb_event> map_afb_event;
 192
 193     // Surface are info (x, y, w, h)
 194     rect_map area_info;
 195
 196     // FOR CES DEMO
 197     std::vector<int> surface_bg;
 198
 199     explicit WindowManager(wl::display *d);
 200     ~WindowManager() = default;
 201
 202     WindowManager(WindowManager const &) = delete;
 203     WindowManager &operator=(WindowManager const &) = delete;
 204     WindowManager(WindowManager &&) = delete;
 205     WindowManager &operator=(WindowManager &&) = delete;
 206
 207     int init();
 208     int dispatch_pending_events();
 209     void set_pending_events();
 210
 211     result<int> api_request_surface(char const *appid, char const *role);
 212     char const *api_request_surface(char const *appid, char const *role, char const *ivi_id);
 213     void api_activate_surface(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
 214     void api_deactivate_surface(char const *appid, char const *role, const reply_func &reply);
 215     void api_enddraw(char const *appid, char const *role);
 216     result<json_object *> api_get_display_info();
 217     result<json_object *> api_get_area_info(char const *role);
 218     void api_ping();
 219     void send_event(char const *evname, char const *label);
 220     void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h);
 221
 222     // Events from the compositor we are interested in
 223     void surface_created(uint32_t surface_id);
 224     void surface_removed(uint32_t surface_id);
 225
 226     void removeClient(const std::string &appid);
 227     void exceptionProcessForTransition();
 228     const char* convertRoleOldToNew(char const *role);
 229     // Do not use this function
 230     void timerHandler();
 231
 232   private:
 233     bool pop_pending_events();
 234     optional<int> lookup_id(char const *name);
 235     optional<std::string> lookup_name(int id);
 236     int init_layers();
 237     void surface_set_layout(int surface_id, const std::string& area = "");
 238     void layout_commit();
 239
 240     // WM Events to clients
 241     void emit_activated(char const *label);
 242     void emit_deactivated(char const *label);
 243     void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h);
 244     void emit_syncdraw(const std::string &role, const std::string &area);
 245     void emit_flushdraw(char const *label);
 246     void emit_visible(char const *label, bool is_visible);
 247     void emit_invisible(char const *label);
 248     void emit_visible(char const *label);
 249
 250     void activate(int id);
 251     void deactivate(int id);
 252     WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
 253                              Task task, unsigned *req_num);
 254     WMError doTransition(unsigned sequence_number);
 255     WMError checkPolicy(unsigned req_num);
 256     WMError startTransition(unsigned req_num);
 257     WMError setInvisibleTask(const std::string &role, bool split);
 258
 259     WMError doEndDraw(unsigned req_num);
 260     WMError layoutChange(const WMAction &action);
 261     WMError visibilityChange(const WMAction &action);
 262     WMError setSurfaceSize(unsigned surface, const std::string& area);
 263     WMError changeCurrentState(unsigned req_num);
 264     void    emitScreenUpdated(unsigned req_num);
 265
 266     void setTimer();
 267     void stopTimer();
 268     void processNextRequest();
 269
 270     int loadOldRoleDb();
 271
 272     const char *check_surface_exist(const char *role);
 273
 274     bool can_split(struct LayoutState const &state, int new_id);
 275
 276   private:
 277     std::unordered_map<std::string, struct compositor::rect> area2size;
 278     std::unordered_map<std::string, std::string> roleold2new;
 279     std::unordered_map<std::string, std::string> rolenew2old;
 280
 281     static const char* kDefaultOldRoleDb;
 282 };
 283
 284 } // namespace wm
 285
 286 #endif // WINDOW_MANAGER_HPP