---

stlsoft_array_proxy.h

Go to the documentation of this file.

/* 
 * File:        stlsoft_array_proxy.h
 *
 * Purpose:     Definition of the array_proxy template, which provides managed
 *              access to arrays, and can be used to avoid polymorphic array
 *              problems.
 *
 * Created:     11th November 2002
 * Updated:     11th September 2004
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2002-2004, 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 STLSOFT_INCL_H_STLSOFT_ARRAY_PROXY
#define STLSOFT_INCL_H_STLSOFT_ARRAY_PROXY

#ifndef __STLSOFT_DOCUMENTATION_SKIP_SECTION
# define STLSOFT_VER_H_STLSOFT_ARRAY_PROXY_MAJOR        2
# define STLSOFT_VER_H_STLSOFT_ARRAY_PROXY_MINOR        0
# define STLSOFT_VER_H_STLSOFT_ARRAY_PROXY_REVISION     1
# define STLSOFT_VER_H_STLSOFT_ARRAY_PROXY_EDIT         26
#endif /* !__STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* 
 * Includes
 */

#ifndef STLSOFT_INCL_H_STLSOFT
# include "stlsoft.h"               // Include the STLSoft root header
#endif /* !STLSOFT_INCL_H_STLSOFT */
#ifndef STLSOFT_INCL_H_STLSOFT_CONSTRAINTS
# include "stlsoft_constraints.h"   // must_be_same_size, must_have_base
#endif /* !STLSOFT_INCL_H_STLSOFT_CONSTRAINTS */

/* 
 * Namespace
 */

