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

/*!
    @file

    :include nn/dbg.h
*/

#ifndef NN_DBG_DBG_BREAK_H_
#define NN_DBG_DBG_BREAK_H_

#include <nn/Result.h>
#include <nn/types.h>
#include <nn/dbg/dbg_Enum.h>

//-------------------------------------------------------------------
// for C / C++

#ifdef __cplusplus
extern "C" {
#endif  // ifdef __cplusplus

/*!
    @brief 対応する C++ 関数 @ref nn::dbg::Break を参照してください。
*/
nnResult nndbgBreak(int reason);

/*!
    @brief 対応する C++ 関数 @ref nn::dbg::Panic を参照してください。
*/
void nndbgPanic(void);

#ifdef __cplusplus
}
#endif  // ifdef __cplusplus



//-------------------------------------------------------------------
// for C++

#ifdef __cplusplus

namespace nn { namespace dbg {

    /*!
        @brief プログラムを停止します。
        
               デバッガ上で実行している場合、
               Break を呼び出すとその位置でプログラムが停止状態になります。
    
               デバッガ上でない場合はプログラムが終了します。
               ただし Config ツールで「Break Stop」を
               「enable」にすることで終了ではなく停止するようになります。

        @param[in]  reason 停止の原因を示す値。
        
        @return 関数の実行結果を返します。
    */
    nn::Result Break(nn::dbg::BreakReason reason);

    /*!
        @brief プログラムを停止します。
        
                停止の原因は BREAK_REASON_PANIC です。

        @return 関数の実行結果を返します。
    */
    inline nn::Result Break()
    {
        return Break(BREAK_REASON_PANIC);
    }

    /*!
        @brief プログラムを停止します。
        
                停止の原因は BREAK_REASON_PANIC です。
    */
    void Panic();

}}

#endif  // ifdef __cplusplus



#endif /* NN_DBG_DBG_BREAK_H_ */