file_mapper.hpp

浏览该文件的文档.

#ifndef NEFORCE_CORE_FILE_FILE_MAPPER_HPP__
#define NEFORCE_CORE_FILE_FILE_MAPPER_HPP__

 
#include "NeForce/core/async/mutex.hpp"
#include "NeForce/core/file/file_constants.hpp"
NEFORCE_BEGIN_NAMESPACE__


class NEFORCE_API file_mapper {
public:
#ifdef NEFORCE_PLATFORM_WINDOWS
    using size_type = ::DWORD; 
#else
    using size_type = size_t; 
#endif
 
    using native_handle_type = _NEFORCE native_handle_type; 

    struct map_info {
        void* address = nullptr;                
        size_type size = 0;                     
        size_type offset = 0;                   
        file_access access = file_access::READ; 
        bool is_mapped = false;                 
    };
 
private:
    native_handle_type file_handle_;
    void* ptr_ = nullptr;
    size_type size_ = 0;
    size_type offset_ = 0;
    file_access access_ = file_access::READ;
    mutable mutex mutex_;
 
#ifdef NEFORCE_PLATFORM_WINDOWS
    native_handle_type mapping_handle_ = INVALID_HANDLE_VALUE; 
#endif
 
public:
    explicit file_mapper(native_handle_type file_handle);

    ~file_mapper();
 
    file_mapper(const file_mapper&) = delete;
    file_mapper& operator=(const file_mapper&) = delete;

    file_mapper(file_mapper&& other) noexcept;

    file_mapper& operator=(file_mapper&& other) noexcept;

    bool map(size_type offset = 0, size_type size = 0, file_access access = file_access::READ,
             file_map_hint hint = file_map_hint::SEQUENTIAL);

    void unmap() noexcept;

    bool remap(size_type new_offset, size_type new_size);

    bool flush(bool async = false) noexcept;

    bool lock_pages(bool lock_in_memory) const noexcept;

    NEFORCE_NODISCARD void* data() const noexcept { return ptr_; }

    NEFORCE_NODISCARD size_type size() const noexcept { return size_; }

    NEFORCE_NODISCARD size_type offset() const noexcept { return offset_; }

    NEFORCE_NODISCARD file_access access() const noexcept { return access_; }

    NEFORCE_NODISCARD bool is_mapped() const noexcept { return ptr_ != nullptr; }

    NEFORCE_NODISCARD map_info info() const noexcept;
};
 // File
 
NEFORCE_END_NAMESPACE__
#endif // NEFORCE_CORE_FILE_FILE_MAPPER_HPP__