Form.h

Go to the documentation of this file.

/*
 * Copyright 2015-2019 CNRS-UM LIRMM, CNRS-AIST JRL
 */
 
#pragma once
 
#include <mc_rtc/gui/details/traits.h>
#include <mc_rtc/gui/elements.h>
 
#include <mc_rtc/logging.h>
 
namespace mc_rtc::gui
{
 
namespace details
{
 
struct FormElements
{
  template<typename... Args>
  FormElements(Args &&... args)
  {
    mc_rtc::MessagePackBuilder builder(data_);
    count_ = sizeof...(Args);
    write_elements(builder, std::forward<Args>(args)...);
    data_size_ = builder.finish();
  }
 
  template<typename T>
  void addElement(T && element)
  {
    count_ += 1;
    using ElementT = typename std::decay<T>::type;
    if(ElementT::is_dynamic()) { addDynamicElement(std::forward<T>(element)); }
    else
    {
      std::vector<char> data = data_;
      mc_rtc::MessagePackBuilder builder(data_);
      builder.write_object(data.data(), data_size_);
      builder.start_array(element.write_size());
      element.write(builder);
      builder.finish_array();
      data_size_ = builder.finish();
    }
  }
 
  void write_impl(mc_rtc::MessagePackBuilder & builder)
  {
    builder.start_array(count_);
    for(const auto & el : dynamic_elements_) { el(builder); }
    builder.write_object(data_.data(), data_size_);
    for(size_t i = dynamic_elements_.size() + 1; i < count_; ++i) { builder.write_object(nullptr, 0); }
    builder.finish_array();
  }
 
protected:
  template<typename... Args>
  void write_elements(mc_rtc::MessagePackBuilder &, Args &&...)
  {
  }
 
  template<typename Arg, typename... Args>
  void write_elements(mc_rtc::MessagePackBuilder & builder, Arg && element, Args &&... args)
  {
    using ElementT = typename std::decay<Arg>::type;
    if(ElementT::is_dynamic()) { addDynamicElement(std::forward<Arg>(element)); }
    else
    {
      builder.start_array(element.write_size());
      element.write(builder);
      builder.finish_array();
    }
    write_elements(builder, std::forward<Args>(args)...);
  }
 
  template<typename T>
  void addDynamicElement(T && element)
  {
    auto callback = [element](mc_rtc::MessagePackBuilder & builder) mutable
    {
      builder.start_array(element.write_size());
      element.write(builder);
      builder.finish_array();
    };
    dynamic_elements_.push_back(callback);
  }
 
  size_t count_;
  std::vector<std::function<void(mc_rtc::MessagePackBuilder &)>> dynamic_elements_;
  std::vector<char> data_;
  size_t data_size_;
};
 
template<typename Callback>
struct FormImpl : public CallbackElement<Element, Callback>, FormElements
{
  static constexpr auto type = Elements::Form;
 
  template<typename... Args>
  FormImpl(const std::string & name, Callback cb, Args &&... args)
  : CallbackElement<Element, Callback>(name, cb), FormElements(std::forward<Args>(args)...)
  {
  }
 
  static constexpr size_t write_size() { return CallbackElement<Element, Callback>::write_size() + 1; }
 
  void write(mc_rtc::MessagePackBuilder & builder)
  {
    CallbackElement<Element, Callback>::write(builder);
    FormElements::write_impl(builder);
  }
 
  FormImpl() {}
};
 
struct is_form_element
{
  template<typename T>
  static auto test(T *) -> typename T::is_form_element_t;
 
  template<typename T>
  static std::false_type test(...);
};
 
template<typename T>
inline constexpr bool is_form_element_v = decltype(is_form_element::test<T>(nullptr))::value;
 
} // namespace details
 
template<typename Derived, Elements element>
struct FormElement
{
  using is_form_element_t = std::true_type;
 
  static constexpr auto type = element;
 
  static constexpr size_t write_size() { return 3 + Derived::write_size_(); }
 
  static constexpr bool is_dynamic() { return false; }
 
  void write(mc_rtc::MessagePackBuilder & builder)
  {
    builder.write(name_);
    builder.write(static_cast<typename std::underlying_type<Elements>::type>(type));
    builder.write(required_);
    static_cast<Derived &>(*this).write_(builder);
  }
 
  FormElement() {}
 
protected:
  FormElement(const std::string & name, bool required) : name_(name), required_(required) {}
 
  std::string name_;
  bool required_;
};
 
namespace details
{
 
template<typename T>
struct CallbackOrValue
{
  static_assert(std::is_same_v<std::decay_t<T>, T>);
 
