src/wm_client.cpp

   1 /*
   2  * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
   3  *
   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
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <json-c/json.h>
  18 #include "wm_client.hpp"
  19 #include "hmi-debug.h"
  20
  21 #define INVALID_SURFACE_ID 0
  22
  23 using std::string;
  24 using std::vector;
  25
  26 namespace wm
  27 {
  28
  29 const vector<string> kWMEvents = {
  30     // Private event for applications
  31     "syncDraw", "flushDraw", "visible", "invisible", "active", "inactive", "error"};
  32 const vector<string> kErrorDescription = {
  33     "unknown-error"};
  34
  35 static const char kKeyDrawingName[] = "drawing_name";
  36 static const char kKeyrole[] = "role";
  37 static const char kKeyError[] = "error";
  38 static const char kKeyErrorDesc[] = "kErrorDescription";
  39
  40 WMClient::WMClient(const string &appid, unsigned layer, unsigned surface, const string &role)
  41     : id(appid), layer(layer),
  42       role2surface(0)
  43 {
  44     role2surface[role] = surface;
  45     for (auto x : kWMEvents)
  46     {
  47 #if GTEST_ENABLED
  48         string ev = x;
  49 #else
  50         afb_event ev = afb_daemon_make_event(x.c_str());
  51 #endif
  52         event2list[x] = ev;
  53     }
  54 }
  55
  56 WMClient::WMClient(const string &appid, const string &role)
  57     : id(appid),
  58       layer(0),
  59       role2surface(0),
  60       event2list(0)
  61 {
  62     role2surface[role] = INVALID_SURFACE_ID;
  63     for (auto x : kWMEvents)
  64     {
  65 #if GTEST_ENABLED
  66         string ev = x;
  67 #else
  68         afb_event ev = afb_daemon_make_event(x.c_str());
  69 #endif
  70         event2list[x] = ev;
  71     }
  72 }
  73
  74 WMClient::~WMClient()
  75 {
  76 }
  77
  78 string WMClient::appID() const
  79 {
  80     return this->id;
  81 }
  82
  83 unsigned WMClient::surfaceID(const string &role) const
  84 {
  85     if (0 == this->role2surface.count(role))
  86     {
  87         HMI_NOTICE("wm", "invalid role %s : appID : %s", role.c_str(), this->id.c_str());
  88         return INVALID_SURFACE_ID;
  89     }
  90     return this->role2surface.at(role);
  91 }
  92
  93 std::string WMClient::role(unsigned surface) const
  94 {
  95     for(const auto& [key, value] : this->role2surface)
  96     {
  97         if(value == surface){
  98             return key;
  99         }
 100     }
 101     return std::string("");
 102 }
 103
 104 unsigned WMClient::layerID() const
 105 {
 106     return this->layer;
 107 }
 108
 109 void WMClient::registerLayer(unsigned layer)
 110 {
 111     this->layer = layer;
 112 }
 113
 114 bool WMClient::addSurface(const string &role, unsigned surface)
 115 {
 116     HMI_DEBUG("wm", "Add role %s with surface %d", role.c_str(), surface);
 117     if (0 != this->role2surface.count(role))
 118     {
 119         HMI_NOTICE("wm", "override surfaceID %d with %d", this->role2surface[role], surface);
 120     }
 121     this->role2surface[role] = surface;
 122     return true;
 123 }
 124
 125 bool WMClient::removeSurfaceIfExist(unsigned surface)
 126 {
 127     bool ret = false;
 128     for (auto &x : this->role2surface)
 129     {
 130         if (surface == x.second)
 131         {
 132             HMI_INFO("wm", "Remove surface from client %s: role %s, surface: %d",
 133                                 this->id.c_str(), x.first.c_str(), x.second);
 134             this->role2surface.erase(x.first);
 135             ret = true;
 136             break;
 137         }
 138     }
 139     return ret;
 140 }
 141
 142 bool WMClient::removeRole(const string &role)
 143 {
 144     bool ret = false;
 145     if (this->role2surface.count(role) != 0)
 146     {
 147         this->role2surface.erase(role);
 148         ret = true;
 149     }
 150     return ret;
 151 }
 152
 153 bool WMClient::subscribe(afb_req req, const string &evname)
 154 {
 155     if(evname != kKeyError){
 156         HMI_DEBUG("wm", "error is only enabeled for now");
 157         return false;
 158     }
 159     int ret = afb_req_subscribe(req, this->event2list[evname]);
 160     if (ret)
 161     {
 162         HMI_DEBUG("wm", "Failed to subscribe %s", evname.c_str());
 163         return false;
 164     }
 165     return true;
 166 }
 167
 168 void WMClient::emitError(WM_CLIENT_ERROR_EVENT ev)
 169 {
 170     if (!afb_event_is_valid(this->event2list[kKeyError])){
 171         HMI_ERROR("wm", "event err is not valid");
 172         return;
 173     }
 174     json_object *j = json_object_new_object();
 175     json_object_object_add(j, kKeyError, json_object_new_int(ev));
 176     json_object_object_add(j, kKeyErrorDesc, json_object_new_string(kErrorDescription[ev].c_str()));
 177     HMI_DEBUG("wm", "error: %d, description:%s", ev, kErrorDescription[ev].c_str());
 178
 179     int ret = afb_event_push(this->event2list[kKeyError], j);
 180     if (ret != 0)
 181     {
 182         HMI_DEBUG("wm", "afb_event_push failed: %m");
 183     }
 184 }
 185
 186 void WMClient::dumpInfo()
 187 {
 188     DUMP("APPID : %s", id.c_str());
 189     DUMP("  LAYER : %d", layer);
 190     for (const auto &x : this->role2surface)
 191     {
 192         DUMP("  ROLE  : %s , SURFACE : %d", x.first.c_str(), x.second);
 193     }
 194 }
 195
 196 } // namespace wm