Compare commits

...

2 commits

Author SHA1 Message Date
Vinzenz Schroeter b79a2534fc the rest of the functions wrapped with macro
Some checks failed
Rust / build-gnu-apt (pull_request) Failing after 1m6s
Rust / build-size-gnu-unstable (pull_request) Failing after 2m49s
2025-06-18 23:14:51 +02:00
Vinzenz Schroeter c492cfab6b even more functions wrapped with macro 2025-06-18 22:40:04 +02:00
14 changed files with 734 additions and 816 deletions

View file

@ -1,7 +1,7 @@
#ifndef SERVICEPOINT_BINDINGS_C #ifndef SERVICEPOINT_BINDINGS_C
#define SERVICEPOINT_BINDINGS_C #define SERVICEPOINT_BINDINGS_C
/* Generated with cbindgen:0.29.0 */ /* Generated with cbindgen:0.28.0 */
/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */ /* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
@ -633,12 +633,6 @@ typedef struct Header {
extern "C" { extern "C" {
#endif // __cplusplus #endif // __cplusplus
/**
* Call this function at the beginning of main to enable rust logging controlled by the
* `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
*/
void init_env_logger(void);
/** /**
*Clones a [`Bitmap`] instance. *Clones a [`Bitmap`] instance.
* *
@ -1254,14 +1248,14 @@ void sp_cmd_bitmap_free(struct BitmapCommand */*notnull*/ instance);
struct BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(struct Bitmap */*notnull*/ bitmap); struct BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(struct Bitmap */*notnull*/ bitmap);
/** /**
* Returns a pointer to the provided `BitmapCommand`. * Gets a reference to the field `bitmap` of the [`servicepoint::BitmapCommand`].
* *
* # Safety * - The returned reference inherits the lifetime of object in which it is contained.
*
* - The returned bitmap inherits the lifetime of the command in which it is contained.
* - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command. * - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
*
* This function is part of the sp_cmd_bitmap module.
*/ */
struct Bitmap */*notnull*/ sp_cmd_bitmap_get(struct BitmapCommand */*notnull*/ command); struct Bitmap */*notnull*/ sp_cmd_bitmap_get_bitmap_mut(struct BitmapCommand */*notnull*/ instance);
/** /**
* Gets the value of field `compression` of the [`servicepoint::BitmapCommand`]. * Gets the value of field `compression` of the [`servicepoint::BitmapCommand`].
@ -1271,7 +1265,9 @@ struct Bitmap */*notnull*/ sp_cmd_bitmap_get(struct BitmapCommand */*notnull*/ c
CompressionCode sp_cmd_bitmap_get_compression(struct BitmapCommand */*notnull*/ instance); CompressionCode sp_cmd_bitmap_get_compression(struct BitmapCommand */*notnull*/ instance);
/** /**
* Reads the origin field of the [BitmapCommand]. * Reads the origin field of the [`BitmapCommand`].
*
* This function is part of the sp_cmd_bitmap module.
*/ */
void sp_cmd_bitmap_get_origin(struct BitmapCommand */*notnull*/ command, void sp_cmd_bitmap_get_origin(struct BitmapCommand */*notnull*/ command,
size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_x,
@ -1292,10 +1288,13 @@ struct BitmapCommand */*notnull*/ sp_cmd_bitmap_new(struct Bitmap */*notnull*/ b
CompressionCode compression); CompressionCode compression);
/** /**
* Moves the provided [Bitmap] to be contained in the [BitmapCommand]. * Sets the value of field `bitmap` of the [`servicepoint::BitmapCommand`].
* The provided value is moved into the instance, potentially invalidating previously taken references.
*
* This function is part of the sp_cmd_bitmap module.
*/ */
void sp_cmd_bitmap_set(struct BitmapCommand */*notnull*/ command, void sp_cmd_bitmap_set_bitmap(struct BitmapCommand */*notnull*/ instance,
struct Bitmap */*notnull*/ bitmap); struct Bitmap */*notnull*/ value);
/** /**
* Sets the value of field `compression` of the [`servicepoint::BitmapCommand`]. * Sets the value of field `compression` of the [`servicepoint::BitmapCommand`].
@ -1306,7 +1305,9 @@ void sp_cmd_bitmap_set_compression(struct BitmapCommand */*notnull*/ instance,
CompressionCode value); CompressionCode value);
/** /**
* Overwrites the origin field of the [BitmapCommand]. * Overwrites the origin field of the [`BitmapCommand`].
*
* This function is part of the sp_cmd_bitmap module.
*/ */
void sp_cmd_bitmap_set_origin(struct BitmapCommand */*notnull*/ command, void sp_cmd_bitmap_set_origin(struct BitmapCommand */*notnull*/ command,
size_t origin_x, size_t origin_x,
@ -1336,9 +1337,14 @@ struct BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(struct BitVecCommand */*no
void sp_cmd_bitvec_free(struct BitVecCommand */*notnull*/ instance); void sp_cmd_bitvec_free(struct BitVecCommand */*notnull*/ instance);
/** /**
* Returns a pointer to the [BitVec] contained in the [BitVecCommand]. * Gets a reference to the field `bitvec` of the [`servicepoint::BitVecCommand`].
*
* - The returned reference inherits the lifetime of object in which it is contained.
* - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
*
* This function is part of the sp_cmd_bitvec module.
*/ */
BitVec *sp_cmd_bitvec_get(struct BitVecCommand */*notnull*/ command); BitVec */*notnull*/ sp_cmd_bitvec_get_bitvec_mut(struct BitVecCommand */*notnull*/ instance);
/** /**
* Gets the value of field `compression` of the [`servicepoint::BitVecCommand`]. * Gets the value of field `compression` of the [`servicepoint::BitVecCommand`].
@ -1383,10 +1389,13 @@ struct BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec,
CompressionCode compression); CompressionCode compression);
/** /**
* Moves the provided [BitVec] to be contained in the [BitVecCommand]. * Sets the value of field `bitvec` of the [`servicepoint::BitVecCommand`].
* The provided value is moved into the instance, potentially invalidating previously taken references.
*
* This function is part of the sp_cmd_bitvec module.
*/ */
void sp_cmd_bitvec_set(struct BitVecCommand */*notnull*/ command, void sp_cmd_bitvec_set_bitvec(struct BitVecCommand */*notnull*/ instance,
BitVec */*notnull*/ bitvec); BitVec */*notnull*/ value);
/** /**
* Sets the value of field `compression` of the [`servicepoint::BitVecCommand`]. * Sets the value of field `compression` of the [`servicepoint::BitVecCommand`].
@ -1489,12 +1498,19 @@ void sp_cmd_brightness_grid_free(struct BrightnessGridCommand */*notnull*/ insta
struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid); struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid);
/** /**
* Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand]. * Gets a reference to the field `grid` of the [`servicepoint::BrightnessGridCommand`].
*
* - The returned reference inherits the lifetime of object in which it is contained.
* - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
*
* This function is part of the sp_cmd_brightness_grid module.
*/ */
BrightnessGrid *sp_cmd_brightness_grid_get(struct BrightnessGridCommand */*notnull*/ command); BrightnessGrid */*notnull*/ sp_cmd_brightness_grid_get_grid_mut(struct BrightnessGridCommand */*notnull*/ instance);
/** /**
* Overwrites the origin field of the [BrightnessGridCommand]. * Reads the origin field of the [`BrightnessGridCommand`].
*
* This function is part of the sp_cmd_brightness_grid module.
*/ */
void sp_cmd_brightness_grid_get_origin(struct BrightnessGridCommand */*notnull*/ command, void sp_cmd_brightness_grid_get_origin(struct BrightnessGridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_x,
@ -1523,13 +1539,18 @@ struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessG
size_t origin_y); size_t origin_y);
/** /**
* Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand]. * Sets the value of field `grid` of the [`servicepoint::BrightnessGridCommand`].
* The provided value is moved into the instance, potentially invalidating previously taken references.
*
* This function is part of the sp_cmd_brightness_grid module.
*/ */
void sp_cmd_brightness_grid_set(struct BrightnessGridCommand */*notnull*/ command, void sp_cmd_brightness_grid_set_grid(struct BrightnessGridCommand */*notnull*/ instance,
BrightnessGrid */*notnull*/ grid); BrightnessGrid */*notnull*/ value);
/** /**
* Reads the origin field of the [BrightnessGridCommand]. * Overwrites the origin field of the [`BrightnessGridCommand`].
*
* This function is part of the sp_cmd_brightness_grid module.
*/ */
void sp_cmd_brightness_grid_set_origin(struct BrightnessGridCommand */*notnull*/ command, void sp_cmd_brightness_grid_set_origin(struct BrightnessGridCommand */*notnull*/ command,
size_t origin_x, size_t origin_x,
@ -1558,12 +1579,19 @@ void sp_cmd_char_grid_free(struct CharGridCommand */*notnull*/ instance);
struct CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid); struct CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid);
/** /**
* Returns a pointer to the [CharGrid] contained in the [CharGridCommand]. * Gets a reference to the field `grid` of the [`servicepoint::CharGridCommand`].
*
* - The returned reference inherits the lifetime of object in which it is contained.
* - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
*
* This function is part of the sp_cmd_char_grid module.
*/ */
CharGrid */*notnull*/ sp_cmd_char_grid_get(struct CharGridCommand */*notnull*/ command); CharGrid */*notnull*/ sp_cmd_char_grid_get_grid_mut(struct CharGridCommand */*notnull*/ instance);
/** /**
* Reads the origin field of the [CharGridCommand]. * Reads the origin field of the [`CharGridCommand`].
*
* This function is part of the sp_cmd_char_grid module.
*/ */
void sp_cmd_char_grid_get_origin(struct CharGridCommand */*notnull*/ command, void sp_cmd_char_grid_get_origin(struct CharGridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_x,
@ -1583,13 +1611,18 @@ struct CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ g
size_t origin_y); size_t origin_y);
/** /**
* Moves the provided [CharGrid] to be contained in the [CharGridCommand]. * Sets the value of field `grid` of the [`servicepoint::CharGridCommand`].
* The provided value is moved into the instance, potentially invalidating previously taken references.
*
* This function is part of the sp_cmd_char_grid module.
*/ */
void sp_cmd_char_grid_set(struct CharGridCommand */*notnull*/ command, void sp_cmd_char_grid_set_grid(struct CharGridCommand */*notnull*/ instance,
CharGrid */*notnull*/ grid); CharGrid */*notnull*/ value);
/** /**
* Overwrites the origin field of the [CharGridCommand]. * Overwrites the origin field of the [`CharGridCommand`].
*
* This function is part of the sp_cmd_char_grid module.
*/ */
void sp_cmd_char_grid_set_origin(struct CharGridCommand */*notnull*/ command, void sp_cmd_char_grid_set_origin(struct CharGridCommand */*notnull*/ command,
size_t origin_x, size_t origin_x,
@ -1616,7 +1649,7 @@ void sp_cmd_clear_free(struct ClearCommand */*notnull*/ instance);
* *
* Does not affect brightness. * Does not affect brightness.
* *
* Returns: a new [ClearCommand] instance. * Returns: a new [`ClearCommand`] instance.
* *
* This function is part of the sp_cmd_clear module. * This function is part of the sp_cmd_clear module.
*/ */
@ -1645,19 +1678,19 @@ void sp_cmd_cp437_grid_free(struct Cp437GridCommand */*notnull*/ instance);
struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_from_grid(Cp437Grid */*notnull*/ grid); struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_from_grid(Cp437Grid */*notnull*/ grid);
/** /**
* Show text on the screen. * Gets a reference to the field `grid` of the [`servicepoint::Cp437GridCommand`].
* *
* The text is sent in the form of a 2D grid of [CP-437] encoded characters. * - The returned reference inherits the lifetime of object in which it is contained.
* For sending UTF-8 encoded characters, see [servicepoint::CharGridCommand]. * - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
* *
* [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 * This function is part of the sp_cmd_cp437_grid module.
*/ */
Cp437Grid *sp_cmd_cp437_grid_get(struct Cp437GridCommand */*notnull*/ command); Cp437Grid */*notnull*/ sp_cmd_cp437_grid_get_grid_mut(struct Cp437GridCommand */*notnull*/ instance);
/** /**
* Gets the origin field of the [Cp437GridCommand]. * Reads the origin field of the [`Cp437GridCommand`].
* *
* Rust equivalent: `cp437_command.origin` * This function is part of the sp_cmd_cp437_grid module.
*/ */
void sp_cmd_cp437_grid_get_origin(struct Cp437GridCommand */*notnull*/ command, void sp_cmd_cp437_grid_get_origin(struct Cp437GridCommand */*notnull*/ command,
size_t */*notnull*/ origin_x, size_t */*notnull*/ origin_x,
@ -1677,17 +1710,18 @@ struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_new(Cp437Grid */*notnull*
size_t origin_y); size_t origin_y);
/** /**
* Moves the provided bitmap into the provided command. * Sets the value of field `grid` of the [`servicepoint::Cp437GridCommand`].
* The provided value is moved into the instance, potentially invalidating previously taken references.
* *
* This drops the previously contained [Cp437Grid]. * This function is part of the sp_cmd_cp437_grid module.
*/ */
void sp_cmd_cp437_grid_set(struct Cp437GridCommand */*notnull*/ command, void sp_cmd_cp437_grid_set_grid(struct Cp437GridCommand */*notnull*/ instance,
Cp437Grid */*notnull*/ grid); Cp437Grid */*notnull*/ value);
/** /**
* Sets the origin field of the [Cp437GridCommand]. * Overwrites the origin field of the [`Cp437GridCommand`].
* *
* Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` * This function is part of the sp_cmd_cp437_grid module.
*/ */
void sp_cmd_cp437_grid_set_origin(struct Cp437GridCommand */*notnull*/ command, void sp_cmd_cp437_grid_set_origin(struct Cp437GridCommand */*notnull*/ command,
size_t origin_x, size_t origin_x,
@ -1712,7 +1746,7 @@ void sp_cmd_fade_out_free(struct FadeOutCommand */*notnull*/ instance);
/** /**
* A yet-to-be-tested command. * A yet-to-be-tested command.
* *
* Returns: a new [FadeOutCommand] instance. * Returns: a new [`FadeOutCommand`] instance.
* *
* This function is part of the sp_cmd_fade_out module. * This function is part of the sp_cmd_fade_out module.
*/ */
@ -1722,6 +1756,8 @@ struct FadeOutCommand */*notnull*/ sp_cmd_fade_out_new(void);
* Clones an [SPCommand] instance. * Clones an [SPCommand] instance.
* *
* returns: a new [SPCommand] instance. * returns: a new [SPCommand] instance.
*
* This function is part of the sp_cmd_generic module.
*/ */
struct Command sp_cmd_generic_clone(struct Command command); struct Command sp_cmd_generic_clone(struct Command command);
@ -1736,6 +1772,8 @@ struct Command sp_cmd_generic_clone(struct Command command);
* SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); * SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new());
* sp_command_free(c); * sp_command_free(c);
* ``` * ```
*
* This function is part of the sp_cmd_generic module.
*/ */
void sp_cmd_generic_free(struct Command command); void sp_cmd_generic_free(struct Command command);
@ -1744,6 +1782,8 @@ void sp_cmd_generic_free(struct Command command);
* The [SPCommand] gets consumed. * The [SPCommand] gets consumed.
* *
* Returns tag [CommandTag::Invalid] in case of an error. * Returns tag [CommandTag::Invalid] in case of an error.
*
* This function is part of the sp_cmd_generic module.
*/ */
struct Packet *sp_cmd_generic_into_packet(struct Command command); struct Packet *sp_cmd_generic_into_packet(struct Command command);
@ -1753,6 +1793,8 @@ struct Packet *sp_cmd_generic_into_packet(struct Command command);
* The packet is dropped in the process. * The packet is dropped in the process.
* *
* Returns: pointer to new [SPCommand] instance or NULL if parsing failed. * Returns: pointer to new [SPCommand] instance or NULL if parsing failed.
*
* This function is part of the sp_cmd_generic module.
*/ */
struct Command sp_cmd_generic_try_from_packet(struct Packet */*notnull*/ packet); struct Command sp_cmd_generic_try_from_packet(struct Packet */*notnull*/ packet);
@ -1768,7 +1810,7 @@ void sp_cmd_hard_reset_free(struct HardResetCommand */*notnull*/ instance);
* *
* Please do not send this in your normal program flow. * Please do not send this in your normal program flow.
* *
* Returns: a new [HardResetCommand] instance. * Returns: a new [`HardResetCommand`] instance.
* *
* This function is part of the sp_cmd_hard_reset module. * This function is part of the sp_cmd_hard_reset module.
*/ */
@ -1902,6 +1944,14 @@ void sp_cp437_grid_set(Cp437Grid */*notnull*/ instance,
*/ */
size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ instance); size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ instance);
/**
* Call this function at the beginning of main to enable rust logging controlled by the
* `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
*
* This function is part of the sp_envlogger module.
*/
void sp_envlogger_init(void);
/** /**
*Clones a [`Packet`] instance. *Clones a [`Packet`] instance.
* *
@ -1920,6 +1970,8 @@ void sp_packet_free(struct Packet */*notnull*/ instance);
* Creates a raw [Packet] from parts. * Creates a raw [Packet] from parts.
* *
* returns: new instance. Will never return null. * returns: new instance. Will never return null.
*
* This function is part of the sp_packet module.
*/ */
struct Packet */*notnull*/ sp_packet_from_parts(struct Header header, struct Packet */*notnull*/ sp_packet_from_parts(struct Header header,
struct ByteSlice payload); struct ByteSlice payload);
@ -1932,11 +1984,14 @@ struct Packet */*notnull*/ sp_packet_from_parts(struct Header header,
struct Header sp_packet_get_header(struct Packet */*notnull*/ instance); struct Header sp_packet_get_header(struct Packet */*notnull*/ instance);
/** /**
* Returns a pointer to the header field of the provided packet. * Gets a reference to the field `header` of the [`servicepoint::Packet`].
* *
* The returned header can be changed and will be valid for the lifetime of the packet. * - The returned reference inherits the lifetime of object in which it is contained.
* - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
*
* This function is part of the sp_packet module.
*/ */
struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ packet); struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ instance);
/** /**
* Returns a pointer to the current payload of the provided packet. * Returns a pointer to the current payload of the provided packet.
@ -1944,6 +1999,8 @@ struct Header */*notnull*/ sp_packet_get_header_mut(struct Packet */*notnull*/ p
* Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload. * Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload.
* *
* The returned memory can be changed and will be valid until a new payload is set. * The returned memory can be changed and will be valid until a new payload is set.
*
* This function is part of the sp_packet module.
*/ */
struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet); struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet);
@ -1953,8 +2010,10 @@ struct ByteSlice sp_packet_get_payload(struct Packet */*notnull*/ packet);
* # Panics * # Panics
* *
* - if the buffer is not big enough to hold header+payload. * - if the buffer is not big enough to hold header+payload.
*
* This function is part of the sp_packet module.
*/ */
void sp_packet_serialize_to(struct Packet */*notnull*/ packet, size_t sp_packet_serialize_to(struct Packet */*notnull*/ packet,
struct ByteSlice buffer); struct ByteSlice buffer);
/** /**
@ -1969,6 +2028,8 @@ void sp_packet_set_header(struct Packet */*notnull*/ instance,
* Sets the payload of the provided packet to the provided data. * Sets the payload of the provided packet to the provided data.
* *
* This makes previous payload pointers invalid. * This makes previous payload pointers invalid.
*
* This function is part of the sp_packet module.
*/ */
void sp_packet_set_payload(struct Packet */*notnull*/ packet, void sp_packet_set_payload(struct Packet */*notnull*/ packet,
struct ByteSlice data); struct ByteSlice data);
@ -1977,6 +2038,8 @@ void sp_packet_set_payload(struct Packet */*notnull*/ packet,
* Tries to load a [Packet] from the passed array with the specified length. * 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 * returns: NULL in case of an error, pointer to the allocated packet otherwise
*
* This function is part of the sp_packet module.
*/ */
struct Packet *sp_packet_try_load(struct ByteSlice data); struct Packet *sp_packet_try_load(struct ByteSlice data);
@ -1984,6 +2047,8 @@ struct Packet *sp_packet_try_load(struct ByteSlice data);
* Converts u16 into [CommandCode]. * Converts u16 into [CommandCode].
* *
* If the provided value is not valid, false is returned and result is not changed. * If the provided value is not valid, false is returned and result is not changed.
*
* This function is part of the sp module.
*/ */
bool sp_u16_to_command_code(uint16_t code, bool sp_u16_to_command_code(uint16_t code,
CommandCode *result); CommandCode *result);
@ -2007,6 +2072,8 @@ void sp_udp_free(struct UdpSocket */*notnull*/ instance);
* if (connection != NULL) * if (connection != NULL)
* sp_udp_send_command(connection, sp_command_clear()); * sp_udp_send_command(connection, sp_command_clear());
* ``` * ```
*
* This function is part of the sp_udp module.
*/ */
struct UdpSocket *sp_udp_open(char */*notnull*/ host); struct UdpSocket *sp_udp_open(char */*notnull*/ host);
@ -2022,6 +2089,8 @@ struct UdpSocket *sp_udp_open(char */*notnull*/ host);
* if (connection != NULL) * if (connection != NULL)
* sp_udp_send_command(connection, sp_command_clear()); * sp_udp_send_command(connection, sp_command_clear());
* ``` * ```
*
* This function is part of the sp_udp module.
*/ */
struct UdpSocket *sp_udp_open_ipv4(uint8_t ip1, struct UdpSocket *sp_udp_open_ipv4(uint8_t ip1,
uint8_t ip2, uint8_t ip2,
@ -2041,6 +2110,8 @@ struct UdpSocket *sp_udp_open_ipv4(uint8_t ip1,
* ```C * ```C
* sp_udp_send_command(connection, sp_command_brightness(5)); * sp_udp_send_command(connection, sp_command_brightness(5));
* ``` * ```
*
* This function is part of the sp_udp module.
*/ */
bool sp_udp_send_command(struct UdpSocket */*notnull*/ connection, bool sp_udp_send_command(struct UdpSocket */*notnull*/ connection,
struct Command command); struct Command command);
@ -2055,6 +2126,8 @@ bool sp_udp_send_command(struct UdpSocket */*notnull*/ connection,
* ```C * ```C
* sp_udp_send_header(connection, sp_command_brightness(5)); * sp_udp_send_header(connection, sp_command_brightness(5));
* ``` * ```
*
* This function is part of the sp_udp module.
*/ */
bool sp_udp_send_header(struct UdpSocket */*notnull*/ udp_connection, bool sp_udp_send_header(struct UdpSocket */*notnull*/ udp_connection,
struct Header header); struct Header header);
@ -2065,6 +2138,8 @@ bool sp_udp_send_header(struct UdpSocket */*notnull*/ udp_connection,
* The passed `packet` gets consumed. * The passed `packet` gets consumed.
* *
* returns: true in case of success * returns: true in case of success
*
* This function is part of the sp_udp module.
*/ */
bool sp_udp_send_packet(struct UdpSocket */*notnull*/ connection, bool sp_udp_send_packet(struct UdpSocket */*notnull*/ connection,
struct Packet */*notnull*/ packet); struct Packet */*notnull*/ packet);

View file

@ -1,12 +1,22 @@
use crate::{ use crate::{
commands::wrap_origin_accessors,
macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions}, macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
mem::{heap_move_nonnull, heap_move_ok, heap_remove}, mem::{heap_move_nonnull, heap_move_ok, heap_remove},
}; };
use servicepoint::{Bitmap, BitmapCommand, CompressionCode, Origin, Packet}; use servicepoint::{Bitmap, BitmapCommand, CompressionCode, Origin, Packet};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_functions!(sp_cmd_bitmap; wrap_clone!(sp_cmd_bitmap::BitmapCommand);
wrap_free!(sp_cmd_bitmap::BitmapCommand);
wrap_fields!(sp_cmd_bitmap::BitmapCommand;
prop bitmap: Bitmap { mut get(); move set(value); };
prop compression: CompressionCode { get(); set(value); };
);
wrap_origin_accessors!(sp_cmd_bitmap::BitmapCommand);
wrap_functions!(sp_cmd_bitmap;
/// Sets a window of pixels to the specified values. /// Sets a window of pixels to the specified values.
/// ///
/// The passed [Bitmap] gets consumed. /// The passed [Bitmap] gets consumed.
@ -43,74 +53,4 @@ wrap_functions!(sp_cmd_bitmap;
) -> *mut Packet { ) -> *mut Packet {
heap_move_ok(unsafe { heap_remove(command) }.try_into()) heap_move_ok(unsafe { heap_remove(command) }.try_into())
} }
); );
wrap_clone!(sp_cmd_bitmap::BitmapCommand);
wrap_free!(sp_cmd_bitmap::BitmapCommand);
wrap_fields!(
sp_cmd_bitmap::BitmapCommand;
//prop bitmap: NonNull<Bitmap> {
// get() {
// return NonNull::from(bitmap);
// };
// set(value) {
// return unsafe { heap_remove(value) };
// };
//};
prop compression: CompressionCode {
get();
set(value);
};
);
/// Returns a pointer to the provided `BitmapCommand`.
///
/// # Safety
///
/// - The returned bitmap inherits the lifetime of the command in which it is contained.
/// - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command.
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitmap_get(
mut command: NonNull<BitmapCommand>,
) -> NonNull<Bitmap> {
unsafe { NonNull::from(&mut (command.as_mut().bitmap)) }
}
/// Moves the provided [Bitmap] to be contained in the [BitmapCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitmap_set(
mut command: NonNull<BitmapCommand>,
bitmap: NonNull<Bitmap>,
) {
unsafe {
command.as_mut().bitmap = heap_remove(bitmap);
}
}
/// Reads the origin field of the [BitmapCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitmap_get_origin(
command: NonNull<BitmapCommand>,
origin_x: NonNull<usize>,
origin_y: NonNull<usize>,
) {
unsafe {
let origin = &command.as_ref().origin;
*origin_x.as_ptr() = origin.x;
*origin_y.as_ptr() = origin.y;
}
}
/// Overwrites the origin field of the [BitmapCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitmap_set_origin(
mut command: NonNull<BitmapCommand>,
origin_x: usize,
origin_y: usize,
) {
unsafe {
command.as_mut().origin = Origin::new(origin_x, origin_y);
}
}

View file

@ -8,6 +8,16 @@ use servicepoint::{
}; };
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_clone!(sp_cmd_bitvec::BitVecCommand);
wrap_free!(sp_cmd_bitvec::BitVecCommand);
wrap_fields!(sp_cmd_bitvec::BitVecCommand;
prop bitvec: DisplayBitVec { mut get(); move set(value); };
prop offset: Offset { get(); set(value); };
prop operation: BinaryOperation { get(); set(value); };
prop compression: CompressionCode { get(); set(value); };
);
wrap_functions!(sp_cmd_bitvec; wrap_functions!(sp_cmd_bitvec;
/// Set pixel data starting at the pixel offset on screen. /// Set pixel data starting at the pixel offset on screen.
@ -46,41 +56,3 @@ wrap_functions!(sp_cmd_bitvec;
} }
); );
wrap_clone!(sp_cmd_bitvec::BitVecCommand);
wrap_free!(sp_cmd_bitvec::BitVecCommand);
wrap_fields!(
sp_cmd_bitvec::BitVecCommand;
prop offset: Offset {
get();
set(value);
};
prop operation: BinaryOperation {
get();
set(value);
};
prop compression: CompressionCode {
get();
set(value);
};
);
/// Returns a pointer to the [BitVec] contained in the [BitVecCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitvec_get(
mut command: NonNull<BitVecCommand>,
) -> *mut DisplayBitVec {
unsafe { &mut command.as_mut().bitvec }
}
/// Moves the provided [BitVec] to be contained in the [BitVecCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_bitvec_set(
mut command: NonNull<BitVecCommand>,
bitvec: NonNull<DisplayBitVec>,
) {
unsafe {
command.as_mut().bitvec = heap_remove(bitvec);
}
}

