From 02f629c68b93ecb97f61f0d23f77b7548bd7b425 Mon Sep 17 00:00:00 2001
From: Vinzenz Schroeter <vinzenz.f.s@gmail.com>
Date: Mon, 16 Jun 2025 21:26:58 +0200
Subject: [PATCH] generate some functions with macros, cbindgen 0.29
---
Cargo.lock | 15 ++-
Cargo.toml | 5 +-
build.rs | 50 ++++-----
cbindgen.toml | 3 +-
include/servicepoint.h | 129 ++++++++++------------
src/commands/bitmap_command.rs | 22 +---
src/commands/bitvec_command.rs | 22 +---
src/commands/brightness_grid_command.rs | 28 +----
src/commands/cc_only_commands.rs | 22 +---
src/commands/char_grid_command.rs | 26 +----
src/commands/cp437_grid_command.rs | 28 +----
src/commands/generic_command.rs | 2 +-
src/commands/global_brightness_command.rs | 25 +----
src/containers/bitmap.rs | 21 +---
src/containers/bitvec.rs | 20 +---
src/containers/brightness_grid.rs | 26 +----
src/containers/byte_slice.rs | 4 +-
src/containers/char_grid.rs | 20 +---
src/containers/cp437_grid.rs | 21 +---
src/lib.rs | 1 +
src/macros.rs | 25 +++++
src/packet.rs | 20 +---
src/udp.rs | 9 +-
23 files changed, 195 insertions(+), 349 deletions(-)
create mode 100644 src/macros.rs
diff --git a/Cargo.lock b/Cargo.lock
index 121e01f..a4f755c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -106,9 +106,9 @@ dependencies = [
[[package]]
name = "cbindgen"
-version = "0.28.0"
+version = "0.29.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "eadd868a2ce9ca38de7eeafdcec9c7065ef89b42b32f0839278d55f35c54d1ff"
+checksum = "975982cdb7ad6a142be15bdf84aea7ec6a9e5d4d797c004d43185b24cfe4e684"
dependencies = [
"clap",
"heck",
@@ -263,9 +263,9 @@ checksum = "84b26c544d002229e640969970a2e74021aadf6e2f96372b9c58eff97de08eb3"
[[package]]
name = "heck"
-version = "0.4.1"
+version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "indexmap"
@@ -368,6 +368,12 @@ version = "1.70.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a4895175b425cb1f87721b59f0f286c2092bd4af812243672510e1ac53e2e0ad"
+[[package]]
+name = "paste"
+version = "1.0.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a"
+
[[package]]
name = "pkg-config"
version = "0.3.32"
@@ -540,6 +546,7 @@ version = "0.15.0"
dependencies = [
"cbindgen",
"env_logger",
+ "paste",
"servicepoint",
]
diff --git a/Cargo.toml b/Cargo.toml
index f6bd53b..668edcc 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -15,7 +15,7 @@ keywords = ["cccb", "cccb-servicepoint", "cbindgen"]
crate-type = ["staticlib", "cdylib", "rlib"]
[build-dependencies]
-cbindgen = "0.28.0"
+cbindgen = "0.29.0"
[dependencies.servicepoint]
version = "0.15.0"
@@ -25,6 +25,9 @@ default-features = false
version = "0.11.8"
optional = true
+[dependencies]
+paste = "1.0.15"
+
[features]
all_compressions = ["servicepoint/all_compressions"]
default = ["all_compressions", "servicepoint/default", "env_logger"]
diff --git a/build.rs b/build.rs
index 397341d..a353ecd 100644
--- a/build.rs
+++ b/build.rs
@@ -8,6 +8,13 @@ use std::{env, fs};
fn main() {
let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+ let is_recursive = env::var("SERVICEPOINT_IS_BUILDING")
+ .unwrap_or("".to_string())
+ == "true";
+ unsafe {
+ env::set_var("SERVICEPOINT_IS_BUILDING", "true");
+ }
+
println!("cargo::rerun-if-changed={crate_dir}/src");
println!("cargo::rerun-if-changed={crate_dir}/build.rs");
println!("cargo::rerun-if-changed={crate_dir}/Cargo.toml");
@@ -18,41 +25,32 @@ fn main() {
let config =
cbindgen::Config::from_file(crate_dir.clone() + "/cbindgen.toml")
.unwrap();
- let output_dir = env::var("OUT_DIR").unwrap();
+
+ let output_dir = &env::var("OUT_DIR").unwrap();
let header_file = output_dir.clone() + "/servicepoint.h";
- let bindings = match cbindgen::generate_with_config(crate_dir, config) {
- Ok(bindings) => bindings,
- Err(e) => {
- eprintln!("cargo:warning=Servicepoint header could not be generated: {e:?}");
- return;
- }
- };
+ let bindings = cbindgen::generate_with_config(crate_dir, config)
+ .expect("Servicepoint header could not be generated");
bindings.write_to_file(&header_file);
println!("cargo:include={output_dir}");
- if let Ok(header_out) = env::var("SERVICEPOINT_HEADER_OUT") {
- let header_copy = header_out + "/servicepoint.h";
-
- if fs::exists(&header_copy).unwrap_or(false) {
- // check if content changed to prevent rebuild of dependents if not
+ if is_recursive {
+ return;
+ }
- let mut bindings_text = Vec::new();
- bindings.write(&mut bindings_text);
-
- match fs::read(&header_copy) {
- Ok(old_content) if old_content == bindings_text => {
- println!("cargo:warning=Header did not change, not updating timestamp");
- return;
- }
- _ => {}
- };
+ if let Ok(header_out) = env::var("SERVICEPOINT_HEADER_OUT") {
+ if !fs::exists(&header_out).unwrap() {
+ panic!(
+ "SERVICEPOINT_HEADER_OUT is not set to an existing directory"
+ );
}
-
- // file does not exist or is different
+
+ let header_copy = header_out + "/servicepoint.h";
+
println!("cargo:warning=Copying header to {header_copy}");
- fs::copy(header_file, &header_copy).unwrap();
+ fs::copy(header_file, &header_copy)
+ .expect("header could not be copied to SERVICEPOINT_HEADER_OUT");
println!("cargo::rerun-if-changed={header_copy}");
}
}
diff --git a/cbindgen.toml b/cbindgen.toml
index 6edd33f..2341192 100644
--- a/cbindgen.toml
+++ b/cbindgen.toml
@@ -30,7 +30,8 @@ include = ["servicepoint", "std"]
extra_bindings = ["servicepoint", "servicepoint_binding_c"]
[parse.expand]
-features = ["full"]
+crates = ["servicepoint_binding_c", "paste"]
+features = []
[export]
include = []
diff --git a/include/servicepoint.h b/include/servicepoint.h
index 3721527..4caa011 100644
--- a/include/servicepoint.h
+++ b/include/servicepoint.h
@@ -1,7 +1,7 @@
#ifndef SERVICEPOINT_BINDINGS_C
#define SERVICEPOINT_BINDINGS_C
-/* Generated with cbindgen:0.28.0 */
+/* Generated with cbindgen:0.29.0 */
/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
@@ -640,9 +640,9 @@ extern "C" {
void init_env_logger(void);
/**
- * Clones a [Bitmap].
+ *Clones a [Bitmap] instance.
*/
-struct Bitmap */*notnull*/ sp_bitmap_clone(struct Bitmap */*notnull*/ bitmap);
+struct Bitmap */*notnull*/ sp_bitmap_clone(struct Bitmap */*notnull*/ instance);
/**
* Sets the state of all pixels in the [Bitmap].
@@ -655,9 +655,9 @@ struct Bitmap */*notnull*/ sp_bitmap_clone(struct Bitmap */*notnull*/ bitmap);
void sp_bitmap_fill(struct Bitmap */*notnull*/ bitmap, bool value);
/**
- * Deallocates a [Bitmap].
+ *Deallocates a [Bitmap] instance.
*/
-void sp_bitmap_free(struct Bitmap */*notnull*/ bitmap);
+void sp_bitmap_free(struct Bitmap */*notnull*/ instance);
/**
* Tries to convert the BitVec to a Bitmap.
@@ -801,9 +801,9 @@ struct ByteSlice sp_bitmap_unsafe_data_ref(struct Bitmap */*notnull*/ bitmap);
size_t sp_bitmap_width(struct Bitmap */*notnull*/ bitmap);
/**
- * Clones a [DisplayBitVec].
+ *Clones a [DisplayBitVec] instance.
*/
-BitVec */*notnull*/ sp_bitvec_clone(BitVec */*notnull*/ bit_vec);
+BitVec */*notnull*/ sp_bitvec_clone(BitVec */*notnull*/ instance);
/**
* Sets the value of all bits in the [DisplayBitVec].
@@ -816,9 +816,9 @@ BitVec */*notnull*/ sp_bitvec_clone(BitVec */*notnull*/ bit_vec);
void sp_bitvec_fill(BitVec */*notnull*/ bit_vec, bool value);
/**
- * Deallocates a [DisplayBitVec].
+ *Deallocates a [DisplayBitVec] instance.
*/
-void sp_bitvec_free(BitVec */*notnull*/ bit_vec);
+void sp_bitvec_free(BitVec */*notnull*/ instance);
/**
* Gets the value of a bit from the [DisplayBitVec].
@@ -915,9 +915,9 @@ void sp_bitvec_set(BitVec */*notnull*/ bit_vec, size_t index, bool value);
struct ByteSlice sp_bitvec_unsafe_data_ref(BitVec */*notnull*/ bit_vec);
/**
- * Clones a [BrightnessGrid].
+ *Clones a [BrightnessGrid] instance.
*/
-BrightnessGrid */*notnull*/ sp_brightness_grid_clone(BrightnessGrid */*notnull*/ grid);
+BrightnessGrid */*notnull*/ sp_brightness_grid_clone(BrightnessGrid */*notnull*/ instance);
/**
* Sets the value of all cells in the [BrightnessGrid].
@@ -931,9 +931,9 @@ void sp_brightness_grid_fill(BrightnessGrid */*notnull*/ brightness_grid,
Brightness value);
/**
- * Deallocates a [BrightnessGrid].
+ *Deallocates a [BrightnessGrid] instance.
*/
-void sp_brightness_grid_free(BrightnessGrid */*notnull*/ brightness_grid);
+void sp_brightness_grid_free(BrightnessGrid */*notnull*/ instance);
/**
* Gets the current value at the specified position.
@@ -1051,9 +1051,9 @@ struct ByteSlice sp_brightness_grid_unsafe_data_ref(BrightnessGrid */*notnull*/
size_t sp_brightness_grid_width(BrightnessGrid */*notnull*/ brightness_grid);
/**
- * Clones a [CharGrid].
+ *Clones a [CharGrid] instance.
*/
-CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ grid);
+CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ instance);
/**
* Sets the value of all cells in the [CharGrid].
@@ -1066,9 +1066,9 @@ CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ grid);
void sp_char_grid_fill(CharGrid */*notnull*/ char_grid, uint32_t value);
/**
- * Deallocates a [CharGrid].
+ *Deallocates a [CharGrid] instance.
*/
-void sp_char_grid_free(CharGrid */*notnull*/ char_grid);
+void sp_char_grid_free(CharGrid */*notnull*/ instance);
/**
* Returns the current value at the specified position.
@@ -1157,16 +1157,14 @@ 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.
+ *Clones a [BitmapCommand] instance.
*/
-struct BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(struct BitmapCommand */*notnull*/ command);
+struct BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(struct BitmapCommand */*notnull*/ instance);
/**
- * Deallocates a [BitmapCommand] instance.
+ *Deallocates a [BitmapCommand] instance.
*/
-void sp_cmd_bitmap_free(struct BitmapCommand */*notnull*/ command);
+void sp_cmd_bitmap_free(struct BitmapCommand */*notnull*/ instance);
/**
* Move the provided [Bitmap] into a new [BitmapCommand],
@@ -1237,16 +1235,14 @@ void sp_cmd_bitmap_set_origin(struct BitmapCommand */*notnull*/ command,
struct Packet *sp_cmd_bitmap_try_into_packet(struct BitmapCommand */*notnull*/ command);
/**
- * Clones an [BitVecCommand] instance.
- *
- * returns: a new [BitVecCommand] instance.
+ *Clones a [BitVecCommand] instance.
*/
-struct BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(struct BitVecCommand */*notnull*/ command);
+struct BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(struct BitVecCommand */*notnull*/ instance);
/**
- * Deallocates a [BitVecCommand].
+ *Deallocates a [BitVecCommand] instance.
*/
-void sp_cmd_bitvec_free(struct BitVecCommand */*notnull*/ command);
+void sp_cmd_bitvec_free(struct BitVecCommand */*notnull*/ instance);
/**
* Returns a pointer to the [BitVec] contained in the [BitVecCommand].
@@ -1319,13 +1315,14 @@ void sp_cmd_bitvec_set_operation(struct BitVecCommand */*notnull*/ command,
struct Packet *sp_cmd_bitvec_try_into_packet(struct BitVecCommand */*notnull*/ command);
/**
- * Clones an [GlobalBrightnessCommand] instance.
- *
- * returns: a new [GlobalBrightnessCommand] instance.
+ *Clones a [GlobalBrightnessCommand] instance.
*/
-struct GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_clone(struct GlobalBrightnessCommand */*notnull*/ command);
+struct GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_clone(struct GlobalBrightnessCommand */*notnull*/ instance);
-void sp_cmd_brightness_global_free(struct BitmapCommand */*notnull*/ command);
+/**
+ *Deallocates a [GlobalBrightnessCommand] instance.
+ */
+void sp_cmd_brightness_global_free(struct GlobalBrightnessCommand */*notnull*/ instance);
Brightness sp_cmd_brightness_global_get(struct GlobalBrightnessCommand */*notnull*/ command);
@@ -1345,16 +1342,14 @@ void sp_cmd_brightness_global_set(struct GlobalBrightnessCommand */*notnull*/ co
Brightness brightness);
/**
- * Clones an [BrightnessGridCommand] instance.
- *
- * returns: a new [BrightnessGridCommand] instance.
+ *Clones a [BrightnessGridCommand] instance.
*/
-struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_clone(struct BrightnessGridCommand */*notnull*/ command);
+struct BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_clone(struct BrightnessGridCommand */*notnull*/ instance);
/**
- * Deallocates a [BitmapCommand].
+ *Deallocates a [BrightnessGridCommand] instance.
*/
-void sp_cmd_brightness_grid_free(struct BitmapCommand */*notnull*/ command);
+void sp_cmd_brightness_grid_free(struct BrightnessGridCommand */*notnull*/ instance);
/**
* Moves the provided [BrightnessGrid] into a new [BrightnessGridCommand],
@@ -1406,16 +1401,14 @@ void sp_cmd_brightness_grid_set_origin(struct BrightnessGridCommand */*notnull*/
size_t origin_y);
/**
- * Clones an [CharGridCommand] instance.
- *
- * returns: a new [CharGridCommand] instance.
+ *Clones a [CharGridCommand] instance.
*/
-struct CharGridCommand */*notnull*/ sp_cmd_char_grid_clone(struct CharGridCommand */*notnull*/ command);
+struct CharGridCommand */*notnull*/ sp_cmd_char_grid_clone(struct CharGridCommand */*notnull*/ instance);
/**
- * Deallocates a [BitmapCommand].
+ *Deallocates a [CharGridCommand] instance.
*/
-void sp_cmd_char_grid_free(struct BitmapCommand */*notnull*/ command);
+void sp_cmd_char_grid_free(struct CharGridCommand */*notnull*/ instance);
/**
* Moves the provided [CharGrid] into a new [CharGridCommand],
@@ -1467,9 +1460,9 @@ void sp_cmd_char_grid_set_origin(struct CharGridCommand */*notnull*/ command,
struct Packet *sp_cmd_char_grid_try_into_packet(struct CharGridCommand */*notnull*/ command);
/**
- * Deallocates a [ClearCommand].
+ *Deallocates a [ClearCommand] instance.
*/
-void sp_cmd_clear_free(struct ClearCommand */*notnull*/ command);
+void sp_cmd_clear_free(struct ClearCommand */*notnull*/ instance);
/**
* Set all pixels to the off state.
@@ -1481,16 +1474,14 @@ void sp_cmd_clear_free(struct ClearCommand */*notnull*/ command);
struct ClearCommand */*notnull*/ sp_cmd_clear_new(void);
/**
- * Clones an [Cp437GridCommand] instance.
- *
- * returns: a new [Cp437GridCommand] instance.
+ *Clones a [Cp437GridCommand] instance.
*/
-struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_clone(struct Cp437GridCommand */*notnull*/ command);
+struct Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_clone(struct Cp437GridCommand */*notnull*/ instance);
/**
- * Deallocates a [Cp437GridCommand].
+ *Deallocates a [Cp437GridCommand] instance.
*/
-void sp_cmd_cp437_grid_free(struct BitmapCommand */*notnull*/ command);
+void sp_cmd_cp437_grid_free(struct Cp437GridCommand */*notnull*/ instance);
/**
* Moves the provided [Cp437Grid] into a new [Cp437GridCommand],
@@ -1553,9 +1544,9 @@ void sp_cmd_cp437_grid_set_origin(struct Cp437GridCommand */*notnull*/ command,
struct Packet *sp_cmd_cp437_grid_try_into_packet(struct Cp437GridCommand */*notnull*/ command);
/**
- * Deallocates a [FadeOutCommand].
+ *Deallocates a [FadeOutCommand] instance.
*/
-void sp_cmd_fade_out_free(struct ClearCommand */*notnull*/ command);
+void sp_cmd_fade_out_free(struct FadeOutCommand */*notnull*/ instance);
/**
* A yet-to-be-tested command.
@@ -1603,9 +1594,9 @@ struct Packet *sp_cmd_generic_into_packet(struct Command command);
struct Command sp_cmd_generic_try_from_packet(struct Packet */*notnull*/ packet);
/**
- * Deallocates a [HardResetCommand].
+ *Deallocates a [HardResetCommand] instance.
*/
-void sp_cmd_hard_reset_free(struct ClearCommand */*notnull*/ command);
+void sp_cmd_hard_reset_free(struct HardResetCommand */*notnull*/ instance);
/**
* Kills the udp daemon on the display, which usually results in a restart.
@@ -1617,9 +1608,9 @@ void sp_cmd_hard_reset_free(struct ClearCommand */*notnull*/ command);
struct HardResetCommand */*notnull*/ sp_cmd_hard_reset_new(void);
/**
- * Clones a [Cp437Grid].
+ *Clones a [Cp437Grid] instance.
*/
-Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ grid);
+Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ instance);
/**
* Sets the value of all cells in the [Cp437Grid].
@@ -1632,9 +1623,9 @@ Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ grid);
void sp_cp437_grid_fill(Cp437Grid */*notnull*/ cp437_grid, uint8_t value);
/**
- * Deallocates a [Cp437Grid].
+ *Deallocates a [Cp437Grid] instance.
*/
-void sp_cp437_grid_free(Cp437Grid */*notnull*/ cp437_grid);
+void sp_cp437_grid_free(Cp437Grid */*notnull*/ instance);
/**
* Gets the current value at the specified position.
@@ -1723,16 +1714,14 @@ struct ByteSlice sp_cp437_grid_unsafe_data_ref(Cp437Grid */*notnull*/ cp437_grid
size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ cp437_grid);
/**
- * Clones a [Packet].
- *
- * returns: a new [Packet] instance.
+ *Clones a [Packet] instance.
*/
-struct Packet */*notnull*/ sp_packet_clone(struct Packet */*notnull*/ packet);
+struct Packet */*notnull*/ sp_packet_clone(struct Packet */*notnull*/ instance);
/**
- * Deallocates a [Packet].
+ *Deallocates a [Packet] instance.
*/
-void sp_packet_free(struct Packet */*notnull*/ packet);
+void sp_packet_free(struct Packet */*notnull*/ instance);
/**
* Creates a raw [Packet] from parts.
@@ -1792,9 +1781,9 @@ bool sp_u16_to_command_code(uint16_t code,
CommandCode *result);
/**
- * Closes and deallocates a [UdpSocket].
+ *Deallocates a [UdpSocket] instance.
*/
-void sp_udp_free(struct UdpSocket */*notnull*/ connection);
+void sp_udp_free(struct UdpSocket */*notnull*/ instance);
/**
* Creates a new instance of [UdpSocket].
diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs
index 286a6f1..6018b33 100644
--- a/src/commands/bitmap_command.rs
+++ b/src/commands/bitmap_command.rs
@@ -1,5 +1,6 @@
-use crate::mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
use servicepoint::{Bitmap, BitmapCommand, CompressionCode, Origin, Packet};
use std::ptr::NonNull;
@@ -44,21 +45,8 @@ pub unsafe extern "C" fn sp_cmd_bitmap_try_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<BitmapCommand>,
-) -> NonNull<BitmapCommand> {
- unsafe { heap_clone(command) }
-}
-
-/// Deallocates a [BitmapCommand] instance.
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_bitmap_free(command: NonNull<BitmapCommand>) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(BitmapCommand, sp_cmd_bitmap);
+wrap_free!(BitmapCommand, sp_cmd_bitmap);
/// Returns a pointer to the provided `BitmapCommand`.
///
diff --git a/src/commands/bitvec_command.rs b/src/commands/bitvec_command.rs
index b49cdc5..b3eb843 100644
--- a/src/commands/bitvec_command.rs
+++ b/src/commands/bitvec_command.rs
@@ -1,5 +1,6 @@
-use crate::mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
use servicepoint::{
BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Offset,
@@ -44,21 +45,8 @@ pub unsafe extern "C" fn sp_cmd_bitvec_try_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<BitVecCommand>,
-) -> NonNull<BitVecCommand> {
- unsafe { heap_clone(command) }
-}
-
-/// Deallocates a [BitVecCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_bitvec_free(command: NonNull<BitVecCommand>) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(BitVecCommand, sp_cmd_bitvec);
+wrap_free!(BitVecCommand, sp_cmd_bitvec);
/// Returns a pointer to the [BitVec] contained in the [BitVecCommand].
#[no_mangle]
diff --git a/src/commands/brightness_grid_command.rs b/src/commands/brightness_grid_command.rs
index 7410f2d..7803486 100644
--- a/src/commands/brightness_grid_command.rs
+++ b/src/commands/brightness_grid_command.rs
@@ -1,9 +1,8 @@
-use crate::mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
-};
-use servicepoint::{
- BitmapCommand, BrightnessGrid, BrightnessGridCommand, Origin, Packet,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
+use servicepoint::{BrightnessGrid, BrightnessGridCommand, Origin, Packet};
use std::ptr::NonNull;
/// Set the brightness of individual tiles in a rectangular area of the display.
@@ -42,23 +41,8 @@ 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<BrightnessGridCommand>,
-) -> NonNull<BrightnessGridCommand> {
- unsafe { heap_clone(command) }
-}
-
-/// Deallocates a [BitmapCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_brightness_grid_free(
- command: NonNull<BitmapCommand>,
-) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(BrightnessGridCommand, sp_cmd_brightness_grid);
+wrap_free!(BrightnessGridCommand, sp_cmd_brightness_grid);
/// Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand].
#[no_mangle]
diff --git a/src/commands/cc_only_commands.rs b/src/commands/cc_only_commands.rs
index 2a48c12..0acfa68 100644
--- a/src/commands/cc_only_commands.rs
+++ b/src/commands/cc_only_commands.rs
@@ -1,4 +1,4 @@
-use crate::mem::{heap_drop, heap_move_nonnull};
+use crate::{macros::wrap_free, mem::heap_move_nonnull};
use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand};
use std::ptr::NonNull;
@@ -12,11 +12,7 @@ pub unsafe extern "C" fn sp_cmd_clear_new() -> NonNull<ClearCommand> {
heap_move_nonnull(ClearCommand)
}
-/// Deallocates a [ClearCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_clear_free(command: NonNull<ClearCommand>) {
- unsafe { heap_drop(command) }
-}
+wrap_free!(ClearCommand, sp_cmd_clear);
/// Kills the udp daemon on the display, which usually results in a restart.
///
@@ -28,13 +24,7 @@ pub unsafe extern "C" fn sp_cmd_hard_reset_new() -> NonNull<HardResetCommand> {
heap_move_nonnull(HardResetCommand)
}
-/// Deallocates a [HardResetCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_hard_reset_free(
- command: NonNull<ClearCommand>,
-) {
- unsafe { heap_drop(command) }
-}
+wrap_free!(HardResetCommand, sp_cmd_hard_reset);
/// A yet-to-be-tested command.
///
@@ -44,8 +34,4 @@ pub unsafe extern "C" fn sp_cmd_fade_out_new() -> NonNull<FadeOutCommand> {
heap_move_nonnull(FadeOutCommand)
}
-/// Deallocates a [FadeOutCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_fade_out_free(command: NonNull<ClearCommand>) {
- unsafe { heap_drop(command) }
-}
+wrap_free!(FadeOutCommand, sp_cmd_fade_out);
diff --git a/src/commands/char_grid_command.rs b/src/commands/char_grid_command.rs
index 1fbd66c..8a6c07c 100644
--- a/src/commands/char_grid_command.rs
+++ b/src/commands/char_grid_command.rs
@@ -1,7 +1,8 @@
-use crate::mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
-use servicepoint::{BitmapCommand, CharGrid, CharGridCommand, Origin, Packet};
+use servicepoint::{CharGrid, CharGridCommand, Origin, Packet};
use std::ptr::NonNull;
/// Show UTF-8 encoded text on the screen.
@@ -40,23 +41,8 @@ pub unsafe extern "C" fn sp_cmd_char_grid_try_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<CharGridCommand>,
-) -> NonNull<CharGridCommand> {
- unsafe { heap_clone(command) }
-}
-
-/// Deallocates a [BitmapCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_char_grid_free(
- command: NonNull<BitmapCommand>,
-) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(CharGridCommand, sp_cmd_char_grid);
+wrap_free!(CharGridCommand, sp_cmd_char_grid);
/// Moves the provided [CharGrid] to be contained in the [CharGridCommand].
#[no_mangle]
diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs
index f034c6d..fc32f05 100644
--- a/src/commands/cp437_grid_command.rs
+++ b/src/commands/cp437_grid_command.rs
@@ -1,9 +1,8 @@
-use crate::mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
-};
-use servicepoint::{
- BitmapCommand, Cp437Grid, Cp437GridCommand, Origin, Packet,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
+use servicepoint::{Cp437Grid, Cp437GridCommand, Origin, Packet};
use std::ptr::NonNull;
/// Show text on the screen.
@@ -42,23 +41,8 @@ pub unsafe extern "C" fn sp_cmd_cp437_grid_try_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<Cp437GridCommand>,
-) -> NonNull<Cp437GridCommand> {
- unsafe { heap_clone(command) }
-}
-
-/// Deallocates a [Cp437GridCommand].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_cp437_grid_free(
- command: NonNull<BitmapCommand>,
-) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(Cp437GridCommand, sp_cmd_cp437_grid);
+wrap_free!(Cp437GridCommand, sp_cmd_cp437_grid);
/// Moves the provided bitmap into the provided command.
///
diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs
index 851e897..840900f 100644
--- a/src/commands/generic_command.rs
+++ b/src/commands/generic_command.rs
@@ -222,7 +222,7 @@ pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand {
}
/// Deallocates an [SPCommand].
-///
+///
/// Commands with an invalid `tag` do not have to be freed as the `data` pointer should be null.
///
/// # Examples
diff --git a/src/commands/global_brightness_command.rs b/src/commands/global_brightness_command.rs
index 6b2643e..48d21d7 100644
--- a/src/commands/global_brightness_command.rs
+++ b/src/commands/global_brightness_command.rs
@@ -1,7 +1,8 @@
-use crate::mem::{heap_clone, heap_drop, heap_move_nonnull, heap_remove};
-use servicepoint::{
- BitmapCommand, Brightness, GlobalBrightnessCommand, Packet,
+use crate::{
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_remove},
};
+use servicepoint::{Brightness, GlobalBrightnessCommand, Packet};
use std::ptr::NonNull;
/// Set the brightness of all tiles to the same value.
@@ -21,22 +22,8 @@ pub unsafe extern "C" fn sp_cmd_brightness_global_into_packet(
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<GlobalBrightnessCommand>,
-) -> NonNull<GlobalBrightnessCommand> {
- unsafe { heap_clone(command) }
-}
-
-#[no_mangle]
-pub unsafe extern "C" fn sp_cmd_brightness_global_free(
- command: NonNull<BitmapCommand>,
-) {
- unsafe { heap_drop(command) }
-}
+wrap_clone!(GlobalBrightnessCommand, sp_cmd_brightness_global);
+wrap_free!(GlobalBrightnessCommand, sp_cmd_brightness_global);
/// Moves the provided bitmap to be contained in the command.
#[no_mangle]
diff --git a/src/containers/bitmap.rs b/src/containers/bitmap.rs
index 7a1b633..63cac85 100644
--- a/src/containers/bitmap.rs
+++ b/src/containers/bitmap.rs
@@ -1,9 +1,7 @@
use crate::{
containers::ByteSlice,
- mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some,
- heap_remove,
- },
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove},
};
use servicepoint::{
Bitmap, BitmapCommand, CompressionCode, DataRef, DisplayBitVec, Grid,
@@ -82,19 +80,8 @@ pub unsafe extern "C" fn sp_bitmap_from_bitvec(
heap_move_ok(Bitmap::from_bitvec(width, bitvec))
}
-/// Clones a [Bitmap].
-#[no_mangle]
-pub unsafe extern "C" fn sp_bitmap_clone(
- bitmap: NonNull<Bitmap>,
-) -> NonNull<Bitmap> {
- unsafe { heap_clone(bitmap) }
-}
-
-/// Deallocates a [Bitmap].
-#[no_mangle]
-pub unsafe extern "C" fn sp_bitmap_free(bitmap: NonNull<Bitmap>) {
- unsafe { heap_drop(bitmap) }
-}
+wrap_clone!(Bitmap, sp_bitmap);
+wrap_free!(Bitmap, sp_bitmap);
/// Gets the current value at the specified position in the [Bitmap].
///
diff --git a/src/containers/bitvec.rs b/src/containers/bitvec.rs
index e9eeb68..5f2d7b0 100644
--- a/src/containers/bitvec.rs
+++ b/src/containers/bitvec.rs
@@ -1,8 +1,7 @@
use crate::{
containers::ByteSlice,
- mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
- },
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
use servicepoint::{
BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Packet,
@@ -36,19 +35,8 @@ pub unsafe extern "C" fn sp_bitvec_load(
heap_move_nonnull(DisplayBitVec::from_slice(data))
}
-/// Clones a [DisplayBitVec].
-#[no_mangle]
-pub unsafe extern "C" fn sp_bitvec_clone(
- bit_vec: NonNull<DisplayBitVec>,
-) -> NonNull<DisplayBitVec> {
- unsafe { heap_clone(bit_vec) }
-}
-
-/// Deallocates a [DisplayBitVec].
-#[no_mangle]
-pub unsafe extern "C" fn sp_bitvec_free(bit_vec: NonNull<DisplayBitVec>) {
- unsafe { heap_drop(bit_vec) }
-}
+wrap_clone!(DisplayBitVec, sp_bitvec);
+wrap_free!(DisplayBitVec, sp_bitvec);
/// Gets the value of a bit from the [DisplayBitVec].
///
diff --git a/src/containers/brightness_grid.rs b/src/containers/brightness_grid.rs
index 3a7ae5f..21c3636 100644
--- a/src/containers/brightness_grid.rs
+++ b/src/containers/brightness_grid.rs
@@ -1,16 +1,13 @@
use crate::{
containers::ByteSlice,
- mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some,
- heap_remove,
- },
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove},
};
use servicepoint::{
Brightness, BrightnessGrid, BrightnessGridCommand, ByteGrid, DataRef, Grid,
Origin, Packet,
};
-use std::mem::transmute;
-use std::ptr::NonNull;
+use std::{mem::transmute, ptr::NonNull};
/// Creates a new [BrightnessGrid] with the specified dimensions.
///
@@ -55,21 +52,8 @@ pub unsafe extern "C" fn sp_brightness_grid_load(
)
}
-/// Clones a [BrightnessGrid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_brightness_grid_clone(
- grid: NonNull<BrightnessGrid>,
-) -> NonNull<BrightnessGrid> {
- unsafe { heap_clone(grid) }
-}
-
-/// Deallocates a [BrightnessGrid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_brightness_grid_free(
- brightness_grid: NonNull<BrightnessGrid>,
-) {
- unsafe { heap_drop(brightness_grid) }
-}
+wrap_clone!(BrightnessGrid, sp_brightness_grid);
+wrap_free!(BrightnessGrid, sp_brightness_grid);
/// Gets the current value at the specified position.
///
diff --git a/src/containers/byte_slice.rs b/src/containers/byte_slice.rs
index 0668318..0642cfc 100644
--- a/src/containers/byte_slice.rs
+++ b/src/containers/byte_slice.rs
@@ -10,9 +10,9 @@
/// - the lifetime of the `CByteSlice` does not outlive the memory it points to, as described in
/// the function returning this type.
/// - if `start` is NULL or `length` is 0, do not dereference `start`.
-///
+///
/// # Examples
-///
+///
/// ```c
/// ByteSlice empty = {.start: NULL, .length = 0};
/// ```
diff --git a/src/containers/char_grid.rs b/src/containers/char_grid.rs
index 3363d43..5c788f4 100644
--- a/src/containers/char_grid.rs
+++ b/src/containers/char_grid.rs
@@ -1,8 +1,7 @@
use crate::{
containers::ByteSlice,
- mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove,
- },
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_remove},
};
use servicepoint::{CharGrid, CharGridCommand, Grid, Origin, Packet};
use std::ptr::NonNull;
@@ -40,19 +39,8 @@ pub unsafe extern "C" fn sp_char_grid_load(
heap_move_ok(CharGrid::load_utf8(width, height, data.to_vec()))
}
-/// Clones a [CharGrid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_char_grid_clone(
- grid: NonNull<CharGrid>,
-) -> NonNull<CharGrid> {
- unsafe { heap_clone(grid) }
-}
-
-/// Deallocates a [CharGrid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_char_grid_free(char_grid: NonNull<CharGrid>) {
- unsafe { heap_drop(char_grid) }
-}
+wrap_clone!(CharGrid, sp_char_grid);
+wrap_free!(CharGrid, sp_char_grid);
/// Returns the current value at the specified position.
///
diff --git a/src/containers/cp437_grid.rs b/src/containers/cp437_grid.rs
index a636295..bd58981 100644
--- a/src/containers/cp437_grid.rs
+++ b/src/containers/cp437_grid.rs
@@ -1,9 +1,7 @@
use crate::{
containers::ByteSlice,
- mem::{
- heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some,
- heap_remove,
- },
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok, heap_move_some, heap_remove},
};
use servicepoint::{
Cp437Grid, Cp437GridCommand, DataRef, Grid, Origin, Packet,
@@ -32,19 +30,8 @@ pub unsafe extern "C" fn sp_cp437_grid_load(
heap_move_some(Cp437Grid::load(width, height, data))
}
-/// Clones a [Cp437Grid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cp437_grid_clone(
- grid: NonNull<Cp437Grid>,
-) -> NonNull<Cp437Grid> {
- unsafe { heap_clone(grid) }
-}
-
-/// Deallocates a [Cp437Grid].
-#[no_mangle]
-pub unsafe extern "C" fn sp_cp437_grid_free(cp437_grid: NonNull<Cp437Grid>) {
- unsafe { heap_drop(cp437_grid) }
-}
+wrap_clone!(Cp437Grid, sp_cp437_grid);
+wrap_free!(Cp437Grid, sp_cp437_grid);
/// Gets the current value at the specified position.
///
diff --git a/src/lib.rs b/src/lib.rs
index 5c64328..e08fbd7 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -29,6 +29,7 @@
pub mod commands;
/// Functions related to [servicepoint::Bitmap], [servicepoint::CharGrid] and friends.
pub mod containers;
+mod macros;
pub(crate) mod mem;
/// Functions related to [Packet].
pub mod packet;
diff --git a/src/macros.rs b/src/macros.rs
new file mode 100644
index 0000000..80e19ef
--- /dev/null
+++ b/src/macros.rs
@@ -0,0 +1,25 @@
+macro_rules! wrap_free {
+ ($typ:ident, $prefix:ident) => {
+ paste::paste! {
+ #[doc = concat!("Deallocates a [", stringify!($typ), "] instance.")]
+ #[no_mangle]
+ pub unsafe extern "C" fn [<$prefix _free>](instance: NonNull<$typ>) {
+ unsafe { crate::mem::heap_drop(instance) }
+ }
+ }
+ };
+}
+
+macro_rules! wrap_clone {
+ ($typ:ident, $prefix:ident) => {
+ paste::paste! {
+ #[doc = concat!("Clones a [", stringify!($typ), "] instance.")]
+ #[no_mangle]
+ pub unsafe extern "C" fn [<$prefix _clone>](instance: NonNull<$typ>) -> NonNull<$typ> {
+ unsafe { crate::mem::heap_clone(instance) }
+ }
+ }
+ };
+}
+
+pub(crate) use {wrap_clone, wrap_free};
diff --git a/src/packet.rs b/src/packet.rs
index b1269df..658265c 100644
--- a/src/packet.rs
+++ b/src/packet.rs
@@ -1,6 +1,7 @@
use crate::{
containers::ByteSlice,
- mem::{heap_clone, heap_drop, heap_move_nonnull, heap_move_ok},
+ macros::{wrap_clone, wrap_free},
+ mem::{heap_move_nonnull, heap_move_ok},
};
use servicepoint::{CommandCode, Header, Packet};
use std::ptr::NonNull;
@@ -90,21 +91,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<Packet>,
-) -> NonNull<Packet> {
- unsafe { heap_clone(packet) }
-}
-
-/// Deallocates a [Packet].
-#[no_mangle]
-pub unsafe extern "C" fn sp_packet_free(packet: NonNull<Packet>) {
- unsafe { heap_drop(packet) }
-}
+wrap_clone!(Packet, sp_packet);
+wrap_free!(Packet, sp_packet);
/// Converts u16 into [CommandCode].
///
diff --git a/src/udp.rs b/src/udp.rs
index fe9f876..eef82a8 100644
--- a/src/udp.rs
+++ b/src/udp.rs
@@ -1,6 +1,7 @@
use crate::{
commands::{CommandTag, SPCommand},
- mem::{heap_drop, heap_move_ok, heap_remove},
+ macros::wrap_free,
+ mem::{heap_move_ok, heap_remove},
};
use servicepoint::{Header, Packet, UdpSocketExt};
use std::{
@@ -143,8 +144,4 @@ pub unsafe extern "C" fn sp_udp_send_header(
.is_ok()
}
-/// Closes and deallocates a [UdpSocket].
-#[no_mangle]
-pub unsafe extern "C" fn sp_udp_free(connection: NonNull<UdpSocket>) {
- unsafe { heap_drop(connection) }
-}
+wrap_free!(UdpSocket, sp_udp);