path: root/src/wm_client.cpp

/*
 * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <json-c/json.h>
#include <algorithm>
#include "wm_client.hpp"
#include "hmi-debug.h"

#define INVALID_SURFACE_ID 0

using std::string;
using std::vector;

namespace wm
{

static const vector<string> kWMEvents = {
    // Private event for applications
    "syncDraw", "flushDraw", "visible", "invisible", "active", "inactive", "error"};
static const vector<string> kErrorDescription = {
    "unknown-error"};

static const char kKeyDrawingName[] = "drawing_name";
static const char kKeyrole[] = "role";
static const char kKeyError[] = "error";
static const char kKeyErrorDesc[] = "kErrorDescription";

WMClient::WMClient(const string &appid, unsigned layer, unsigned surface, const string &role)
    : id(appid), layer(layer),
      service2surfaces(0)
{
    service2surfaces[role] = surface;
    for (auto x : kWMEvents)
    {
#if GTEST_ENABLED
        string ev = x;
#else
        afb_event ev = afb_daemon_make_event(x.c_str());
#endif
        evname2afb_event[x] = ev;
    }
}

WMClient::WMClient(const string &appid, const string &role)
    : id(appid),
      layer(0),
      service2surfaces(0),
      evname2afb_event(0)
{
    service2surfaces[role] = INVALID_SURFACE_ID;
    for (auto x : kWMEvents)
    {
#if GTEST_ENABLED
        string ev = x;
#else
        afb_event ev = afb_daemon_make_event(x.c_str());
#endif
        evname2afb_event[x] = ev;
    }
}

// WMClient::~WMClient()
// {
// }

string WMClient::appID() const
{
    return this->id;
}

vector<unsigned> WMClient::renderOrder() const
{
    return this->surface_render_order;
}

const vector<std::string>& WMClient::roles() const
{
    return this->role_list;
}

unsigned WMClient::layerID() const
{
    return this->layer;
}

unsigned WMClient::surfaceID() const
{
    return this->surface;
}

const string& WMClient::getWMLayerName()
{
    return this->wm_layer_name;
}

void WMClient::setRole(const string& role)
{
    this->role_list.push_back(role);
}

/**
 * Set layerID the client belongs to
 *
 * This function set layerID the client belongs to.
 * But this function may not used because the layer should be fixed at constructor.
 * So this function will be used to change layer by some reasons.
 *
 * @param     unsigned[in] layerID
 * @return    None
 * @attention WMClient can't have multiple layer
 */
void WMClient::registerLayer(unsigned layer)
{
    this->layer = layer;
}

/**
 * Add the pair of name and surface of surface to the client
 *
 * This function set the pair of role and surface to the client.
 * This function is used for the client which has multi surfaces.
 * If the model and relationship for role and surface(layer)
 * is changed, this function will be changed
 * Current Window Manager doesn't use this function.
 *
 * @param     string[in] name
 * @param     unsigned[in] surface
 * @return    true
 */
void WMClient::attachServiceSurface(const string &name, unsigned surface)
{
    HMI_DEBUG("wm", "Add surface name %s with surface %d", name.c_str(), surface);
    if (0 != this->service2surfaces.count(name))
    {
        HMI_NOTICE("wm", "override surfaceID %d with %d", this->service2surfaces[name], surface);
    }
    this->service2surfaces[name] = surface;
}

void WMClient::removeServiceSurface(const std::string &name)
{
    for (auto &x : this->service2surfaces)
    {
        if (name == x.first)
        {
            HMI_INFO("wm", "Remove surface from client %s: service surface name %s, surface: %d",
                        this->id.c_str(), x.first.c_str(), x.second);
            this->service2surfaces.erase(name);
        }
    }
    // re_asign render order
    this->setRenderOrder(this->surface_render_order);
}

void WMClient::setArea(const std::string& area)
{
    this->area = area;
    // TODO: implementation
}

void WMClient::setRenderOrder()
{
    // use private surface_render_order
}

void WMClient::setRenderOrder(const vector<string> &render_order)
{
    // TODO: implement LM
}

void WMClient::setRenderOrder(const vector<unsigned> &render_order)
{
    // TODO implement LM
}

bool WMClient::removeSurfaceIfExist(unsigned surface)
{
    bool ret = false;
    auto fwd_itr = std::remove_if(
        this->surface_render_order.begin(), this->surface_render_order.end(),
        [surface, &ret](unsigned x) {
            ret = true;
            return x == surface;
        });
    this->surface_render_order.erase(fwd_itr, this->surface_render_order.end());
    if(ret)
    {
        for(auto &y : this->service2surfaces)
        {
            if(y.second == surface)
            {
                HMI_INFO("wm", "Remove surface from client %s: role %s, surface: %d",
                        this->id.c_str(), y.first.c_str(), y.second);
                this->service2surfaces.erase(y.first);
            }
        }
        if(this->surface == surface)
        {
            this->surface = INVALID_SURFACE_ID;
            // TODO: If main surface vanishes, how do we treat?
            //       Window Manager doesn't know it's means dead or on purpose.
            // option1: remove service surface and notify to the service.
            // option2: waiting the application calls deallocate.
            HMI_INFO("wm", "Main surface vanishes");
        }
    }
    return ret;
}

void WMClient::removeRole(const string &role)
{
    auto fwd_itr = std::remove_if(
        this->role_list.begin(), this->role_list.end(),
        [&role](string x) {
            return x == role;
        });
    this->role_list.erase(fwd_itr, this->role_list.end());
}

#if GTEST_ENABLED
bool WMClient::subscribe(afb_req req, const string &evname)
{
    if(evname != kKeyError){
        HMI_DEBUG("wm", "error is only enabeled for now");
        return false;
    }
    int ret = afb_req_subscribe(req, this->evname2afb_event[evname]);
    if (ret)
    {
        HMI_DEBUG("wm", "Failed to subscribe %s", evname.c_str());
        return false;
    }
    return true;
}

void WMClient::emitError(WM_CLIENT_ERROR_EVENT ev)
{
    if (!afb_event_is_valid(this->evname2afb_event[kKeyError])){
        HMI_ERROR("wm", "event err is not valid");
        return;
    }
    json_object *j = json_object_new_object();
    json_object_object_add(j, kKeyError, json_object_new_int(ev));
    json_object_object_add(j, kKeyErrorDesc, json_object_new_string(kErrorDescription[ev].c_str()));
    HMI_DEBUG("wm", "error: %d, description:%s", ev, kErrorDescription[ev].c_str());

    int ret = afb_event_push(this->evname2afb_event[kKeyError], j);
    if (ret != 0)
    {
        HMI_DEBUG("wm", "afb_event_push failed: %m");
    }
}
#endif

void WMClient::dumpInfo()
{
    DUMP("APPID : %s", this->id.c_str());
    DUMP("  LAYER : %d", this->layer);
    for (const auto &x : this->role_list)
    {
        DUMP("  ROLE  : %s , SURFACE : %d", x.c_str());
    }
    DUMP("  MAIN SURFACE : %d", this->surface);
    string ro = "";
    for (const auto &x : this->surface_render_order)
    {
        ro += x;
        ro += " ,";
    }
    DUMP("  RENDER ORDER  : %s", ro.c_str());
}

} // namespace wm