  CallbackOrValue(T value) : callback_or_value(value) {}
 
  T callback_or_value;
 
  static inline constexpr bool is_callback = std::is_invocable_v<T>;
 
  void write(mc_rtc::MessagePackBuilder & builder)
  {
    if constexpr(is_callback) { builder.write(callback_or_value()); }
    else
    {
      builder.write(callback_or_value);
    }
  }
};
 
struct VoidValue
{
};
 
template<>
struct CallbackOrValue<VoidValue>
{
  CallbackOrValue() {}
  CallbackOrValue(VoidValue) {}
 
  static inline constexpr bool is_callback = false;
 
  void write(mc_rtc::MessagePackBuilder & builder) { builder.write(); }
};
 
template<typename T>
struct FormDataInputBase
{
  FormDataInputBase(const T & def) : def_{def}, has_def_(true) {}
 
  FormDataInputBase() : FormDataInputBase(T{}) { has_def_ = false; }
 
  static constexpr size_t write_size_() { return 2; }
 
  static constexpr bool is_dynamic_() { return CallbackOrValue<T>::is_callback; }
 
  void write_(mc_rtc::MessagePackBuilder & builder)
  {
    def_.write(builder);
    builder.write(has_def_);
  }
 
private:
  CallbackOrValue<T> def_;
  bool has_def_;
};
 
template<typename T, Elements element>
struct FormDataInput : public FormElement<FormDataInput<T, element>, element>, FormDataInputBase<T>
{
  FormDataInput(const std::string & name, bool required, const T & def)
  : FormElement<FormDataInput<T, element>, element>(name, required), FormDataInputBase<T>(def)
  {
  }
 
  FormDataInput(const std::string & name, bool required)
  : FormElement<FormDataInput<T, element>, element>(name, required), FormDataInputBase<T>()
  {
  }
 
  static constexpr bool is_dynamic() { return FormDataInputBase<T>::is_dynamic_(); }
};
 
template<typename T, Elements element>
struct FormInteractiveDataInput : public FormElement<FormInteractiveDataInput<T, element>, element>,
                                  FormDataInputBase<T>
{
  FormInteractiveDataInput(const std::string & name, bool required, const T & def, bool interactive = true)
  : FormElement<FormInteractiveDataInput<T, element>, element>(name, required), FormDataInputBase<T>(def),
    interactive_(interactive)
  {
  }
 
  FormInteractiveDataInput(const std::string & name, bool required, bool interactive)
  : FormElement<FormInteractiveDataInput<T, element>, element>(name, required), FormDataInputBase<T>(),
    interactive_(interactive)
  {
  }
 
  static constexpr bool is_dynamic() { return FormDataInputBase<T>::is_dynamic_(); }
 
  static constexpr size_t write_size_() { return FormDataInputBase<T>::write_size_() + 1; }
 
  void write_(mc_rtc::MessagePackBuilder & builder)
  {
    FormDataInputBase<T>::write_(builder);
    builder.write(interactive_);
  }
 
private:
  bool interactive_;
};
 
} // namespace details
 
#define MAKE_DATA_INPUT_HELPER(DATAT, ELEMENT, FNAME)                                                          \
  inline details::FormDataInput<DATAT, ELEMENT> FNAME(const std::string & name, bool required)                 \
  {                                                                                                            \
    return {name, required};                                                                                   \
  }                                                                                                            \
                                                                                                               \
  template<typename T = DATAT>                                                                                 \
  inline auto FNAME(const std::string & name, bool required, T value)                                          \
  {                                                                                                            \
    if constexpr(std::is_invocable_v<T>) { return details::FormDataInput<T, ELEMENT>{name, required, value}; } \
    else                                                                                                       \
    {                                                                                                          \
      if constexpr(std::is_same_v<std::decay_t<T>, DATAT>)                                                     \
      {                                                                                                        \
        return details::FormDataInput<DATAT, ELEMENT>{name, required, value};                                  \
      }                                                                                                        \
      else                                                                                                     \
      {                                                                                                        \
        return details::FormDataInput<DATAT, ELEMENT>{name, required, DATAT{value}};                           \
      }                                                                                                        \
    }                                                                                                          \
  }
 
#define MAKE_INTERACTIVE_DATA_INPUT_HELPER(DATAT, ELEMENT, FNAME)                                            \
  inline details::FormInteractiveDataInput<DATAT, ELEMENT> FNAME(const std::string & name, bool required,    \
                                                                 bool interactive = true)                    \
  {                                                                                                          \
    return {name, required, interactive};                                                                    \
  }                                                                                                          \
                                                                                                             \
  template<typename T = DATAT, typename = std::enable_if_t<!std::is_same_v<T, bool>>>                        \
  inline auto FNAME(const std::string & name, bool required, T value, bool interactive = true)               \
  {                                                                                                          \
    if constexpr(std::is_invocable_v<T>)                                                                     \
    {                                                                                                        \
      return details::FormInteractiveDataInput<T, ELEMENT>{name, required, value, interactive};              \
    }                                                                                                        \
    else                                                                                                     \
    {                                                                                                        \
      if constexpr(std::is_same_v<std::decay_t<T>, DATAT>)                                                   \
      {                                                                                                      \
        return details::FormInteractiveDataInput<DATAT, ELEMENT>{name, required, value, interactive};        \
      }                                                                                                      \
      else                                                                                                   \
      {                                                                                                      \
        return details::FormInteractiveDataInput<DATAT, ELEMENT>{name, required, DATAT{value}, interactive}; \
      }                                                                                                      \
    }                                                                                                        \
  }
 
MAKE_DATA_INPUT_HELPER(bool, Elements::Checkbox, FormCheckbox)
MAKE_DATA_INPUT_HELPER(int, Elements::IntegerInput, FormIntegerInput)
MAKE_DATA_INPUT_HELPER(double, Elements::NumberInput, FormNumberInput)
MAKE_DATA_INPUT_HELPER(std::string, Elements::StringInput, FormStringInput)
MAKE_INTERACTIVE_DATA_INPUT_HELPER(Eigen::Vector3d, Elements::Point3D, FormPoint3DInput)
MAKE_INTERACTIVE_DATA_INPUT_HELPER(sva::PTransformd, Elements::Rotation, FormRotationInput)
MAKE_INTERACTIVE_DATA_INPUT_HELPER(sva::PTransformd, Elements::Transform, FormTransformInput)
 
#undef MAKE_DATA_INPUT_HELPER
#undef MAKE_INTERACTIVE_DATA_INPUT_HELPER
 
namespace details
{
 
template<typename T>
struct FormArrayInput : public FormElement<FormArrayInput<T>, Elements::ArrayInput>
{
  FormArrayInput(const std::string & name,
                 bool required,
                 const std::vector<std::string> & labels,
                 const T & def,
                 bool fixed_size = true)
  : FormElement<FormArrayInput<T>, Elements::ArrayInput>(name, required), def_{def}, fixed_size_(fixed_size),
    has_def_(true), labels_(labels)
  {
  }
 
