From e7cad5b5a3a79e6e1cf6fd4dcfdbbbf03fecdddd Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Wed, 7 May 2025 08:29:16 +0200 Subject: [PATCH 1/5] doc changes --- include/servicepoint.h | 66 +++++++++++++++++++++++------- src/bitvec.rs | 24 +++++------ src/commands/bitmap_command.rs | 2 +- src/commands/cp437_grid_command.rs | 11 ++++- src/commands/generic_command.rs | 13 +++++- src/udp.rs | 2 +- 6 files changed, 87 insertions(+), 31 deletions(-) diff --git a/include/servicepoint.h b/include/servicepoint.h index ec722f5..131fe41 100644 --- a/include/servicepoint.h +++ b/include/servicepoint.h @@ -125,6 +125,11 @@ enum CommandCode typedef uint16_t CommandCode; #endif // __cplusplus +/** + * Specifies the kind of command struct. + * + * This is _not_ equivalent to the [servicepoint::CommandCode]s. + */ enum CommandTag #ifdef __cplusplus : uint8_t @@ -531,6 +536,9 @@ typedef size_t Offset; */ typedef ValueGrid_u8 Cp437Grid; +/** + * Pointer to one of the available command structs. + */ typedef union { uint8_t *null; BitmapCommand */*notnull*/ bitmap; @@ -545,6 +553,13 @@ typedef union { FadeOutCommand */*notnull*/ fade_out; } CommandUnion; +/** + * This struct represents a pointer to one of the possible command structs. + * + * Only ever access `data` with the correct data type as specified by `tag`! + * + * Rust equivalent: [TypedCommand]. + */ typedef struct { /** * Specifies which kind of command struct is contained in `data` @@ -754,12 +769,12 @@ ByteSlice sp_bitmap_unsafe_data_ref(Bitmap */*notnull*/ bitmap); size_t sp_bitmap_width(Bitmap */*notnull*/ bitmap); /** - * Clones a [SPBitVec]. + * Clones a [DisplayBitVec]. */ DisplayBitVec */*notnull*/ sp_bitvec_clone(DisplayBitVec */*notnull*/ bit_vec); /** - * Sets the value of all bits in the [SPBitVec]. + * Sets the value of all bits in the [DisplayBitVec]. * * # Arguments * @@ -769,12 +784,12 @@ DisplayBitVec */*notnull*/ sp_bitvec_clone(DisplayBitVec */*notnull*/ bit_vec); void sp_bitvec_fill(DisplayBitVec */*notnull*/ bit_vec, bool value); /** - * Deallocates a [SPBitVec]. + * Deallocates a [DisplayBitVec]. */ void sp_bitvec_free(DisplayBitVec */*notnull*/ bit_vec); /** - * Gets the value of a bit from the [SPBitVec]. + * Gets the value of a bit from the [DisplayBitVec]. * * # Arguments * @@ -792,7 +807,7 @@ bool sp_bitvec_get(DisplayBitVec */*notnull*/ bit_vec, size_t index); /** * Creates a [BitVecCommand] and immediately turns that into a [Packet]. * - * The provided [SPBitVec] gets consumed. + * The provided [DisplayBitVec] gets consumed. * * Returns NULL in case of an error. */ @@ -811,7 +826,7 @@ Packet *sp_bitvec_into_packet(DisplayBitVec */*notnull*/ bitvec, bool sp_bitvec_is_empty(DisplayBitVec */*notnull*/ bit_vec); /** - * Gets the length of the [SPBitVec] in bits. + * Gets the length of the [DisplayBitVec] in bits. * * # Arguments * @@ -820,20 +835,20 @@ bool sp_bitvec_is_empty(DisplayBitVec */*notnull*/ bit_vec); size_t sp_bitvec_len(DisplayBitVec */*notnull*/ bit_vec); /** - * Interpret the data as a series of bits and load then into a new [SPBitVec] instance. + * Interpret the data as a series of bits and load then into a new [DisplayBitVec] instance. * - * returns: [SPBitVec] instance containing data. + * returns: [DisplayBitVec] instance containing data. */ DisplayBitVec */*notnull*/ sp_bitvec_load(ByteSlice data); /** - * Creates a new [SPBitVec] instance. + * Creates a new [DisplayBitVec] instance. * * # Arguments * * - `size`: size in bits. * - * returns: [SPBitVec] with all bits set to false. + * returns: [DisplayBitVec] with all bits set to false. * * # Panics * @@ -842,7 +857,7 @@ DisplayBitVec */*notnull*/ sp_bitvec_load(ByteSlice data); DisplayBitVec */*notnull*/ sp_bitvec_new(size_t size); /** - * Sets the value of a bit in the [SPBitVec]. + * Sets the value of a bit in the [DisplayBitVec]. * * # Arguments * @@ -859,7 +874,7 @@ void sp_bitvec_set(DisplayBitVec */*notnull*/ bit_vec, bool value); /** - * Gets an unsafe reference to the data of the [SPBitVec] instance. + * Gets an unsafe reference to the data of the [DisplayBitVec] instance. * * The returned memory is valid for the lifetime of the bitvec. * @@ -1119,7 +1134,7 @@ void sp_cmd_bitmap_free(BitmapCommand */*notnull*/ command); * Move the provided [Bitmap] into a new [BitmapCommand], * leaving other fields as their default values. * - * Rust equivalent: [`>::from`] + * Rust equivalent: `BitmapCommand::from(bitmap)` */ BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(Bitmap */*notnull*/ bitmap); @@ -1311,6 +1326,11 @@ Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_from_grid(Cp437Grid */*notnull*/ Cp437Grid *sp_cmd_cp437_grid_get(Cp437GridCommand */*notnull*/ command); +/** + * Gets the origin field of the [Cp437GridCommand]. + * + * Rust equivalent: `cp437_command.origin` + */ void sp_cmd_cp437_grid_get_origin(Cp437GridCommand */*notnull*/ command, size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_y); @@ -1322,11 +1342,18 @@ Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_new(Cp437Grid */*notnull*/ grid, size_t origin_y); /** - * Moves the provided bitmap to be contained in the command. + * Moves the provided bitmap into the provided command. + * + * This drops the previously contained [Cp437Grid]. */ void sp_cmd_cp437_grid_set(Cp437GridCommand */*notnull*/ command, Cp437Grid */*notnull*/ grid); +/** + * Sets the origin field of the [Cp437GridCommand]. + * + * Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` + */ void sp_cmd_cp437_grid_set_origin(Cp437GridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); @@ -1367,6 +1394,15 @@ void sp_cmd_generic_free(SPCommand command); */ Packet *sp_cmd_generic_into_packet(SPCommand command); +/** + * Tries to turn a [Packet] into a [TypedCommand]. + * + * The packet is deallocated in the process. + * + * Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. + */ +SPCommand *sp_cmd_generic_try_from_packet(Packet */*notnull*/ packet); + void sp_cmd_hard_reset_free(ClearCommand */*notnull*/ command); /** @@ -1585,7 +1621,7 @@ UdpSocket *sp_udp_open_ipv4(uint8_t ip1, uint16_t port); /** - * Sends a [TypedCommand] to the display using the [UdpSocket]. + * Sends a [SPCommand] to the display using the [UdpSocket]. * * The passed `command` gets consumed. * diff --git a/src/bitvec.rs b/src/bitvec.rs index 1ba49a7..ec5aa4c 100644 --- a/src/bitvec.rs +++ b/src/bitvec.rs @@ -7,13 +7,13 @@ use servicepoint::{ }; use std::ptr::NonNull; -/// Creates a new [SPBitVec] instance. +/// Creates a new [DisplayBitVec] instance. /// /// # Arguments /// /// - `size`: size in bits. /// -/// returns: [SPBitVec] with all bits set to false. +/// returns: [DisplayBitVec] with all bits set to false. /// /// # Panics /// @@ -23,9 +23,9 @@ pub unsafe extern "C" fn sp_bitvec_new(size: usize) -> NonNull { heap_move_nonnull(DisplayBitVec::repeat(false, size)) } -/// Interpret the data as a series of bits and load then into a new [SPBitVec] instance. +/// Interpret the data as a series of bits and load then into a new [DisplayBitVec] instance. /// -/// returns: [SPBitVec] instance containing data. +/// returns: [DisplayBitVec] instance containing data. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_load( data: ByteSlice, @@ -34,7 +34,7 @@ pub unsafe extern "C" fn sp_bitvec_load( heap_move_nonnull(DisplayBitVec::from_slice(data)) } -/// Clones a [SPBitVec]. +/// Clones a [DisplayBitVec]. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_clone( bit_vec: NonNull, @@ -42,13 +42,13 @@ pub unsafe extern "C" fn sp_bitvec_clone( unsafe { heap_clone(bit_vec) } } -/// Deallocates a [SPBitVec]. +/// Deallocates a [DisplayBitVec]. #[no_mangle] pub unsafe extern "C" fn sp_bitvec_free(bit_vec: NonNull) { unsafe { heap_drop(bit_vec) } } -/// Gets the value of a bit from the [SPBitVec]. +/// Gets the value of a bit from the [DisplayBitVec]. /// /// # Arguments /// @@ -68,7 +68,7 @@ pub unsafe extern "C" fn sp_bitvec_get( unsafe { *bit_vec.as_ref().get(index).unwrap() } } -/// Sets the value of a bit in the [SPBitVec]. +/// Sets the value of a bit in the [DisplayBitVec]. /// /// # Arguments /// @@ -88,7 +88,7 @@ pub unsafe extern "C" fn sp_bitvec_set( unsafe { (*bit_vec.as_ptr()).set(index, value) } } -/// Sets the value of all bits in the [SPBitVec]. +/// Sets the value of all bits in the [DisplayBitVec]. /// /// # Arguments /// @@ -102,7 +102,7 @@ pub unsafe extern "C" fn sp_bitvec_fill( unsafe { (*bit_vec.as_ptr()).fill(value) } } -/// Gets the length of the [SPBitVec] in bits. +/// Gets the length of the [DisplayBitVec] in bits. /// /// # Arguments /// @@ -126,7 +126,7 @@ pub unsafe extern "C" fn sp_bitvec_is_empty( unsafe { bit_vec.as_ref().is_empty() } } -/// Gets an unsafe reference to the data of the [SPBitVec] instance. +/// Gets an unsafe reference to the data of the [DisplayBitVec] instance. /// /// The returned memory is valid for the lifetime of the bitvec. /// @@ -142,7 +142,7 @@ pub unsafe extern "C" fn sp_bitvec_unsafe_data_ref( /// Creates a [BitVecCommand] and immediately turns that into a [Packet]. /// -/// The provided [SPBitVec] gets consumed. +/// The provided [DisplayBitVec] gets consumed. /// /// Returns NULL in case of an error. #[no_mangle] diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs index b2ff3d8..2adf9a8 100644 --- a/src/commands/bitmap_command.rs +++ b/src/commands/bitmap_command.rs @@ -26,7 +26,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_new( /// Move the provided [Bitmap] into a new [BitmapCommand], /// leaving other fields as their default values. /// -/// Rust equivalent: [`>::from`] +/// Rust equivalent: `BitmapCommand::from(bitmap)` #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_from_bitmap( bitmap: NonNull, diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs index 1e1598a..2ccb000 100644 --- a/src/commands/cp437_grid_command.rs +++ b/src/commands/cp437_grid_command.rs @@ -46,7 +46,9 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_free( unsafe { heap_drop(command) } } -/// Moves the provided bitmap to be contained in the command. +/// Moves the provided bitmap into the provided command. +/// +/// This drops the previously contained [Cp437Grid]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_set( mut command: NonNull, @@ -64,6 +66,9 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_get( &mut unsafe { command.as_mut() }.grid } +/// Gets the origin field of the [Cp437GridCommand]. +/// +/// Rust equivalent: `cp437_command.origin` #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_get_origin( command: NonNull, @@ -77,6 +82,10 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_get_origin( } } + +/// Sets the origin field of the [Cp437GridCommand]. +/// +/// Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_set_origin( mut command: NonNull, diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs index e3da8fd..561d041 100644 --- a/src/commands/generic_command.rs +++ b/src/commands/generic_command.rs @@ -8,7 +8,9 @@ use servicepoint::{ }; use std::ptr::{null_mut, NonNull}; +/// Pointer to one of the available command structs. #[repr(C)] +#[allow(missing_docs)] pub union CommandUnion { pub null: *mut u8, pub bitmap: NonNull, @@ -24,7 +26,11 @@ pub union CommandUnion { pub fade_out: NonNull, } +/// Specifies the kind of command struct. +/// +/// This is _not_ equivalent to the [servicepoint::CommandCode]s. #[repr(u8)] +#[allow(missing_docs)] pub enum CommandTag { Invalid = 0, Bitmap, @@ -39,6 +45,11 @@ pub enum CommandTag { BitmapLegacy, } +/// This struct represents a pointer to one of the possible command structs. +/// +/// Only ever access `data` with the correct data type as specified by `tag`! +/// +/// Rust equivalent: [TypedCommand]. #[repr(C)] pub struct SPCommand { /// Specifies which kind of command struct is contained in `data` @@ -59,7 +70,7 @@ impl SPCommand { /// The packet is deallocated in the process. /// /// Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. -/// #[no_mangle] +#[no_mangle] pub unsafe extern "C" fn sp_cmd_generic_try_from_packet( packet: NonNull, ) -> *mut SPCommand { diff --git a/src/udp.rs b/src/udp.rs index 7b659cf..4f778b0 100644 --- a/src/udp.rs +++ b/src/udp.rs @@ -62,7 +62,7 @@ pub unsafe extern "C" fn sp_udp_send_packet( unsafe { connection.as_ref().send(&Vec::from(packet)) }.is_ok() } -/// Sends a [TypedCommand] to the display using the [UdpSocket]. +/// Sends a [SPCommand] to the display using the [UdpSocket]. /// /// The passed `command` gets consumed. /// From cf6e6385ec502788a0ce2cb6973189f6dd525336 Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Wed, 7 May 2025 08:43:13 +0200 Subject: [PATCH 2/5] move containers to own mod --- src/commands/cp437_grid_command.rs | 1 - src/commands/generic_command.rs | 6 +++--- src/{ => containers}/bitmap.rs | 8 ++++++-- src/{ => containers}/bitvec.rs | 2 +- src/{ => containers}/brightness_grid.rs | 2 +- src/{ => containers}/byte_slice.rs | 0 src/{ => containers}/char_grid.rs | 2 +- src/{ => containers}/cp437_grid.rs | 2 +- src/containers/mod.rs | 13 +++++++++++++ src/lib.rs | 7 +------ src/packet.rs | 2 +- 11 files changed, 28 insertions(+), 17 deletions(-) rename src/{ => containers}/bitmap.rs (95%) rename src/{ => containers}/bitvec.rs (98%) rename src/{ => containers}/brightness_grid.rs (98%) rename src/{ => containers}/byte_slice.rs (100%) rename src/{ => containers}/char_grid.rs (98%) rename src/{ => containers}/cp437_grid.rs (98%) create mode 100644 src/containers/mod.rs diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs index 2ccb000..eb42d15 100644 --- a/src/commands/cp437_grid_command.rs +++ b/src/commands/cp437_grid_command.rs @@ -82,7 +82,6 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_get_origin( } } - /// Sets the origin field of the [Cp437GridCommand]. /// /// Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs index 561d041..2b5327d 100644 --- a/src/commands/generic_command.rs +++ b/src/commands/generic_command.rs @@ -2,9 +2,9 @@ use crate::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ - BitVecCommand, BitmapCommand, BrightnessGridCommand, - CharGridCommand, ClearCommand, Cp437GridCommand, FadeOutCommand, - GlobalBrightnessCommand, HardResetCommand, Packet, TypedCommand, + BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand, + ClearCommand, Cp437GridCommand, FadeOutCommand, GlobalBrightnessCommand, + HardResetCommand, Packet, TypedCommand, }; use std::ptr::{null_mut, NonNull}; diff --git a/src/bitmap.rs b/src/containers/bitmap.rs similarity index 95% rename from src/bitmap.rs rename to src/containers/bitmap.rs index 3393671..f928596 100644 --- a/src/bitmap.rs +++ b/src/containers/bitmap.rs @@ -1,6 +1,10 @@ -use crate::{byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove}; +use crate::{ + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + heap_move_ok, heap_move_some, heap_remove, +}; use servicepoint::{ - Bitmap, BitmapCommand, CompressionCode, DataRef, Grid, Origin, Packet, DisplayBitVec + Bitmap, BitmapCommand, CompressionCode, DataRef, DisplayBitVec, Grid, + Origin, Packet, }; use std::ptr::NonNull; diff --git a/src/bitvec.rs b/src/containers/bitvec.rs similarity index 98% rename from src/bitvec.rs rename to src/containers/bitvec.rs index ec5aa4c..fd1132d 100644 --- a/src/bitvec.rs +++ b/src/containers/bitvec.rs @@ -1,5 +1,5 @@ use crate::{ - byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ diff --git a/src/brightness_grid.rs b/src/containers/brightness_grid.rs similarity index 98% rename from src/brightness_grid.rs rename to src/containers/brightness_grid.rs index dc3b2f7..b6b3f04 100644 --- a/src/brightness_grid.rs +++ b/src/containers/brightness_grid.rs @@ -1,5 +1,5 @@ use crate::{ - byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove, }; use servicepoint::{ diff --git a/src/byte_slice.rs b/src/containers/byte_slice.rs similarity index 100% rename from src/byte_slice.rs rename to src/containers/byte_slice.rs diff --git a/src/char_grid.rs b/src/containers/char_grid.rs similarity index 98% rename from src/char_grid.rs rename to src/containers/char_grid.rs index 62aba87..4e11e19 100644 --- a/src/char_grid.rs +++ b/src/containers/char_grid.rs @@ -1,5 +1,5 @@ use crate::{ - byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{CharGrid, CharGridCommand, Grid, Origin, Packet}; diff --git a/src/cp437_grid.rs b/src/containers/cp437_grid.rs similarity index 98% rename from src/cp437_grid.rs rename to src/containers/cp437_grid.rs index b4d449e..3d3885a 100644 --- a/src/cp437_grid.rs +++ b/src/containers/cp437_grid.rs @@ -1,5 +1,5 @@ use crate::{ - byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove, }; use servicepoint::{ diff --git a/src/containers/mod.rs b/src/containers/mod.rs new file mode 100644 index 0000000..62d51d0 --- /dev/null +++ b/src/containers/mod.rs @@ -0,0 +1,13 @@ +mod bitmap; +mod bitvec; +mod brightness_grid; +mod byte_slice; +mod char_grid; +mod cp437_grid; + +pub use bitmap::*; +pub use bitvec::*; +pub use brightness_grid::*; +pub use byte_slice::*; +pub use char_grid::*; +pub use cp437_grid::*; diff --git a/src/lib.rs b/src/lib.rs index de22866..8196e3b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -27,13 +27,8 @@ use std::ptr::NonNull; -pub mod bitmap; -pub mod bitvec; -pub mod brightness_grid; -pub mod byte_slice; -pub mod char_grid; pub mod commands; -pub mod cp437_grid; +pub mod containers; pub mod packet; pub mod udp; diff --git a/src/packet.rs b/src/packet.rs index 16509be..a6fde16 100644 --- a/src/packet.rs +++ b/src/packet.rs @@ -1,5 +1,5 @@ use crate::{ - byte_slice::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, + containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, }; use servicepoint::{CommandCode, Header, Packet}; From 626a887480c3e823323f51d82713c830d754f5b6 Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Wed, 7 May 2025 08:53:49 +0200 Subject: [PATCH 3/5] move heap functions to own mod --- src/commands/bitmap_command.rs | 2 +- src/commands/bitvec_command.rs | 2 +- src/commands/brightness_grid_command.rs | 2 +- src/commands/cc_only_commands.rs | 2 +- src/commands/char_grid_command.rs | 2 +- src/commands/cp437_grid_command.rs | 2 +- src/commands/generic_command.rs | 22 ++++++++-------- src/commands/global_brightness_command.rs | 2 +- src/containers/bitmap.rs | 7 +++-- src/containers/bitvec.rs | 6 +++-- src/containers/brightness_grid.rs | 7 +++-- src/containers/char_grid.rs | 6 +++-- src/containers/cp437_grid.rs | 7 +++-- src/lib.rs | 31 +---------------------- src/mem.rs | 29 +++++++++++++++++++++ src/packet.rs | 4 +-- src/udp.rs | 14 ++++++---- 17 files changed, 82 insertions(+), 65 deletions(-) create mode 100644 src/mem.rs diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs index 2adf9a8..d67a59f 100644 --- a/src/commands/bitmap_command.rs +++ b/src/commands/bitmap_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{Bitmap, BitmapCommand, CompressionCode, Origin, Packet}; diff --git a/src/commands/bitvec_command.rs b/src/commands/bitvec_command.rs index bfe2d33..a717e0c 100644 --- a/src/commands/bitvec_command.rs +++ b/src/commands/bitvec_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ diff --git a/src/commands/brightness_grid_command.rs b/src/commands/brightness_grid_command.rs index bd975d6..ac4b302 100644 --- a/src/commands/brightness_grid_command.rs +++ b/src/commands/brightness_grid_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ diff --git a/src/commands/cc_only_commands.rs b/src/commands/cc_only_commands.rs index 751a6ab..ca24f7d 100644 --- a/src/commands/cc_only_commands.rs +++ b/src/commands/cc_only_commands.rs @@ -1,4 +1,4 @@ -use crate::{heap_drop, heap_move_nonnull}; +use crate::mem::{heap_drop, heap_move_nonnull}; use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand}; use std::ptr::NonNull; diff --git a/src/commands/char_grid_command.rs b/src/commands/char_grid_command.rs index bc078cd..d3f6816 100644 --- a/src/commands/char_grid_command.rs +++ b/src/commands/char_grid_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{BitmapCommand, CharGrid, CharGridCommand, Origin, Packet}; diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs index eb42d15..2ab4e54 100644 --- a/src/commands/cp437_grid_command.rs +++ b/src/commands/cp437_grid_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs index 2b5327d..59eb8f8 100644 --- a/src/commands/generic_command.rs +++ b/src/commands/generic_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ @@ -65,11 +65,11 @@ impl SPCommand { }; } -/// Tries to turn a [Packet] into a [TypedCommand]. +/// Tries to turn a [Packet] into a [SPCommand]. /// -/// The packet is deallocated in the process. +/// The packet is dropped in the process. /// -/// Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. +/// Returns: pointer to new [SPCommand] instance or NULL if parsing failed. #[no_mangle] pub unsafe extern "C" fn sp_cmd_generic_try_from_packet( packet: NonNull, @@ -142,9 +142,9 @@ pub unsafe extern "C" fn sp_cmd_generic_try_from_packet( })) } -/// Clones a [SPCommand] instance. +/// Clones an [SPCommand] instance. /// -/// returns: new [SPCommand] instance. +/// returns: a new [SPCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand { unsafe { @@ -217,12 +217,12 @@ pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand { } } -/// Deallocates a [SPCommand]. +/// Deallocates an [SPCommand]. /// /// # Examples /// /// ```C -/// TypedCommand c = sp_command_clear(); +/// SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); /// sp_command_free(c); /// ``` #[no_mangle] @@ -248,10 +248,10 @@ pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) { } } -/// Turns a [TypedCommand] into a [Packet]. -/// The [TypedCommand] gets consumed. +/// Tries to turn a [SPCommand] into a [Packet]. +/// The [SPCommand] gets consumed. /// -/// Returns NULL in case of an error. +/// Returns tag [CommandTag::Invalid] in case of an error. #[no_mangle] pub unsafe extern "C" fn sp_cmd_generic_into_packet( command: SPCommand, diff --git a/src/commands/global_brightness_command.rs b/src/commands/global_brightness_command.rs index 29e7c19..9d1690c 100644 --- a/src/commands/global_brightness_command.rs +++ b/src/commands/global_brightness_command.rs @@ -1,4 +1,4 @@ -use crate::{ +use crate::mem::{ heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, }; use servicepoint::{ diff --git a/src/containers/bitmap.rs b/src/containers/bitmap.rs index f928596..7a1b633 100644 --- a/src/containers/bitmap.rs +++ b/src/containers/bitmap.rs @@ -1,6 +1,9 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, heap_move_some, heap_remove, + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, }; use servicepoint::{ Bitmap, BitmapCommand, CompressionCode, DataRef, DisplayBitVec, Grid, diff --git a/src/containers/bitvec.rs b/src/containers/bitvec.rs index fd1132d..e9eeb68 100644 --- a/src/containers/bitvec.rs +++ b/src/containers/bitvec.rs @@ -1,6 +1,8 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, heap_remove, + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, + }, }; use servicepoint::{ BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Packet, diff --git a/src/containers/brightness_grid.rs b/src/containers/brightness_grid.rs index b6b3f04..3a7ae5f 100644 --- a/src/containers/brightness_grid.rs +++ b/src/containers/brightness_grid.rs @@ -1,6 +1,9 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, heap_move_some, heap_remove, + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, }; use servicepoint::{ Brightness, BrightnessGrid, BrightnessGridCommand, ByteGrid, DataRef, Grid, diff --git a/src/containers/char_grid.rs b/src/containers/char_grid.rs index 4e11e19..3363d43 100644 --- a/src/containers/char_grid.rs +++ b/src/containers/char_grid.rs @@ -1,6 +1,8 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, heap_remove, + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, + }, }; use servicepoint::{CharGrid, CharGridCommand, Grid, Origin, Packet}; use std::ptr::NonNull; diff --git a/src/containers/cp437_grid.rs b/src/containers/cp437_grid.rs index 3d3885a..a636295 100644 --- a/src/containers/cp437_grid.rs +++ b/src/containers/cp437_grid.rs @@ -1,6 +1,9 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, heap_move_some, heap_remove, + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, }; use servicepoint::{ Cp437Grid, Cp437GridCommand, DataRef, Grid, Origin, Packet, diff --git a/src/lib.rs b/src/lib.rs index 8196e3b..14b172d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,10 +25,9 @@ //! } //! ``` -use std::ptr::NonNull; - pub mod commands; pub mod containers; +pub mod mem; pub mod packet; pub mod udp; @@ -37,34 +36,6 @@ use std::time::Duration; /// Actual hardware limit is around 28-29ms/frame. Rounded up for less dropped packets. pub const SP_FRAME_PACING_MS: u128 = Duration::from_millis(30).as_millis(); -pub(crate) fn heap_move(x: T) -> *mut T { - Box::into_raw(Box::new(x)) -} - -pub(crate) fn heap_move_nonnull(x: T) -> NonNull { - NonNull::from(Box::leak(Box::new(x))) -} - -pub(crate) fn heap_move_ok(x: Result) -> *mut T { - x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) -} - -pub(crate) fn heap_move_some(x: Option) -> *mut T { - x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) -} - -pub(crate) unsafe fn heap_drop(x: NonNull) { - drop(unsafe { heap_remove(x) }); -} - -pub(crate) unsafe fn heap_remove(x: NonNull) -> T { - unsafe { *Box::from_raw(x.as_ptr()) } -} - -unsafe fn heap_clone(source: NonNull) -> NonNull { - heap_move_nonnull(unsafe { source.as_ref().clone() }) -} - /// This is a type only used by cbindgen to have a type for pointers. pub struct UdpSocket; diff --git a/src/mem.rs b/src/mem.rs new file mode 100644 index 0000000..6555999 --- /dev/null +++ b/src/mem.rs @@ -0,0 +1,29 @@ +use std::ptr::NonNull; + +pub(crate) fn heap_move(x: T) -> *mut T { + Box::into_raw(Box::new(x)) +} + +pub(crate) fn heap_move_nonnull(x: T) -> NonNull { + NonNull::from(Box::leak(Box::new(x))) +} + +pub(crate) fn heap_move_ok(x: Result) -> *mut T { + x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) +} + +pub(crate) fn heap_move_some(x: Option) -> *mut T { + x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) +} + +pub(crate) unsafe fn heap_drop(x: NonNull) { + drop(unsafe { heap_remove(x) }); +} + +pub(crate) unsafe fn heap_remove(x: NonNull) -> T { + unsafe { *Box::from_raw(x.as_ptr()) } +} + +pub(crate) unsafe fn heap_clone(source: NonNull) -> NonNull { + heap_move_nonnull(unsafe { source.as_ref().clone() }) +} diff --git a/src/packet.rs b/src/packet.rs index a6fde16..5fe7572 100644 --- a/src/packet.rs +++ b/src/packet.rs @@ -1,6 +1,6 @@ use crate::{ - containers::ByteSlice, heap_clone, heap_drop, heap_move_nonnull, - heap_move_ok, + containers::ByteSlice, + mem::{heap_clone, heap_drop, heap_move_nonnull, heap_move_ok}, }; use servicepoint::{CommandCode, Header, Packet}; use std::ptr::NonNull; diff --git a/src/udp.rs b/src/udp.rs index 4f778b0..7c2ab2f 100644 --- a/src/udp.rs +++ b/src/udp.rs @@ -1,9 +1,13 @@ -use crate::commands::{CommandTag, SPCommand}; -use crate::{heap_drop, heap_move_ok, heap_remove}; +use crate::{ + commands::{CommandTag, SPCommand}, + mem::{heap_drop, heap_move_ok, heap_remove}, +}; use servicepoint::{Header, Packet, UdpSocketExt}; -use std::ffi::{c_char, CStr}; -use std::net::{Ipv4Addr, SocketAddrV4, UdpSocket}; -use std::ptr::NonNull; +use std::{ + ffi::{c_char, CStr}, + net::{Ipv4Addr, SocketAddrV4, UdpSocket}, + ptr::NonNull, +}; /// Creates a new instance of [UdpSocket]. /// From 36f3d84dc8e8f9aa07b384a5e98d4a0303876abe Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Wed, 7 May 2025 22:27:06 +0200 Subject: [PATCH 4/5] a bunch of docs --- cbindgen.toml | 4 +- include/servicepoint.h | 175 ++++++++++++++++------ src/commands/bitmap_command.rs | 3 + src/commands/bitvec_command.rs | 4 + src/commands/brightness_grid_command.rs | 11 ++ src/commands/cc_only_commands.rs | 9 +- src/commands/char_grid_command.rs | 11 ++ src/commands/cp437_grid_command.rs | 17 +++ src/commands/generic_command.rs | 29 ++-- src/commands/global_brightness_command.rs | 14 +- src/lib.rs | 6 +- src/packet.rs | 2 + 12 files changed, 215 insertions(+), 70 deletions(-) diff --git a/cbindgen.toml b/cbindgen.toml index 4aabb7e..7841755 100644 --- a/cbindgen.toml +++ b/cbindgen.toml @@ -35,8 +35,8 @@ include = [] exclude = ["BitVec"] [export.rename] -"SpByteSlice" = "ByteSlice" -"SpCommand" = "Command" +"SPCommand" = "Command" +"DisplayBitVec" = "BitVec" [enum] rename_variants = "QualifiedScreamingSnakeCase" diff --git a/include/servicepoint.h b/include/servicepoint.h index 131fe41..a5b3ac7 100644 --- a/include/servicepoint.h +++ b/include/servicepoint.h @@ -346,7 +346,7 @@ typedef struct Cp437GridCommand Cp437GridCommand; /** * This is a type only used by cbindgen to have a type for pointers. */ -typedef struct DisplayBitVec DisplayBitVec; +typedef struct BitVec BitVec; /** *
Untested
@@ -569,7 +569,7 @@ typedef struct { * The pointer to the command struct */ CommandUnion data; -} SPCommand; +} Command; /** * A raw header. @@ -637,7 +637,7 @@ void sp_bitmap_free(Bitmap */*notnull*/ bitmap); * * Returns NULL in case of error. */ -Bitmap *sp_bitmap_from_bitvec(size_t width, DisplayBitVec */*notnull*/ bitvec); +Bitmap *sp_bitmap_from_bitvec(size_t width, BitVec */*notnull*/ bitvec); /** * Gets the current value at the specified position in the [Bitmap]. @@ -665,7 +665,7 @@ size_t sp_bitmap_height(Bitmap */*notnull*/ bitmap); /** * Consumes the Bitmap and returns the contained BitVec */ -DisplayBitVec */*notnull*/ sp_bitmap_into_bitvec(Bitmap */*notnull*/ bitmap); +BitVec */*notnull*/ sp_bitmap_into_bitvec(Bitmap */*notnull*/ bitmap); /** * Creates a [BitmapCommand] and immediately turns that into a [Packet]. @@ -771,7 +771,7 @@ size_t sp_bitmap_width(Bitmap */*notnull*/ bitmap); /** * Clones a [DisplayBitVec]. */ -DisplayBitVec */*notnull*/ sp_bitvec_clone(DisplayBitVec */*notnull*/ bit_vec); +BitVec */*notnull*/ sp_bitvec_clone(BitVec */*notnull*/ bit_vec); /** * Sets the value of all bits in the [DisplayBitVec]. @@ -781,12 +781,12 @@ DisplayBitVec */*notnull*/ sp_bitvec_clone(DisplayBitVec */*notnull*/ bit_vec); * - `bit_vec`: instance to write to * - `value`: the value to set all bits to */ -void sp_bitvec_fill(DisplayBitVec */*notnull*/ bit_vec, bool value); +void sp_bitvec_fill(BitVec */*notnull*/ bit_vec, bool value); /** * Deallocates a [DisplayBitVec]. */ -void sp_bitvec_free(DisplayBitVec */*notnull*/ bit_vec); +void sp_bitvec_free(BitVec */*notnull*/ bit_vec); /** * Gets the value of a bit from the [DisplayBitVec]. @@ -802,7 +802,7 @@ void sp_bitvec_free(DisplayBitVec */*notnull*/ bit_vec); * * - when accessing `index` out of bounds */ -bool sp_bitvec_get(DisplayBitVec */*notnull*/ bit_vec, size_t index); +bool sp_bitvec_get(BitVec */*notnull*/ bit_vec, size_t index); /** * Creates a [BitVecCommand] and immediately turns that into a [Packet]. @@ -811,7 +811,7 @@ bool sp_bitvec_get(DisplayBitVec */*notnull*/ bit_vec, size_t index); * * Returns NULL in case of an error. */ -Packet *sp_bitvec_into_packet(DisplayBitVec */*notnull*/ bitvec, +Packet *sp_bitvec_into_packet(BitVec */*notnull*/ bitvec, size_t offset, BinaryOperation operation, CompressionCode compression); @@ -823,7 +823,7 @@ Packet *sp_bitvec_into_packet(DisplayBitVec */*notnull*/ bitvec, * * - `bit_vec`: instance to write to */ -bool sp_bitvec_is_empty(DisplayBitVec */*notnull*/ bit_vec); +bool sp_bitvec_is_empty(BitVec */*notnull*/ bit_vec); /** * Gets the length of the [DisplayBitVec] in bits. @@ -832,14 +832,14 @@ bool sp_bitvec_is_empty(DisplayBitVec */*notnull*/ bit_vec); * * - `bit_vec`: instance to write to */ -size_t sp_bitvec_len(DisplayBitVec */*notnull*/ bit_vec); +size_t sp_bitvec_len(BitVec */*notnull*/ bit_vec); /** * Interpret the data as a series of bits and load then into a new [DisplayBitVec] instance. * * returns: [DisplayBitVec] instance containing data. */ -DisplayBitVec */*notnull*/ sp_bitvec_load(ByteSlice data); +BitVec */*notnull*/ sp_bitvec_load(ByteSlice data); /** * Creates a new [DisplayBitVec] instance. @@ -854,7 +854,7 @@ DisplayBitVec */*notnull*/ sp_bitvec_load(ByteSlice data); * * - when `size` is not divisible by 8. */ -DisplayBitVec */*notnull*/ sp_bitvec_new(size_t size); +BitVec */*notnull*/ sp_bitvec_new(size_t size); /** * Sets the value of a bit in the [DisplayBitVec]. @@ -869,9 +869,7 @@ DisplayBitVec */*notnull*/ sp_bitvec_new(size_t size); * * - when accessing `index` out of bounds */ -void sp_bitvec_set(DisplayBitVec */*notnull*/ bit_vec, - size_t index, - bool value); +void sp_bitvec_set(BitVec */*notnull*/ bit_vec, size_t index, bool value); /** * Gets an unsafe reference to the data of the [DisplayBitVec] instance. @@ -882,7 +880,7 @@ void sp_bitvec_set(DisplayBitVec */*notnull*/ bit_vec, * * - `bit_vec`: instance to write to */ -ByteSlice sp_bitvec_unsafe_data_ref(DisplayBitVec */*notnull*/ bit_vec); +ByteSlice sp_bitvec_unsafe_data_ref(BitVec */*notnull*/ bit_vec); /** * Clones a [BrightnessGrid]. @@ -1126,6 +1124,11 @@ void sp_char_grid_set(CharGrid */*notnull*/ char_grid, */ size_t sp_char_grid_width(CharGrid */*notnull*/ char_grid); +/** + * Clones an [BitmapCommand] instance. + * + * returns: a new [BitmapCommand] instance. + */ BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(BitmapCommand */*notnull*/ command); void sp_cmd_bitmap_free(BitmapCommand */*notnull*/ command); @@ -1181,11 +1184,19 @@ void sp_cmd_bitmap_set_origin(BitmapCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Clones an [BitVecCommand] instance. + * + * returns: a new [BitVecCommand] instance. + */ BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(BitVecCommand */*notnull*/ command); +/** + * Deallocates a [BitVecCommand]. + */ void sp_cmd_bitvec_free(BitVecCommand */*notnull*/ command); -DisplayBitVec *sp_cmd_bitvec_get(BitVecCommand */*notnull*/ command); +BitVec *sp_cmd_bitvec_get(BitVecCommand */*notnull*/ command); CompressionCode sp_cmd_bitvec_get_compression(BitVecCommand */*notnull*/ command); @@ -1209,7 +1220,7 @@ Packet *sp_cmd_bitvec_into_packet(BitVecCommand */*notnull*/ command); * * The contained [`DisplayBitVec`] is always uncompressed. */ -BitVecCommand */*notnull*/ sp_cmd_bitvec_new(DisplayBitVec */*notnull*/ bitvec, +BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec, size_t offset, BinaryOperation operation, CompressionCode compression); @@ -1218,7 +1229,7 @@ BitVecCommand */*notnull*/ sp_cmd_bitvec_new(DisplayBitVec */*notnull*/ bitvec, * Moves the provided bitmap to be contained in the command. */ void sp_cmd_bitvec_set(BitVecCommand */*notnull*/ command, - DisplayBitVec */*notnull*/ bitvec); + BitVec */*notnull*/ bitvec); void sp_cmd_bitvec_set_compression(BitVecCommand */*notnull*/ command, CompressionCode compression); @@ -1229,14 +1240,24 @@ void sp_cmd_bitvec_set_offset(BitVecCommand */*notnull*/ command, void sp_cmd_bitvec_set_operation(BitVecCommand */*notnull*/ command, BinaryOperation operation); +/** + * Clones an [GlobalBrightnessCommand] instance. + * + * returns: a new [GlobalBrightnessCommand] instance. + */ GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_clone(GlobalBrightnessCommand */*notnull*/ command); void sp_cmd_brightness_global_free(BitmapCommand */*notnull*/ command); Brightness *sp_cmd_brightness_global_get(GlobalBrightnessCommand */*notnull*/ command); -Packet *sp_cmd_brightness_global_into_packet(GlobalBrightnessCommand */*notnull*/ command); +Packet */*notnull*/ sp_cmd_brightness_global_into_packet(GlobalBrightnessCommand */*notnull*/ command); +/** + * Set the brightness of all tiles to the same value. + * + * Returns: a new [GlobalBrightnessCommand] instance. + */ GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_new(Brightness brightness); /** @@ -1245,10 +1266,22 @@ GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_new(Brightness bri void sp_cmd_brightness_global_set(GlobalBrightnessCommand */*notnull*/ command, Brightness brightness); +/** + * Clones an [BrightnessGridCommand] instance. + * + * returns: a new [BrightnessGridCommand] instance. + */ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_clone(BrightnessGridCommand */*notnull*/ command); +/** + * Deallocates a [BitmapCommand]. + */ void sp_cmd_brightness_grid_free(BitmapCommand */*notnull*/ command); +/** + * Moves the provided [BrightnessGrid] into a new [BrightnessGridCommand], + * leaving other fields as their default values. + */ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid); BrightnessGrid *sp_cmd_brightness_grid_get(BrightnessGridCommand */*notnull*/ command); @@ -1259,6 +1292,13 @@ void sp_cmd_brightness_grid_get_origin(BrightnessGridCommand */*notnull*/ comman Packet *sp_cmd_brightness_grid_into_packet(BrightnessGridCommand */*notnull*/ command); +/** + * Set the brightness of individual tiles in a rectangular area of the display. + * + * The passed [BrightnessGrid] gets consumed. + * + * Returns: a new [BrightnessGridCommand] instance. + */ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessGrid */*notnull*/ grid, size_t origin_x, size_t origin_y); @@ -1273,10 +1313,22 @@ void sp_cmd_brightness_grid_set_origin(BrightnessGridCommand */*notnull*/ comman size_t origin_x, size_t origin_y); +/** + * Clones an [CharGridCommand] instance. + * + * returns: a new [CharGridCommand] instance. + */ CharGridCommand */*notnull*/ sp_cmd_char_grid_clone(CharGridCommand */*notnull*/ command); +/** + * Deallocates a [BitmapCommand]. + */ void sp_cmd_char_grid_free(BitmapCommand */*notnull*/ command); +/** + * Moves the provided [CharGrid] into a new [CharGridCommand], + * leaving other fields as their default values. + */ CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid); CharGrid *sp_cmd_char_grid_get(CharGridCommand */*notnull*/ command); @@ -1287,6 +1339,13 @@ void sp_cmd_char_grid_get_origin(CharGridCommand */*notnull*/ command, Packet *sp_cmd_char_grid_into_packet(CharGridCommand */*notnull*/ command); +/** + * Show UTF-8 encoded text on the screen. + * + * The passed [CharGrid] gets consumed. + * + * Returns: a new [CharGridCommand] instance. + */ CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ grid, size_t origin_x, size_t origin_y); @@ -1301,6 +1360,9 @@ void sp_cmd_char_grid_set_origin(CharGridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Deallocates a [ClearCommand]. + */ void sp_cmd_clear_free(ClearCommand */*notnull*/ command); /** @@ -1309,21 +1371,35 @@ void sp_cmd_clear_free(ClearCommand */*notnull*/ command); * Does not affect brightness. * * Returns: a new [ClearCommand] instance. - * - * # Examples - * - * ```C - * sp_udp_send_command(connection, sp_cmd_clear()); - * ``` */ ClearCommand */*notnull*/ sp_cmd_clear_new(void); +/** + * Clones an [Cp437GridCommand] instance. + * + * returns: a new [Cp437GridCommand] instance. + */ Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_clone(Cp437GridCommand */*notnull*/ command); +/** + * Deallocates a [Cp437GridCommand]. + */ void sp_cmd_cp437_grid_free(BitmapCommand */*notnull*/ command); +/** + * Moves the provided [Cp437Grid] into a new [Cp437GridCommand], + * leaving other fields as their default values. + */ Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_from_grid(Cp437Grid */*notnull*/ grid); +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of [CP-437] encoded characters. + * For sending UTF-8 encoded characters, see [servicepoint::CharGridCommand]. + * + * [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 + */ Cp437Grid *sp_cmd_cp437_grid_get(Cp437GridCommand */*notnull*/ command); /** @@ -1337,6 +1413,13 @@ void sp_cmd_cp437_grid_get_origin(Cp437GridCommand */*notnull*/ command, Packet *sp_cmd_cp437_grid_into_packet(Cp437GridCommand */*notnull*/ command); +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of [CP-437] encoded characters. + * + * The origin is relative to the top-left of the display. + */ Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_new(Cp437Grid */*notnull*/ grid, size_t origin_x, size_t origin_y); @@ -1358,6 +1441,9 @@ void sp_cmd_cp437_grid_set_origin(Cp437GridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Deallocates a [FadeOutCommand]. + */ void sp_cmd_fade_out_free(ClearCommand */*notnull*/ command); /** @@ -1368,41 +1454,44 @@ void sp_cmd_fade_out_free(ClearCommand */*notnull*/ command); FadeOutCommand */*notnull*/ sp_cmd_fade_out_new(void); /** - * Clones a [SPCommand] instance. + * Clones an [SPCommand] instance. * - * returns: new [SPCommand] instance. + * returns: a new [SPCommand] instance. */ -SPCommand sp_cmd_generic_clone(SPCommand command); +Command sp_cmd_generic_clone(Command command); /** - * Deallocates a [SPCommand]. + * Deallocates an [SPCommand]. * * # Examples * * ```C - * TypedCommand c = sp_command_clear(); + * SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); * sp_command_free(c); * ``` */ -void sp_cmd_generic_free(SPCommand command); +void sp_cmd_generic_free(Command command); /** - * Turns a [TypedCommand] into a [Packet]. - * The [TypedCommand] gets consumed. + * Tries to turn a [SPCommand] into a [Packet]. + * The [SPCommand] gets consumed. * - * Returns NULL in case of an error. + * Returns tag [CommandTag::Invalid] in case of an error. */ -Packet *sp_cmd_generic_into_packet(SPCommand command); +Packet *sp_cmd_generic_into_packet(Command command); /** - * Tries to turn a [Packet] into a [TypedCommand]. + * Tries to turn a [Packet] into a [SPCommand]. * - * The packet is deallocated in the process. + * The packet is dropped in the process. * - * Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. + * Returns: pointer to new [SPCommand] instance or NULL if parsing failed. */ -SPCommand *sp_cmd_generic_try_from_packet(Packet */*notnull*/ packet); +Command *sp_cmd_generic_try_from_packet(Packet */*notnull*/ packet); +/** + * Deallocates a [HardResetCommand]. + */ void sp_cmd_hard_reset_free(ClearCommand */*notnull*/ command); /** @@ -1520,6 +1609,8 @@ size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ cp437_grid); /** * Clones a [Packet]. + * + * returns: a new [Packet] instance. */ Packet */*notnull*/ sp_packet_clone(Packet */*notnull*/ packet); @@ -1633,7 +1724,7 @@ UdpSocket *sp_udp_open_ipv4(uint8_t ip1, * sp_udp_send_command(connection, sp_command_brightness(5)); * ``` */ -bool sp_udp_send_command(UdpSocket */*notnull*/ connection, SPCommand command); +bool sp_udp_send_command(UdpSocket */*notnull*/ connection, Command command); /** * Sends a [Header] to the display using the [UdpSocket]. diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs index d67a59f..731a644 100644 --- a/src/commands/bitmap_command.rs +++ b/src/commands/bitmap_command.rs @@ -41,6 +41,9 @@ pub unsafe extern "C" fn sp_cmd_bitmap_into_packet( heap_move_ok(unsafe { heap_remove(command) }.try_into()) } +/// Clones an [BitmapCommand] instance. +/// +/// returns: a new [BitmapCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_clone( command: NonNull, diff --git a/src/commands/bitvec_command.rs b/src/commands/bitvec_command.rs index a717e0c..7734c05 100644 --- a/src/commands/bitvec_command.rs +++ b/src/commands/bitvec_command.rs @@ -41,6 +41,9 @@ pub unsafe extern "C" fn sp_cmd_bitvec_into_packet( heap_move_ok(unsafe { heap_remove(command) }.try_into()) } +/// Clones an [BitVecCommand] instance. +/// +/// returns: a new [BitVecCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_clone( command: NonNull, @@ -48,6 +51,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_clone( unsafe { heap_clone(command) } } +/// Deallocates a [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_free(command: NonNull) { unsafe { heap_drop(command) } diff --git a/src/commands/brightness_grid_command.rs b/src/commands/brightness_grid_command.rs index ac4b302..aa1caab 100644 --- a/src/commands/brightness_grid_command.rs +++ b/src/commands/brightness_grid_command.rs @@ -6,6 +6,11 @@ use servicepoint::{ }; use std::ptr::NonNull; +/// Set the brightness of individual tiles in a rectangular area of the display. +/// +/// The passed [BrightnessGrid] gets consumed. +/// +/// Returns: a new [BrightnessGridCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_new( grid: NonNull, @@ -18,6 +23,8 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_new( }) } +/// Moves the provided [BrightnessGrid] into a new [BrightnessGridCommand], +/// leaving other fields as their default values. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_from_grid( grid: NonNull, @@ -32,6 +39,9 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_into_packet( heap_move_ok(unsafe { heap_remove(command) }.try_into()) } +/// Clones an [BrightnessGridCommand] instance. +/// +/// returns: a new [BrightnessGridCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_clone( command: NonNull, @@ -39,6 +49,7 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_clone( unsafe { heap_clone(command) } } +/// Deallocates a [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_free( command: NonNull, diff --git a/src/commands/cc_only_commands.rs b/src/commands/cc_only_commands.rs index ca24f7d..2a48c12 100644 --- a/src/commands/cc_only_commands.rs +++ b/src/commands/cc_only_commands.rs @@ -7,17 +7,12 @@ use std::ptr::NonNull; /// Does not affect brightness. /// /// Returns: a new [ClearCommand] instance. -/// -/// # Examples -/// -/// ```C -/// sp_udp_send_command(connection, sp_cmd_clear()); -/// ``` #[no_mangle] pub unsafe extern "C" fn sp_cmd_clear_new() -> NonNull { heap_move_nonnull(ClearCommand) } +/// Deallocates a [ClearCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_clear_free(command: NonNull) { unsafe { heap_drop(command) } @@ -33,6 +28,7 @@ pub unsafe extern "C" fn sp_cmd_hard_reset_new() -> NonNull { heap_move_nonnull(HardResetCommand) } +/// Deallocates a [HardResetCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_hard_reset_free( command: NonNull, @@ -48,6 +44,7 @@ pub unsafe extern "C" fn sp_cmd_fade_out_new() -> NonNull { heap_move_nonnull(FadeOutCommand) } +/// Deallocates a [FadeOutCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_fade_out_free(command: NonNull) { unsafe { heap_drop(command) } diff --git a/src/commands/char_grid_command.rs b/src/commands/char_grid_command.rs index d3f6816..c9e5d9b 100644 --- a/src/commands/char_grid_command.rs +++ b/src/commands/char_grid_command.rs @@ -4,6 +4,11 @@ use crate::mem::{ use servicepoint::{BitmapCommand, CharGrid, CharGridCommand, Origin, Packet}; use std::ptr::NonNull; +/// Show UTF-8 encoded text on the screen. +/// +/// The passed [CharGrid] gets consumed. +/// +/// Returns: a new [CharGridCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_new( grid: NonNull, @@ -16,6 +21,8 @@ pub unsafe extern "C" fn sp_cmd_char_grid_new( }) } +/// Moves the provided [CharGrid] into a new [CharGridCommand], +/// leaving other fields as their default values. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_from_grid( grid: NonNull, @@ -30,6 +37,9 @@ pub unsafe extern "C" fn sp_cmd_char_grid_into_packet( heap_move_ok(unsafe { heap_remove(command) }.try_into()) } +/// Clones an [CharGridCommand] instance. +/// +/// returns: a new [CharGridCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_clone( command: NonNull, @@ -37,6 +47,7 @@ pub unsafe extern "C" fn sp_cmd_char_grid_clone( unsafe { heap_clone(command) } } +/// Deallocates a [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_free( command: NonNull, diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs index 2ab4e54..f6b8f9d 100644 --- a/src/commands/cp437_grid_command.rs +++ b/src/commands/cp437_grid_command.rs @@ -6,6 +6,11 @@ use servicepoint::{ }; use std::ptr::NonNull; +/// Show text on the screen. +/// +/// The text is sent in the form of a 2D grid of [CP-437] encoded characters. +/// +/// The origin is relative to the top-left of the display. #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_new( grid: NonNull, @@ -18,6 +23,8 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_new( }) } +/// Moves the provided [Cp437Grid] into a new [Cp437GridCommand], +/// leaving other fields as their default values. #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_from_grid( grid: NonNull, @@ -32,6 +39,9 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_into_packet( heap_move_ok(unsafe { heap_remove(command) }.try_into()) } +/// Clones an [Cp437GridCommand] instance. +/// +/// returns: a new [Cp437GridCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_clone( command: NonNull, @@ -39,6 +49,7 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_clone( unsafe { heap_clone(command) } } +/// Deallocates a [Cp437GridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_free( command: NonNull, @@ -59,6 +70,12 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_set( } } +/// Show text on the screen. +/// +/// The text is sent in the form of a 2D grid of [CP-437] encoded characters. +/// For sending UTF-8 encoded characters, see [servicepoint::CharGridCommand]. +/// +/// [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 #[no_mangle] pub unsafe extern "C" fn sp_cmd_cp437_grid_get( mut command: NonNull, diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs index 59eb8f8..bdeab5e 100644 --- a/src/commands/generic_command.rs +++ b/src/commands/generic_command.rs @@ -1,5 +1,6 @@ use crate::mem::{ - heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, + heap_clone, heap_drop, heap_move, heap_move_nonnull, heap_move_ok, + heap_remove, }; use servicepoint::{ BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand, @@ -229,7 +230,7 @@ pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand { pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) { unsafe { match command.tag { - CommandTag::Invalid => return, + CommandTag::Invalid => (), CommandTag::Bitmap => heap_drop(command.data.bitmap), CommandTag::BitVec => heap_drop(command.data.bitvec), CommandTag::BrightnessGrid => { @@ -273,20 +274,20 @@ pub unsafe extern "C" fn sp_cmd_generic_into_packet( CommandTag::Cp437Grid => heap_move_ok(unsafe { heap_remove(command.data.cp437_grid).try_into() }), - CommandTag::GlobalBrightness => heap_move_ok(unsafe { - heap_remove(command.data.global_brightness).try_into() + CommandTag::GlobalBrightness => heap_move(unsafe { + heap_remove(command.data.global_brightness).into() }), CommandTag::Clear => { - heap_move_ok(unsafe { heap_remove(command.data.clear).try_into() }) + heap_move(unsafe { heap_remove(command.data.clear).into() }) + } + CommandTag::HardReset => { + heap_move(unsafe { heap_remove(command.data.hard_reset).into() }) + } + CommandTag::FadeOut => { + heap_move(unsafe { heap_remove(command.data.fade_out).into() }) + } + CommandTag::BitmapLegacy => { + heap_move(unsafe { heap_remove(command.data.bitmap_legacy).into() }) } - CommandTag::HardReset => heap_move_ok(unsafe { - heap_remove(command.data.hard_reset).try_into() - }), - CommandTag::FadeOut => heap_move_ok(unsafe { - heap_remove(command.data.fade_out).try_into() - }), - CommandTag::BitmapLegacy => heap_move_ok(unsafe { - heap_remove(command.data.bitmap_legacy).try_into() - }), } } diff --git a/src/commands/global_brightness_command.rs b/src/commands/global_brightness_command.rs index 9d1690c..063dea7 100644 --- a/src/commands/global_brightness_command.rs +++ b/src/commands/global_brightness_command.rs @@ -1,11 +1,12 @@ -use crate::mem::{ - heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, -}; +use crate::mem::{heap_clone, heap_drop, heap_move_nonnull, heap_remove}; use servicepoint::{ BitmapCommand, Brightness, GlobalBrightnessCommand, Packet, }; use std::ptr::NonNull; +/// Set the brightness of all tiles to the same value. +/// +/// Returns: a new [GlobalBrightnessCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_global_new( brightness: Brightness, @@ -16,10 +17,13 @@ pub unsafe extern "C" fn sp_cmd_brightness_global_new( #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_global_into_packet( command: NonNull, -) -> *mut Packet { - heap_move_ok(unsafe { heap_remove(command) }.try_into()) +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(command) }.into()) } +/// Clones an [GlobalBrightnessCommand] instance. +/// +/// returns: a new [GlobalBrightnessCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_global_clone( command: NonNull, diff --git a/src/lib.rs b/src/lib.rs index 14b172d..377b2a0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,10 +25,14 @@ //! } //! ``` +/// Functions related to commands. pub mod commands; +/// Functions related to [servicepoint::Bitmap], [servicepoint::CharGrid] and friends. pub mod containers; -pub mod mem; +pub(crate) mod mem; +/// Functions related to [Packet]. pub mod packet; +/// Functions related to [UdpSocket]. pub mod udp; use std::time::Duration; diff --git a/src/packet.rs b/src/packet.rs index 5fe7572..e9593c9 100644 --- a/src/packet.rs +++ b/src/packet.rs @@ -79,6 +79,8 @@ pub unsafe extern "C" fn sp_packet_serialize_to( } /// Clones a [Packet]. +/// +/// returns: a new [Packet] instance. #[no_mangle] pub unsafe extern "C" fn sp_packet_clone( packet: NonNull, From cb8f9456c7617a975cc6aab3563fb4aefa971870 Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Wed, 7 May 2025 22:50:53 +0200 Subject: [PATCH 5/5] even more docs --- include/servicepoint.h | 103 +++++++++++++++++++++--- src/commands/bitmap_command.rs | 12 ++- src/commands/bitvec_command.rs | 14 +++- src/commands/brightness_grid_command.rs | 8 +- src/commands/char_grid_command.rs | 10 ++- src/commands/cp437_grid_command.rs | 5 +- 6 files changed, 132 insertions(+), 20 deletions(-) diff --git a/include/servicepoint.h b/include/servicepoint.h index a5b3ac7..d5b0199 100644 --- a/include/servicepoint.h +++ b/include/servicepoint.h @@ -1131,6 +1131,9 @@ size_t sp_char_grid_width(CharGrid */*notnull*/ char_grid); */ BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(BitmapCommand */*notnull*/ command); +/** + * Deallocates a [BitmapCommand] instance. + */ void sp_cmd_bitmap_free(BitmapCommand */*notnull*/ command); /** @@ -1151,14 +1154,18 @@ BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(Bitmap */*notnull*/ bitmap) */ Bitmap */*notnull*/ sp_cmd_bitmap_get(BitmapCommand */*notnull*/ command); +/** + * Reads the compression kind of the [BitmapCommand]. + */ CompressionCode sp_cmd_bitmap_get_compression(BitmapCommand */*notnull*/ command); +/** + * Reads the origin field of the [BitmapCommand]. + */ void sp_cmd_bitmap_get_origin(BitmapCommand */*notnull*/ command, size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_y); -Packet *sp_cmd_bitmap_into_packet(BitmapCommand */*notnull*/ command); - /** * Sets a window of pixels to the specified values. * @@ -1172,18 +1179,31 @@ BitmapCommand */*notnull*/ sp_cmd_bitmap_new(Bitmap */*notnull*/ bitmap, CompressionCode compression); /** - * Moves the provided bitmap to be contained in the command. + * Moves the provided [Bitmap] to be contained in the [BitmapCommand]. */ void sp_cmd_bitmap_set(BitmapCommand */*notnull*/ command, Bitmap */*notnull*/ bitmap); +/** + * Overwrites the compression kind of the [BitmapCommand]. + */ void sp_cmd_bitmap_set_compression(BitmapCommand */*notnull*/ command, CompressionCode compression); +/** + * Overwrites the origin field of the [BitmapCommand]. + */ void sp_cmd_bitmap_set_origin(BitmapCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Tries to turn a [BitmapCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_bitmap_try_into_packet(BitmapCommand */*notnull*/ command); + /** * Clones an [BitVecCommand] instance. * @@ -1196,16 +1216,26 @@ BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(BitVecCommand */*notnull*/ comman */ void sp_cmd_bitvec_free(BitVecCommand */*notnull*/ command); +/** + * Returns a pointer to the [BitVec] contained in the [BitVecCommand]. + */ BitVec *sp_cmd_bitvec_get(BitVecCommand */*notnull*/ command); +/** + * Reads the compression kind of the [BitVecCommand]. + */ CompressionCode sp_cmd_bitvec_get_compression(BitVecCommand */*notnull*/ command); +/** + * Reads the offset field of the [BitVecCommand]. + */ Offset sp_cmd_bitvec_get_offset(BitVecCommand */*notnull*/ command); +/** + * Returns the [BinaryOperation] of the command. + */ BinaryOperation sp_cmd_bitvec_get_operation(BitVecCommand */*notnull*/ command); -Packet *sp_cmd_bitvec_into_packet(BitVecCommand */*notnull*/ command); - /** * Set pixel data starting at the pixel offset on screen. * @@ -1226,20 +1256,36 @@ BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec, CompressionCode compression); /** - * Moves the provided bitmap to be contained in the command. + * Moves the provided [BitVec] to be contained in the [BitVecCommand]. */ void sp_cmd_bitvec_set(BitVecCommand */*notnull*/ command, BitVec */*notnull*/ bitvec); +/** + * Overwrites the compression kind of the [BitVecCommand]. + */ void sp_cmd_bitvec_set_compression(BitVecCommand */*notnull*/ command, CompressionCode compression); +/** + * Overwrites the offset field of the [BitVecCommand]. + */ void sp_cmd_bitvec_set_offset(BitVecCommand */*notnull*/ command, Offset offset); +/** + * Overwrites the [BinaryOperation] of the command. + */ void sp_cmd_bitvec_set_operation(BitVecCommand */*notnull*/ command, BinaryOperation operation); +/** + * Tries to turn a [BitVecCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_bitvec_try_into_packet(BitVecCommand */*notnull*/ command); + /** * Clones an [GlobalBrightnessCommand] instance. * @@ -1284,12 +1330,23 @@ void sp_cmd_brightness_grid_free(BitmapCommand */*notnull*/ command); */ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid); +/** + * Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand]. + */ BrightnessGrid *sp_cmd_brightness_grid_get(BrightnessGridCommand */*notnull*/ command); +/** + * Overwrites the origin field of the [BrightnessGridCommand]. + */ void sp_cmd_brightness_grid_get_origin(BrightnessGridCommand */*notnull*/ command, size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_y); +/** + * Tries to turn a [BrightnessGridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ Packet *sp_cmd_brightness_grid_into_packet(BrightnessGridCommand */*notnull*/ command); /** @@ -1304,11 +1361,14 @@ BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessGrid */* size_t origin_y); /** - * Moves the provided bitmap to be contained in the command. + * Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand]. */ void sp_cmd_brightness_grid_set(BrightnessGridCommand */*notnull*/ command, BrightnessGrid */*notnull*/ grid); +/** + * Reads the origin field of the [BrightnessGridCommand]. + */ void sp_cmd_brightness_grid_set_origin(BrightnessGridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); @@ -1331,14 +1391,18 @@ void sp_cmd_char_grid_free(BitmapCommand */*notnull*/ command); */ CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid); +/** + * Returns a pointer to the [CharGrid] contained in the [CharGridCommand]. + */ CharGrid *sp_cmd_char_grid_get(CharGridCommand */*notnull*/ command); +/** + * Reads the origin field of the [CharGridCommand]. + */ void sp_cmd_char_grid_get_origin(CharGridCommand */*notnull*/ command, size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_y); -Packet *sp_cmd_char_grid_into_packet(CharGridCommand */*notnull*/ command); - /** * Show UTF-8 encoded text on the screen. * @@ -1351,15 +1415,25 @@ CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ grid, size_t origin_y); /** - * Moves the provided bitmap to be contained in the command. + * Moves the provided [CharGrid] to be contained in the [CharGridCommand]. */ void sp_cmd_char_grid_set(CharGridCommand */*notnull*/ command, CharGrid */*notnull*/ grid); +/** + * Overwrites the origin field of the [CharGridCommand]. + */ void sp_cmd_char_grid_set_origin(CharGridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Tries to turn a [CharGridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_char_grid_try_into_packet(CharGridCommand */*notnull*/ command); + /** * Deallocates a [ClearCommand]. */ @@ -1411,8 +1485,6 @@ void sp_cmd_cp437_grid_get_origin(Cp437GridCommand */*notnull*/ command, size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_y); -Packet *sp_cmd_cp437_grid_into_packet(Cp437GridCommand */*notnull*/ command); - /** * Show text on the screen. * @@ -1441,6 +1513,13 @@ void sp_cmd_cp437_grid_set_origin(Cp437GridCommand */*notnull*/ command, size_t origin_x, size_t origin_y); +/** + * Tries to turn a [Cp437GridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_cp437_grid_try_into_packet(Cp437GridCommand */*notnull*/ command); + /** * Deallocates a [FadeOutCommand]. */ diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs index 731a644..286a6f1 100644 --- a/src/commands/bitmap_command.rs +++ b/src/commands/bitmap_command.rs @@ -34,8 +34,11 @@ pub unsafe extern "C" fn sp_cmd_bitmap_from_bitmap( heap_move_nonnull(unsafe { heap_remove(bitmap) }.into()) } +/// Tries to turn a [BitmapCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. #[no_mangle] -pub unsafe extern "C" fn sp_cmd_bitmap_into_packet( +pub unsafe extern "C" fn sp_cmd_bitmap_try_into_packet( command: NonNull, ) -> *mut Packet { heap_move_ok(unsafe { heap_remove(command) }.try_into()) @@ -51,6 +54,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_clone( unsafe { heap_clone(command) } } +/// Deallocates a [BitmapCommand] instance. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_free(command: NonNull) { unsafe { heap_drop(command) } @@ -69,7 +73,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_get( unsafe { NonNull::from(&mut (command.as_mut().bitmap)) } } -/// Moves the provided bitmap to be contained in the command. +/// Moves the provided [Bitmap] to be contained in the [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_set( mut command: NonNull, @@ -80,6 +84,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_set( } } +/// Reads the origin field of the [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_get_origin( command: NonNull, @@ -93,6 +98,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_get_origin( } } +/// Overwrites the origin field of the [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_set_origin( mut command: NonNull, @@ -104,6 +110,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_set_origin( } } +/// Overwrites the compression kind of the [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_set_compression( mut command: NonNull, @@ -114,6 +121,7 @@ pub unsafe extern "C" fn sp_cmd_bitmap_set_compression( } } +/// Reads the compression kind of the [BitmapCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitmap_get_compression( command: NonNull, diff --git a/src/commands/bitvec_command.rs b/src/commands/bitvec_command.rs index 7734c05..617e3af 100644 --- a/src/commands/bitvec_command.rs +++ b/src/commands/bitvec_command.rs @@ -34,8 +34,11 @@ pub unsafe extern "C" fn sp_cmd_bitvec_new( }) } +/// Tries to turn a [BitVecCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. #[no_mangle] -pub unsafe extern "C" fn sp_cmd_bitvec_into_packet( +pub unsafe extern "C" fn sp_cmd_bitvec_try_into_packet( command: NonNull, ) -> *mut Packet { heap_move_ok(unsafe { heap_remove(command) }.try_into()) @@ -57,6 +60,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_free(command: NonNull) { unsafe { heap_drop(command) } } +/// Returns a pointer to the [BitVec] contained in the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_get( mut command: NonNull, @@ -64,7 +68,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_get( &mut unsafe { command.as_mut() }.bitvec } -/// Moves the provided bitmap to be contained in the command. +/// Moves the provided [BitVec] to be contained in the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_set( mut command: NonNull, @@ -75,6 +79,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_set( } } +/// Reads the offset field of the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_get_offset( command: NonNull, @@ -82,6 +87,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_get_offset( unsafe { command.as_ref().offset } } +/// Overwrites the offset field of the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_set_offset( mut command: NonNull, @@ -92,6 +98,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_set_offset( } } +/// Returns the [BinaryOperation] of the command. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_get_operation( command: NonNull, @@ -99,6 +106,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_get_operation( unsafe { command.as_ref().operation.clone() } // TODO remove clone } +/// Overwrites the [BinaryOperation] of the command. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_set_operation( mut command: NonNull, @@ -109,6 +117,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_set_operation( } } +/// Overwrites the compression kind of the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_set_compression( mut command: NonNull, @@ -119,6 +128,7 @@ pub unsafe extern "C" fn sp_cmd_bitvec_set_compression( } } +/// Reads the compression kind of the [BitVecCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_bitvec_get_compression( command: NonNull, diff --git a/src/commands/brightness_grid_command.rs b/src/commands/brightness_grid_command.rs index aa1caab..80e1b89 100644 --- a/src/commands/brightness_grid_command.rs +++ b/src/commands/brightness_grid_command.rs @@ -32,6 +32,9 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_from_grid( heap_move_nonnull(unsafe { heap_remove(grid) }.into()) } +/// Tries to turn a [BrightnessGridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_into_packet( command: NonNull, @@ -57,7 +60,7 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_free( unsafe { heap_drop(command) } } -/// Moves the provided bitmap to be contained in the command. +/// Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_set( mut command: NonNull, @@ -68,6 +71,7 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_set( } } +/// Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_get( mut command: NonNull, @@ -75,6 +79,7 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_get( &mut unsafe { command.as_mut() }.grid } +/// Overwrites the origin field of the [BrightnessGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_get_origin( command: NonNull, @@ -88,6 +93,7 @@ pub unsafe extern "C" fn sp_cmd_brightness_grid_get_origin( } } +/// Reads the origin field of the [BrightnessGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_brightness_grid_set_origin( mut command: NonNull, diff --git a/src/commands/char_grid_command.rs b/src/commands/char_grid_command.rs index c9e5d9b..8a220a5 100644 --- a/src/commands/char_grid_command.rs +++ b/src/commands/char_grid_command.rs @@ -30,8 +30,11 @@ pub unsafe extern "C" fn sp_cmd_char_grid_from_grid( heap_move_nonnull(unsafe { heap_remove(grid) }.into()) } +/// Tries to turn a [CharGridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. #[no_mangle] -pub unsafe extern "C" fn sp_cmd_char_grid_into_packet( +pub unsafe extern "C" fn sp_cmd_char_grid_try_into_packet( command: NonNull, ) -> *mut Packet { heap_move_ok(unsafe { heap_remove(command) }.try_into()) @@ -55,7 +58,7 @@ pub unsafe extern "C" fn sp_cmd_char_grid_free( unsafe { heap_drop(command) } } -/// Moves the provided bitmap to be contained in the command. +/// Moves the provided [CharGrid] to be contained in the [CharGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_set( mut command: NonNull, @@ -66,6 +69,7 @@ pub unsafe extern "C" fn sp_cmd_char_grid_set( } } +/// Returns a pointer to the [CharGrid] contained in the [CharGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_get( mut command: NonNull, @@ -73,6 +77,7 @@ pub unsafe extern "C" fn sp_cmd_char_grid_get( &mut unsafe { command.as_mut() }.grid } +/// Reads the origin field of the [CharGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_get_origin( command: NonNull, @@ -86,6 +91,7 @@ pub unsafe extern "C" fn sp_cmd_char_grid_get_origin( } } +/// Overwrites the origin field of the [CharGridCommand]. #[no_mangle] pub unsafe extern "C" fn sp_cmd_char_grid_set_origin( mut command: NonNull, diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs index f6b8f9d..f653ef5 100644 --- a/src/commands/cp437_grid_command.rs +++ b/src/commands/cp437_grid_command.rs @@ -32,8 +32,11 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_from_grid( heap_move_nonnull(unsafe { heap_remove(grid) }.into()) } +/// Tries to turn a [Cp437GridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. #[no_mangle] -pub unsafe extern "C" fn sp_cmd_cp437_grid_into_packet( +pub unsafe extern "C" fn sp_cmd_cp437_grid_try_into_packet( command: NonNull, ) -> *mut Packet { heap_move_ok(unsafe { heap_remove(command) }.try_into())