#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_STORAGE_FILESYSTEM_WINRTFILEAPI_H
#define NUCLEX_STORAGE_FILESYSTEM_WINRTFILEAPI_H

#include "Nuclex/Storage/Config.h"

#if defined(NUCLEX_STORAGE_WINRT)

#include "../../Helpers/WindowsWithoutDefines.h"

#include <string>
#include <cstdint>

namespace Nuclex { namespace Storage { namespace FileSystem {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Wraps the WinRT file system API</summary>
  /// <remarks>
  ///   <para>
  ///     This is just a small helper class that reduces the amount of boilerplate code
  ///     required when calling the file system API functions from WinRT, such as
  ///     checking result codes and transforming paths from UTF-8 to UCS-2/UTF-16.
  ///   </para>
  ///   <para>
  ///     It is not intended to hide operating system details or make this API platform
  ///     neutral (the File and Container classes do that), so depending on the amount
  ///     of noise required by the file system APIs of other operating systems there might
  ///     exist similar classes.
  ///   </para>
  /// </remarks>
  class WinRTFileApi {

    /// <summary>Creates the specified directory chain</summary>
    /// <param name="path">Path that will be created</param>
    public: static void CreateDirectory(const std::string &path);

    /// <summary>Creates all directories down to the specified path</summary>
    /// <param name="directory">Directory that will be created recursively</param>
    public: static void CreateDirectoryRecursively(const std::string &directory);

    /// <summary>Deletes a directory and everything in it</summary>
    /// <param name="path">Path of the directory that will be deleted</param>
    public: static void DeleteDirectory(const std::string &path);

    /// <summary>Deletes a file</summary>
    /// <param name="path">Path of the file that will be deleted</param>
    public: static void DeleteFile(const std::string &path);

    /// <summary>Retrieves the attributes of the file in the specified path</summary>
    /// <param name="path">Path of the file whose attributes will be retrieved</param>
    /// <returns>The attributes of the specified
    public: static DWORD GetFileAttributes(const std::string &path);

    /// <summary>
    ///   Retrieves the extended attributes of the file in the specified path
    /// </summary>
    /// <param name="path">Path of the file whose attributes will be retrieved</param>
    /// <param name="fileAttributeData">Receives the attributes of the file</param>
    /// <returns>
    ///   True if the attributes were retrieved, false if the file doesn't exist
    /// </returns>
    public: static bool GetFileAttributesEx(
      const std::string &path, WIN32_FILE_ATTRIBUTE_DATA &fileAttributeData
    );

    /// <summary>Opens the specified file for shared reading</summary>
    /// <param name="path">Path of the file that will be opened</param>
    /// <returns>The handle of the opened file</returns>
    public: static HANDLE OpenFileForReading(const std::string &path);

    /// <summary>Creates or opens the specified file for exclusive writing</summary>
    /// <param name="path">Path of the file that will be opened</param>
    /// <returns>The handle of the opened file</returns>
    public: static HANDLE OpenFileForWriting(const std::string &path);

    /// <summary>Moves the file cursor for the specified file</summary>
    /// <param name="fileHandle">File whose file cursor will be moved</param>
    /// <param name="location">Location the file cursor will be moved to</param>
    public: static std::uint64_t SetFilePointer(HANDLE fileHandle, std::uint64_t location);

    /// <summary>Determines the length of the specified file</summary>
    /// <param name="fileHandle">Handle of the file whose length will be determined</param>
    /// <returns>The length of the specified file in bytes</returns>
    public: static std::uint64_t GetFileSize(HANDLE fileHandle);

    /// <summary>Reads data from the specified file</summary>
    /// <param name="fileHandle">Handle of the file from which data will be read</param>
    /// <param name="buffer">Buffer into which the data will be put</param>
    /// <param name="count">Number of bytes that will be read from the file</param>
    /// <returns>The number of bytes that were actually read</returns>
    public: static std::size_t Read(HANDLE fileHandle, void *buffer, std::size_t count);

    /// <summary>Writes data into the specified file</summary>
    /// <param name="fileHandle">Handle of the file into which data will be written</param>
    /// <param name="buffer">Buffer containing the data that will be written</param>
    /// <param name="count">Number of bytes that will be written into the file</param>
    /// <returns>The number of bytes that were actually written</returns>
    public: static std::size_t Write(HANDLE fileHandle, const void *buffer, std::size_t count);

    /// <summary>Ensures changes to the specified file have been written to disk</summary>
    /// <param name="fileHandle">Handle of the file that will be flushed</param>
    public: static void FlushFileBuffers(HANDLE fileHandle);

    /// <summary>Closes the specified file</summary>
    /// <param name="fileHandle">Handle of the file that will be closed</param>
    /// <param name="throwOnError">
    ///   Whether to throw an exception if the file cannot be closed
    /// </param>
    public: static void CloseFile(HANDLE fileHandle, bool throwOnError = true);

    /// <summary>Finds the first file matching the specified search mask</summary>
    /// <param name="searchMask">Search mask controlling which files will be found</param>
    /// <param name="findData">Receives the first found file or directory</param>
    /// <returns>The handle of the file search or INVALID_HANDLE_VALUE if none found</returns>
    public: static HANDLE FindFirstFile(
      const std::string &searchMask, WIN32_FIND_DATAW &findData
    );

    /// <summary>Advances to the next file in a file search</summary>
    /// <param name="searchHandle">Search handle returned by FindFirstFile()</param>
    /// <param name="findData">Receives the next found file or directory</param>
    /// <returns>True if there was a next file, otherwise false</returns>
    public: static bool FindNextFile(HANDLE searchHandle, WIN32_FIND_DATAW &findData);
      
    /// <summary>Closes the specified search handle</summary>
    /// <param name="searchHandle">Handle of the search that will be closed</param>
    /// <param name="throwOnError">
    ///   Whether to throw an exception if the search handle cannot be closed
    /// </param>
    public: static void CloseSearch(HANDLE searchHandle, bool throwOnError = true);

    /// <summary>Creates all directories down to the specified path</summary>
    /// <param name="directory">Directory that will be created recursively</param>
    /// <remarks>
    ///   The provided directory must not be terminated with a path separator.
    /// </remarks>
    private: static void createDirectoryRecursively(const std::wstring &directory);

    /// <summary>Recursively deletes the specified directory and all its contents</summary>
    /// <param name="path">Absolute path of the directory that will be deleted</param>
    /// <remarks>
    ///   The path must not be terminated with a path separator.
    /// </remarks>
    private: static void recursiveDeleteDirectory(const std::wstring &path);

    /// <summary>Retrieves the attributes of the specified file</summary>
    /// <param name="path">Path of the file whose attribute will be retrieved</param>
    /// <returns>The file's attributes or INVALID_FILE_ATTRIBUTES if not found</returns>
    private: static bool getFileAttributesEx(
      const std::wstring &path, WIN32_FILE_ATTRIBUTE_DATA &fileAttributeData
    );

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Storage::FileSystem

#endif // defined(NUCLEX_STORAGE_WINRT)
#endif // NUCLEX_STORAGE_FILESYSTEM_WINRTFILEAPI_H