2 * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef WINDOW_MANAGER_HPP
18 #define WINDOW_MANAGER_HPP
22 #include <unordered_map>
23 #include <experimental/optional>
24 #include "controller_hooks.hpp"
27 #include "wayland_ivi_wm.hpp"
28 #include "hmi-debug.h"
29 #include "request.hpp"
30 #include "wm_error.hpp"
47 using std::experimental::optional;
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[];
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[];
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;
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;
83 // Insert and return a new ID
84 unsigned generate_id(std::string const &name)
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());
93 // Insert a new ID which defined outside
94 void register_name_id(std::string const &name, unsigned sid)
96 this->id2name[sid] = name;
97 this->name2id[name] = sid;
98 HMI_DEBUG("wm", "register id %u with name %s", sid, name.c_str());
102 // Lookup by ID or by name
103 optional<unsigned> lookup(std::string const &name) const
105 auto i = this->name2id.find(name);
106 return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
109 optional<std::string> lookup(unsigned id) const
111 auto i = this->id2name.find(id);
112 return i == this->id2name.end() ? nullopt
113 : optional<std::string>(i->second);
116 // Remove a surface id and name
117 void remove_id(std::string const &name)
119 auto i = this->name2id.find(name);
120 if (i != this->name2id.end())
122 this->id2name.erase(i->second);
123 this->name2id.erase(i);
127 void remove_id(unsigned id)
129 auto i = this->id2name.find(id);
130 if (i != this->id2name.end())
132 this->name2id.erase(i->second);
133 this->id2name.erase(i);
141 typedef std::unordered_map<uint32_t, struct compositor::rect> rect_map;
142 typedef std::function<void(const char *err_msg)> reply_func;
148 Event_Active = Event_Val_Min,
161 Event_Val_Max = Event_Error,
164 const std::vector<const char *> kListEventName{
174 struct controller_hooks chooks;
176 // This is the one thing, we do not own.
177 struct wl::display *display;
179 std::unique_ptr<struct compositor::controller> controller;
180 std::vector<std::unique_ptr<struct wl::output>> outputs;
182 // track current layouts separately
185 // ID allocation and proxy methods for lookup
186 struct id_allocator id_alloc;
188 // Set by AFB API when wayland events need to be dispatched
189 std::atomic<bool> pending_events;
191 std::map<const char *, struct afb_event> map_afb_event;
193 // Surface are info (x, y, w, h)
197 std::vector<int> surface_bg;
199 explicit WindowManager(wl::display *d);
200 ~WindowManager() = default;
202 WindowManager(WindowManager const &) = delete;
203 WindowManager &operator=(WindowManager const &) = delete;
204 WindowManager(WindowManager &&) = delete;
205 WindowManager &operator=(WindowManager &&) = delete;
208 int dispatch_pending_events();
209 void set_pending_events();
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 bool api_set_role(char const *appid, char const *role, unsigned pid);
214 void api_activate_surface(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
215 void api_deactivate_surface(char const *appid, char const *role, const reply_func &reply);
216 void api_enddraw(char const *appid, char const *role);
217 result<json_object *> api_get_display_info();
218 result<json_object *> api_get_area_info(char const *role);
220 void send_event(char const *evname, char const *label);
221 void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h);
223 // Events from the compositor we are interested in
224 void surface_created(uint32_t surface_id);
225 void surface_removed(uint32_t surface_id);
226 void surface_properties(uint32_t surface_id, uint32_t pid);
228 void removeClient(const std::string &appid);
229 void exceptionProcessForTransition();
230 const char* convertRoleOldToNew(char const *role);
231 // Do not use this function
235 bool pop_pending_events();
236 optional<int> lookup_id(char const *name);
237 optional<std::string> lookup_name(int id);
239 void surface_set_layout(int surface_id, const std::string& area = "");
240 void layout_commit();
242 // WM Events to clients
243 void emit_activated(char const *label);
244 void emit_deactivated(char const *label);
245 void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h);
246 void emit_syncdraw(const std::string &role, const std::string &area);
247 void emit_flushdraw(char const *label);
248 void emit_visible(char const *label, bool is_visible);
249 void emit_invisible(char const *label);
250 void emit_visible(char const *label);
252 void activate(int id);
253 void deactivate(int id);
254 WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
255 Task task, unsigned *req_num);
256 WMError doTransition(unsigned sequence_number);
257 WMError checkPolicy(unsigned req_num);
258 WMError startTransition(unsigned req_num);
259 WMError setInvisibleTask(const std::string &role, bool split);
261 WMError doEndDraw(unsigned req_num);
262 WMError layoutChange(const WMAction &action);
263 WMError visibilityChange(const WMAction &action);
264 WMError setSurfaceSize(unsigned surface, const std::string& area);
265 WMError changeCurrentState(unsigned req_num);
266 void emitScreenUpdated(unsigned req_num);
270 void processNextRequest();
274 const char *check_surface_exist(const char *role);
276 bool can_split(struct LayoutState const &state, int new_id);
279 std::unordered_map<std::string, struct compositor::rect> area2size;
280 std::unordered_map<std::string, std::string> roleold2new;
281 std::unordered_map<std::string, std::string> rolenew2old;
283 static const char* kDefaultOldRoleDb;
288 #endif // WINDOW_MANAGER_HPP