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>
35 static const uint64_t kTimeOut = 3ULL; /* 3s */
37 /* DrawingArea name used by "{layout}.{area}" */
38 const char kNameLayoutNormal[] = "normal";
39 const char kNameLayoutSplit[] = "split";
40 const char kNameAreaFull[] = "full";
41 const char kNameAreaMain[] = "main";
42 const char kNameAreaSub[] = "sub";
44 /* Key for json obejct */
45 const char kKeyDrawingName[] = "drawing_name";
46 const char kKeyDrawingArea[] = "drawing_area";
47 const char kKeyDrawingRect[] = "drawing_rect";
48 const char kKeyX[] = "x";
49 const char kKeyY[] = "y";
50 const char kKeyWidth[] = "width";
51 const char kKeyHeight[] = "height";
52 const char kKeyWidthPixel[] = "width_pixel";
53 const char kKeyHeightPixel[] = "height_pixel";
54 const char kKeyWidthMm[] = "width_mm";
55 const char kKeyHeightMm[] = "height_mm";
56 const char kKeyScale[] = "scale";
57 const char kKeyIds[] = "ids";
59 static sd_event_source *g_timer_ev_src = nullptr;
60 static AppList g_app_list;
61 static WindowManager *g_context;
68 result<json> file_to_json(char const *filename)
71 std::ifstream i(filename);
74 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
75 j = default_layers_json;
85 struct result<layer_map> load_layer_map(char const *filename)
87 HMI_DEBUG("wm", "loading IDs from %s", filename);
89 auto j = file_to_json(filename);
92 return Err<layer_map>(j.unwrap_err());
94 json jids = j.unwrap();
96 return to_layer_map(jids);
99 static int processTimerHandler(sd_event_source *s, uint64_t usec, void *userdata)
101 HMI_NOTICE("wm", "Time out occurs because the client replys endDraw slow, so revert the request");
102 reinterpret_cast<wm::WindowManager *>(userdata)->timerHandler();
106 static void onStateTransitioned(vector<WMAction> actions)
108 g_context->startTransitionWrapper(actions);
111 static void onError()
113 g_context->processError(WMError::LAYOUT_CHANGE_FAIL);
120 WindowManager::WindowManager(wl::display *d)
127 pending_events(false)
129 const char *path = getenv("AFM_APP_INSTALL_DIR");
130 string lm_setting_path = path;
133 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
137 lm_setting_path += "/etc/layers_setting.json";
139 this->lm = std::make_shared<LayerControl>(lm_setting_path);
144 auto l = load_layer_map(path.c_str());
147 this->layers = l.unwrap();
151 HMI_ERROR("wm", "%s", l.err().value());
155 catch (std::exception &e)
157 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
161 int WindowManager::init()
163 if (!this->display->ok())
168 if (this->layers.mapping.empty())
170 HMI_ERROR("wm", "No surface -> layer mapping loaded");
174 // TODO: application requests by old role,
175 // so create role map (old, new)
177 this->loadOldRoleDb();
179 // Store my context for calling callback from PolicyManager
182 // Initialize PMWrapper
183 this->pmw.initialize();
185 // Register callback to PolicyManager
186 this->pmw.registerCallback(onStateTransitioned, onError);
189 for (int i = Event_Val_Min; i <= Event_Val_Max; i++)
191 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
194 this->display->add_global_handler(
195 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
196 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
199 this->display->add_global_handler(
200 "ivi_wm", [this](wl_registry *r, uint32_t name, uint32_t v) {
202 std::make_unique<struct compositor::controller>(r, name, v);
204 // Init controller hooks
205 this->controller->chooks = &this->chooks;
207 // This protocol needs the output, so lets just add our mapping here...
208 this->controller->add_proxy_to_id_mapping(
209 this->outputs.front()->proxy.get(),
210 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
211 this->outputs.front()->proxy.get())));
214 this->controller->create_screen(this->outputs.front()->proxy.get());
216 // Set display to controller
217 this->controller->display = this->display;
220 // First level objects
221 this->display->roundtrip();
222 // Second level objects
223 this->display->roundtrip();
224 // Third level objects
225 this->display->roundtrip();
227 return init_layers();
230 int WindowManager::dispatch_pending_events()
232 if (this->pop_pending_events())
234 this->display->dispatch_pending();
240 void WindowManager::set_pending_events()
242 this->pending_events.store(true, std::memory_order_release);
245 result<int> WindowManager::api_request_surface(char const *appid, char const *drawing_name)
247 // TODO: application requests by old role,
248 // so convert role old to new
249 const char *role = this->convertRoleOldToNew(drawing_name);
251 auto lid = this->layers.get_layer_id(string(role));
252 unsigned l_id = this->lm->getNewLayerID(role);
256 * register drawing_name as fallback and make it displayed.
258 lid = this->layers.get_layer_id(string("fallback"));
259 l_id = this->lm->getNewLayerID("fallback");
260 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
263 return Err<int>("Drawing name does not match any role, fallback is disabled");
267 // generate surface ID for ivi-shell application
269 // auto rname = this->lookup_id(role);
272 // name does not exist yet, allocate surface id...
273 auto id = int(this->id_alloc.generate_id(role));
274 // this->layers.add_surface(id, *lid);
276 // set the main_surface[_name] here and now
277 // if (!this->layers.main_surface_name.empty() &&
278 // this->layers.main_surface_name == drawing_name)
280 // this->layers.main_surface = id;
281 // HMI_DEBUG("wm", "Set main_surface id to %u", id);
284 // add client into the db
285 string appid_str(appid);
286 if(g_app_list.contains(appid_str))
288 // add surface into app
289 auto client = g_app_list.lookUpClient(appid_str);
290 // client.addSurface(id);
294 g_app_list.addClient(appid_str, l_id, id, string(role));
297 // Set role map of (new, old)
298 this->rolenew2old[role] = string(drawing_name);
303 // Check currently registered drawing names if it is already there.
304 return Err<int>("Surface already present");
307 char const *WindowManager::api_request_surface(char const *appid, char const *drawing_name,
312 // TODO: application requests by old role,
313 // so convert role old to new
314 const char *role = this->convertRoleOldToNew(drawing_name);
316 auto lid = this->layers.get_layer_id(string(role));
317 unsigned sid = std::stol(ivi_id);
322 * register drawing_name as fallback and make it displayed.
324 lid = this->layers.get_layer_id(string("fallback"));
325 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role);
328 return "Drawing name does not match any role, fallback is disabled";
332 auto rname = this->lookup_id(role);
336 return "Surface already present";
339 // register pair drawing_name and ivi_id
340 this->id_alloc.register_name_id(role, sid);
341 this->layers.add_surface(sid, *lid);
343 // this surface is already created
344 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
346 this->controller->layers[*lid]->add_surface(sid);
347 this->layout_commit();
349 // add client into the db
350 string appid_str(appid);
351 g_app_list.addClient(appid_str, *lid, sid, string(role));
353 // Set role map of (new, old)
354 this->rolenew2old[role] = string(drawing_name);
360 * This function is substitute of requestSurface
361 * If surface creation is faster than application request of this function,
362 * WM will bind surfaceID with application and role.
363 * If surface creation is slower than application request of thie function,
364 * WM will put Client into pending list.
367 * Application can request with pid but this is temporary solution for now.
368 * This will be removed.
370 bool WindowManager::api_set_role(char const *appid, char const *drawing_name, unsigned pid){
372 string role = drawing_name;
373 unsigned surface = 0;
374 WMError wm_err = WMError::UNKNOWN;
377 // get layer ID which role should be in
378 auto lid = this->layers.get_layer_id(role);
382 * register drawing_name as fallback and make it displayed.
384 lid = this->layers.get_layer_id(string("fallback"));
385 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", role.c_str());
388 HMI_ERROR("wm", "Drawing name does not match any role, fallback is disabled");
394 // search floating surfaceID from pid if pid is designated.
395 // It is not good that application request with its pid
396 wm_err = g_app_list.popFloatingSurface(pid, &surface);
399 // get floating surface with appid. If WM queries appid from pid,
400 // WM can bind surface and role with appid(not implemented yet)
401 //wm_err = g_app_list.popFloatingSurface(id);
403 if(wm_err != WMError::SUCCESS){
404 HMI_ERROR("wm", "No floating surface for app: %s", id.c_str());
405 g_app_list.addFloatingClient(id, *lid, role);
406 HMI_NOTICE("wm", "%s : Waiting for surface creation", id.c_str());
411 if (g_app_list.contains(id))
413 HMI_INFO("wm", "Add role: %s with surface: %d. Client %s has multi surfaces.",
414 role.c_str(), surface, id.c_str());
415 wm_err = g_app_list.appendRole(id, role, surface);
416 if(wm_err != WMError::SUCCESS){
417 HMI_INFO("wm", errorDescription(wm_err));
421 HMI_INFO("wm", "Create new client: %s, surface: %d into layer: %d with role: %s",
422 id.c_str(), surface, *lid, role.c_str());
423 g_app_list.addClient(id, *lid, surface, role);
426 // register pair drawing_name and ivi_id
427 this->id_alloc.register_name_id(role.c_str(), surface);
428 this->layers.add_surface(surface, *lid);
430 // this surface is already created
431 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface, *lid);
433 const auto &o_layer = this->layers.get_layer(*lid);
434 auto rect = o_layer.value().rect;
437 rect.w = this->controller->output_size.w + 1 + rect.w;
441 rect.h = this->controller->output_size.h + 1 + rect.h;
444 this->controller->layers[*lid]->add_surface(surface);
445 this->layout_commit();
450 void WindowManager::api_activate_surface(char const *appid, char const *drawing_name,
451 char const *drawing_area, const reply_func &reply)
455 // TODO: application requests by old role,
456 // so convert role old to new
457 const char *c_role = this->convertRoleOldToNew(drawing_name);
460 string role = c_role;
461 string area = drawing_area;
463 if(!g_app_list.contains(id))
465 reply("app doesn't request 'requestSurface' or 'setRole' yet");
468 auto client = g_app_list.lookUpClient(id);
470 unsigned srfc = client->surfaceID(role);
473 HMI_ERROR("wm", "role sould be set with surface");
474 reply("role sould be set with surface");
477 g_app_list.removeFloatingSurface(client->surfaceID());
479 Task task = Task::TASK_ALLOCATE;
480 unsigned req_num = 0;
481 WMError ret = WMError::UNKNOWN;
483 ret = this->setRequest(id, role, area, task, &req_num);
485 if(ret != WMError::SUCCESS)
487 HMI_ERROR("wm", errorDescription(ret));
488 reply("Failed to set request");
493 if (req_num != g_app_list.currentRequestNumber())
495 // Add request, then invoked after the previous task is finished
496 HMI_SEQ_DEBUG(req_num, "request is accepted");
503 ret = this->doTransition(req_num);
505 if (ret != WMError::SUCCESS)
508 HMI_SEQ_ERROR(req_num, errorDescription(ret));
509 g_app_list.removeRequest(req_num);
510 this->processNextRequest();
514 void WindowManager::api_deactivate_surface(char const *appid, char const *drawing_name,
515 const reply_func &reply)
519 // TODO: application requests by old role,
520 // so convert role old to new
521 const char *c_role = this->convertRoleOldToNew(drawing_name);
527 string role = c_role;
528 string area = ""; //drawing_area;
529 Task task = Task::TASK_RELEASE;
530 unsigned req_num = 0;
531 WMError ret = WMError::UNKNOWN;
533 ret = this->setRequest(id, role, area, task, &req_num);
535 if (ret != WMError::SUCCESS)
537 HMI_ERROR("wm", errorDescription(ret));
538 reply("Failed to set request");
543 if (req_num != g_app_list.currentRequestNumber())
545 // Add request, then invoked after the previous task is finished
546 HMI_SEQ_DEBUG(req_num, "request is accepted");
553 ret = this->doTransition(req_num);
555 if (ret != WMError::SUCCESS)
558 HMI_SEQ_ERROR(req_num, errorDescription(ret));
559 g_app_list.removeRequest(req_num);
560 this->processNextRequest();
564 void WindowManager::api_enddraw(char const *appid, char const *drawing_name)
566 // TODO: application requests by old role,
567 // so convert role old to new
568 const char *c_role = this->convertRoleOldToNew(drawing_name);
571 string role = c_role;
572 unsigned current_req = g_app_list.currentRequestNumber();
573 bool result = g_app_list.setEndDrawFinished(current_req, id, role);
577 HMI_ERROR("wm", "%s is not in transition state", id.c_str());
581 if (g_app_list.endDrawFullfilled(current_req))
583 // do task for endDraw
585 WMError ret = this->doEndDraw(current_req);
587 if(ret != WMError::SUCCESS)
589 //this->emit_error();
591 // Undo state of PolicyManager
592 this->pmw.undoState();
594 this->emitScreenUpdated(current_req);
595 HMI_SEQ_INFO(current_req, "Finish request status: %s", errorDescription(ret));
597 g_app_list.removeRequest(current_req);
599 this->processNextRequest();
603 HMI_SEQ_INFO(current_req, "Wait other App call endDraw");
608 result<json_object *> WindowManager::api_get_display_info()
610 if (!this->display->ok())
612 return Err<json_object *>("Wayland compositor is not available");
616 compositor::size o_size = this->controller->output_size;
617 compositor::size p_size = this->controller->physical_size;
619 json_object *object = json_object_new_object();
620 json_object_object_add(object, kKeyWidthPixel, json_object_new_int(o_size.w));
621 json_object_object_add(object, kKeyHeightPixel, json_object_new_int(o_size.h));
622 json_object_object_add(object, kKeyWidthMm, json_object_new_int(p_size.w));
623 json_object_object_add(object, kKeyHeightMm, json_object_new_int(p_size.h));
624 json_object_object_add(object, kKeyScale, json_object_new_double(this->controller->scale));
626 return Ok<json_object *>(object);
629 result<json_object *> WindowManager::api_get_area_info(char const *drawing_name)
631 HMI_DEBUG("wm", "called");
633 // TODO: application requests by old role,
634 // so convert role old to new
635 const char *role = this->convertRoleOldToNew(drawing_name);
637 // Check drawing name, surface/layer id
638 auto const &surface_id = this->lookup_id(role);
641 return Err<json_object *>("Surface does not exist");
644 if (!this->controller->surface_exists(*surface_id))
646 return Err<json_object *>("Surface does not exist in controller!");
649 auto layer_id = this->layers.get_layer_id(*surface_id);
652 return Err<json_object *>("Surface is not on any layer!");
655 // Set area rectangle
656 compositor::rect area_info = this->area_info[*surface_id];
657 json_object *object = json_object_new_object();
658 json_object_object_add(object, kKeyX, json_object_new_int(area_info.x));
659 json_object_object_add(object, kKeyY, json_object_new_int(area_info.y));
660 json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w));
661 json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h));
663 return Ok<json_object *>(object);
666 void WindowManager::api_ping() { this->dispatch_pending_events(); }
668 void WindowManager::send_event(char const *evname, char const *label)
670 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
672 json_object *j = json_object_new_object();
673 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
675 int ret = afb_event_push(this->map_afb_event[evname], j);
678 HMI_DEBUG("wm", "afb_event_push failed: %m");
682 void WindowManager::send_event(char const *evname, char const *label, char const *area,
683 int x, int y, int w, int h)
685 HMI_DEBUG("wm", "%s: %s(%s, %s) x:%d y:%d w:%d h:%d",
686 __func__, evname, label, area, x, y, w, h);
688 json_object *j_rect = json_object_new_object();
689 json_object_object_add(j_rect, kKeyX, json_object_new_int(x));
690 json_object_object_add(j_rect, kKeyY, json_object_new_int(y));
691 json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w));
692 json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h));
694 json_object *j = json_object_new_object();
695 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
696 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
697 json_object_object_add(j, kKeyDrawingRect, j_rect);
699 int ret = afb_event_push(this->map_afb_event[evname], j);
702 HMI_DEBUG("wm", "afb_event_push failed: %m");
709 void WindowManager::surface_created(uint32_t surface_id)
711 this->controller->get_surface_properties(surface_id, IVI_WM_PARAM_SIZE);
713 auto layer_id = this->layers.get_layer_id(surface_id);
716 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
721 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
723 this->controller->layers[*layer_id]->add_surface(surface_id);
724 this->layout_commit();
727 void WindowManager::surface_removed(uint32_t surface_id)
729 HMI_DEBUG("wm", "Delete surface_id %u", surface_id);
730 this->id_alloc.remove_id(surface_id);
731 this->layers.remove_surface(surface_id);
732 g_app_list.removeSurface(surface_id);
735 void WindowManager::surface_properties(unsigned surface_id, unsigned pid)
737 HMI_DEBUG("wm", "get surface properties");
739 // search pid from surfaceID
740 /*json_object *response;
741 afb_service_call_sync("afm-main", "runners", nullptr, &response);
743 // retrieve appid from pid from application manager
745 if(response == nullptr)
747 HMI_ERROR("wm", "No runners");
751 // check appid then add it to the client
752 HMI_INFO("wm", "Runners:%s", json_object_get_string(response));
753 int size = json_object_array_length(response);
754 for(int i = 0; i < size; i++)
756 json_object *j = json_object_array_get_idx(response, i);
757 const char* id = jh::getStringFromJson(j, "id");
758 int runid = jh::getIntFromJson(j, "runid");
759 if(id && (runid > 0))
769 json_object_put(response);
771 g_app_list.addFloatingSurface(appid, surface_id, pid);*/
774 void WindowManager::removeClient(const string &appid)
776 HMI_DEBUG("wm", "Remove clinet %s from list", appid.c_str());
777 g_app_list.removeClient(appid);
780 void WindowManager::exceptionProcessForTransition()
782 unsigned req_num = g_app_list.currentRequestNumber();
783 HMI_SEQ_NOTICE(req_num, "Process exception handling for request. Remove current request %d", req_num);
784 g_app_list.removeRequest(req_num);
785 HMI_SEQ_NOTICE(g_app_list.currentRequestNumber(), "Process next request if exists");
786 this->processNextRequest();
789 void WindowManager::timerHandler()
791 unsigned req_num = g_app_list.currentRequestNumber();
792 HMI_SEQ_DEBUG(req_num, "Timer expired remove Request");
793 g_app_list.reqDump();
794 g_app_list.removeRequest(req_num);
795 this->processNextRequest();
798 void WindowManager::startTransitionWrapper(vector<WMAction> &actions)
801 unsigned req_num = g_app_list.currentRequestNumber();
805 if (g_app_list.haveRequest())
807 HMI_SEQ_DEBUG(req_num, "There is no WMAction for this request");
808 goto proc_remove_request;
812 HMI_SEQ_DEBUG(req_num, "There is no request");
817 for (auto &act : actions)
822 auto const &surface_id = this->lookup_id(act.role.c_str());
823 string appid = g_app_list.getAppID(*surface_id, act.role, &found);
826 if (TaskVisible::INVISIBLE == act.visible)
828 // App is killed, so do not set this action
833 HMI_SEQ_ERROR(req_num, "appid which is visible is not found");
841 ret = g_app_list.setAction(req_num, act);
842 if (ret != WMError::SUCCESS)
844 HMI_SEQ_ERROR(req_num, "Setting action is failed");
849 HMI_SEQ_DEBUG(req_num, "Start transition.");
850 ret = this->startTransition(req_num);
851 if (ret != WMError::SUCCESS)
853 if (ret == WMError::NO_LAYOUT_CHANGE)
855 goto proc_remove_request;
859 HMI_SEQ_ERROR(req_num, "Transition state is failed");
868 HMI_SEQ_ERROR(req_num, errorDescription(ret));
869 this->pmw.undoState();
872 g_app_list.removeRequest(req_num);
873 this->processNextRequest();
876 void WindowManager::processError(WMError error)
878 unsigned req_num = g_app_list.currentRequestNumber();
881 HMI_SEQ_ERROR(req_num, errorDescription(error));
882 g_app_list.removeRequest(req_num);
883 this->processNextRequest();
887 ******* Private Functions *******
890 bool WindowManager::pop_pending_events()
893 return this->pending_events.compare_exchange_strong(
894 x, false, std::memory_order_consume);
897 optional<int> WindowManager::lookup_id(char const *name)
899 return this->id_alloc.lookup(string(name));
901 optional<string> WindowManager::lookup_name(int id)
903 return this->id_alloc.lookup(id);
909 int WindowManager::init_layers()
911 if (!this->controller)
913 HMI_ERROR("wm", "ivi_controller global not available");
917 if (this->outputs.empty())
919 HMI_ERROR("wm", "no output was set up!");
923 auto &c = this->controller;
925 auto &o = this->outputs.front();
926 auto &s = c->screens.begin()->second;
927 auto &layers = c->layers;
929 // Write output dimensions to ivi controller...
930 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
931 c->physical_size = compositor::size{uint32_t(o->physical_width),
932 uint32_t(o->physical_height)};
935 HMI_DEBUG("wm", "SCALING: screen (%dx%d), physical (%dx%d)",
936 o->width, o->height, o->physical_width, o->physical_height);
938 this->layers.loadAreaDb();
940 const compositor::rect css_bg = this->layers.getAreaSize("fullscreen");
941 rectangle dp_bg(o->width, o->height);
943 dp_bg.set_aspect(static_cast<double>(css_bg.w) / css_bg.h);
944 dp_bg.fit(o->width, o->height);
945 dp_bg.center(o->width, o->height);
946 HMI_DEBUG("wm", "SCALING: CSS BG(%dx%d) -> DDP %dx%d,(%dx%d)",
947 css_bg.w, css_bg.h, dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
955 // Quick and dirty setup of layers
956 for (auto const &i : this->layers.mapping)
958 c->layer_create(i.second.layer_id, dp_bg.width(), dp_bg.height());
959 auto &l = layers[i.second.layer_id];
960 l->set_destination_rectangle(dp_bg.left(), dp_bg.top(), dp_bg.width(), dp_bg.height());
961 l->set_visibility(1);
962 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
963 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
966 // Add layers to screen
967 s->set_render_order(this->layers.layers);
969 this->layout_commit();
971 c->scale = static_cast<double>(dp_bg.height()) / css_bg.h;
972 this->layers.setupArea(c->scale);
977 void WindowManager::surface_set_layout(int surface_id, const string& area)
979 if (!this->controller->surface_exists(surface_id))
981 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
985 auto o_layer_id = this->layers.get_layer_id(surface_id);
989 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
993 uint32_t layer_id = *o_layer_id;
995 auto const &layer = this->layers.get_layer(layer_id);
996 auto rect = this->layers.getAreaSize(area);
997 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "%s : x:%d y:%d w:%d h:%d", area.c_str(),
998 rect.x, rect.y, rect.w, rect.h);
999 auto &s = this->controller->surfaces[surface_id];
1006 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
1009 // set destination to the display rectangle
1010 s->set_destination_rectangle(x, y, w, h);
1012 // update area information
1013 this->area_info[surface_id].x = x;
1014 this->area_info[surface_id].y = y;
1015 this->area_info[surface_id].w = w;
1016 this->area_info[surface_id].h = h;
1018 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
1019 surface_id, layer_id, x, y, w, h);
1022 void WindowManager::layout_commit()
1024 this->controller->commit_changes();
1025 this->display->flush();
1028 void WindowManager::emit_activated(char const *label)
1030 this->send_event(kListEventName[Event_Active], label);
1033 void WindowManager::emit_deactivated(char const *label)
1035 this->send_event(kListEventName[Event_Inactive], label);
1038 void WindowManager::emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h)
1040 this->send_event(kListEventName[Event_SyncDraw], label, area, x, y, w, h);
1043 void WindowManager::emit_syncdraw(const string &role, const string &area)
1045 compositor::rect rect = this->layers.getAreaSize(area);
1046 this->send_event(kListEventName[Event_SyncDraw],
1047 role.c_str(), area.c_str(), rect.x, rect.y, rect.w, rect.h);
1050 void WindowManager::emit_flushdraw(char const *label)
1052 this->send_event(kListEventName[Event_FlushDraw], label);
1055 void WindowManager::emit_visible(char const *label, bool is_visible)
1057 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
1060 void WindowManager::emit_invisible(char const *label)
1062 return emit_visible(label, false);
1065 void WindowManager::emit_visible(char const *label) { return emit_visible(label, true); }
1067 void WindowManager::activate(int id)
1069 auto ip = this->controller->sprops.find(id);
1070 if (ip != this->controller->sprops.end())
1072 this->controller->surfaces[id]->set_visibility(1);
1074 this->lookup_name(id).value_or("unknown-name").c_str();
1077 if ((0 == strcmp(label, "radio")) ||
1078 (0 == strcmp(label, "music")) ||
1079 (0 == strcmp(label, "video")) ||
1080 (0 == strcmp(label, "map")))
1082 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i)
1087 this->surface_bg.erase(i);
1089 // Remove from BG layer (999)
1090 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
1091 this->controller->layers[999]->remove_surface(id);
1093 // Add to FG layer (1001)
1094 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
1095 this->controller->layers[1001]->add_surface(id);
1097 for (int j : this->surface_bg)
1099 HMI_DEBUG("wm", "Stored id:%d", j);
1107 this->layout_commit();
1109 // TODO: application requests by old role,
1110 // so convert role new to old for emitting event
1111 const char* old_role = this->rolenew2old[label].c_str();
1113 this->emit_visible(old_role);
1114 this->emit_activated(old_role);
1118 void WindowManager::deactivate(int id)
1120 auto ip = this->controller->sprops.find(id);
1121 if (ip != this->controller->sprops.end())
1124 this->lookup_name(id).value_or("unknown-name").c_str();
1127 if ((0 == strcmp(label, "radio")) ||
1128 (0 == strcmp(label, "music")) ||
1129 (0 == strcmp(label, "video")) ||
1130 (0 == strcmp(label, "map")))
1134 this->surface_bg.push_back(id);
1136 // Remove from FG layer (1001)
1137 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
1138 this->controller->layers[1001]->remove_surface(id);
1140 // Add to BG layer (999)
1141 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
1142 this->controller->layers[999]->add_surface(id);
1144 for (int j : surface_bg)
1146 HMI_DEBUG("wm", "Stored id:%d", j);
1151 this->controller->surfaces[id]->set_visibility(0);
1155 this->layout_commit();
1157 // TODO: application requests by old role,
1158 // so convert role new to old for emitting event
1159 const char* old_role = this->rolenew2old[label].c_str();
1161 this->emit_deactivated(old_role);
1162 this->emit_invisible(old_role);
1166 WMError WindowManager::setRequest(const string& appid, const string &role, const string &area,
1167 Task task, unsigned* req_num)
1169 if (!g_app_list.contains(appid))
1171 return WMError::NOT_REGISTERED;
1174 auto client = g_app_list.lookUpClient(appid);
1179 unsigned current = g_app_list.currentRequestNumber();
1180 unsigned requested_num = g_app_list.getRequestNumber(appid);
1181 if (requested_num != 0)
1183 HMI_SEQ_INFO(requested_num,
1184 "%s %s %s request is already queued", appid.c_str(), role.c_str(), area.c_str());
1185 return REQ_REJECTED;
1188 WMRequest req = WMRequest(appid, role, area, task);
1189 unsigned new_req = g_app_list.addRequest(req);
1191 g_app_list.reqDump();
1193 HMI_SEQ_DEBUG(current, "%s start sequence with %s, %s", appid.c_str(), role.c_str(), area.c_str());
1195 return WMError::SUCCESS;
1198 WMError WindowManager::doTransition(unsigned req_num)
1200 HMI_SEQ_DEBUG(req_num, "check policy");
1201 WMError ret = this->checkPolicy(req_num);
1205 WMError WindowManager::checkPolicy(unsigned req_num)
1210 // get current trigger
1212 WMError ret = WMError::LAYOUT_CHANGE_FAIL;
1213 auto trigger = g_app_list.getRequest(req_num, &found);
1216 ret = WMError::NO_ENTRY;
1219 string req_area = trigger.area;
1221 if (trigger.task == Task::TASK_ALLOCATE)
1223 const char *msg = this->check_surface_exist(trigger.role.c_str());
1227 HMI_SEQ_ERROR(req_num, msg);
1232 // Input event data to PolicyManager
1233 if (0 > this->pmw.setInputEventData(trigger.task, trigger.role, trigger.area))
1235 HMI_SEQ_ERROR(req_num, "Failed to set input event data to PolicyManager");
1239 // Execute state transition of PolicyManager
1240 if (0 > this->pmw.executeStateTransition())
1242 HMI_SEQ_ERROR(req_num, "Failed to execute state transition of PolicyManager");
1246 ret = WMError::SUCCESS;
1248 g_app_list.reqDump();
1253 WMError WindowManager::startTransition(unsigned req_num)
1255 bool sync_draw_happen = false;
1257 WMError ret = WMError::SUCCESS;
1258 auto actions = g_app_list.getActions(req_num, &found);
1261 ret = WMError::NO_ENTRY;
1262 HMI_SEQ_ERROR(req_num,
1263 "Window Manager bug :%s : Action is not set", errorDescription(ret));
1267 for (const auto &action : actions)
1269 if (action.visible == TaskVisible::VISIBLE)
1271 sync_draw_happen = true;
1273 // TODO: application requests by old role,
1274 // so convert role new to old for emitting event
1275 string old_role = this->rolenew2old[action.role];
1277 this->emit_syncdraw(old_role, action.area);
1278 /* TODO: emit event for app not subscriber
1279 if(g_app_list.contains(y.appid))
1280 g_app_list.lookUpClient(y.appid)->emit_syncdraw(y.role, y.area); */
1284 if (sync_draw_happen)
1290 // deactivate only, no syncDraw
1291 // Make it deactivate here
1292 for (const auto &x : actions)
1294 if (g_app_list.contains(x.appid))
1296 auto client = g_app_list.lookUpClient(x.appid);
1297 this->deactivate(client->surfaceID(x.role));
1300 ret = WMError::NO_LAYOUT_CHANGE;
1305 WMError WindowManager::doEndDraw(unsigned req_num)
1309 auto actions = g_app_list.getActions(req_num, &found);
1310 WMError ret = WMError::SUCCESS;
1313 ret = WMError::NO_ENTRY;
1317 HMI_SEQ_INFO(req_num, "do endDraw");
1319 // layout change and make it visible
1320 for (const auto &act : actions)
1322 if(act.visible != TaskVisible::NO_CHANGE)
1325 if(!g_app_list.contains(act.appid)){
1326 ret = WMError::NOT_REGISTERED;
1328 ret = this->layoutChange(act);
1329 if(ret != WMError::SUCCESS)
1331 HMI_SEQ_WARNING(req_num,
1332 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1335 ret = this->visibilityChange(act);
1336 if (ret != WMError::SUCCESS)
1338 HMI_SEQ_WARNING(req_num,
1339 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
1342 HMI_SEQ_DEBUG(req_num, "visible %s", act.role.c_str());
1343 //this->lm_enddraw(act.role.c_str());
1346 this->layout_commit();
1348 HMI_SEQ_INFO(req_num, "emit flushDraw");
1350 for(const auto &act_flush : actions)
1352 if(act_flush.visible == TaskVisible::VISIBLE)
1354 // TODO: application requests by old role,
1355 // so convert role new to old for emitting event
1356 string old_role = this->rolenew2old[act_flush.role];
1358 this->emit_flushdraw(old_role.c_str());
1365 WMError WindowManager::layoutChange(const WMAction &action)
1367 if (action.visible == TaskVisible::INVISIBLE)
1369 // Visibility is not change -> no redraw is required
1370 return WMError::SUCCESS;
1372 auto client = g_app_list.lookUpClient(action.appid);
1373 unsigned surface = client->surfaceID(action.role);
1376 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1377 "client doesn't have surface with role(%s)", action.role.c_str());
1378 return WMError::NOT_REGISTERED;
1381 WMError ret = this->setSurfaceSize(surface, action.area);
1385 WMError WindowManager::visibilityChange(const WMAction &action)
1387 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Change visibility");
1388 if(!g_app_list.contains(action.appid)){
1389 return WMError::NOT_REGISTERED;
1391 auto client = g_app_list.lookUpClient(action.appid);
1392 unsigned surface = client->surfaceID(action.role);
1395 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
1396 "client doesn't have surface with role(%s)", action.role.c_str());
1397 return WMError::NOT_REGISTERED;
1400 if (action.visible != TaskVisible::INVISIBLE)
1402 this->activate(surface); // Layout Manager task
1406 this->deactivate(surface); // Layout Manager task
1408 return WMError::SUCCESS;
1411 WMError WindowManager::setSurfaceSize(unsigned surface, const string &area)
1413 this->surface_set_layout(surface, area);
1415 return WMError::SUCCESS;
1418 void WindowManager::emitScreenUpdated(unsigned req_num)
1421 HMI_SEQ_DEBUG(req_num, "emit screen updated");
1423 auto actions = g_app_list.getActions(req_num, &found);
1425 // create json object
1426 json_object *j = json_object_new_object();
1427 json_object *jarray = json_object_new_array();
1429 for(const auto& action: actions)
1431 if(action.visible != TaskVisible::INVISIBLE)
1433 json_object_array_add(jarray, json_object_new_string(action.appid.c_str()));
1436 json_object_object_add(j, kKeyIds, jarray);
1437 HMI_SEQ_INFO(req_num, "Visible app: %s", json_object_get_string(j));
1439 int ret = afb_event_push(
1440 this->map_afb_event[kListEventName[Event_ScreenUpdated]], j);
1443 HMI_DEBUG("wm", "afb_event_push failed: %m");
1447 void WindowManager::setTimer()
1450 if (clock_gettime(CLOCK_BOOTTIME, &ts) != 0) {
1451 HMI_ERROR("wm", "Could't set time (clock_gettime() returns with error");
1455 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Timer set activate");
1456 if (g_timer_ev_src == nullptr)
1458 // firsttime set into sd_event
1459 int ret = sd_event_add_time(afb_daemon_get_event_loop(), &g_timer_ev_src,
1460 CLOCK_BOOTTIME, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL, 1, processTimerHandler, this);
1463 HMI_ERROR("wm", "Could't set timer");
1468 // update timer limitation after second time
1469 sd_event_source_set_time(g_timer_ev_src, (uint64_t)(ts.tv_sec + kTimeOut) * 1000000ULL);
1470 sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_ONESHOT);
1474 void WindowManager::stopTimer()
1476 unsigned req_num = g_app_list.currentRequestNumber();
1477 HMI_SEQ_DEBUG(req_num, "Timer stop");
1478 int rc = sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_OFF);
1481 HMI_SEQ_ERROR(req_num, "Timer stop failed");
1485 void WindowManager::processNextRequest()
1488 g_app_list.reqDump();
1489 unsigned req_num = g_app_list.currentRequestNumber();
1490 if (g_app_list.haveRequest())
1492 HMI_SEQ_DEBUG(req_num, "Process next request");
1493 WMError rc = doTransition(req_num);
1494 if (rc != WMError::SUCCESS)
1496 HMI_SEQ_ERROR(req_num, errorDescription(rc));
1501 HMI_SEQ_DEBUG(req_num, "Nothing Request. Waiting Request");
1505 const char* WindowManager::convertRoleOldToNew(char const *old_role)
1507 const char *new_role = nullptr;
1509 for (auto const &on : this->roleold2new)
1511 std::regex regex = std::regex(on.first);
1512 if (std::regex_match(old_role, regex))
1514 // role is old. So convert to new.
1515 new_role = on.second.c_str();
1520 if (nullptr == new_role)
1522 // role is new or fallback.
1523 new_role = old_role;
1526 HMI_DEBUG("wm", "old:%s -> new:%s", old_role, new_role);
1531 int WindowManager::loadOldRoleDb()
1533 // Get afm application installed dir
1534 char const *afm_app_install_dir = getenv("AFM_APP_INSTALL_DIR");
1535 HMI_DEBUG("wm", "afm_app_install_dir:%s", afm_app_install_dir);
1538 if (!afm_app_install_dir)
1540 HMI_ERROR("wm", "AFM_APP_INSTALL_DIR is not defined");
1544 file_name = string(afm_app_install_dir) + string("/etc/old_roles.db");
1548 json_object* json_obj;
1549 int ret = jh::inputJsonFilie(file_name.c_str(), &json_obj);
1552 HMI_ERROR("wm", "Could not open old_role.db, so use default old_role information");
1553 json_obj = json_tokener_parse(kDefaultOldRoleDb);
1555 HMI_DEBUG("wm", "json_obj dump:%s", json_object_get_string(json_obj));
1558 json_object* json_cfg;
1559 if (!json_object_object_get_ex(json_obj, "old_roles", &json_cfg))
1561 HMI_ERROR("wm", "Parse Error!!");
1565 int len = json_object_array_length(json_cfg);
1566 HMI_DEBUG("wm", "json_cfg len:%d", len);
1567 HMI_DEBUG("wm", "json_cfg dump:%s", json_object_get_string(json_cfg));
1569 for (int i=0; i<len; i++)
1571 json_object* json_tmp = json_object_array_get_idx(json_cfg, i);
1573 const char* old_role = jh::getStringFromJson(json_tmp, "name");
1574 if (nullptr == old_role)
1576 HMI_ERROR("wm", "Parse Error!!");
1580 const char* new_role = jh::getStringFromJson(json_tmp, "new");
1581 if (nullptr == new_role)
1583 HMI_ERROR("wm", "Parse Error!!");
1587 this->roleold2new[old_role] = string(new_role);
1591 for(auto itr = this->roleold2new.begin();
1592 itr != this->roleold2new.end(); ++itr)
1594 HMI_DEBUG("wm", ">>> role old:%s new:%s",
1595 itr->first.c_str(), itr->second.c_str());
1598 // Release json_object
1599 json_object_put(json_obj);
1604 const char *WindowManager::check_surface_exist(const char *drawing_name)
1606 auto const &surface_id = this->lookup_id(drawing_name);
1609 return "Surface does not exist";
1612 if (!this->controller->surface_exists(*surface_id))
1614 return "Surface does not exist in controller!";
1617 auto layer_id = this->layers.get_layer_id(*surface_id);
1621 return "Surface is not on any layer!";
1624 HMI_DEBUG("wm", "surface %d is detected", *surface_id);
1628 const char* WindowManager::kDefaultOldRoleDb = "{ \
1631 \"name\": \"HomeScreen\", \
1632 \"new\": \"homescreen\" \
1635 \"name\": \"Music\", \
1636 \"new\": \"music\" \
1639 \"name\": \"MediaPlayer\", \
1640 \"new\": \"music\" \
1643 \"name\": \"Video\", \
1644 \"new\": \"video\" \
1647 \"name\": \"VideoPlayer\", \
1648 \"new\": \"video\" \
1651 \"name\": \"WebBrowser\", \
1652 \"new\": \"browser\" \
1655 \"name\": \"Radio\", \
1656 \"new\": \"radio\" \
1659 \"name\": \"Phone\", \
1660 \"new\": \"phone\" \
1663 \"name\": \"Navigation\", \
1667 \"name\": \"HVAC\", \
1671 \"name\": \"Settings\", \
1672 \"new\": \"settings\" \
1675 \"name\": \"Dashboard\", \
1676 \"new\": \"dashboard\" \
1679 \"name\": \"POI\", \
1683 \"name\": \"Mixer\", \
1684 \"new\": \"mixer\" \
1687 \"name\": \"Restriction\", \
1688 \"new\": \"restriction\" \
1691 \"name\": \"^OnScreen.*\", \
1692 \"new\": \"on_screen\" \
1700 void controller_hooks::surface_created(uint32_t surface_id)
1702 this->wmgr->surface_created(surface_id);
1705 void controller_hooks::surface_removed(uint32_t surface_id)
1707 this->wmgr->surface_removed(surface_id);
1710 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
1713 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,
1719 void controller_hooks::surface_properties(uint32_t surface_id, uint32_t pid)
1721 this->wmgr->surface_properties(surface_id, pid);