mfcstl/collections/clist_adaptors.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        mfcstl/collections/clist_adaptors.hpp
 *
 * Purpose:     Contains the definition of the CList_cadaptor and CList_iadaptor
 *              class templates.
 *
 * Created:     1st December 2002
 * Updated:     10th August 2009
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2002-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.
 *
 * ////////////////////////////////////////////////////////////////////// */


#ifndef MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS
#define MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define MFCSTL_VER_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS_MAJOR     3
# define MFCSTL_VER_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS_MINOR     0
# define MFCSTL_VER_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS_REVISION  6
# define MFCSTL_VER_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS_EDIT      62
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Compatibility
 */

/*
[Incompatibilies-start]
[Incompatibilies-end]
 */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#ifndef MFCSTL_INCL_MFCSTL_HPP_MFCSTL
# include <mfcstl/mfcstl.hpp>
#endif /* !MFCSTL_INCL_MFCSTL_HPP_MFCSTL */
#ifndef MFCSTL_INCL_MFCSTL_MEMORY_HPP_AFX_ALLOCATOR
# include <mfcstl/memory/afx_allocator.hpp>
#endif /* !MFCSTL_INCL_MFCSTL_MEMORY_HPP_AFX_ALLOCATOR */
#ifndef MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_SWAP
# include <mfcstl/collections/clist_swap.hpp>
#endif /* !MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_SWAP */
#ifndef MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_TRAITS
# include <mfcstl/collections/clist_traits.hpp>
#endif /* !MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_TRAITS */
#ifndef MFCSTL_INCL_MFCSTL_UTIL_HPP_MEMORY_EXCEPTION_TRANSLATION_POLICIES
# include <mfcstl/util/memory_exception_translation_policies.hpp>
#endif /* !MFCSTL_INCL_MFCSTL_UTIL_HPP_MEMORY_EXCEPTION_TRANSLATION_POLICIES */
#ifndef STLSOFT_INCL_STLSOFT_UTIL_STD_HPP_ITERATOR_GENERATORS
# include <stlsoft/util/std/iterator_generators.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_UTIL_STD_HPP_ITERATOR_GENERATORS */
#ifndef STLSOFT_INCL_STLSOFT_META_HPP_CAPABILITIES
# include <stlsoft/meta/capabilities.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_META_HPP_CAPABILITIES */
#ifdef STLSOFT_META_HAS_IS_SAME_TYPE
# ifndef STLSOFT_INCL_STLSOFT_META_HPP_IS_SAME_TYPE
#  include <stlsoft/meta/is_same_type.hpp>
# endif /* !STLSOFT_INCL_STLSOFT_META_HPP_IS_SAME_TYPE */
#endif /* STLSOFT_META_HAS_IS_SAME_TYPE */
#ifndef STLSOFT_INCL_STLSOFT_COLLECTIONS_UTIL_HPP_COLLECTIONS
# include <stlsoft/collections/util/collections.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_COLLECTIONS_UTIL_HPP_COLLECTIONS */
#if defined(STLSOFT_CF_TEMPLATE_PARTIAL_SPECIALISATION_SUPPORT) && \
    !defined(MFCSTL_NO_INCLUDE_AFXTEMPL_BY_DEFAULT)
# include <afxtempl.h>
#endif /* STLSOFT_CF_TEMPLATE_PARTIAL_SPECIALISATION_SUPPORT && !MFCSTL_NO_INCLUDE_AFXTEMPL_BY_DEFAULT */

