Files

235 lines
6.2 KiB
C++

// (C) Copyright 2013 Ruslan Baratov
// Copyright (C) 2014 Vicente J. Botet Escriba
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
// See www.boost.org/libs/thread for documentation.
#ifndef ACTIV_BOOST_THREAD_WITH_LOCK_GUARD_HPP
#define ACTIV_BOOST_THREAD_WITH_LOCK_GUARD_HPP
#include <ActivBoost/thread/lock_guard.hpp>
#include <ActivBoost/utility/result_of.hpp>
//#include <ActivBoost/thread/detail/invoke.hpp>
namespace Boost {
#if !defined(ACTIV_BOOST_NO_CXX11_VARIADIC_TEMPLATES) && \
!defined(ACTIV_BOOST_NO_CXX11_DECLTYPE) && \
!defined(ACTIV_BOOST_NO_CXX11_TRAILING_RESULT_TYPES)
/**
* Utility to run functions in scope protected by mutex.
*
* Examples:
*
* int func(int, int&);
* Boost::mutex m;
* int a;
* int result = Boost::with_lock_guard(m, func, 1, Boost::ref(a));
*
* // using Boost::bind
* int result = Boost::with_lock_guard(
* m, Boost::bind(func, 2, Boost::ref(a))
* );
*
* // using lambda
* int a;
* int result = Boost::with_lock_guard(
* m,
* [&a](int x) {
* a = 3;
* return x + 4;
* },
* 5
* );
*/
template <class Lockable, class Function, class... Args>
typename Boost::result_of<Function(Args...)>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Function) func,
ACTIV_BOOST_FWD_REF(Args)... args
) //-> decltype(func(Boost::forward<Args>(args)...))
{
Boost::lock_guard<Lockable> lock(m);
return func(Boost::forward<Args>(args)...);
}
#else
// Workaround versions for compilers without c++11 variadic templates support.
// (function arguments limit: 4)
// (for lambda support define ACTIV_BOOST_RESULT_OF_USE_DECLTYPE may be needed)
template <class Lockable, class Func>
typename Boost::result_of<Func()>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Func) func
) {
Boost::lock_guard<Lockable> lock(m);
return func();
}
template <class Lockable, class Func, class Arg>
typename Boost::result_of<Func(Arg)>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Func) func,
ACTIV_BOOST_FWD_REF(Arg) arg
) {
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg>(arg)
);
}
template <class Lockable, class Func, class Arg1, class Arg2>
typename Boost::result_of<Func(Arg1, Arg2)>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Func) func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2
) {
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2)
);
}
template <class Lockable, class Func, class Arg1, class Arg2, class Arg3>
typename Boost::result_of<Func(Arg1, Arg2, Arg3)>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Func) func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2,
ACTIV_BOOST_FWD_REF(Arg3) arg3
) {
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2),
Boost::forward<Arg3>(arg3)
);
}
template <
class Lockable, class Func, class Arg1, class Arg2, class Arg3, class Arg4
>
typename Boost::result_of<Func(Arg1, Arg2, Arg3, Arg4)>::type with_lock_guard(
Lockable& m,
ACTIV_BOOST_FWD_REF(Func) func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2,
ACTIV_BOOST_FWD_REF(Arg3) arg3,
ACTIV_BOOST_FWD_REF(Arg4) arg4
) {
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2),
Boost::forward<Arg3>(arg3),
Boost::forward<Arg4>(arg4)
);
}
// overloads for function pointer
// (if argument is not function pointer, static assert will trigger)
template <class Lockable, class Func>
typename Boost::result_of<
typename Boost::add_pointer<Func>::type()
>::type with_lock_guard(
Lockable& m,
Func* func
) {
ACTIV_BOOST_STATIC_ASSERT(Boost::is_function<Func>::value);
Boost::lock_guard<Lockable> lock(m);
return func();
}
template <class Lockable, class Func, class Arg>
typename Boost::result_of<
typename Boost::add_pointer<Func>::type(Arg)
>::type with_lock_guard(
Lockable& m,
Func* func,
ACTIV_BOOST_FWD_REF(Arg) arg
) {
ACTIV_BOOST_STATIC_ASSERT(Boost::is_function<Func>::value);
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg>(arg)
);
}
template <class Lockable, class Func, class Arg1, class Arg2>
typename Boost::result_of<
typename Boost::add_pointer<Func>::type(Arg1, Arg2)
>::type with_lock_guard(
Lockable& m,
Func* func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2
) {
ACTIV_BOOST_STATIC_ASSERT(Boost::is_function<Func>::value);
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2)
);
}
template <class Lockable, class Func, class Arg1, class Arg2, class Arg3>
typename Boost::result_of<
typename Boost::add_pointer<Func>::type(Arg1, Arg2, Arg3)
>::type with_lock_guard(
Lockable& m,
Func* func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2,
ACTIV_BOOST_FWD_REF(Arg3) arg3
) {
ACTIV_BOOST_STATIC_ASSERT(Boost::is_function<Func>::value);
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2),
Boost::forward<Arg3>(arg3)
);
}
template <
class Lockable, class Func, class Arg1, class Arg2, class Arg3, class Arg4
>
typename Boost::result_of<
typename Boost::add_pointer<Func>::type(Arg1, Arg2, Arg3, Arg4)
>::type with_lock_guard(
Lockable& m,
Func* func,
ACTIV_BOOST_FWD_REF(Arg1) arg1,
ACTIV_BOOST_FWD_REF(Arg2) arg2,
ACTIV_BOOST_FWD_REF(Arg3) arg3,
ACTIV_BOOST_FWD_REF(Arg4) arg4
) {
ACTIV_BOOST_STATIC_ASSERT(Boost::is_function<Func>::value);
Boost::lock_guard<Lockable> lock(m);
return func(
Boost::forward<Arg1>(arg1),
Boost::forward<Arg2>(arg2),
Boost::forward<Arg3>(arg3),
Boost::forward<Arg4>(arg4)
);
}
#endif
} // namespace Boost
#endif // ACTIV_BOOST_THREAD_WITH_LOCK_GUARD_HPP