diff --git a/crates/servicepoint_binding_c/examples/lang_c/Makefile b/crates/servicepoint_binding_c/examples/lang_c/Makefile index 787d38e..86cf49c 100644 --- a/crates/servicepoint_binding_c/examples/lang_c/Makefile +++ b/crates/servicepoint_binding_c/examples/lang_c/Makefile @@ -1,7 +1,7 @@ CC := gcc THIS_DIR := $(dir $(realpath $(lastword $(MAKEFILE_LIST)))) -REPO_ROOT := $(THIS_DIR)/../.. +REPO_ROOT := $(THIS_DIR)/../../../.. build: out/lang_c diff --git a/crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h b/crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h index cc1e903..465a89a 100644 --- a/crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h +++ b/crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h @@ -44,10 +44,25 @@ enum sp_CompressionCode : uint16_t #endif // __cplusplus { + /** + * no compression + */ Uncompressed = 0, + /** + * compress using flate2 with zlib header + */ Zlib = 26490, + /** + * compress using bzip2 + */ Bzip2 = 25210, + /** + * compress using lzma + */ Lzma = 27770, + /** + * compress using Zstandard + */ Zstd = 31347, }; #ifndef __cplusplus @@ -55,7 +70,7 @@ typedef uint16_t sp_CompressionCode; #endif // __cplusplus /** - * A vector of bits + * A fixed-size vector of bits */ typedef struct sp_BitVec sp_BitVec; @@ -87,7 +102,13 @@ typedef struct sp_PixelGrid sp_PixelGrid; /** * Represents a span of memory (`&mut [u8]` ) as a struct usable by C code. * - * Usage of this type is inherently unsafe. + * # Safety + * + * The caller has to make sure that: + * + * - accesses to the memory pointed to with `start` is never accessed outside `length` + * - the lifetime of the `CByteSlice` does not outlive the memory it points to, as described in + * the function returning this type. */ typedef struct sp_CByteSlice { /** @@ -116,51 +137,150 @@ extern "C" { /** * Clones a `BitVec`. - * The returned instance has to be freed with `bit_vec_dealloc`. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not written to concurrently + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_bit_vec_dealloc`. */ struct sp_BitVec *sp_bit_vec_clone(const struct sp_BitVec *this_); /** * Deallocates a `BitVec`. * - * Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not used concurrently or after this call + * - `this` was not passed to another consuming function, e.g. to create a `Command` */ void sp_bit_vec_dealloc(struct sp_BitVec *this_); /** * Sets the value of all bits in the `BitVec`. + * + * # Arguments + * + * * `value`: the value to set all bits to + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not written to or read from concurrently */ void sp_bit_vec_fill(struct sp_BitVec *this_, bool value); /** * Gets the value of a bit from the `BitVec`. + * + * # Arguments + * + * * `this`: instance to read from + * * `index`: the bit index to read + * + * returns: value of the bit + * + * # Panics + * + * When accessing `index` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not written to concurrently */ bool sp_bit_vec_get(const struct sp_BitVec *this_, size_t index); /** * Returns true if length is 0. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` */ bool sp_bit_vec_is_empty(const struct sp_BitVec *this_); /** * Gets the length of the `BitVec` in bits. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` */ size_t sp_bit_vec_len(const struct sp_BitVec *this_); /** - * Loads a `BitVec` from the provided data. - * The returned instance has to be freed with `bit_vec_dealloc`. + * Interpret the data as a series of bits and load then into a new `BitVec` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - `data` points to a valid memory location of at least `data_length` + * bytes in size. + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_bit_vec_dealloc`. */ -struct sp_BitVec *sp_bit_vec_load(const uint8_t *data, size_t data_length); +struct sp_BitVec *sp_bit_vec_load(const uint8_t *data, + size_t data_length); /** * Creates a new `BitVec` instance. - * The returned instance has to be freed with `bit_vec_dealloc`. + * + * # Arguments + * + * * `size`: size in bits. + * + * returns: `BitVec` with all bits set to false. + * + * # Panics + * + * When `size` is not divisible by 8. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_bit_vec_dealloc`. */ struct sp_BitVec *sp_bit_vec_new(size_t size); /** * Sets the value of a bit in the `BitVec`. + * + * # Arguments + * + * * `this`: instance to write to + * * `index`: the bit index to edit + * * `value`: the value to set the bit to + * + * returns: old value of the bit + * + * # Panics + * + * When accessing `index` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not written to or read from concurrently */ bool sp_bit_vec_set(struct sp_BitVec *this_, size_t index, bool value); @@ -169,45 +289,109 @@ bool sp_bit_vec_set(struct sp_BitVec *this_, size_t index, bool value); * * ## Safety * - * The caller has to make sure to never access the returned memory after the `BitVec` - * instance has been consumed or manually deallocated. + * The caller has to make sure that: * - * Reading and writing concurrently to either the original instance or the returned data will - * result in undefined behavior. + * - `this` points to a valid `BitVec` + * - the returned memory range is never accessed after the passed `BitVec` has been freed + * - the returned memory range is never accessed concurrently, either via the `BitVec` or directly */ struct sp_CByteSlice sp_bit_vec_unsafe_data_ref(struct sp_BitVec *this_); /** * Clones a `ByteGrid`. - * The returned instance has to be freed with `byte_grid_dealloc`. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` + * - `this` is not written to concurrently + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_byte_grid_dealloc`. */ struct sp_ByteGrid *sp_byte_grid_clone(const struct sp_ByteGrid *this_); /** * Deallocates a `ByteGrid`. * - * Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` + * - `this` is not used concurrently or after this call + * - `this` was not passed to another consuming function, e.g. to create a `Command` */ void sp_byte_grid_dealloc(struct sp_ByteGrid *this_); /** - * Fills the whole `ByteGrid` with the specified value + * Sets the value of all cells in the `ByteGrid`. + * + * # Arguments + * + * * `this`: instance to write to + * * `value`: the value to set all cells to + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` + * - `this` is not written to or read from concurrently */ void sp_byte_grid_fill(struct sp_ByteGrid *this_, uint8_t value); /** - * Get the current value at the specified position + * Gets the current value at the specified position. + * + * # Arguments + * + * * `this`: instance to read from + * * `x` and `y`: position of the cell to read + * + * # Panics + * + * When accessing `x` or `y` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` + * - `this` is not written to concurrently */ uint8_t sp_byte_grid_get(const struct sp_ByteGrid *this_, size_t x, size_t y); /** - * Gets the height in pixels of the `ByteGrid` instance. + * Gets the height of the `ByteGrid` instance. + * + * # Arguments + * + * * `this`: instance to read from + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` */ size_t sp_byte_grid_height(const struct sp_ByteGrid *this_); /** * Loads a `ByteGrid` with the specified dimensions from the provided data. - * The returned instance has to be freed with `byte_grid_dealloc`. + * + * # Panics + * + * When the provided `data_length` is not sufficient for the `height` and `width` + * + * # Safety + * + * The caller has to make sure that: + * + * - `data` points to a valid memory location of at least `data_length` + * bytes in size. + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_byte_grid_dealloc`. */ struct sp_ByteGrid *sp_byte_grid_load(size_t width, size_t height, @@ -215,13 +399,41 @@ struct sp_ByteGrid *sp_byte_grid_load(size_t width, size_t data_length); /** - * Creates a new `ByteGrid` instance. - * The returned instance has to be freed with `byte_grid_dealloc`. + * Creates a new `ByteGrid` with the specified dimensions. + * + * returns: `ByteGrid` initialized to 0. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_byte_grid_dealloc`. */ -struct sp_ByteGrid *sp_byte_grid_new(size_t width, size_t height); +struct sp_ByteGrid *sp_byte_grid_new(size_t width, + size_t height); /** - * Sets the current value at the specified position + * Sets the value of the specified position in the `ByteGrid`. + * + * # Arguments + * + * * `this`: instance to write to + * * `x` and `y`: position of the cell + * * `value`: the value to write to the cell + * + * returns: old value of the cell + * + * # Panics + * + * When accessing `x` or `y` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `BitVec` + * - `this` is not written to or read from concurrently */ void sp_byte_grid_set(struct sp_ByteGrid *this_, size_t x, @@ -233,22 +445,42 @@ void sp_byte_grid_set(struct sp_ByteGrid *this_, * * ## Safety * - * The caller has to make sure to never access the returned memory after the `ByteGrid` - * instance has been consumed or manually deallocated. + * The caller has to make sure that: * - * Reading and writing concurrently to either the original instance or the returned data will - * result in undefined behavior. + * - `this` points to a valid `ByteGrid` + * - the returned memory range is never accessed after the passed `ByteGrid` has been freed + * - the returned memory range is never accessed concurrently, either via the `ByteGrid` or directly */ struct sp_CByteSlice sp_byte_grid_unsafe_data_ref(struct sp_ByteGrid *this_); /** - * Gets the width in pixels of the `ByteGrid` instance. + * Gets the width of the `ByteGrid` instance. + * + * # Arguments + * + * * `this`: instance to read from + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `ByteGrid` */ size_t sp_byte_grid_width(const struct sp_ByteGrid *this_); /** * Allocates a new `Command::BitmapLinear` instance. - * The passed `BitVec` gets deallocated in the process. + * The passed `BitVec` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `bit_vec` points to a valid instance of `BitVec` + * - `bit_vec` is not used concurrently or after this call + * - `compression` matches one of the allowed enum values + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_bitmap_linear(sp_Offset offset, struct sp_BitVec *bit_vec, @@ -256,7 +488,17 @@ struct sp_Command *sp_command_bitmap_linear(sp_Offset offset, /** * Allocates a new `Command::BitmapLinearAnd` instance. - * The passed `BitVec` gets deallocated in the process. + * The passed `BitVec` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `bit_vec` points to a valid instance of `BitVec` + * - `bit_vec` is not used concurrently or after this call + * - `compression` matches one of the allowed enum values + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_bitmap_linear_and(sp_Offset offset, struct sp_BitVec *bit_vec, @@ -264,7 +506,17 @@ struct sp_Command *sp_command_bitmap_linear_and(sp_Offset offset, /** * Allocates a new `Command::BitmapLinearOr` instance. - * The passed `BitVec` gets deallocated in the process. + * The passed `BitVec` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `bit_vec` points to a valid instance of `BitVec` + * - `bit_vec` is not used concurrently or after this call + * - `compression` matches one of the allowed enum values + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_bitmap_linear_or(sp_Offset offset, struct sp_BitVec *bit_vec, @@ -272,95 +524,213 @@ struct sp_Command *sp_command_bitmap_linear_or(sp_Offset offset, /** * Allocates a new `Command::BitmapLinearWin` instance. - * The passed `PixelGrid` gets deallocated in the process. + * The passed `PixelGrid` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `pixel_grid` points to a valid instance of `PixelGrid` + * - `pixel_grid` is not used concurrently or after this call + * - `compression` matches one of the allowed enum values + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_bitmap_linear_win(size_t x, size_t y, - struct sp_PixelGrid *byte_grid, + struct sp_PixelGrid *pixel_grid, sp_CompressionCode compression_code); /** * Allocates a new `Command::BitmapLinearXor` instance. - * The passed `BitVec` gets deallocated in the process. + * The passed `BitVec` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `bit_vec` points to a valid instance of `BitVec` + * - `bit_vec` is not used concurrently or after this call + * - `compression` matches one of the allowed enum values + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_bitmap_linear_xor(sp_Offset offset, struct sp_BitVec *bit_vec, sp_CompressionCode compression); /** - * Allocates a new `Command::Brightness` instance + * Allocates a new `Command::Brightness` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_brightness(sp_Brightness brightness); /** * Allocates a new `Command::CharBrightness` instance. - * The passed `ByteGrid` gets deallocated in the process. + * The passed `ByteGrid` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `byte_grid` points to a valid instance of `ByteGrid` + * - `byte_grid` is not used concurrently or after this call + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_char_brightness(size_t x, size_t y, struct sp_ByteGrid *byte_grid); /** - * Allocates a new `Command::Clear` instance + * Allocates a new `Command::Clear` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_clear(void); /** - * Clones a `Command` instance + * Clones a `Command` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid instance of `Command` + * - `this` is not written to concurrently + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_clone(const struct sp_Command *original); /** * Allocates a new `Command::Cp437Data` instance. - * The passed `ByteGrid` gets deallocated in the process. + * The passed `ByteGrid` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `byte_grid` points to a valid instance of `ByteGrid` + * - `byte_grid` is not used concurrently or after this call + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_cp437_data(size_t x, size_t y, struct sp_ByteGrid *byte_grid); /** - * Deallocates a `Command`. Note that connection_send does this implicitly, so you only need - * to do this if you use the library for parsing commands. + * Deallocates a `Command`. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `Command` + * - `this` is not used concurrently or after this call + * - `this` was not passed to another consuming function, e.g. to create a `Packet` */ void sp_command_dealloc(struct sp_Command *ptr); /** - * Allocates a new `Command::FadeOut` instance + * Allocates a new `Command::FadeOut` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_fade_out(void); /** - * Allocates a new `Command::HardReset` instance + * Allocates a new `Command::HardReset` instance. + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_hard_reset(void); /** - * Tries to turn a `Packet` into a `Command`. The packet is gets deallocated in the process. + * Tries to turn a `Packet` into a `Command`. The packet is deallocated in the process. * - * Returns: pointer to command or NULL + * Returns: pointer to new `Command` instance or NULL + * + * # Safety + * + * The caller has to make sure that: + * + * - `packet` points to a valid instance of `Packet` + * - `packet` is not used concurrently or after this call + * - the result is checked for NULL + * - the returned `Command` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_command_dealloc`. */ struct sp_Command *sp_command_try_from_packet(struct sp_Packet *packet); /** - * Closes and deallocates a connection instance + * Closes and deallocates a `Connection`. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `Connection` + * - `this` is not used concurrently or after this call */ void sp_connection_dealloc(struct sp_Connection *ptr); /** - * Creates a new instance of Connection. - * The returned instance has to be deallocated with `connection_dealloc`. + * Creates a new instance of `Connection`. * - * returns: NULL if connection fails or connected instance + * returns: NULL if connection fails, or connected instance * - * Panics: bad string encoding + * # Panics + * + * Bad string encoding + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_connection_dealloc`. */ struct sp_Connection *sp_connection_open(const char *host); /** - * Sends the command instance. The instance is consumed / destroyed and cannot be used after this call. + * Sends a `Packet` to the display using the `Connection`. + * The passed `Packet` gets consumed. + * + * returns: true in case of success + * + * # Safety + * + * The caller has to make sure that: + * + * - `connection` points to a valid instance of `Connection` + * - `packet` points to a valid instance of `Packet` + * - `packet` is not used concurrently or after this call */ bool sp_connection_send(const struct sp_Connection *connection, - struct sp_Packet *command_ptr); + struct sp_Packet *packet); /** * Deallocates a `Packet`. @@ -370,7 +740,17 @@ bool sp_connection_send(const struct sp_Connection *connection, void sp_packet_dealloc(struct sp_Packet *this_); /** - * Turns a `Command` into a `Packet`. The command gets deallocated in the process. + * Turns a `Command` into a `Packet`. + * The `Command` gets consumed. + * + * # Safety + * + * The caller has to make sure that: + * + * - `command` points to a valid instance of `Command` + * - `command` is not used concurrently or after this call + * - the returned `Packet` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_packet_dealloc`. */ struct sp_Packet *sp_packet_from_command(struct sp_Command *command); @@ -378,40 +758,121 @@ struct sp_Packet *sp_packet_from_command(struct sp_Command *command); * Tries to load a `Packet` from the passed array with the specified length. * * returns: NULL in case of an error, pointer to the allocated packet otherwise + * + * # Safety + * + * The caller has to make sure that: + * + * - `data` points to a valid memory region of at least `length` bytes + * - `data` is not written to concurrently + * - the returned `Packet` instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_packet_dealloc`. */ -struct sp_Packet *sp_packet_try_load(const uint8_t *data, size_t length); +struct sp_Packet *sp_packet_try_load(const uint8_t *data, + size_t length); /** * Clones a `PixelGrid`. - * The returned instance has to be freed with `pixel_grid_dealloc`. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` + * - `this` is not written to concurrently + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_pixel_grid_dealloc`. */ struct sp_PixelGrid *sp_pixel_grid_clone(const struct sp_PixelGrid *this_); /** * Deallocates a `PixelGrid`. * - * Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` + * - `this` is not used concurrently or after this call + * - `this` was not passed to another consuming function, e.g. to create a `Command` */ void sp_pixel_grid_dealloc(struct sp_PixelGrid *this_); /** - * Fills the whole `PixelGrid` with the specified value + * Sets the state of all pixels in the `PixelGrid`. + * + * # Arguments + * + * * `this`: instance to write to + * * `value`: the value to set all pixels to + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` + * - `this` is not written to or read from concurrently */ void sp_pixel_grid_fill(struct sp_PixelGrid *this_, bool value); /** - * Get the current value at the specified position + * Gets the current value at the specified position in the `PixelGrid`. + * + * # Arguments + * + * * `this`: instance to read from + * * `x` and `y`: position of the cell to read + * + * # Panics + * + * When accessing `x` or `y` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` + * - `this` is not written to concurrently */ bool sp_pixel_grid_get(const struct sp_PixelGrid *this_, size_t x, size_t y); /** * Gets the height in pixels of the `PixelGrid` instance. + * + * # Arguments + * + * * `this`: instance to read from + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` */ size_t sp_pixel_grid_height(const struct sp_PixelGrid *this_); /** * Loads a `PixelGrid` with the specified dimensions from the provided data. - * The returned instance has to be freed with `pixel_grid_dealloc`. + * + * # Arguments + * + * * `width`: size in pixels in x-direction + * * `height`: size in pixels in y-direction + * + * returns: `PixelGrid` that contains a copy of the provided data + * + * # Panics + * + * - when the dimensions and data size do not match exactly. + * - when the width is not dividable by 8 + * + * # Safety + * + * The caller has to make sure that: + * + * - `data` points to a valid memory location of at least `data_length` bytes in size. + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_pixel_grid_dealloc`. */ struct sp_PixelGrid *sp_pixel_grid_load(size_t width, size_t height, @@ -419,13 +880,50 @@ struct sp_PixelGrid *sp_pixel_grid_load(size_t width, size_t data_length); /** - * Creates a new `PixelGrid` instance. - * The returned instance has to be freed with `pixel_grid_dealloc`. + * Creates a new `PixelGrid` with the specified dimensions. + * + * # Arguments + * + * * `width`: size in pixels in x-direction + * * `height`: size in pixels in y-direction + * + * returns: `PixelGrid` initialized to all pixels off + * + * # Panics + * + * - when the width is not dividable by 8 + * + * # Safety + * + * The caller has to make sure that: + * + * - the returned instance is freed in some way, either by using a consuming function or + * by explicitly calling `sp_pixel_grid_dealloc`. */ -struct sp_PixelGrid *sp_pixel_grid_new(size_t width, size_t height); +struct sp_PixelGrid *sp_pixel_grid_new(size_t width, + size_t height); /** - * Sets the current value at the specified position + * Sets the value of the specified position in the `PixelGrid`. + * + * # Arguments + * + * * `this`: instance to write to + * * `x` and `y`: position of the cell + * * `value`: the value to write to the cell + * + * returns: old value of the cell + * + * # Panics + * + * When accessing `x` or `y` out of bounds. + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` + * - `this` is not written to or read from concurrently */ void sp_pixel_grid_set(struct sp_PixelGrid *this_, size_t x, @@ -437,16 +935,26 @@ void sp_pixel_grid_set(struct sp_PixelGrid *this_, * * ## Safety * - * The caller has to make sure to never access the returned memory after the `PixelGrid` - * instance has been consumed or manually deallocated. + * The caller has to make sure that: * - * Reading and writing concurrently to either the original instance or the returned data will - * result in undefined behavior. + * - `this` points to a valid `PixelGrid` + * - the returned memory range is never accessed after the passed `PixelGrid` has been freed + * - the returned memory range is never accessed concurrently, either via the `PixelGrid` or directly */ struct sp_CByteSlice sp_pixel_grid_unsafe_data_ref(struct sp_PixelGrid *this_); /** * Gets the width in pixels of the `PixelGrid` instance. + * + * # Arguments + * + * * `this`: instance to read from + * + * # Safety + * + * The caller has to make sure that: + * + * - `this` points to a valid `PixelGrid` */ size_t sp_pixel_grid_width(const struct sp_PixelGrid *this_); diff --git a/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs b/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs index fd8f466..0d926ef 100644 --- a/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs +++ b/crates/servicepoint_binding_cs/ServicePoint/BindGen/ServicePoint.g.cs @@ -19,204 +19,204 @@ namespace ServicePoint.BindGen public const nuint TILE_HEIGHT = 20; - /// Creates a new `BitVec` instance. The returned instance has to be freed with `bit_vec_dealloc`. + /// Creates a new `BitVec` instance. # Arguments * `size`: size in bits. returns: `BitVec` with all bits set to false. # Panics When `size` is not divisible by 8. # Safety The caller has to make sure that: - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_bit_vec_dealloc`. [DllImport(__DllName, EntryPoint = "sp_bit_vec_new", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern BitVec* sp_bit_vec_new(nuint size); - /// Loads a `BitVec` from the provided data. The returned instance has to be freed with `bit_vec_dealloc`. + /// Interpret the data as a series of bits and load then into a new `BitVec` instance. # Safety The caller has to make sure that: - `data` points to a valid memory location of at least `data_length` bytes in size. - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_bit_vec_dealloc`. [DllImport(__DllName, EntryPoint = "sp_bit_vec_load", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern BitVec* sp_bit_vec_load(byte* data, nuint data_length); - /// Clones a `BitVec`. The returned instance has to be freed with `bit_vec_dealloc`. + /// Clones a `BitVec`. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not written to concurrently - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_bit_vec_dealloc`. [DllImport(__DllName, EntryPoint = "sp_bit_vec_clone", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern BitVec* sp_bit_vec_clone(BitVec* @this); - /// Deallocates a `BitVec`. Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + /// Deallocates a `BitVec`. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not used concurrently or after this call - `this` was not passed to another consuming function, e.g. to create a `Command` [DllImport(__DllName, EntryPoint = "sp_bit_vec_dealloc", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_bit_vec_dealloc(BitVec* @this); - /// Gets the value of a bit from the `BitVec`. + /// Gets the value of a bit from the `BitVec`. # Arguments * `this`: instance to read from * `index`: the bit index to read returns: value of the bit # Panics When accessing `index` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not written to concurrently [DllImport(__DllName, EntryPoint = "sp_bit_vec_get", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [return: MarshalAs(UnmanagedType.U1)] public static extern bool sp_bit_vec_get(BitVec* @this, nuint index); - /// Sets the value of a bit in the `BitVec`. + /// Sets the value of a bit in the `BitVec`. # Arguments * `this`: instance to write to * `index`: the bit index to edit * `value`: the value to set the bit to returns: old value of the bit # Panics When accessing `index` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_bit_vec_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [return: MarshalAs(UnmanagedType.U1)] public static extern bool sp_bit_vec_set(BitVec* @this, nuint index, [MarshalAs(UnmanagedType.U1)] bool value); - /// Sets the value of all bits in the `BitVec`. + /// Sets the value of all bits in the `BitVec`. # Arguments * `value`: the value to set all bits to # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_bit_vec_fill", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_bit_vec_fill(BitVec* @this, [MarshalAs(UnmanagedType.U1)] bool value); - /// Gets the length of the `BitVec` in bits. + /// Gets the length of the `BitVec` in bits. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` [DllImport(__DllName, EntryPoint = "sp_bit_vec_len", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern nuint sp_bit_vec_len(BitVec* @this); - /// Returns true if length is 0. + /// Returns true if length is 0. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` [DllImport(__DllName, EntryPoint = "sp_bit_vec_is_empty", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [return: MarshalAs(UnmanagedType.U1)] public static extern bool sp_bit_vec_is_empty(BitVec* @this); - /// Gets an unsafe reference to the data of the `BitVec` instance. ## Safety The caller has to make sure to never access the returned memory after the `BitVec` instance has been consumed or manually deallocated. Reading and writing concurrently to either the original instance or the returned data will result in undefined behavior. + /// Gets an unsafe reference to the data of the `BitVec` instance. ## Safety The caller has to make sure that: - `this` points to a valid `BitVec` - the returned memory range is never accessed after the passed `BitVec` has been freed - the returned memory range is never accessed concurrently, either via the `BitVec` or directly [DllImport(__DllName, EntryPoint = "sp_bit_vec_unsafe_data_ref", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern CByteSlice sp_bit_vec_unsafe_data_ref(BitVec* @this); - /// Creates a new `ByteGrid` instance. The returned instance has to be freed with `byte_grid_dealloc`. + /// Creates a new `ByteGrid` with the specified dimensions. returns: `ByteGrid` initialized to 0. # Safety The caller has to make sure that: - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_byte_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_byte_grid_new", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern ByteGrid* sp_byte_grid_new(nuint width, nuint height); - /// Loads a `ByteGrid` with the specified dimensions from the provided data. The returned instance has to be freed with `byte_grid_dealloc`. + /// Loads a `ByteGrid` with the specified dimensions from the provided data. # Panics When the provided `data_length` is not sufficient for the `height` and `width` # Safety The caller has to make sure that: - `data` points to a valid memory location of at least `data_length` bytes in size. - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_byte_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_byte_grid_load", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern ByteGrid* sp_byte_grid_load(nuint width, nuint height, byte* data, nuint data_length); - /// Clones a `ByteGrid`. The returned instance has to be freed with `byte_grid_dealloc`. + /// Clones a `ByteGrid`. # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` - `this` is not written to concurrently - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_byte_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_byte_grid_clone", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern ByteGrid* sp_byte_grid_clone(ByteGrid* @this); - /// Deallocates a `ByteGrid`. Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + /// Deallocates a `ByteGrid`. # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` - `this` is not used concurrently or after this call - `this` was not passed to another consuming function, e.g. to create a `Command` [DllImport(__DllName, EntryPoint = "sp_byte_grid_dealloc", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_byte_grid_dealloc(ByteGrid* @this); - /// Get the current value at the specified position + /// Gets the current value at the specified position. # Arguments * `this`: instance to read from * `x` and `y`: position of the cell to read # Panics When accessing `x` or `y` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` - `this` is not written to concurrently [DllImport(__DllName, EntryPoint = "sp_byte_grid_get", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern byte sp_byte_grid_get(ByteGrid* @this, nuint x, nuint y); - /// Sets the current value at the specified position + /// Sets the value of the specified position in the `ByteGrid`. # Arguments * `this`: instance to write to * `x` and `y`: position of the cell * `value`: the value to write to the cell returns: old value of the cell # Panics When accessing `x` or `y` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `BitVec` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_byte_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_byte_grid_set(ByteGrid* @this, nuint x, nuint y, byte value); - /// Fills the whole `ByteGrid` with the specified value + /// Sets the value of all cells in the `ByteGrid`. # Arguments * `this`: instance to write to * `value`: the value to set all cells to # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_byte_grid_fill", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_byte_grid_fill(ByteGrid* @this, byte value); - /// Gets the width in pixels of the `ByteGrid` instance. + /// Gets the width of the `ByteGrid` instance. # Arguments * `this`: instance to read from # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` [DllImport(__DllName, EntryPoint = "sp_byte_grid_width", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern nuint sp_byte_grid_width(ByteGrid* @this); - /// Gets the height in pixels of the `ByteGrid` instance. + /// Gets the height of the `ByteGrid` instance. # Arguments * `this`: instance to read from # Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` [DllImport(__DllName, EntryPoint = "sp_byte_grid_height", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern nuint sp_byte_grid_height(ByteGrid* @this); - /// Gets an unsafe reference to the data of the `ByteGrid` instance. ## Safety The caller has to make sure to never access the returned memory after the `ByteGrid` instance has been consumed or manually deallocated. Reading and writing concurrently to either the original instance or the returned data will result in undefined behavior. + /// Gets an unsafe reference to the data of the `ByteGrid` instance. ## Safety The caller has to make sure that: - `this` points to a valid `ByteGrid` - the returned memory range is never accessed after the passed `ByteGrid` has been freed - the returned memory range is never accessed concurrently, either via the `ByteGrid` or directly [DllImport(__DllName, EntryPoint = "sp_byte_grid_unsafe_data_ref", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern CByteSlice sp_byte_grid_unsafe_data_ref(ByteGrid* @this); - /// Tries to turn a `Packet` into a `Command`. The packet is gets deallocated in the process. Returns: pointer to command or NULL + /// Tries to turn a `Packet` into a `Command`. The packet is deallocated in the process. Returns: pointer to new `Command` instance or NULL # Safety The caller has to make sure that: - `packet` points to a valid instance of `Packet` - `packet` is not used concurrently or after this call - the result is checked for NULL - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_try_from_packet", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_try_from_packet(Packet* packet); - /// Clones a `Command` instance + /// Clones a `Command` instance. # Safety The caller has to make sure that: - `this` points to a valid instance of `Command` - `this` is not written to concurrently - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_clone", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_clone(Command* original); - /// Allocates a new `Command::Clear` instance + /// Allocates a new `Command::Clear` instance. # Safety The caller has to make sure that: - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_clear", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_clear(); - /// Allocates a new `Command::HardReset` instance + /// Allocates a new `Command::HardReset` instance. # Safety The caller has to make sure that: - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_hard_reset", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_hard_reset(); - /// Allocates a new `Command::FadeOut` instance + /// Allocates a new `Command::FadeOut` instance. # Safety The caller has to make sure that: - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_fade_out", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_fade_out(); - /// Allocates a new `Command::Brightness` instance + /// Allocates a new `Command::Brightness` instance. # Safety The caller has to make sure that: - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_brightness", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_brightness(byte brightness); - /// Allocates a new `Command::CharBrightness` instance. The passed `ByteGrid` gets deallocated in the process. + /// Allocates a new `Command::CharBrightness` instance. The passed `ByteGrid` gets consumed. # Safety The caller has to make sure that: - `byte_grid` points to a valid instance of `ByteGrid` - `byte_grid` is not used concurrently or after this call - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_char_brightness", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_char_brightness(nuint x, nuint y, ByteGrid* byte_grid); - /// Allocates a new `Command::BitmapLinear` instance. The passed `BitVec` gets deallocated in the process. + /// Allocates a new `Command::BitmapLinear` instance. The passed `BitVec` gets consumed. # Safety The caller has to make sure that: - `bit_vec` points to a valid instance of `BitVec` - `bit_vec` is not used concurrently or after this call - `compression` matches one of the allowed enum values - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_bitmap_linear", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_bitmap_linear(nuint offset, BitVec* bit_vec, CompressionCode compression); - /// Allocates a new `Command::BitmapLinearAnd` instance. The passed `BitVec` gets deallocated in the process. + /// Allocates a new `Command::BitmapLinearAnd` instance. The passed `BitVec` gets consumed. # Safety The caller has to make sure that: - `bit_vec` points to a valid instance of `BitVec` - `bit_vec` is not used concurrently or after this call - `compression` matches one of the allowed enum values - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_bitmap_linear_and", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_bitmap_linear_and(nuint offset, BitVec* bit_vec, CompressionCode compression); - /// Allocates a new `Command::BitmapLinearOr` instance. The passed `BitVec` gets deallocated in the process. + /// Allocates a new `Command::BitmapLinearOr` instance. The passed `BitVec` gets consumed. # Safety The caller has to make sure that: - `bit_vec` points to a valid instance of `BitVec` - `bit_vec` is not used concurrently or after this call - `compression` matches one of the allowed enum values - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_bitmap_linear_or", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_bitmap_linear_or(nuint offset, BitVec* bit_vec, CompressionCode compression); - /// Allocates a new `Command::BitmapLinearXor` instance. The passed `BitVec` gets deallocated in the process. + /// Allocates a new `Command::BitmapLinearXor` instance. The passed `BitVec` gets consumed. # Safety The caller has to make sure that: - `bit_vec` points to a valid instance of `BitVec` - `bit_vec` is not used concurrently or after this call - `compression` matches one of the allowed enum values - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_bitmap_linear_xor", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_bitmap_linear_xor(nuint offset, BitVec* bit_vec, CompressionCode compression); - /// Allocates a new `Command::Cp437Data` instance. The passed `ByteGrid` gets deallocated in the process. + /// Allocates a new `Command::Cp437Data` instance. The passed `ByteGrid` gets consumed. # Safety The caller has to make sure that: - `byte_grid` points to a valid instance of `ByteGrid` - `byte_grid` is not used concurrently or after this call - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_cp437_data", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Command* sp_command_cp437_data(nuint x, nuint y, ByteGrid* byte_grid); - /// Allocates a new `Command::BitmapLinearWin` instance. The passed `PixelGrid` gets deallocated in the process. + /// Allocates a new `Command::BitmapLinearWin` instance. The passed `PixelGrid` gets consumed. # Safety The caller has to make sure that: - `pixel_grid` points to a valid instance of `PixelGrid` - `pixel_grid` is not used concurrently or after this call - `compression` matches one of the allowed enum values - the returned `Command` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_command_dealloc`. [DllImport(__DllName, EntryPoint = "sp_command_bitmap_linear_win", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] - public static extern Command* sp_command_bitmap_linear_win(nuint x, nuint y, PixelGrid* byte_grid, CompressionCode compression_code); + public static extern Command* sp_command_bitmap_linear_win(nuint x, nuint y, PixelGrid* pixel_grid, CompressionCode compression_code); - /// Deallocates a `Command`. Note that connection_send does this implicitly, so you only need to do this if you use the library for parsing commands. + /// Deallocates a `Command`. # Safety The caller has to make sure that: - `this` points to a valid `Command` - `this` is not used concurrently or after this call - `this` was not passed to another consuming function, e.g. to create a `Packet` [DllImport(__DllName, EntryPoint = "sp_command_dealloc", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_command_dealloc(Command* ptr); - /// Creates a new instance of Connection. The returned instance has to be deallocated with `connection_dealloc`. returns: NULL if connection fails or connected instance Panics: bad string encoding + /// Creates a new instance of `Connection`. returns: NULL if connection fails, or connected instance # Panics Bad string encoding # Safety The caller has to make sure that: - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_connection_dealloc`. [DllImport(__DllName, EntryPoint = "sp_connection_open", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Connection* sp_connection_open(byte* host); - /// Sends the command instance. The instance is consumed / destroyed and cannot be used after this call. + /// Sends a `Packet` to the display using the `Connection`. The passed `Packet` gets consumed. returns: true in case of success # Safety The caller has to make sure that: - `connection` points to a valid instance of `Connection` - `packet` points to a valid instance of `Packet` - `packet` is not used concurrently or after this call [DllImport(__DllName, EntryPoint = "sp_connection_send", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [return: MarshalAs(UnmanagedType.U1)] - public static extern bool sp_connection_send(Connection* connection, Packet* command_ptr); + public static extern bool sp_connection_send(Connection* connection, Packet* packet); - /// Closes and deallocates a connection instance + /// Closes and deallocates a `Connection`. # Safety The caller has to make sure that: - `this` points to a valid `Connection` - `this` is not used concurrently or after this call [DllImport(__DllName, EntryPoint = "sp_connection_dealloc", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_connection_dealloc(Connection* ptr); - /// Creates a new `PixelGrid` instance. The returned instance has to be freed with `pixel_grid_dealloc`. + /// Creates a new `PixelGrid` with the specified dimensions. # Arguments * `width`: size in pixels in x-direction * `height`: size in pixels in y-direction returns: `PixelGrid` initialized to all pixels off # Panics - when the width is not dividable by 8 # Safety The caller has to make sure that: - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_pixel_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_pixel_grid_new", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern PixelGrid* sp_pixel_grid_new(nuint width, nuint height); - /// Loads a `PixelGrid` with the specified dimensions from the provided data. The returned instance has to be freed with `pixel_grid_dealloc`. + /// Loads a `PixelGrid` with the specified dimensions from the provided data. # Arguments * `width`: size in pixels in x-direction * `height`: size in pixels in y-direction returns: `PixelGrid` that contains a copy of the provided data # Panics - when the dimensions and data size do not match exactly. - when the width is not dividable by 8 # Safety The caller has to make sure that: - `data` points to a valid memory location of at least `data_length` bytes in size. - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_pixel_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_pixel_grid_load", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern PixelGrid* sp_pixel_grid_load(nuint width, nuint height, byte* data, nuint data_length); - /// Clones a `PixelGrid`. The returned instance has to be freed with `pixel_grid_dealloc`. + /// Clones a `PixelGrid`. # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - `this` is not written to concurrently - the returned instance is freed in some way, either by using a consuming function or by explicitly calling `sp_pixel_grid_dealloc`. [DllImport(__DllName, EntryPoint = "sp_pixel_grid_clone", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern PixelGrid* sp_pixel_grid_clone(PixelGrid* @this); - /// Deallocates a `PixelGrid`. Note: do not call this if the grid has been consumed in another way, e.g. to create a command. + /// Deallocates a `PixelGrid`. # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - `this` is not used concurrently or after this call - `this` was not passed to another consuming function, e.g. to create a `Command` [DllImport(__DllName, EntryPoint = "sp_pixel_grid_dealloc", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_pixel_grid_dealloc(PixelGrid* @this); - /// Get the current value at the specified position + /// Gets the current value at the specified position in the `PixelGrid`. # Arguments * `this`: instance to read from * `x` and `y`: position of the cell to read # Panics When accessing `x` or `y` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - `this` is not written to concurrently [DllImport(__DllName, EntryPoint = "sp_pixel_grid_get", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] [return: MarshalAs(UnmanagedType.U1)] public static extern bool sp_pixel_grid_get(PixelGrid* @this, nuint x, nuint y); - /// Sets the current value at the specified position + /// Sets the value of the specified position in the `PixelGrid`. # Arguments * `this`: instance to write to * `x` and `y`: position of the cell * `value`: the value to write to the cell returns: old value of the cell # Panics When accessing `x` or `y` out of bounds. # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_pixel_grid_set", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_pixel_grid_set(PixelGrid* @this, nuint x, nuint y, [MarshalAs(UnmanagedType.U1)] bool value); - /// Fills the whole `PixelGrid` with the specified value + /// Sets the state of all pixels in the `PixelGrid`. # Arguments * `this`: instance to write to * `value`: the value to set all pixels to # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - `this` is not written to or read from concurrently [DllImport(__DllName, EntryPoint = "sp_pixel_grid_fill", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern void sp_pixel_grid_fill(PixelGrid* @this, [MarshalAs(UnmanagedType.U1)] bool value); - /// Gets the width in pixels of the `PixelGrid` instance. + /// Gets the width in pixels of the `PixelGrid` instance. # Arguments * `this`: instance to read from # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` [DllImport(__DllName, EntryPoint = "sp_pixel_grid_width", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern nuint sp_pixel_grid_width(PixelGrid* @this); - /// Gets the height in pixels of the `PixelGrid` instance. + /// Gets the height in pixels of the `PixelGrid` instance. # Arguments * `this`: instance to read from # Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` [DllImport(__DllName, EntryPoint = "sp_pixel_grid_height", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern nuint sp_pixel_grid_height(PixelGrid* @this); - /// Gets an unsafe reference to the data of the `PixelGrid` instance. ## Safety The caller has to make sure to never access the returned memory after the `PixelGrid` instance has been consumed or manually deallocated. Reading and writing concurrently to either the original instance or the returned data will result in undefined behavior. + /// Gets an unsafe reference to the data of the `PixelGrid` instance. ## Safety The caller has to make sure that: - `this` points to a valid `PixelGrid` - the returned memory range is never accessed after the passed `PixelGrid` has been freed - the returned memory range is never accessed concurrently, either via the `PixelGrid` or directly [DllImport(__DllName, EntryPoint = "sp_pixel_grid_unsafe_data_ref", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern CByteSlice sp_pixel_grid_unsafe_data_ref(PixelGrid* @this); - /// Turns a `Command` into a `Packet`. The command gets deallocated in the process. + /// Turns a `Command` into a `Packet`. The `Command` gets consumed. # Safety The caller has to make sure that: - `command` points to a valid instance of `Command` - `command` is not used concurrently or after this call - the returned `Packet` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_packet_dealloc`. [DllImport(__DllName, EntryPoint = "sp_packet_from_command", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Packet* sp_packet_from_command(Command* command); - /// Tries to load a `Packet` from the passed array with the specified length. returns: NULL in case of an error, pointer to the allocated packet otherwise + /// Tries to load a `Packet` from the passed array with the specified length. returns: NULL in case of an error, pointer to the allocated packet otherwise # Safety The caller has to make sure that: - `data` points to a valid memory region of at least `length` bytes - `data` is not written to concurrently - the returned `Packet` instance is freed in some way, either by using a consuming function or by explicitly calling `sp_packet_dealloc`. [DllImport(__DllName, EntryPoint = "sp_packet_try_load", CallingConvention = CallingConvention.Cdecl, ExactSpelling = true)] public static extern Packet* sp_packet_try_load(byte* data, nuint length);