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

  Copyright (C)2010 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: 17231 $
 *---------------------------------------------------------------------------*/

#ifndef UBL_API_H_
#define UBL_API_H_

#include<nn/fs.h>
#include<nn/fnd.h>
#include<nn/Result.h>

namespace nn {
namespace ubl {

/*=======================================================================*
    関数プロトタイプ宣言
 *=======================================================================*/

/*!--------------------------------------------------------------------------*
  @brief        UBLライブラリを初期化処理を行います
                ライブラリ利用前に一度呼び出す必要があります

  @return       処理の結果が返ってきます
 *---------------------------------------------------------------------------*/
nn::Result Initialize( void );

/*!--------------------------------------------------------------------------*
  @brief        UBLライブラリを終了します
 *---------------------------------------------------------------------------*/
void Finalize( void );

/*!--------------------------------------------------------------------------*
  @brief        ローカルブラックリストをクリアーした後、SDカードに書き出します

  @return       クリアー処理に対する処理の結果が返ります
 *---------------------------------------------------------------------------*/
nn::Result Clear( void );

/*!--------------------------------------------------------------------------*
  @brief        指定IDがブラックリストに存在するか調べます
  
                現在、ローカルブラックリストのみ検索します。
                つまりタイトルIDとUGCデータIDは無視されます。
                グローバルへの対応は将来行われる予定です。

  @param[in]    authorId 検索する作者ID
  @param[in]    titleId  検索するタイトルID
  @param[in]    dataId   検索するUGCデータID

  @return       指定した要素が合致したならtrue、合致しなければfalse
 *---------------------------------------------------------------------------*/
bool IsExist( u64 authorId , u32 titleId , u64 dataId);

/*!--------------------------------------------------------------------------*
  @brief        ローカルブラックリストに登録されている作者の総数を返します

  @return       ローカルブラックリストに登録されている作者の総数
 *---------------------------------------------------------------------------*/
u32 GetTotalLocalUser( void );

/*!--------------------------------------------------------------------------*
  @brief        グローバル作者ブラックリストに登録されている作者の総数を返します

  @return       グローバル作者ブラックリストに登録されている作者の総数
 *---------------------------------------------------------------------------*/
u32 GetTotalGlobalUser( void );

/*!--------------------------------------------------------------------------*
  @brief        グローバルデータブラックリストに登録されているデータの総数を返します

  @return       グローバルデータブラックリストに登録されているデータの総数
 *---------------------------------------------------------------------------*/
u32 GetTotalGlobalData( void );

/*!--------------------------------------------------------------------------*
  @brief        CTR本体のユニークIDを返します

  @return       CTR本体のユニークID
 *---------------------------------------------------------------------------*/
u64 GetUserId( void );

/*!--------------------------------------------------------------------------*
  @brief        ユーザー名を取得します

  @param[out]   name 取得したユーザ名を格納するメモリへのポインタ
  
  @return       ユーザー名にNGワードが含まれている場合にはtrue
 *---------------------------------------------------------------------------*/
bool GetUserName( wchar_t *name );

/*!--------------------------------------------------------------------------*
  @brief        64ビット長のハッシュデータを取得します

  @param[in]    inputBuffer 入力データへのポインタ
  @param[in]    inputSize   入力データのサイズ

  @return       64ビットのハッシュデータ
 *---------------------------------------------------------------------------*/
u64 GetHashValue( const void *inputBuffer , size_t inputSize);

/*!--------------------------------------------------------------------------*
  @brief        指定されたIDと日時をローカルブラックリストに登録し、SDカードに書き出します

  @param[in]    id 登録する作者ID
  @param[in]    dt 登録日時

  @return       登録処理に対する処理の結果が返ります
 *---------------------------------------------------------------------------*/
nn::Result Entry( u64 id, nn::fnd::DateTime *dt );

} // end of namespace ubl
} // end of namespace nn

#endif /* UBL_API_H_ */