servicepoint/servicepoint-binding-c
0
2
Fork 0
Code Issues 1 Pull requests 1 Projects Releases 2 Packages Wiki Activity Actions

CCommand (opaque wrapper around Command for C)

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-08-29 20:39:42 +02:00
parent d2369446ef
commit 956e5df812
6 changed files with 107 additions and 82 deletions
Download patch file Download diff file Expand all files Collapse all files

63
crates/servicepoint_binding_c/examples/lang_c/include/servicepoint.h
View file

@ -137,6 +137,11 @@ typedef struct sp_CBitVec sp_CBitVec;
*/
typedef struct sp_CBrightnessGrid sp_CBrightnessGrid;
/**
* Opaque struct needed for correct code generation.
*/
typedef struct sp_CCommand sp_CCommand;
/**
* A C-wrapper for grid containing codepage 437 characters.
*
@ -588,9 +593,9 @@ size_t sp_brightness_grid_width(const struct sp_CBrightnessGrid *this_);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_bitmap_linear(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
struct sp_CCommand *sp_command_bitmap_linear(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
/**
* Allocates a new `Command::BitmapLinearAnd` instance.
@ -606,9 +611,9 @@ struct sp_Command *sp_command_bitmap_linear(sp_Offset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_bitmap_linear_and(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
struct sp_CCommand *sp_command_bitmap_linear_and(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
/**
* Allocates a new `Command::BitmapLinearOr` instance.
@ -624,9 +629,9 @@ struct sp_Command *sp_command_bitmap_linear_and(sp_Offset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_bitmap_linear_or(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
struct sp_CCommand *sp_command_bitmap_linear_or(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
/**
* Allocates a new `Command::BitmapLinearWin` instance.
@ -642,10 +647,10 @@ struct sp_Command *sp_command_bitmap_linear_or(sp_Offset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_bitmap_linear_win(size_t x,
size_t y,
struct sp_PixelGrid *pixel_grid,
sp_CompressionCode compression_code);
struct sp_CCommand *sp_command_bitmap_linear_win(size_t x,
size_t y,
struct sp_PixelGrid *pixel_grid,
sp_CompressionCode compression_code);
/**
* Allocates a new `Command::BitmapLinearXor` instance.
@ -661,9 +666,9 @@ struct sp_Command *sp_command_bitmap_linear_win(size_t x,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_bitmap_linear_xor(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
struct sp_CCommand *sp_command_bitmap_linear_xor(sp_Offset offset,
struct sp_CBitVec *bit_vec,
sp_CompressionCode compression);
/**
* Allocates a new `Command::Brightness` instance for setting the brightness of all tiles to the
@ -680,7 +685,7 @@ struct sp_Command *sp_command_bitmap_linear_xor(sp_Offset offset,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_brightness(uint8_t brightness);
struct sp_CCommand *sp_command_brightness(uint8_t brightness);
/**
* Allocates a new `Command::CharBrightness` instance.
@ -695,9 +700,9 @@ struct sp_Command *sp_command_brightness(uint8_t brightness);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_char_brightness(size_t x,
size_t y,
struct sp_CBrightnessGrid *byte_grid);
struct sp_CCommand *sp_command_char_brightness(size_t x,
size_t y,
struct sp_CBrightnessGrid *byte_grid);
/**
* Allocates a new `Command::Clear` instance.
@ -709,7 +714,7 @@ struct sp_Command *sp_command_char_brightness(size_t x,
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_clear(void);
struct sp_CCommand *sp_command_clear(void);
/**
* Clones a `Command` instance.
@ -723,7 +728,7 @@ struct sp_Command *sp_command_clear(void);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_clone(const struct sp_Command *original);
struct sp_CCommand *sp_command_clone(const struct sp_CCommand *original);
/**
* Allocates a new `Command::Cp437Data` instance.
@ -738,9 +743,9 @@ struct sp_Command *sp_command_clone(const struct sp_Command *original);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_cp437_data(size_t x,
size_t y,
struct sp_CCp437Grid *byte_grid);
struct sp_CCommand *sp_command_cp437_data(size_t x,
size_t y,
struct sp_CCp437Grid *byte_grid);
/**
* Deallocates a `Command`.
@ -753,7 +758,7 @@ struct sp_Command *sp_command_cp437_data(size_t x,
* - `this` is not used concurrently or after this call
* - `this` was not passed to another consuming function, e.g. to create a `Packet`
*/
void sp_command_dealloc(struct sp_Command *ptr);
void sp_command_dealloc(struct sp_CCommand *ptr);
/**
* Allocates a new `Command::FadeOut` instance.
@ -765,7 +770,7 @@ void sp_command_dealloc(struct sp_Command *ptr);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_fade_out(void);
struct sp_CCommand *sp_command_fade_out(void);
/**
* Allocates a new `Command::HardReset` instance.
@ -777,7 +782,7 @@ struct sp_Command *sp_command_fade_out(void);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_hard_reset(void);
struct sp_CCommand *sp_command_hard_reset(void);
/**
* Tries to turn a `Packet` into a `Command`. The packet is deallocated in the process.
@ -794,7 +799,7 @@ struct sp_Command *sp_command_hard_reset(void);
* - the returned `Command` instance is freed in some way, either by using a consuming function or
* by explicitly calling `sp_command_dealloc`.
*/
struct sp_Command *sp_command_try_from_packet(struct sp_Packet *packet);
struct sp_CCommand *sp_command_try_from_packet(struct sp_Packet *packet);
/**
* Closes and deallocates a `Connection`.

2
crates/servicepoint_binding_c/examples/lang_c/src/main.c
View file

@ -9,7 +9,7 @@ int main(void) {
sp_PixelGrid *pixels = sp_pixel_grid_new(sp_PIXEL_WIDTH, sp_PIXEL_HEIGHT);
sp_pixel_grid_fill(pixels, true);
sp_Command *command = sp_command_bitmap_linear_win(0, 0, pixels, Uncompressed);
sp_CCommand *command = sp_command_bitmap_linear_win(0, 0, pixels, Uncompressed);
sp_Packet *packet = sp_packet_from_command(command);
if (!sp_connection_send(connection, packet))
return 1;