Skip to content

Commit

Permalink
core: refactors file and memory API
Browse files Browse the repository at this point in the history
  • Loading branch information
@quesnel
quesnel committed Aug 8, 2024
1 parent b376ad8 commit 77534b1
Show file tree
Hide file tree
Showing 6 changed files with 416 additions and 287 deletions.
253 changes: 169 additions & 84 deletions lib/include/irritator/file.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,54 @@
#define ORG_VLEPROJECT_IRRITATOR_FILE_HPP

#include <irritator/core.hpp>
#include <irritator/ext.hpp>

namespace irt {

enum class seek_origin { current, end, set };

enum class open_mode { read, write, append };

class file
class file
{
public:
enum class error_code {
open_error, // Fail to open file (@c e_file_name @c e_errno).
read_error, // Error during read file (@c e_file_name @c e_errno).
write_error, // Error during write file (@c e_file_name @c e_errno).
eof_error, // End of file reach errro (@c e_file_name @c e_errno).
memory_error = 1,
eof_error,
arg_error,
open_error,
};

/**
* @brief Try to open a file.
*
* @example
* attempt_all([]()
* {
* auto file = file::open(file_path->sv(), file::mode::read);
* if (not file)
* return file.error();
* auto file = file::open(filename, file::mode::read,
* [&](file::error_code ec) noexcept{
* if (ec == error_code::open_error) {
* // gui
* app.notifications.try_insert("fail to open file");
*
* // cli
* fprintf(stderr, "Fail to open %s", filename);
* });
*
* if (file) {
* int x, y, z;
* return file.read(x) && file.read(y) && file.read(z);
* }
* @endexample
*
* ...
* return success();
* },
* [](file::error_code ec, const e_file_name *f, const e_errno *e) {
* std::cerr << ordinal(ec);
* if (f)
* std::cerr << f->value;
* if (e)
* std::cerr << e->value;
* });
* @param filename File name in utf-8.
* @return @c file if success @c error_code otherwise.
*/
static result<file> open(const char* filename,
const open_mode mode) noexcept;
template<std::invocable<error_code> Fn>
static std::optional<file> open(const char* filename,
const open_mode mode,
Fn&& fn) noexcept;

static std::optional<file> open(const char* filename,
const open_mode mode) noexcept;

static bool exists(const char* filename) noexcept;

Expand All @@ -68,47 +75,47 @@ class file
i64 seek(i64 offset, seek_origin origin) noexcept;
void rewind() noexcept;

status read(bool& value) noexcept;
status read(u8& value) noexcept;
status read(u16& value) noexcept;
status read(u32& value) noexcept;
status read(u64& value) noexcept;
status read(i8& value) noexcept;
status read(i16& value) noexcept;
status read(i32& value) noexcept;
status read(i64& value) noexcept;
bool read(bool& value) noexcept;
bool read(u8& value) noexcept;
bool read(u16& value) noexcept;
bool read(u32& value) noexcept;
bool read(u64& value) noexcept;
bool read(i8& value) noexcept;
bool read(i16& value) noexcept;
bool read(i32& value) noexcept;
bool read(i64& value) noexcept;

status read(float& value) noexcept;
status read(double& value) noexcept;
bool read(float& value) noexcept;
bool read(double& value) noexcept;

template<typename EnumType>
requires(std::is_enum_v<EnumType>)
status read(EnumType& value) noexcept
bool read(EnumType& value) noexcept
{
auto integer = ordinal(value);

irt_check(read(integer));
value = enum_cast<EnumType>(integer);

return success();
return true;
}

status write(const bool value) noexcept;
status write(const u8 value) noexcept;
status write(const u16 value) noexcept;
status write(const u32 value) noexcept;
status write(const u64 value) noexcept;
status write(const i8 value) noexcept;
status write(const i16 value) noexcept;
status write(const i32 value) noexcept;
status write(const i64 value) noexcept;
bool write(const bool value) noexcept;
bool write(const u8 value) noexcept;
bool write(const u16 value) noexcept;
bool write(const u32 value) noexcept;
bool write(const u64 value) noexcept;
bool write(const i8 value) noexcept;
bool write(const i16 value) noexcept;
bool write(const i32 value) noexcept;
bool write(const i64 value) noexcept;

status write(const float value) noexcept;
status write(const double value) noexcept;
bool write(const float value) noexcept;
bool write(const double value) noexcept;

template<typename EnumType>
requires(std::is_enum_v<EnumType>)
status write(const EnumType value) noexcept
bool write(const EnumType value) noexcept
{
return write(ordinal(value));
}
Expand All @@ -118,39 +125,42 @@ class file
//! @param length The length of the buffer to read (must be greater than
//! 0).
//! @return false if failure, true otherwise.
status read(void* buffer, i64 length) noexcept;
bool read(void* buffer, i64 length) noexcept;

//! Low level write function.
//! @param buffer A pointer to buffer (must be not null) with at least @c
//! length bytes available.
//! @param length The length of the buffer to read (must be greater than
//! 0).
//! @return false if failure, true otherwise.
status write(const void* buffer, i64 length) noexcept;
bool write(const void* buffer, i64 length) noexcept;

void* get_handle() const noexcept;
open_mode get_mode() const noexcept;

private:
file(void* handle, const open_mode mode) noexcept;
static void* fopen(const char* filename, const char* mode) noexcept;

void* file_handle = nullptr;
open_mode mode = open_mode::read;
};

class memory
class memory
{
public:
enum class error_code {
open_error, // Fail to open file (@c e_file_name @c e_errno).
read_error, // Error during read file (@c e_file_name @c e_errno).
write_error, // Error during write file (@c e_file_name @c e_errno).
eof_error, // End of file reach errro (@c e_file_name @c e_errno).
};
enum class error_code { memory_error = 1, eof_error, arg_error };

memory(const i64 length, const open_mode mode) noexcept;
~memory() noexcept = default;

template<std::invocable<error_code> Fn>
static std::optional<memory> make(const i64 length,
const open_mode mode,
Fn&& fn) noexcept;

static std::optional<memory> make(const i64 length,
const open_mode mode) noexcept;

memory(const memory& other) noexcept = delete;
memory& operator=(const memory& other) noexcept = delete;
memory(memory&& other) noexcept;
Expand All @@ -165,45 +175,45 @@ class memory
i64 seek(i64 offset, seek_origin origin) noexcept;
void rewind() noexcept;

status read(bool& value) noexcept;
status read(u8& value) noexcept;
status read(u16& value) noexcept;
status read(u32& value) noexcept;
status read(u64& value) noexcept;
status read(i8& value) noexcept;
status read(i16& value) noexcept;
status read(i32& value) noexcept;
status read(i64& value) noexcept;
bool read(bool& value) noexcept;
bool read(u8& value) noexcept;
bool read(u16& value) noexcept;
bool read(u32& value) noexcept;
bool read(u64& value) noexcept;
bool read(i8& value) noexcept;
bool read(i16& value) noexcept;
bool read(i32& value) noexcept;
bool read(i64& value) noexcept;

status read(float& value) noexcept;
status read(double& value) noexcept;
bool read(float& value) noexcept;
bool read(double& value) noexcept;

template<typename EnumType>
requires(std::is_enum_v<EnumType>)
status read(EnumType& value) noexcept
bool read(EnumType& value) noexcept
{
auto integer = ordinal(value);
irt_check(read(integer));
value = enum_cast<EnumType>(integer);
return success();
return true;
}

status write(const bool value) noexcept;
status write(const u8 value) noexcept;
status write(const u16 value) noexcept;
status write(const u32 value) noexcept;
status write(const u64 value) noexcept;
status write(const i8 value) noexcept;
status write(const i16 value) noexcept;
status write(const i32 value) noexcept;
status write(const i64 value) noexcept;
bool write(const bool value) noexcept;
bool write(const u8 value) noexcept;
bool write(const u16 value) noexcept;
bool write(const u32 value) noexcept;
bool write(const u64 value) noexcept;
bool write(const i8 value) noexcept;
bool write(const i16 value) noexcept;
bool write(const i32 value) noexcept;
bool write(const i64 value) noexcept;

status write(const float value) noexcept;
status write(const double value) noexcept;
bool write(const float value) noexcept;
bool write(const double value) noexcept;

template<typename EnumType>
requires(std::is_enum_v<EnumType>)
status write(const EnumType value) noexcept
bool write(const EnumType value) noexcept
{
return write(ordinal(value));
}
Expand All @@ -213,23 +223,98 @@ class memory
//! @param length The length of the buffer to read (must be greater than
//! 0).
//! @return false if failure, true otherwise.
status read(void* buffer, i64 length) noexcept;
bool read(void* buffer, i64 length) noexcept;

//! Low level write function.
//! @param buffer A pointer to buffer (must be not null) with at least @c
//! length bytes available.
//! @param length The length of the buffer to read (must be greater than
//! 0).
//! @return false if failure, true otherwise.
status write(const void* buffer, i64 length) noexcept;
bool write(const void* buffer, i64 length) noexcept;

vector<u8> data;
i64 pos = 0;

private:
memory(const i64 length, const open_mode mode) noexcept;
};

inline void* file::get_handle() const noexcept { return file_handle; }
inline open_mode file::get_mode() const noexcept { return mode; }

template<std::invocable<file::error_code> Fn>
inline std::optional<file> file::open(const char* filename,
const open_mode mode,
Fn&& fn) noexcept
{
if (not filename) {
fn(file::error_code::arg_error);
return std::nullopt;
}

auto* ptr = fopen(filename,
mode == open_mode::read ? "rb"
: mode == open_mode::write ? "wb"
: "ab");

if (not ptr) {
fn(file::error_code::open_error);
return std::nullopt;
}

return file(ptr, mode);
}

inline std::optional<file> file::open(const char* filename,
const open_mode mode) noexcept
{
if (not filename)
return std::nullopt;

auto* ptr = fopen(filename,
mode == open_mode::read ? "rb"
: mode == open_mode::write ? "wb"
: "ab");

if (not ptr)
return std::nullopt;

return file(ptr, mode);
}

template<std::invocable<memory::error_code> Fn>
inline std::optional<memory> memory::make(const i64 length,
const open_mode mode,
Fn&& fn) noexcept
{
if (not(1 <= length and length <= INT32_MAX)) {
fn(memory::error_code::arg_error);
return std::nullopt;
}

memory mem(length, mode);
if (not std::cmp_equal(mem.data.size(), length)) {
fn(memory::error_code::memory_error);
return std::nullopt;
}

return mem;
}

inline std::optional<memory> memory::make(const i64 length,
const open_mode mode) noexcept
{
if (not(1 <= length and length <= INT32_MAX))
return std::nullopt;

memory mem(length, mode);
if (not std::cmp_equal(mem.data.size(), length))
return std::nullopt;

return mem;
}

} // irt

#endif
Loading

0 comments on commit 77534b1

Please sign in to comment.