View file

@ -1,10 +1,20 @@
use crate::{ use crate::{
macros::{wrap_clone, wrap_free, wrap_functions}, commands::wrap_origin_accessors,
macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
mem::{heap_move_nonnull, heap_move_ok, heap_remove}, mem::{heap_move_nonnull, heap_move_ok, heap_remove},
}; };
use servicepoint::{BrightnessGrid, BrightnessGridCommand, Origin, Packet}; use servicepoint::{BrightnessGrid, BrightnessGridCommand, Origin, Packet};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_clone!(sp_cmd_brightness_grid::BrightnessGridCommand);
wrap_free!(sp_cmd_brightness_grid::BrightnessGridCommand);
wrap_fields!(sp_cmd_brightness_grid::BrightnessGridCommand;
prop grid: BrightnessGrid { mut get(); move set(grid); };
);
wrap_origin_accessors!(sp_cmd_brightness_grid::BrightnessGridCommand);
wrap_functions!(sp_cmd_brightness_grid; wrap_functions!(sp_cmd_brightness_grid;
/// Set the brightness of individual tiles in a rectangular area of the display. /// Set the brightness of individual tiles in a rectangular area of the display.
@ -41,51 +51,3 @@ wrap_functions!(sp_cmd_brightness_grid;
} }
); );
wrap_clone!(sp_cmd_brightness_grid::BrightnessGridCommand);
wrap_free!(sp_cmd_brightness_grid::BrightnessGridCommand);
/// 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<BrightnessGridCommand>,
grid: NonNull<BrightnessGrid>,
) {
unsafe {
command.as_mut().grid = heap_remove(grid);
}
}
/// 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<BrightnessGridCommand>,
) -> *mut BrightnessGrid {
unsafe { &mut 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<BrightnessGridCommand>,
origin_x: NonNull<usize>,
origin_y: NonNull<usize>,
) {
unsafe {
let origin = &command.as_ref().origin;
*origin_x.as_ptr() = origin.x;
*origin_y.as_ptr() = origin.y;
}
}
/// Reads the origin field of the [BrightnessGridCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_brightness_grid_set_origin(
mut command: NonNull<BrightnessGridCommand>,
origin_x: usize,
origin_y: usize,
) {
unsafe {
command.as_mut().origin = Origin::new(origin_x, origin_y);
}
}

