detail/PluginPtr.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * 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.
 *
 */


#ifndef IGNITION_COMMON_DETAIL_PLUGINPTR_HH_
#define IGNITION_COMMON_DETAIL_PLUGINPTR_HH_
#include <memory>
#include <utility>

#include "ignition/common/PluginPtr.hh"
#include "ignition/common/TemplateHelpers.hh"

namespace ignition
{
  namespace common
  {
    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr()
      : dataPtr(new PluginType)
    {
      // Do nothing
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        const TemplatePluginPtr &_other)
      : dataPtr(new PluginType)
    {
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
    }

    template <typename PluginType>
    // the following is a false positive with cppcheck 1.82 fixed in 1.83
    // cppcheck-suppress syntaxError
    template <typename OtherPluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        const TemplatePluginPtr<OtherPluginType> &_other)
      : dataPtr(new PluginType)
    {
      static_assert(ConstCompatible<PluginType, OtherPluginType>::value,
                "The requested PluginPtr cast would discard const qualifiers");
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        const TemplatePluginPtr &_other)
    {
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
      return *this;
    }

    template <typename PluginType>
    template <typename OtherPluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        const TemplatePluginPtr<OtherPluginType> &_other)
    {
      static_assert(ConstCompatible<PluginType, OtherPluginType>::value,
                "The requested PluginPtr cast would discard const qualifiers");
      this->dataPtr->PrivateCopyPluginInstance(*_other.dataPtr);
      return *this;
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(
        TemplatePluginPtr &&_other)
      : dataPtr(std::move(_other.dataPtr))
    {
      // Do nothing
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        TemplatePluginPtr &&_other)
    {
      this->dataPtr = std::move(_other.dataPtr);
      return *this;
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>& TemplatePluginPtr<PluginType>::operator =(
        std::nullptr_t)
    {
      this->Clear();
      return *this;
    }

    template <typename PluginType>
    PluginType* TemplatePluginPtr<PluginType>::operator ->() const
    {
      return dataPtr.get();
    }

    template <typename PluginType>
    PluginType& TemplatePluginPtr<PluginType>::operator *() const
    {
      return (*dataPtr);
    }

    #define DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR(op)\
      template <typename PluginType>\
      bool TemplatePluginPtr<PluginType>::operator op (\
            const TemplatePluginPtr &_other) const\
      {\
        return (this->dataPtr->PrivateGetInstancePtr() op \
                _other.dataPtr->PrivateGetInstancePtr() );\
      }

    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( == )  // NOLINT
    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( < )   // NOLINT
    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( > )   // NOLINT
    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( != )  // NOLINT
    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( <= )  // NOLINT
    DETAIL_IGN_COMMON_PLUGINPTR_IMPLEMENT_OPERATOR( >= )  // NOLINT

    template <typename PluginType>
    std::size_t TemplatePluginPtr<PluginType>::Hash() const
    {
      return std::hash< std::shared_ptr<void> >()(
                   this->dataPtr->PrivateGetInstancePtr());
    }

    template <typename PluginType>
    bool TemplatePluginPtr<PluginType>::IsEmpty() const
    {
      return (nullptr == this->dataPtr->PrivateGetInstancePtr());
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>::operator bool() const
    {
      return !this->IsEmpty();
    }

    template <typename PluginType>
    void TemplatePluginPtr<PluginType>::Clear()
    {
      this->dataPtr->PrivateSetPluginInstance(nullptr);
    }

    template <typename PluginType>
    TemplatePluginPtr<PluginType>::TemplatePluginPtr(const PluginInfo *info)
      : dataPtr(new PluginType)
    {
      dataPtr->PrivateSetPluginInstance(info);
    }
  }
}

// Note that opening up namespace std is legal here because we are specializing
// a templated structure from the STL, which is permitted (and even encouraged).
namespace std
{
  template <typename PluginType>
  struct hash<ignition::common::TemplatePluginPtr<PluginType>>
  {
    size_t operator()(
        const ignition::common::TemplatePluginPtr<PluginType> &ptr) const
    {
      return ptr.Hash();
    }
  };
}

#endif