CustomViewCreator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 pongasoft
 *
 * 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.
 *
 * @author Yan Pujante
 */
#pragma once

#include <vstgui4/vstgui/uidescription/iviewcreator.h>
#include <vstgui4/vstgui/uidescription/uiviewcreator.h>
#include <vstgui4/vstgui/uidescription/uiviewfactory.h>
#include <vstgui4/vstgui/uidescription/uiattributes.h>
#include <vstgui4/vstgui/uidescription/detail/uiviewcreatorattributes.h>
#include <vstgui4/vstgui/lib/crect.h>
#include <vstgui4/vstgui/lib/ccolor.h>
#include <vstgui4/vstgui/lib/cbitmap.h>
#include <map>
#include <memory>
#include <pongasoft/logging/logging.h>
#include <pongasoft/VST/GUI/Types.h>
#include <pongasoft/VST/GUI/LookAndFeel.h>
#include <pongasoft/Utils/StringUtils.h>

namespace pongasoft {
namespace VST {
namespace GUI {
namespace Views {

using namespace VSTGUI;

class ViewAttribute
{
public:
  // Constructor
  explicit ViewAttribute(std::string iName) :
    fName(std::move(iName))
  {}

  virtual IViewCreator::AttrType getType() = 0;

  std::string getName() const
  {
    return fName;
  }

  virtual bool apply(CView *iView, const UIAttributes &iAttributes, const IUIDescription *iDescription) = 0;

  virtual bool getAttributeValue(CView *iView, const IUIDescription *iDescription, std::string &oStringValue) const = 0;

private:
  std::string fName;
};

template<typename TView>
inline TView *createCustomView(CRect const &iSize) { return new TView(iSize); }

template<typename TView>
class TCustomViewCreator : public ViewCreatorAdapter
{
private:
  template<typename T, typename TGetter, typename TSetter>
  class TAttribute : public ViewAttribute
  {
  public:
    using Getter = TGetter;
    using Setter = TSetter;

    // Constructor
    TAttribute(std::string const &iName, Getter iGetter, Setter iSetter) :
      ViewAttribute(iName), fGetter{iGetter}, fSetter{iSetter} { }

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kUnknownType;
    }

    virtual bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, T &oValue) const
    {
      return false;
    }

    virtual bool toString(IUIDescription const *iDescription, T const &iValue, std::string &oStringValue) const
    {
      return false;
    }

    // apply => set a color to the view
    bool apply(CView *iView, const UIAttributes &iAttributes, const IUIDescription *iDescription) override
    {
      auto *tv = dynamic_cast<TView *>(iView);
      if(tv != nullptr)
      {
        auto attributeValue = iAttributes.getAttributeValue(getName());
        if(attributeValue)
        {
          T value;
          if(fromString(iDescription, *attributeValue, value))
          {
            (tv->*fSetter)(value);
            return true;
          }
        }
      }
      return false;
    }

    // getAttributeValue => get a color from the view
    bool getAttributeValue(CView *iView, const IUIDescription *iDescription, std::string &oStringValue) const override
    {
      auto *tv = dynamic_cast<TView *>(iView);
      if(tv != nullptr)
      {
        auto value = (tv->*fGetter)();
        return toString(iDescription, value, oStringValue);
      }
      return false;
    }

  private:
    Getter fGetter;
    Setter fSetter;
  };

  template<typename T>
  using ByValAttribute = TAttribute<T, T (TView::*)() const, void (TView::*)(T)>;

  template<typename T>
  using ByRefAttribute = TAttribute<T, T const &(TView::*)() const, void (TView::*)(T const &)>;

  class TagAttribute : public ByValAttribute<int32_t>
  {
  public:
    TagAttribute(std::string const &iName,
                 typename ByValAttribute<int32_t>::Getter iGetter,
                 typename ByValAttribute<int32_t>::Setter iSetter) :
      ByValAttribute<int32_t>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kTagType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, int32_t &oValue) const override
    {
      if(iAttributeValue.length() != 0)
      {
        auto tag = iDescription->getTagForName(iAttributeValue.c_str());
        if(tag == -1)
        {
          char *endPtr = nullptr;
          tag = (int32_t) strtol(iAttributeValue.c_str(), &endPtr, 10);
          if(endPtr == iAttributeValue.c_str())
          {
            return false;
          }
        }
        oValue = tag;
        return true;
      }
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const int32_t &iValue, std::string &oStringValue) const override
    {
      if(iValue != -1)
      {
        UTF8StringPtr controlTag = iDescription->lookupControlTagName(iValue);
        if(controlTag)
        {
          oStringValue = controlTag;
          return true;
        }
      }

      return false;
    }
  };