View file

@ -5,39 +5,33 @@ use crate::{
use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand}; use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_functions!(sp_cmd_clear; macro_rules! wrap_cc_only {
($prefix:ident :: $typ:ident ; $(#[$meta:meta])*) => {
wrap_functions!($prefix;
$(#[$meta])*
///
#[doc = concat!(" Returns: a new [`",stringify!($typ),"`] instance.")]
fn new() -> NonNull<$typ> {
heap_move_nonnull($typ)
}
);
wrap_free!($prefix :: $typ);
};
}
wrap_cc_only!(sp_cmd_clear::ClearCommand;
/// Set all pixels to the off state. /// Set all pixels to the off state.
/// ///
/// Does not affect brightness. /// Does not affect brightness.
///
/// Returns: a new [ClearCommand] instance.
fn new() -> NonNull<ClearCommand> {
heap_move_nonnull(ClearCommand)
}
); );
wrap_free!(sp_cmd_clear::ClearCommand); wrap_cc_only!(sp_cmd_hard_reset::HardResetCommand;
wrap_functions!(sp_cmd_hard_reset;
/// Kills the udp daemon on the display, which usually results in a restart. /// Kills the udp daemon on the display, which usually results in a restart.
/// ///
/// Please do not send this in your normal program flow. /// Please do not send this in your normal program flow.
///
/// Returns: a new [HardResetCommand] instance.
fn new() -> NonNull<HardResetCommand> {
heap_move_nonnull(HardResetCommand)
}
); );
wrap_free!(sp_cmd_hard_reset::HardResetCommand); wrap_cc_only!(sp_cmd_fade_out::FadeOutCommand;
wrap_functions!(sp_cmd_fade_out;
/// A yet-to-be-tested command. /// A yet-to-be-tested command.
///
/// Returns: a new [FadeOutCommand] instance.
fn new() -> NonNull<FadeOutCommand> {
heap_move_nonnull(FadeOutCommand)
}
); );
wrap_free!(sp_cmd_fade_out::FadeOutCommand);

View file

@ -1,10 +1,20 @@
use crate::{ use crate::{
macros::{wrap_clone, wrap_free, wrap_functions}, commands::wrap_origin_accessors,
macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
mem::{heap_move_nonnull, heap_move_ok, heap_remove}, mem::{heap_move_nonnull, heap_move_ok, heap_remove},
}; };
use servicepoint::{CharGrid, CharGridCommand, Origin, Packet}; use servicepoint::{CharGrid, CharGridCommand, Origin, Packet};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_clone!(sp_cmd_char_grid::CharGridCommand);
wrap_free!(sp_cmd_char_grid::CharGridCommand);
wrap_fields!(sp_cmd_char_grid::CharGridCommand;
prop grid: CharGrid { mut get(); move set(grid); };
);
wrap_origin_accessors!(sp_cmd_char_grid::CharGridCommand);
wrap_functions!(sp_cmd_char_grid; wrap_functions!(sp_cmd_char_grid;
/// Show UTF-8 encoded text on the screen. /// Show UTF-8 encoded text on the screen.
@ -41,51 +51,3 @@ wrap_functions!(sp_cmd_char_grid;
} }
); );
wrap_clone!(sp_cmd_char_grid::CharGridCommand);
wrap_free!(sp_cmd_char_grid::CharGridCommand);
/// 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<CharGridCommand>,
grid: NonNull<CharGrid>,
) {
unsafe {
command.as_mut().grid = heap_remove(grid);
}
}
/// 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<CharGridCommand>,
) -> NonNull<CharGrid> {
unsafe { NonNull::from(&mut 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<CharGridCommand>,
origin_x: NonNull<usize>,
origin_y: NonNull<usize>,
) {
unsafe {
let origin = &command.as_ref().origin;
*origin_x.as_ptr() = origin.x;
*origin_y.as_ptr() = origin.y;
}
}
/// Overwrites the origin field of the [CharGridCommand].
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_char_grid_set_origin(
mut command: NonNull<CharGridCommand>,
origin_x: usize,
origin_y: usize,
) {
unsafe {
command.as_mut().origin = Origin::new(origin_x, origin_y);
}
}

View file

@ -1,10 +1,20 @@
use crate::{ use crate::{
macros::{wrap_clone, wrap_free, wrap_functions}, commands::wrap_origin_accessors,
macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
mem::{heap_move_nonnull, heap_move_ok, heap_remove}, mem::{heap_move_nonnull, heap_move_ok, heap_remove},
}; };
use servicepoint::{Cp437Grid, Cp437GridCommand, Origin, Packet}; use servicepoint::{Cp437Grid, Cp437GridCommand, Origin, Packet};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_clone!(sp_cmd_cp437_grid::Cp437GridCommand);
wrap_free!(sp_cmd_cp437_grid::Cp437GridCommand);
wrap_fields!(sp_cmd_cp437_grid::Cp437GridCommand;
prop grid: Cp437Grid { mut get(); move set(grid); };
);
wrap_origin_accessors!(sp_cmd_cp437_grid::Cp437GridCommand);
wrap_functions!(sp_cmd_cp437_grid; wrap_functions!(sp_cmd_cp437_grid;
/// Show text on the screen. /// Show text on the screen.
@ -41,62 +51,3 @@ wrap_functions!(sp_cmd_cp437_grid;
} }
); );
wrap_clone!(sp_cmd_cp437_grid::Cp437GridCommand);
wrap_free!(sp_cmd_cp437_grid::Cp437GridCommand);
/// 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<Cp437GridCommand>,
grid: NonNull<Cp437Grid>,
) {
unsafe {
command.as_mut().grid = heap_remove(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
#[no_mangle]
pub unsafe extern "C" fn sp_cmd_cp437_grid_get(
mut command: NonNull<Cp437GridCommand>,
) -> *mut Cp437Grid {
unsafe { &mut 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<Cp437GridCommand>,
origin_x: NonNull<usize>,
origin_y: NonNull<usize>,
) {
unsafe {
let origin = &command.as_ref().origin;
*origin_x.as_ptr() = origin.x;
*origin_y.as_ptr() = origin.y;
}
}
/// 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<Cp437GridCommand>,
origin_x: usize,
origin_y: usize,
) {
unsafe {
command.as_mut().origin = Origin::new(origin_x, origin_y);
}
}

View file

@ -1,6 +1,9 @@
use crate::mem::{ use crate::{
macros::wrap_functions,
mem::{
heap_clone, heap_drop, heap_move, heap_move_nonnull, heap_move_ok, heap_clone, heap_drop, heap_move, heap_move_nonnull, heap_move_ok,
heap_remove, heap_remove,
},
}; };
use servicepoint::{ use servicepoint::{
BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand, BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand,
@ -66,13 +69,14 @@ impl SPCommand {
}; };
} }
wrap_functions!(sp_cmd_generic;
/// Tries to turn a [Packet] into a [SPCommand]. /// Tries to turn a [Packet] into a [SPCommand].
/// ///
/// The packet is dropped in the process. /// The packet is dropped in the process.
/// ///
/// Returns: pointer to new [SPCommand] instance or NULL if parsing failed. /// Returns: pointer to new [SPCommand] instance or NULL if parsing failed.
#[no_mangle] fn try_from_packet(
pub unsafe extern "C" fn sp_cmd_generic_try_from_packet(
packet: NonNull<Packet>, packet: NonNull<Packet>,
) -> SPCommand { ) -> SPCommand {
let packet = *unsafe { Box::from_raw(packet.as_ptr()) }; let packet = *unsafe { Box::from_raw(packet.as_ptr()) };
@ -149,8 +153,7 @@ pub unsafe extern "C" fn sp_cmd_generic_try_from_packet(
/// Clones an [SPCommand] instance. /// Clones an [SPCommand] instance.
/// ///
/// returns: a new [SPCommand] instance. /// returns: a new [SPCommand] instance.
#[no_mangle] fn clone(command: SPCommand) -> SPCommand {
pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand {
unsafe { unsafe {
match command.tag { match command.tag {
CommandTag::Clear => SPCommand { CommandTag::Clear => SPCommand {
@ -231,8 +234,7 @@ pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand {
/// SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); /// SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new());
/// sp_command_free(c); /// sp_command_free(c);
/// ``` /// ```
#[no_mangle] fn free(command: SPCommand) {
pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) {
unsafe { unsafe {
match command.tag { match command.tag {
CommandTag::Invalid => (), CommandTag::Invalid => (),
@ -258,8 +260,7 @@ pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) {
/// The [SPCommand] gets consumed. /// The [SPCommand] gets consumed.
/// ///
/// Returns tag [CommandTag::Invalid] in case of an error. /// Returns tag [CommandTag::Invalid] in case of an error.
#[no_mangle] fn into_packet(
pub unsafe extern "C" fn sp_cmd_generic_into_packet(
command: SPCommand, command: SPCommand,
) -> *mut Packet { ) -> *mut Packet {
match command.tag { match command.tag {
@ -296,3 +297,5 @@ pub unsafe extern "C" fn sp_cmd_generic_into_packet(
} }
} }
} }
);

View file

@ -13,3 +13,35 @@ pub use brightness_grid_command::*;
pub use char_grid_command::*; pub use char_grid_command::*;
pub use cp437_grid_command::*; pub use cp437_grid_command::*;
pub use generic_command::*; pub use generic_command::*;
macro_rules! wrap_origin_accessors {
( $prefix:ident :: $object_type:ty ) => {
$crate::macros::wrap_functions!($prefix;
#[doc = concat!(" Reads the origin field of the [`", stringify!($object_type), "`].")]
fn get_origin(
command: NonNull<$object_type>,
origin_x: NonNull<usize>,
origin_y: NonNull<usize>,
) {
unsafe {
let origin = &command.as_ref().origin;
*origin_x.as_ptr() = origin.x;
*origin_y.as_ptr() = origin.y;
}
}
#[doc = concat!(" Overwrites the origin field of the [`", stringify!($object_type), "`].")]
fn set_origin(
command: NonNull<$object_type>,
origin_x: usize,
origin_y: usize,
) {
unsafe {
$crate::macros::nonnull_as_mut!(command).origin = ::servicepoint::Origin::new(origin_x, origin_y);
}
}
);
};
}
pub(crate) use wrap_origin_accessors;

View file

@ -35,7 +35,7 @@ impl ByteSlice {
unsafe { std::slice::from_raw_parts(self.start, self.length) } unsafe { std::slice::from_raw_parts(self.start, self.length) }
} }
pub(crate) unsafe fn as_slice_mut(&mut self) -> &mut [u8] { pub(crate) unsafe fn as_slice_mut(&self) -> &mut [u8] {
unsafe { std::slice::from_raw_parts_mut(self.start, self.length) } unsafe { std::slice::from_raw_parts_mut(self.start, self.length) }
} }

View file

@ -47,10 +47,13 @@ pub struct DisplayBitVec;
#[cfg(feature = "env_logger")] #[cfg(feature = "env_logger")]
mod feature_env_logger { mod feature_env_logger {
use crate::macros::wrap_functions;
wrap_functions!(sp_envlogger;
/// Call this function at the beginning of main to enable rust logging controlled by the /// Call this function at the beginning of main to enable rust logging controlled by the
/// `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/). /// `RUST_LOG` environment variable. See [env_logger](https://docs.rs/env_logger/latest/env_logger/).
#[no_mangle] fn init() {
pub unsafe extern "C" fn init_env_logger() {
env_logger::init(); env_logger::init();
} }
);
} }

View file

@ -28,7 +28,7 @@ macro_rules! nonnull_as_ref {
macro_rules! nonnull_as_mut { macro_rules! nonnull_as_mut {
($ident:ident) => { ($ident:ident) => {
&mut *$ident.as_ptr() (&mut *$ident.as_ptr())
}; };
} }
@ -91,6 +91,14 @@ macro_rules! wrap_fields {
$(return $get_expr:expr;)? $(return $get_expr:expr;)?
})?; })?;
)? )?
$(
mut get() $({
$(#[$get_mut_meta:meta])*
$(return $get_mut_expr:expr;)?
})?;
)?
$( $(
set($value:ident) set($value:ident)
$({ $({
@ -98,6 +106,14 @@ macro_rules! wrap_fields {
$(return $set_expr:expr;)? $(return $set_expr:expr;)?
})?; })?;
)? )?
$(
move set( $set_move_value:ident)
$({
$(#[$set_move_meta:meta])*
$(return $set_move_expr:expr;)?
})?;
)?
}; };
)+ )+
) => { ) => {
@ -112,10 +128,9 @@ macro_rules! wrap_fields {
#[$get_meta] #[$get_meta]
)*)? )*)?
fn [<get _ $prop_name>]( fn [<get _ $prop_name>](
instance: NonNull<$object_type> instance: ::core::ptr::NonNull<$object_type>
) -> $prop_type { ) -> $prop_type {
let instance = unsafe { $crate::macros::nonnull_as_ref!(instance) }; let $prop_name = unsafe { $crate::macros::nonnull_as_ref!(instance).$prop_name };
let $prop_name = instance.$prop_name;
$($( $($(
let $prop_name = $get_expr; let $prop_name = $get_expr;
)?)? )?)?
@ -123,6 +138,27 @@ macro_rules! wrap_fields {
} }
)? )?
$(
#[doc = concat!(" Gets a reference to the field `", stringify!($prop_name),
"` of the [`servicepoint::",stringify!($object_type),"`].")]
$($(
#[doc = ""]
#[$get_mut_meta]
)*)?
#[doc = ""]
#[doc = " - The returned reference inherits the lifetime of object in which it is contained."]
#[doc = " - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command."]
fn [<get _ $prop_name _mut>](
instance: ::core::ptr::NonNull<$object_type>
) -> ::core::ptr::NonNull<$prop_type> {
let $prop_name = unsafe { &mut $crate::macros::nonnull_as_mut!(instance).$prop_name };
$($(
let $prop_name = $get_mut_expr;
)?)?
return ::core::ptr::NonNull::from($prop_name);
}
)?
$( $(
#[doc = concat!(" Sets the value of field `", stringify!($prop_name), #[doc = concat!(" Sets the value of field `", stringify!($prop_name),
"` of the [`servicepoint::",stringify!($object_type),"`].")] "` of the [`servicepoint::",stringify!($object_type),"`].")]
@ -131,7 +167,7 @@ macro_rules! wrap_fields {
#[$set_meta] #[$set_meta]
)*)? )*)?
fn [<set _ $prop_name>]( fn [<set _ $prop_name>](
instance: NonNull<$object_type>, instance: ::core::ptr::NonNull<$object_type>,
value: $prop_type, value: $prop_type,
) { ) {
let instance = unsafe { $crate::macros::nonnull_as_mut!(instance) }; let instance = unsafe { $crate::macros::nonnull_as_mut!(instance) };
@ -142,6 +178,29 @@ macro_rules! wrap_fields {
instance.$prop_name = value; instance.$prop_name = value;
} }
)? )?
$(
#[doc = concat!(" Sets the value of field `", stringify!($prop_name),
"` of the [`servicepoint::",stringify!($object_type),"`].")]
#[doc = concat!(" The provided value is moved into the instance, ",
"potentially invalidating previously taken references.")]
$($(
#[doc = ""]
#[$set_move_meta]
)*)?
fn [<set _ $prop_name>](
instance: ::core::ptr::NonNull<$object_type>,
value: NonNull<$prop_type>,
) {
let instance = unsafe { $crate::macros::nonnull_as_mut!(instance) };
let value = unsafe { $crate::mem::heap_remove(value) };
$($(
let $set_move_value = value;
let value = $set_move_expr;
)?)?
instance.$prop_name = value;
}
)?
)+ )+
); );
} }

