WeakBind.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 GAZEBO_COMMON_WEAKBIND_HH_
#define GAZEBO_COMMON_WEAKBIND_HH_
 
// This fixes compiler warnings, see #3147 and #3160
#ifndef BOOST_BIND_GLOBAL_PLACEHOLDERS
#define BOOST_BIND_GLOBAL_PLACEHOLDERS
#endif
#include <boost/bind.hpp>
#include <boost/shared_ptr.hpp>
 
namespace gazebo
{
  namespace common
  {
    namespace details
    {
      template <typename Func, typename T>
      class WeakBinder
      {
        public: using WeakPtr = boost::weak_ptr<T>;
 
        private: Func func;
 
        private: WeakPtr ptr;
 
        public: WeakBinder(Func _func, WeakPtr _ptr) :
            func(_func),
            ptr(_ptr)
        {}
 
        public: template <typename... Args> auto operator()(Args&&... _args)
            -> typename std::enable_if<
                !std::is_void<
                  decltype(this->func(std::forward<Args>(_args)...))
                >::value,
                decltype(this->func(std::forward<Args>(_args)...))
              >::type
        {
          auto ptrLock = this->ptr.lock();
          if (ptrLock)
          {
            return this->func(std::forward<Args>(_args)...);
          }
          else
          {
            return {};  // NOLINT(readability/braces)
          }
        }
 
        public: template <typename... Args> auto operator()(Args&&... _args)
          -> typename std::enable_if<
                std::is_void<
                  decltype(this->func(std::forward<Args>(_args)...))
                >::value,
                void
             >::type
        {
          auto ptrLock = this->ptr.lock();
          if (ptrLock)
          {
            this->func(std::forward<Args>(_args)...);
          }
        }
      };
 
      template <typename Func, typename T>
      WeakBinder<Func, T> makeWeakBinder(Func func, boost::weak_ptr<T> ptr)
      {
        return WeakBinder<Func, T>(func, ptr);
      }
    }
 
    template <typename T, typename Func, typename... Args>
    auto weakBind(Func _func, boost::shared_ptr<T> _ptr, Args... _args)
    #if __cplusplus < 201402L
      -> decltype(details::makeWeakBinder(
            boost::bind(_func, _ptr.get(), _args...),
            boost::weak_ptr<T>(_ptr)))
    #endif
    {
      return details::makeWeakBinder(
                boost::bind(_func, _ptr.get(), _args...),
                boost::weak_ptr<T>(_ptr));
    }
  }
}
 
#endif