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 "util.hpp"
  20 #include <ilm/ilm_control.h>
  21
  22 #define INVALID_SURFACE_ID 0
  23
  24 using std::string;
  25 using std::vector;
  26
  27 namespace wm
  28 {
  29
  30 static const vector<string> kWMEvents = {
  31     // Private event for applications
  32     "syncDraw", "flushDraw", "visible", "invisible", "active", "inactive", "error"};
  33 static const vector<string> kErrorDescription = {
  34     "unknown-error"};
  35
  36 static const char kKeyDrawingName[] = "drawing_name";
  37 static const char kKeyrole[] = "role";
  38 static const char kKeyError[] = "error";
  39 static const char kKeyErrorDesc[] = "kErrorDescription";
  40
  41 WMClient::WMClient(const string &appid, unsigned layer, unsigned surface, const string &role)
  42     : id(appid), layer(layer),
  43       role2surface(0)
  44 {
  45     role2surface[role] = surface;
  46     for (auto x : kWMEvents)
  47     {
  48 #if GTEST_ENABLED
  49         string ev = x;
  50 #else
  51         afb_event_t ev = afb_api_make_event(afbBindingV3root, x.c_str());
  52 #endif
  53         evname2list[x] = ev;
  54     }
  55 }
  56
  57 WMClient::WMClient(const string &appid, const string &role)
  58     : id(appid),
  59       layer(0),
  60       role2surface(0),
  61       evname2list(0)
  62 {
  63     role2surface[role] = INVALID_SURFACE_ID;
  64     for (auto x : kWMEvents)
  65     {
  66 #if GTEST_ENABLED
  67         string ev = x;
  68 #else
  69         afb_event_t ev = afb_api_make_event(afbBindingV3root, x.c_str());
  70 #endif
  71         evname2list[x] = ev;
  72     }
  73 }
  74
  75 WMClient::WMClient(const string &appid, unsigned layer, const string &role)
  76     : id(appid),
  77       layer(layer),
  78       main_role(role),
  79       role2surface(0),
  80       evname2list(0)
  81 {
  82     role2surface[role] = INVALID_SURFACE_ID;
  83     for (auto x : kWMEvents)
  84     {
  85 #if GTEST_ENABLED
  86         string ev = x;
  87 #else
  88         afb_event_t ev = afb_api_make_event(afbBindingV3root, x.c_str());
  89 #endif
  90         evname2list[x] = ev;
  91     }
  92 }
  93
  94 string WMClient::appID() const
  95 {
  96     return this->id;
  97 }
  98
  99 string WMClient::role() const
 100 {
 101     return this->main_role;
 102 }
 103
 104 unsigned WMClient::layerID() const
 105 {
 106     return this->layer;
 107 }
 108
 109 unsigned WMClient::surfaceID() const
 110 {
 111     return this->surface;
 112 }
 113
 114 void WMClient::registerSurface(unsigned surface)
 115 {
 116     this->surface = surface;
 117 }
 118
 119 /**
 120  * Add surface to the client
 121  *
 122  * This function add main surface to the client(ivi_layer).
 123  *
 124  * @param     string[in] role
 125  * @return    WMError
 126  */
 127 WMError WMClient::addSurface(unsigned surface)
 128 {
 129     this->surface = surface;
 130     ilmErrorTypes err = ilm_layerAddSurface(this->layer, surface);
 131
 132     if(err == ILM_SUCCESS)
 133     {
 134         err = ilm_commitChanges();
 135     }
 136     return (err == ILM_SUCCESS) ? WMError::SUCCESS : WMError::FAIL;
 137 }
 138
 139 bool WMClient::removeSurfaceIfExist(unsigned surface)
 140 {
 141     bool ret = false;
 142     if(surface == this->surface)
 143     {
 144         this->surface = INVALID_SURFACE_ID;
 145         ret = true;
 146     }
 147     return ret;
 148 }
 149
 150
 151 #if GTEST_ENABLED
 152 bool WMClient::subscribe(afb_req_t req, const string &evname)
 153 {
 154     if(evname != kKeyError){
 155         HMI_DEBUG("error is only enabeled for now");
 156         return false;
 157     }
 158     int ret = afb_req_subscribe(req, this->evname2list[evname]);
 159     if (ret)
 160     {
 161         HMI_DEBUG("Failed to subscribe %s", evname.c_str());
 162         return false;
 163     }
 164     return true;
 165 }
 166
 167 void WMClient::emitError(WM_CLIENT_ERROR_EVENT ev)
 168 {
 169     if (!afb_event_is_valid(this->evname2list[kKeyError])){
 170         HMI_ERROR("event err is not valid");
 171         return;
 172     }
 173     json_object *j = json_object_new_object();
 174     json_object_object_add(j, kKeyError, json_object_new_int(ev));
 175     json_object_object_add(j, kKeyErrorDesc, json_object_new_string(kErrorDescription[ev].c_str()));
 176     HMI_DEBUG("error: %d, description:%s", ev, kErrorDescription[ev].c_str());
 177
 178     int ret = afb_event_push(this->evname2list[kKeyError], j);
 179     if (ret != 0)
 180     {
 181         HMI_DEBUG("afb_event_push failed: %m");
 182     }
 183 }
 184 #endif
 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