file_sys.hpp

Go to the documentation of this file.

/*
 
Copyright 2025 Matthew Tolman
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 
*/
 
#pragma once
 
#ifndef MTCORE_IO_HPP
#define MTCORE_IO_HPP
 
#include "mtcore/colls/slice.hpp"
#include "mtcore/core.hpp"
#include "mtcore/random.hpp"


namespace mtcore::io {
  using FileError = int;

  struct SyncFileSystemVTable {
    Result<FILE *, FileError> (*file_open)(void *state, const char *path, const char *mode);

    Result<void, FileError> (*file_close)(void *state, FILE *fp);

    size_t (*file_read)(void *state, void *buffer, size_t size, size_t count, FILE *stream);

    size_t (*file_write)(void *state, const void *ptr, size_t size, size_t nmemb, FILE *stream);
    Result<void, FileError> (*file_rename)(void *state, const char *oldFileName, const char *newFileName);

    Result<void, FileError> (*file_remove)(void *state, const char *path);

    Result<void, FileError> (*file_sync)(void *state, FILE *fp);

    size_t (*file_size)(void *state, FILE *file);

    bool (*file_eof)(void *state, FILE *file);

    FileError (*file_error)(void *state, FILE *file);
  };

  struct SyncFileSystem {

    const SyncFileSystemVTable *vtable = nullptr;
    void *state                        = nullptr;

    Result<void, FileError> write_file_safe(Allocator &tmpAlloc, const char *path, Slice<const u8> data,
                                            Prng &prng) const;

    Result<void, FileError> write_file_direct(const char *path, Slice<const u8> data) const;

    [[nodiscard]] Result<Slice<u8>, FileError> read_file_into(const char *path, Slice<u8> out) const;

    [[nodiscard]] Result<Slice<char>, FileError> read_file_str_into(const char *path, const Slice<char> out) const;

    [[nodiscard]] Result<void, FileError> read_file(Allocator &alloc, const char *path, Slice<u8> &out) const;

    [[nodiscard]] Result<void, FileError> read_file_str(Allocator &alloc, const char *path, Slice<char> &out) const;

    [[nodiscard]] Result<Slice<u8>, FileError> read_chunk_into(FILE *file, const Slice<u8> out) const;

    [[nodiscard]] Result<Slice<char>, FileError> read_chunk_str_into(FILE *file, const Slice<char> out) const;

    [[nodiscard]] Result<void, FileError> write_chunk(FILE *file, const Slice<const u8> buff) const;

    [[nodiscard]] Result<void, FileError> write_chunk_str(FILE *file, const Slice<const char> buff) const;

    [[nodiscard]] Result<FILE *, FileError> open(const char *path, const char *mode) const;

    [[nodiscard]] Result<void, FileError> sync(FILE *file) const;

    [[nodiscard]] Result<void, FileError> close(FILE *file) const;

    [[nodiscard]] Result<void, FileError> rename(const char *oldPath, const char *newPath) const;

    [[nodiscard]] Result<void, FileError> remove(const char *path) const;
  };

  SyncFileSystem c_filesys();
}  // namespace mtcore
 
#endif  // MTCORE_IO_HPP