#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2021 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_WINDOWS_WINDOWSFILEAPI_H
#define NUCLEX_STORAGE_FILESYSTEM_WINDOWS_WINDOWSFILEAPI_H

#include "Nuclex/Storage/Config.h"

#if defined(NUCLEX_STORAGE_WIN32)

#include "../../Helpers/WindowsApi.h"

#include <cstdint> // std::uint8_t, std::size_t

namespace Nuclex { namespace Storage { namespace FileSystem { namespace Windows {

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

  /// <summary>Wraps the Windows 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 Windows, such as
  ///     checking result codes and transforming paths from UTF-8 to UTF-16 stored in
  ///     wchar_ts of non-standard 2 byte size.
  ///   </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, only some methods will be wrapped here.
  ///   </para>
  /// </remarks>
  class WindowsFileApi {

    /// <summary>Creates the specified directory</summary>
    /// <param name="path">Path to the directory 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>
    /// <returns>True if the file was deleted, false if it didn't exist</returns>
    public: static bool DeleteFile(const std::string &path);

    /// <summary>Moves or renames a file</summary>
    /// <param name="path">Current path of the file that will be moved</param>
    /// <param name="newPath">New path the file will become accessible under</param>
    public: static void MoveFile(const std::string &path, const std::string &newPath);

    /// <summary>Determines the location of the system's temp directory</summary>
    /// <returns>The path to the system's temp directory</returns>
    public: static std::string GetTempPath();

    /// <summary>Obtains the full path of the specified module</summary>
    /// <param name="moduleHandle">
    ///   Handle of the module whose path will be determined, nullptr for executable
    /// </param>
    /// <returns>The full path to the specified module</returns>
    public: static std::string GetModuleFileName(HMODULE moduleHandle = nullptr);

    /// <summary>Returns the current working directory of the process</summary>
    /// <returns>The process' current working directory</returns>
    public: static std::string GetCurrentWorkingDirectory();

    /// <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>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>Resolves the normalized, absolute path to the specified path</summary>
    /// <param name="path">Path that will be followed and normalized</param>
    /// <returns>The absolute path of the specified path's ultimate target</returns>
    public: static std::string GetFullPathName(const std::string &path);

    /// <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="directory">Absolute path of the directory that will be deleted</param>
    /// <remarks>
    ///   The provided directory must not be terminated with a path separator.
    /// </remarks>
    private: static void deleteDirectoryRecursively(const std::wstring &directory);

  };

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

  /// <summary>Closes a search handle upon destruction</summary>
  class SearchScope {

    /// <summary>Initializes the search handle closer</summary>
    /// <param name="searchHandle">Search handle that will be closed</param>
    public: SearchScope(::HANDLE searchHandle) :
      searchHandle(searchHandle) {}

    /// <summary>Closes the search handle</summary>
    public: ~SearchScope() {
      const bool throwOnError = false;
      WindowsFileApi::CloseSearch(this->searchHandle, throwOnError);
    }

    /// <summary>Search handle that will be closed upon destruction</summary>
    private: ::HANDLE searchHandle;

  };

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

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

#endif // defined(NUCLEX_STORAGE_WIN32)

#endif // NUCLEX_STORAGE_FILESYSTEM_WINDOWS_WINDOWSFILEAPI_H