Cloneable.hpp

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   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.
 *   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 DART_COMMON_CLONEABLE_HPP_
#define DART_COMMON_CLONEABLE_HPP_

#include <memory>
#include <vector>

#include "dart/common/Memory.hpp"

namespace dart {
namespace common {

//==============================================================================
template <class T>
class Cloneable
{
public:
  Cloneable() = default;

  virtual ~Cloneable() = default;

  Cloneable(const Cloneable& doNotCopy) = delete;

  Cloneable& operator=(const Cloneable& doNotCopy) = delete;

  virtual std::unique_ptr<T> clone() const = 0;

  virtual void copy(const T& anotherCloneable) = 0;
};

//==============================================================================
template <class Base, class Mixin>
class MakeCloneable : public Base, public Mixin
{
public:
  using Data = Mixin;

  // To get byte-aligned Eigen vectors
  EIGEN_MAKE_ALIGNED_OPERATOR_NEW

  DART_DEFINE_ALIGNED_SHARED_OBJECT_CREATOR(MakeCloneable)

  
  MakeCloneable();

  template <typename... Args>
  MakeCloneable(Args&&... args);

  MakeCloneable(const Mixin& mixin);

  MakeCloneable(Mixin&& mixin);

  MakeCloneable(const MakeCloneable<Base, Mixin>& other);

  MakeCloneable(MakeCloneable<Base, Mixin>&& other);

  MakeCloneable& operator=(const Mixin& mixin);

  MakeCloneable& operator=(Mixin&& mixin);

  MakeCloneable& operator=(const MakeCloneable& other);

  MakeCloneable& operator=(MakeCloneable&& other);

  // Documentation inherited
  std::unique_ptr<Base> clone() const override final;

  // Documentation inherited
  void copy(const Base& other) override final;
};

//==============================================================================
template <
    class Base,
    class OwnerT,
    class DataT,
    void (*setData)(OwnerT*, const DataT&),
    DataT (*getData)(const OwnerT*)>
class ProxyCloneable : public Base
{
public:
  using Data = DataT;
  using Owner = OwnerT;

  ProxyCloneable();

  ProxyCloneable(OwnerT* owner);

  template <typename... Args>
  ProxyCloneable(OwnerT* owner, Args&&... args);

  template <typename... Args>
  ProxyCloneable(Args&&... args);

  ProxyCloneable(const ProxyCloneable& other);

  ProxyCloneable(ProxyCloneable&& other);

  ProxyCloneable& operator=(const Data& data);

  ProxyCloneable& operator=(Data&& other);

  ProxyCloneable& operator=(const ProxyCloneable& other);

  ProxyCloneable& operator=(ProxyCloneable&& other);

  void set(const Data& data);

  void set(Data&& data);

  void set(const ProxyCloneable& other);

  void set(ProxyCloneable&& other);

  Data get() const;

  OwnerT* getOwner();

  const OwnerT* getOwner() const;

  // Documentation inherited
  std::unique_ptr<Base> clone() const override final;

  // Documentation inherited
  void copy(const Base& other) override final;

protected:
  OwnerT* mOwner;

  std::unique_ptr<Data> mData;
};

//==============================================================================
template <typename MapType>
class CloneableMap
{
public:
  CloneableMap() = default;

  CloneableMap(const CloneableMap& otherStates);

  CloneableMap(CloneableMap&& otherStates);

  CloneableMap(const MapType& otherMap);

  CloneableMap(MapType&& otherMap);

  CloneableMap& operator=(const CloneableMap& otherStates);

  CloneableMap& operator=(CloneableMap&& otherStates);

  CloneableMap& operator=(const MapType& otherMap);

  CloneableMap& operator=(MapType&& otherMap);

  void copy(const CloneableMap& otherMap, bool merge = false);

  void copy(const MapType& otherMap, bool merge = false);

  void merge(const CloneableMap& otherMap);

  void merge(const MapType& otherMap);

  MapType& getMap();

  const MapType& getMap() const;

protected:
  MapType mMap;
};

//==============================================================================
template <typename T>
class CloneableVector
{
public:
  CloneableVector() = default;

  CloneableVector(const std::vector<T>& regularVector);

  CloneableVector(std::vector<T>&& regularVector);

  CloneableVector(const CloneableVector& other);

  CloneableVector& operator=(const CloneableVector& other);

  std::unique_ptr<CloneableVector<T> > clone() const;

  void copy(const CloneableVector<T>& anotherVector);

  std::vector<T>& getVector();

  const std::vector<T>& getVector() const;

private:
  std::vector<T> mVector;
};

} // namespace common
} // namespace dart

#include "dart/common/detail/Cloneable.hpp"

#endif // DART_COMMON_CLONEABLE_HPP_