View file

@ -1,16 +1,17 @@
use crate::{ use crate::{
containers::ByteSlice, containers::ByteSlice,
macros::{wrap_clone, wrap_fields, wrap_free}, macros::{wrap_clone, wrap_fields, wrap_free, wrap_functions},
mem::{heap_move_nonnull, heap_move_ok}, mem::{heap_move_nonnull, heap_move_ok},
}; };
use servicepoint::{CommandCode, Header, Packet}; use servicepoint::{CommandCode, Header, Packet};
use std::ptr::NonNull; use std::ptr::NonNull;
wrap_functions!(sp_packet;
/// Tries to load a [Packet] from the passed array with the specified length. /// 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 /// returns: NULL in case of an error, pointer to the allocated packet otherwise
#[no_mangle] fn try_load(data: ByteSlice) -> *mut Packet {
pub unsafe extern "C" fn sp_packet_try_load(data: ByteSlice) -> *mut Packet {
let data = unsafe { data.as_slice() }; let data = unsafe { data.as_slice() };
heap_move_ok(servicepoint::Packet::try_from(data)) heap_move_ok(servicepoint::Packet::try_from(data))
} }
@ -18,11 +19,7 @@ pub unsafe extern "C" fn sp_packet_try_load(data: ByteSlice) -> *mut Packet {
/// Creates a raw [Packet] from parts. /// Creates a raw [Packet] from parts.
/// ///
/// returns: new instance. Will never return null. /// returns: new instance. Will never return null.
#[no_mangle] fn from_parts(header: Header, payload: ByteSlice) -> NonNull<Packet> {
pub unsafe extern "C" fn sp_packet_from_parts(
header: Header,
payload: ByteSlice,
) -> NonNull<Packet> {
let payload = if payload == ByteSlice::INVALID { let payload = if payload == ByteSlice::INVALID {
None None
} else { } else {
@ -32,25 +29,12 @@ pub unsafe extern "C" fn sp_packet_from_parts(
heap_move_nonnull(Packet { header, payload }) heap_move_nonnull(Packet { header, payload })
} }
/// Returns a pointer to the header field of the provided packet.
///
/// The returned header can be changed and will be valid for the lifetime of the packet.
#[no_mangle]
pub unsafe extern "C" fn sp_packet_get_header_mut(
packet: NonNull<Packet>,
) -> NonNull<Header> {
NonNull::from(unsafe { &mut (*packet.as_ptr()).header })
}
/// Returns a pointer to the current payload of the provided packet. /// Returns a pointer to the current payload of the provided packet.
/// ///
/// Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload. /// Returns an [ByteSlice::INVALID] instance in case the packet does not have any payload.
/// ///
/// The returned memory can be changed and will be valid until a new payload is set. /// The returned memory can be changed and will be valid until a new payload is set.
#[no_mangle] fn get_payload(packet: NonNull<Packet>) -> ByteSlice {
pub unsafe extern "C" fn sp_packet_get_payload(
packet: NonNull<Packet>,
) -> ByteSlice {
unsafe { unsafe {
match &mut (*packet.as_ptr()).payload { match &mut (*packet.as_ptr()).payload {
None => ByteSlice::INVALID, None => ByteSlice::INVALID,
@ -62,11 +46,7 @@ pub unsafe extern "C" fn sp_packet_get_payload(
/// Sets the payload of the provided packet to the provided data. /// Sets the payload of the provided packet to the provided data.
/// ///
/// This makes previous payload pointers invalid. /// This makes previous payload pointers invalid.
#[no_mangle] fn set_payload(packet: NonNull<Packet>, data: ByteSlice) {
pub unsafe extern "C" fn sp_packet_set_payload(
packet: NonNull<Packet>,
data: ByteSlice,
) {
unsafe { unsafe {
(*packet.as_ptr()).payload = if data == ByteSlice::INVALID { (*packet.as_ptr()).payload = if data == ByteSlice::INVALID {
None None
@ -81,15 +61,12 @@ pub unsafe extern "C" fn sp_packet_set_payload(
/// # Panics /// # Panics
/// ///
/// - if the buffer is not big enough to hold header+payload. /// - if the buffer is not big enough to hold header+payload.
#[no_mangle] fn serialize_to(packet: NonNull<Packet>, buffer: ByteSlice) -> usize {
pub unsafe extern "C" fn sp_packet_serialize_to(
packet: NonNull<Packet>,
mut buffer: ByteSlice,
) {
unsafe { unsafe {
packet.as_ref().serialize_to(buffer.as_slice_mut()); packet.as_ref().serialize_to(buffer.as_slice_mut()).unwrap_or(0)
} }
} }
);
wrap_clone!(sp_packet::Packet); wrap_clone!(sp_packet::Packet);
wrap_free!(sp_packet::Packet); wrap_free!(sp_packet::Packet);
@ -98,15 +75,17 @@ wrap_fields!(
sp_packet::Packet; sp_packet::Packet;
prop header: Header { prop header: Header {
get(); get();
mut get();
set(value); set(value);
}; };
); );
wrap_functions!(sp;
/// Converts u16 into [CommandCode]. /// Converts u16 into [CommandCode].
/// ///
/// If the provided value is not valid, false is returned and result is not changed. /// If the provided value is not valid, false is returned and result is not changed.
#[no_mangle] fn u16_to_command_code(
pub unsafe extern "C" fn sp_u16_to_command_code(
code: u16, code: u16,
result: *mut CommandCode, result: *mut CommandCode,
) -> bool { ) -> bool {
@ -120,3 +99,5 @@ pub unsafe extern "C" fn sp_u16_to_command_code(
Err(_) => false, Err(_) => false,
} }
} }
);

View file

@ -1,6 +1,6 @@
use crate::{ use crate::{
commands::{CommandTag, SPCommand}, commands::{CommandTag, SPCommand},
macros::wrap_free, macros::{wrap_free, wrap_functions},
mem::{heap_move_ok, heap_remove}, mem::{heap_move_ok, heap_remove},
}; };
use servicepoint::{Header, Packet, UdpSocketExt}; use servicepoint::{Header, Packet, UdpSocketExt};
@ -10,6 +10,10 @@ use std::{
ptr::NonNull, ptr::NonNull,
}; };
wrap_free!(sp_udp::UdpSocket);
wrap_functions!(sp_udp;
/// Creates a new instance of [UdpSocket]. /// Creates a new instance of [UdpSocket].
/// ///
/// returns: NULL if connection fails, or connected instance /// returns: NULL if connection fails, or connected instance
@ -21,8 +25,7 @@ use std::{
/// if (connection != NULL) /// if (connection != NULL)
/// sp_udp_send_command(connection, sp_command_clear()); /// sp_udp_send_command(connection, sp_command_clear());
/// ``` /// ```
#[no_mangle] fn open(host: NonNull<c_char>) -> *mut UdpSocket {
pub unsafe extern "C" fn sp_udp_open(host: NonNull<c_char>) -> *mut UdpSocket {
let host = unsafe { CStr::from_ptr(host.as_ptr()) } let host = unsafe { CStr::from_ptr(host.as_ptr()) }
.to_str() .to_str()
.expect("Bad encoding"); .expect("Bad encoding");
@ -41,14 +44,7 @@ pub unsafe extern "C" fn sp_udp_open(host: NonNull<c_char>) -> *mut UdpSocket {
/// if (connection != NULL) /// if (connection != NULL)
/// sp_udp_send_command(connection, sp_command_clear()); /// sp_udp_send_command(connection, sp_command_clear());
/// ``` /// ```
#[no_mangle] fn open_ipv4(ip1: u8, ip2: u8, ip3: u8, ip4: u8, port: u16) -> *mut UdpSocket {
pub unsafe extern "C" fn sp_udp_open_ipv4(
ip1: u8,
ip2: u8,
ip3: u8,
ip4: u8,
port: u16,
) -> *mut UdpSocket {
let addr = SocketAddrV4::new(Ipv4Addr::from([ip1, ip2, ip3, ip4]), port); let addr = SocketAddrV4::new(Ipv4Addr::from([ip1, ip2, ip3, ip4]), port);
heap_move_ok(UdpSocket::bind_connect(addr)) heap_move_ok(UdpSocket::bind_connect(addr))
} }
@ -58,11 +54,7 @@ pub unsafe extern "C" fn sp_udp_open_ipv4(
/// The passed `packet` gets consumed. /// The passed `packet` gets consumed.
/// ///
/// returns: true in case of success /// returns: true in case of success
#[no_mangle] fn send_packet(connection: NonNull<UdpSocket>, packet: NonNull<Packet>) -> bool {
pub unsafe extern "C" fn sp_udp_send_packet(
connection: NonNull<UdpSocket>,
packet: NonNull<Packet>,
) -> bool {
let packet = unsafe { heap_remove(packet) }; let packet = unsafe { heap_remove(packet) };
unsafe { connection.as_ref().send(&Vec::from(packet)) }.is_ok() unsafe { connection.as_ref().send(&Vec::from(packet)) }.is_ok()
} }
@ -78,11 +70,7 @@ pub unsafe extern "C" fn sp_udp_send_packet(
/// ```C /// ```C
/// sp_udp_send_command(connection, sp_command_brightness(5)); /// sp_udp_send_command(connection, sp_command_brightness(5));
/// ``` /// ```
#[no_mangle] fn send_command(connection: NonNull<UdpSocket>, command: SPCommand) -> bool {
pub unsafe extern "C" fn sp_udp_send_command(
connection: NonNull<UdpSocket>,
command: SPCommand,
) -> bool {
unsafe { unsafe {
match command.tag { match command.tag {
CommandTag::Invalid => return false, CommandTag::Invalid => return false,
@ -130,11 +118,7 @@ pub unsafe extern "C" fn sp_udp_send_command(
/// ```C /// ```C
/// sp_udp_send_header(connection, sp_command_brightness(5)); /// sp_udp_send_header(connection, sp_command_brightness(5));
/// ``` /// ```
#[no_mangle] fn send_header(udp_connection: NonNull<UdpSocket>, header: Header) -> bool {
pub unsafe extern "C" fn sp_udp_send_header(
udp_connection: NonNull<UdpSocket>,
header: Header,
) -> bool {
let packet = Packet { let packet = Packet {
header, header,
payload: None, payload: None,
@ -144,4 +128,4 @@ pub unsafe extern "C" fn sp_udp_send_header(
.is_ok() .is_ok()
} }
wrap_free!(sp_udp::UdpSocket); );