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.hpp"
29 #include <json-c/json.h>
32 #include <bits/signum.h>
46 result<json> file_to_json(char const *filename) {
48 std::ifstream i(filename);
50 HMI_DEBUG("wm", "Could not open config file, so use default layer information");
51 j = default_layers_json;
60 struct result<layer_map> load_layer_map(char const *filename) {
61 HMI_DEBUG("wm", "loading IDs from %s", filename);
63 auto j = file_to_json(filename);
65 return Err<layer_map>(j.unwrap_err());
67 json jids = j.unwrap();
69 return to_layer_map(jids);
78 App::App(wl::display *d)
86 pending_events(false),
90 auto l = load_layer_map(
91 this->config.get_string("layers.json").value().c_str());
93 this->layers = l.unwrap();
95 HMI_ERROR("wm", "%s", l.err().value());
98 } catch (std::exception &e) {
99 HMI_ERROR("wm", "Loading of configuration failed: %s", e.what());
104 if (!this->display->ok()) {
108 if (this->layers.mapping.empty()) {
109 HMI_ERROR("wm", "No surface -> layer mapping loaded");
114 for (int i=Event_Val_Min; i<=Event_Val_Max; i++) {
115 map_afb_event[kListEventName[i]] = afb_daemon_make_event(kListEventName[i]);
118 this->display->add_global_handler(
119 "wl_output", [this](wl_registry *r, uint32_t name, uint32_t v) {
120 this->outputs.emplace_back(std::make_unique<wl::output>(r, name, v));
123 this->display->add_global_handler(
124 "ivi_controller", [this](wl_registry *r, uint32_t name, uint32_t v) {
126 std::make_unique<struct compositor::controller>(r, name, v);
128 // Init controller hooks
129 this->controller->chooks = &this->chooks;
131 // This protocol needs the output, so lets just add our mapping here...
132 this->controller->add_proxy_to_id_mapping(
133 this->outputs.back()->proxy.get(),
134 wl_proxy_get_id(reinterpret_cast<struct wl_proxy *>(
135 this->outputs.back()->proxy.get())));
138 // First level objects
139 this->display->roundtrip();
140 // Second level objects
141 this->display->roundtrip();
142 // Third level objects
143 this->display->roundtrip();
145 return init_layers();
148 int App::dispatch_events() {
149 if (this->dispatch_events() == 0) {
153 int ret = this->display->dispatch();
155 HMI_ERROR("wm", "wl_display_dipatch() returned error %d",
156 this->display->get_error());
159 this->display->flush();
164 int App::dispatch_pending_events() {
165 if (this->pop_pending_events()) {
166 this->display->dispatch_pending();
172 bool App::pop_pending_events() {
174 return this->pending_events.compare_exchange_strong(
175 x, false, std::memory_order_consume);
178 void App::set_pending_events() {
179 this->pending_events.store(true, std::memory_order_release);
182 optional<int> App::lookup_id(char const *name) {
183 return this->id_alloc.lookup(std::string(name));
185 optional<std::string> App::lookup_name(int id) {
186 return this->id_alloc.lookup(id);
192 int App::init_layers() {
193 if (!this->controller) {
194 HMI_ERROR("wm", "ivi_controller global not available");
198 if (this->outputs.empty()) {
199 HMI_ERROR("wm", "no output was set up!");
203 auto &c = this->controller;
205 auto &o = this->outputs.front();
206 auto &s = c->screens.begin()->second;
207 auto &layers = c->layers;
209 // Write output dimensions to ivi controller...
210 c->output_size = compositor::size{uint32_t(o->width), uint32_t(o->height)};
218 // Quick and dirty setup of layers
219 for (auto const &i : this->layers.mapping) {
220 c->layer_create(i.second.layer_id, o->width, o->height);
221 auto &l = layers[i.second.layer_id];
222 l->set_destination_rectangle(0, 0, o->width, o->height);
223 l->set_visibility(1);
224 HMI_DEBUG("wm", "Setting up layer %s (%d) for surface role match \"%s\"",
225 i.second.name.c_str(), i.second.layer_id, i.second.role.c_str());
228 // Add layers to screen
229 s->set_render_order(this->layers.layers);
231 this->layout_commit();
236 void App::surface_set_layout(int surface_id, optional<int> sub_surface_id) {
237 if (!this->controller->surface_exists(surface_id)) {
238 HMI_ERROR("wm", "Surface %d does not exist", surface_id);
242 auto o_layer_id = this->layers.get_layer_id(surface_id);
245 HMI_ERROR("wm", "Surface %d is not associated with any layer!", surface_id);
249 uint32_t layer_id = *o_layer_id;
251 auto const &layer = this->layers.get_layer(layer_id);
252 auto rect = layer.value().rect;
253 auto &s = this->controller->surfaces[surface_id];
260 // less-than-0 values refer to MAX + 1 - $VALUE
261 // e.g. MAX is either screen width or height
263 w = this->controller->output_size.w + 1 + w;
266 h = this->controller->output_size.h + 1 + h;
269 if (sub_surface_id) {
270 if (o_layer_id != this->layers.get_layer_id(*sub_surface_id)) {
272 "surface_set_layout: layers of surfaces (%d and %d) don't match!",
273 surface_id, *sub_surface_id);
280 // split along major axis
289 auto &ss = this->controller->surfaces[*sub_surface_id];
291 HMI_DEBUG("wm", "surface_set_layout for sub surface %u on layer %u",
292 *sub_surface_id, layer_id);
294 // configure surface to wxh dimensions
295 ss->set_configuration(w, h);
296 // set source reactangle, even if we should not need to set it.
297 ss->set_source_rectangle(0, 0, w, h);
298 // set destination to the display rectangle
299 ss->set_destination_rectangle(x + x_off, y + y_off, w, h);
303 HMI_DEBUG("wm", "surface_set_layout for surface %u on layer %u", surface_id,
306 // configure surface to wxh dimensions
307 s->set_configuration(w, h);
308 // set source reactangle, even if we should not need to set it.
309 s->set_source_rectangle(0, 0, w, h);
311 // set destination to the display rectangle
312 s->set_destination_rectangle(x, y, w, h);
314 HMI_DEBUG("wm", "Surface %u now on layer %u with rect { %d, %d, %d, %d }",
315 surface_id, layer_id, x, y, w, h);
318 void App::layout_commit() {
319 this->controller->commit_changes();
320 this->display->flush();
323 char const *App::api_activate_surface(char const *drawing_name, char const *drawing_area) {
326 auto const &surface_id = this->lookup_id(drawing_name);
329 return "Surface does not exist";
332 if (!this->controller->surface_exists(*surface_id)) {
333 return "Surface does not exist in controller!";
336 auto layer_id = this->layers.get_layer_id(*surface_id);
339 return "Surface is not on any layer!";
342 auto o_state = *this->layers.get_layout_state(*surface_id);
344 if (o_state == nullptr) {
345 return "Could not find layer for surface";
348 struct LayoutState &state = *o_state;
350 // disable layers that are above our current layer
351 for (auto const &l : this->layers.mapping) {
352 if (l.second.layer_id <= *layer_id) {
357 if (l.second.state.main != -1) {
358 this->deactivate(l.second.state.main);
359 l.second.state.main = -1;
363 if (l.second.state.sub != -1) {
364 this->deactivate(l.second.state.sub);
365 l.second.state.sub = -1;
370 this->layout_commit();
374 auto layer = this->layers.get_layer(*layer_id);
376 if (state.main == -1) {
378 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
379 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
380 this->surface_set_layout(*surface_id);
383 // Commit for configuraton
384 this->layout_commit();
386 if (!(layer->is_normal_layout_only)) {
387 // Wait for configuration listener
388 controller->is_configured = false;
389 while (!(controller->is_configured)) {
390 dispatch_pending_events();
394 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
395 this->emit_syncdraw(drawing_name, str_area.c_str());
396 this->enqueue_flushdraw(state.main);
399 if (0 == strcmp(drawing_name, "HomeScreen")) {
401 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
402 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
403 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
404 this->emit_syncdraw(drawing_name, str_area.c_str());
405 this->enqueue_flushdraw(state.main);
408 bool can_split = this->can_split(state, *surface_id);
413 LayoutState{state.main, *surface_id},
414 [&] (LayoutState const &nl) {
415 HMI_DEBUG("wm", "Layout: %s", kNameLayoutSplit);
417 std::move(*this->lookup_name(state.main));
419 this->surface_set_layout(state.main, surface_id);
420 if (state.sub != *surface_id) {
421 if (state.sub != -1) {
422 this->deactivate(state.sub);
427 // Commit for configuraton and visibility(0)
428 this->layout_commit();
430 // Wait for configuration listener
431 controller->is_configured = false;
432 while (!(controller->is_configured)) {
433 dispatch_pending_events();
436 std::string str_area_main = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaMain);
437 std::string str_area_sub = std::string(kNameLayoutSplit) + "." + std::string(kNameAreaSub);
438 this->emit_syncdraw(main.c_str(), str_area_main.c_str());
439 this->emit_syncdraw(drawing_name, str_area_sub.c_str());
440 this->enqueue_flushdraw(state.main);
441 this->enqueue_flushdraw(state.sub);
445 state, LayoutState{*surface_id}, [&] (LayoutState const &nl) {
446 HMI_DEBUG("wm", "Layout: %s", kNameLayoutNormal);
448 this->surface_set_layout(*surface_id);
449 if (state.main != *surface_id) {
450 this->deactivate(state.main);
452 if (state.sub != -1) {
453 if (state.sub != *surface_id) {
454 this->deactivate(state.sub);
459 // Commit for configuraton and visibility(0)
460 this->layout_commit();
462 if (!(layer->is_normal_layout_only)) {
463 // Wait for configuration listener
464 controller->is_configured = false;
465 while (!(controller->is_configured)) {
466 dispatch_pending_events();
470 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
471 this->emit_syncdraw(drawing_name, str_area.c_str());
472 this->enqueue_flushdraw(state.main);
482 char const *App::api_deactivate_surface(char const *drawing_name) {
484 auto const &surface_id = this->lookup_id(drawing_name);
487 return "Surface does not exist";
490 if (*surface_id == this->layers.main_surface) {
491 return "Cannot deactivate main_surface";
494 auto o_state = *this->layers.get_layout_state(*surface_id);
496 if (o_state == nullptr) {
497 return "Could not find layer for surface";
500 struct LayoutState &state = *o_state;
502 if (state.main == -1) {
503 return "No surface active";
506 // Check against main_surface, main_surface_name is the configuration item.
507 if (*surface_id == this->layers.main_surface) {
508 HMI_DEBUG("wm", "Refusing to deactivate main_surface %d", *surface_id);
512 if (state.main == *surface_id) {
513 if (state.sub != -1) {
515 state, LayoutState{state.sub, -1}, [&] (LayoutState const &nl) {
516 std::string sub = std::move(*this->lookup_name(state.sub));
518 this->deactivate(*surface_id);
519 this->surface_set_layout(state.sub);
522 this->layout_commit();
523 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
524 this->emit_syncdraw(sub.c_str(), str_area.c_str());
525 this->enqueue_flushdraw(state.sub);
528 this->try_layout(state, LayoutState{-1, -1}, [&] (LayoutState const &nl) {
529 this->deactivate(*surface_id);
531 this->layout_commit();
534 } else if (state.sub == *surface_id) {
536 state, LayoutState{state.main, -1}, [&] (LayoutState const &nl) {
537 std::string main = std::move(*this->lookup_name(state.main));
539 this->deactivate(*surface_id);
540 this->surface_set_layout(state.main);
543 this->layout_commit();
544 std::string str_area = std::string(kNameLayoutNormal) + "." + std::string(kNameAreaFull);
545 this->emit_syncdraw(main.c_str(), str_area.c_str());
546 this->enqueue_flushdraw(state.main);
549 return "Surface is not active";
555 void App::enqueue_flushdraw(int surface_id) {
556 this->check_flushdraw(surface_id);
557 HMI_DEBUG("wm", "Enqueuing EndDraw for surface_id %d", surface_id);
558 this->pending_end_draw.push_back(surface_id);
561 void App::check_flushdraw(int surface_id) {
562 auto i = std::find(std::begin(this->pending_end_draw),
563 std::end(this->pending_end_draw), surface_id);
564 if (i != std::end(this->pending_end_draw)) {
565 auto n = this->lookup_name(surface_id);
566 HMI_ERROR("wm", "Application %s (%d) has pending EndDraw call(s)!",
567 n ? n->c_str() : "unknown-name", surface_id);
568 std::swap(this->pending_end_draw[std::distance(
569 std::begin(this->pending_end_draw), i)],
570 this->pending_end_draw.back());
571 this->pending_end_draw.resize(this->pending_end_draw.size() - 1);
575 char const *App::api_enddraw(char const *drawing_name) {
576 for (unsigned i = 0, iend = this->pending_end_draw.size(); i < iend; i++) {
577 auto n = this->lookup_name(this->pending_end_draw[i]);
578 if (n && *n == drawing_name) {
579 std::swap(this->pending_end_draw[i], this->pending_end_draw[iend - 1]);
580 this->pending_end_draw.resize(iend - 1);
581 this->activate(this->pending_end_draw[i]);
582 this->layout_commit();
583 this->emit_flushdraw(drawing_name);
587 return "No EndDraw pending for surface";
590 void App::api_ping() { this->dispatch_pending_events(); }
592 void App::send_event(char const *evname, char const *label){
593 HMI_DEBUG("wm", "%s: %s(%s)", __func__, evname, label);
595 json_object *j = json_object_new_object();
596 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
598 int ret = afb_event_push(this->map_afb_event[evname], j);
600 HMI_DEBUG("wm", "afb_event_push failed: %m");
604 void App::send_event(char const *evname, char const *label, char const *area){
605 HMI_DEBUG("wm", "%s: %s(%s, %s)", __func__, evname, label, area);
607 json_object *j = json_object_new_object();
608 json_object_object_add(j, kKeyDrawingName, json_object_new_string(label));
609 json_object_object_add(j, kKeyDrawingArea, json_object_new_string(area));
611 int ret = afb_event_push(this->map_afb_event[evname], j);
613 HMI_DEBUG("wm", "afb_event_push failed: %m");
620 void App::surface_created(uint32_t surface_id) {
621 auto layer_id = this->layers.get_layer_id(surface_id);
623 HMI_DEBUG("wm", "Newly created surfce %d is not associated with any layer!",
628 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", surface_id, *layer_id);
630 this->controller->layers[*layer_id]->add_surface(
631 this->controller->surfaces[surface_id].get());
633 // activate the main_surface right away
634 /*if (surface_id == static_cast<unsigned>(this->layers.main_surface)) {
635 HMI_DEBUG("wm", "Activating main_surface (%d)", surface_id);
637 this->api_activate_surface(
638 this->lookup_name(surface_id).value_or("unknown-name").c_str());
642 void App::surface_removed(uint32_t surface_id) {
643 HMI_DEBUG("wm", "surface_id is %u", surface_id);
645 // We cannot normally deactivate the main_surface, so be explicit
647 if (int(surface_id) == this->layers.main_surface) {
648 this->deactivate_main_surface();
650 auto drawing_name = this->lookup_name(surface_id);
652 this->api_deactivate_surface(drawing_name->c_str());
656 this->id_alloc.remove_id(surface_id);
657 this->layers.remove_surface(surface_id);
660 void App::emit_activated(char const *label) {
661 this->send_event(kListEventName[Event_Active], label);
664 void App::emit_deactivated(char const *label) {
665 this->send_event(kListEventName[Event_Inactive], label);
668 void App::emit_syncdraw(char const *label, char const *area) {
669 this->send_event(kListEventName[Event_SyncDraw], label, area);
672 void App::emit_flushdraw(char const *label) {
673 this->send_event(kListEventName[Event_FlushDraw], label);
676 void App::emit_visible(char const *label, bool is_visible) {
677 this->send_event(is_visible ? kListEventName[Event_Visible] : kListEventName[Event_Invisible], label);
680 void App::emit_invisible(char const *label) {
681 return emit_visible(label, false);
684 void App::emit_visible(char const *label) { return emit_visible(label, true); }
686 result<int> App::api_request_surface(char const *drawing_name) {
687 auto lid = this->layers.get_layer_id(std::string(drawing_name));
689 // TODO: Do we need to put these applications on the App layer?
690 return Err<int>("Drawing name does not match any role");
693 auto rname = this->lookup_id(drawing_name);
695 // name does not exist yet, allocate surface id...
696 auto id = int(this->id_alloc.generate_id(drawing_name));
697 this->layers.add_surface(id, *lid);
699 // set the main_surface[_name] here and now
700 if (!this->layers.main_surface_name.empty() &&
701 this->layers.main_surface_name == drawing_name) {
702 this->layers.main_surface = id;
703 HMI_DEBUG("wm", "Set main_surface id to %u", id);
709 // Check currently registered drawing names if it is already there.
710 return Err<int>("Surface already present");
713 char const *App::api_request_surface(char const *drawing_name,
714 char const *ivi_id) {
717 auto lid = this->layers.get_layer_id(std::string(drawing_name));
718 unsigned sid = std::stol(ivi_id);
721 return "Drawing name does not match any role";
724 auto rname = this->lookup_id(drawing_name);
727 return "Surface already present";
730 // register pair drawing_name and ivi_id
731 this->id_alloc.register_name_id(drawing_name, sid);
732 this->layers.add_surface(sid, *lid);
734 // this surface is already created
735 HMI_DEBUG("wm", "surface_id is %u, layer_id is %u", sid, *lid);
737 this->controller->layers[*lid]->add_surface(
738 this->controller->surfaces[sid].get());
743 void App::activate(int id) {
744 auto ip = this->controller->sprops.find(id);
745 if (ip != this->controller->sprops.end()) {
746 this->controller->surfaces[id]->set_visibility(0);
747 this->layout_commit();
748 this->controller->surfaces[id]->set_visibility(1);
750 this->lookup_name(id).value_or("unknown-name").c_str();
753 if ((0 == strcmp(label, "Radio"))
754 || (0 == strcmp(label, "MediaPlayer"))
755 || (0 == strcmp(label, "Music"))
756 || (0 == strcmp(label, "Navigation"))) {
757 for (auto i = surface_bg.begin(); i != surface_bg.end(); ++i) {
760 this->surface_bg.erase(i);
762 // Remove from BG layer (999)
763 HMI_DEBUG("wm", "Remove %s(%d) from BG layer", label, id);
764 this->controller->layers[999]->remove_surface(
765 this->controller->surfaces[id].get());
767 // Add to FG layer (1001)
768 HMI_DEBUG("wm", "Add %s(%d) to FG layer", label, id);
769 this->controller->layers[1001]->add_surface(
770 this->controller->surfaces[id].get());
772 for (int j : this->surface_bg) {
773 HMI_DEBUG("wm", "Stored id:%d", j);
781 this->emit_visible(label);
782 this->emit_activated(label);
786 void App::deactivate(int id) {
787 auto ip = this->controller->sprops.find(id);
788 if (ip != this->controller->sprops.end() && ip->second.visibility != 0) {
790 this->lookup_name(id).value_or("unknown-name").c_str();
793 if ((0 == strcmp(label, "Radio"))
794 || (0 == strcmp(label, "MediaPlayer"))
795 || (0 == strcmp(label, "Music"))
796 || (0 == strcmp(label, "Navigation"))) {
799 this->surface_bg.push_back(id);
801 // Remove from FG layer (1001)
802 HMI_DEBUG("wm", "Remove %s(%d) from FG layer", label, id);
803 this->controller->layers[1001]->remove_surface(
804 this->controller->surfaces[id].get());
806 // Add to BG layer (999)
807 HMI_DEBUG("wm", "Add %s(%d) to BG layer", label, id);
808 this->controller->layers[999]->add_surface(
809 this->controller->surfaces[id].get());
811 for (int j : surface_bg) {
812 HMI_DEBUG("wm", "Stored id:%d", j);
816 this->controller->surfaces[id]->set_visibility(0);
820 this->emit_deactivated(label);
821 this->emit_invisible(label);
825 void App::deactivate_main_surface() {
826 this->layers.main_surface = -1;
827 this->api_deactivate_surface(this->layers.main_surface_name.c_str());
830 bool App::can_split(struct LayoutState const &state, int new_id) {
831 if (state.main != -1 && state.main != new_id) {
832 auto new_id_layer = this->layers.get_layer_id(new_id).value();
833 auto current_id_layer = this->layers.get_layer_id(state.main).value();
835 // surfaces are on separate layers, don't bother.
836 if (new_id_layer != current_id_layer) {
840 std::string const &new_id_str = this->lookup_name(new_id).value();
841 std::string const &cur_id_str = this->lookup_name(state.main).value();
843 auto const &layer = this->layers.get_layer(new_id_layer);
845 HMI_DEBUG("wm", "layer info name: %s", layer->name.c_str());
847 if (layer->layouts.empty()) {
851 for (auto i = layer->layouts.cbegin(); i != layer->layouts.cend(); i++) {
852 HMI_DEBUG("wm", "%d main_match '%s'", new_id_layer, i->main_match.c_str());
853 auto rem = std::regex(i->main_match);
854 if (std::regex_match(cur_id_str, rem)) {
855 // build the second one only if the first already matched
856 HMI_DEBUG("wm", "%d sub_match '%s'", new_id_layer, i->sub_match.c_str());
857 auto res = std::regex(i->sub_match);
858 if (std::regex_match(new_id_str, res)) {
859 HMI_DEBUG("wm", "layout matched!");
869 void App::try_layout(struct LayoutState & /*state*/,
870 struct LayoutState const &new_layout,
871 std::function<void(LayoutState const &nl)> apply) {
872 if (this->policy.layout_is_valid(new_layout)) {
880 void controller_hooks::surface_created(uint32_t surface_id) {
881 this->app->surface_created(surface_id);
884 void controller_hooks::surface_removed(uint32_t surface_id) {
885 this->app->surface_removed(surface_id);
888 void controller_hooks::surface_visibility(uint32_t /*surface_id*/,
891 void controller_hooks::surface_destination_rectangle(uint32_t /*surface_id*/,