/**
	 * @file LocalFileSystem.h
	 * @brief Declaration of tc::io::LocalFileSystem
	 * @author Jack (jakcron)
	 * @version 0.6
	 * @date 2022/01/23
	 **/
#pragma once
#include <tc/io/IFileSystem.h>

#include <tc/io/IOException.h>
#include <tc/io/DirectoryNotEmptyException.h>
#include <tc/io/DirectoryNotFoundException.h>
#include <tc/io/FileNotFoundException.h>
#include <tc/io/PathTooLongException.h>
#include <tc/UnauthorisedAccessException.h>

#ifdef _WIN32
	#include <windows.h>
#endif

namespace tc { namespace io {

	/**
	 * @class LocalFileSystem
	 * @brief An IFileSystem wrapper around the existing OS FileSystem API.
	 **/
class LocalFileSystem : public tc::io::IFileSystem
{
public:
		/// Default Constructor
	LocalFileSystem();

	tc::ResourceStatus state();
	void dispose();

		/** 
		 * @brief Create a new file
		 * 
		 * @param[in] path A relative or absolute path to file.
		 * 
		 * @throw tc::ArgumentException @p path contains invalid characters or is empty.
		 * @throw tc::NotSupportedException @p path refers to an unsupported non-file device.
		 * @throw tc::io::IOException An unspecfied I/O error occurred. Or the stream has been closed.
		 * @throw tc::SecurityException The caller does not have the required permission.
		 * @throw tc::io::DirectoryNotFoundException The specified path is invalid, such as being on an unmapped drive.
		 * @throw tc::UnauthorisedAccessException The @p access requested is not permitted by the operating system for the specified @p path.
		 * @throw tc::io::PathTooLongException The specified @p path, file name, or both exceed the system-defined maximum length.
		 **/
	void createFile(const tc::io::Path& path);

		/** 
		 * @brief Remove a file
		 * @param[in] path A relative or absolute path for the file that the current @ref IFileSystem object will remove.
		 * 
		 * @throw tc::UnauthorisedAccessException @p path specified a read-only file.
		 * @throw tc::UnauthorisedAccessException @p path is a directory.
		 * @throw tc::UnauthorisedAccessException The caller does not have the required permission.
		 * @throw tc::UnauthorisedAccessException The file is currently in use.
		 * @throw tc::io::IOException File An I/O error has occured.
		 * @throw tc::io::PathTooLongException The specified path, file name, or both exceed the system-defined maximum length.
		 * @throw tc::io::DirectoryNotFoundException A component of the path prefix is not a directory.
		 * @throw tc::io::FileNotFoundException The specifed file does not exist.
		 **/
	void removeFile(const tc::io::Path& path);

		/** 
		 * @brief Open a file
		 * @param[in] path A relative or absolute path for the file that the current @ref IFileSystem object will open an @ref IStream for.
		 * @param[in] mode One of the enumeration values that determines how to open or create the file.
		 * @param[in] access One of the enumeration values that determines how the file can be accessed by the @ref IStream object. This also determines the values returned by the @ref IStream::canRead and @ref IStream::canWrite methods of the IStream object. @ref IStream::canSeek is true if path specifies a disk file.
		 * @param[out] stream Pointer to IStream object to be instantiated
		 **/
	void openFile(const tc::io::Path& path, tc::io::FileMode mode, tc::io::FileAccess access, std::shared_ptr<tc::io::IStream>& stream);
	
		/** 
		 * @brief Create a new directory
		 * @param[in] path Path to directory
		 * 
		 * @throw tc::UnauthorisedAccessException Write permission is denied for a parent direcory.
		 * @throw tc::UnauthorisedAccessException Parent directory resides in a read-only file system.
		 * @throw tc::UnauthorisedAccessException The caller does not have the required permission.

		 * @throw tc::io::IOException An I/O error has occured.
		 * @throw tc::io::PathTooLongException The specified path, directory name, or both exceed the system-defined maximum length.
		 * @throw tc::io::DirectoryNotFoundException A component of the path prefix is not a directory or does not exist.
		 **/
	void createDirectory(const tc::io::Path& path);

		/** 
		 * @brief Remove a directory
		 * @param[in] path Path to directory
		 * 
		 * @throw tc::UnauthorisedAccessException Directory resides in a read-only file system.
		 * @throw tc::UnauthorisedAccessException The caller does not have the required permission.
		 * @throw tc::UnauthorisedAccessException The directory is a mount point.
		 * @throw tc::io::IOException An I/O error has occured.
		 * @throw tc::io::PathTooLongException The specified path, directory name, or both exceed the system-defined maximum length.
		 * @throw tc::io::DirectoryNotEmptyException The named directory is not empty.
		 * @throw tc::io::DirectoryNotFoundException A component of the path prefix is not a directory.
		 * @throw tc::io::DirectoryNotFoundException The named directory does not exist.
		 **/
	void removeDirectory(const tc::io::Path& path);

		/** 
		 * @brief Get the full path of the working directory
		 * @param[out] path Path object to populate
		 * 
		 * @throw tc::UnauthorisedAccessException Read or search permission was denied for a component of the pathname.
		 * @throw tc::io::IOException An I/O error has occured.
		 **/
	void getWorkingDirectory(tc::io::Path& path);

		/** 
		 * @brief Change the working directory
		 * @param[in] path Path to directory
		 * 
		 * @throw tc::UnauthorisedAccessException Search permission was denied for a component of the pathname.
		 * @throw tc::io::IOException An I/O error has occured.
		 * @throw tc::io::PathTooLongException The specified path, directory name, or both exceed the system-defined maximum length.
		 * @throw tc::io::DirectoryNotFoundException A component of the path prefix is not a directory.
		 * @throw tc::io::DirectoryNotFoundException The named directory does not exist.
		 **/
	void setWorkingDirectory(const tc::io::Path& path);

		/** 
		 * @brief Get directory listing a directory
		 * @param[in] path Path to directory
		 * @param[out] info sDirectoryListing object to populate
		 * 
		 * @throw tc::UnauthorisedAccessException Permission denied.
		 * @throw tc::io::IOException An I/O error has occured.
		 * @throw tc::io::DirectoryNotFoundException A component of the path prefix is not a directory.
		 * @throw tc::io::DirectoryNotFoundException The named directory does not exist.
		 **/
	void getDirectoryListing(const tc::io::Path& path, tc::io::sDirectoryListing& info);
private:
	static const std::string kClassName;

	tc::ResourceStatus mState;
};

}} // namespace tc::io