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

#ifndef NN_FS_FS_DIRECTORY_H_
#define NN_FS_FS_DIRECTORY_H_

#include <nn/Handle.h>
#include <nn/Result.h>
#include <nn/types.h>
#include <nn/util/util_Result.h>
#include <nn/fs/fs_Parameters.h>
#include <nn/fs/fs_DirectoryBase.h>

#include <nn/fs/fs_DirectoryBase.h>

namespace nn {
namespace fs {

/*!
    @brief ディレクトリを操作するためのクラスです。

           パス名で指定されたディレクトリを開き、そのエントリを読み込むことができます。
           パス名を指定して、ディレクトリの作成・リネーム・削除ができます。
           パス名の指定には、ワイド文字列とマルチバイト文字列の両方が使えますが、
           特別な理由が無い限りは、ワイド文字列を使うようにしてください。
*/
class Directory : private nn::util::NonCopyable<Directory>, private detail::DirectoryBase
{
public:

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

               引数の無いオーバロードでは、ディレクトリは開きません。ディレクトリのエントリを読み込むためには、別途 @ref Initialize を呼ぶ必要があります。

               パス名を指定したオーバロードでは、指定されたパスのディレクトリを開きます。
    */
    Directory() {}

    /*!
        @brief オブジェクトを構築し、指定されたディレクトリを開くコンストラクタです。

               指定されたパスのディレクトリを開きます。

        @param[in] pathName 開くディレクトリのパス
    */
    Directory( const wchar_t* pathName ) : DirectoryBase(pathName) {}

    /*!
        @brief オブジェクトを構築し、指定されたディレクトリを開くコンストラクタです。

               指定されたパスのディレクトリを開きます。
               この関数では、内部でパス名をマルチバイト文字列からワイド文字列に変換するために、
               大きくスタック上にバッファを取るので、スタックの大きさには注意してください。

        @param[in] pathName 開くディレクトリのパス(ASCII 文字以外を含むことはできません)
    */
    Directory( const char* pathName ) : DirectoryBase(pathName) {}

    /*!
        @brief 指定されたディレクトリを開きます。

               指定されたパスのディレクトリを開きます。
               既にこのオブジェクトでディレクトリを開いている場合に呼ぶことはできません。

        @param[in] pathName 開くディレクトリのパス
    */
    void Initialize( const wchar_t* pathName ) { DirectoryBase::Initialize(pathName); }

    /*!
        @brief 指定されたディレクトリを開きます。

               指定されたパスのディレクトリを開きます。
               既にこのオブジェクトでディレクトリを開いている場合に呼ぶことはできません。
               この関数では、内部でパス名をマルチバイト文字列からワイド文字列に変換するために、
               大きくスタック上にバッファを取るので、スタックの大きさには注意してください。

        @param[in] pathName 開くディレクトリのパス(ASCII 文字以外を含むことはできません)
    */
    void Initialize( const char* pathName ) { DirectoryBase::Initialize(pathName); }

    /*!
        @brief 指定されたディレクトリを開くことを試みます。

               指定されたパスのディレクトリを開きます。
               ディレクトリを開く途中でエラーが発生した場合は、そのエラーを返します。
               既にこのオブジェクトでディレクトリを開いている場合に呼ぶことはできません。

        @param[in] pathName 開くディレクトリのパス

        @return ディレクトリを開いた結果。
    */
    Result TryInitialize( const wchar_t* pathName ) { return DirectoryBase::TryInitialize(pathName); }

    /*!
        @brief 指定されたディレクトリを開くことを試みます。

               指定されたパスのディレクトリを開きます。
               ディレクトリを開く途中でエラーが発生した場合は、そのエラーを返します。
               既にこのオブジェクトでディレクトリを開いている場合に呼ぶことはできません。
               この関数では、内部でパス名をマルチバイト文字列からワイド文字列に変換するために、
               大きくスタック上にバッファを取るので、スタックの大きさには注意してください。

        @param[in] pathName 開くディレクトリのパス

        @return ディレクトリを開いた結果。
    */
    Result TryInitialize( const char* pathName ) { return DirectoryBase::TryInitialize(pathName); }

    /*!
        @brief ディレクトリを閉じます。

               ディレクトリを閉じます。ディレクトリが開かれていなかった場合は何もしません。
    */
    void Finalize() { DirectoryBase::Finalize(); }

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

               ディレクトリが開かれていればディレクトリを閉じます。
    */
    virtual ~Directory() {}

    /*!
        @brief ディレクトリから指定された数のディレクトリエントリを読み込みます。

               ファイルの現在位置から最大 numEntries エントリを読み込み、
               pEntries で指定されたアドレスの領域にコピーします。
               実際にコピーしたエントリ数を返します。

               エントリを全て走査し終わっているときは、0 を返します。

         @param[out] pEntries ディレクトリエントリの読み込み先
         @param[in] numEntries 読み込む最大のディレクトリエントリ数

         @return 実際に読み込んだエントリ数を返します。エントリを全て走査し終わっているときは、0 を返します。
    */
    s32 Read( DirectoryEntry pEntries[], s32 numEntries ) { return DirectoryBase::Read(pEntries, numEntries); }

    Result TryRead( s32* pNumEntriesOut, DirectoryEntry pEntries[], s32 numEntries ) { return DirectoryBase::TryRead(pNumEntriesOut, pEntries, numEntries); }
    
};

} // end of namespace fs
} // end of namespace nn

#endif  // ifndef NN_FS_FS_DIRECTORY_H_