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;
58 static WindowManager *g_context;
65 result<json> file_to_json(char const *filename)
68 std::ifstream i(filename);
71 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
72 j = default_layers_json;
82 struct result<layer_map> load_layer_map(char const *filename)
84 HMI_DEBUG("wm", "loading IDs from %s", filename);
86 auto j = file_to_json(filename);
89 return Err<layer_map>(j.unwrap_err());
91 json jids = j.unwrap();
93 return to_layer_map(jids);
96 static int processTimerHandler(sd_event_source *s, uint64_t usec, void *userdata)
98 HMI_NOTICE("wm", "Time out occurs because the client replys endDraw slow, so revert the request");
99 reinterpret_cast<wm::WindowManager *>(userdata)->timerHandler();
103 static void onStateTransitioned(std::vector<WMAction> actions)
105 g_context->startTransitionWrapper(actions);
108 static void onError()
110 g_context->processError(WMError::LAYOUT_CHANGE_FAIL);
117 WindowManager::WindowManager(wl::display *d)
124 pending_events(false)
126 char const *path_layers_json = getenv("AFM_APP_INSTALL_DIR");
128 if (!path_layers_json)
130 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
131 path = std::string(path_layers_json);
135 path = std::string(path_layers_json) + std::string("/etc/layers.json");
141 auto l = load_layer_map(path.c_str());
144 this->layers = l.unwrap();
148 HMI_ERROR("wm", "%s", l.err().value());
152 catch (std::exception &e)
154 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
158 int WindowManager::init()
160 if (!this->display->ok())
165 if (this->layers.mapping.empty())
167 HMI_ERROR("wm", "No surface -> layer mapping loaded");
171 // TODO: application requests by old role,
172 // so create role map (old, new)
174 this->loadOldRoleDb();
176 // Store my context for calling callback from PolicyManager
179 // Initialize PMWrapper
180 this->pmw.initialize();
182 // Register callback to PolicyManager
183 this->pmw.registerCallback(onStateTransitioned, onError);
186 for (int i = Event_Val_Min; i <= Event_Val_Max; i++)
188 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
191 this->display->add_global_handler(
192 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
193 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
196 this->display->add_global_handler(
197 "ivi_wm", [this](wl_registry *r, uint32_t name, uint32_t v) {
199 std::make_unique<struct compositor::controller>(r, name, v);
201 // Init controller hooks
202 this->controller->chooks = &this->chooks;
204 // This protocol needs the output, so lets just add our mapping here...
205 this->controller->add_proxy_to_id_mapping(
206 this->outputs.front()->proxy.get(),
207 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
208 this->outputs.front()->proxy.get())));
211 this->controller->create_screen(this->outputs.front()->proxy.get());
213 // Set display to controller
214 this->controller->display = this->display;
217 // First level objects
218 this->display->roundtrip();
219 // Second level objects
220 this->display->roundtrip();
221 // Third level objects
222 this->display->roundtrip();
224 return init_layers();
227 int WindowManager::dispatch_pending_events()
229 if (this->pop_pending_events())
231 this->display->dispatch_pending();
237 void WindowManager::set_pending_events()
239 this->pending_events.store(true, std::memory_order_release);
242 result<int> WindowManager::api_request_surface(char const *appid, char const *drawing_name)
244 // TODO: application requests by old role,
245 // so convert role old to new
246 const char *role = this->convertRoleOldToNew(drawing_name);
248 auto lid = this->layers.get_layer_id(std::string(role));
252 * register drawing_name as fallback and make it displayed.
254 lid = this->layers.get_layer_id(std::string("fallback"));
255 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
258 return Err<int>("Drawing name does not match any role, fallback is disabled");
262 auto rname = this->lookup_id(role);
265 // name does not exist yet, allocate surface id...
266 auto id = int(this->id_alloc.generate_id(role));
267 this->layers.add_surface(id, *lid);
269 // set the main_surface[_name] here and now
270 if (!this->layers.main_surface_name.empty() &&
271 this->layers.main_surface_name == drawing_name)
273 this->layers.main_surface = id;
274 HMI_DEBUG("wm", "Set main_surface id to %u", id);
277 // add client into the db
278 std::string appid_str(appid);
279 g_app_list.addClient(appid_str, *lid, id, std::string(role));
281 // Set role map of (new, old)
282 this->rolenew2old[role] = std::string(drawing_name);
287 // Check currently registered drawing names if it is already there.
288 return Err<int>("Surface already present");
291 char const *WindowManager::api_request_surface(char const *appid, char const *drawing_name,
296 // TODO: application requests by old role,
297 // so convert role old to new
298 const char *role = this->convertRoleOldToNew(drawing_name);
300 auto lid = this->layers.get_layer_id(std::string(role));
301 unsigned sid = std::stol(ivi_id);
306 * register drawing_name as fallback and make it displayed.
308 lid = this->layers.get_layer_id(std::string("fallback"));
309 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
312 return "Drawing name does not match any role, fallback is disabled";
316 auto rname = this->lookup_id(role);
320 return "Surface already present";
323 // register pair drawing_name and ivi_id
324 this->id_alloc.register_name_id(role, sid);
325 this->layers.add_surface(sid, *lid);
327 // this surface is already created
328 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
330 this->controller->layers[*lid]->add_surface(sid);
331 this->layout_commit();
333 // add client into the db
334 std::string appid_str(appid);
335 g_app_list.addClient(appid_str, *lid, sid, std::string(role));
337 // Set role map of (new, old)
338 this->rolenew2old[role] = std::string(drawing_name);
344 * This function is substitute of requestSurface
345 * If surface creation is faster than application request of this function,
346 * WM will bind surfaceID with application and role.
347 * If surface creation is slower than application request of thie function,
348 * WM will put Client into pending list.
351 * Application can request with pid but this is temporary solution for now.
352 * This will be removed.
354 bool WindowManager::api_set_role(char const *appid, char const *drawing_name, unsigned pid){
355 std::string id = appid;
356 std::string role = drawing_name;
357 unsigned surface = 0;
358 WMError wm_err = WMError::UNKNOWN;
361 // get layer ID which role should be in
362 auto lid = this->layers.get_layer_id(role);
366 * register drawing_name as fallback and make it displayed.
368 lid = this->layers.get_layer_id(std::string("fallback"));
369 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role.c_str());
372 HMI_ERROR("wm", "Drawing name does not match any role, fallback is disabled");
378 // search floating surfaceID from pid if pid is designated.
379 // It is not good that application request with its pid
380 wm_err = g_app_list.popFloatingSurface(pid, &surface);
383 // get floating surface with appid. If WM queries appid from pid,
384 // WM can bind surface and role with appid(not implemented yet)
385 //wm_err = g_app_list.popFloatingSurface(id);
387 if(wm_err != WMError::SUCCESS){
388 HMI_ERROR("wm", "No floating surface for app: %s", id.c_str());
389 g_app_list.addFloatingClient(id, *lid, role);
390 HMI_NOTICE("wm", "%s : Waiting for surface creation", id.c_str());
395 if (g_app_list.contains(id))
397 HMI_INFO("wm", "Add role: %s with surface: %d. Client %s has multi surfaces.",
398 role.c_str(), surface, id.c_str());
399 wm_err = g_app_list.appendRole(id, role, surface);
400 if(wm_err != WMError::SUCCESS){
401 HMI_INFO("wm", errorDescription(wm_err));
405 HMI_INFO("wm", "Create new client: %s, surface: %d into layer: %d with role: %s",
406 id.c_str(), surface, *lid, role.c_str());
407 g_app_list.addClient(id, *lid, surface, role);
410 // register pair drawing_name and ivi_id
411 this->id_alloc.register_name_id(role.c_str(), surface);
412 this->layers.add_surface(surface, *lid);
414 // this surface is already created
415 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface, *lid);
417 const auto &o_layer = this->layers.get_layer(*lid);
418 auto rect = o_layer.value().rect;
421 rect.w = this->controller->output_size.w + 1 + rect.w;
425 rect.h = this->controller->output_size.h + 1 + rect.h;
428 this->controller->layers[*lid]->add_surface(surface);
429 this->layout_commit();
434 void WindowManager::api_activate_surface(char const *appid, char const *drawing_name,
435 char const *drawing_area, const reply_func &reply)
439 // TODO: application requests by old role,
440 // so convert role old to new
441 const char *c_role = this->convertRoleOldToNew(drawing_name);
443 std::string id = appid;
444 std::string role = c_role;
445 std::string area = drawing_area;
447 if(!g_app_list.contains(id))
449 reply("app doesn't request 'requestSurface' or 'setRole' yet");
452 auto client = g_app_list.lookUpClient(id);
454 unsigned srfc = client->surfaceID(role);
457 HMI_ERROR("wm", "role sould be set with surface");
458 reply("role sould be set with surface");
461 g_app_list.removeFloatingSurface(client->surfaceID());
463 Task task = Task::TASK_ALLOCATE;
464 unsigned req_num = 0;
465 WMError ret = WMError::UNKNOWN;
467 ret = this->setRequest(id, role, area, task, &req_num);
469 if(ret != WMError::SUCCESS)
471 HMI_ERROR("wm", errorDescription(ret));
472 reply("Failed to set request");
477 if (req_num != g_app_list.currentRequestNumber())
479 // Add request, then invoked after the previous task is finished
480 HMI_SEQ_DEBUG(req_num, "request is accepted");
487 ret = this->doTransition(req_num);
489 if (ret != WMError::SUCCESS)
492 HMI_SEQ_ERROR(req_num, errorDescription(ret));
493 g_app_list.removeRequest(req_num);
494 this->processNextRequest();
498 void WindowManager::api_deactivate_surface(char const *appid, char const *drawing_name,
499 const reply_func &reply)
503 // TODO: application requests by old role,
504 // so convert role old to new
505 const char *c_role = this->convertRoleOldToNew(drawing_name);
510 std::string id = appid;
511 std::string role = c_role;
512 std::string area = ""; //drawing_area;
513 Task task = Task::TASK_RELEASE;
514 unsigned req_num = 0;
515 WMError ret = WMError::UNKNOWN;
517 ret = this->setRequest(id, role, area, task, &req_num);
519 if (ret != WMError::SUCCESS)
521 HMI_ERROR("wm", errorDescription(ret));
522 reply("Failed to set request");
527 if (req_num != g_app_list.currentRequestNumber())
529 // Add request, then invoked after the previous task is finished
530 HMI_SEQ_DEBUG(req_num, "request is accepted");
537 ret = this->doTransition(req_num);
539 if (ret != WMError::SUCCESS)
542 HMI_SEQ_ERROR(req_num, errorDescription(ret));
543 g_app_list.removeRequest(req_num);
544 this->processNextRequest();
548 void WindowManager::api_enddraw(char const *appid, char const *drawing_name)
550 // TODO: application requests by old role,
551 // so convert role old to new
552 const char *c_role = this->convertRoleOldToNew(drawing_name);
554 std::string id = appid;
555 std::string role = c_role;
556 unsigned current_req = g_app_list.currentRequestNumber();
557 bool result = g_app_list.setEndDrawFinished(current_req, id, role);
561 HMI_ERROR("wm", "%s is not in transition state", id.c_str());
565 if (g_app_list.endDrawFullfilled(current_req))
567 // do task for endDraw
569 WMError ret = this->doEndDraw(current_req);
571 if(ret != WMError::SUCCESS)
573 //this->emit_error();
575 // Undo state of PolicyManager
576 this->pmw.undoState();
578 this->emitScreenUpdated(current_req);
579 HMI_SEQ_INFO(current_req, "Finish request status: %s", errorDescription(ret));
581 g_app_list.removeRequest(current_req);
583 this->processNextRequest();
587 HMI_SEQ_INFO(current_req, "Wait other App call endDraw");
592 result<json_object *> WindowManager::api_get_display_info()
594 if (!this->display->ok())
596 return Err<json_object *>("Wayland compositor is not available");
600 compositor::size o_size = this->controller->output_size;
601 compositor::size p_size = this->controller->physical_size;
603 json_object *object = json_object_new_object();
604 json_object_object_add(object, kKeyWidthPixel, json_object_new_int(o_size.w));
605 json_object_object_add(object, kKeyHeightPixel, json_object_new_int(o_size.h));
606 json_object_object_add(object, kKeyWidthMm, json_object_new_int(p_size.w));
607 json_object_object_add(object, kKeyHeightMm, json_object_new_int(p_size.h));
608 json_object_object_add(object, kKeyScale, json_object_new_double(this->controller->scale));
610 return Ok<json_object *>(object);
613 result<json_object *> WindowManager::api_get_area_info(char const *drawing_name)
615 HMI_DEBUG("wm", "called");
617 // TODO: application requests by old role,
618 // so convert role old to new
619 const char *role = this->convertRoleOldToNew(drawing_name);
621 // Check drawing name, surface/layer id
622 auto const &surface_id = this->lookup_id(role);
625 return Err<json_object *>("Surface does not exist");
628 if (!this->controller->surface_exists(*surface_id))
630 return Err<json_object *>("Surface does not exist in controller!");
633 auto layer_id = this->layers.get_layer_id(*surface_id);
636 return Err<json_object *>("Surface is not on any layer!");
639 // Set area rectangle
640 compositor::rect area_info = this->area_info[*surface_id];
641 json_object *object = json_object_new_object();
642 json_object_object_add(object, kKeyX, json_object_new_int(area_info.x));
643 json_object_object_add(object, kKeyY, json_object_new_int(area_info.y));
644 json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w));
645 json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h));
647 return Ok<json_object *>(object);
650 void WindowManager::api_ping() { this->dispatch_pending_events(); }
652 void WindowManager::send_event(char const *evname, char const *label)
654 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
656 json_object *j = json_object_new_object();
657 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
659 int ret = afb_event_push(this->map_afb_event[evname], j);
662 HMI_DEBUG("wm", "afb_event_push failed: %m");
666 void WindowManager::send_event(char const *evname, char const *label, char const *area,
667 int x, int y, int w, int h)
669 HMI_DEBUG("wm", "%s: %s(%s, %s) x:%d y:%d w:%d h:%d",
670 __func__, evname, label, area, x, y, w, h);
672 json_object *j_rect = json_object_new_object();
673 json_object_object_add(j_rect, kKeyX, json_object_new_int(x));
674 json_object_object_add(j_rect, kKeyY, json_object_new_int(y));
675 json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w));
676 json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h));
678 json_object *j = json_object_new_object();
679 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
680 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
681 json_object_object_add(j, kKeyDrawingRect, j_rect);
683 int ret = afb_event_push(this->map_afb_event[evname], j);
686 HMI_DEBUG("wm", "afb_event_push failed: %m");
693 void WindowManager::surface_created(uint32_t surface_id)
695 this->controller->get_surface_properties(surface_id, IVI_WM_PARAM_SIZE);
697 auto layer_id = this->layers.get_layer_id(surface_id);
700 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
705 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
707 this->controller->layers[*layer_id]->add_surface(surface_id);
708 this->layout_commit();
711 void WindowManager::surface_removed(uint32_t surface_id)
713 HMI_DEBUG("wm", "Delete surface_id %u", surface_id);
714 this->id_alloc.remove_id(surface_id);
715 this->layers.remove_surface(surface_id);
716 g_app_list.removeSurface(surface_id);
719 void WindowManager::surface_properties(unsigned surface_id, unsigned pid)
721 HMI_DEBUG("wm", "get surface properties");
723 // search pid from surfaceID
724 /*json_object *response;
725 afb_service_call_sync("afm-main", "runners", nullptr, &response);
727 // retrieve appid from pid from application manager
728 std::string appid = "";
729 if(response == nullptr)
731 HMI_ERROR("wm", "No runners");
735 // check appid then add it to the client
736 HMI_INFO("wm", "Runners:%s", json_object_get_string(response));
737 int size = json_object_array_length(response);
738 for(int i = 0; i < size; i++)
740 json_object *j = json_object_array_get_idx(response, i);
741 const char* id = jh::getStringFromJson(j, "id");
742 int runid = jh::getIntFromJson(j, "runid");
743 if(id && (runid > 0))
753 json_object_put(response);
755 g_app_list.addFloatingSurface(appid, surface_id, pid);*/
758 void WindowManager::removeClient(const std::string &appid)
760 HMI_DEBUG("wm", "Remove clinet %s from list", appid.c_str());
761 g_app_list.removeClient(appid);
764 void WindowManager::exceptionProcessForTransition()
766 unsigned req_num = g_app_list.currentRequestNumber();
767 HMI_SEQ_NOTICE(req_num, "Process exception handling for request. Remove current request %d", req_num);
768 g_app_list.removeRequest(req_num);
769 HMI_SEQ_NOTICE(g_app_list.currentRequestNumber(), "Process next request if exists");
770 this->processNextRequest();
773 void WindowManager::timerHandler()
775 unsigned req_num = g_app_list.currentRequestNumber();
776 HMI_SEQ_DEBUG(req_num, "Timer expired remove Request");
777 g_app_list.reqDump();
778 g_app_list.removeRequest(req_num);
779 this->processNextRequest();
782 void WindowManager::startTransitionWrapper(std::vector<WMAction> &actions)
785 unsigned req_num = g_app_list.currentRequestNumber();
789 if (g_app_list.haveRequest())
791 HMI_SEQ_DEBUG(req_num, "There is no WMAction for this request");
792 goto proc_remove_request;
796 HMI_SEQ_DEBUG(req_num, "There is no request");
801 for (auto &act : actions)
806 auto const &surface_id = this->lookup_id(act.role.c_str());
807 std::string appid = g_app_list.getAppID(*surface_id, act.role, &found);
810 if (TaskVisible::INVISIBLE == act.visible)
812 // App is killed, so do not set this action
817 HMI_SEQ_ERROR(req_num, "appid which is visible is not found");
825 ret = g_app_list.setAction(req_num, act);
826 if (ret != WMError::SUCCESS)
828 HMI_SEQ_ERROR(req_num, "Setting action is failed");
833 HMI_SEQ_DEBUG(req_num, "Start transition.");
834 ret = this->startTransition(req_num);
835 if (ret != WMError::SUCCESS)
837 if (ret == WMError::NO_LAYOUT_CHANGE)
839 goto proc_remove_request;
843 HMI_SEQ_ERROR(req_num, "Transition state is failed");
852 HMI_SEQ_ERROR(req_num, errorDescription(ret));
853 this->pmw.undoState();
856 g_app_list.removeRequest(req_num);
857 this->processNextRequest();
860 void WindowManager::processError(WMError error)
862 unsigned req_num = g_app_list.currentRequestNumber();
865 HMI_SEQ_ERROR(req_num, errorDescription(error));
866 g_app_list.removeRequest(req_num);
867 this->processNextRequest();
871 ******* Private Functions *******
874 bool WindowManager::pop_pending_events()
877 return this->pending_events.compare_exchange_strong(
878 x, false, std::memory_order_consume);
881 optional<int> WindowManager::lookup_id(char const *name)
883 return this->id_alloc.lookup(std::string(name));
885 optional<std::string> WindowManager::lookup_name(int id)
887 return this->id_alloc.lookup(id);
893 int WindowManager::init_layers()
895 if (!this->controller)
897 HMI_ERROR("wm", "ivi_controller global not available");
901 if (this->outputs.empty())
903 HMI_ERROR("wm", "no output was set up!");
907 auto &c = this->controller;
909 auto &o = this->outputs.front();
910 auto &s = c->screens.begin()->second;
911 auto &layers = c->layers;
913 // Write output dimensions to ivi controller...
914 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
915 c->physical_size = compositor::size{uint32_t(o->physical_width),
916 uint32_t(o->physical_height)};
919 HMI_DEBUG("wm", "SCALING: screen (%dx%d), physical (%dx%d)",
920 o->width, o->height, o->physical_width, o->physical_height);
922 this->layers.loadAreaDb();
924 const compositor::rect css_bg = this->layers.getAreaSize("fullscreen");
925 rectangle dp_bg(o->width, o->height);
927 dp_bg.set_aspect(static_cast<double>(css_bg.w) / css_bg.h);
928 dp_bg.fit(o->width, o->height);
929 dp_bg.center(o->width, o->height);
930 HMI_DEBUG("wm", "SCALING: CSS BG(%dx%d) -> DDP %dx%d,(%dx%d)",
931 css_bg.w, css_bg.h, dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
939 // Quick and dirty setup of layers
940 for (auto const &i : this->layers.mapping)
942 c->layer_create(i.second.layer_id, dp_bg.width(), dp_bg.height());
943 auto &l = layers[i.second.layer_id];
944 l->set_destination_rectangle(dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
945 l->set_visibility(1);
946 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
947 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
950 // Add layers to screen
951 s->set_render_order(this->layers.layers);
953 this->layout_commit();
955 c->scale = static_cast<double>(dp_bg.height()) / css_bg.h;
956 this->layers.setupArea(c->scale);
961 void WindowManager::surface_set_layout(int surface_id, const std::string& area)
963 if (!this->controller->surface_exists(surface_id))
965 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
969 auto o_layer_id = this->layers.get_layer_id(surface_id);
973 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
977 uint32_t layer_id = *o_layer_id;
979 auto const &layer = this->layers.get_layer(layer_id);
980 auto rect = this->layers.getAreaSize(area);
981 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "%s : x:%d y:%d w:%d h:%d", area.c_str(),
982 rect.x, rect.y, rect.w, rect.h);
983 auto &s = this->controller->surfaces[surface_id];
990 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
993 // set destination to the display rectangle
994 s->set_destination_rectangle(x, y, w, h);
996 // update area information
997 this->area_info[surface_id].x = x;
998 this->area_info[surface_id].y = y;
999 this->area_info[surface_id].w = w;
1000 this->area_info[surface_id].h = h;
1002 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
1003 surface_id, layer_id, x, y, w, h);
1006 void WindowManager::layout_commit()
1008 this->controller->commit_changes();
1009 this->display->flush();
1012 void WindowManager::emit_activated(char const *label)
1014 this->send_event(kListEventName[Event_Active], label);
1017 void WindowManager::emit_deactivated(char const *label)
1019 this->send_event(kListEventName[Event_Inactive], label);
1022 void WindowManager::emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h)
1024 this->send_event(kListEventName[Event_SyncDraw], label, area, x, y, w, h);
1027 void WindowManager::emit_syncdraw(const std::string &role, const std::string &area)
1029 compositor::rect rect = this->layers.getAreaSize(area);
1030 this->send_event(kListEventName[Event_SyncDraw],
1031 role.c_str(), area.c_str(), rect.x, rect.y, rect.w, rect.h);
1034 void WindowManager::emit_flushdraw(char const *label)
1036 this->send_event(kListEventName[Event_FlushDraw], label);
1039 void WindowManager::emit_visible(char const *label, bool is_visible)
1041 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
1044 void WindowManager::emit_invisible(char const *label)
1046 return emit_visible(label, false);
1049 void WindowManager::emit_visible(char const *label) { return emit_visible(label, true); }
1051 void WindowManager::activate(int id)
1053 auto ip = this->controller->sprops.find(id);
1054 if (ip != this->controller->sprops.end())
1056 this->controller->surfaces[id]->set_visibility(1);
1058 this->lookup_name(id).value_or("unknown-name").c_str();
1061 if ((0 == strcmp(label, "radio")) ||
1062 (0 == strcmp(label, "music")) ||
1063 (0 == strcmp(label, "video")) ||
1064 (0 == strcmp(label, "map")))
1066 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i)
1071 this->surface_bg.erase(i);
1073 // Remove from BG layer (999)
1074 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
1075 this->controller->layers[999]->remove_surface(id);
1077 // Add to FG layer (1001)
1078 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
1079 this->controller->layers[1001]->add_surface(id);
1081 for (int j : this->surface_bg)
1083 HMI_DEBUG("wm", "Stored id:%d", j);
1091 this->layout_commit();
1093 // TODO: application requests by old role,
1094 // so convert role new to old for emitting event
1095 const char* old_role = this->rolenew2old[label].c_str();
1097 this->emit_visible(old_role);
1098 this->emit_activated(old_role);
1102 void WindowManager::deactivate(int id)
1104 auto ip = this->controller->sprops.find(id);
1105 if (ip != this->controller->sprops.end())
1108 this->lookup_name(id).value_or("unknown-name").c_str();
1111 if ((0 == strcmp(label, "radio")) ||
1112 (0 == strcmp(label, "music")) ||
1113 (0 == strcmp(label, "video")) ||
1114 (0 == strcmp(label, "map")))
1118 this->surface_bg.push_back(id);
1120 // Remove from FG layer (1001)
1121 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
1122 this->controller->layers[1001]->remove_surface(id);
1124 // Add to BG layer (999)
1125 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
1126 this->controller->layers[999]->add_surface(id);
1128 for (int j : surface_bg)
1130 HMI_DEBUG("wm", "Stored id:%d", j);
1135 this->controller->surfaces[id]->set_visibility(0);
1139 this->layout_commit();
1141 // TODO: application requests by old role,
1142 // so convert role new to old for emitting event
1143 const char* old_role = this->rolenew2old[label].c_str();
1145 this->emit_deactivated(old_role);
1146 this->emit_invisible(old_role);
1150 WMError WindowManager::setRequest(const std::string& appid, const std::string &role, const std::string &area,
1151 Task task, unsigned* req_num)
1153 if (!g_app_list.contains(appid))
1155 return WMError::NOT_REGISTERED;
1158 auto client = g_app_list.lookUpClient(appid);
1163 unsigned current = g_app_list.currentRequestNumber();
1164 unsigned requested_num = g_app_list.getRequestNumber(appid);
1165 if (requested_num != 0)
1167 HMI_SEQ_INFO(requested_num,
1168 "%s %s %s request is already queued", appid.c_str(), role.c_str(), area.c_str());
1169 return REQ_REJECTED;
1172 WMRequest req = WMRequest(appid, role, area, task);
1173 unsigned new_req = g_app_list.addRequest(req);
1175 g_app_list.reqDump();
1177 HMI_SEQ_DEBUG(current, "%s start sequence with %s, %s", appid.c_str(), role.c_str(), area.c_str());
1179 return WMError::SUCCESS;
1182 WMError WindowManager::doTransition(unsigned req_num)
1184 HMI_SEQ_DEBUG(req_num, "check policy");
1185 WMError ret = this->checkPolicy(req_num);
1189 WMError WindowManager::checkPolicy(unsigned req_num)
1194 // get current trigger
1196 WMError ret = WMError::LAYOUT_CHANGE_FAIL;
1197 auto trigger = g_app_list.getRequest(req_num, &found);
1200 ret = WMError::NO_ENTRY;
1203 std::string req_area = trigger.area;
1205 if (trigger.task == Task::TASK_ALLOCATE)
1207 const char *msg = this->check_surface_exist(trigger.role.c_str());
1211 HMI_SEQ_ERROR(req_num, msg);
1216 // Input event data to PolicyManager
1217 if (0 > this->pmw.setInputEventData(trigger.task, trigger.role, trigger.area))
1219 HMI_SEQ_ERROR(req_num, "Failed to set input event data to PolicyManager");
1223 // Execute state transition of PolicyManager
1224 if (0 > this->pmw.executeStateTransition())
1226 HMI_SEQ_ERROR(req_num, "Failed to execute state transition of PolicyManager");
1230 ret = WMError::SUCCESS;
1232 g_app_list.reqDump();
1237 WMError WindowManager::startTransition(unsigned req_num)
1239 bool sync_draw_happen = false;
1241 WMError ret = WMError::SUCCESS;
1242 auto actions = g_app_list.getActions(req_num, &found);
1245 ret = WMError::NO_ENTRY;
1246 HMI_SEQ_ERROR(req_num,
1247 "Window Manager bug :%s : Action is not set", errorDescription(ret));
1251 for (const auto &action : actions)
1253 if (action.visible == TaskVisible::VISIBLE)
1255 sync_draw_happen = true;
1257 // TODO: application requests by old role,
1258 // so convert role new to old for emitting event
1259 std::string old_role = this->rolenew2old[action.role];
1261 this->emit_syncdraw(old_role, action.area);
1262 /* TODO: emit event for app not subscriber
1263 if(g_app_list.contains(y.appid))
1264 g_app_list.lookUpClient(y.appid)->emit_syncdraw(y.role, y.area); */
1268 if (sync_draw_happen)
1274 // deactivate only, no syncDraw
1275 // Make it deactivate here
1276 for (const auto &x : actions)
1278 if (g_app_list.contains(x.appid))
1280 auto client = g_app_list.lookUpClient(x.appid);
1281 this->deactivate(client->surfaceID(x.role));
1284 ret = WMError::NO_LAYOUT_CHANGE;
1289 WMError WindowManager::doEndDraw(unsigned req_num)
1293 auto actions = g_app_list.getActions(req_num, &found);
1294 WMError ret = WMError::SUCCESS;
1297 ret = WMError::NO_ENTRY;
1301 HMI_SEQ_INFO(req_num, "do endDraw");
1303 // layout change and make it visible
1304 for (const auto &act : actions)
1306 if(act.visible != TaskVisible::NO_CHANGE)
1309 if(!g_app_list.contains(act.appid)){
1310 ret = WMError::NOT_REGISTERED;
1312 ret = this->layoutChange(act);
1313 if(ret != WMError::SUCCESS)
1315 HMI_SEQ_WARNING(req_num,
1316 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1319 ret = this->visibilityChange(act);
1320 if (ret != WMError::SUCCESS)
1322 HMI_SEQ_WARNING(req_num,
1323 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1326 HMI_SEQ_DEBUG(req_num, "visible %s", act.role.c_str());
1327 //this->lm_enddraw(act.role.c_str());
1330 this->layout_commit();
1332 HMI_SEQ_INFO(req_num, "emit flushDraw");
1334 for(const auto &act_flush : actions)
1336 if(act_flush.visible == TaskVisible::VISIBLE)
1338 // TODO: application requests by old role,
1339 // so convert role new to old for emitting event
1340 std::string old_role = this->rolenew2old[act_flush.role];
1342 this->emit_flushdraw(old_role.c_str());
1349 WMError WindowManager::layoutChange(const WMAction &action)
1351 if (action.visible == TaskVisible::INVISIBLE)
1353 // Visibility is not change -> no redraw is required
1354 return WMError::SUCCESS;
1356 auto client = g_app_list.lookUpClient(action.appid);
1357 unsigned surface = client->surfaceID(action.role);
1360 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1361 "client doesn't have surface with role(%s)", action.role.c_str());
1362 return WMError::NOT_REGISTERED;
1365 WMError ret = this->setSurfaceSize(surface, action.area);
1369 WMError WindowManager::visibilityChange(const WMAction &action)
1371 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Change visibility");
1372 if(!g_app_list.contains(action.appid)){
1373 return WMError::NOT_REGISTERED;
1375 auto client = g_app_list.lookUpClient(action.appid);
1376 unsigned surface = client->surfaceID(action.role);
1379 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1380 "client doesn't have surface with role(%s)", action.role.c_str());
1381 return WMError::NOT_REGISTERED;
1384 if (action.visible != TaskVisible::INVISIBLE)
1386 this->activate(surface); // Layout Manager task
1390 this->deactivate(surface); // Layout Manager task
1392 return WMError::SUCCESS;
1395 WMError WindowManager::setSurfaceSize(unsigned surface, const std::string &area)
1397 this->surface_set_layout(surface, area);
1399 return WMError::SUCCESS;
1402 void WindowManager::emitScreenUpdated(unsigned req_num)
1405 HMI_SEQ_DEBUG(req_num, "emit screen updated");
1407 auto actions = g_app_list.getActions(req_num, &found);
1409 // create json object
1410 json_object *j = json_object_new_object();
1411 json_object *jarray = json_object_new_array();
1413 for(const auto& action: actions)
1415 if(action.visible != TaskVisible::INVISIBLE)
1417 json_object_array_add(jarray, json_object_new_string(action.appid.c_str()));
1420 json_object_object_add(j, kKeyIds, jarray);
1421 HMI_SEQ_INFO(req_num, "Visible app: %s", json_object_get_string(j));
1423 int ret = afb_event_push(
1424 this->map_afb_event[kListEventName[Event_ScreenUpdated]], j);
1427 HMI_DEBUG("wm", "afb_event_push failed: %m");
1431 void WindowManager::setTimer()
1434 if (clock_gettime(CLOCK_BOOTTIME, &ts) != 0) {
1435 HMI_ERROR("wm", "Could't set time (clock_gettime() returns with error");
1439 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Timer set activate");
1440 if (g_timer_ev_src == nullptr)
1442 // firsttime set into sd_event
1443 int ret = sd_event_add_time(afb_daemon_get_event_loop(), &g_timer_ev_src,
1444 CLOCK_BOOTTIME, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL, 1, processTimerHandler, this);
1447 HMI_ERROR("wm", "Could't set timer");
1452 // update timer limitation after second time
1453 sd_event_source_set_time(g_timer_ev_src, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL);
1454 sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_ONESHOT);
1458 void WindowManager::stopTimer()
1460 unsigned req_num = g_app_list.currentRequestNumber();
1461 HMI_SEQ_DEBUG(req_num, "Timer stop");
1462 int rc = sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_OFF);
1465 HMI_SEQ_ERROR(req_num, "Timer stop failed");
1469 void WindowManager::processNextRequest()
1472 g_app_list.reqDump();
1473 unsigned req_num = g_app_list.currentRequestNumber();
1474 if (g_app_list.haveRequest())
1476 HMI_SEQ_DEBUG(req_num, "Process next request");
1477 WMError rc = doTransition(req_num);
1478 if (rc != WMError::SUCCESS)
1480 HMI_SEQ_ERROR(req_num, errorDescription(rc));
1485 HMI_SEQ_DEBUG(req_num, "Nothing Request. Waiting Request");
1489 const char* WindowManager::convertRoleOldToNew(char const *old_role)
1491 const char *new_role = nullptr;
1493 for (auto const &on : this->roleold2new)
1495 std::regex regex = std::regex(on.first);
1496 if (std::regex_match(old_role, regex))
1498 // role is old. So convert to new.
1499 new_role = on.second.c_str();
1504 if (nullptr == new_role)
1506 // role is new or fallback.
1507 new_role = old_role;
1510 HMI_DEBUG("wm", "old:%s -> new:%s", old_role, new_role);
1515 int WindowManager::loadOldRoleDb()
1517 // Get afm application installed dir
1518 char const *afm_app_install_dir = getenv("AFM_APP_INSTALL_DIR");
1519 HMI_DEBUG("wm", "afm_app_install_dir:%s", afm_app_install_dir);
1521 std::string file_name;
1522 if (!afm_app_install_dir)
1524 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
1528 file_name = std::string(afm_app_install_dir) + std::string("/etc/old_roles.db");
1532 json_object* json_obj;
1533 int ret = jh::inputJsonFilie(file_name.c_str(), &json_obj);
1536 HMI_ERROR("wm", "Could not open old_role.db, so use default old_role information");
1537 json_obj = json_tokener_parse(kDefaultOldRoleDb);
1539 HMI_DEBUG("wm", "json_obj dump:%s", json_object_get_string(json_obj));
1542 json_object* json_cfg;
1543 if (!json_object_object_get_ex(json_obj, "old_roles", &json_cfg))
1545 HMI_ERROR("wm", "Parse Error!!");
1549 int len = json_object_array_length(json_cfg);
1550 HMI_DEBUG("wm", "json_cfg len:%d", len);
1551 HMI_DEBUG("wm", "json_cfg dump:%s", json_object_get_string(json_cfg));
1553 for (int i=0; i<len; i++)
1555 json_object* json_tmp = json_object_array_get_idx(json_cfg, i);
1557 const char* old_role = jh::getStringFromJson(json_tmp, "name");
1558 if (nullptr == old_role)
1560 HMI_ERROR("wm", "Parse Error!!");
1564 const char* new_role = jh::getStringFromJson(json_tmp, "new");
1565 if (nullptr == new_role)
1567 HMI_ERROR("wm", "Parse Error!!");
1571 this->roleold2new[old_role] = std::string(new_role);
1575 for(auto itr = this->roleold2new.begin();
1576 itr != this->roleold2new.end(); ++itr)
1578 HMI_DEBUG("wm", ">>> role old:%s new:%s",
1579 itr->first.c_str(), itr->second.c_str());
1582 // Release json_object
1583 json_object_put(json_obj);
1588 const char *WindowManager::check_surface_exist(const char *drawing_name)
1590 auto const &surface_id = this->lookup_id(drawing_name);
1593 return "Surface does not exist";
1596 if (!this->controller->surface_exists(*surface_id))
1598 return "Surface does not exist in controller!";
1601 auto layer_id = this->layers.get_layer_id(*surface_id);
1605 return "Surface is not on any layer!";
1608 HMI_DEBUG("wm", "surface %d is detected", *surface_id);
1612 const char* WindowManager::kDefaultOldRoleDb = "{ \
1615 \"name\": \"HomeScreen\", \
1616 \"new\": \"homescreen\" \
1619 \"name\": \"Music\", \
1620 \"new\": \"music\" \
1623 \"name\": \"MediaPlayer\", \
1624 \"new\": \"music\" \
1627 \"name\": \"Video\", \
1628 \"new\": \"video\" \
1631 \"name\": \"VideoPlayer\", \
1632 \"new\": \"video\" \
1635 \"name\": \"WebBrowser\", \
1636 \"new\": \"browser\" \
1639 \"name\": \"Radio\", \
1640 \"new\": \"radio\" \
1643 \"name\": \"Phone\", \
1644 \"new\": \"phone\" \
1647 \"name\": \"Navigation\", \
1651 \"name\": \"HVAC\", \
1655 \"name\": \"Settings\", \
1656 \"new\": \"settings\" \
1659 \"name\": \"Dashboard\", \
1660 \"new\": \"dashboard\" \
1663 \"name\": \"POI\", \
1667 \"name\": \"Mixer\", \
1668 \"new\": \"mixer\" \
1671 \"name\": \"Restriction\", \
1672 \"new\": \"restriction\" \
1675 \"name\": \"^OnScreen.*\", \
1676 \"new\": \"on_screen\" \
1684 void controller_hooks::surface_created(uint32_t surface_id)
1686 this->wmgr->surface_created(surface_id);
1689 void controller_hooks::surface_removed(uint32_t surface_id)
1691 this->wmgr->surface_removed(surface_id);
1694 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
1697 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,
1703 void controller_hooks::surface_properties(uint32_t surface_id, uint32_t pid)
1705 this->wmgr->surface_properties(surface_id, pid);