  template<typename TInt>
  class IntegerAttribute : public ByValAttribute<TInt>
  {
  public:
    using Getter = typename ByValAttribute<TInt>::Getter;
    using Setter = typename ByValAttribute<TInt>::Setter;

    // Constructor
    IntegerAttribute(std::string const &iName, Getter iGetter, Setter iSetter) :
      ByValAttribute<TInt>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kIntegerType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, TInt &oValue) const override
    {
      char *endPtr = nullptr;
      auto value = static_cast<TInt>(strtol(iAttributeValue.c_str(), &endPtr, 10));
      if(endPtr == iAttributeValue.c_str())
      {
        DLOG_F(WARNING, "could not convert <%s> to an integer", iAttributeValue.c_str());
        return false;
      }
      oValue = value;
      return true;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const TInt &iValue, std::string &oStringValue) const override
    {
      std::stringstream str;
      str << iValue;
      oStringValue = str.str();
      return true;
    }
  };

  template<typename TFloat>
  class FloatAttribute : public ByValAttribute<TFloat>
  {
  public:
    using Getter = typename ByValAttribute<TFloat>::Getter;
    using Setter = typename ByValAttribute<TFloat>::Setter;

    // Constructor
    FloatAttribute(std::string const &iName, Getter iGetter, Setter iSetter) :
      ByValAttribute<TFloat>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kFloatType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, TFloat &oValue) const override
    {
      TFloat value;
      if(Utils::stringToFloat<TFloat>(iAttributeValue, value))
      {
        oValue = value;
        return true;
      }
      DLOG_F(WARNING, "could not convert <%s> to a float", iAttributeValue.c_str());
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const TFloat &iValue, std::string &oStringValue) const override
    {
      std::stringstream str;
      str << iValue;
      oStringValue = str.str();
      return true;
    }
  };

  class ColorAttribute : public ByRefAttribute<CColor>
  {
  public:

    // Constructor
    ColorAttribute(std::string const &iName,
                   typename ByRefAttribute<CColor>::Getter iGetter,
                   typename ByRefAttribute<CColor>::Setter iSetter) :
      ByRefAttribute<CColor>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kColorType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, CColor &oValue) const override
    {
      CColor color;
      if(UIViewCreator::stringToColor(&iAttributeValue, color, iDescription))
      {
        oValue = color;
        return true;
      }
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const CColor &iValue, std::string &oStringValue) const override
    {
      return UIViewCreator::colorToString(iValue, oStringValue, iDescription);
    }
  };

  class GradientAttribute : public ByValAttribute<GradientPtr>
  {
  public:

    // Constructor
    GradientAttribute(std::string const &iName,
                   typename ByValAttribute<GradientPtr>::Getter iGetter,
                   typename ByValAttribute<GradientPtr>::Setter iSetter) :
      ByValAttribute<GradientPtr>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kGradientType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, GradientPtr &oValue) const override
    {
      auto gradient = iDescription->getGradient(iAttributeValue.c_str());
      if(gradient)
      {
        oValue = gradient;
        return true;
      }
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, GradientPtr const &iValue, std::string &oStringValue) const override
    {
      if(iValue)
      {
        auto name = iDescription->lookupGradientName(iValue);
        if(name)
        {
          oStringValue = name;
          return true;
        }

      }
      return false;
    }
  };

  class BooleanAttribute : public ByValAttribute<bool>
  {
  public:
    // Constructor
    BooleanAttribute(std::string const &iName,
                     typename ByValAttribute<bool>::Getter iGetter,
                     typename ByValAttribute<bool>::Setter iSetter) :
      ByValAttribute<bool>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kBooleanType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, bool &oValue) const override
    {
      if(iAttributeValue == "true")
      {
        oValue = true;
        return true;
      }

      if(iAttributeValue == "false")
      {
        oValue = false;
        return true;
      }

      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const bool &iValue, std::string &oStringValue) const override
    {
      oStringValue = iValue ? "true" : "false";
      return true;
    }
  };

  class BitmapAttribute : public ByValAttribute<BitmapPtr>
  {
  public:
    // Constructor
    BitmapAttribute(std::string const &iName,
                    typename ByValAttribute<BitmapPtr>::Getter iGetter,
                    typename ByValAttribute<BitmapPtr>::Setter iSetter) :
      ByValAttribute<BitmapPtr>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kBitmapType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, BitmapPtr &oValue) const override
    {
      BitmapPtr bitmap;
      if(UIViewCreator::stringToBitmap(&iAttributeValue, bitmap, iDescription))
      {
        oValue = bitmap;
        return true;
      }
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, BitmapPtr const &iValue, std::string &oStringValue) const override
    {
      if(iValue)
        return UIViewCreator::bitmapToString(iValue, oStringValue, iDescription);
      else
        return false;
    }
  };

  class FontAttribute : public ByValAttribute<FontPtr>
  {
  public:
    // Constructor
    FontAttribute(std::string const &iName,
                  typename ByValAttribute<FontPtr>::Getter iGetter,
                  typename ByValAttribute<FontPtr>::Setter iSetter) :
      ByValAttribute<FontPtr>(iName, iGetter, iSetter) {}

    // getType
    IViewCreator::AttrType getType() override
    {
      return IViewCreator::kFontType;
    }

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, FontPtr &oValue) const override
    {
      auto font = iDescription->getFont(iAttributeValue.c_str());
      if(font)
      {
        oValue = font;
        return true;
      }
      return false;
    }

    // toString
    bool toString(IUIDescription const *iDescription, FontPtr const &iValue, std::string &oStringValue) const override
    {
      if(iValue)
      {
        auto fontName = iDescription->lookupFontName(iValue);
        if(fontName)
        {
          oStringValue = fontName;
          return true;
        }
      }
      return false;
    }
  };

  class MarginAttribute : public ByRefAttribute<Margin>
  {
  public:
    MarginAttribute(std::string const &iName,
                    typename ByRefAttribute<Margin>::Getter iGetter,
                    typename ByRefAttribute<Margin>::Setter iSetter) :
      ByRefAttribute<Margin>(iName, iGetter, iSetter) {}

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, Margin &oValue) const override
    {
      auto parts = Utils::splitFloats<CCoord>(iAttributeValue, ',');

      if(parts.empty())
        return false;

      // look for nan in the array
      if(std::find_if(parts.cbegin(), parts.cend(), [] (auto f) {return std::isnan(f);}) != parts.cend())
        return false;

      if(parts.size() == 1)
      {
        oValue = Margin{parts[0]};
      }
      else
      {
        if(parts.size() < 4)
          return false;

        oValue = Margin{parts[0], parts[1], parts[2], parts[3]};
      }

      return true;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const Margin &iValue, std::string &oStringValue) const override
    {
      std::stringstream str;
      if(iValue.fTop == iValue.fRight && iValue.fTop == iValue.fBottom && iValue.fTop == iValue.fLeft)
        str << iValue.fTop;
      else
      {
        str << iValue.fTop;
        str << ",";
        str << iValue.fRight;
        str << ",";
        str << iValue.fBottom;
        str << ",";
        str << iValue.fLeft;
      }
      oStringValue = str.str();
      return true;
    }
  };

  class RangeAttribute : public ByRefAttribute<Range>
  {
  public:
    RangeAttribute(std::string const &iName,
                   typename ByRefAttribute<Range>::Getter iGetter,
                   typename ByRefAttribute<Range>::Setter iSetter) :
      ByRefAttribute<Range>(iName, iGetter, iSetter) {}

    // fromString
    bool fromString(IUIDescription const *iDescription, std::string const &iAttributeValue, Range &oValue) const override
    {
      auto parts = Utils::splitFloats<CCoord>(iAttributeValue, ',');

      if(parts.empty())
        return false;

      // look for nan in the array
      if(std::find_if(parts.cbegin(), parts.cend(), [] (auto f) {return std::isnan(f);}) != parts.cend())
        return false;

      if(parts.size() == 1)
        oValue = Range{parts[0]};
      else
        oValue = Range{parts[0], parts[1]};

      return true;
    }

    // toString
    bool toString(IUIDescription const *iDescription, const Range &iValue, std::string &oStringValue) const override
    {
      std::stringstream str;
      if(iValue.fFrom == iValue.fTo)
        str << iValue.fFrom;
      else
      {
        str << iValue.fFrom;
        str << ",";
        str << iValue.fTo;
      }
      oStringValue = str.str();
      return true;
    }
  };

