/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     fnd_MemoryRange.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 31054 $
 *---------------------------------------------------------------------------*/

/*!@file
  @brief    メモリ領域の範囲を表すクラスです。
 */

#ifndef NN_FND_FND_MEMORYRANGE_H_
#define NN_FND_FND_MEMORYRANGE_H_

#include <nn/types.h>

#include <nn/Assert.h>

#ifdef __cplusplus


namespace nn { namespace fnd {

/*!
    @brief    メモリ領域の範囲を表すクラスです。
 */
class MemoryRange
{
public:

    MemoryRange() {}

    /*!
        @brief      メモリ領域の範囲を表すオブジェクトを構築します。

        @param[in] begin    先頭アドレスを表します。

        @param[in] end      末尾アドレスを表します。領域内の最後のアドレス+4 の位置を指定します。
    */
    MemoryRange(uptr begin, uptr end) : m_Begin(begin), m_End(end) { NN_TASSERT_(m_Begin <= m_End); }

    /*!
        @brief      メモリ領域の範囲を初期化します。

        @param[in] begin    先頭アドレスを表します。

        @param[in] end      末尾アドレスを表します。領域内の最後のアドレス+4 の位置を指定します。
    */
    void Initialize(uptr begin, uptr end) { m_Begin = begin; m_End = end; NN_TASSERT_(m_Begin <= m_End); }

    /*!
        @brief      先頭アドレスを返します。
    */
    uptr GetAddress() const { return m_Begin; }

    /*!
        @brief      末尾のアドレスを返します。
        
                    先頭アドレス + 領域の大きさ の位置であり、領域内の最後のアドレス+4 の位置を表しています。
    */
    uptr GetEndAddress() const { return m_End; }

    /*!
        @brief          範囲の大きさを返します。

        @return         メモリブロックの大きさ
    */
    size_t GetSize() const { return m_End - m_Begin; }

private:
    uptr m_Begin;
    uptr m_End;
};

}}

#endif

#endif