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>
25 #include "pm_wrapper.hpp"
27 #include "request.hpp"
28 #include "wm_error.hpp"
29 #include "wm_layer_control.hpp"
32 #include <afb/afb-binding.h>
35 #include "activity_manager.hpp"
42 using std::experimental::optional;
44 /* DrawingArea name used by "{layout}.{area}" */
45 extern const char kNameLayoutNormal[];
46 extern const char kNameLayoutSplit[];
47 extern const char kNameAreaFull[];
48 extern const char kNameAreaMain[];
49 extern const char kNameAreaSub[];
51 /* Key for json obejct */
52 extern const char kKeyDrawingName[];
53 extern const char kKeyDrawingArea[];
54 extern const char kKeyDrawingRect[];
55 extern const char kKeyX[];
56 extern const char kKeyY[];
57 extern const char kKeyWidth[];
58 extern const char kKeyHeigh[];
59 extern const char kKeyWidthPixel[];
60 extern const char kKeyHeightPixel[];
61 extern const char kKeyWidthMm[];
62 extern const char kKeyHeightMm[];
63 extern const char kKeyScale[];
64 extern const char kKeyIds[];
69 // Surfaces that where requested but not yet created
70 std::unordered_map<unsigned, std::string> id2name;
71 std::unordered_map<std::string, unsigned> name2id;
73 id_allocator(id_allocator const &) = delete;
74 id_allocator(id_allocator &&) = delete;
75 id_allocator &operator=(id_allocator const &);
76 id_allocator &operator=(id_allocator &&) = delete;
78 // Insert and return a new ID
79 unsigned generate_id(std::string const &name)
81 unsigned sid = this->next++;
82 this->id2name[sid] = name;
83 this->name2id[name] = sid;
84 HMI_DEBUG("allocated new id %u with name %s", sid, name.c_str());
88 // Insert a new ID which defined outside
89 void register_name_id(std::string const &name, unsigned sid)
91 this->id2name[sid] = name;
92 this->name2id[name] = sid;
93 HMI_DEBUG("register id %u with name %s", sid, name.c_str());
97 // Lookup by ID or by name
98 optional<unsigned> lookup(std::string const &name) const
100 auto i = this->name2id.find(name);
101 return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
104 optional<std::string> lookup(unsigned id) const
106 auto i = this->id2name.find(id);
107 return i == this->id2name.end() ? nullopt
108 : optional<std::string>(i->second);
111 // Remove a surface id and name
112 void remove_id(std::string const &name)
114 auto i = this->name2id.find(name);
115 if (i != this->name2id.end())
117 this->id2name.erase(i->second);
118 this->name2id.erase(i);
122 void remove_id(unsigned id)
124 auto i = this->id2name.find(id);
125 if (i != this->id2name.end())
127 this->name2id.erase(i->second);
128 this->id2name.erase(i);
143 typedef std::unordered_map<uint32_t, struct rect> rect_map;
144 typedef std::function<void(const char *err_msg)> reply_func;
150 Event_Active = Event_Val_Min,
163 Event_Val_Max = Event_Error,
166 explicit WindowManager();
167 ~WindowManager() = default;
169 WindowManager(WindowManager const &) = delete;
170 WindowManager &operator=(WindowManager const &) = delete;
171 WindowManager(WindowManager &&) = delete;
172 WindowManager &operator=(WindowManager &&) = delete;
176 result<int> api_request_surface(char const *appid, char const *role);
177 char const *api_request_surface(char const *appid, char const *role, char const *ivi_id);
178 void api_activate_window(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
179 void api_deactivate_window(char const *appid, char const *role, const reply_func &reply);
180 void api_enddraw(char const *appid, char const *role);
181 int api_subscribe(afb_req_t req, int event_id);
183 result<json_object *> api_get_display_info();
184 result<json_object *> api_get_area_info(char const *role);
186 void send_event(const std::string& evname, const std::string& role);
187 void send_event(const std::string& evname, const std::string& role, const std::string& area, int x, int y, int w, int h);
189 // Events from the compositor we are interested in
190 void surface_created(unsigned surface_id);
191 void surface_removed(unsigned surface_id);
193 void removeClient(const std::string &appid);
194 void exceptionProcessForTransition();
196 // Do not use this function
198 void startTransitionWrapper(std::vector<WMAction> &actions);
199 void processError(WMError error);
202 // AGL Lifecycle Management API
203 lcm::ActivityManager amgr;
206 // WM Events to clients
207 void emit_activated(const std::string& role);
208 void emit_deactivated(const std::string& role);
209 void emit_syncdraw(const std::string& role, char const *area, int x, int y, int w, int h);
210 void emit_syncdraw(const std::string &role, const std::string &area);
211 void emit_flushdraw(const std::string& role);
212 void emit_visible(const std::string& role, bool is_visible);
213 void emit_invisible(const std::string& role);
214 void emit_visible(const std::string& role);
216 WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
217 Task task, unsigned *req_num);
218 WMError checkPolicy(unsigned req_num);
219 WMError startTransition(unsigned req_num);
221 WMError doEndDraw(unsigned req_num);
222 void emitScreenUpdated(unsigned req_num);
226 void processNextRequest();
229 std::map<std::string, afb_event_t> map_afb_event;
230 std::unordered_map<std::string, struct rect> area2size;
231 std::shared_ptr<LayerControl> lc;
234 struct id_allocator id_alloc;
236 // ID allocation and proxy methods for lookup
237 std::unordered_map<unsigned, struct TmpClient> tmp_surface2app;
242 #endif // WINDOW_MANAGER_HPP