public:
  // Constructor
  explicit TCustomViewCreator(char const *iViewName = nullptr,
                              char const *iDisplayName = nullptr,
                              char const *iBaseViewName = VSTGUI::UIViewCreator::kCView) :
    fViewName{iViewName},
    fDisplayName{iDisplayName},
    fBaseViewName{iBaseViewName},
    fAttributes{}
  {
    // this allows for inheritance!
    if(iViewName != nullptr && iDisplayName != nullptr)
      VSTGUI::UIViewFactory::registerViewCreator(*this);
  }

  // Destructor
  ~TCustomViewCreator() override
  {
    // we simply clear the map since it holds shared pointers which will be discarded when they are no longer
    // held by another object
    fAttributes.clear();
  }

  // getViewName
  IdStringPtr getViewName() const override
  {
    return fViewName;
  }

  // getDisplayName
  UTF8StringPtr getDisplayName() const override
  {
    return fDisplayName;
  }

  // getBaseViewName
  IdStringPtr getBaseViewName() const override
  {
    return fBaseViewName;
  }

  template<typename XView>
  void registerAttributes(TCustomViewCreator<XView> const &iOther)
  {
    for(auto attribute : iOther.fAttributes)
    {
      registerAttribute(attribute.second);
    }

    if(std::string(fBaseViewName) == std::string(VSTGUI::UIViewCreator::kCView))
      fBaseViewName = iOther.fBaseViewName;
  }

  void registerColorAttribute(std::string const &iName,
                              typename ColorAttribute::Getter iGetter,
                              typename ColorAttribute::Setter iSetter)
  {
    registerAttribute<ColorAttribute>(iName, iGetter, iSetter);
  }

  void registerGradientAttribute(std::string const &iName,
                              typename GradientAttribute::Getter iGetter,
                              typename GradientAttribute::Setter iSetter)
  {
    registerAttribute<GradientAttribute>(iName, iGetter, iSetter);
  }

  void registerBitmapAttribute(std::string const &iName,
                              typename BitmapAttribute::Getter iGetter,
                              typename BitmapAttribute::Setter iSetter)
  {
    registerAttribute<BitmapAttribute>(iName, iGetter, iSetter);
  }

  void registerFontAttribute(std::string const &iName,
                             typename FontAttribute::Getter iGetter,
                             typename FontAttribute::Setter iSetter)
  {
    registerAttribute<FontAttribute>(iName, iGetter, iSetter);
  }

  void registerMarginAttribute(std::string const &iName,
                               typename MarginAttribute::Getter iGetter,
                               typename MarginAttribute::Setter iSetter)
  {
    registerAttribute<MarginAttribute>(iName, iGetter, iSetter);
  }

  void registerRangeAttribute(std::string const &iName,
                               typename RangeAttribute::Getter iGetter,
                               typename RangeAttribute::Setter iSetter)
  {
    registerAttribute<RangeAttribute>(iName, iGetter, iSetter);
  }

  void registerTagAttribute(std::string const &iName,
                            typename TagAttribute::Getter iGetter,
                            typename TagAttribute::Setter iSetter)
  {
    registerAttribute<TagAttribute>(iName, iGetter, iSetter);
  }

  template<typename TInt>
  void registerIntegerAttribute(std::string const &iName,
                                typename IntegerAttribute<TInt>::Getter iGetter,
                                typename IntegerAttribute<TInt>::Setter iSetter)
  {
    registerAttribute<IntegerAttribute<TInt>>(iName, iGetter, iSetter);
  }

  void registerIntAttribute(std::string const &iName,
                            typename IntegerAttribute<int32_t>::Getter iGetter,
                            typename IntegerAttribute<int32_t>::Setter iSetter)
  {
    registerIntegerAttribute<int32_t>(iName, iGetter, iSetter);
  }

  void registerFloatAttribute(std::string const &iName,
                              typename FloatAttribute<float>::Getter iGetter,
                              typename FloatAttribute<float>::Setter iSetter)
  {
    registerAttribute<FloatAttribute<float>>(iName, iGetter, iSetter);
  }

  void registerDoubleAttribute(std::string const &iName,
                               typename FloatAttribute<double>::Getter iGetter,
                               typename FloatAttribute<double>::Setter iSetter)
  {
    registerAttribute<FloatAttribute<double>>(iName, iGetter, iSetter);
  }

  void registerBooleanAttribute(std::string const &iName,
                                typename BooleanAttribute::Getter iGetter,
                                typename BooleanAttribute::Setter iSetter)
  {
    registerAttribute<BooleanAttribute>(iName, iGetter, iSetter);
  }

  CView *create(const UIAttributes &attributes, const IUIDescription *description) const override
  {
#ifdef JAMBA_DEBUG_LOGGING
    DLOG_F(INFO, "CustomViewCreator<%s>::create()", getViewName());
#endif

    return createCustomView<TView>(CRect(0, 0, 0, 0));
  }

  bool apply(CView *view, const UIAttributes &attributes, const IUIDescription *description) const override
  {
    auto *tv = dynamic_cast<TView *>(view);

    if(tv == nullptr)
      return false;

    for(auto attribute : fAttributes)
    {
      attribute.second->apply(tv, attributes, description);
    }

    return true;
  }

  // getAttributeNames
  bool getAttributeNames(std::list<std::string> &attributeNames) const override
  {
    for(auto attribute : fAttributes)
    {
      attributeNames.emplace_back(attribute.first);
    }
    return true;
  }

  // getAttributeType
  AttrType getAttributeType(const std::string &attributeName) const override
  {
    auto iter = fAttributes.find(attributeName);
    if(iter != fAttributes.cend())
    {
      return iter->second->getType();
    }
    return kUnknownType;
  }

  bool getAttributeValue(CView *iView,
                         const std::string &iAttributeName,
                         std::string &oStringValue,
                         const IUIDescription *iDescription) const override
  {
    auto *cdv = dynamic_cast<TView *>(iView);

    if(cdv == nullptr)
      return false;

    auto iter = fAttributes.find(iAttributeName);
    if(iter != fAttributes.cend())
    {
      return iter->second->getAttributeValue(cdv, iDescription, oStringValue);
    }

    return false;
  }

