bound_param_helper.hpp

Go to the documentation of this file.

#pragma once

#include <memory>
#include <string>

#include <cras_cpp_common/log_utils.h>
#include <cras_cpp_common/param_utils/get_param_adapter.hpp>
#include <cras_cpp_common/param_utils/get_param_options.hpp>
#include <cras_cpp_common/param_utils/get_param_result.hpp>
#include <cras_cpp_common/param_utils/param_helper.hpp>
#include <cras_cpp_common/optional.hpp>

namespace cras
{

class BoundParamHelper;
typedef ::std::shared_ptr<::cras::BoundParamHelper> BoundParamHelperPtr;

class BoundParamHelper : protected ::cras::ParamHelper
{
public:
  BoundParamHelper(const ::cras::LogHelperPtr& log, const ::cras::GetParamAdapterPtr& param) :
      ::cras::ParamHelper(log), param(param)
  {
  }

  ~BoundParamHelper() override = default;

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ::cras::GetParamResult<ResultType> getParamVerbose(
    const ::std::string& name, const ::cras::optional<ResultType>& defaultValue = ResultType(),
    const ::std::string& unit = "", const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::ParamHelper::getParamVerbose(*this->param, name, defaultValue, unit, options);
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ::cras::GetParamResult<ResultType> getParamVerbose(
    const ::std::string& name, const ResultType& defaultValue = ResultType(),
    const ::std::string& unit = "", const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::ParamHelper::getParamVerbose(
      *this->param, name, ::cras::optional<ResultType>(defaultValue), unit, options);
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ResultType getParam(
    const ::std::string& name, const ::cras::optional<ResultType>& defaultValue = ResultType(),
    const ::std::string& unit = "", const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::ParamHelper::getParam(*this->param, name, defaultValue, unit, options);
  }

  template<typename ResultType, typename ParamServerType = typename ::cras::DefaultParamServerType<ResultType>::type,
    ::cras::check_get_param_types<ResultType, ParamServerType>* = nullptr>
  inline ResultType getParam(
    const ::std::string& name, const ResultType& defaultValue = ResultType(),
    const ::std::string& unit = "", const ::cras::GetParamOptions<ResultType, ParamServerType>& options = {}) const
  {
    return ::cras::ParamHelper::getParam(*this->param, name, ::cras::optional<ResultType>(defaultValue), unit, options);
  }

  // std::string - char interop specializations

  inline ::cras::GetParamResult<::std::string> getParamVerbose(
    const ::std::string& name, const ::cras::optional<const char *>& defaultValue, const ::std::string& unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::ParamHelper::getParamVerbose(*this->param, name, defaultValue, unit, options);
  }

  inline ::cras::GetParamResult<std::string> getParamVerbose(
    const ::std::string& name, const char* defaultValue, const ::std::string& unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::ParamHelper::getParamVerbose(*this->param, name, defaultValue, unit, options);
  }

  inline ::std::string getParam(
    const ::std::string& name, const ::cras::optional<const char *>& defaultValue, const ::std::string& unit = "",
    const ::cras::GetParamOptions<::std::string>& options = {}) const
  {
    return ::cras::ParamHelper::getParam(*this->param, name, defaultValue, unit, options);
  }

  inline ::std::string getParam(
    const ::std::string& name, const char* defaultValue, const ::std::string& unit = "",
    const ::cras::GetParamOptions<std::string>& options = {}) const
  {
    return ::cras::ParamHelper::getParam(*this->param, name, defaultValue, unit, options);
  }

  inline bool hasParam(const ::std::string& name, const bool searchNested = true) const
  {
    if (this->param->hasParam(name))
      return true;
    if (!searchNested)
      return false;

    // try searching for a nested parameter
    const auto parts = ::cras::split(name, "/", 1);
    if (parts.size() == 1)
      return false;
    const auto& head = parts[0];
    const auto& tail = parts[1];
    if (!this->param->hasParam(head))
      return false;
    XmlRpc::XmlRpcValue x;
    this->param->getParam(head, x);
    if (x.getType() != XmlRpc::XmlRpcValue::TypeStruct)
      return false;
    return this->paramsInNamespace(head)->hasParam(tail);
  }

  inline ::cras::BoundParamHelperPtr paramsInNamespace(const ::std::string& ns) const
  {
    return ::std::make_shared<::cras::BoundParamHelper>(this->log, this->param->getNamespaced(ns));
  }

  inline ::std::string getNamespace() const
  {
    return this->param->getNamespace();
  }

  using ::cras::ParamHelper::getLogger;

protected:
  ::cras::GetParamAdapterPtr param;
};

}