You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
260 lines
7.2 KiB
260 lines
7.2 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: stlsoft/synch/lock_scope.hpp (originally MLLock.h, ::SynesisStd)
|
|
*
|
|
* Purpose: Synchronisation object lock scoping class.
|
|
*
|
|
* Created: 1st October 1994
|
|
* Updated: 10th August 2009
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 1994-2009, Matthew Wilson and Synesis Software
|
|
* All rights reserved.
|
|
*
|
|
* 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.
|
|
* - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
|
|
* any contributors may be used to endorse or promote products derived from
|
|
* this software without specific prior written permission.
|
|
*
|
|
* 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 OWNER 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.
|
|
*
|
|
* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
|
|
/** \file stlsoft/synch/lock_scope.hpp
|
|
*
|
|
* \brief [C++ only] Definition of the stlsoft::lock_scope class template
|
|
* (\ref group__library__synch "Synchronisation" Library).
|
|
*/
|
|
|
|
#ifndef STLSOFT_INCL_STLSOFT_SYNCH_HPP_LOCK_SCOPE
|
|
#define STLSOFT_INCL_STLSOFT_SYNCH_HPP_LOCK_SCOPE
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define STLSOFT_VER_STLSOFT_SYNCH_HPP_LOCK_SCOPE_MAJOR 6
|
|
# define STLSOFT_VER_STLSOFT_SYNCH_HPP_LOCK_SCOPE_MINOR 0
|
|
# define STLSOFT_VER_STLSOFT_SYNCH_HPP_LOCK_SCOPE_REVISION 1
|
|
# define STLSOFT_VER_STLSOFT_SYNCH_HPP_LOCK_SCOPE_EDIT 112
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT
|
|
# include <stlsoft/stlsoft.h>
|
|
#endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Namespace
|
|
*/
|
|
|
|
#ifndef _STLSOFT_NO_NAMESPACE
|
|
namespace stlsoft
|
|
{
|
|
#endif /* _STLSOFT_NO_NAMESPACE */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Classes
|
|
*/
|
|
|
|
// class lock_traits
|
|
|
|
/** \brief Traits class for lockable objects
|
|
*
|
|
* \ingroup group__library__synch
|
|
*
|
|
* \param L The lockable class
|
|
*/
|
|
template<ss_typename_param_k L>
|
|
struct lock_traits
|
|
{
|
|
/// \name Member Types
|
|
/// @{
|
|
public:
|
|
/// \brief The lockable type
|
|
typedef L lock_type;
|
|
/// \brief The current parameterisation of this type
|
|
typedef lock_traits<L> class_type;
|
|
/// @}
|
|
|
|
/// \name Operations
|
|
/// @{
|
|
public:
|
|
/// \brief Locks the given lockable instance
|
|
static void lock(lock_type &c)
|
|
{
|
|
lock_instance(c);
|
|
}
|
|
|
|
/// \brief Unlocks the given lockable instance
|
|
static void unlock(lock_type &c)
|
|
{
|
|
unlock_instance(c);
|
|
}
|
|
/// @}
|
|
};
|
|
|
|
// class lock_invert_traits
|
|
|
|
/** \brief Traits class for inverting the lock status of lockable objects
|
|
*
|
|
* \ingroup group__library__synch
|
|
*
|
|
* \param L The lockable class
|
|
*/
|
|
template<ss_typename_param_k L>
|
|
struct lock_invert_traits
|
|
{
|
|
/// \name Member Types
|
|
/// @{
|
|
public:
|
|
/// \brief The lockable type
|
|
typedef L lock_type;
|
|
/// \brief The current parameterisation of this type
|
|
typedef lock_invert_traits<L> class_type;
|
|
/// @}
|
|
|
|
/// \name Operations
|
|
/// @{
|
|
public:
|
|
/// \brief Unlocks the given lockable instance
|
|
static void lock(lock_type &c)
|
|
{
|
|
unlock_instance(c);
|
|
}
|
|
|
|
/// \brief Locks the given lockable instance
|
|
static void unlock(lock_type &c)
|
|
{
|
|
lock_instance(c);
|
|
}
|
|
/// @}
|
|
};
|
|
|
|
// class lock_traits_inverter
|
|
|
|
/** \brief Traits inverter class for inverting the lock behaviour of lockable traits types
|
|
*
|
|
* \ingroup group__library__synch
|
|
*
|
|
* \param L The traits class
|
|
*/
|
|
template<ss_typename_param_k T>
|
|
struct lock_traits_inverter
|
|
{
|
|
/// \name Member Types
|
|
/// @{
|
|
public:
|
|
/// \brief The traits type
|
|
typedef T traits_type;
|
|
/// \brief The lockable type
|
|
typedef ss_typename_type_k traits_type::lock_type lock_type;
|
|
/// \brief The current parameterisation of this type
|
|
typedef lock_traits_inverter<T> class_type;
|
|
/// @}
|
|
|
|
/// \name Operations
|
|
/// @{
|
|
public:
|
|
/// \brief Unlocks the given lockable instance
|
|
static void lock(lock_type &c)
|
|
{
|
|
traits_type::unlock(c);
|
|
}
|
|
|
|
/// \brief Locks the given lockable instance
|
|
static void unlock(lock_type &c)
|
|
{
|
|
traits_type::lock(c);
|
|
}
|
|
/// @}
|
|
};
|
|
|
|
// class lock_scope
|
|
|
|
/**\brief This class scopes the lock status of a lockable type
|
|
*
|
|
* \ingroup group__library__synch
|
|
*
|
|
* \param L The lockable type, e.g. stlsoft::null_mutex
|
|
* \param T The lock traits. On translators that support default template arguments this defaults to lock_traits<L>
|
|
*/
|
|
template< ss_typename_param_k L
|
|
#ifdef STLSOFT_CF_TEMPLATE_CLASS_DEFAULT_CLASS_ARGUMENT_SUPPORT
|
|
, ss_typename_param_k T = lock_traits<L>
|
|
#else /* ? STLSOFT_CF_TEMPLATE_CLASS_DEFAULT_CLASS_ARGUMENT_SUPPORT */
|
|
, ss_typename_param_k T
|
|
#endif /* STLSOFT_CF_TEMPLATE_CLASS_DEFAULT_CLASS_ARGUMENT_SUPPORT */
|
|
>
|
|
class lock_scope
|
|
{
|
|
/// \name Member Types
|
|
/// @{
|
|
public:
|
|
/// \brief The lockable type
|
|
typedef L lock_type;
|
|
/// \brief The traits type
|
|
typedef T traits_type;
|
|
/// \brief The current parameterisation of this type
|
|
typedef lock_scope<L, T> class_type;
|
|
/// @}
|
|
|
|
/// \name Construction
|
|
/// @{
|
|
public:
|
|
/// \brief Locks the lockable instance
|
|
lock_scope(lock_type &l)
|
|
: m_l(l)
|
|
{
|
|
traits_type::lock(m_l);
|
|
}
|
|
/// \brief Unlocks the lockable instance
|
|
~lock_scope() stlsoft_throw_0()
|
|
{
|
|
traits_type::unlock(m_l);
|
|
}
|
|
/// @}
|
|
|
|
/// \name Members
|
|
/// @{
|
|
private:
|
|
lock_type &m_l;
|
|
/// @}
|
|
|
|
/// \name Not to be implemented
|
|
/// @{
|
|
private:
|
|
lock_scope(class_type const& rhs);
|
|
lock_scope& operator =(class_type const& rhs);
|
|
/// @}
|
|
};
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#ifndef _STLSOFT_NO_NAMESPACE
|
|
} // namespace stlsoft
|
|
#endif /* _STLSOFT_NO_NAMESPACE */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* !STLSOFT_INCL_STLSOFT_SYNCH_HPP_LOCK_SCOPE */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|