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

even more functions wrapped with macro

Browse source
This commit is contained in:
Vinzenz Schroeter 2025-06-18 22:40:04 +02:00
parent 21987d05f3
commit c492cfab6b
8 changed files with 249 additions and 331 deletions
Download patch file Download diff file Expand all files Collapse all files

126
include/servicepoint.h
View file

@ -1,7 +1,7 @@
#ifndef 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. */
@ -1254,14 +1254,14 @@ void sp_cmd_bitmap_free(struct BitmapCommand */*notnull*/ instance);
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 bitmap inherits the lifetime of the command in which it is contained.
* - 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_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`].
@ -1271,7 +1271,9 @@ struct Bitmap */*notnull*/ sp_cmd_bitmap_get(struct BitmapCommand */*notnull*/ c
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,
size_t */*notnull*/ origin_x,
@ -1292,10 +1294,13 @@ struct BitmapCommand */*notnull*/ sp_cmd_bitmap_new(struct Bitmap */*notnull*/ b
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,
struct Bitmap */*notnull*/ bitmap);
void sp_cmd_bitmap_set_bitmap(struct BitmapCommand */*notnull*/ instance,
struct Bitmap */*notnull*/ value);
/**
* Sets the value of field `compression` of the [`servicepoint::BitmapCommand`].
@ -1306,7 +1311,9 @@ void sp_cmd_bitmap_set_compression(struct BitmapCommand */*notnull*/ instance,
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,
size_t origin_x,
@ -1336,9 +1343,14 @@ struct BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(struct BitVecCommand */*no
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`].
@ -1383,10 +1395,13 @@ struct BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec,
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,
BitVec */*notnull*/ bitvec);
void sp_cmd_bitvec_set_bitvec(struct BitVecCommand */*notnull*/ instance,
BitVec */*notnull*/ value);
/**
* Sets the value of field `compression` of the [`servicepoint::BitVecCommand`].
@ -1489,12 +1504,19 @@ void sp_cmd_brightness_grid_free(struct BrightnessGridCommand */*notnull*/ insta
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,
size_t */*notnull*/ origin_x,
@ -1523,13 +1545,18 @@ struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessG
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,
BrightnessGrid */*notnull*/ grid);
void sp_cmd_brightness_grid_set_grid(struct BrightnessGridCommand */*notnull*/ instance,
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,
size_t origin_x,
@ -1558,12 +1585,19 @@ void sp_cmd_char_grid_free(struct CharGridCommand */*notnull*/ instance);
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,
size_t */*notnull*/ origin_x,
@ -1583,13 +1617,18 @@ struct CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ g
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,
CharGrid */*notnull*/ grid);
void sp_cmd_char_grid_set_grid(struct CharGridCommand */*notnull*/ instance,
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,
size_t origin_x,
@ -1645,19 +1684,19 @@ void sp_cmd_cp437_grid_free(struct Cp437GridCommand */*notnull*/ instance);
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.
* For sending UTF-8 encoded characters, see [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.
*
* [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,
size_t */*notnull*/ origin_x,
@ -1677,17 +1716,18 @@ struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_new(Cp437Grid */*notnull*
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,
Cp437Grid */*notnull*/ grid);
void sp_cmd_cp437_grid_set_grid(struct Cp437GridCommand */*notnull*/ instance,
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,
size_t origin_x,