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>
45 result<json> file_to_json(char const *filename) {
47 std::ifstream i(filename);
49 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
50 j = default_layers_json;
59 struct result<layer_map> load_layer_map(char const *filename) {
60 HMI_DEBUG("wm", "loading IDs from %s", filename);
62 auto j = file_to_json(filename);
64 return Err<layer_map>(j.unwrap_err());
66 json jids = j.unwrap();
68 return to_layer_map(jids);
77 App::App(wl::display *d)
85 pending_events(false),
89 auto l = load_layer_map(
90 this->config.get_string("layers.json").value().c_str());
92 this->layers = l.unwrap();
94 HMI_ERROR("wm", "%s", l.err().value());
97 } catch (std::exception &e) {
98 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
103 if (!this->display->ok()) {
107 if (this->layers.mapping.empty()) {
108 HMI_ERROR("wm", "No surface -> layer mapping loaded");
113 for (int i=Event_Val_Min; i<=Event_Val_Max; i++) {
114 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
117 this->display->add_global_handler(
118 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
119 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
122 this->display->add_global_handler(
123 "ivi_wm", [this](wl_registry *r, uint32_t name, uint32_t v) {
125 std::make_unique<struct compositor::controller>(r, name, v);
127 // Init controller hooks
128 this->controller->chooks = &this->chooks;
130 // This protocol needs the output, so lets just add our mapping here...
131 this->controller->add_proxy_to_id_mapping(
132 this->outputs.back()->proxy.get(),
133 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
134 this->outputs.back()->proxy.get())));
137 this->controller->create_screen(this->outputs.back()->proxy.get());
139 // Set display to controller
140 this->controller->display = this->display;
143 // First level objects
144 this->display->roundtrip();
145 // Second level objects
146 this->display->roundtrip();
147 // Third level objects
148 this->display->roundtrip();
150 return init_layers();
153 int App::dispatch_pending_events() {
154 if (this->pop_pending_events()) {
155 this->display->dispatch_pending();
161 bool App::pop_pending_events() {
163 return this->pending_events.compare_exchange_strong(
164 x, false, std::memory_order_consume);
167 void App::set_pending_events() {
168 this->pending_events.store(true, std::memory_order_release);
171 optional<int> App::lookup_id(char const *name) {
172 return this->id_alloc.lookup(std::string(name));
174 optional<std::string> App::lookup_name(int id) {
175 return this->id_alloc.lookup(id);
181 int App::init_layers() {
182 if (!this->controller) {
183 HMI_ERROR("wm", "ivi_controller global not available");
187 if (this->outputs.empty()) {
188 HMI_ERROR("wm", "no output was set up!");
192 auto &c = this->controller;
194 auto &o = this->outputs.front();
195 auto &s = c->screens.begin()->second;
196 auto &layers = c->layers;
198 // Write output dimensions to ivi controller...
199 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
207 // Quick and dirty setup of layers
208 for (auto const &i : this->layers.mapping) {
209 c->layer_create(i.second.layer_id, o->width, o->height);
210 auto &l = layers[i.second.layer_id];
211 l->set_destination_rectangle(0, 0, o->width, o->height);
212 l->set_visibility(1);
213 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
214 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
217 // Add layers to screen
218 s->set_render_order(this->layers.layers);
220 this->layout_commit();
225 void App::surface_set_layout(int surface_id, optional<int> sub_surface_id) {
226 if (!this->controller->surface_exists(surface_id)) {
227 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
231 auto o_layer_id = this->layers.get_layer_id(surface_id);
234 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
238 uint32_t layer_id = *o_layer_id;
240 auto const &layer = this->layers.get_layer(layer_id);
241 auto rect = layer.value().rect;
242 auto &s = this->controller->surfaces[surface_id];
249 // less-than-0 values refer to MAX + 1 - $VALUE
250 // e.g. MAX is either screen width or height
252 w = this->controller->output_size.w + 1 + w;
255 h = this->controller->output_size.h + 1 + h;
258 if (sub_surface_id) {
259 if (o_layer_id != this->layers.get_layer_id(*sub_surface_id)) {
261 "surface_set_layout: layers of surfaces (%d and %d) don't match!",
262 surface_id, *sub_surface_id);
269 // split along major axis
278 auto &ss = this->controller->surfaces[*sub_surface_id];
280 HMI_DEBUG("wm", "surface_set_layout for sub surface %u on layer %u",
281 *sub_surface_id, layer_id);
283 // set destination to the display rectangle
284 ss->set_destination_rectangle(x + x_off, y + y_off, w, h);
288 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
291 // set destination to the display rectangle
292 s->set_destination_rectangle(x, y, w, h);
294 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
295 surface_id, layer_id, x, y, w, h);
298 void App::layout_commit() {
299 this->controller->commit_changes();
300 this->display->flush();
303 char const *App::api_activate_surface(char const *drawing_name, char const *drawing_area) {
306 auto const &surface_id = this->lookup_id(drawing_name);
309 return "Surface does not exist";
312 if (!this->controller->surface_exists(*surface_id)) {
313 return "Surface does not exist in controller!";
316 auto layer_id = this->layers.get_layer_id(*surface_id);
319 return "Surface is not on any layer!";
322 auto o_state = *this->layers.get_layout_state(*surface_id);
324 if (o_state == nullptr) {
325 return "Could not find layer for surface";
328 struct LayoutState &state = *o_state;
330 // disable layers that are above our current layer
331 for (auto const &l : this->layers.mapping) {
332 if (l.second.layer_id <= *layer_id) {
337 if (l.second.state.main != -1) {
338 this->deactivate(l.second.state.main);
339 l.second.state.main = -1;
343 if (l.second.state.sub != -1) {
344 this->deactivate(l.second.state.sub);
345 l.second.state.sub = -1;
350 this->layout_commit();
354 auto layer = this->layers.get_layer(*layer_id);
356 if (state.main == -1) {
358 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
359 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
360 this->surface_set_layout(*surface_id);
363 // Commit for configuraton
364 this->layout_commit();
366 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
367 this->emit_syncdraw(drawing_name, str_area.c_str());
368 this->enqueue_flushdraw(state.main);
371 if (0 == strcmp(drawing_name, "HomeScreen")) {
373 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
374 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
375 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
376 this->emit_syncdraw(drawing_name, str_area.c_str());
377 this->enqueue_flushdraw(state.main);
380 bool can_split = this->can_split(state, *surface_id);
385 LayoutState{state.main, *surface_id},
386 [&] (LayoutState const &nl) {
387 HMI_DEBUG("wm", "Layout: %s", kNameLayoutSplit);
389 std::move(*this->lookup_name(state.main));
391 this->surface_set_layout(state.main, surface_id);
392 if (state.sub != *surface_id) {
393 if (state.sub != -1) {
394 this->deactivate(state.sub);
399 // Commit for configuration and visibility(0)
400 this->layout_commit();
402 std::string str_area_main = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaMain);
403 std::string str_area_sub = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaSub);
404 this->emit_syncdraw(main.c_str(), str_area_main.c_str());
405 this->emit_syncdraw(drawing_name, str_area_sub.c_str());
406 this->enqueue_flushdraw(state.main);
407 this->enqueue_flushdraw(state.sub);
411 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
412 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
414 this->surface_set_layout(*surface_id);
415 if (state.main != *surface_id) {
416 this->deactivate(state.main);
418 if (state.sub != -1) {
419 if (state.sub != *surface_id) {
420 this->deactivate(state.sub);
425 // Commit for configuraton and visibility(0)
426 this->layout_commit();
428 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
429 this->emit_syncdraw(drawing_name, str_area.c_str());
430 this->enqueue_flushdraw(state.main);
440 char const *App::api_deactivate_surface(char const *drawing_name) {
442 auto const &surface_id = this->lookup_id(drawing_name);
445 return "Surface does not exist";
448 if (*surface_id == this->layers.main_surface) {
449 return "Cannot deactivate main_surface";
452 auto o_state = *this->layers.get_layout_state(*surface_id);
454 if (o_state == nullptr) {
455 return "Could not find layer for surface";
458 struct LayoutState &state = *o_state;
460 if (state.main == -1) {
461 return "No surface active";
464 // Check against main_surface, main_surface_name is the configuration item.
465 if (*surface_id == this->layers.main_surface) {
466 HMI_DEBUG("wm", "Refusing to deactivate main_surface %d", *surface_id);
470 if (state.main == *surface_id) {
471 if (state.sub != -1) {
473 state, LayoutState{state.sub, -1}, [&] (LayoutState const &nl) {
474 std::string sub = std::move(*this->lookup_name(state.sub));
476 this->deactivate(*surface_id);
477 this->surface_set_layout(state.sub);
480 this->layout_commit();
481 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
482 this->emit_syncdraw(sub.c_str(), str_area.c_str());
483 this->enqueue_flushdraw(state.sub);
486 this->try_layout(state, LayoutState{-1, -1}, [&] (LayoutState const &nl) {
487 this->deactivate(*surface_id);
489 this->layout_commit();
492 } else if (state.sub == *surface_id) {
494 state, LayoutState{state.main, -1}, [&] (LayoutState const &nl) {
495 std::string main = std::move(*this->lookup_name(state.main));
497 this->deactivate(*surface_id);
498 this->surface_set_layout(state.main);
501 this->layout_commit();
502 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
503 this->emit_syncdraw(main.c_str(), str_area.c_str());
504 this->enqueue_flushdraw(state.main);
507 return "Surface is not active";
513 void App::enqueue_flushdraw(int surface_id) {
514 this->check_flushdraw(surface_id);
515 HMI_DEBUG("wm", "Enqueuing EndDraw for surface_id %d", surface_id);
516 this->pending_end_draw.push_back(surface_id);
519 void App::check_flushdraw(int surface_id) {
520 auto i = std::find(std::begin(this->pending_end_draw),
521 std::end(this->pending_end_draw), surface_id);
522 if (i != std::end(this->pending_end_draw)) {
523 auto n = this->lookup_name(surface_id);
524 HMI_ERROR("wm", "Application %s (%d) has pending EndDraw call(s)!",
525 n ? n->c_str() : "unknown-name", surface_id);
526 std::swap(this->pending_end_draw[std::distance(
527 std::begin(this->pending_end_draw), i)],
528 this->pending_end_draw.back());
529 this->pending_end_draw.resize(this->pending_end_draw.size() - 1);
533 char const *App::api_enddraw(char const *drawing_name) {
534 for (unsigned i = 0, iend = this->pending_end_draw.size(); i < iend; i++) {
535 auto n = this->lookup_name(this->pending_end_draw[i]);
536 if (n && *n == drawing_name) {
537 std::swap(this->pending_end_draw[i], this->pending_end_draw[iend - 1]);
538 this->pending_end_draw.resize(iend - 1);
539 this->activate(this->pending_end_draw[i]);
540 this->layout_commit();
541 this->emit_flushdraw(drawing_name);
545 return "No EndDraw pending for surface";
548 void App::api_ping() { this->dispatch_pending_events(); }
550 void App::send_event(char const *evname, char const *label){
551 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
553 json_object *j = json_object_new_object();
554 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
556 int ret = afb_event_push(this->map_afb_event[evname], j);
558 HMI_DEBUG("wm", "afb_event_push failed: %m");
562 void App::send_event(char const *evname, char const *label, char const *area){
563 HMI_DEBUG("wm", "%s: %s(%s, %s)", __func__, evname, label, area);
565 json_object *j = json_object_new_object();
566 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
567 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
569 int ret = afb_event_push(this->map_afb_event[evname], j);
571 HMI_DEBUG("wm", "afb_event_push failed: %m");
578 void App::surface_created(uint32_t surface_id) {
579 auto layer_id = this->layers.get_layer_id(surface_id);
581 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
586 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
588 this->controller->layers[*layer_id]->add_surface(surface_id);
589 this->layout_commit();
590 // activate the main_surface right away
591 /*if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
592 HMI_DEBUG("wm", "Activating main_surface (%d)", surface_id);
594 this->api_activate_surface(
595 this->lookup_name(surface_id).value_or("unknown-name").c_str());
599 void App::surface_removed(uint32_t surface_id) {
600 HMI_DEBUG("wm", "surface_id is %u", surface_id);
602 // We cannot normally deactivate the main_surface, so be explicit
604 if (int(surface_id) == this->layers.main_surface) {
605 this->deactivate_main_surface();
607 auto drawing_name = this->lookup_name(surface_id);
609 this->api_deactivate_surface(drawing_name->c_str());
613 this->id_alloc.remove_id(surface_id);
614 this->layers.remove_surface(surface_id);
617 void App::emit_activated(char const *label) {
618 this->send_event(kListEventName[Event_Active], label);
621 void App::emit_deactivated(char const *label) {
622 this->send_event(kListEventName[Event_Inactive], label);
625 void App::emit_syncdraw(char const *label, char const *area) {
626 this->send_event(kListEventName[Event_SyncDraw], label, area);
629 void App::emit_flushdraw(char const *label) {
630 this->send_event(kListEventName[Event_FlushDraw], label);
633 void App::emit_visible(char const *label, bool is_visible) {
634 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
637 void App::emit_invisible(char const *label) {
638 return emit_visible(label, false);
641 void App::emit_visible(char const *label) { return emit_visible(label, true); }
643 result<int> App::api_request_surface(char const *drawing_name) {
644 auto lid = this->layers.get_layer_id(std::string(drawing_name));
646 // TODO: Do we need to put these applications on the App layer?
647 return Err<int>("Drawing name does not match any role");
650 auto rname = this->lookup_id(drawing_name);
652 // name does not exist yet, allocate surface id...
653 auto id = int(this->id_alloc.generate_id(drawing_name));
654 this->layers.add_surface(id, *lid);
656 // set the main_surface[_name] here and now
657 if (!this->layers.main_surface_name.empty() &&
658 this->layers.main_surface_name == drawing_name) {
659 this->layers.main_surface = id;
660 HMI_DEBUG("wm", "Set main_surface id to %u", id);
666 // Check currently registered drawing names if it is already there.
667 return Err<int>("Surface already present");
670 char const *App::api_request_surface(char const *drawing_name,
671 char const *ivi_id) {
674 auto lid = this->layers.get_layer_id(std::string(drawing_name));
675 unsigned sid = std::stol(ivi_id);
678 return "Drawing name does not match any role";
681 auto rname = this->lookup_id(drawing_name);
684 return "Surface already present";
687 // register pair drawing_name and ivi_id
688 this->id_alloc.register_name_id(drawing_name, sid);
689 this->layers.add_surface(sid, *lid);
691 // this surface is already created
692 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
694 this->controller->layers[*lid]->add_surface(sid);
695 this->layout_commit();
700 void App::activate(int id) {
701 auto ip = this->controller->sprops.find(id);
702 if (ip != this->controller->sprops.end()) {
703 this->controller->surfaces[id]->set_visibility(1);
705 this->lookup_name(id).value_or("unknown-name").c_str();
708 if ((0 == strcmp(label, "Radio"))
709 || (0 == strcmp(label, "MediaPlayer"))
710 || (0 == strcmp(label, "Music"))
711 || (0 == strcmp(label, "Navigation"))) {
712 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i) {
715 this->surface_bg.erase(i);
717 // Remove from BG layer (999)
718 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
719 this->controller->layers[999]->remove_surface(id);
721 // Add to FG layer (1001)
722 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
723 this->controller->layers[1001]->add_surface(id);
725 for (int j : this->surface_bg) {
726 HMI_DEBUG("wm", "Stored id:%d", j);
734 this->emit_visible(label);
735 this->emit_activated(label);
739 void App::deactivate(int id) {
740 auto ip = this->controller->sprops.find(id);
741 if (ip != this->controller->sprops.end()) {
743 this->lookup_name(id).value_or("unknown-name").c_str();
746 if ((0 == strcmp(label, "Radio"))
747 || (0 == strcmp(label, "MediaPlayer"))
748 || (0 == strcmp(label, "Music"))
749 || (0 == strcmp(label, "Navigation"))) {
752 this->surface_bg.push_back(id);
754 // Remove from FG layer (1001)
755 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
756 this->controller->layers[1001]->remove_surface(id);
758 // Add to BG layer (999)
759 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
760 this->controller->layers[999]->add_surface(id);
762 for (int j : surface_bg) {
763 HMI_DEBUG("wm", "Stored id:%d", j);
767 this->controller->surfaces[id]->set_visibility(0);
771 this->emit_deactivated(label);
772 this->emit_invisible(label);
776 void App::deactivate_main_surface() {
777 this->layers.main_surface = -1;
778 this->api_deactivate_surface(this->layers.main_surface_name.c_str());
781 bool App::can_split(struct LayoutState const &state, int new_id) {
782 if (state.main != -1 && state.main != new_id) {
783 auto new_id_layer = this->layers.get_layer_id(new_id).value();
784 auto current_id_layer = this->layers.get_layer_id(state.main).value();
786 // surfaces are on separate layers, don't bother.
787 if (new_id_layer != current_id_layer) {
791 std::string const &new_id_str = this->lookup_name(new_id).value();
792 std::string const &cur_id_str = this->lookup_name(state.main).value();
794 auto const &layer = this->layers.get_layer(new_id_layer);
796 HMI_DEBUG("wm", "layer info name: %s", layer->name.c_str());
798 if (layer->layouts.empty()) {
802 for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++) {
803 HMI_DEBUG("wm", "%d main_match '%s'", new_id_layer, i->main_match.c_str());
804 auto rem = std::regex(i->main_match);
805 if (std::regex_match(cur_id_str, rem)) {
806 // build the second one only if the first already matched
807 HMI_DEBUG("wm", "%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
808 auto res = std::regex(i->sub_match);
809 if (std::regex_match(new_id_str, res)) {
810 HMI_DEBUG("wm", "layout matched!");
820 void App::try_layout(struct LayoutState & /*state*/,
821 struct LayoutState const &new_layout,
822 std::function<void(LayoutState const &nl)> apply) {
823 if (this->policy.layout_is_valid(new_layout)) {
831 void controller_hooks::surface_created(uint32_t surface_id) {
832 this->app->surface_created(surface_id);
835 void controller_hooks::surface_removed(uint32_t surface_id) {
836 this->app->surface_removed(surface_id);
839 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
842 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,