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>
40 using std::experimental::optional;
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[];
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[];
67 // Surfaces that where requested but not yet created
68 std::unordered_map<unsigned, std::string> id2name;
69 std::unordered_map<std::string, unsigned> name2id;
71 id_allocator(id_allocator const &) = delete;
72 id_allocator(id_allocator &&) = delete;
73 id_allocator &operator=(id_allocator const &);
74 id_allocator &operator=(id_allocator &&) = delete;
76 // Insert and return a new ID
77 unsigned generate_id(std::string const &name)
79 unsigned sid = this->next++;
80 this->id2name[sid] = name;
81 this->name2id[name] = sid;
82 HMI_DEBUG("allocated new id %u with name %s", sid, name.c_str());
86 // Insert a new ID which defined outside
87 void register_name_id(std::string const &name, unsigned sid)
89 this->id2name[sid] = name;
90 this->name2id[name] = sid;
91 HMI_DEBUG("register id %u with name %s", sid, name.c_str());
95 // Lookup by ID or by name
96 optional<unsigned> lookup(std::string const &name) const
98 auto i = this->name2id.find(name);
99 return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
102 optional<std::string> lookup(unsigned id) const
104 auto i = this->id2name.find(id);
105 return i == this->id2name.end() ? nullopt
106 : optional<std::string>(i->second);
109 // Remove a surface id and name
110 void remove_id(std::string const &name)
112 auto i = this->name2id.find(name);
113 if (i != this->name2id.end())
115 this->id2name.erase(i->second);
116 this->name2id.erase(i);
120 void remove_id(unsigned id)
122 auto i = this->id2name.find(id);
123 if (i != this->id2name.end())
125 this->name2id.erase(i->second);
126 this->id2name.erase(i);
141 typedef std::unordered_map<uint32_t, struct 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 explicit WindowManager();
165 ~WindowManager() = default;
167 WindowManager(WindowManager const &) = delete;
168 WindowManager &operator=(WindowManager const &) = delete;
169 WindowManager(WindowManager &&) = delete;
170 WindowManager &operator=(WindowManager &&) = delete;
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 void api_activate_window(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
177 void api_deactivate_window(char const *appid, char const *role, const reply_func &reply);
178 void api_enddraw(char const *appid, char const *role);
179 int api_subscribe(afb_req_t req, int event_id);
180 result<json_object *> api_get_display_info();
181 result<json_object *> api_get_area_info(char const *role);
182 void send_event(const std::string& evname, const std::string& role);
183 void send_event(const std::string& evname, const std::string& role, const std::string& area, int x, int y, int w, int h);
185 // Events from the compositor we are interested in
186 void surface_created(unsigned surface_id);
187 void surface_removed(unsigned surface_id);
189 void removeClient(const std::string &appid);
190 void exceptionProcessForTransition();
192 // Do not use this function
194 void startTransitionWrapper(std::vector<WMAction> &actions);
195 void processError(WMError error);
198 // WM Events to clients
199 void emit_activated(const std::string& role);
200 void emit_deactivated(const std::string& role);
201 void emit_syncdraw(const std::string& role, char const *area, int x, int y, int w, int h);
202 void emit_syncdraw(const std::string &role, const std::string &area);
203 void emit_flushdraw(const std::string& role);
204 void emit_visible(const std::string& role, bool is_visible);
205 void emit_invisible(const std::string& role);
206 void emit_visible(const std::string& role);
208 WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
209 Task task, unsigned *req_num);
210 WMError checkPolicy(unsigned req_num);
211 WMError startTransition(unsigned req_num);
213 WMError doEndDraw(unsigned req_num);
214 void emitScreenUpdated(unsigned req_num);
218 void processNextRequest();
221 std::map<std::string, afb_event_t> map_afb_event;
222 std::unordered_map<std::string, struct rect> area2size;
223 std::shared_ptr<LayerControl> lc;
226 struct id_allocator id_alloc;
228 // ID allocation and proxy methods for lookup
229 std::unordered_map<unsigned, struct TmpClient> tmp_surface2app;
234 #endif // WINDOW_MANAGER_HPP