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

#ifndef NN_FS_FS_PARAMETERS_H_
#define NN_FS_FS_PARAMETERS_H_

#include <nn/types.h>
#include <nn/config.h>
#include <nn/dbg/dbg_Logger.h>
#include <nn/assert.h>
#include <nn/util.h>
#include <nn/util/util_Int64.h>

namespace nn {
namespace fs {

static const size_t MAX_ARCHIVE_NAME_LENGTH = 7;
static const size_t MAX_FILE_PATH_LENGTH = MAX_ARCHIVE_NAME_LENGTH + 1 + 253;

/*!
    @brief ファイルのオープンモードを示す列挙定数です。

    ファイルのオープンモードをこれらの論理和で指定します。
*/
enum OpenMode
{
    OPEN_MODE_READ    = (1u << 0),  //!< 読み込みモードで開きます。
    OPEN_MODE_WRITE   = (1u << 1),  //!< 書き込みモードで開きます。
    OPEN_MODE_CREATE  = (1u << 2)   //!< ファイルが無ければファイルを作成します。OPEN_MODE_WRITE を同時に指定する必要があります。
};

/*!
    @brief ファイルの読み書きの位置を指定することを示す列挙定数です。
*/
enum PositionBase
{
    POSITION_BASE_BEGIN,    //!< ファイルの先頭を基準としてファイルのカレント位置を設定することを示す定数です。
    POSITION_BASE_CURRENT,  //!< ファイルのカレント位置を基準としてファイルのカレント位置を設定することを示す定数です。
    POSITION_BASE_END       //!< ファイルの末尾を基準としてファイルのカレント位置を設定することを示す定数です。
};

struct Transaction
{
    bit32   dummy;
};

/*!
    @brief ディレクトリエントリの属性情報を示す構造体です。

    isDirectory メンバ以外は、sdmc アーカイブでのみ有効です。それ以外のアーカイブでは不定値になりますので、ご注意ください。
*/
struct Attributes
{
    bool isDirectory;   //!< true のときはディレクトリであることを、false のときはファイルであること示します。
    bool isHidden;      //!< true のときは、隠し属性であることを示します。
    bool isArchive;     //!< true のときは、アーカイブであることを示します。
    bool isReadOnly;    //!< true のときは、読み取り専用であることを示します。
};

struct ShortName
{
    char body[10];      //!< 8.3 形式の拡張子以外の部分を示す文字列が格納されます。
    char ext[4];        //!< 8.3 形式の拡張子部分を表す文字列が格納されます。
    bool valid;         //!< true のときは、このショートファイルネームが有効であることを示します。
    bit8 pad;
};

/*!
    @brief ディレクトリエントリを示す構造体です。

    entrySize メンバは、sdmc アーカイブでのみ有効です。それ以外のアーカイブでは不定値になりますので、ご注意ください。
*/
struct DirectoryEntry
{
    wchar_t            entryName[MAX_FILE_PATH_LENGTH + 1]; //!< エントリのロングファイルネームを示します。
    ShortName          shortName;   //!< エントリのショートファイルネームを示します。
    nn::fs::Attributes attributes;  //!< エントリの属性を示します。
    s64                entrySize;   //!< エントリがファイルであればファイルサイズを示します。ディレクトリのときは 0 が入ります。
};

struct PathMark
{
    bit32 rawPathMark;
};

enum MediaType
{
    MEDIA_TYPE_NAND     = 0,
    MEDIA_TYPE_SDMC     = 1,
    MEDIA_TYPE_CTRCARD  = 2
};

namespace detail { struct ArchiveHandleTag {}; }
typedef nn::util::Int64<bit64, detail::ArchiveHandleTag> ArchiveHandle;

typedef bit64 ExtSaveDataId;
typedef bit64 TitleId;

} // end of namespace tcb
} // end of namespace nn

namespace nn { namespace CTR {

typedef struct DUMMY1
{
    bit8 data[948];
} Dummy1;

typedef struct DUMMY2
{
    bit8 data[9152];
} Dummy2;

}}

#endif  // ifndef NN_FS_FS_ENUMS_H_