#ifndef _STLSOFT_NO_NAMESPACE
namespace stlsoft
{
#endif /* _STLSOFT_NO_NAMESPACE */

/* 
 * Classes
 */

template <ss_typename_param_k T>
class array_proxy
{
public:
    typedef T                   value_type;
    typedef array_proxy<T>      class_type;
    typedef value_type          *pointer;
    typedef value_type          *const_pointer;     // This is deliberately non-const
    typedef value_type          *iterator;
    typedef value_type          *const_iterator;    // This is deliberately non-const
    typedef value_type          &reference;
    typedef value_type          &const_reference;   // This is deliberately non-const
    typedef ss_size_t           size_type;

public:
#ifdef __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
    template <ss_typename_param_k D>
    array_proxy(array_proxy<D> const &d)
        : m_begin(d.begin())
        , m_end(d.end())
    {
        // Ensures that D is a derived type of T. (Actually that is
        // handled in the initialiser list, but putting it here
        // makes the intent quite explicit.)
        stlsoft_constraint_must_have_base(D, T);

        // Ensures that D and T are the same size.
        stlsoft_constraint_must_be_same_size(D, T);
    }

# ifdef __STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT
    template <ss_typename_param_k D, ss_size_t N>
    ss_explicit_k array_proxy(D (&d)[N])
        : m_begin(&d[0])
        , m_end(&d[N])
    {
        // Ensures that D is a derived type of T. (Actually that is
        // handled in the initialiser list, but putting it here
        // makes the intent quite explicit.)
        stlsoft_constraint_must_have_base(D, T);

        // Ensures that D and T are the same size.
        stlsoft_constraint_must_be_same_size(D, T);
    }

#  if defined(STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR)
    template <ss_size_t N>
    ss_explicit_k array_proxy(T (&t)[N])
        : m_begin(&t[0])
        , m_end(&t[N])
    {}
#  endif /* STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR */
# endif /* __STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT */
#endif // __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT

#if !defined(__STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT) || \
    defined(STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR)
    array_proxy(pointer begin, pointer end)
        : m_begin(begin)
        , m_end(end)
    {}
#endif /* !__STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT || STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR */

#ifdef __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
    template <ss_typename_param_k D>
    array_proxy(D *begin, D *end)
        : m_begin(begin)
        , m_end(end)
    {
        // Ensures that D is a derived type of T. (Actually that is
        // handled in the initialiser list, but putting it here
        // makes the intent quite explicit.)
        stlsoft_constraint_must_have_base(D, T);

        // Ensures that D and T are the same size.
        stlsoft_constraint_must_be_same_size(D, T);
   }
#endif // __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT

#if !defined(__STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT) || \
    defined(STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR)
    array_proxy(pointer p, ss_size_t n)
        : m_begin(p)
        , m_end(p + n)
    {}
#endif /* !__STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT || STLSOFT_CF_NON_TEMPLATE_CTOR_REQUIRED_WITH_TEMPLATE_CTOR */

#ifdef __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT
    template <ss_typename_param_k D>
    array_proxy(D *p, ss_size_t n)
        : m_begin(p)
        , m_end(p + n)
    {
        // Ensures that D is a derived type of T. (Actually that is
        // handled in the initialiser list, but putting it here
        // makes the intent quite explicit.)
        stlsoft_constraint_must_have_base(D, T);

        // Ensures that D and T are the same size.
        stlsoft_constraint_must_be_same_size(D, T);
    }
#endif // __STLSOFT_CF_MEMBER_TEMPLATE_CTOR_SUPPORT


public:
    pointer base()
    {
        return m_begin;
    }
    pointer base() const
    {
        return m_begin;
    }
    size_type size() const
    {
        return m_end - m_begin;
    }
    ss_bool_t empty() const
    {
        return m_begin == m_end;
    }
    static size_type max_size()
    {
        return static_cast<size_type>(-1) / sizeof(value_type);
    }

public:
    reference operator [](ss_size_t index)
    {
        stlsoft_message_assert("index out of bounds, in array_proxy", !(size() < index));

        return m_begin[index];
    }
    const_reference operator [](ss_size_t index) const
    {
        stlsoft_message_assert("index out of bounds, in array_proxy", !(size() < index));

        return const_cast<pointer>(m_begin)[index];
    }

public:
    iterator begin()
    {
        return m_begin;
    }
    iterator end()
    {
        return m_end;
    }
    const_iterator begin() const
    {
        return m_begin;
    }
    const_iterator end() const
    {
        return m_end;
    }

// Members
private:
    pointer const m_begin;
    pointer const m_end;

// Not to be implemented
private:
    array_proxy &operator =(array_proxy const &);
};

#ifdef __STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT
template <ss_typename_param_k T, ss_size_t N>
inline array_proxy<T> make_array_proxy(T (&t)[N])
{
    return array_proxy<T>(&t[0], &t[N]);
//    return array_proxy<T>(t); // This one not used, because CodeWarrior gets confused
}
#endif /* __STLSOFT_CF_STATIC_ARRAY_SIZE_DETERMINATION_SUPPORT */

template <ss_typename_param_k T>
inline array_proxy<T> make_array_proxy(T *begin, T *end)
{
    return array_proxy<T>(begin, end);
}

template <ss_typename_param_k T>
inline array_proxy<T> make_array_proxy(T *p, ss_size_t n)
{
    return array_proxy<T>(p, n);
}

// Unit-testing

#ifdef STLSOFT_UNITTEST

namespace unittest
{
    ss_bool_t test_stlsoft_array_proxy(unittest_reporter *r)
    {
        ss_bool_t               bSuccess    =   true;

        unittest_initialiser    init(r, "STLSoft", "array_proxy", __FILE__);

#if 0
        if(<<TODO>>)
        {
            r->report("<<TODO>> failed ", __LINE__);
            bSuccess = false;
        }
#endif /* 0 */

        return bSuccess;
    }

    unittest_registrar    unittest_stlsoft_array_proxy(test_stlsoft_array_proxy);

} // namespace unittest

#endif /* STLSOFT_UNITTEST */

/* 

#ifndef _STLSOFT_NO_NAMESPACE
} // namespace stlsoft
#endif /* _STLSOFT_NO_NAMESPACE */

/* 

#endif /* !STLSOFT_INCL_H_STLSOFT_ARRAY_PROXY */

/* 

STLSoft Libraries documentation © Synesis Software Pty Ltd, 2001-2004