File.hh

Go to the documentation of this file.

#ifndef FILE_HH
#define FILE_HH
 
#include <cstdint>
#include <ctime>
#include <memory>
#include <span>
#include <string_view>
 
namespace openmsx {
 
class Filename;
class FileBase;
 
class File
{
public:
        enum OpenMode {
                NORMAL,
                TRUNCATE,
                CREATE,
                LOAD_PERSISTENT,
                SAVE_PERSISTENT,
                PRE_CACHE,
        };
 
        File();
 
        explicit File(std::string filename, OpenMode mode = NORMAL);
        explicit File(const Filename& filename, OpenMode mode = NORMAL);
        explicit File(Filename&& filename, OpenMode mode = NORMAL);
 
        File(std::string filename, const char* mode);
        File(const Filename& filename, const char* mode);
        File(Filename&& filename, const char* mode);
        File(File&& other) noexcept;
 
        /* Used by MemoryBufferFile. */
        File(std::unique_ptr<FileBase> file_);
 
        ~File();
 
        File& operator=(File&& other) noexcept;
 
        [[nodiscard]] bool is_open() const { return file != nullptr; }
 
        void close();
 
        void read(std::span<uint8_t> buffer);
 
        template<typename T>
        void read(std::span<T> buffer) {
                read(std::span<uint8_t>{reinterpret_cast<uint8_t*>(buffer.data()), buffer.size_bytes()});
        }
 
        void write(std::span<const uint8_t> buffer);
 
        template<typename T>
        void write(std::span<T> buffer) {
                write(std::span<const uint8_t>{reinterpret_cast<const uint8_t*>(buffer.data()), buffer.size_bytes()});
        }
 
        [[nodiscard]] std::span<const uint8_t> mmap();
 
        void munmap();
 
        [[nodiscard]] size_t getSize();
 
        void seek(size_t pos);
 
        [[nodiscard]] size_t getPos();
 
        void truncate(size_t size);
 
        void flush();
 
        [[nodiscard]] const std::string& getURL() const;
 
        [[nodiscard]] std::string_view getOriginalName();
 
        [[nodiscard]] bool isReadOnly() const;
 
        [[nodiscard]] time_t getModificationDate();
 
private:
        friend class LocalFileReference;
        [[nodiscard]] std::string getLocalReference() const;
 
        std::unique_ptr<FileBase> file;
};
 
} // namespace openmsx
 
#endif