mirror of
https://github.com/DarkStore-3DS/Project_CTR.git
synced 2026-07-03 08:49:03 +00:00
jakcron
124 lines
3.7 KiB
C++
124 lines
3.7 KiB
C++
/**
|
|
* @file IFileSystem.h
|
|
* @brief Declaration of tc::io::IFileSystem
|
|
* @author Jack (jakcron)
|
|
* @version 0.6
|
|
* @date 2019/06/18
|
|
**/
|
|
#pragma once
|
|
#include <tc/types.h>
|
|
#include <tc/ResourceStatus.h>
|
|
#include <tc/io/IStream.h>
|
|
#include <tc/io/Path.h>
|
|
#include <tc/io/FileMode.h>
|
|
#include <tc/io/FileAccess.h>
|
|
|
|
namespace tc { namespace io {
|
|
|
|
/**
|
|
* @struct sDirectoryListing
|
|
* @brief Contains basic info about a directory with-in a FileSystem
|
|
*
|
|
* The includes the absolute path of the directory, and lists of child directory and file names.
|
|
*
|
|
* @note All strings are UTF-8
|
|
**/
|
|
struct sDirectoryListing
|
|
{
|
|
/// Absolute Path
|
|
tc::io::Path abs_path;
|
|
/// List of child directory names
|
|
std::vector<std::string> dir_list;
|
|
/// List of child file names
|
|
std::vector<std::string> file_list;
|
|
};
|
|
|
|
/**
|
|
* @class IFileSystem
|
|
*
|
|
* @brief An interface for implementing a basic FileSystem handler.
|
|
*
|
|
* Defines expected functionality including:
|
|
* - File access (open)
|
|
* - File management (create, remove)
|
|
* - Directory traversal (get current directory, change current directory)
|
|
* - Directory management (create, remove)
|
|
* - Directory listing
|
|
*
|
|
* @note IFileSystem uses the tc::io::Path class to represent a path, not as a literal string.
|
|
* @note It is up to the implementation of IFileSystem to validate and process tc::io::Path objects.
|
|
* @note It is up to the implementation to enforce tc::io::FileMode & tc::io::FileAccess.
|
|
**/
|
|
class IFileSystem
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Destructor
|
|
**/
|
|
virtual ~IFileSystem() = default;
|
|
|
|
/**
|
|
* @brief Get state of IFileSystem
|
|
* @return ResourceStatus
|
|
**/
|
|
virtual tc::ResourceStatus state() = 0;
|
|
|
|
/**
|
|
* @brief Close the filesystem
|
|
**/
|
|
virtual void dispose() = 0;
|
|
|
|
/**
|
|
* @brief Create a new file
|
|
* @param[in] path A relative or absolute path to file.
|
|
**/
|
|
virtual void createFile(const tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Remove a file
|
|
* @param[in] path A relative or absolute path to file.
|
|
**/
|
|
virtual void removeFile(const tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Open a file
|
|
* @param[in] path A relative or absolute path to file.
|
|
* @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
|
|
**/
|
|
virtual void openFile(const tc::io::Path& path, tc::io::FileMode mode, tc::io::FileAccess access, std::shared_ptr<tc::io::IStream>& stream) = 0;
|
|
|
|
/**
|
|
* @brief Create a new directory
|
|
* @param[in] path A relative or absolute path to directory.
|
|
**/
|
|
virtual void createDirectory(const tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Remove a directory
|
|
* @param[in] path A relative or absolute path to directory.
|
|
**/
|
|
virtual void removeDirectory(const tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Get the full path of the working directory
|
|
* @param[out] path Path object to populate
|
|
**/
|
|
virtual void getWorkingDirectory(tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Change the working directory
|
|
* @param[in] path A relative or absolute path to directory.
|
|
**/
|
|
virtual void setWorkingDirectory(const tc::io::Path& path) = 0;
|
|
|
|
/**
|
|
* @brief Get directory listing a directory
|
|
* @param[in] path A relative or absolute path to directory.
|
|
* @param[out] info sDirectoryListing object to populate
|
|
**/
|
|
virtual void getDirectoryListing(const tc::io::Path& path, tc::io::sDirectoryListing& info) = 0;
|
|
};
|
|
|
|
}} // namespace tc::io
|