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