private:

  // somehow this is required...
  template<typename XView>
  friend class TCustomViewCreator;

  void registerAttribute(std::shared_ptr<ViewAttribute> iAttribute)
  {
    // making sure there are no duplicates (cannot use loguru here!)
    assert(fAttributes.find(iAttribute->getName()) == fAttributes.cend());
    fAttributes[iAttribute->getName()] = iAttribute;
  }

  template<typename TViewAttribute>
  void registerAttribute(std::string const &iName,
                         typename TViewAttribute::Getter iGetter,
                         typename TViewAttribute::Setter iSetter)
  {
    std::shared_ptr<ViewAttribute> cva;
    cva.reset(new TViewAttribute(iName, iGetter, iSetter));
    registerAttribute(cva);
  }


  char const *fViewName;
  char const *fDisplayName;
  char const *fBaseViewName;

  // use a map of shared pointers so that they can easily be copied (see registerAttributes)
  std::map<std::string, std::shared_ptr<ViewAttribute>> fAttributes;
};

template<typename TView, typename TBaseView>
class CustomViewCreator : public TCustomViewCreator<TView>
{
public:
  explicit CustomViewCreator(char const *iViewName = nullptr,
                             char const *iDisplayName = nullptr,
                             char const *iBaseViewName = VSTGUI::UIViewCreator::kCView) :
    TCustomViewCreator<TView>(iViewName, iDisplayName, iBaseViewName)
  {
    TCustomViewCreator<TView>::registerAttributes(typename TBaseView::Creator());
  }
};

}
}
}
}