/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     hid_DebugPadReader.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: 17553 $
 *---------------------------------------------------------------------------*/

/*! @file
    @brief      DebugPadReader クラスを定義します。

*/
#ifndef NN_HID_CTR_HID_DEBUG_PAD_READER_H_
#define NN_HID_CTR_HID_DEBUG_PAD_READER_H_

#include <nn/Handle.h>
#include <nn/Result.h>
#include <nn/types.h>
#include <nn/hid/CTR/hid_Result.h>
#include <nn/hid/CTR/hid_Api.h>
#include <nn/hid/CTR/hid_pad.h>
#include <nn/hid/CTR/hid_DeviceStatus.h>
#include <nn/util/util_SizedEnum.h>
#include <nn/util/util_NonCopyable.h>

namespace nn {
namespace hid {
namespace CTR {
/*! @brief デバッグ専用のコントロールパッド(デバッグパッド)のサンプリングデータを読み込むクラスです。

             デバッグパッドは 16 msec 周期でサンプリングされます。<BR>
             アナログスティックのキャリブレーションは、システムの起動時に行います。また、aボタン、十字ボタン左、 +ボタン、-ボタン を実行中に同時に<BR>
             押してもキャリブレーションを行います。

*/

class DebugPadReader : private nn::util::NonCopyable<DebugPadReader>
{
public:
    /*!
      @enum     StickClampMode
      @brief    SetStickClampMode( )  で設定するアナログスティックのクランプ方法を示す列挙体です。
     */

    typedef enum
    {
        /*! @brief 遊びのある円形クランプ です。内側を十字形にクランプします。*/
        STICK_CLAMP_MODE_CIRCLE_WITH_PLAY = 0,
        /*! @brief 遊びのない円形クランプです。 */
        STICK_CLAMP_MODE_CIRCLE_WITHOUT_PLAY
    } StickClampMode;

    /*!
    @brief          コンストラクタです。

                    インスタンスを生成する前に @ref nn::hid::CTR::Initialize( ) で初期化してください。

    */
    DebugPadReader(DebugPad& debugPad=GetDebugPad( ))
        : m_DebugPad(debugPad)
        , m_IndexOfRead(-1)
        , m_IsReadLatestFirst(true)
        , m_StickClampMode(STICK_CLAMP_MODE_CIRCLE_WITH_PLAY)
        , m_TickOfRead(-1)
        {};

    /*!
    @brief          デストラクタです。

    */
    ~DebugPadReader( ) {};

    /*!
      @brief        デバッグパッドのサンプリングデータを新しいものから順に読み込みます。以前に読み込んだデータは読み込まれません。

      @param[out]   pBufs       新しいものから順にサンプリングデータが読み込まれます。
      @param[out]   pReadLen    読み込んだサンプリングデータの数です。
      @param[in]    bufLen      pBufs に読み込めるサンプリングデータの数を指定します。
      @return       なし。

    */
    void Read(DebugPadStatus* pBufs, s32* pReadLen, s32 bufLen);

    /*!
      @brief        最新のデバッグパッドのサンプリングデータを読み込みます。 nn::hid::CTR::DebugPadReader::Read( ) とちがい同じサンプリングデータを読み込むことが出来ます。

      trigger、release は前回の ReadLatest( ) の読み込み結果に対して生成されます。<BR><BR>

      @param[out]   pBuf        サンプリングデータが読み込まれます。
      @return       サンプリングデータの読み込み結果を返します。<BR>
                      true ・・・ 読み込めました。<BR>
                      false ・・・ 読み込めませんでした。(システム起動後あるいはスリープ復帰後の最初のサンプリングが行われ次第、読み込めます。)

    */
    bool ReadLatest(DebugPadStatus* pBuf);

    /*!
      @brief        アナログスティックのクランプ方法を取得します。

      @return       現在設定されているクランプ方法を返します。

    */
    StickClampMode GetStickClampMode( ) const;

    /*!
      @brief        アナログスティックのクランプ方法を設定します。

                    Read( ) と ReadLatest( ) で 得られるアナログスティックの値が設定された方法でクランプされます。クランプの詳細は、@ref nn::hid::CTR::DebugPadReader::StickClampMode を参照してください。<BR>
                   遊びのある 円形クランプ がデフォルトで設定されています。

      @param[in]    mode   設定するクランプ方法です。
      @return       なし。

    */
    void SetStickClampMode(StickClampMode mode);

protected:
    DebugPad&           m_DebugPad;
    s32                 m_IndexOfRead;
    bit16               m_LatestHold;
    bool                m_IsReadLatestFirst;
    nn::util::SizedEnum1<StickClampMode>      m_StickClampMode;
    NN_PADDING4;
    s64                 m_TickOfRead;
};


// inline 定義

inline DebugPadReader::StickClampMode DebugPadReader::GetStickClampMode( ) const
{
    return m_StickClampMode;
}

inline void DebugPadReader::SetStickClampMode(DebugPadReader::StickClampMode mode)
{
    m_StickClampMode = mode;
}

} // namespace CTR {
} // namespace hid {
} // namespace nn {

#endif  // #ifndef NN_HID_CTR_HID_DEBUG_PAD_READER_H_