Cool_Tools/ImHex
1
0
Fork 0
mirror of synced 2025-02-12 08:43:03 +01:00
Code Releases Wiki Activity

impr: Added some documentation to providers (#1001)

Browse Source
This commit is contained in:
Thomas 2023-04-01 11:17:19 +02:00 committed by GitHub
parent 60efb6973b
commit 24106b860a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
lib/libimhex/include/hex/providers/provider.hpp
View File

@ -16,6 +16,9 @@
namespace hex::prv { namespace hex::prv {
/**
* @brief Represent the data source for a tab
*/
class Provider { class Provider {
public: public:
constexpr static size_t PageSize = 0x1000'0000; constexpr static size_t PageSize = 0x1000'0000;
@ -29,7 +32,21 @@ namespace hex::prv {
[[nodiscard]] virtual bool isResizable() const = 0; [[nodiscard]] virtual bool isResizable() const = 0;
[[nodiscard]] virtual bool isSavable() const = 0; [[nodiscard]] virtual bool isSavable() const = 0;
/**
* @brief Read data from this provider, applying overlays and patches
* @param offset offset to start reading the data
* @param buffer buffer to write read data
* @param size number of bytes to read
* @param overlays apply overlays and patches is true. Same as readRaw() if false
*/
virtual void read(u64 offset, void *buffer, size_t size, bool overlays = true); virtual void read(u64 offset, void *buffer, size_t size, bool overlays = true);
/**
* @brief Write data to the patches of this provider. Will not directly modify provider.
* @param offset offset to start writing the data
* @param buffer buffer to take data to write from
* @param size number of bytes to write
*/
virtual void write(u64 offset, const void *buffer, size_t size); virtual void write(u64 offset, const void *buffer, size_t size);
virtual void resize(size_t newSize); virtual void resize(size_t newSize);
@ -39,7 +56,19 @@ namespace hex::prv {
virtual void save(); virtual void save();
virtual void saveAs(const std::fs::path &path); virtual void saveAs(const std::fs::path &path);
/**
* @brief Read data from this provider, without applying overlays and patches
* @param offset offset to start reading the data
* @param buffer buffer to write read data
* @param size number of bytes to read
*/
virtual void readRaw(u64 offset, void *buffer, size_t size) = 0; virtual void readRaw(u64 offset, void *buffer, size_t size) = 0;
/**
* @brief Write data directly to this provider
* @param offset offset to start writing the data
* @param buffer buffer to take data to write from
* @param size number of bytes to write
*/
virtual void writeRaw(u64 offset, const void *buffer, size_t size) = 0; virtual void writeRaw(u64 offset, const void *buffer, size_t size) = 0;
[[nodiscard]] virtual size_t getActualSize() const = 0; [[nodiscard]] virtual size_t getActualSize() const = 0;