gz/utils/ImplPtr.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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 GZ_UTILS__IMPLPTR_HH_
#define GZ_UTILS__IMPLPTR_HH_
 
#include <memory>
#include <utility>
 
#include <gz/utils/config.hh>
#include <gz/utils/detail/DefaultOps.hh>
#include <gz/utils/SuppressWarning.hh>
#include <gz/utils/Export.hh>
 
namespace ignition
{
  namespace utils
  {
    template <class T,
              class Deleter = void (*)(T*),
              class Operations = detail::CopyMoveDeleteOperations<T> >
    class ImplPtr
    {
      public: template <class U, class D, class Ops>
      ImplPtr(U *_ptr, D &&_deleter, Ops &&_ops);
 
      public: ImplPtr(const ImplPtr &_other);
 
      public: ImplPtr &operator=(const ImplPtr &_other);
 
      // We explicitly declare the move constructor to make it clear that it is
      // available.
      public: ImplPtr(ImplPtr &&) = default;
 
      // We explicitly declare the move assignment operator to make it clear
      // that it is available.
      public: ImplPtr &operator=(ImplPtr &&) = default;
 
      public: ~ImplPtr() = default;
 
      public: T &operator*();
 
      public: const T &operator*() const;
 
      public: T *operator->();
 
      public: const T *operator->() const;
 
      public: T *Get();
 
      public: const T *Get() const;
 
      private: ImplPtr Clone() const;
 
      private: std::unique_ptr<T, Deleter> ptr;
 
      private: Operations ops;
    };
 
    template <class T, typename... Args>
    ImplPtr<T> MakeImpl(Args &&..._args);
 
    template <class T, class Deleter = void (*)(T*)>
    using UniqueImplPtr = std::unique_ptr<T, Deleter>;
 
    template <class T, typename... Args>
    UniqueImplPtr<T> MakeUniqueImpl(Args &&..._args);
  }  // namespace utils
}  // namespace ignition
 
#define IGN_UTILS_IMPL_PTR_FWD(ImplementationClass, memberName) \
  IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING \
  private: ::ignition::utils::ImplPtr<ImplementationClass> memberName; \
  IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
 
#define IGN_UTILS_UNIQUE_IMPL_PTR_FWD(ImplementationClass, memberName) \
  IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING \
  private: ::ignition::utils::UniqueImplPtr<ImplementationClass> memberName; \
  IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
 
#define IGN_UTILS_IMPL_PTR(memberName) \
  public: class Implementation; \
  IGN_UTILS_IMPL_PTR_FWD(Implementation, memberName)
 
#define IGN_UTILS_UNIQUE_IMPL_PTR(memberName) \
  public: class Implementation; \
  IGN_UTILS_UNIQUE_IMPL_PTR_FWD(Implementation, memberName)
 
 
#include <gz/utils/detail/ImplPtr.hh>
 
#endif  // GZ_UTILS__IMPLPTR_HH_