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.
230 lines
6.9 KiB
230 lines
6.9 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: stlsoft/smartptr/proxy_ptr.hpp
|
|
*
|
|
* Purpose: Contains the proxy_ptr template class.
|
|
*
|
|
* Created: 17th January 1999
|
|
* Updated: 10th August 2009
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 1999-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/smartptr/proxy_ptr.hpp
|
|
*
|
|
* \brief [C++ only] Definition of the stlsoft::proxy_ptr smart
|
|
* pointer class template
|
|
* (\ref group__library__smart_pointers "Smart Pointers" Library).
|
|
*/
|
|
|
|
#ifndef STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_PROXY_PTR
|
|
#define STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_PROXY_PTR
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define STLSOFT_VER_STLSOFT_SMARTPTR_HPP_PROXY_PTR_MAJOR 5
|
|
# define STLSOFT_VER_STLSOFT_SMARTPTR_HPP_PROXY_PTR_MINOR 1
|
|
# define STLSOFT_VER_STLSOFT_SMARTPTR_HPP_PROXY_PTR_REVISION 1
|
|
# define STLSOFT_VER_STLSOFT_SMARTPTR_HPP_PROXY_PTR_EDIT 72
|
|
#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 proxy_ptr
|
|
/** \brief This class emulates a pointer in all respects, and is useful as
|
|
* a generic code testing tool, and is simply an aid to
|
|
* self-documentation.
|
|
*
|
|
* \ingroup group__library__smart_pointers
|
|
*
|
|
* \param T The value type
|
|
*/
|
|
template <ss_typename_param_k T>
|
|
class proxy_ptr
|
|
{
|
|
public:
|
|
/// The value type
|
|
typedef T value_type;
|
|
/// The current parameterisation of the type
|
|
typedef proxy_ptr<T> class_type;
|
|
|
|
typedef value_type* resource_type;
|
|
typedef value_type const* const_resource_type;
|
|
|
|
// Construction
|
|
public:
|
|
/// Construct from a pointer to "borrow"
|
|
ss_explicit_k proxy_ptr(value_type *t)
|
|
: m_value(t)
|
|
{}
|
|
/// Assignment from a new pointer
|
|
proxy_ptr& operator =(value_type *t)
|
|
{
|
|
m_value = t;
|
|
|
|
return *this;
|
|
}
|
|
|
|
// Conversion
|
|
public:
|
|
/// Implicit conversion to pointer to the underlying pointer
|
|
operator value_type *()
|
|
{
|
|
return m_value;
|
|
}
|
|
/// Implicit conversion to pointer-to-const to the underlying pointer
|
|
operator value_type const* () const
|
|
{
|
|
return m_value;
|
|
}
|
|
|
|
/// Indirection operator
|
|
///
|
|
/// \note This method does a debug-time assertion that the underlying pointer is non-null
|
|
value_type& operator *() // indirection
|
|
{
|
|
STLSOFT_MESSAGE_ASSERT("Dereferencing a null pointer!", NULL != m_value);
|
|
|
|
return *m_value;
|
|
}
|
|
/// Indirection operator
|
|
///
|
|
/// \note This method does a debug-time assertion that the underlying pointer is non-null
|
|
value_type const& operator *() const // indirection
|
|
{
|
|
STLSOFT_MESSAGE_ASSERT("Dereferencing a null pointer!", NULL != m_value);
|
|
|
|
return *m_value;
|
|
}
|
|
/// Member-selection operator
|
|
///
|
|
/// \note This method does a debug-time assertion that the underlying pointer is non-null
|
|
value_type* operator ->() // member-selection
|
|
{
|
|
STLSOFT_MESSAGE_ASSERT("Dereferencing a null pointer!", NULL != m_value);
|
|
|
|
return m_value;
|
|
}
|
|
/// Member-selection operator
|
|
///
|
|
/// \note This method does a debug-time assertion that the underlying pointer is non-null
|
|
value_type const* operator ->() const // member-selection
|
|
{
|
|
STLSOFT_MESSAGE_ASSERT("Dereferencing a null pointer!", NULL != m_value);
|
|
|
|
return m_value;
|
|
}
|
|
|
|
/// Returns the underlying pointer value
|
|
///
|
|
/// \deprecated This function will be removed in a future release. Users
|
|
/// should instead invoke get()
|
|
value_type* get_ptr() const
|
|
{
|
|
return get();
|
|
}
|
|
|
|
/// Returns the underlying pointer value
|
|
value_type* get() const
|
|
{
|
|
return m_value;
|
|
}
|
|
|
|
/// Returns the underlying pointer value
|
|
///
|
|
/// \deprecated This method will be removed in a future version
|
|
value_type* GetPointer() const
|
|
{
|
|
return m_value;
|
|
}
|
|
|
|
/// Sets the underlying pointer value to null
|
|
void clear()
|
|
{
|
|
m_value = NULL;
|
|
}
|
|
|
|
// Members
|
|
private:
|
|
value_type *m_value;
|
|
};
|
|
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Shims
|
|
*/
|
|
|
|
/** \brief get_ptr shim
|
|
*
|
|
* \ingroup group__library__smart_pointers
|
|
*/
|
|
template <ss_typename_param_k T>
|
|
inline T* get_ptr(proxy_ptr<T> const& p)
|
|
{
|
|
return p.get();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/proxy_ptr_unittest_.h"
|
|
#endif /* STLSOFT_UNITTEST */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#ifndef _STLSOFT_NO_NAMESPACE
|
|
} // namespace stlsoft
|
|
#endif /* _STLSOFT_NO_NAMESPACE */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* !STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_PROXY_PTR */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|