/*
 Copyright (c) 2017, Ford Motor Company
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following
 disclaimer in the documentation and/or other materials provided with the
 distribution.

 Neither the name of the Ford Motor Company nor the names of its contributors
 may be used to endorse or promote products derived from this software
 without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_MESSAGE_HELPER_H_
#define SRC_COMPONENTS_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_MESSAGE_HELPER_H_

#include <stdint.h>
#include <string>
#include <map>

#include "utils/macro.h"
#include "json/json.h"
#include "interfaces/HMI_API.h"
#include "functional_module/function_ids.h"
#include "remote_control/remote_plugin_interface.h"
#include "application_manager/message.h"

namespace remote_control {

/**
 * @brief MessageHelper class
 **/
class MessageHelper {
 public:
  static const std::string GetMobileAPIName(
      functional_modules::RCFunctionID func_id);

  /**
   * @brief Convert Json::Value to std::string
   *
   * @param value Value with json
   *
   * @return string with json
   */
  static std::string ValueToString(const Json::Value& value);

  /**
   * @brief Convert std::string to Json::Value
   *
   * @param string string with json
   *
   * @return Value created from string with json
   */
  static Json::Value StringToValue(const std::string& string);

  /**
   * Creates hmi request
   * @param function_id - API function we create request for
   * @param message_params - params in request
   * @param rc_module - used module for requests handling
   * @param hmi_app_id - app is used between SDL & HMI
   * @return creted request - reqdy to be sent to hmi
   */
  static application_manager::MessagePtr CreateHmiRequest(
      const char* function_id,
      const uint32_t hmi_app_id,
      const Json::Value& message_params,
      RemotePluginInterface& rc_module);

  /** @brief Converts string to hmi AccessMode enum value
   * @param access_mode stringified value
   * @return hmi AccessMode enum value if succedeed, otherwise - INVALID_ENUM
   * value
   */
  static hmi_apis::Common_RCAccessMode::eType AccessModeFromString(
      const std::string& access_mode);

  /**
   * @brief AccessModeToString converts enum values to string
   * @param access_mode Access mode enum value
   * @return Appropriate string value
   */
  static std::string AccessModeToString(
      const hmi_apis::Common_RCAccessMode::eType access_mode);

 private:
  MessageHelper();

  static const std::map<functional_modules::RCFunctionID, std::string>
      kMobileAPINames;
  DISALLOW_COPY_AND_ASSIGN(MessageHelper);
};

/** @brief Check for existence of specified key in Json::Value
 * @param value Value with json
 * @param key string with key name
 * @return true if key exist
 */
bool IsMember(const Json::Value& value, const std::string& key);

}  // namespace remote_control

#endif  // SRC_COMPONENTS_REMOTE_CONTROL_INCLUDE_REMOTE_CONTROL_MESSAGE_HELPER_H_