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 TMCAGLWM_APP_HPP
18 #define TMCAGLWM_APP_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 kKeyScale[];
69 extern const char kKeyIds[];
71 typedef struct WMClientCtxt
75 WMClientCtxt(const char *appName, const char* appRole)
86 // Surfaces that where requested but not yet created
87 std::unordered_map<unsigned, std::string> id2name;
88 std::unordered_map<std::string, unsigned> name2id;
90 id_allocator(id_allocator const &) = delete;
91 id_allocator(id_allocator &&) = delete;
92 id_allocator &operator=(id_allocator const &);
93 id_allocator &operator=(id_allocator &&) = delete;
95 // Insert and return a new ID
96 unsigned generate_id(std::string const &name)
98 unsigned sid = this->next++;
99 this->id2name[sid] = name;
100 this->name2id[name] = sid;
101 HMI_DEBUG("wm", "allocated new id %u with name %s", sid, name.c_str());
105 // Insert a new ID which defined outside
106 void register_name_id(std::string const &name, unsigned sid)
108 this->id2name[sid] = name;
109 this->name2id[name] = sid;
110 HMI_DEBUG("wm", "register id %u with name %s", sid, name.c_str());
114 // Lookup by ID or by name
115 optional<unsigned> lookup(std::string const &name) const
117 auto i = this->name2id.find(name);
118 return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
121 optional<std::string> lookup(unsigned id) const
123 auto i = this->id2name.find(id);
124 return i == this->id2name.end() ? nullopt
125 : optional<std::string>(i->second);
128 // Remove a surface id and name
129 void remove_id(std::string const &name)
131 auto i = this->name2id.find(name);
132 if (i != this->name2id.end())
134 this->id2name.erase(i->second);
135 this->name2id.erase(i);
139 void remove_id(unsigned id)
141 auto i = this->id2name.find(id);
142 if (i != this->id2name.end())
144 this->name2id.erase(i->second);
145 this->id2name.erase(i);
153 typedef std::unordered_map<uint32_t, struct compositor::rect> rect_map;
154 typedef std::function<void(const char *err_msg)> reply_func;
160 Event_Active = Event_Val_Min,
173 Event_Val_Max = Event_Error,
176 const std::vector<const char *> kListEventName{
186 struct controller_hooks chooks;
188 // This is the one thing, we do not own.
189 struct wl::display *display;
191 std::unique_ptr<struct compositor::controller> controller;
192 std::vector<std::unique_ptr<struct wl::output>> outputs;
194 // track current layouts separately
197 // ID allocation and proxy methods for lookup
198 struct id_allocator id_alloc;
200 // Set by AFB API when wayland events need to be dispatched
201 std::atomic<bool> pending_events;
203 std::map<const char *, struct afb_event> map_afb_event;
205 // Surface are info (x, y, w, h)
209 std::vector<int> surface_bg;
211 explicit WindowManager(wl::display *d);
212 ~WindowManager() = default;
214 WindowManager(WindowManager const &) = delete;
215 WindowManager &operator=(WindowManager const &) = delete;
216 WindowManager(WindowManager &&) = delete;
217 WindowManager &operator=(WindowManager &&) = delete;
220 int dispatch_pending_events();
221 void set_pending_events();
223 result<int> api_request_surface(char const *appid, char const *role);
224 char const *api_request_surface(char const *appid, char const *role, char const *ivi_id);
225 void api_activate_surface(char const *appid, char const *role, char const *drawing_area, const reply_func &reply);
226 void api_deactivate_surface(char const *appid, char const *role, const reply_func &reply);
227 void api_enddraw(char const *appid, char const *role);
228 result<json_object *> api_get_display_info();
229 result<json_object *> api_get_area_info(char const *role);
231 void send_event(char const *evname, char const *label);
232 void send_event(char const *evname, char const *label, char const *area, int x, int y, int w, int h);
234 // Events from the compositor we are interested in
235 void surface_created(uint32_t surface_id);
236 void surface_removed(uint32_t surface_id);
238 void removeClient(const std::string &appid);
239 void exceptionProcessForTransition();
240 const char* convertRoleOldToNew(char const *role);
241 // Do not use this function
243 void onApplicationTerminated(const WMClientCtxt& ctxt);
246 bool pop_pending_events();
247 optional<int> lookup_id(char const *name);
248 optional<std::string> lookup_name(int id);
250 void surface_set_layout(int surface_id, const std::string& area = "");
251 void layout_commit();
253 // WM Events to clients
254 void emit_activated(char const *label);
255 void emit_deactivated(char const *label);
256 void emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h);
257 void emit_syncdraw(const std::string &role, const std::string &area);
258 void emit_flushdraw(char const *label);
259 void emit_visible(char const *label, bool is_visible);
260 void emit_invisible(char const *label);
261 void emit_visible(char const *label);
263 void activate(int id);
264 void deactivate(int id);
265 WMError setRequest(const std::string &appid, const std::string &role, const std::string &area,
266 Task task, unsigned *req_num);
267 WMError doTransition(unsigned sequence_number);
268 WMError checkPolicy(unsigned req_num);
269 WMError startTransition(unsigned req_num);
270 WMError setInvisibleTask(const std::string &role, bool split);
272 WMError doEndDraw(unsigned req_num);
273 WMError layoutChange(const WMAction &action);
274 WMError visibilityChange(const WMAction &action);
275 WMError setSurfaceSize(unsigned surface, const std::string& area);
276 WMError changeCurrentState(unsigned req_num);
277 void emitScreenUpdated(unsigned req_num);
281 void processNextRequest();
285 const char *check_surface_exist(const char *role);
287 bool can_split(struct LayoutState const &state, int new_id);
290 std::unordered_map<std::string, struct compositor::rect> area2size;
291 std::unordered_map<std::string, std::string> roleold2new;
292 std::unordered_map<std::string, std::string> rolenew2old;
294 static const char* kDefaultOldRoleDb;
299 #endif // TMCAGLWM_APP_HPP