#ifdef STLSOFT_UNITTEST
# include <afxtempl.h>
# include <stlsoft/string/simple_string.hpp>
#endif /* STLSOFT_UNITTEST */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#ifndef _MFCSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
/* There is no stlsoft namespace, so must define ::mfcstl */
namespace mfcstl
{
# else
/* Define stlsoft::mfcstl_project */

namespace stlsoft
{

namespace mfcstl_project
{

# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_MFCSTL_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Pre-processor options
 *
 * Because the CObList, CPtrList, CStringList and CList<,> implementations all
 * internally represent their logical position indicators (of type POSTION) as
 * pointers to the nodes within the lists, it is workable to be able to copy
 * these position variables.
 *
 * However, nothing in the MFC documentation stipulates this to be a reliable
 * and documented part of the classes' interfaces, so this is a potentially
 * unsafe assumption.
 *
 * Therefore, the iterator model for the CList_adaptor_base class is Input Iterator.
 * If you wish to use forward iterators, you may specify the pre-processor
 * symbol _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR, in which case the iterator
 * classes will implement copy semantics, rather than the default move
 * semantics.
 */

/* /////////////////////////////////////////////////////////////////////////
 * Classes
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
// Forward declarations
template<   ss_typename_param_k L
        ,   ss_typename_param_k I
        ,   ss_typename_param_k T
        >
class CList_adaptor_base;

// CList_cadaptor is not currently defined
template<   ss_typename_param_k L
        ,   ss_typename_param_k T
        >
class CList_cadaptor;

template<   ss_typename_param_k L
        ,   ss_typename_param_k T
        >
class CList_iadaptor;

#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

template<   ss_typename_param_k L
        ,   ss_typename_param_k I
        ,   ss_typename_param_k T
        >
class CList_adaptor_base
    : public stlsoft_ns_qual(stl_collection_tag)
{
public:
    typedef L                                                                   list_type;
private:
    typedef I                                                                   interface_class_type;
    typedef T                                                                   list_traits_type;
#if defined(MFCSTL_CLIST_ADAPTORS_USE_BAD_ALLOC_POLICY)
    typedef bad_alloc_throwing_policy                                           exception_translation_policy_type;
#else /* ? MFCSTL_CLIST_ADAPTORS_USE_BAD_ALLOC_POLICY */
    typedef CMemoryException_throwing_policy                                    exception_translation_policy_type;
#endif /* MFCSTL_CLIST_ADAPTORS_USE_BAD_ALLOC_POLICY */
public:
    typedef ss_typename_type_k list_traits_type::value_type                     value_type;
    typedef afx_allocator<value_type>                                           allocator_type;
    typedef ss_typename_type_k allocator_type::reference                        reference;
    typedef ss_typename_type_k allocator_type::const_reference                  const_reference;
    typedef ss_typename_type_k allocator_type::pointer                          pointer;
    typedef ss_typename_type_k allocator_type::const_pointer                    const_pointer;
    typedef ms_size_t                                                           size_type;
    typedef ms_ptrdiff_t                                                        difference_type;
    typedef CList_adaptor_base<L, I, T>                                         class_type;
public:
    class const_iterator
        : public stlsoft_ns_qual(iterator_base)<mfcstl_ns_qual_std(input_iterator_tag)
                                            ,   value_type
                                            ,   ms_ptrdiff_t
                                            ,   void        // By-Value Temporary reference
                                            ,   value_type  // By-Value Temporary reference
                                            >
    {
        friend class CList_adaptor_base<L, I, T>;

        typedef const_iterator                                              class_type;
        // NOTE: If you get a compiler error on the next line, referring to
        // undefined 'value_type' then you need to provide a traits type
        // with the member type 'value_type' defined.
# ifdef STLSOFT_CF_TEMPLATE_PARTIAL_SPECIALISATION_SUPPORT
        typedef ss_typename_type_k CList_adaptor_base<L, I, T>::value_type  value_type;
# endif /* !STLSOFT_CF_TEMPLATE_PARTIAL_SPECIALISATION_SUPPORT */
# ifndef _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR
        typedef stlsoft_define_move_rhs_type(class_type)                    rhs_type;
# endif /* !_MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */

    // Construction
    private:
        const_iterator(list_type const* list, POSITION pos)
            : m_list(list)
            , m_pos(pos)
            , m_value()
        {
            operator ++();
        }
    public:
        const_iterator()
            : m_list(NULL)
            , m_pos(NULL)
            , m_value()
        {}
# ifdef _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR
        // The copy constructor and copy assignment operator are not defined,
        // which allows the class to support copy-semantics. See the
        // description of _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR given for
        // a discussion of the ramifications of this choice.

# else /* ? _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */
        const_iterator(rhs_type rhs)
            : m_list(rhs.m_list)
            , m_pos(rhs.m_pos)
            , m_value(rhs.m_value)
        {
            move_lhs_from_rhs(rhs).m_pos = NULL;
        }

        const_iterator const& operator =(rhs_type rhs)
        {
            m_list  =   rhs.m_list;
            m_pos   =   rhs.m_pos;
            m_value =   rhs.m_value;

            move_lhs_from_rhs(rhs).m_pos = NULL;

            return *this;
        }
# endif /* _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */

    // Operators
    public:
        value_type operator *() const
        {
            MFCSTL_MESSAGE_ASSERT("", NULL != m_list);

            return m_value;
        }

        const_iterator& operator ++()
        {
            if(m_pos == NULL)
            {
                MFCSTL_MESSAGE_ASSERT("operator ++() called on invalid iterator", NULL != m_list);

                m_list = NULL;
            }
            else
            {
                m_value = m_list->GetNext(m_pos);
            }

            return *this;
        }

# ifdef _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR
        const_iterator operator ++(int)
# else /* ? _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */
        void operator ++(int)
# endif /* _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */
        {
# ifdef _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR
            class_type  ret(*this);
# endif /* _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */

            operator ++();

# ifdef _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR
            return ret;
# endif /* _MFCSTL_LIST_ADAPTOR_ENABLE_FWD_ITERATOR */
        }

        ms_bool_t operator ==(const_iterator const& rhs) const
        {
            // Because the C<Type><Container> containers, e.g. CStringList
            // work on the basis of get-and-advance, m_pos alone cannot be
            // the sentinel for an ended sequence. Hence, combining the
            // implementation of op++ to set m_list to NULL when m_pos is NULL, we
            // can test both members, which results in the after-the-fact
            // equality evaluating correctly.

            MFCSTL_MESSAGE_ASSERT("invalid comparison between iterators from different ranges", (NULL == m_list || NULL == rhs.m_list || m_list == rhs.m_list));

            return m_pos == rhs.m_pos && m_list == rhs.m_list;
        }
        ms_bool_t operator !=(const_iterator const& rhs) const
        {
            return !operator ==(rhs);
        }

    // Members
    private:
        list_type const*    m_list;
        POSITION            m_pos;
        value_type          m_value;
    };

public:
    list_type&          get_CList()
    {
        return static_cast<interface_class_type*>(this)->get_actual_list();
    }
    list_type const&    get_CList() const
    {
        return static_cast<interface_class_type const*>(this)->get_actual_list();
    }

protected:
    CList_adaptor_base()
    {}
    ~CList_adaptor_base() stlsoft_throw_0()
    {}
public:
    allocator_type get_allocator() const
    {
        return allocator_type();
    }

public:
    size_type size() const
    {
        return static_cast<size_type>(get_CList().GetSize());
    }
    size_type max_size() const
    {
        return get_allocator().max_size();
    }
    ms_bool_t empty() const
    {
        return 0 == size();
    }

public:

public:
    void push_back(value_type const& val)
    {
        get_CList().AddTail(val);
    }

public:
    const_iterator  begin() const
    {
        return const_iterator(&get_CList(), get_CList().GetHeadPosition());
    }
    const_iterator  end() const
    {
        return const_iterator();
    }
};

template<   ss_typename_param_k A
        ,   ss_typename_param_k T = CList_traits<A>
        >
class CList_iadaptor
        : public CList_adaptor_base<A, CList_iadaptor<A, T>, T>
{
private:
    typedef CList_adaptor_base<A, CList_iadaptor<A, T>, T>        parent_class_type;
public:
    typedef ss_typename_type_k parent_class_type::list_type        list_type;
    typedef ss_typename_type_k parent_class_type::value_type        value_type;
    typedef ss_typename_type_k parent_class_type::allocator_type    allocator_type;
    typedef ss_typename_type_k parent_class_type::reference         reference;
    typedef ss_typename_type_k parent_class_type::const_reference   const_reference;
    typedef ss_typename_type_k parent_class_type::pointer           pointer;
    typedef ss_typename_type_k parent_class_type::const_pointer     const_pointer;
#if 0
    typedef ss_typename_type_k parent_class_type::const_iterator    const_iterator;
#endif /* 0 */
    typedef ss_typename_type_k parent_class_type::size_type         size_type;
    typedef ss_typename_type_k parent_class_type::difference_type   difference_type;
    typedef CList_iadaptor<A, T>                                   class_type;

private:
    friend class CList_adaptor_base<A, CList_iadaptor<A, T>, T>;

    list_type          &get_actual_list()
    {
        MFCSTL_ASSERT(NULL != m_pList);
        return *m_pList;
    }
    list_type const    &get_actual_list() const
    {
        MFCSTL_ASSERT(NULL != m_pList);
        return *m_pList;
    }

public:
    template <ss_typename_param_k A2>
    CList_iadaptor(A2 &list)
         : m_pList(&list)
    {
        STLSOFT_STATIC_ASSERT(sizeof(list_type) == sizeof(A2));
#ifdef STLSOFT_META_HAS_IS_SAME_TYPE
        STLSOFT_STATIC_ASSERT((stlsoft::is_same_type<list_type, A2>::value));
#else /* ? STLSOFT_META_HAS_IS_SAME_TYPE */
        ASSERT(0 == ::lstrcmpA(list.GetRuntimeClass()->m_lpszClassName, list_type().GetRuntimeClass()->m_lpszClassName));
# ifdef _CPPRTTI
        ASSERT(0 == ::lstrcmpA(typeid(A2).name(), typeid(list_type).name()));
# endif /* _CPPRTTI */
#endif /* STLSOFT_META_HAS_IS_SAME_TYPE */
    }
    template <ss_typename_param_k A2>
    CList_iadaptor(A2 *pList)
         : m_pList(pList)
    {
        MFCSTL_MESSAGE_ASSERT("Cannot initialise a CList_iadaptor with a NULL pointer", NULL != pList);

        STLSOFT_STATIC_ASSERT(sizeof(list_type) == sizeof(A2));
#ifdef STLSOFT_META_HAS_IS_SAME_TYPE
        STLSOFT_STATIC_ASSERT((stlsoft::is_same_type<list_type, A2>::value));
#else /* ? STLSOFT_META_HAS_IS_SAME_TYPE */
        ASSERT(0 == ::lstrcmpA(pList->GetRuntimeClass()->m_lpszClassName, list_type().GetRuntimeClass()->m_lpszClassName));
# ifdef _CPPRTTI
        ASSERT(0 == ::lstrcmpA(typeid(A2).name(), typeid(list_type).name()));
# endif /* _CPPRTTI */
#endif /* STLSOFT_META_HAS_IS_SAME_TYPE */
    }

private:
    list_type  *m_pList;

private:
    CList_iadaptor(class_type const& rhs);            // Only possible semantics for copy-ctor are share underlying list
    class_type& operator =(class_type const& rhs);  // Could either repoint, or could do deep copy.
};

// Unit-testing

#ifdef STLSOFT_UNITTEST
# include "./unittest/clist_adaptors_unittest_.h"
#endif /* STLSOFT_UNITTEST */

/* ////////////////////////////////////////////////////////////////////// */

#ifndef _MFCSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
} /* namespace mfcstl */
# else
} /* namespace mfcstl_project */
} /* namespace stlsoft */
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_MFCSTL_NO_NAMESPACE */

/* ////////////////////////////////////////////////////////////////////// */

#endif /* !MFCSTL_INCL_MFCSTL_COLLECTIONS_HPP_CLIST_ADAPTORS */

/* ///////////////////////////// end of file //////////////////////////// */

---