mirror of
https://github.com/WerWolv/ImHex-Patterns.git
synced 2026-03-27 23:37:04 -05:00
b10a37af67
doc: descirbe how to create multidimensional std::Array Co-authored-by: paxcut <53811119+paxcut@users.noreply.github.com>
69 lines
1.8 KiB
Rust
69 lines
1.8 KiB
Rust
#pragma once
|
|
|
|
import std.sys;
|
|
import std.core;
|
|
|
|
/*!
|
|
The array library contains a helper type to make it easier to create multi-dimensional arrays
|
|
and pass arrays to functions as parameters.
|
|
|
|
## Multi-dimensional arrays
|
|
|
|
The following example shows how to use multi-dimensional arrays with structs.
|
|
|
|
```rust
|
|
import std.array;
|
|
|
|
struct File {
|
|
u8 width, height;
|
|
std::Array<std::Array<u8, parent.width>, height> cells;
|
|
};
|
|
|
|
File file @ 0x00;
|
|
```
|
|
|
|
*/
|
|
|
|
namespace auto std {
|
|
|
|
/**
|
|
Simple one dimensional array wrapper
|
|
@tparam T The array types
|
|
@tparam Size Number of entries in the array
|
|
*/
|
|
struct Array<T, auto Size> {
|
|
T data[Size] [[inline]];
|
|
} [[format("std::impl::format_array")]];
|
|
|
|
/**
|
|
Simple array wrapper for an array with a size in bytes
|
|
@tparam T The array types
|
|
@tparam NumBytes Number of bytes the array contains
|
|
*/
|
|
struct ByteSizedArray<T, auto NumBytes> {
|
|
u64 startAddress = $;
|
|
T array[while($ - startAddress < NumBytes)] [[inline]];
|
|
|
|
std::assert($ - startAddress == NumBytes, "Not enough bytes available to fit a whole number of types");
|
|
} [[format("std::impl::format_array")]];
|
|
|
|
|
|
/**
|
|
An interface type for getting the index of the currently processed element in an array. This is a nice wrapper around `std::core::array_index()`
|
|
|
|
To use it, inherit from it and use the `this.index` field to get the index of the current element
|
|
*/
|
|
struct IIndexed {
|
|
const u64 index = std::core::array_index();
|
|
};
|
|
|
|
namespace impl {
|
|
|
|
fn format_array(ref auto array) {
|
|
return "[ ... ]";
|
|
};
|
|
|
|
}
|
|
|
|
}
|