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

/*!
    @file

    :include nn/dbg.h
*/

#ifndef NN_DBG_DBG_PRINTRESULT_H_
#define NN_DBG_DBG_PRINTRESULT_H_

#include <nn/Result.h>

#ifdef __cplusplus
namespace nn { namespace dbg {

/*
    @brief エラーレベルを示す文字列を取得します。

    @param[in] result 結果

    @return エラーレベルを示す文字列
*/
const char* GetLevelString(nn::Result result);

/*
    @brief モジュール情報を示す文字列を取得します。

    @param[in] result 結果

    @return モジュール情報を示す文字列
*/
const char* GetModuleString(nn::Result result);

/*
    @brief エラー概要を示す文字列を取得します。

    @param[in] result 結果

    @return エラー概要を示す文字列
*/
const char* GetSummaryString(nn::Result result);

/*
    @brief エラー詳細を示す文字列を取得します。

    @param[in] result 結果

    @return エラー詳細を示す文字列
*/
const char* GetDescriptionString(nn::Result result);

/*
    @brief 結果を出力します。

    @param[in] result 結果
*/
void PrintResult(Result result);

/*
    @brief 結果を出力します。PrintResult の省メモリ版です。

    @param[in] result 結果
*/
void TPrintResult(Result result);

}}

#ifndef NN_SWITCH_DISABLE_ASSERT_WARNING

    #define NN_DBG_DECLARE_GET_RESULT_DESCRIPTION_STRING_IMPL_KEEPER(libname) \
        namespace nn { namespace libname { \
            void GetResultDescriptionStringImplKeeper(); \
        }}

    #define NN_DBG_USE_GET_RESULT_DESCRIPTION_STRING_IMPL_KEEPER(libname) (::nn::libname::GetResultDescriptionStringImplKeeper())

    #define NN_DBG_CHECK_RESULT(exp)    NN_UTIL_PANIC_IF_FAILED(exp)
#else

    #define NN_DBG_DECLARE_GET_RESULT_DESCRIPTION_STRING_IMPL_KEEPER(libname)
    #define NN_DBG_USE_GET_RESULT_DESCRIPTION_STRING_IMPL_KEEPER(libname) (void)0

    #define NN_DBG_CHECK_RESULT(exp)    ((void)(exp))

#endif

#endif  // ifdef __cplusplus


#endif /* NN_DBG_DBG_RESULT_H_ */