  FormArrayInput(const std::string & name,
                 bool required,
                 const std::vector<std::string> & labels = {},
                 bool fixed_size = false)
  : FormArrayInput<T>(name, required, labels, {}, fixed_size)
  {
    has_def_ = false;
  }
 
  static constexpr size_t write_size_() { return 4; }
 
  static constexpr bool is_dynamic() { return CallbackOrValue<T>::is_callback; }
 
  void write_(mc_rtc::MessagePackBuilder & builder)
  {
    def_.write(builder);
    builder.write(fixed_size_);
    builder.write(has_def_);
    builder.write(labels_);
  }
 
private:
  CallbackOrValue<T> def_;
  bool fixed_size_;
  bool has_def_;
  std::vector<std::string> labels_;
};
 
} // namespace details
 
template<typename T>
details::FormArrayInput<T> FormArrayInput(const std::string & name, bool required, bool fixed_size = false)
{
  using Labels = details::Labels<T>;
  return {name, required, Labels::labels, fixed_size};
}
 
template<typename T>
auto FormArrayInput(const std::string & name, bool required, T && value, bool fixed_size = true)
{
  if constexpr(std::is_invocable_v<T>)
  {
    using DataT = std::decay_t<decltype(std::declval<T>()())>;
    using Labels = details::Labels<DataT>;
    return details::FormArrayInput{name, required, Labels::labels, std::forward<T>(value), fixed_size};
  }
  else
  {
    using DataT = std::decay_t<T>;
    using Labels = details::Labels<DataT>;
    return details::FormArrayInput<DataT>{name, required, Labels::labels, std::forward<T>(value), fixed_size};
  }
}
 
struct FormComboInput : public FormElement<FormComboInput, Elements::ComboInput>
{
  inline FormComboInput(const std::string & name,
                        bool required,
                        const std::vector<std::string> & values,
                        bool send_index = false,
                        int def = -1)
  : FormElement<FormComboInput, Elements::ComboInput>(name, required), values_(values), send_index_(send_index),
    def_(def)
  {
  }
 
