native_file.hxx

Go to the documentation of this file.

 
#pragma once
#include <ice/os.hxx>
#include <ice/path_utils.hxx>
#include <ice/native_aio.hxx>
#include <ice/expected.hxx>
 
namespace ice::native_file
{
 
    static constexpr ErrorCode E_FileHandleInvalid{ "E.8800:FileSystem:File handle is invalid." };
    static constexpr ErrorCode E_FilePathProvidedIsInvalid{ "E.8801:FileSystem:File path provided is invalid." };
    static constexpr ErrorCode E_FileFailedToBindToAIOPort{ "E.8802:FileSystem:File handle failed to bind to provided AIO port." };
    static constexpr ErrorCode E_FileFailedToReadRequestedSize{ "E.8803:FileSystem:Failed to read requested number of bytes from file." };
 
#if ISP_WINDOWS
    using File = ice::win32::FileHandle;
    using FilePath = ice::BasicPath<ice::wchar>;
    using HeapFilePath = ice::BasicHeapPath<ice::wchar>;
#   define ISP_PATH_LITERAL(val) L##val
#elif ISP_UNIX
    using File = ice::unix_::FileHandle;
    using FilePath = ice::BasicPath<char>;
    using HeapFilePath = ice::BasicHeapPath<char>;
#   define ISP_PATH_LITERAL(val) val
#endif
 
    enum class PathFlags : ice::u8
    {
        None = 0x00,
        Normalized = 0x01,
    };
 
    enum class FileOpenFlags : ice::u8
    {
        None = 0b0000'0000,

        Read = 0b0000'0000,

        Write = 0b0000'0001,

        Exclusive = 0b0001'0000,

        Asynchronous = 0b0010'0000,
    };
 
    enum class FileRequestStatus : ice::u8
    {
        Error,
        Pending,
        Completed,
    };
 
    bool exists_file(
        ice::native_file::FilePath path
    ) noexcept;
 
    auto open_file(
        ice::native_file::FilePath path,
        ice::native_file::FileOpenFlags flags = FileOpenFlags::Read
    ) noexcept -> ice::native_file::File;
 
    auto open_file(
        ice::native_aio::AIOPort port,
        ice::native_file::FilePath path,
        ice::native_file::FileOpenFlags flags = FileOpenFlags::Read
    ) noexcept -> ice::Expected<ice::native_file::File>;
 
    auto sizeof_file(ice::native_file::File const& native_file) noexcept -> ice::usize;
    auto sizeof_file(ice::native_file::FilePath path) noexcept -> ice::usize;
 
    auto read_file(
        ice::native_file::File const& native_file,
        ice::usize requested_read_size,
        ice::Memory memory
    ) noexcept -> ice::usize;
 
    auto read_file(
        ice::native_file::File const& native_file,
        ice::usize requested_read_offset,
        ice::usize requested_read_size,
        ice::Memory memory
    ) noexcept -> ice::usize;
 
    auto read_file_request(
        ice::native_aio::AIORequest& request,
        ice::native_file::File const& native_file,
        ice::usize requested_read_offset,
        ice::usize requested_read_size,
        ice::Memory memory
    ) noexcept -> ice::native_file::FileRequestStatus;
 
    auto write_file(
        ice::native_file::File const& native_file,
        ice::usize write_offset,
        ice::Data data
    ) noexcept -> ice::usize;
 
    auto write_file_request(
        ice::native_aio::AIORequest& request,
        ice::native_file::File const& native_file,
        ice::usize write_offset,
        ice::Data data
    ) noexcept -> ice::native_file::FileRequestStatus;
 
    auto append_file(
        ice::native_file::File const& native_file,
        ice::Data data
    ) noexcept -> ice::usize;
 
    enum class TraverseAction : ice::u8 { Continue, Break, SkipSubDir };
    enum class EntityType : ice::u8 { File, Directory };
 
    using TraversePathCallback = auto(*)(
        ice::native_file::FilePath,
        ice::native_file::FilePath,
        ice::native_file::EntityType,
        void* userdata
    ) noexcept -> ice::native_file::TraverseAction;
 
    bool traverse_directories(
        ice::native_file::FilePath starting_dir,
        ice::native_file::TraversePathCallback callback,
        void* userdata
    ) noexcept;
 
    bool create_directory(
        ice::native_file::FilePath path
    ) noexcept;
 
    bool is_directory(
        ice::native_file::FilePath path
    ) noexcept;
 
    void path_from_string(
        ice::native_file::HeapFilePath& out_filepath,
        ice::String path_string
    ) noexcept;
 
    void path_to_string(
        ice::native_file::FilePath path,
        ice::HeapString<>& out_string
    ) noexcept;
 
    void path_join_string(
        ice::native_file::HeapFilePath& path,
        ice::String string
    ) noexcept;
 
    template<PathFlags Flags = PathFlags::None, typename... Strings>
        requires (std::convertible_to<Strings, ice::String> && ...)
    inline auto path_from_strings(
        ice::Allocator& alloc,
        Strings&&... strings
    ) noexcept -> ice::native_file::HeapFilePath
    {
        ice::native_file::HeapFilePath result{ alloc };
        (ice::native_file::path_join_string(result, ice::forward<Strings>(strings)), ...);
        if constexpr (ice::has_all(Flags, PathFlags::Normalized))
        {
            result.normalize();
        }
        return result;
    }
 
} // namespace ice::native_file