Show debug message when incorrect role
[apps/agl-service-windowmanager.git] / 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             this->role2surface.erase(x.first);
133             ret = true;
134             break;
135         }
136     }
137     return ret;
138 }
139
140 bool WMClient::removeRole(const string &role)
141 {
142     bool ret = false;
143     if (this->role2surface.count(role) != 0)
144     {
145         this->role2surface.erase(role);
146         ret = true;
147     }
148     return ret;
149 }
150
151 bool WMClient::subscribe(afb_req req, const string &evname)
152 {
153     if(evname != kKeyError){
154         HMI_DEBUG("wm", "error is only enabeled for now");
155         return false;
156     }
157     int ret = afb_req_subscribe(req, this->event2list[evname]);
158     if (ret)
159     {
160         HMI_DEBUG("wm", "Failed to subscribe %s", evname.c_str());
161         return false;
162     }
163     return true;
164 }
165
166 void WMClient::emitError(WM_CLIENT_ERROR_EVENT ev)
167 {
168     if (!afb_event_is_valid(this->event2list[kKeyError])){
169         HMI_ERROR("wm", "event err is not valid");
170         return;
171     }
172     json_object *j = json_object_new_object();
173     json_object_object_add(j, kKeyError, json_object_new_int(ev));
174     json_object_object_add(j, kKeyErrorDesc, json_object_new_string(kErrorDescription[ev].c_str()));
175     HMI_DEBUG("wm", "error: %d, description:%s", ev, kErrorDescription[ev].c_str());
176
177     int ret = afb_event_push(this->event2list[kKeyError], j);
178     if (ret != 0)
179     {
180         HMI_DEBUG("wm", "afb_event_push failed: %m");
181     }
182 }
183
184 void WMClient::dumpInfo()
185 {
186     DUMP("APPID : %s", id.c_str());
187     DUMP("  LAYER : %d", layer);
188     for (const auto &x : this->role2surface)
189     {
190         DUMP("  ROLE  : %s , SURFACE : %d", x.first.c_str(), x.second);
191     }
192 }
193
194 } // namespace wm