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.
18 #include "json_helper.hpp"
22 #include "wayland_ivi_wm.hpp"
29 #include <json-c/json.h>
38 #include "wm_client.hpp"
39 #include "applist.hpp"
43 #include <systemd/sd-event.h>
49 static const unsigned kTimeOut = 3000000UL; /* 3s */
51 /* DrawingArea name used by "{layout}.{area}" */
52 const char kNameLayoutNormal[] = "normal";
53 const char kNameLayoutSplit[] = "split";
54 const char kNameAreaFull[] = "full";
55 const char kNameAreaMain[] = "main";
56 const char kNameAreaSub[] = "sub";
58 /* Key for json obejct */
59 const char kKeyDrawingName[] = "drawing_name";
60 const char kKeyDrawingArea[] = "drawing_area";
61 const char kKeyDrawingRect[] = "drawing_rect";
62 const char kKeyX[] = "x";
63 const char kKeyY[] = "y";
64 const char kKeyWidth[] = "width";
65 const char kKeyHeight[] = "height";
66 const char kKeyWidthPixel[] = "width_pixel";
67 const char kKeyHeightPixel[] = "height_pixel";
68 const char kKeyWidthMm[] = "width_mm";
69 const char kKeyHeightMm[] = "height_mm";
71 static sd_event_source *g_timer_ev_src = nullptr;
73 static AppList g_app_list;
80 result<json> file_to_json(char const *filename)
83 std::ifstream i(filename);
86 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
87 j = default_layers_json;
97 struct result<layer_map> load_layer_map(char const *filename)
99 HMI_DEBUG("wm", "loading IDs from %s", filename);
101 auto j = file_to_json(filename);
104 return Err<layer_map>(j.unwrap_err());
106 json jids = j.unwrap();
108 return to_layer_map(jids);
112 processTimerHandler(sd_event_source *s, uint64_t usec, void *userdata)
114 HMI_NOTICE("wm", "Time out occurs because the client replys endDraw slow, so revert the request");
115 reinterpret_cast<wm::App *>(userdata)->timerHandler();
121 void App::timerHandler()
123 unsigned req_num = g_app_list.currentRequestNumber();
124 HMI_SEQ_DEBUG(req_num, "Timer expired remove Request");
125 g_app_list.reqDump();
126 g_app_list.removeRequest(req_num);
127 this->processNextRequest();
130 void App::removeClient(const std::string &appid)
132 HMI_DEBUG("wm", "Remove clinet %s from list", appid.c_str());
133 g_app_list.removeClient(appid);
136 void App::exeptionProcessForTransition()
138 unsigned req_num = g_app_list.currentRequestNumber();
139 HMI_SEQ_NOTICE(req_num, "Process exeption handling for request. Remove current request %d", req_num);
140 g_app_list.removeRequest(req_num);
141 HMI_SEQ_NOTICE(g_app_list.currentRequestNumber(), "Process next request if exists");
142 this->processNextRequest();
145 bool App::subscribeEventForApp(const std::string &appid, afb_req req, const std::string &evname)
147 if(!g_app_list.contains(appid)){
148 HMI_DEBUG("wm", "Client %s is not registered", appid.c_str());
151 auto client = g_app_list.lookUpClient(appid);
152 return client->subscribe(req, evname);
158 App::App(wl::display *d)
166 pending_events(false),
172 auto l = load_layer_map(
173 this->config.get_string("layers.json").value().c_str());
176 this->layers = l.unwrap();
180 HMI_ERROR("wm", "%s", l.err().value());
184 catch (std::exception &e)
186 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
192 if (!this->display->ok())
197 if (this->layers.mapping.empty())
199 HMI_ERROR("wm", "No surface -> layer mapping loaded");
204 for (int i = Event_Val_Min; i <= Event_Val_Max; i++)
206 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
209 this->display->add_global_handler(
210 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
211 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
214 this->display->add_global_handler(
215 "ivi_wm", [this](wl_registry *r, uint32_t name, uint32_t v) {
217 std::make_unique<struct compositor::controller>(r, name, v);
219 // Init controller hooks
220 this->controller->chooks = &this->chooks;
222 // This protocol needs the output, so lets just add our mapping here...
223 this->controller->add_proxy_to_id_mapping(
224 this->outputs.back()->proxy.get(),
225 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
226 this->outputs.back()->proxy.get())));
229 this->controller->create_screen(this->outputs.back()->proxy.get());
231 // Set display to controller
232 this->controller->display = this->display;
235 // First level objects
236 this->display->roundtrip();
237 // Second level objects
238 this->display->roundtrip();
239 // Third level objects
240 this->display->roundtrip();
242 return init_layers();
245 int App::dispatch_pending_events()
247 if (this->pop_pending_events())
249 this->display->dispatch_pending();
255 bool App::pop_pending_events()
258 return this->pending_events.compare_exchange_strong(
259 x, false, std::memory_order_consume);
262 void App::set_pending_events()
264 this->pending_events.store(true, std::memory_order_release);
267 optional<int> App::lookup_id(char const *name)
269 return this->id_alloc.lookup(std::string(name));
271 optional<std::string> App::lookup_name(int id)
273 return this->id_alloc.lookup(id);
279 int App::init_layers()
281 if (!this->controller)
283 HMI_ERROR("wm", "ivi_controller global not available");
287 if (this->outputs.empty())
289 HMI_ERROR("wm", "no output was set up!");
293 auto &c = this->controller;
295 auto &o = this->outputs.front();
296 auto &s = c->screens.begin()->second;
297 auto &layers = c->layers;
299 // Write output dimensions to ivi controller...
300 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
301 c->physical_size = compositor::size{uint32_t(o->physical_width),
302 uint32_t(o->physical_height)};
310 // Quick and dirty setup of layers
311 for (auto const &i : this->layers.mapping)
313 c->layer_create(i.second.layer_id, o->width, o->height);
314 auto &l = layers[i.second.layer_id];
315 l->set_destination_rectangle(0, 0, o->width, o->height);
316 l->set_visibility(1);
317 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
318 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
321 // Add layers to screen
322 s->set_render_order(this->layers.layers);
324 this->layout_commit();
326 this->layers.setupArea(o->width, o->height);
331 void App::surface_set_layout(int surface_id, const std::string& area)
333 if (!this->controller->surface_exists(surface_id))
335 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
339 auto o_layer_id = this->layers.get_layer_id(surface_id);
343 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
347 uint32_t layer_id = *o_layer_id;
349 auto const &layer = this->layers.get_layer(layer_id);
350 auto rect = this->layers.getAreaSize(area);
351 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "%s : x:%d y:%d w:%d h:%d", area.c_str(),
352 rect.x, rect.y, rect.w, rect.h);
353 auto &s = this->controller->surfaces[surface_id];
360 // less-than-0 values refer to MAX + 1 - $VALUE
361 // e.g. MAX is either screen width or height
364 w = this->controller->output_size.w + 1 + w;
368 h = this->controller->output_size.h + 1 + h;
371 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
374 // set destination to the display rectangle
375 s->set_destination_rectangle(x, y, w, h);
377 // update area information
378 this->area_info[surface_id].x = x;
379 this->area_info[surface_id].y = y;
380 this->area_info[surface_id].w = w;
381 this->area_info[surface_id].h = h;
383 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
384 surface_id, layer_id, x, y, w, h);
387 void App::layout_commit()
389 this->controller->commit_changes();
390 this->display->flush();
395 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Timer set activate");
396 if (g_timer_ev_src == nullptr)
398 // firsttime set into sd_event
399 int ret = sd_event_add_time(afb_daemon_get_event_loop(), &g_timer_ev_src,
400 CLOCK_REALTIME, time(NULL) * (1000000UL) + kTimeOut, 1, processTimerHandler, this);
403 HMI_ERROR("wm", "Could't set timer");
408 // update timer limitation after second time
409 sd_event_source_set_time(g_timer_ev_src, time(NULL) * (1000000UL) + kTimeOut);
410 sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_ONESHOT);
414 void App::stopTimer()
416 unsigned req_num = g_app_list.currentRequestNumber();
417 HMI_SEQ_DEBUG(req_num, "Timer stop");
418 int rc = sd_event_source_set_enabled(g_timer_ev_src, SD_EVENT_OFF);
421 HMI_SEQ_ERROR(req_num, "Timer stop failed");
425 WMError App::doTransition(unsigned req_num)
427 HMI_SEQ_DEBUG(req_num, "check policy");
428 WMError ret = this->checkPolicy(req_num);
429 if (ret != WMError::SUCCESS)
433 HMI_SEQ_DEBUG(req_num, "Start transition.");
434 ret = this->startTransition(req_num);
438 WMError App::checkPolicy(unsigned req_num)
443 // get current trigger
446 WMError ret = WMError::LAYOUT_CHANGE_FAIL;
447 auto trigger = g_app_list.getRequest(req_num, &found);
450 ret = WMError::NO_ENTRY;
453 std::string req_area = trigger.area;
455 // >>>> Compatible with current window manager until policy manager coming
456 if (trigger.task == Task::TASK_ALLOCATE)
458 HMI_SEQ_DEBUG(req_num, "Check split or not");
459 const char *msg = this->check_surface_exist(trigger.role.c_str());
463 HMI_SEQ_ERROR(req_num, msg);
464 ret = WMError::LAYOUT_CHANGE_FAIL;
468 auto const &surface_id = this->lookup_id(trigger.role.c_str());
469 auto o_state = *this->layers.get_layout_state(*surface_id);
470 struct LayoutState &state = *o_state;
472 unsigned curernt_sid = state.main;
473 split = this->can_split(state, *surface_id);
477 HMI_SEQ_DEBUG(req_num, "Split happens");
478 // Get current visible role
479 std::string add_role = this->lookup_name(state.main).value();
481 std::string add_area = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaMain);
482 // Change request area
483 req_area = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaSub);
484 HMI_SEQ_NOTICE(req_num, "Change request area from %s to %s, because split is happen",
485 trigger.area, req_area);
486 // set another action
487 std::string add_name = g_app_list.getAppID(curernt_sid, add_role, &found);
490 HMI_SEQ_ERROR(req_num, "Couldn't widhdraw with surfaceID : %s", curernt_sid);
491 ret = WMError::NOT_REGISTERED;
494 HMI_SEQ_INFO(req_num, "Additional split app %s, role: %s, area: %s",
495 add_name.c_str(), add_role.c_str(), add_area.c_str());
497 bool end_draw_finished = false;
498 WMAction split_action{
502 TaskVisible::VISIBLE,
504 WMError ret = g_app_list.setAction(req_num, split_action);
505 if (ret != WMError::SUCCESS)
507 HMI_SEQ_ERROR(req_num, "Failed to set action");
510 g_app_list.reqDump();
515 HMI_SEQ_DEBUG(req_num, "split doesn't happen");
518 // Set invisible task(Remove if policy manager finish)
519 ret = this->setInvisibleTask(trigger.role, split);
520 if(ret != WMError::SUCCESS)
522 HMI_SEQ_ERROR(req_num, "Failed to set invisible task: %s", errorDescription(ret));
526 /* get new status from Policy Manager */
527 HMI_SEQ_NOTICE(req_num, "ATM, Policy manager does't exist, then set WMAction as is");
528 if(trigger.role == "HomeScreen")
530 // TODO : Remove when Policy Manager completed
531 HMI_SEQ_NOTICE(req_num, "Hack. This process will be removed. Change HomeScreen code!!");
532 req_area = "fullscreen";
534 TaskVisible task_visible =
535 (trigger.task == Task::TASK_ALLOCATE) ? TaskVisible::VISIBLE : TaskVisible::INVISIBLE;
537 ret = g_app_list.setAction(req_num, trigger.appid, trigger.role, req_area, task_visible);
538 g_app_list.reqDump();
543 WMError App::startTransition(unsigned req_num)
545 bool sync_draw_happen = false;
547 WMError ret = WMError::SUCCESS;
548 auto actions = g_app_list.getActions(req_num, &found);
551 ret = WMError::NO_ENTRY;
552 HMI_SEQ_ERROR(req_num,
553 "Window Manager bug :%s : Action is not set", errorDescription(ret));
557 for (const auto &action : actions)
559 if (action.visible != TaskVisible::INVISIBLE)
561 sync_draw_happen = true;
562 this->emit_syncdraw(action.role, action.area);
563 /* TODO: emit event for app not subscriber
564 if(g_app_list.contains(y.appid))
565 g_app_list.lookUpClient(y.appid)->emit_syncdraw(y.role, y.area); */
569 if (sync_draw_happen)
575 // deactivate only, no syncDraw
576 // Make it deactivate here
577 for (const auto &x : actions)
579 if (g_app_list.contains(x.appid))
581 auto client = g_app_list.lookUpClient(x.appid);
582 this->deactivate(client->surfaceID(x.role));
585 ret = NO_LAYOUT_CHANGE;
590 WMError App::setInvisibleTask(const std::string &role, bool split)
592 unsigned req_num = g_app_list.currentRequestNumber();
593 HMI_SEQ_DEBUG(req_num, "set current visible app to invisible task");
594 // This task is copied from original actiavete surface
595 const char *drawing_name = role.c_str();
596 auto const &surface_id = this->lookup_id(drawing_name);
597 auto layer_id = this->layers.get_layer_id(*surface_id);
598 auto o_state = *this->layers.get_layout_state(*surface_id);
599 struct LayoutState &state = *o_state;
600 std::string add_name, add_role;
601 std::string add_area = "";
603 TaskVisible task_visible = TaskVisible::INVISIBLE;
604 bool end_draw_finished = true;
607 for (auto const &l : this->layers.mapping)
609 if (l.second.layer_id <= *layer_id)
613 HMI_DEBUG("wm", "debug: main %d , sub : %d", l.second.state.main, l.second.state.sub);
614 if (l.second.state.main != -1)
616 //this->deactivate(l.second.state.main);
617 surface = l.second.state.main;
618 add_role = *this->id_alloc.lookup(surface);
619 add_name = g_app_list.getAppID(surface, add_role, &found);
621 return WMError::NOT_REGISTERED;
623 HMI_SEQ_INFO(req_num, "Invisible %s", add_name.c_str());
624 WMAction act{add_name, add_role, add_area, task_visible, end_draw_finished};
625 g_app_list.setAction(req_num, act);
626 l.second.state.main = -1;
629 if (l.second.state.sub != -1)
631 //this->deactivate(l.second.state.sub);
632 surface = l.second.state.sub;
633 add_role = *this->id_alloc.lookup(surface);
634 add_name = g_app_list.getAppID(surface, add_role, &found);
637 return WMError::NOT_REGISTERED;
639 HMI_SEQ_INFO(req_num, "Invisible %s", add_name.c_str());
640 WMAction act{add_name, add_role, add_area, task_visible, end_draw_finished};
641 g_app_list.setAction(req_num, act);
642 l.second.state.sub = -1;
646 // change current state here, but this is hack
647 auto layer = this->layers.get_layer(*layer_id);
649 if (state.main == -1)
651 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
652 //state = LayoutState{*surface_id};
654 state, LayoutState{*surface_id}, [&](LayoutState const &nl) {
655 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
656 //this->surface_set_layout(*surface_id);
659 //compositor::rect area_rect = this->area_info[*surface_id];
664 if (0 != strcmp(drawing_name, "HomeScreen"))
669 std::move(*this->id_alloc.lookup(state.main));
670 if (state.sub != *surface_id)
674 //this->deactivate(state.sub);
676 deact_sub.role = main;
677 deact_sub.area = add_area;
678 deact_sub.appid = g_app_list.getAppID(state.sub, main, &found);
681 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
682 return WMError::NOT_REGISTERED;
684 deact_sub.visible = task_visible;
685 deact_sub.end_draw_finished = end_draw_finished;
686 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
687 g_app_list.setAction(req_num, deact_sub);
690 //state = LayoutState{state.main, *surface_id};
694 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
696 //this->surface_set_layout(*surface_id);
697 if (state.main != *surface_id)
699 // this->deactivate(state.main);
701 deact_main.role = std::move(*this->id_alloc.lookup(state.main));
703 deact_main.area = add_area;
704 deact_main.appid = g_app_list.getAppID(state.main, deact_main.role, &found);
707 HMI_SEQ_DEBUG(req_num, "sub surface ddoesn't exist");
708 return WMError::NOT_REGISTERED;
710 deact_main.visible = task_visible;
711 deact_main.end_draw_finished = end_draw_finished;
712 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
713 g_app_list.setAction(req_num, deact_main);
717 if (state.sub != *surface_id)
719 //this->deactivate(state.sub);
721 deact_sub.role = std::move(*this->id_alloc.lookup(state.sub));
723 deact_sub.area = add_area;
724 deact_sub.appid = g_app_list.getAppID(state.sub, deact_sub.role, &found);
727 HMI_SEQ_DEBUG(req_num, "sub surface ddoesn't exist");
728 return WMError::NOT_REGISTERED;
730 deact_sub.visible = task_visible;
731 deact_sub.end_draw_finished = end_draw_finished;
732 HMI_SEQ_DEBUG(req_num, "sub surface doesn't exist");
733 g_app_list.setAction(req_num, deact_sub);
736 //state = LayoutState{*surface_id};
740 return WMError::SUCCESS;
743 const char *App::check_surface_exist(const char *drawing_name)
745 auto const &surface_id = this->lookup_id(drawing_name);
748 //reply("Surface does not exist");
749 return "Surface does not exist";
752 if (!this->controller->surface_exists(*surface_id))
754 //reply("Surface does not exist in controller!");
755 return "Surface does not exist in controller!";
758 auto layer_id = this->layers.get_layer_id(*surface_id);
762 //reply("Surface is not on any layer!");
763 return "Surface is not on any layer!";
766 auto o_state = *this->layers.get_layout_state(*surface_id);
768 if (o_state == nullptr)
770 //reply("Could not find layer for surface");
771 return "Could not find layer for surface";
774 HMI_DEBUG("wm", "surface %d is detected", *surface_id);
779 WMError App::setRequest(const std::string& appid, const std::string &role, const std::string &area,
780 Task task, unsigned* req_num)
782 if (!g_app_list.contains(appid))
784 return WMError::NOT_REGISTERED;
787 auto client = g_app_list.lookUpClient(appid);
792 unsigned current = g_app_list.currentRequestNumber();
793 unsigned requested_num = g_app_list.getRequestNumber(appid);
794 if (requested_num != 0)
796 HMI_SEQ_INFO(requested_num,
797 "%s %s %s request is already queued", appid.c_str(), role.c_str(), area.c_str());
801 WMRequest req = WMRequest(appid, role, area, task);
802 unsigned new_req = g_app_list.addRequest(req);
804 g_app_list.reqDump();
806 HMI_SEQ_DEBUG(current, "%s start sequence with %s, %s", appid.c_str(), role.c_str(), area.c_str());
808 return WMError::SUCCESS;
811 void App::api_activate_surface(char const *appid, char const *drawing_name,
812 char const *drawing_area, const reply_func &reply)
816 std::string id = appid;
817 std::string role = drawing_name;
818 std::string area = drawing_area;
819 Task task = Task::TASK_ALLOCATE;
820 unsigned req_num = 0;
821 WMError ret = WMError::UNKNOWN;
823 ret = this->setRequest(id, role, area, task, &req_num);
825 if(ret != WMError::SUCCESS)
827 HMI_ERROR("wm", errorDescription(ret));
828 reply("Failed to set request");
833 if (req_num != g_app_list.currentRequestNumber())
835 // Add request, then invoked after the previous task is finished
836 HMI_SEQ_DEBUG(req_num, "request is accepted");
843 ret = this->doTransition(req_num);
845 if (ret != WMError::SUCCESS)
848 HMI_SEQ_ERROR(req_num, errorDescription(ret));
849 g_app_list.removeRequest(req_num);
850 this->processNextRequest();
854 void App::api_deactivate_surface(char const *appid, char const *drawing_name,
855 const reply_func &reply)
862 std::string id = appid;
863 std::string role = drawing_name;
864 std::string area = ""; //drawing_area;
865 Task task = Task::TASK_RELEASE;
866 unsigned req_num = 0;
867 WMError ret = WMError::UNKNOWN;
869 ret = this->setRequest(id, role, area, task, &req_num);
871 if (ret != WMError::SUCCESS)
873 HMI_ERROR("wm", errorDescription(ret));
874 reply("Failed to set request");
879 if (req_num != g_app_list.currentRequestNumber())
881 // Add request, then invoked after the previous task is finished
882 HMI_SEQ_DEBUG(req_num, "request is accepted");
889 ret = this->doTransition(req_num);
891 if (ret != WMError::SUCCESS)
894 HMI_SEQ_ERROR(req_num, errorDescription(ret));
895 g_app_list.removeRequest(req_num);
896 this->processNextRequest();
900 WMError App::doEndDraw(unsigned req_num)
904 auto actions = g_app_list.getActions(req_num, &found);
905 WMError ret = WMError::SUCCESS;
908 ret = WMError::NO_ENTRY;
912 HMI_SEQ_INFO(req_num, "do endDraw");
914 // layout change and make it visible
915 for (const auto &act : actions)
918 if(!g_app_list.contains(act.appid)){
919 ret = WMError::NOT_REGISTERED;
921 ret = this->layoutChange(act);
922 if(ret != WMError::SUCCESS)
924 HMI_SEQ_WARNING(req_num,
925 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
928 ret = this->visibilityChange(act);
929 if (ret != WMError::SUCCESS)
931 HMI_SEQ_WARNING(req_num,
932 "Failed to manipulate surfaces while state change : %s", errorDescription(ret));
935 HMI_SEQ_DEBUG(req_num, "visible %s", act.role.c_str());
936 //this->lm_enddraw(act.role.c_str());
939 // Change current state
940 this->changeCurrentState(req_num);
942 HMI_SEQ_INFO(req_num, "emit flushDraw");
944 for(const auto &act_flush : actions)
946 if(act_flush.visible != TaskVisible::INVISIBLE)
948 this->emit_flushdraw(act_flush.role.c_str());
955 WMError App::setSurfaceSize(unsigned surface, const std::string &area)
957 this->surface_set_layout(surface, area);
959 return WMError::SUCCESS;
962 WMError App::layoutChange(const WMAction &action)
964 if (action.visible == TaskVisible::INVISIBLE)
966 // Visibility is not change -> no redraw is required
967 return WMError::SUCCESS;
969 auto client = g_app_list.lookUpClient(action.appid);
970 unsigned surface = client->surfaceID(action.role);
973 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
974 "client doesn't have surface with role(%s)", action.role.c_str());
975 return WMError::NOT_REGISTERED;
978 WMError ret = this->setSurfaceSize(surface, action.area);
982 WMError App::visibilityChange(const WMAction &action)
984 HMI_SEQ_DEBUG(g_app_list.currentRequestNumber(), "Change visibility");
985 if(!g_app_list.contains(action.appid)){
986 return WMError::NOT_REGISTERED;
988 auto client = g_app_list.lookUpClient(action.appid);
989 unsigned surface = client->surfaceID(action.role);
992 HMI_SEQ_ERROR(g_app_list.currentRequestNumber(),
993 "client doesn't have surface with role(%s)", action.role.c_str());
994 return WMError::NOT_REGISTERED;
997 if (action.visible != TaskVisible::INVISIBLE)
999 this->activate(surface); // Layout Manager task
1003 this->deactivate(surface); // Layout Manager task
1005 return WMError::SUCCESS;
1008 WMError App::changeCurrentState(unsigned req_num)
1010 HMI_SEQ_DEBUG(req_num, "Change current layout state");
1011 bool trigger_found = false, action_found = false;
1012 auto trigger = g_app_list.getRequest(req_num, &trigger_found);
1013 auto actions = g_app_list.getActions(req_num, &action_found);
1014 if (!trigger_found || !action_found)
1016 HMI_SEQ_ERROR(req_num, "Action not found");
1017 return WMError::LAYOUT_CHANGE_FAIL;
1020 // Layout state reset
1021 struct LayoutState reset_state{-1, -1};
1022 HMI_SEQ_DEBUG(req_num,"Reset layout state");
1023 for (const auto &action : actions)
1025 if(!g_app_list.contains(action.appid)){
1026 return WMError::NOT_REGISTERED;
1028 auto client = g_app_list.lookUpClient(action.appid);
1029 auto pCurState = *this->layers.get_layout_state((int)client->surfaceID(action.role));
1030 if(pCurState == nullptr)
1032 HMI_SEQ_ERROR(req_num, "Counldn't find current status");
1035 pCurState->main = reset_state.main;
1036 pCurState->sub = reset_state.sub;
1039 HMI_SEQ_DEBUG(req_num, "Change state");
1040 for (const auto &action : actions)
1042 auto client = g_app_list.lookUpClient(action.appid);
1043 auto pLayerCurState = *this->layers.get_layout_state((int)client->surfaceID(action.role));
1044 if (pLayerCurState == nullptr)
1046 HMI_SEQ_ERROR(req_num, "Counldn't find current status");
1051 if (action.visible != TaskVisible::INVISIBLE)
1053 surface = (int)client->surfaceID(action.role);
1054 HMI_SEQ_INFO(req_num, "Change %s surface : %d, state visible area : %s",
1055 action.role.c_str(), surface, action.area.c_str());
1056 // visible == true -> layout changes
1057 if(action.area == "normal.full" || action.area == "split.main")
1059 pLayerCurState->main = surface;
1061 else if (action.area == "split.sub")
1063 pLayerCurState->sub = surface;
1068 pLayerCurState->main = surface;
1073 return WMError::SUCCESS;
1076 void App::api_enddraw(char const *appid, char const *drawing_name)
1078 std::string id = appid;
1079 std::string role = drawing_name;
1080 unsigned current_req = g_app_list.currentRequestNumber();
1081 bool result = g_app_list.setEndDrawFinished(current_req, id, role);
1085 HMI_ERROR("wm", "%s is not in transition state", id.c_str());
1089 if (g_app_list.endDrawFullfilled(current_req))
1091 // do task for endDraw
1093 WMError ret = this->doEndDraw(current_req);
1095 if(ret != WMError::SUCCESS)
1097 //this->emit_error();
1099 HMI_SEQ_INFO(current_req, "Finish request status: %s", errorDescription(ret));
1101 g_app_list.removeRequest(current_req);
1103 this->processNextRequest();
1107 HMI_SEQ_INFO(current_req, "Wait other App call endDraw");
1112 void App::processNextRequest()
1115 g_app_list.reqDump();
1116 unsigned req_num = g_app_list.currentRequestNumber();
1117 if (g_app_list.haveRequest())
1119 HMI_SEQ_DEBUG(req_num, "Process next request");
1120 WMError rc = doTransition(req_num);
1121 if (rc != WMError::SUCCESS)
1123 HMI_SEQ_ERROR(req_num, errorDescription(rc));
1128 HMI_SEQ_DEBUG(req_num, "Nothing Request. Waiting Request");
1132 void App::api_ping() { this->dispatch_pending_events(); }
1134 void App::send_event(char const *evname, char const *label)
1136 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
1138 json_object *j = json_object_new_object();
1139 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
1141 int ret = afb_event_push(this->map_afb_event[evname], j);
1144 HMI_DEBUG("wm", "afb_event_push failed: %m");
1148 void App::send_event(char const *evname, char const *label, char const *area,
1149 int x, int y, int w, int h)
1151 HMI_DEBUG("wm", "%s: %s(%s, %s) x:%d y:%d w:%d h:%d",
1152 __func__, evname, label, area, x, y, w, h);
1154 json_object *j_rect = json_object_new_object();
1155 json_object_object_add(j_rect, kKeyX, json_object_new_int(x));
1156 json_object_object_add(j_rect, kKeyY, json_object_new_int(y));
1157 json_object_object_add(j_rect, kKeyWidth, json_object_new_int(w));
1158 json_object_object_add(j_rect, kKeyHeight, json_object_new_int(h));
1160 json_object *j = json_object_new_object();
1161 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
1162 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
1163 json_object_object_add(j, kKeyDrawingRect, j_rect);
1165 int ret = afb_event_push(this->map_afb_event[evname], j);
1168 HMI_DEBUG("wm", "afb_event_push failed: %m");
1175 void App::surface_created(uint32_t surface_id)
1177 auto layer_id = this->layers.get_layer_id(surface_id);
1180 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
1185 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
1187 this->controller->layers[*layer_id]->add_surface(surface_id);
1188 this->layout_commit();
1189 // activate the main_surface right away
1190 /*if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
1191 HMI_DEBUG("wm", "Activating main_surface (%d)", surface_id);
1193 this->api_activate_surface(
1194 this->lookup_name(surface_id).value_or("unknown-name").c_str());
1197 // search pid from surfaceID
1199 // pick up appid from pid from application manager
1201 // check appid then add it to the client
1204 void App::surface_removed(uint32_t surface_id)
1206 HMI_DEBUG("wm", "surface_id is %u", surface_id);
1208 g_app_list.removeSurface(surface_id);
1211 void App::emit_activated(char const *label)
1213 this->send_event(kListEventName[Event_Active], label);
1216 void App::emit_deactivated(char const *label)
1218 this->send_event(kListEventName[Event_Inactive], label);
1221 void App::emit_syncdraw(char const *label, char const *area, int x, int y, int w, int h)
1223 this->send_event(kListEventName[Event_SyncDraw], label, area, x, y, w, h);
1226 void App::emit_syncdraw(const std::string &role, const std::string &area)
1228 compositor::rect rect = this->layers.getAreaSize(area);
1229 //this->lm_get_area_info(area, &x, &y, &w, &h);
1230 this->send_event(kListEventName[Event_SyncDraw],
1231 role.c_str(), area.c_str(), rect.x, rect.y, rect.w, rect.h);
1234 void App::emit_flushdraw(char const *label)
1236 this->send_event(kListEventName[Event_FlushDraw], label);
1239 void App::emit_visible(char const *label, bool is_visible)
1241 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
1244 void App::emit_invisible(char const *label)
1246 return emit_visible(label, false);
1249 void App::emit_visible(char const *label) { return emit_visible(label, true); }
1251 result<int> App::api_request_surface(char const *appid, char const *drawing_name)
1253 auto lid = this->layers.get_layer_id(std::string(drawing_name));
1257 * register drawing_name as fallback and make it displayed.
1259 lid = this->layers.get_layer_id(std::string("Fallback"));
1260 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", drawing_name);
1263 return Err<int>("Drawing name does not match any role, Fallback is disabled");
1267 auto rname = this->lookup_id(drawing_name);
1270 // name does not exist yet, allocate surface id...
1271 auto id = int(this->id_alloc.generate_id(drawing_name));
1272 this->layers.add_surface(id, *lid);
1274 // set the main_surface[_name] here and now
1275 if (!this->layers.main_surface_name.empty() &&
1276 this->layers.main_surface_name == drawing_name)
1278 this->layers.main_surface = id;
1279 HMI_DEBUG("wm", "Set main_surface id to %u", id);
1282 // add client into the db
1283 std::string appid_str(appid);
1284 std::string role(drawing_name);
1285 //g_app_list.addClient(appid_str, role);
1286 g_app_list.addClient(appid_str, *lid, id, role);
1291 // Check currently registered drawing names if it is already there.
1292 return Err<int>("Surface already present");
1295 char const *App::api_request_surface(char const *appid, char const *drawing_name,
1300 auto lid = this->layers.get_layer_id(std::string(drawing_name));
1301 unsigned sid = std::stol(ivi_id);
1306 * register drawing_name as fallback and make it displayed.
1308 lid = this->layers.get_layer_id(std::string("Fallback"));
1309 HMI_DEBUG("wm", "%s is not registered in layers.json, then fallback as normal app", drawing_name);
1312 return "Drawing name does not match any role, Fallback is disabled";
1316 auto rname = this->lookup_id(drawing_name);
1320 return "Surface already present";
1323 // register pair drawing_name and ivi_id
1324 this->id_alloc.register_name_id(drawing_name, sid);
1325 this->layers.add_surface(sid, *lid);
1327 // this surface is already created
1328 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
1330 this->controller->layers[*lid]->add_surface(sid);
1331 this->layout_commit();
1336 result<json_object *> App::api_get_display_info()
1339 if (!this->controller)
1341 return Err<json_object *>("ivi_controller global not available");
1345 compositor::size o_size = this->controller->output_size;
1346 compositor::size p_size = this->controller->physical_size;
1348 json_object *object = json_object_new_object();
1349 json_object_object_add(object, kKeyWidthPixel, json_object_new_int(o_size.w));
1350 json_object_object_add(object, kKeyHeightPixel, json_object_new_int(o_size.h));
1351 json_object_object_add(object, kKeyWidthMm, json_object_new_int(p_size.w));
1352 json_object_object_add(object, kKeyHeightMm, json_object_new_int(p_size.h));
1354 return Ok<json_object *>(object);
1357 result<json_object *> App::api_get_area_info(char const *drawing_name)
1359 HMI_DEBUG("wm", "called");
1361 // Check drawing name, surface/layer id
1362 auto const &surface_id = this->lookup_id(drawing_name);
1365 return Err<json_object *>("Surface does not exist");
1368 if (!this->controller->surface_exists(*surface_id))
1370 return Err<json_object *>("Surface does not exist in controller!");
1373 auto layer_id = this->layers.get_layer_id(*surface_id);
1376 return Err<json_object *>("Surface is not on any layer!");
1379 auto o_state = *this->layers.get_layout_state(*surface_id);
1380 if (o_state == nullptr)
1382 return Err<json_object *>("Could not find layer for surface");
1385 struct LayoutState &state = *o_state;
1386 if ((state.main != *surface_id) && (state.sub != *surface_id))
1388 return Err<json_object *>("Surface is inactive");
1391 // Set area rectangle
1392 compositor::rect area_info = this->area_info[*surface_id];
1393 json_object *object = json_object_new_object();
1394 json_object_object_add(object, kKeyX, json_object_new_int(area_info.x));
1395 json_object_object_add(object, kKeyY, json_object_new_int(area_info.y));
1396 json_object_object_add(object, kKeyWidth, json_object_new_int(area_info.w));
1397 json_object_object_add(object, kKeyHeight, json_object_new_int(area_info.h));
1399 return Ok<json_object *>(object);
1402 void App::activate(int id)
1404 auto ip = this->controller->sprops.find(id);
1405 if (ip != this->controller->sprops.end())
1407 this->controller->surfaces[id]->set_visibility(1);
1409 this->lookup_name(id).value_or("unknown-name").c_str();
1412 if ((0 == strcmp(label, "Radio")) ||
1413 (0 == strcmp(label, "MediaPlayer")) ||
1414 (0 == strcmp(label, "Music")) ||
1415 (0 == strcmp(label, "Navigation")))
1417 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i)
1422 this->surface_bg.erase(i);
1424 // Remove from BG layer (999)
1425 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
1426 this->controller->layers[999]->remove_surface(id);
1428 // Add to FG layer (1001)
1429 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
1430 this->controller->layers[1001]->add_surface(id);
1432 for (int j : this->surface_bg)
1434 HMI_DEBUG("wm", "Stored id:%d", j);
1441 this->layout_commit();
1443 this->emit_visible(label);
1444 this->emit_activated(label);
1448 void App::deactivate(int id)
1450 auto ip = this->controller->sprops.find(id);
1451 if (ip != this->controller->sprops.end())
1454 this->lookup_name(id).value_or("unknown-name").c_str();
1457 if ((0 == strcmp(label, "Radio")) || (0 == strcmp(label, "MediaPlayer")) || (0 == strcmp(label, "Music")) || (0 == strcmp(label, "Navigation")))
1461 this->surface_bg.push_back(id);
1463 // Remove from FG layer (1001)
1464 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
1465 this->controller->layers[1001]->remove_surface(id);
1467 // Add to BG layer (999)
1468 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
1469 this->controller->layers[999]->add_surface(id);
1471 for (int j : surface_bg)
1473 HMI_DEBUG("wm", "Stored id:%d", j);
1478 this->controller->surfaces[id]->set_visibility(0);
1482 this->emit_deactivated(label);
1483 this->emit_invisible(label);
1487 bool App::can_split(struct LayoutState const &state, int new_id)
1489 if (state.main != -1 && state.main != new_id)
1491 auto new_id_layer = this->layers.get_layer_id(new_id).value();
1492 auto current_id_layer = this->layers.get_layer_id(state.main).value();
1494 // surfaces are on separate layers, don't bother.
1495 if (new_id_layer != current_id_layer)
1500 std::string const &new_id_str = this->lookup_name(new_id).value();
1501 std::string const &cur_id_str = this->lookup_name(state.main).value();
1503 auto const &layer = this->layers.get_layer(new_id_layer);
1505 HMI_DEBUG("wm", "layer info name: %s", layer->name.c_str());
1507 if (layer->layouts.empty())
1512 for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++)
1514 HMI_DEBUG("wm", "%d main_match '%s'", new_id_layer, i->main_match.c_str());
1515 auto rem = std::regex(i->main_match);
1516 if (std::regex_match(cur_id_str, rem))
1518 // build the second one only if the first already matched
1519 HMI_DEBUG("wm", "%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
1520 auto res = std::regex(i->sub_match);
1521 if (std::regex_match(new_id_str, res))
1523 HMI_DEBUG("wm", "layout matched!");
1533 void App::try_layout(struct LayoutState & /*state*/,
1534 struct LayoutState const &new_layout,
1535 std::function<void(LayoutState const &nl)> apply)
1537 if (this->policy.layout_is_valid(new_layout))
1546 void controller_hooks::surface_created(uint32_t surface_id)
1548 this->app->surface_created(surface_id);
1551 void controller_hooks::surface_removed(uint32_t surface_id)
1553 this->app->surface_removed(surface_id);
1556 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
1559 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,