  static constexpr size_t write_size_() { return 3; }
 
  inline void write_(mc_rtc::MessagePackBuilder & builder)
  {
    builder.write(values_);
    builder.write(send_index_);
    builder.write(def_);
  }
 
  inline FormComboInput() {}
 
private:
  std::vector<std::string> values_;
  bool send_index_ = false;
  int def_;
};
 
struct FormDataComboInput : public FormElement<FormDataComboInput, Elements::DataComboInput>
{
  inline FormDataComboInput(const std::string & name,
                            bool required,
                            const std::vector<std::string> & ref,
                            bool send_index = false)
  : FormElement<FormDataComboInput, Elements::DataComboInput>(name, required), ref_(ref), send_index_(send_index)
  {
  }
 
  static constexpr size_t write_size_() { return 2; }
 
  inline void write_(mc_rtc::MessagePackBuilder & builder)
  {
    builder.write(ref_);
    builder.write(send_index_);
  }
 
  inline FormDataComboInput() {}
 
private:
  std::vector<std::string> ref_;
  bool send_index_;
};
 
struct FormObjectInput : public FormElement<FormObjectInput, Elements::Form>, details::FormElements
{
  template<typename... Args>
  FormObjectInput(const std::string & name, bool required, Args &&... args)
  : FormElement<FormObjectInput, Elements::Form>(name, required), FormElements(std::forward<Args>(args)...)
  {
  }
 
  static constexpr bool is_dynamic() { return true; }
 
  static constexpr size_t write_size_() { return 1; }
 
  void write_(mc_rtc::MessagePackBuilder & builder) { FormElements::write_impl(builder); }
};
 
template<typename T = details::VoidValue>
struct FormGenericArrayInput : public FormElement<FormGenericArrayInput<T>, Elements::GenericArray>,
                               details::FormElements
{
  template<typename = std::enable_if_t<!details::is_form_element_v<T>>>
  FormGenericArrayInput(const std::string & name, bool required, T data = {})
  : FormElement<FormGenericArrayInput, Elements::GenericArray>(name, required), data_{data}
  {
  }
 
  template<typename Element, typename = std::enable_if_t<details::is_form_element_v<Element>>>
  FormGenericArrayInput(const std::string & name, bool required, Element && element, T data = {})
  : FormElement<FormGenericArrayInput, Elements::GenericArray>(name, required),
    FormElements(std::forward<Element>(element)), data_{data}
  {
  }
 
  static constexpr bool is_dynamic() { return true; }
 
  static constexpr size_t write_size_() { return 2; }
 
  void write_(mc_rtc::MessagePackBuilder & builder)
  {
    if(count_ != 1) { mc_rtc::log::error_and_throw("FormGenericArrayInput must have exactly one element"); }
    FormElements::write_impl(builder);
    data_.write(builder);
  }
 
private:
  details::CallbackOrValue<T> data_;
};
 
template<typename T = details::VoidValue>
struct FormOneOfInput : public FormElement<FormOneOfInput<T>, Elements::OneOf>, details::FormElements
{
  FormOneOfInput(const std::string & name, bool required)
  : FormElement<FormOneOfInput, Elements::OneOf>(name, required), FormElements()
  {
  }
 
  template<typename U,
           typename... Args,
           typename = std::enable_if_t<!details::is_variant_v<std::decay_t<U>> && !details::is_getter<U>()>>
  FormOneOfInput(const std::string & name, bool required, U && arg, Args &&... args)
  : FormElement<FormOneOfInput, Elements::OneOf>(name, required),
    FormElements(std::forward<U>(arg), std::forward<Args>(args)...)
  {
  }
 
  template<typename... Args>
  FormOneOfInput(const std::string & name, bool required, const T & def, Args &&... args)
  : FormElement<FormOneOfInput, Elements::OneOf>(name, required), FormElements(std::forward<Args>(args)...), def_(def)
  {
  }
 
  static constexpr bool is_dynamic() { return true; }
 
  static constexpr size_t write_size_() { return 2; }
 
  void write_(mc_rtc::MessagePackBuilder & builder)
  {
    def_.write(builder);
    FormElements::write_impl(builder);
  }
 
private:
  details::CallbackOrValue<T> def_;
};
 
template<typename Callback, typename... Args>
auto Form(const std::string & name, Callback cb, Args &&... args)
{
  return details::FormImpl(name, cb, std::forward<Args>(args)...);
}
 
} // namespace mc_rtc::gui