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 static const vector<string> kWMEvents = {
  30     // Private event for applications
  31     "syncDraw", "flushDraw", "visible", "invisible", "active", "inactive", "error"};
  32 static 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         return INVALID_SURFACE_ID;
  88     }
  89     return this->role2surface.at(role);
  90 }
  91
  92 std::string WMClient::role(unsigned surface) const
  93 {
  94     for(const auto& x : this->role2surface)
  95     {
  96         if(x.second == surface)
  97         {
  98             return x.first;
  99         }
 100     }
 101     return std::string("");
 102 }
 103
 104 unsigned WMClient::layerID() const
 105 {
 106     return this->layer;
 107 }
 108
 109 /**
 110  * Set layerID the client belongs to
 111  *
 112  * This function set layerID the client belongs to.
 113  * But this function may not used because the layer should be fixed at constructor.
 114  * So this function will be used to change layer by some reasons.
 115  *
 116  * @param     unsigned[in] layerID
 117  * @return    None
 118  * @attention WMClient can't have multiple layer
 119  */
 120 void WMClient::registerLayer(unsigned layer)
 121 {
 122     this->layer = layer;
 123 }
 124
 125 /**
 126  * Add the pair of role and surface to the client
 127  *
 128  * This function set the pair of role and surface to the client.
 129  * This function is used for the client which has multi surfaces.
 130  * If the model and relationship for role and surface(layer)
 131  * is changed, this function will be changed
 132  * Current Window Manager doesn't use this function.
 133  *
 134  * @param     string[in] role
 135  * @param     unsigned[in] surface
 136  * @return    true
 137  */
 138 bool WMClient::addSurface(const string &role, unsigned surface)
 139 {
 140     HMI_DEBUG("wm", "Add role %s with surface %d", role.c_str(), surface);
 141     if (0 != this->role2surface.count(role))
 142     {
 143         HMI_NOTICE("wm", "override surfaceID %d with %d", this->role2surface[role], surface);
 144     }
 145     this->role2surface[role] = surface;
 146     return true;
 147 }
 148
 149 bool WMClient::removeSurfaceIfExist(unsigned surface)
 150 {
 151     bool ret = false;
 152     for (auto &x : this->role2surface)
 153     {
 154         if (surface == x.second)
 155         {
 156             HMI_INFO("wm", "Remove surface from client %s: role %s, surface: %d",
 157                                 this->id.c_str(), x.first.c_str(), x.second);
 158             this->role2surface.erase(x.first);
 159             ret = true;
 160             break;
 161         }
 162     }
 163     return ret;
 164 }
 165
 166 bool WMClient::removeRole(const string &role)
 167 {
 168     bool ret = false;
 169     if (this->role2surface.count(role) != 0)
 170     {
 171         this->role2surface.erase(role);
 172         ret = true;
 173     }
 174     return ret;
 175 }
 176
 177 #if GTEST_ENABLED
 178 bool WMClient::subscribe(afb_req req, const string &evname)
 179 {
 180     if(evname != kKeyError){
 181         HMI_DEBUG("wm", "error is only enabeled for now");
 182         return false;
 183     }
 184     int ret = afb_req_subscribe(req, this->event2list[evname]);
 185     if (ret)
 186     {
 187         HMI_DEBUG("wm", "Failed to subscribe %s", evname.c_str());
 188         return false;
 189     }
 190     return true;
 191 }
 192
 193 void WMClient::emitError(WM_CLIENT_ERROR_EVENT ev)
 194 {
 195     if (!afb_event_is_valid(this->event2list[kKeyError])){
 196         HMI_ERROR("wm", "event err is not valid");
 197         return;
 198     }
 199     json_object *j = json_object_new_object();
 200     json_object_object_add(j, kKeyError, json_object_new_int(ev));
 201     json_object_object_add(j, kKeyErrorDesc, json_object_new_string(kErrorDescription[ev].c_str()));
 202     HMI_DEBUG("wm", "error: %d, description:%s", ev, kErrorDescription[ev].c_str());
 203
 204     int ret = afb_event_push(this->event2list[kKeyError], j);
 205     if (ret != 0)
 206     {
 207         HMI_DEBUG("wm", "afb_event_push failed: %m");
 208     }
 209 }
 210 #endif
 211
 212 void WMClient::dumpInfo()
 213 {
 214     DUMP("APPID : %s", id.c_str());
 215     DUMP("  LAYER : %d", layer);
 216     for (const auto &x : this->role2surface)
 217     {
 218         DUMP("  ROLE  : %s , SURFACE : %d", x.first.c_str(), x.second);
 219     }
 220 }
 221
 222 } // namespace wm