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.
20 #include "window_manager.hpp"
21 #include "json_helper.hpp"
22 #include "applist.hpp"
26 #include <systemd/sd-event.h>
32 static const uint64_t kTimeOut = 3ULL; /* 3s */
34 /* DrawingArea name used by "{layout}.{area}" */
35 const char kNameLayoutNormal[] = "normal";
36 const char kNameLayoutSplit[] = "split";
37 const char kNameAreaFull[] = "full";
38 const char kNameAreaMain[] = "main";
39 const char kNameAreaSub[] = "sub";
41 /* Key for json obejct */
42 const char kKeyDrawingName[] = "drawing_name";
43 const char kKeyDrawingArea[] = "drawing_area";
44 const char kKeyDrawingRect[] = "drawing_rect";
45 const char kKeyX[] = "x";
46 const char kKeyY[] = "y";
47 const char kKeyWidth[] = "width";
48 const char kKeyHeight[] = "height";
49 const char kKeyWidthPixel[] = "width_pixel";
50 const char kKeyHeightPixel[] = "height_pixel";
51 const char kKeyWidthMm[] = "width_mm";
52 const char kKeyHeightMm[] = "height_mm";
53 const char kKeyScale[] = "scale";
54 const char kKeyIds[] = "ids";
56 static sd_event_source *g_timer_ev_src = nullptr;
57 static AppList g_app_list;
64 result<json> file_to_json(char const *filename)
67 std::ifstream i(filename);
70 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
71 j = default_layers_json;
81 struct result<layer_map> load_layer_map(char const *filename)
83 HMI_DEBUG("wm", "loading IDs from %s", filename);
85 auto j = file_to_json(filename);
88 return Err<layer_map>(j.unwrap_err());
90 json jids = j.unwrap();
92 return to_layer_map(jids);
95 static int processTimerHandler(sd_event_source *s, uint64_t usec, void *userdata)
97 HMI_NOTICE("wm", "Time out occurs because the client replys endDraw slow, so revert the request");
98 reinterpret_cast<wm::WindowManager *>(userdata)->timerHandler();
107 WindowManager::WindowManager(wl::display *d)
114 pending_events(false)
116 char const *path_layers_json = getenv("AFM_APP_INSTALL_DIR");
118 if (!path_layers_json)
120 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
121 path = std::string(path_layers_json);
125 path = std::string(path_layers_json) + std::string("/etc/layers.json");
131 auto l = load_layer_map(path.c_str());
134 this->layers = l.unwrap();
138 HMI_ERROR("wm", "%s", l.err().value());
142 catch (std::exception &e)
144 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
148 int WindowManager::init()
150 if (!this->display->ok())
155 if (this->layers.mapping.empty())
157 HMI_ERROR("wm", "No surface -> layer mapping loaded");
161 // TODO: application requests by old role,
162 // so create role map (old, new)
164 this->loadOldRoleDb();
167 for (int i = Event_Val_Min; i <= Event_Val_Max; i++)
169 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
172 this->display->add_global_handler(
173 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
174 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
177 this->display->add_global_handler(
178 "ivi_wm", [this](wl_registry *r, uint32_t name, uint32_t v) {
180 std::make_unique<struct compositor::controller>(r, name, v);
182 // Init controller hooks
183 this->controller->chooks = &this->chooks;
185 // This protocol needs the output, so lets just add our mapping here...
186 this->controller->add_proxy_to_id_mapping(
187 this->outputs.front()->proxy.get(),
188 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
189 this->outputs.front()->proxy.get())));
192 this->controller->create_screen(this->outputs.front()->proxy.get());
194 // Set display to controller
195 this->controller->display = this->display;
198 // First level objects
199 this->display->roundtrip();
200 // Second level objects
201 this->display->roundtrip();
202 // Third level objects
203 this->display->roundtrip();
205 return init_layers();
208 int WindowManager::dispatch_pending_events()
210 if (this->pop_pending_events())
212 this->display->dispatch_pending();
218 void WindowManager::set_pending_events()
220 this->pending_events.store(true, std::memory_order_release);
223 result<int> WindowManager::api_request_surface(char const *appid, char const *drawing_name)
225 // TODO: application requests by old role,
226 // so convert role old to new
227 const char *role = this->convertRoleOldToNew(drawing_name);
229 auto lid = this->layers.get_layer_id(std::string(role));
233 * register drawing_name as fallback and make it displayed.
235 lid = this->layers.get_layer_id(std::string("fallback"));
236 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
239 return Err<int>("Drawing name does not match any role, fallback is disabled");
243 auto rname = this->lookup_id(role);
246 // name does not exist yet, allocate surface id...
247 auto id = int(this->id_alloc.generate_id(role));
248 this->layers.add_surface(id, *lid);
250 // set the main_surface[_name] here and now
251 if (!this->layers.main_surface_name.empty() &&
252 this->layers.main_surface_name == drawing_name)
254 this->layers.main_surface = id;
255 HMI_DEBUG("wm", "Set main_surface id to %u", id);
258 // add client into the db
259 std::string appid_str(appid);
260 g_app_list.addClient(appid_str, *lid, id, std::string(role));
262 // Set role map of (new, old)
263 this->rolenew2old[role] = std::string(drawing_name);
268 // Check currently registered drawing names if it is already there.
269 return Err<int>("Surface already present");
272 char const *WindowManager::api_request_surface(char const *appid, char const *drawing_name,
277 // TODO: application requests by old role,
278 // so convert role old to new
279 const char *role = this->convertRoleOldToNew(drawing_name);
281 auto lid = this->layers.get_layer_id(std::string(role));
282 unsigned sid = std::stol(ivi_id);
287 * register drawing_name as fallback and make it displayed.
289 lid = this->layers.get_layer_id(std::string("fallback"));
290 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
293 return "Drawing name does not match any role, fallback is disabled";
297 auto rname = this->lookup_id(role);
301 return "Surface already present";
304 // register pair drawing_name and ivi_id
305 this->id_alloc.register_name_id(role, sid);
306 this->layers.add_surface(sid, *lid);
308 // this surface is already created
309 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
311 this->controller->layers[*lid]->add_surface(sid);
312 this->layout_commit();
314 // add client into the db
315 std::string appid_str(appid);
316 g_app_list.addClient(appid_str, *lid, sid, std::string(role));
318 // Set role map of (new, old)
319 this->rolenew2old[role] = std::string(drawing_name);
324 void WindowManager::api_activate_surface(char const *appid, char const *drawing_name,
325 char const *drawing_area, const reply_func &reply)
329 // TODO: application requests by old role,
330 // so convert role old to new
331 const char *c_role = this->convertRoleOldToNew(drawing_name);
333 std::string id = appid;
334 std::string role = c_role;
335 std::string area = drawing_area;
336 Task task = Task::TASK_ALLOCATE;
337 unsigned req_num = 0;
338 WMError ret = WMError::UNKNOWN;
340 ret = this->setRequest(id, role, area, task, &req_num);
342 if(ret != WMError::SUCCESS)
344 HMI_ERROR("wm", errorDescription(ret));
345 reply("Failed to set request");
350 if (req_num != g_app_list.currentRequestNumber())
352 // Add request, then invoked after the previous task is finished
353 HMI_SEQ_DEBUG(req_num, "request is accepted");
360 ret = this->doTransition(req_num);
362 if (ret != WMError::SUCCESS)
365 HMI_SEQ_ERROR(req_num, errorDescription(ret));
366 g_app_list.removeRequest(req_num);
367 this->processNextRequest();
371 void WindowManager::api_deactivate_surface(char const *appid, char const *drawing_name,
372 const reply_func &reply)
376 // TODO: application requests by old role,
377 // so convert role old to new
378 const char *c_role = this->convertRoleOldToNew(drawing_name);
383 std::string id = appid;
384 std::string role = c_role;
385 std::string area = ""; //drawing_area;
386 Task task = Task::TASK_RELEASE;
387 unsigned req_num = 0;
388 WMError ret = WMError::UNKNOWN;
390 ret = this->setRequest(id, role, area, task, &req_num);
392 if (ret != WMError::SUCCESS)
394 HMI_ERROR("wm", errorDescription(ret));
395 reply("Failed to set request");
400 if (req_num != g_app_list.currentRequestNumber())
402 // Add request, then invoked after the previous task is finished
403 HMI_SEQ_DEBUG(req_num, "request is accepted");
410 ret = this->doTransition(req_num);
412 if (ret != WMError::SUCCESS)
415 HMI_SEQ_ERROR(req_num, errorDescription(ret));
416 g_app_list.removeRequest(req_num);
417 this->processNextRequest();
421 void WindowManager::api_enddraw(char const *appid, char const *drawing_name)
423 // TODO: application requests by old role,
424 // so convert role old to new
425 const char *c_role = this->convertRoleOldToNew(drawing_name);
427 std::string id = appid;
428 std::string role = c_role;
429 unsigned current_req = g_app_list.currentRequestNumber();
430 bool result = g_app_list.setEndDrawFinished(current_req, id, role);
434 HMI_ERROR("wm", "%s is not in transition state", id.c_str());
438 if (g_app_list.endDrawFullfilled(current_req))
440 // do task for endDraw
442 WMError ret = this->doEndDraw(current_req);
444 if(ret != WMError::SUCCESS)
446 //this->emit_error();
448 this->emitScreenUpdated(current_req);
449 HMI_SEQ_INFO(current_req, "Finish request status: %s", errorDescription(ret));
451 g_app_list.removeRequest(current_req);
453 this->processNextRequest();
457 HMI_SEQ_INFO(current_req, "Wait other App call endDraw");
462 result<json_object *> WindowManager::api_get_display_info()
464 if (!this->display->ok())
466 return Err<json_object *>("Wayland compositor is not available");
470 compositor::size o_size = this->controller->output_size;
471 compositor::size p_size = this->controller->physical_size;
473 json_object *object = json_object_new_object();
474 json_object_object_add(object, kKeyWidthPixel, json_object_new_int(o_size.w));
475 json_object_object_add(object, kKeyHeightPixel, json_object_new_int(o_size.h));
476 json_object_object_add(object, kKeyWidthMm, json_object_new_int(p_size.w));
477 json_object_object_add(object, kKeyHeightMm, json_object_new_int(p_size.h));
478 json_object_object_add(object, kKeyScale, json_object_new_double(this->controller->scale));
480 return Ok<json_object *>(object);
483 result<json_object *> WindowManager::api_get_area_info(char const *drawing_name)
485 HMI_DEBUG("wm", "called");
487 // TODO: application requests by old role,
488 // so convert role old to new
489 const char *role = this->convertRoleOldToNew(drawing_name);
491 // Check drawing name, surface/layer id
492 auto const &surface_id = this->lookup_id(role);
495 return Err<json_object *>("Surface does not exist");
498 if (!this->controller->surface_exists(*surface_id))
500 return Err<json_object *>("Surface does not exist in controller!");
503 auto layer_id = this->layers.get_layer_id(*surface_id);
506 return Err<json_object *>("Surface is not on any layer!");
509 auto o_state = *this->layers.get_layout_state(*surface_id);
510 if (o_state == nullptr)
512 return Err<json_object *>("Could not find layer for surface");
515 struct LayoutState &state = *o_state;
516 if ((state.main != *surface_id) && (state.sub != *surface_id))
518 return Err<json_object *>("Surface is inactive");
521 // Set area rectangle
522 compositor::rect area_info = this->area_info[*surface_id];
523 json_object *object = json_object_new_object();
524 json_object_object_add(object, kKeyX, json_object_new_int(area_info.x));
525 json_object_object_add(object, kKeyY, json_object_new_int(area_info.y));
526 json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w));
527 json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h));
529 return Ok<json_object *>(object);
532 void WindowManager::api_ping() { this->dispatch_pending_events(); }
534 void WindowManager::send_event(char const *evname, char const *label)
536 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
538 json_object *j = json_object_new_object();
539 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
541 int ret = afb_event_push(this->map_afb_event[evname], j);
544 HMI_DEBUG("wm", "afb_event_push failed: %m");
548 void WindowManager::send_event(char const *evname, char const *label, char const *area,
549 int x, int y, int w, int h)
551 HMI_DEBUG("wm", "%s: %s(%s, %s) x:%d y:%d w:%d h:%d",
552 __func__, evname, label, area, x, y, w, h);
554 json_object *j_rect = json_object_new_object();
555 json_object_object_add(j_rect, kKeyX, json_object_new_int(x));
556 json_object_object_add(j_rect, kKeyY, json_object_new_int(y));
557 json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w));
558 json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h));
560 json_object *j = json_object_new_object();
561 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
562 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
563 json_object_object_add(j, kKeyDrawingRect, j_rect);
565 int ret = afb_event_push(this->map_afb_event[evname], j);
568 HMI_DEBUG("wm", "afb_event_push failed: %m");
575 void WindowManager::surface_created(uint32_t surface_id)
577 this->controller->get_surface_properties(surface_id, IVI_WM_PARAM_SIZE);
579 auto layer_id = this->layers.get_layer_id(surface_id);
582 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
587 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
589 this->controller->layers[*layer_id]->add_surface(surface_id);
590 this->layout_commit();
593 void WindowManager::surface_removed(uint32_t surface_id)
595 HMI_DEBUG("wm", "surface_id is %u", surface_id);
596 g_app_list.removeSurface(surface_id);
599 void WindowManager::removeClient(const std::string &appid)
601 HMI_DEBUG("wm", "Remove clinet %s from list", appid.c_str());
602 g_app_list.removeClient(appid);
605 void WindowManager::exceptionProcessForTransition()
607 unsigned req_num = g_app_list.currentRequestNumber();
608 HMI_SEQ_NOTICE(req_num, "Process exception handling for request. Remove current request %d", req_num);
609 g_app_list.removeRequest(req_num);
610 HMI_SEQ_NOTICE(g_app_list.currentRequestNumber(), "Process next request if exists");
611 this->processNextRequest();
614 void WindowManager::timerHandler()
616 unsigned req_num = g_app_list.currentRequestNumber();
617 HMI_SEQ_DEBUG(req_num, "Timer expired remove Request");
618 g_app_list.reqDump();
619 g_app_list.removeRequest(req_num);
620 this->processNextRequest();
624 ******* Private Functions *******
627 bool WindowManager::pop_pending_events()
630 return this->pending_events.compare_exchange_strong(
631 x, false, std::memory_order_consume);
634 optional<int> WindowManager::lookup_id(char const *name)
636 return this->id_alloc.lookup(std::string(name));
638 optional<std::string> WindowManager::lookup_name(int id)
640 return this->id_alloc.lookup(id);
646 int WindowManager::init_layers()
648 if (!this->controller)
650 HMI_ERROR("wm", "ivi_controller global not available");
654 if (this->outputs.empty())
656 HMI_ERROR("wm", "no output was set up!");
660 auto &c = this->controller;
662 auto &o = this->outputs.front();
663 auto &s = c->screens.begin()->second;
664 auto &layers = c->layers;
666 // Write output dimensions to ivi controller...
667 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
668 c->physical_size = compositor::size{uint32_t(o->physical_width),
669 uint32_t(o->physical_height)};
672 HMI_DEBUG("wm", "SCALING: screen (%dx%d), physical (%dx%d)",
673 o->width, o->height, o->physical_width, o->physical_height);
675 this->layers.loadAreaDb();
677 const compositor::rect css_bg = this->layers.getAreaSize("fullscreen");
678 rectangle dp_bg(o->width, o->height);
680 dp_bg.set_aspect(static_cast<double>(css_bg.w) / css_bg.h);
681 dp_bg.fit(o->width, o->height);
682 dp_bg.center(o->width, o->height);
683 HMI_DEBUG("wm", "SCALING: CSS BG(%dx%d) -> DDP %dx%d,(%dx%d)",
684 css_bg.w, css_bg.h, dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
692 // Quick and dirty setup of layers
693 for (auto const &i : this->layers.mapping)
695 c->layer_create(i.second.layer_id, dp_bg.width(), dp_bg.height());
696 auto &l = layers[i.second.layer_id];
697 l->set_destination_rectangle(dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
698 l->set_visibility(1);
699 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
700 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
703 // Add layers to screen
704 s->set_render_order(this->layers.layers);
706 this->layout_commit();
708 c->scale = static_cast<double>(dp_bg.height()) / css_bg.h;
709 this->layers.setupArea(c->scale);
714 void WindowManager::surface_set_layout(int surface_id, const std::string& area)
716 if (!this->controller->surface_exists(surface_id))
718 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
722 auto o_layer_id = this->layers.get_layer_id(surface_id);
726 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
730 uint32_t layer_id = *o_layer_id;
732 auto const &layer = this->layers.get_layer(layer_id);
733 auto rect = this->layers.getAreaSize(area);
734 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "%s : x:%d y:%d w:%d h:%d", area.c_str(),
735 rect.x, rect.y, rect.w, rect.h);
736 auto &s = this->controller->surfaces[surface_id];
743 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
746 // set destination to the display rectangle
747 s->set_destination_rectangle(x, y, w, h);
749 // update area information
750 this->area_info[surface_id].x = x;
751 this->area_info[surface_id].y = y;
752 this->area_info[surface_id].w = w;
753 this->area_info[surface_id].h = h;
755 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
756 surface_id, layer_id, x, y, w, h);
759 void WindowManager::layout_commit()
761 this->controller->commit_changes();
762 this->display->flush();
765 void WindowManager::emit_activated(char const *label)
767 this->send_event(kListEventName[Event_Active], label);
770 void WindowManager::emit_deactivated(char const *label)
772 this->send_event(kListEventName[Event_Inactive], label);
775 void WindowManager::emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h)
777 this->send_event(kListEventName[Event_SyncDraw], label, area, x, y, w, h);
780 void WindowManager::emit_syncdraw(const std::string &role, const std::string &area)
782 compositor::rect rect = this->layers.getAreaSize(area);
783 this->send_event(kListEventName[Event_SyncDraw],
784 role.c_str(), area.c_str(), rect.x, rect.y, rect.w, rect.h);
787 void WindowManager::emit_flushdraw(char const *label)
789 this->send_event(kListEventName[Event_FlushDraw], label);
792 void WindowManager::emit_visible(char const *label, bool is_visible)
794 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
797 void WindowManager::emit_invisible(char const *label)
799 return emit_visible(label, false);
802 void WindowManager::emit_visible(char const *label) { return emit_visible(label, true); }
804 void WindowManager::activate(int id)
806 auto ip = this->controller->sprops.find(id);
807 if (ip != this->controller->sprops.end())
809 this->controller->surfaces[id]->set_visibility(1);
811 this->lookup_name(id).value_or("unknown-name").c_str();
814 if ((0 == strcmp(label, "radio")) ||
815 (0 == strcmp(label, "music")) ||
816 (0 == strcmp(label, "video")) ||
817 (0 == strcmp(label, "map")))
819 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i)
824 this->surface_bg.erase(i);
826 // Remove from BG layer (999)
827 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
828 this->controller->layers[999]->remove_surface(id);
830 // Add to FG layer (1001)
831 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
832 this->controller->layers[1001]->add_surface(id);
834 for (int j : this->surface_bg)
836 HMI_DEBUG("wm", "Stored id:%d", j);
844 this->layout_commit();
846 // TODO: application requests by old role,
847 // so convert role new to old for emitting event
848 const char* old_role = this->rolenew2old[label].c_str();
850 this->emit_visible(old_role);
851 this->emit_activated(old_role);
855 void WindowManager::deactivate(int id)
857 auto ip = this->controller->sprops.find(id);
858 if (ip != this->controller->sprops.end())
861 this->lookup_name(id).value_or("unknown-name").c_str();
864 if ((0 == strcmp(label, "radio")) ||
865 (0 == strcmp(label, "music")) ||
866 (0 == strcmp(label, "video")) ||
867 (0 == strcmp(label, "map")))
871 this->surface_bg.push_back(id);
873 // Remove from FG layer (1001)
874 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
875 this->controller->layers[1001]->remove_surface(id);
877 // Add to BG layer (999)
878 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
879 this->controller->layers[999]->add_surface(id);
881 for (int j : surface_bg)
883 HMI_DEBUG("wm", "Stored id:%d", j);
888 this->controller->surfaces[id]->set_visibility(0);
892 this->layout_commit();
894 // TODO: application requests by old role,
895 // so convert role new to old for emitting event
896 const char* old_role = this->rolenew2old[label].c_str();
898 this->emit_deactivated(old_role);
899 this->emit_invisible(old_role);
903 WMError WindowManager::setRequest(const std::string& appid, const std::string &role, const std::string &area,
904 Task task, unsigned* req_num)
906 if (!g_app_list.contains(appid))
908 return WMError::NOT_REGISTERED;
911 auto client = g_app_list.lookUpClient(appid);
916 unsigned current = g_app_list.currentRequestNumber();
917 unsigned requested_num = g_app_list.getRequestNumber(appid);
918 if (requested_num != 0)
920 HMI_SEQ_INFO(requested_num,
921 "%s %s %s request is already queued", appid.c_str(), role.c_str(), area.c_str());
925 WMRequest req = WMRequest(appid, role, area, task);
926 unsigned new_req = g_app_list.addRequest(req);
928 g_app_list.reqDump();
930 HMI_SEQ_DEBUG(current, "%s start sequence with %s, %s", appid.c_str(), role.c_str(), area.c_str());
932 return WMError::SUCCESS;
935 WMError WindowManager::doTransition(unsigned req_num)
937 HMI_SEQ_DEBUG(req_num, "check policy");
938 WMError ret = this->checkPolicy(req_num);
939 if (ret != WMError::SUCCESS)
943 HMI_SEQ_DEBUG(req_num, "Start transition.");
944 ret = this->startTransition(req_num);
948 WMError WindowManager::checkPolicy(unsigned req_num)
953 // get current trigger
956 WMError ret = WMError::LAYOUT_CHANGE_FAIL;
957 auto trigger = g_app_list.getRequest(req_num, &found);
960 ret = WMError::NO_ENTRY;
963 std::string req_area = trigger.area;
965 // >>>> Compatible with current window manager until policy manager coming
966 if (trigger.task == Task::TASK_ALLOCATE)
968 HMI_SEQ_DEBUG(req_num, "Check split or not");
969 const char *msg = this->check_surface_exist(trigger.role.c_str());
973 HMI_SEQ_ERROR(req_num, msg);
974 ret = WMError::LAYOUT_CHANGE_FAIL;
978 auto const &surface_id = this->lookup_id(trigger.role.c_str());
979 auto o_state = *this->layers.get_layout_state(*surface_id);
980 struct LayoutState &state = *o_state;
982 unsigned curernt_sid = state.main;
983 split = this->can_split(state, *surface_id);
987 HMI_SEQ_DEBUG(req_num, "Split happens");
988 // Get current visible role
989 std::string add_role = this->lookup_name(state.main).value();
991 std::string add_area = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaMain);
992 // Change request area
993 req_area = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaSub);
994 HMI_SEQ_NOTICE(req_num, "Change request area from %s to %s, because split happens",
995 trigger.area.c_str(), req_area.c_str());
996 // set another action
997 std::string add_name = g_app_list.getAppID(curernt_sid, add_role, &found);
1000 HMI_SEQ_ERROR(req_num, "Couldn't widhdraw with surfaceID : %d", curernt_sid);
1001 ret = WMError::NOT_REGISTERED;
1004 HMI_SEQ_INFO(req_num, "Additional split app %s, role: %s, area: %s",
1005 add_name.c_str(), add_role.c_str(), add_area.c_str());
1007 bool end_draw_finished = false;
1008 WMAction split_action{
1012 TaskVisible::VISIBLE,
1014 WMError ret = g_app_list.setAction(req_num, split_action);
1015 if (ret != WMError::SUCCESS)
1017 HMI_SEQ_ERROR(req_num, "Failed to set action");
1020 g_app_list.reqDump();
1025 HMI_SEQ_DEBUG(req_num, "split doesn't happen");
1028 // Set invisible task(Remove if policy manager finish)
1029 ret = this->setInvisibleTask(trigger.role, split);
1030 if(ret != WMError::SUCCESS)
1032 HMI_SEQ_ERROR(req_num, "Failed to set invisible task: %s", errorDescription(ret));
1036 /* get new status from Policy Manager */
1037 HMI_SEQ_NOTICE(req_num, "ATM, Policy manager does't exist, then set WMAction as is");
1038 if(trigger.role == "homescreen")
1040 // TODO : Remove when Policy Manager completed
1041 HMI_SEQ_NOTICE(req_num, "Hack. This process will be removed. Change HomeScreen code!!");
1042 req_area = "fullscreen";
1044 TaskVisible task_visible =
1045 (trigger.task == Task::TASK_ALLOCATE) ? TaskVisible::VISIBLE : TaskVisible::INVISIBLE;
1047 ret = g_app_list.setAction(req_num, trigger.appid, trigger.role, req_area, task_visible);
1048 g_app_list.reqDump();
1053 WMError WindowManager::startTransition(unsigned req_num)
1055 bool sync_draw_happen = false;
1057 WMError ret = WMError::SUCCESS;
1058 auto actions = g_app_list.getActions(req_num, &found);
1061 ret = WMError::NO_ENTRY;
1062 HMI_SEQ_ERROR(req_num,
1063 "Window Manager bug :%s : Action is not set", errorDescription(ret));
1067 for (const auto &action : actions)
1069 if (action.visible != TaskVisible::INVISIBLE)
1071 sync_draw_happen = true;
1073 // TODO: application requests by old role,
1074 // so convert role new to old for emitting event
1075 std::string old_role = this->rolenew2old[action.role];
1077 this->emit_syncdraw(old_role, action.area);
1078 /* TODO: emit event for app not subscriber
1079 if(g_app_list.contains(y.appid))
1080 g_app_list.lookUpClient(y.appid)->emit_syncdraw(y.role, y.area); */
1084 if (sync_draw_happen)
1090 // deactivate only, no syncDraw
1091 // Make it deactivate here
1092 for (const auto &x : actions)
1094 if (g_app_list.contains(x.appid))
1096 auto client = g_app_list.lookUpClient(x.appid);
1097 this->deactivate(client->surfaceID(x.role));
1100 ret = NO_LAYOUT_CHANGE;
1105 WMError WindowManager::setInvisibleTask(const std::string &role, bool split)
1107 unsigned req_num = g_app_list.currentRequestNumber();
1108 HMI_SEQ_DEBUG(req_num, "set current visible app to invisible task");
1110 auto trigger = g_app_list.getRequest(req_num, &found);
1111 // I don't check found == true here because this is checked in caller.
1112 if(trigger.role == "homescreen")
1114 HMI_SEQ_INFO(req_num, "In case of 'homescreen' visible, don't change app to invisible");
1115 return WMError::SUCCESS;
1118 // This task is copied from original actiavete surface
1119 const char *drawing_name = this->rolenew2old[role].c_str();
1120 auto const &surface_id = this->lookup_id(role.c_str());
1121 auto layer_id = this->layers.get_layer_id(*surface_id);
1122 auto o_state = *this->layers.get_layout_state(*surface_id);
1123 struct LayoutState &state = *o_state;
1124 std::string add_name, add_role;
1125 std::string add_area = "";
1127 TaskVisible task_visible = TaskVisible::INVISIBLE;
1128 bool end_draw_finished = true;
1130 for (auto const &l : this->layers.mapping)
1132 if (l.second.layer_id <= *layer_id)
1136 HMI_DEBUG("wm", "debug: main %d , sub : %d", l.second.state.main, l.second.state.sub);
1137 if (l.second.state.main != -1)
1139 //this->deactivate(l.second.state.main);
1140 surface = l.second.state.main;
1141 add_role = *this->id_alloc.lookup(surface);
1142 add_name = g_app_list.getAppID(surface, add_role, &found);
1144 return WMError::NOT_REGISTERED;
1146 HMI_SEQ_INFO(req_num, "Invisible %s", add_name.c_str());
1147 WMAction act{add_name, add_role, add_area, task_visible, end_draw_finished};
1148 g_app_list.setAction(req_num, act);
1149 l.second.state.main = -1;
1152 if (l.second.state.sub != -1)
1154 //this->deactivate(l.second.state.sub);
1155 surface = l.second.state.sub;
1156 add_role = *this->id_alloc.lookup(surface);
1157 add_name = g_app_list.getAppID(surface, add_role, &found);
1160 return WMError::NOT_REGISTERED;
1162 HMI_SEQ_INFO(req_num, "Invisible %s", add_name.c_str());
1163 WMAction act{add_name, add_role, add_area, task_visible, end_draw_finished};
1164 g_app_list.setAction(req_num, act);
1165 l.second.state.sub = -1;
1169 // change current state here, but this is hack
1170 auto layer = this->layers.get_layer(*layer_id);
1172 if (state.main == -1)
1174 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
1178 if (0 != strcmp(drawing_name, "HomeScreen"))
1182 if (state.sub != *surface_id)
1184 if (state.sub != -1)
1186 //this->deactivate(state.sub);
1189 std::move(*this->id_alloc.lookup(state.sub));
1190 deact_sub.area = add_area;
1191 deact_sub.appid = g_app_list.getAppID(state.sub, deact_sub.role, &found);
1194 HMI_SEQ_ERROR(req_num, "App doesn't exist for role : %s",
1195 deact_sub.role.c_str());
1196 return WMError::NOT_REGISTERED;
1198 deact_sub.visible = task_visible;
1199 deact_sub.end_draw_finished = end_draw_finished;
1200 HMI_SEQ_DEBUG(req_num, "Set invisible task for %s", deact_sub.appid.c_str());
1201 g_app_list.setAction(req_num, deact_sub);
1204 //state = LayoutState{state.main, *surface_id};
1208 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
1210 //this->surface_set_layout(*surface_id);
1211 if (state.main != *surface_id)
1213 // this->deactivate(state.main);
1214 WMAction deact_main;
1215 deact_main.role = std::move(*this->id_alloc.lookup(state.main));
1217 deact_main.area = add_area;
1218 deact_main.appid = g_app_list.getAppID(state.main, deact_main.role, &found);
1221 HMI_SEQ_DEBUG(req_num, "sub surface ddoesn't exist");
1222 return WMError::NOT_REGISTERED;
1224 deact_main.visible = task_visible;
1225 deact_main.end_draw_finished = end_draw_finished;
1226 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
1227 g_app_list.setAction(req_num, deact_main);
1229 if (state.sub != -1)
1231 if (state.sub != *surface_id)
1233 //this->deactivate(state.sub);
1235 deact_sub.role = std::move(*this->id_alloc.lookup(state.sub));
1237 deact_sub.area = add_area;
1238 deact_sub.appid = g_app_list.getAppID(state.sub, deact_sub.role, &found);
1241 HMI_SEQ_DEBUG(req_num, "sub surface ddoesn't exist");
1242 return WMError::NOT_REGISTERED;
1244 deact_sub.visible = task_visible;
1245 deact_sub.end_draw_finished = end_draw_finished;
1246 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
1247 g_app_list.setAction(req_num, deact_sub);
1250 //state = LayoutState{*surface_id};
1254 return WMError::SUCCESS;
1257 WMError WindowManager::doEndDraw(unsigned req_num)
1261 auto actions = g_app_list.getActions(req_num, &found);
1262 WMError ret = WMError::SUCCESS;
1265 ret = WMError::NO_ENTRY;
1269 HMI_SEQ_INFO(req_num, "do endDraw");
1271 // layout change and make it visible
1272 for (const auto &act : actions)
1275 if(!g_app_list.contains(act.appid)){
1276 ret = WMError::NOT_REGISTERED;
1278 ret = this->layoutChange(act);
1279 if(ret != WMError::SUCCESS)
1281 HMI_SEQ_WARNING(req_num,
1282 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1285 ret = this->visibilityChange(act);
1286 if (ret != WMError::SUCCESS)
1288 HMI_SEQ_WARNING(req_num,
1289 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1292 HMI_SEQ_DEBUG(req_num, "visible %s", act.role.c_str());
1293 //this->lm_enddraw(act.role.c_str());
1295 this->layout_commit();
1297 // Change current state
1298 this->changeCurrentState(req_num);
1300 HMI_SEQ_INFO(req_num, "emit flushDraw");
1302 for(const auto &act_flush : actions)
1304 if(act_flush.visible != TaskVisible::INVISIBLE)
1306 // TODO: application requests by old role,
1307 // so convert role new to old for emitting event
1308 std::string old_role = this->rolenew2old[act_flush.role];
1310 this->emit_flushdraw(old_role.c_str());
1317 WMError WindowManager::layoutChange(const WMAction &action)
1319 if (action.visible == TaskVisible::INVISIBLE)
1321 // Visibility is not change -> no redraw is required
1322 return WMError::SUCCESS;
1324 auto client = g_app_list.lookUpClient(action.appid);
1325 unsigned surface = client->surfaceID(action.role);
1328 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1329 "client doesn't have surface with role(%s)", action.role.c_str());
1330 return WMError::NOT_REGISTERED;
1333 WMError ret = this->setSurfaceSize(surface, action.area);
1337 WMError WindowManager::visibilityChange(const WMAction &action)
1339 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Change visibility");
1340 if(!g_app_list.contains(action.appid)){
1341 return WMError::NOT_REGISTERED;
1343 auto client = g_app_list.lookUpClient(action.appid);
1344 unsigned surface = client->surfaceID(action.role);
1347 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1348 "client doesn't have surface with role(%s)", action.role.c_str());
1349 return WMError::NOT_REGISTERED;
1352 if (action.visible != TaskVisible::INVISIBLE)
1354 this->activate(surface); // Layout Manager task
1358 this->deactivate(surface); // Layout Manager task
1360 return WMError::SUCCESS;
1363 WMError WindowManager::setSurfaceSize(unsigned surface, const std::string &area)
1365 this->surface_set_layout(surface, area);
1367 return WMError::SUCCESS;
1370 WMError WindowManager::changeCurrentState(unsigned req_num)
1372 HMI_SEQ_DEBUG(req_num, "Change current layout state");
1373 bool trigger_found = false, action_found = false;
1374 auto trigger = g_app_list.getRequest(req_num, &trigger_found);
1375 auto actions = g_app_list.getActions(req_num, &action_found);
1376 if (!trigger_found || !action_found)
1378 HMI_SEQ_ERROR(req_num, "Action not found");
1379 return WMError::LAYOUT_CHANGE_FAIL;
1382 // Layout state reset
1383 struct LayoutState reset_state{-1, -1};
1384 HMI_SEQ_DEBUG(req_num,"Reset layout state");
1385 for (const auto &action : actions)
1387 if(!g_app_list.contains(action.appid)){
1388 return WMError::NOT_REGISTERED;
1390 auto client = g_app_list.lookUpClient(action.appid);
1391 auto pCurState = *this->layers.get_layout_state((int)client->surfaceID(action.role));
1392 if(pCurState == nullptr)
1394 HMI_SEQ_ERROR(req_num, "Counldn't find current status");
1397 pCurState->main = reset_state.main;
1398 pCurState->sub = reset_state.sub;
1401 HMI_SEQ_DEBUG(req_num, "Change state");
1402 for (const auto &action : actions)
1404 auto client = g_app_list.lookUpClient(action.appid);
1405 auto pLayerCurState = *this->layers.get_layout_state((int)client->surfaceID(action.role));
1406 if (pLayerCurState == nullptr)
1408 HMI_SEQ_ERROR(req_num, "Counldn't find current status");
1413 if (action.visible != TaskVisible::INVISIBLE)
1415 surface = (int)client->surfaceID(action.role);
1416 HMI_SEQ_INFO(req_num, "Change %s surface : %d, state visible area : %s",
1417 action.role.c_str(), surface, action.area.c_str());
1418 // visible == true -> layout changes
1419 if(action.area == "normal.full" || action.area == "split.main")
1421 pLayerCurState->main = surface;
1423 else if (action.area == "split.sub")
1425 pLayerCurState->sub = surface;
1430 pLayerCurState->main = surface;
1435 return WMError::SUCCESS;
1438 void WindowManager::emitScreenUpdated(unsigned req_num)
1441 HMI_SEQ_DEBUG(req_num, "emit screen updated");
1443 auto actions = g_app_list.getActions(req_num, &found);
1445 // create json object
1446 json_object *j = json_object_new_object();
1447 json_object *jarray = json_object_new_array();
1449 for(const auto& action: actions)
1451 if(action.visible != TaskVisible::INVISIBLE)
1453 json_object_array_add(jarray, json_object_new_string(action.appid.c_str()));
1456 json_object_object_add(j, kKeyIds, jarray);
1457 HMI_SEQ_INFO(req_num, "Visible app: %s", json_object_get_string(j));
1459 int ret = afb_event_push(
1460 this->map_afb_event[kListEventName[Event_ScreenUpdated]], j);
1463 HMI_DEBUG("wm", "afb_event_push failed: %m");
1467 void WindowManager::setTimer()
1470 if (clock_gettime(CLOCK_BOOTTIME, &ts) != 0) {
1471 HMI_ERROR("wm", "Could't set time (clock_gettime() returns with error");
1475 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Timer set activate");
1476 if (g_timer_ev_src == nullptr)
1478 // firsttime set into sd_event
1479 int ret = sd_event_add_time(afb_daemon_get_event_loop(), &g_timer_ev_src,
1480 CLOCK_BOOTTIME, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL, 1, processTimerHandler, this);
1483 HMI_ERROR("wm", "Could't set timer");
1488 // update timer limitation after second time
1489 sd_event_source_set_time(g_timer_ev_src, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL);
1490 sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_ONESHOT);
1494 void WindowManager::stopTimer()
1496 unsigned req_num = g_app_list.currentRequestNumber();
1497 HMI_SEQ_DEBUG(req_num, "Timer stop");
1498 int rc = sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_OFF);
1501 HMI_SEQ_ERROR(req_num, "Timer stop failed");
1505 void WindowManager::processNextRequest()
1508 g_app_list.reqDump();
1509 unsigned req_num = g_app_list.currentRequestNumber();
1510 if (g_app_list.haveRequest())
1512 HMI_SEQ_DEBUG(req_num, "Process next request");
1513 WMError rc = doTransition(req_num);
1514 if (rc != WMError::SUCCESS)
1516 HMI_SEQ_ERROR(req_num, errorDescription(rc));
1521 HMI_SEQ_DEBUG(req_num, "Nothing Request. Waiting Request");
1525 const char* WindowManager::convertRoleOldToNew(char const *old_role)
1527 const char *new_role = nullptr;
1529 for (auto const &on : this->roleold2new)
1531 std::regex regex = std::regex(on.first);
1532 if (std::regex_match(old_role, regex))
1534 // role is old. So convert to new.
1535 new_role = on.second.c_str();
1540 if (nullptr == new_role)
1542 // role is new or fallback.
1543 new_role = old_role;
1546 HMI_DEBUG("wm", "old:%s -> new:%s", old_role, new_role);
1551 int WindowManager::loadOldRoleDb()
1553 // Get afm application installed dir
1554 char const *afm_app_install_dir = getenv("AFM_APP_INSTALL_DIR");
1555 HMI_DEBUG("wm", "afm_app_install_dir:%s", afm_app_install_dir);
1557 std::string file_name;
1558 if (!afm_app_install_dir)
1560 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
1564 file_name = std::string(afm_app_install_dir) + std::string("/etc/old_roles.db");
1568 json_object* json_obj;
1569 int ret = jh::inputJsonFilie(file_name.c_str(), &json_obj);
1572 HMI_ERROR("wm", "Could not open old_role.db, so use default old_role information");
1573 json_obj = json_tokener_parse(kDefaultOldRoleDb);
1575 HMI_DEBUG("wm", "json_obj dump:%s", json_object_get_string(json_obj));
1578 json_object* json_cfg;
1579 if (!json_object_object_get_ex(json_obj, "old_roles", &json_cfg))
1581 HMI_ERROR("wm", "Parse Error!!");
1585 int len = json_object_array_length(json_cfg);
1586 HMI_DEBUG("wm", "json_cfg len:%d", len);
1587 HMI_DEBUG("wm", "json_cfg dump:%s", json_object_get_string(json_cfg));
1589 for (int i=0; i<len; i++)
1591 json_object* json_tmp = json_object_array_get_idx(json_cfg, i);
1593 const char* old_role = jh::getStringFromJson(json_tmp, "name");
1594 if (nullptr == old_role)
1596 HMI_ERROR("wm", "Parse Error!!");
1600 const char* new_role = jh::getStringFromJson(json_tmp, "new");
1601 if (nullptr == new_role)
1603 HMI_ERROR("wm", "Parse Error!!");
1607 this->roleold2new[old_role] = std::string(new_role);
1611 for(auto itr = this->roleold2new.begin();
1612 itr != this->roleold2new.end(); ++itr)
1614 HMI_DEBUG("wm", ">>> role old:%s new:%s",
1615 itr->first.c_str(), itr->second.c_str());
1618 // Release json_object
1619 json_object_put(json_obj);
1624 const char *WindowManager::check_surface_exist(const char *drawing_name)
1626 auto const &surface_id = this->lookup_id(drawing_name);
1629 return "Surface does not exist";
1632 if (!this->controller->surface_exists(*surface_id))
1634 return "Surface does not exist in controller!";
1637 auto layer_id = this->layers.get_layer_id(*surface_id);
1641 return "Surface is not on any layer!";
1644 auto o_state = *this->layers.get_layout_state(*surface_id);
1646 if (o_state == nullptr)
1648 return "Could not find layer for surface";
1651 HMI_DEBUG("wm", "surface %d is detected", *surface_id);
1655 bool WindowManager::can_split(struct LayoutState const &state, int new_id)
1657 if (state.main != -1 && state.main != new_id)
1659 auto new_id_layer = this->layers.get_layer_id(new_id).value();
1660 auto current_id_layer = this->layers.get_layer_id(state.main).value();
1662 // surfaces are on separate layers, don't bother.
1663 if (new_id_layer != current_id_layer)
1668 std::string const &new_id_str = this->lookup_name(new_id).value();
1669 std::string const &cur_id_str = this->lookup_name(state.main).value();
1671 auto const &layer = this->layers.get_layer(new_id_layer);
1673 HMI_DEBUG("wm", "layer info name: %s", layer->name.c_str());
1675 if (layer->layouts.empty())
1680 for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++)
1682 HMI_DEBUG("wm", "%d main_match '%s'", new_id_layer, i->main_match.c_str());
1683 auto rem = std::regex(i->main_match);
1684 if (std::regex_match(cur_id_str, rem))
1686 // build the second one only if the first already matched
1687 HMI_DEBUG("wm", "%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
1688 auto res = std::regex(i->sub_match);
1689 if (std::regex_match(new_id_str, res))
1691 HMI_DEBUG("wm", "layout matched!");
1701 const char* WindowManager::kDefaultOldRoleDb = "{ \
1704 \"name\": \"HomeScreen\", \
1705 \"new\": \"homescreen\" \
1708 \"name\": \"Music\", \
1709 \"new\": \"music\" \
1712 \"name\": \"MediaPlayer\", \
1713 \"new\": \"music\" \
1716 \"name\": \"Video\", \
1717 \"new\": \"video\" \
1720 \"name\": \"VideoPlayer\", \
1721 \"new\": \"video\" \
1724 \"name\": \"WebBrowser\", \
1725 \"new\": \"browser\" \
1728 \"name\": \"Radio\", \
1729 \"new\": \"radio\" \
1732 \"name\": \"Phone\", \
1733 \"new\": \"phone\" \
1736 \"name\": \"Navigation\", \
1740 \"name\": \"HVAC\", \
1744 \"name\": \"Settings\", \
1745 \"new\": \"settings\" \
1748 \"name\": \"Dashboard\", \
1749 \"new\": \"dashboard\" \
1752 \"name\": \"POI\", \
1756 \"name\": \"Mixer\", \
1757 \"new\": \"mixer\" \
1760 \"name\": \"Restriction\", \
1761 \"new\": \"restriction\" \
1764 \"name\": \"^OnScreen.*\", \
1765 \"new\": \"on_screen\" \
1773 void controller_hooks::surface_created(uint32_t surface_id)
1775 this->wmgr->surface_created(surface_id);
1778 void controller_hooks::surface_removed(uint32_t surface_id)
1780 this->wmgr->surface_removed(surface_id);
1783 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
1786 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,