/*---------------------------------------------------------------------------*
  Project:  TwlSDK - FS - libraries
  File:     types.h

  Copyright 2007-2008 Nintendo. 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.

  $Date:: 2008-12-08#$
  $Rev: 9544 $
  $Author: yosizaki $

 *---------------------------------------------------------------------------*/


#ifndef NITRO_FS_TYPES_H_
#define NITRO_FS_TYPES_H_


#include <nitro/misc.h>
#include <nitro/types.h>
#include <nitro/os/common/thread.h>


#ifdef __cplusplus
extern "C" {
#endif


/*---------------------------------------------------------------------------*/
/* Constants */

// Return values for the FS library API
typedef enum FSResult
{
    // Result values that can be obtained with the FS_GetErrorCode function
    FS_RESULT_SUCCESS = 0,
    FS_RESULT_FAILURE,
    FS_RESULT_BUSY,
    FS_RESULT_CANCELED,
    FS_RESULT_CANCELLED = FS_RESULT_CANCELED,
    FS_RESULT_UNSUPPORTED,
    FS_RESULT_ERROR,
    FS_RESULT_INVALID_PARAMETER,
    FS_RESULT_NO_MORE_RESOURCE,
    FS_RESULT_ALREADY_DONE,
    FS_RESULT_PERMISSION_DENIED,
    FS_RESULT_MEDIA_FATAL,
    FS_RESULT_NO_ENTRY,
    FS_RESULT_MEDIA_NOTHING,
    FS_RESULT_MEDIA_UNKNOWN,
    FS_RESULT_BAD_FORMAT,
    FS_RESULT_MAX,
    // Temporary result values to use within procedures
    FS_RESULT_PROC_ASYNC = 256,
    FS_RESULT_PROC_DEFAULT,
    FS_RESULT_PROC_UNKNOWN
}
FSResult;

// backward compatibility for typo
#define FS_RESULT_NO_MORE_RESOUCE   FS_RESULT_NO_MORE_RESOURCE

// Maximum archive name length
#define FS_ARCHIVE_NAME_LEN_MAX     3

// Maximum filename length (limited to procedures for old specifications)
#define	FS_FILE_NAME_MAX	        127

// Maximum entry name length (limited to procedures for old specifications)
#define	FS_ENTRY_SHORTNAME_MAX      16
#define	FS_ENTRY_LONGNAME_MAX	    260

// The maximum length of special archive names (a TWL enhancement) and of absolute paths
#define FS_ARCHIVE_NAME_LONG_MAX    15
#define FS_ARCHIVE_FULLPATH_MAX     (FS_ARCHIVE_NAME_LONG_MAX + 1 + 1 + FS_ENTRY_LONGNAME_MAX)

// Entry attributes used with ReadDirectory
#define FS_ATTRIBUTE_IS_DIRECTORY   0x00000100UL
#define FS_ATTRIBUTE_IS_PROTECTED   0x00000200UL
#define FS_ATTRIBUTE_IS_OFFLINE     0x00000400UL
// Attributes that only have meaning for archives based on MS-DOS FAT
#define FS_ATTRIBUTE_DOS_MASK       0x000000FFUL
#define FS_ATTRIBUTE_DOS_READONLY   0x00000001UL
#define FS_ATTRIBUTE_DOS_HIDDEN     0x00000002UL
#define FS_ATTRIBUTE_DOS_SYSTEM     0x00000004UL
#define FS_ATTRIBUTE_DOS_VOLUME     0x00000008UL
#define FS_ATTRIBUTE_DOS_DIRECTORY  0x00000010UL
#define FS_ATTRIBUTE_DOS_ARCHIVE    0x00000020UL

#define FS_PROPERTY_CTRL_SET_MTIME  0x01000000UL
#define FS_PROPERTY_CTRL_MASK       0x01000000UL

// Constants to use in SeekDirectory, OpenFileFast, and so on
#define FS_INVALID_FILE_ID          0xFFFFFFFFUL
#define FS_INVALID_DIRECTORY_ID     0xFFFFFFFFUL

// Constants to use in SeekDirectory
#define FS_DIRECTORY_POSITION_HEAD  0x00000000UL

// Seek origin to use in SeekFile
typedef enum FSSeekFileMode
{
    FS_SEEK_SET,
    FS_SEEK_CUR,
    FS_SEEK_END
}
FSSeekFileMode;

// Access mode to use in OpenFile
#define FS_FILEMODE_R               0x00000001UL
#define FS_FILEMODE_W               0x00000002UL
#define FS_FILEMODE_L               0x00000004UL
#define FS_FILEMODE_RW              (FS_FILEMODE_R | FS_FILEMODE_W)
#define FS_FILEMODE_RWL             (FS_FILEMODE_R | FS_FILEMODE_W | FS_FILEMODE_L)

// Access mode to use in OpenDirectory
#define FS_DIRMODE_SHORTNAME_ONLY   0x00001000UL

// Permissions to use in CreateFile
#define FS_PERMIT_R                 0x00000001UL
#define FS_PERMIT_W                 0x00000002UL
#define FS_PERMIT_RW                (FS_PERMIT_R | FS_PERMIT_W)

// Archive capabilities
#define FS_ARCHIVE_CAPS_UNICODE     0x00000001UL

//
// The following group of constants is required only during archive implementation.
//

// File commands and archive messages
// Used in user procedures during archive implementation.
typedef u32 FSCommandType;
// Commands that are compatible with the old specifications
#define FS_COMMAND_READFILE             0UL
#define FS_COMMAND_WRITEFILE            1UL
#define FS_COMMAND_SEEKDIR              2UL
#define FS_COMMAND_READDIR              3UL
#define FS_COMMAND_FINDPATH             4UL
#define FS_COMMAND_GETPATH              5UL
#define FS_COMMAND_OPENFILEFAST         6UL
#define FS_COMMAND_OPENFILEDIRECT       7UL
#define FS_COMMAND_CLOSEFILE            8UL
#define FS_COMMAND_ACTIVATE             9UL
#define FS_COMMAND_IDLE                 10UL
#define FS_COMMAND_SUSPEND              11UL
#define FS_COMMAND_RESUME               12UL
// New commands that are compatible with the old specifications
#define FS_COMMAND_OPENFILE             13UL
#define FS_COMMAND_SEEKFILE             14UL
#define FS_COMMAND_GETFILELENGTH        15UL
#define FS_COMMAND_GETFILEPOSITION      16UL
// Extended commands in the new specifications
#define FS_COMMAND_MOUNT                17UL
#define FS_COMMAND_UNMOUNT              18UL
#define FS_COMMAND_GETARCHIVECAPS       19UL
#define FS_COMMAND_CREATEFILE           20UL
#define FS_COMMAND_DELETEFILE           21UL
#define FS_COMMAND_RENAMEFILE           22UL
#define FS_COMMAND_GETPATHINFO          23UL
#define FS_COMMAND_SETPATHINFO          24UL
#define FS_COMMAND_CREATEDIRECTORY      25UL
#define FS_COMMAND_DELETEDIRECTORY      26UL
#define FS_COMMAND_RENAMEDIRECTORY      27UL
#define FS_COMMAND_GETARCHIVERESOURCE   28UL
// 29UL
#define FS_COMMAND_FLUSHFILE            30UL
#define FS_COMMAND_SETFILELENGTH        31UL
#define FS_COMMAND_OPENDIRECTORY        32UL
#define FS_COMMAND_CLOSEDIRECTORY       33UL
#define FS_COMMAND_SETSEEKCACHE         34UL
#define FS_COMMAND_MAX                  35UL
#define FS_COMMAND_INVALID              FS_COMMAND_MAX
#define FS_COMMAND_PROC_MAX             (FSCommandType)(FS_COMMAND_RESUME + 1)

// Restrictions due to the data size maintained by the FSFile structure
SDK_COMPILER_ASSERT(FS_COMMAND_MAX < 256);

//
// The following group of constants is used only within the library.
//

// File status (used internally)
#define FS_FILE_STATUS_BUSY                 0x00000001UL
#define FS_FILE_STATUS_CANCEL               0x00000002UL
#define FS_FILE_STATUS_BLOCKING             0x00000004UL
#define FS_FILE_STATUS_ASYNC_DONE           0x00000008UL
#define FS_FILE_STATUS_IS_FILE              0x00000010UL
#define FS_FILE_STATUS_IS_DIR               0x00000020UL
#define FS_FILE_STATUS_OPERATING            0x00000040UL
#define FS_FILE_STATUS_UNICODE_MODE         0x00000080UL
#define FS_FILE_STATUS_CMD_SHIFT            8UL
#define FS_FILE_STATUS_CMD_MASK             0x000000FFUL
#define	FS_FILE_STATUS_USER_RESERVED_BIT	0x00010000UL
#define	FS_FILE_STATUS_USER_RESERVED_MASK	0xFFFF0000UL

// Internal archive status flag (for inline functions)
// Users do not use these constants directly.
#define FS_ARCHIVE_FLAG_REGISTER            0x00000001UL
#define FS_ARCHIVE_FLAG_LOADED              0x00000002UL
#define FS_ARCHIVE_FLAG_SUSPEND             0x00000008UL
#define FS_ARCHIVE_FLAG_RUNNING             0x00000010UL
#define FS_ARCHIVE_FLAG_CANCELING           0x00000020UL
#define FS_ARCHIVE_FLAG_SUSPENDING          0x00000040UL
#define FS_ARCHIVE_FLAG_UNLOADING           0x00000080UL
#define FS_ARCHIVE_FLAG_USER_RESERVED_BIT	0x00010000UL
#define FS_ARCHIVE_FLAG_USER_RESERVED_MASK	0xFFFF0000UL


/*---------------------------------------------------------------------------*/
/* Declarations */

struct FSArchive;
struct FSFile;

// Date and time information used by the FS library in general
typedef struct FSDateTime
{
    u32     year;    // 0-
    u32     month;   // 1-12
    u32     day;     // 1-31
    u32     hour;    // 0-23
    u32     minute;  // 0-59
    u32     second;  // 0-60
}
FSDateTime;

// Entry information used with ReadDirectory
typedef struct FSDirectoryEntryInfo
{
    char        shortname[FS_ENTRY_SHORTNAME_MAX];
    u32         shortname_length;
    char        longname[FS_ENTRY_LONGNAME_MAX];
    u32         longname_length;
    u32         attributes;
    FSDateTime  atime;
    FSDateTime  mtime;
    FSDateTime  ctime;
    u32         filesize;
    u32         id;
}
FSDirectoryEntryInfo;

typedef struct FSDirectoryEntryInfoW
{
    u32         attributes;
    FSDateTime  atime;
    FSDateTime  mtime;
    FSDateTime  ctime;
    u32         filesize;
    u32         id;
    u32         shortname_length;
    u32         longname_length;
    char        shortname[FS_ENTRY_SHORTNAME_MAX];
    u16         longname[FS_ENTRY_LONGNAME_MAX];
}
FSDirectoryEntryInfoW;

// Entry information used with GetPathInfo and SetPathInfo
typedef struct FSPathInfo
{
    u32         attributes;
    FSDateTime  ctime;
    FSDateTime  mtime;
    FSDateTime  atime;
    u32         filesize;
    u32         id;
}
FSPathInfo;

typedef struct FSArchiveResource
{
    u64     totalSize;
    u64     availableSize;
    u32     maxFileHandles;
    u32     currentFileHandles;
    u32     maxDirectoryHandles;
    u32     currentDirectoryHandles;
    // For FAT archives
    u32     bytesPerSector;
    u32     sectorsPerCluster;
    u32     totalClusters;
    u32     availableClusters;
}
FSArchiveResource;

SDK_COMPILER_ASSERT(sizeof(FSArchiveResource) == 48);

// For FS_TellDir(), FS_SeekDir(), FS_ReadDir()
typedef struct FSDirPos
{
// Private:
    struct FSArchive   *arc;
    u16                 own_id;
    u16                 index;
    u32                 pos;
}
FSDirPos;

// For FS_OpenFileFast()
typedef struct FSFileID
{
// private:
    struct FSArchive   *arc;
    u32                 file_id;
}
FSFileID;

// For FS_ReadDir()
typedef struct
{
    union
    {
        FSFileID file_id;               // Valid if !is_directory
        FSDirPos dir_id;                // Valid if is_directory
    };
    u32     is_directory;               // Directory ? 1 : 0
    u32     name_len;                   // strlen(name)
    char    name[FS_FILE_NAME_MAX + 1]; // String with '\0'
}
FSDirEntry;

/*---------------------------------------------------------------------------*/


#ifdef __cplusplus
} /* extern "C" */
#endif


#endif /* NITRO_FS_TYPES_H_ */