//
// Copyright (C) 2014 Intel Corporation. All Rights Reserved.
//
// The source code contained or described herein and all documents related
// to the source code ("Material") are owned by Intel Corporation or its
// suppliers or licensors.  Title to the Material remains with Intel
// Corporation or its suppliers and licensors.  The Material is protected
// by worldwide copyright laws and treaty provisions.  No part of the
// Material may be used, copied, reproduced, modified, published, uploaded,
// posted, transmitted, distributed, or disclosed in any way without
// Intel's prior express written permission.
//
// No license under any patent, copyright, trade secret or other intellectual
// property right is granted to or conferred upon you by disclosure or
// delivery of the Materials, either expressly, by implication, inducement,
// estoppel or otherwise. Any license under such intellectual property rights
// must be express and approved by Intel in writing.
//
// Unless otherwise agreed by Intel in writing, you may not remove or alter
// this notice or any other notice embedded in Materials by Intel or Intel's
// suppliers or licensors in any way.
//

#ifndef SDLT_SOA_1D_MEMBER_H
#define SDLT_SOA_1D_MEMBER_H

#include "../../common.h"
#include "../../internal/soa1d/exporter.h"
#include "../../internal/soa1d/importer.h"
#include "../../internal/soa1d/organization.h"
#include "../../primitive.h"
#include "../deferred.h"
#include "../enable_if_type.h"
#include "../rvalue_operator_helper.h"
#include "../unqualified.h"


namespace sdlt {
namespace __SDLT_IMPL {
namespace internal {
namespace soa1d {

__SDLT_INHERIT_IMPL_BEGIN

template<
    typename PrimitiveT,
    int AlignD1OnIndexT,
    typename IndexD1T
>
struct member
{

    template<
        typename MemberDataT,
        int MemberOffsetT
    >
    class proxy
    : public sdlt::primitive<MemberDataT>::template member_interface<proxy<MemberDataT, MemberOffsetT>, MemberOffsetT, proxy>
    // By inheriting from the primitive's member_interface,
    // methods to access to each individual data member of the MemberDataT
    // are generated
    {
    public:
        typedef MemberDataT value_type;

        explicit SDLT_INLINE
        proxy(
            unsigned char * const a_data,
            const organization an_organization,
            const IndexD1T an_index_d1)
        : m_data(a_data)
        , m_organization(an_organization)
        , m_index(an_index_d1)
        {
        }

        // MUST PROVIDE USER DEFINED COPY CONSTRUCTOR
        // with individual member assignment to allow compiler
        // to track them through a SIMD loop
        SDLT_INLINE
        proxy(const proxy &other)
        : m_data(other.m_data)
        , m_organization(other.m_organization)
        , m_index(other.m_index)
        {
        }

        // NOTE:  the return value is constant, intent is to allow chained
        // assignments, not modification of return value.  As we can't ever
        // provide direct access to the underlying object for all containers,
        // just import export of its values.
        // We could have returned *this, but in the case of chaining wanted
        // to avoid re-exporting the primitive when we already have it
        // represented as a_value
        SDLT_INLINE
        const value_type &
        operator = (const value_type &a_value) {
            importer<PrimitiveT, MemberOffsetT, AlignD1OnIndexT, IndexD1T> imp(
                m_data,
                m_organization,
                m_index);

            // In order to use the same layout strategy for import and export
            // we have to use non-const parameter,
            // thus we have to remove constness of the value
            primitive<MemberDataT>::transfer(imp, const_cast<MemberDataT &>(a_value));
            return a_value;
        }

        // NOTE: MemberDataT const prevents rvalue assignment for structs,
        // better protection that nothing
        SDLT_INLINE
        operator value_type const () const {
            MemberDataT value;
            exporter<PrimitiveT, MemberOffsetT, AlignD1OnIndexT, IndexD1T> ex(
                m_data,
                m_organization,
                m_index);

            primitive<MemberDataT>::transfer(ex, value);
            return value;
        }

        // can't inherit assignment operator so have to define it here
        SDLT_INLINE
        proxy &
        operator = (const proxy &other) {

            value_type const value = other;
            this->operator = (value);
            return *this;
        }

        // Support Argument Dependent Lookup to specialize for std::swap
        // NOTE:  Iterators return an instance, not the usual reference
        // to the data.  And some algorithms like std::swap_iter
        // will call swap with value, not reference, arguments.
        // For this reason we override the value version of swap,
        // not the reference.
        friend SDLT_INLINE
        void swap(proxy left, proxy right)
        {
            // NOTE:  member swap implemented by pass_through_land_rvalue_operators_xmacro
            left.swap(right);
        }

        // By including pass_through_land_rvalue_operators_xmacro,
        // operators for lvalue based compound assignment, increment, decrement operators are generated
        // operators for rvalue based relational, arithmetic, logic, and bitwise operators are generated
        #define __SDLT_XMACRO_SELF proxy
        #include "../../internal/pass_through_land_rvalue_operators_xmacro.h"

    protected:
        template<typename>
        friend class sdlt::primitive;

        template<typename NestedMemberDataT, int OffsetT>
        SDLT_INLINE
        proxy<NestedMemberDataT, MemberOffsetT+OffsetT> member() const
        {
            return proxy<NestedMemberDataT, MemberOffsetT+OffsetT>(m_data, m_organization, m_index);
        }

    private:
        unsigned char * const m_data;
        const organization m_organization;
        IndexD1T m_index;
    };

};

__SDLT_INHERIT_IMPL_END

} // namespace soa1d
} // namespace internal
} // namespace __SDLT_IMPL
} // namespace sdlt

#endif // SDLT_SOA_1D_MEMBER_H
